whimsical-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From curc...@apache.org
Subject [whimsy] branch master updated: Add partial listing of hardcoded lists/maps
Date Sat, 20 Apr 2019 21:31:59 GMT
This is an automated email from the ASF dual-hosted git repository.

curcuru pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/whimsy.git


The following commit(s) were added to refs/heads/master by this push:
     new 60a6810  Add partial listing of hardcoded lists/maps
60a6810 is described below

commit 60a681034e7ee067698cabf4b1c6927007f9c5f4
Author: Shane Curcuru <asf@shanecurcuru.org>
AuthorDate: Sat Apr 20 17:31:49 2019 -0400

    Add partial listing of hardcoded lists/maps
---
 www/docs/hardcoded.cgi  | 53 ++++++++++++++++++++++++++++
 www/docs/hardcoded.json | 92 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 145 insertions(+)

diff --git a/www/docs/hardcoded.cgi b/www/docs/hardcoded.cgi
new file mode 100644
index 0000000..d3bb368
--- /dev/null
+++ b/www/docs/hardcoded.cgi
@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+PAGETITLE = "Hardcoded Data In Code" # Wvisible:tools data
+
+$LOAD_PATH.unshift '/srv/whimsy/lib'
+require 'json'
+require 'whimsy/asf'
+require 'wunderbar'
+require 'wunderbar/bootstrap'
+GITWHIMSY = 'https://github.com/apache/whimsy/blob/master'
+HARDCODED = 'hardcoded.json'
+hclist = JSON.parse(File.read(HARDCODED))
+
+_html do
+  _body? do
+    _whimsy_body(
+      title: PAGETITLE,
+      related: {
+        "https://github.com/apache/whimsy/blob/master/DEVELOPMENT.md" => "Whimsy Dev Environment
Setup",
+        "/public" => "Whimsy public JSON datafiles",
+        "/docs" => "Whimsy code/API developer documentation"
+      },
+      helpblock: -> {
+        _p %{ Whimsy tools integrate directly with a wide variety of 
+          private and public data and processes within the ASF.  Many 
+          tools also hardcode lists or mappings of data that is 
+          canonically stored elsewhere.  This is a partial list.
+        }
+        _p %{ Many of these hardcoded lists are good things, and are 
+          in the right part of the code.  Some lists may turn out to 
+          be better stored elsewhere, either in Whimsy or other repos.
+        }
+      }
+    ) do
+      _ul.list_group do
+        hclist.each do |file, info|
+          _li.list_group_item do
+            _a '', name: file.gsub(/[#%\[\]\{\}\\"<>]/, '')
+            _code! do
+              if info['line']
+                _a! file, href: "#{GITWHIMSY}#{file}##{info['line']}"
+              else
+                _a! file, href: "#{GITWHIMSY}#{file}"
+              end
+              _span.text_muted " #{info['symbol']}"
+            end
+            _br
+            _ " #{info['description']}"
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/www/docs/hardcoded.json b/www/docs/hardcoded.json
new file mode 100644
index 0000000..7e3e00f
--- /dev/null
+++ b/www/docs/hardcoded.json
@@ -0,0 +1,92 @@
+{
+  "tools/collate_minutes.rb": {
+    "line": "230",
+    "symbol": "",
+    "description": "List of common prefix phrases in resolution titles"
+  },
+  "lib/whimsy/asf/board.rb": {
+    "line": "107",
+    "symbol": "DIRECTOR_MAP",
+    "description": "Map of all director id/initial/names"
+  },
+  "lib/whimsy/asf/committee.rb": {
+    "line": "64",
+    "symbol": "@@aliases.merge!",
+    "description": "Map of PMC display names to shortnames: 'community development' =>
'comdev'"
+  },
+  "lib/whimsy/asf/mail.rb": {
+    "line": "86",
+    "symbol": "",
+    "description": "Lists of special cased mailing list names and access"
+  },
+  "lib/whimsy/asf/mlist.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Various hardcoded logic for details of how lists are archived; some special
cases that are related to technical details"
+  },
+  "lib/whimsy/asf/person.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Various collation bits for people's names; generic to unicode or name
prefixes"
+  },
+  "lib/whimsy/asf/podling.rb": {
+    "line": "260",
+    "symbol": "dev_mail_list",
+    "description": "Development mailing list name associated with a given podling"
+  },
+  "lib/whimsy/asf/site.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Various ASF groups and their website homepage URLs"
+  },
+  "lib/whimsy/asf/agenda/special.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Various hardcoded strings dealing with board agenda items (historical
and current)"
+  },
+  "lib/whimsy/asd/agenda/summary.rb": {
+    "line": "",
+    "symbol": "SKIP_AGENDAS",
+    "description": "defines map of F2F agendas (not traditionally parseable)"
+  },
+  "lib/whimsy/asf/person/override-dates.rb": {
+    "line": "",
+    "symbol": "@@create_date",
+    "description": "Corrected creation dates for accounts created before May 2009"
+  },
+  "tools/check_auth.rb": {
+    "line": "",
+    "symbol": "ROLE_NAMES",
+    "description": "hardcoded list of special non-LDAP names"
+  },
+  "tools/mboxhdr2csv.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Maps some tool-generated subject lines for different lists"
+  },
+  "tools/ponypoop.rb": {
+    "line": "",
+    "symbol": "",
+    "description": "Mapping some tool-generated subject lines for different lists"
+  },
+  "www/incubator/graduated.cgi": {
+    "line": "9",
+    "symbol": "parents",
+    "description": "List of parent PMCs for some podlings"
+  },
+  "www/members/proxy.cgi": {
+    "line": "",
+    "symbol": "volunteers",
+    "description": "List of volunteers for current member's meeting; update annually per
proxies file"
+  },
+  "www/members/subscriptions.cgi": {
+    "line": "",
+    "symbol": "ARCHIVERS",
+    "description": "List of email addreses for private lists"
+  },
+  "www/test/dataflow.json": {
+    "line": "",
+    "symbol": "",
+    "description": "List of common /public datafiles and explanations"
+  }
+}


Mime
View raw message