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 d5835d7 Use new whimsy/sitewebsite UI code
d5835d7 is described below
commit d5835d71761eb810898472c55726701c19112124
Author: Shane Curcuru <[email protected]>
AuthorDate: Thu May 10 16:07:20 2018 -0400
Use new whimsy/sitewebsite UI code
Fewer lines of code to do the same thing - beautiful
---
www/pods.cgi | 324 ++++++-----------------------------------------------------
1 file changed, 31 insertions(+), 293 deletions(-)
diff --git a/www/pods.cgi b/www/pods.cgi
index 18c0f86..3a9828b 100755
--- a/www/pods.cgi
+++ b/www/pods.cgi
@@ -1,4 +1,5 @@
#!/usr/bin/env ruby
+PAGETITLE = "Apache Podling Website Checks" # Wvisible:sites,brand
# ensure that there is a path (even a slash will do) after the script name
unless ENV['PATH_INFO'] and not ENV['PATH_INFO'].empty?
@@ -12,90 +13,13 @@ $LOAD_PATH.unshift
File.realpath(File.expand_path('../../lib', __FILE__))
require 'json'
require 'net/http'
require 'time' # for httpdate
+require 'whimsy/sitestandards'
-PAGETITLE = "Apache Podling Website Checks" # Wvisible:sites,brand
-cols = %w( uri events foundation image license sponsorship security thanks
copyright trademarks disclaimer)
-CHECKS = {
- 'uri' => %r{https?://[^.]+\.incubator\.apache\.org},
- 'copyright' => %r{[Cc]opyright [^.]+ Apache Software Foundation}, # Do we
need '[Tt]he ASF'?
- 'foundation' => %r{.},
- 'image' => %r{.},
- # TODO more checks needed here, e.g. ASF registered and 3rd party marks
- 'trademarks' => %r{trademarks of [Tt]he Apache Software Foundation},
- 'events' => %r{^https?://.*apache.org/events/current-event},
- 'license' => %r{^https?://.*apache.org/licenses/$}, # should link to
parent license page only
- 'sponsorship' => %r{^https?://.*apache.org/foundation/sponsorship},
- 'security' => %r{^https?://.*apache.org/[Ss]ecurity},
- 'thanks' => %r{^https?://.*apache.org/foundation/thanks},
- 'disclaimer' => %r{Apache \S+( \S+)?( \([Ii]ncubating\))? is an effort
undergoing [Ii]ncubation at [Tt]he Apache Software Foundation \(ASF\),?
sponsored by the (Apache )?\S+( PMC)?. Incubation is required of all newly
accepted projects until a further review indicates that the infrastructure,
communications, and decision making process have stabilized in a manner
consistent with other successful ASF projects. While incubation status is not
necessarily a reflection of the completeness [...]
-}
-DOCS = {
- 'uri' => ['https://www.apache.org/foundation/marks/pmcs#websites',
- 'The homepage for any ProjectName must be served from
http://ProjectName.apache.org'],
-# 'copyright' => 'TBA',
- 'foundation' => ['https://www.apache.org/foundation/marks/pmcs#navigation',
- 'All projects must feature some prominent link back to the
main ASF homepage at http://www.apache.org/'],
- 'trademarks' =>
['https://www.apache.org/foundation/marks/pmcs#attributions',
- 'All project or product homepages must feature a prominent
trademark attribution of all applicable Apache trademarks'],
-# 'events' => 'TBA',
- 'license' => ['https://www.apache.org/foundation/marks/pmcs#navigation',
- '"License" should link to:
http://www.apache.org/licenses/'],
- 'sponsorship' => ['https://www.apache.org/foundation/marks/pmcs#navigation',
- '"Sponsorship" or "Donate" should link to:
http://www.apache.org/foundation/sponsorship.html'],
- 'security' => ['https://www.apache.org/foundation/marks/pmcs#navigation',
- '"Security" should link to either to a project-specific
page [...], or to the main http://www.apache.org/security/ page'],
- 'thanks' => ['https://www.apache.org/foundation/marks/pmcs#navigation',
- '"Thanks" should link to:
http://www.apache.org/foundation/thanks.html'],
- 'disclaimer' =>
['https://incubator.apache.org/guides/branding.html#disclaimers',
- 'All podling sites must contain a disclaimer'],
-}
-DATAURI = 'https://whimsy.apache.org/public/pods-scan.json'
-
-def analyze(sites)
- success = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
- counts = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }
- CHECKS.each do |nam, pat|
- success[nam] = sites.select{ |k, site| site[nam] =~ pat }.keys
- counts[nam]['label-success'] = success[nam].count
- counts[nam]['label-warning'] = 0 # Reorder output
- counts[nam]['label-danger'] = sites.select{ |k, site| site[nam].nil?
}.count
- counts[nam]['label-warning'] = sites.size - counts[nam]['label-success']
- counts[nam]['label-danger']
- end
-
- [
- counts, {
- 'label-success' => '# Sites with links to primary ASF page',
- 'label-warning' => '# Sites with link, but not an expected ASF one',
- 'label-danger' => '# Sites with no link for this topic'
- }, success
- ]
-end
-
-def getsites
- local_copy = File.expand_path('../public/pods-scan.json', __FILE__).untaint
- if File.exist? local_copy
- crawl_time = File.mtime(local_copy).httpdate # show time in same format
as last-mod
- sites = JSON.parse(File.read(local_copy))
- else
- begin
- response = Net::HTTP.get_response(URI(DATAURI))
- crawl_time = response['last-modified']
- sites = JSON.parse(response.body)
- rescue
- sites = {
- "nodata": {
- "display_name" => "No data found - try again later"
- }
- }
- crawl_time = 0
- end
- end
- return sites, crawl_time
-end
-
-sites, crawl_time = getsites()
-
-analysis = analyze(sites)
+# Gather and analyze scans for TLP websites
+cgi_for_tlps = false
+sites, crawl_time = SiteStandards.get_sites(cgi_for_tlps)
+checks_performed = SiteStandards.get_checks(cgi_for_tlps)
+analysis = SiteStandards.analyze(sites, checks_performed)
# Allow CLI testing, e.g. "PATH_INFO=/ ruby www/site.cgi >test.json"
# SCRIPT_NAME will always be set for a CGI invocation
@@ -107,94 +31,11 @@ end
# Only required for CGI use
# if these are required earlier, the code creates an unnecessary 'assets'
directory
-require 'whimsy/asf/themes'
require 'wunderbar'
require 'wunderbar/bootstrap'
require 'wunderbar/jquery/stupidtable'
-
-# Determine the color of a given table cell, given:
-# - overall analysis of the sites, in particular the third column
-# which is a list projects that successfully matched the check
-# - list of links for the project in question
-# - the column in question (which indicates the check being reported on)
-# - the name of the project
-def label(analysis, links, col, name)
- if not links[col]
- 'label-danger'
- elsif analysis[2].include? col and not analysis[2][col].include? name
- 'label-warning'
- else
- 'label-success'
- end
-end
-
-def displayProject(project, links, cols, analysis)
- _whimsy_panel_table(
- title: "Site Check For Project - #{links['display_name']}",
- helpblock: -> {
- _a href: '../', aria_label: 'Home to site checker' do
- _span.glyphicon.glyphicon_home :aria_hidden
- end
- _span.glyphicon.glyphicon_menu_right
- _ ' Results for project: '
- _a links['display_name'], href: links['uri']
- _ ' Check Results column is the actual text found on the project
homepage for this check.'
- }
- ) do
- _table.table.table_striped do
- _tbody do
- _thead do
- _tr do
- _th! 'Check Type'
- _th! 'Check Results'
- _th! 'Check Description'
- end
- end
- cols.each do |col|
- cls = label(analysis, links, col, project)
- _tr do
- _td do
- _a col.capitalize, href: "../check/#{col}"
- end
-
- if links[col] =~ /^https?:/
- _td class: cls do
- _a links[col], href: links[col]
- end
- else
- _td links[col], class: cls
- end
-
- _td do
- if cls == 'label-warning'
- _ 'Expected to match the regular expression: '
- _code CHECKS[col].source
- _ ''
- else
- _ ''
- end
- end
- end
- end
- end
- end
- end
-end
-
-def displayError(path)
- _whimsy_panel_table(
- title: "ERROR",
- helpblock: -> {
- _a href: '../', aria_label: 'Home to site checker' do
- _span.glyphicon.glyphicon_home :aria_hidden
- end
- _span.glyphicon.glyphicon_menu_right
- _span.text_danger "ERROR: The path #{path} is not a recognized command
for this tool, sorry! "
- }
- ) do
- _p.bold 'ERROR - please try again.'
- end
-end
+require 'whimsy/asf/themes'
+require 'whimsy/sitewebsite'
_html do
_head do
@@ -209,138 +50,35 @@ _html do
related: {
"/committers/tools" => "Whimsy Tool Listing",
"https://www.apache.org/foundation/marks/pmcs#navigation"; => "Required
PMC Links Policy",
- "https://github.com/apache/whimsy/"; => "Read The Whimsy Code"
+ "https://github.com/apache/whimsy/blob/master/www#{ENV['SCRIPT_NAME']}"
=> "See This Source Code",
+ "mailto:[email protected]?subject=[SITE] Website Checker
Question" => "Questions? Email Whimsy PMC"
},
helpblock: -> {
_p do
_div.bg_danger 'NOTE: most podlings may not pass these checks yet
during incubation - but they are expected to pass them before graduation.'
- _ 'This script periodically crawls all Apache podling websites to
check them for a few specific links or text blocks that all podlings are
expected to have.'
- _ 'The checks (currently in beta) include verifying that all '
- _a 'required links', href:
'https://www.apache.org/foundation/marks/pmcs#navigation'
- _ ' appear on a project homepage, along with checking if project logos
appear in apache.org/img'
- end
- _p do
- _a 'View the crawler code', href:
'https://github.com/apache/whimsy/blob/master/tools/site-scan.rb'
- _ ', '
- _a 'website display code', href:
'https://github.com/apache/whimsy/blob/master/www/pods.cgi'
- _ ', and '
- _a 'raw JSON data', href: DATAURI
- _ '.'
- _br
- _ "Last crawl time: #{crawl_time} over #{sites.size} websites."
- end
- }
- ) do
-
- if path_info =~ %r{/project/(.+)}
- # details for an individual project
- project = $1
- if sites[project]
- displayProject(project, sites[project], cols, analysis)
- else
- displayError(path_info)
+ _p do
+ _ 'This script periodically crawls all Apache project and podling
websites to check them for a few specific links or text blocks that all
projects are expected to have.'
+ _ 'The checks include verifying that all '
+ _a 'required links', href:
'https://www.apache.org/foundation/marks/pmcs#navigation'
+ _ ' appear on a project homepage, along with an "image" check if
project logo files are in apache.org/img'
end
- elsif path_info =~ %r{/check/(.+)}
- # details for a single check
- col = $1
- _whimsy_panel_table(
- title: "Site Check Of Type - #{col.capitalize}",
- helpblock: -> {
- _a href: '../', aria_label: 'Home to site checker' do
- _span.glyphicon.glyphicon_home :aria_hidden
- end
- _span.glyphicon.glyphicon_menu_right
- if CHECKS.include? col
- _ ' Check Results are expected to match the regular expression: '
- _code CHECKS[col].source
- if DOCS.include? col
- _ ' '
- _a DOCS[col][1], href: DOCS[col][0]
- end
- else
- _span.text_danger "WARNING: the site checker may not understand
type: #{col}, results may not be complete/available."
- end
- }
- ) do
- _table.table.table_condensed.table_striped do
- _thead do
- _tr do
- _th! 'Project'
- _th! 'Check Results'
- end
- end
- _tbody do
- sites.each do |n, links|
- _tr do
- _td do
- _a links['display_name'], href: "../project/#{n}"
- end
-
- if links[col] =~ /^https?:/
- _td class: label(analysis, links, col, n) do
- _a links[col], href: links[col]
- end
- else
- _td links[col], class: label(analysis, links, col, n)
- end
- end
- end
- end
- end
+ _p! do
+ _a 'View the crawler code', href:
'https://github.com/apache/whimsy/blob/master/tools/site-scan.rb'
+ _ ', '
+ _a 'website display code', href:
"https://github.com/apache/whimsy/blob/master/www#{ENV['SCRIPT_NAME']}"
+ _ ', '
+ _a 'validation checks details', href:
"https://github.com/apache/whimsy/blob/master/lib/whimsy/sitewebsite.rb";
+ _ ', and '
+ _a 'raw JSON data', href:
"#{SiteStandards.get_url()}#{SiteStandards.get_filename(cgi_for_tlps)}"
+ _ '.'
+ _br
+ _ "Last crawl time: #{crawl_time} over #{sites.size} websites."
end
- else
- # overview
- _whimsy_panel_table(
- title: "Site Check - All Projects Results",
- helpblock: -> {
- _ul.list_inline do
- _li.small "Data key: "
- analysis[1].each do |cls, desc|
- _li.label desc, class: cls
- end
- _li.small " Click column badges to sort"
- end
- }
- ) do
- _table.table.table_condensed.table_striped do
- _thead do
- _tr do
- _th! 'Project', data_sort: 'string-ins'
- cols.each do |col|
- _th! data_sort: 'string' do
- _a col.capitalize, href: "check/#{col}"
- _br
- analysis[0][col].each do |cls, val|
- _ ' '
- _span.label val, class: cls
- end
- end
- end
- end
- end
-
- sort_order = {
- 'label-success' => 1,
- 'label-warning' => 2,
- 'label-danger' => 3
- }
-
- _tbody do
- sites.each do |n, links|
- _tr do
- _td do
- _a "#{links['display_name']}", href: "project/#{n}"
- end
- cols.each do |c|
- cls = label(analysis, links, c, n)
- _td '', class: cls, data_sort_value: sort_order[cls]
- end
- end
- end
- end
- end
- end # of _whimsy_panel_table
end
+ }
+ ) do
+ # Encapsulate data display (same for projects and podlings)
+ display_application(path_info, sites, analysis, checks_performed,
cgi_for_tlps)
end
_script %{
--
To stop receiving notification emails like this one, please contact
[email protected].
