lib/whimsy/asf/committee.rb - whimsy - Git at Google

 require 'time'

 module ASF

   # Define super class to prevent circular references.  This class is
   # actually defined in ldap.rb which is require'd after committee.rb.
   class Base # :nodoc:
   end

   #
   # Representation for a committee (either a PMC, a board committee, or
   # a President's committee).  This data is parsed from
   # <tt>committee-info.txt</tt>, and is augmened by data from LDAP,
   # ASF::Site, and ASF::Mail.
   #
   # Note that the simple attributes which are sourced from
   # <tt>committee-info.txt</tt> data is generally not available until
   # ASF::Committee.load_committee_info is called.
   #
   # Similarly, the simple attributes which are sourced from LDAP is
   # generally not available until ASF::Committee.preload is called.

   class Committee < Base
     # list of chairs for this committee.  Returned as a list of hashes
     # containing the <tt>:name</tt> and <tt>:id</tt>.  Data is obtained from
     # <tt>committee-info.txt</tt>.
     attr_accessor :chairs

     # list of members for this committee.  Returned as a list of ids.
     # Data is obtained from <tt>committee-info.txt</tt>.
     attr_reader :info

     # when this committee is next expected to report.  May be a string
     # containing values such as "Next month: missing in May", "Next month: new,
     # montly through July".  Data is obtained from <tt>committee-info.txt</tt>.
     attr_writer :report

     # list of members for this committee.  Returned as a list of hash
     # mapping ids to a hash of <tt>:name</tt> and <tt>:date</tt> values.
     # Data is obtained from <tt>committee-info.txt</tt>.
     attr_accessor :roster

     # Date this committee was established in the format MM/YYYY.
     # Data is obtained from <tt>committee-info.txt</tt>.
     attr_accessor :established

     # list of months when his committee typically  reports.  Returned
     # as a comma separated string.  Data is obtained from
     # <tt>committee-info.txt</tt>.
     attr_accessor :schedule

     # create an empty committee instance
     def initialize(*args)
       @info = []
       @chairs = []
       @roster = {}
       super
     end

     # mapping of committee names to canonical names (generally from ldap)
     # See also www/roster/committee.cgi
     @@aliases = Hash.new {|hash, name| name.downcase}
     @@aliases.merge! \
       'community development'       => 'comdev',
       'conference planning'         => 'concom',
       'conferences'                 => 'concom',
       'http server'                 => 'httpd',
       'httpserver'                  => 'httpd',
       'java community process'      => 'jcp',
       'logging services'            => 'logging',
       'lucene.net'                  => 'lucenenet',
       'portable runtime'            => 'apr',
       'quetzalcoatl'                => 'quetz',
       'security team'               => 'security',
       'open climate workbench'      => 'climate',
       'c++ standard library'        => 'stdcxx',
       'travel assistance'           => 'tac',
       'traffic server'              => 'trafficserver',
       'web services'                => 'ws',
       'xml graphics'                => 'xmlgraphics',
       'incubating'                  => 'incubator' # special for index.html

     @@namemap = Proc.new do |name|
       cname = @@aliases[name.sub(/\s+\(.*?\)/, '').downcase]
       cname
     end

     # load committee info from <tt>committee-info.txt</tt>.  Will not reparse
     # if the file has already been parsed and the underlying file has not
     # changed.
     def self.load_committee_info
       board = ASF::SVN['private/committers/board']
       file = "#{board}/committee-info.txt"
       return unless File.exist? file

       if @committee_info and File.mtime(file) == @committee_mtime
         return @committee_info
       end

       @committee_mtime = File.mtime(file)
       @@svn_change = Time.parse(
         `svn info #{file}`[/Last Changed Date: (.*) \(/, 1]).gmtime

       parse_committee_info File.read(file)
     end

     # insert (replacing if necessary) a new committee into committee-info.txt
     def self.establish(contents, pmc, date, people)
       # split into foot, sections (array) and head
       foot = contents[/^=+\s*\Z/]
       contents.sub! /^=+\s*\Z/, ''
       sections = contents.split(/^\* /)
       head = sections.shift

       # remove existing section (if present)
       sections.delete_if {|section| section.downcase.start_with? pmc.downcase}

       # build new section
       section  = ["#{pmc}  (est. #{date.strftime('%m/%Y')})"]
       people.sort.each do |id, name|
         name = "#{name.ljust(26)} <#{id}@apache.org>"
         section << "    #{(name).ljust(59)} [#{date.strftime('%Y-%m-%d')}]"
       end

       # add new section
       sections << section.join("\n") + "\n\n\n"

       # sort sections
       sections.sort_by!(&:downcase)

       # re-attach parts
       head + '* ' + sections.join('* ') + foot
     end

     # extract chairs, list of nonpmcs, roster, start date, and reporting
     # information from <tt>committee-info.txt</tt>.  Note: this method is
     # intended to be internal, use ASF::Committee.load_committee_info as it
     # will cache this data.
     def self.parse_committee_info(contents)
       list = Hash.new {|hash, name| hash[name] = find(name)}

       # Split the file on lines starting "* ", i.e. the start of each group in section 3
       info = contents.split(/^\* /)
       # Extract the text before first entry in section 3 and split on section headers,
       # keeping sections 1 (COMMITTEES) and 2 (REPORTING).
       head, report = info.shift.split(/^\d\./)[1..2]
       # Drop lines which could match group entries
       head.gsub! /^\s+NAME\s+CHAIR\s*$/,'' # otherwise could match an entry with no e-mail

       # extract the committee chairs (e-mail address is required here)
       # Note: this includes the non-PMC entries
       head.scan(/^[ \t]+(\w.*?)[ \t][ \t]+(.*)[ \t]+<(.*?)@apache\.org>/).
         each do |committee, name, id|
           unless list[committee].chairs.any? {|chair| chair[:id] == id}
             list[committee].chairs << {name: name, id: id}
           end
         end

       # Extract the non-PMC committees (e-mail address may be absent)
       # first drop leading text so we only match non-PMCs
       @nonpmcs = head.sub(/.*?also has /m,'').
         scan(/^[ \t]+(\w.*?)(?:[ \t][ \t]|[ \t]?$)/).flatten.uniq.
         map {|name| list[name]}

       # for each committee in section 3
       info.each do |roster|
         # extract the committee name and canonicalise
         committee = list[@@namemap.call(roster[/(\w.*?)[ \t]+\(/,1])]

         # get and normalize the start date
         established = roster[/\(est\. (.*?)\)/, 1]
         established = "0#{established}" if established =~ /^\d\//
         committee.established = established

         # match non-empty entries and check the syntax
         roster.scan(/^[ \t]+.+$/) do |line|
             Wunderbar.warn "Invalid syntax: #{committee.name} '#{line}'" unless line =~ /\s<(.*?)@apache\.org>\s/
         end

         # extract the availids (is this used?)
         committee.info = roster.scan(/<(.*?)@apache\.org>/).flatten

         # drop (chair) markers and extract 0: name, 1: availid, 2: [date], 3: date
         # the date is optional (e.g. infrastructure)
         committee.roster = Hash[roster.gsub(/\(\w+\)/, '').
           scan(/^[ \t]*(.*?)[ \t]*<(.*?)@apache\.org>(?:[ \t]+(\[(.*?)\]))?/).
           map {|list| [list[1], {name: list[0], date: list[3]}]}]
       end

       # process report section
       report.scan(/^([^\n]+)\n---+\n(.*?)\n\n/m).each do |period, committees|
         committees.scan(/^   [ \t]*(.*)/).each do |committee|
           committee, comment = committee.first.split(/[ \t]+#[ \t]+/,2)
           committee = list[committee]
           if comment
             committee.report = "#{period}: #{comment}"
           elsif period == 'Next month'
             committee.report = 'Every month'
           else
             committee.schedule = period
           end
         end
       end

       @committee_info = list.values.uniq
     end

     # return a list of PMC committees.  Data is obtained from
     # <tt>committee-info.txt</tt>
     def self.pmcs
       committees = ASF::Committee.load_committee_info
       committees - @nonpmcs
     end

     # return a list of non-PMC committees.  Data is obtained from
     # <tt>committee-info.txt</tt>
     def self.nonpmcs
       @nonpmcs
     end

     # Finds a committee based on the name of the Committee.  Is aware of
     # a number of aliases for a given committee.  Will set display name
     # if the name being searched on contains an uppercase character.
     def self.find(name)
       result = super(@@namemap.call(name))
       result.display_name = name if name =~ /[A-Z]/
       result
     end

     # Return the Last Changed Date for <tt>committee-info.txt</tt> in svn as
     # a <tt>Time</tt> object.  Data is based on the previous call to
     # ASF::Committee.load_committee_info.
     def self.svn_change
       @@svn_change
     end

     # returns the (first) chair as an instance of the ASF::Person class.
     def chair
       Committee.load_committee_info
       if @chairs.length >= 1
         ASF::Person.find(@chairs.first[:id])
       else
         nil
       end
     end

     # Version of name suitable for display purposes.  Typically in uppercase.
     # Data is sourced from <tt>committee-info.txt</tt>.
     def display_name
       Committee.load_committee_info
       @display_name || name
     end

     # setter for display_name, should only be used by
     # ASF::Committee.load_committee_info
     def display_name=(name)
       @display_name ||= name
     end

     # when this committee is next expected to report.  May be a string
     # containing values such as "Next month: missing in May", "Next month: new,
     # montly through July".  Or may be a list of months, separated by commas.
     # Data is obtained from <tt>committee-info.txt</tt>.
     def report
       @report || @schedule
     end

     # setter for display_name, should only be used by
     # ASF::Committee.load_committee_info
     def info=(list)
       @info = list
     end

     # hash of availid => public_name for members (owners) of this committee
     # Data is obtained from <tt>committee-info.txt</tt>.
     def names
       Committee.load_committee_info
       Hash[@roster.map {|id, info| [id, info[:name]]}]
     end

     # if true, this committee is not a PMC.
     # Data is obtained from <tt>committee-info.txt</tt>.
     def nonpmc?
       Committee.nonpmcs.include? self
     end
   end
 end
	require 'time'

	module ASF

	# Define super class to prevent circular references. This class is
	# actually defined in ldap.rb which is require'd after committee.rb.
	class Base # :nodoc:
	end

	#
	# Representation for a committee (either a PMC, a board committee, or
	# a President's committee). This data is parsed from
	# <tt>committee-info.txt</tt>, and is augmened by data from LDAP,
	# ASF::Site, and ASF::Mail.
	#
	# Note that the simple attributes which are sourced from
	# <tt>committee-info.txt</tt> data is generally not available until
	# ASF::Committee.load_committee_info is called.
	#
	# Similarly, the simple attributes which are sourced from LDAP is
	# generally not available until ASF::Committee.preload is called.

	class Committee < Base
	# list of chairs for this committee. Returned as a list of hashes
	# containing the <tt>:name</tt> and <tt>:id</tt>. Data is obtained from
	# <tt>committee-info.txt</tt>.
	attr_accessor :chairs

	# list of members for this committee. Returned as a list of ids.
	# Data is obtained from <tt>committee-info.txt</tt>.
	attr_reader :info

	# when this committee is next expected to report. May be a string
	# containing values such as "Next month: missing in May", "Next month: new,
	# montly through July". Data is obtained from <tt>committee-info.txt</tt>.
	attr_writer :report

	# list of members for this committee. Returned as a list of hash
	# mapping ids to a hash of <tt>:name</tt> and <tt>:date</tt> values.
	# Data is obtained from <tt>committee-info.txt</tt>.
	attr_accessor :roster

	# Date this committee was established in the format MM/YYYY.
	# Data is obtained from <tt>committee-info.txt</tt>.
	attr_accessor :established

	# list of months when his committee typically reports. Returned
	# as a comma separated string. Data is obtained from
	# <tt>committee-info.txt</tt>.
	attr_accessor :schedule

	# create an empty committee instance
	def initialize(*args)
	@info = []
	@chairs = []
	@roster = {}
	super
	end

	# mapping of committee names to canonical names (generally from ldap)
	# See also www/roster/committee.cgi
	@@aliases = Hash.new {\|hash, name\| name.downcase}
	@@aliases.merge! \
	'community development' => 'comdev',
	'conference planning' => 'concom',
	'conferences' => 'concom',
	'http server' => 'httpd',
	'httpserver' => 'httpd',
	'java community process' => 'jcp',
	'logging services' => 'logging',
	'lucene.net' => 'lucenenet',
	'portable runtime' => 'apr',
	'quetzalcoatl' => 'quetz',
	'security team' => 'security',
	'open climate workbench' => 'climate',
	'c++ standard library' => 'stdcxx',
	'travel assistance' => 'tac',
	'traffic server' => 'trafficserver',
	'web services' => 'ws',
	'xml graphics' => 'xmlgraphics',
	'incubating' => 'incubator' # special for index.html

	@@namemap = Proc.new do \|name\|
	cname = @@aliases[name.sub(/\s+\(.*?\)/, '').downcase]
	cname
	end

	# load committee info from <tt>committee-info.txt</tt>. Will not reparse
	# if the file has already been parsed and the underlying file has not
	# changed.
	def self.load_committee_info
	board = ASF::SVN['private/committers/board']
	file = "#{board}/committee-info.txt"
	return unless File.exist? file

	if @committee_info and File.mtime(file) == @committee_mtime
	return @committee_info
	end

	@committee_mtime = File.mtime(file)
	@@svn_change = Time.parse(
	`svn info #{file}`[/Last Changed Date: (.*) \(/, 1]).gmtime

	parse_committee_info File.read(file)
	end

	# insert (replacing if necessary) a new committee into committee-info.txt
	def self.establish(contents, pmc, date, people)
	# split into foot, sections (array) and head
	foot = contents[/^=+\s*\Z/]
	contents.sub! /^=+\s*\Z/, ''
	sections = contents.split(/^\* /)
	head = sections.shift

	# remove existing section (if present)
	sections.delete_if {\|section\| section.downcase.start_with? pmc.downcase}

	# build new section
	section = ["#{pmc} (est. #{date.strftime('%m/%Y')})"]
	people.sort.each do \|id, name\|
	name = "#{name.ljust(26)} <#{id}@apache.org>"
	section << " #{(name).ljust(59)} [#{date.strftime('%Y-%m-%d')}]"
	end

	# add new section
	sections << section.join("\n") + "\n\n\n"

	# sort sections
	sections.sort_by!(&:downcase)

	# re-attach parts
	head + '* ' + sections.join('* ') + foot
	end

	# extract chairs, list of nonpmcs, roster, start date, and reporting
	# information from <tt>committee-info.txt</tt>. Note: this method is
	# intended to be internal, use ASF::Committee.load_committee_info as it
	# will cache this data.
	def self.parse_committee_info(contents)
	list = Hash.new {\|hash, name\| hash[name] = find(name)}

	# Split the file on lines starting "* ", i.e. the start of each group in section 3
	info = contents.split(/^\* /)
	# Extract the text before first entry in section 3 and split on section headers,
	# keeping sections 1 (COMMITTEES) and 2 (REPORTING).
	head, report = info.shift.split(/^\d\./)[1..2]
	# Drop lines which could match group entries
	head.gsub! /^\s+NAME\s+CHAIR\s*$/,'' # otherwise could match an entry with no e-mail

	# extract the committee chairs (e-mail address is required here)
	# Note: this includes the non-PMC entries
	head.scan(/^[ \t]+(\w.?)[ \t][ \t]+(.)[ \t]+<(.*?)@apache\.org>/).
	each do \|committee, name, id\|
	unless list[committee].chairs.any? {\|chair\| chair[:id] == id}
	list[committee].chairs << {name: name, id: id}
	end
	end

	# Extract the non-PMC committees (e-mail address may be absent)
	# first drop leading text so we only match non-PMCs
	@nonpmcs = head.sub(/.*?also has /m,'').
	scan(/^[ \t]+(\w.*?)(?:[ \t][ \t]\|[ \t]?$)/).flatten.uniq.
	map {\|name\| list[name]}

	# for each committee in section 3
	info.each do \|roster\|
	# extract the committee name and canonicalise
	committee = list[@@namemap.call(roster[/(\w.*?)[ \t]+\(/,1])]

	# get and normalize the start date
	established = roster[/\(est\. (.*?)\)/, 1]
	established = "0#{established}" if established =~ /^\d\//
	committee.established = established

	# match non-empty entries and check the syntax
	roster.scan(/^[ \t]+.+$/) do \|line\|
	Wunderbar.warn "Invalid syntax: #{committee.name} '#{line}'" unless line =~ /\s<(.*?)@apache\.org>\s/
	end

	# extract the availids (is this used?)
	committee.info = roster.scan(/<(.*?)@apache\.org>/).flatten

	# drop (chair) markers and extract 0: name, 1: availid, 2: [date], 3: date
	# the date is optional (e.g. infrastructure)
	committee.roster = Hash[roster.gsub(/\(\w+\)/, '').
	scan(/^[ \t](.?)[ \t]<(.?)@apache\.org>(?:[ \t]+(\[(.*?)\]))?/).
	map {\|list\| [list[1], {name: list[0], date: list[3]}]}]
	end

	# process report section
	report.scan(/^([^\n]+)\n---+\n(.*?)\n\n/m).each do \|period, committees\|
	committees.scan(/^ [ \t](.)/).each do \|committee\|
	committee, comment = committee.first.split(/[ \t]+#[ \t]+/,2)
	committee = list[committee]
	if comment
	committee.report = "#{period}: #{comment}"
	elsif period == 'Next month'
	committee.report = 'Every month'
	else
	committee.schedule = period
	end
	end
	end

	@committee_info = list.values.uniq
	end

	# return a list of PMC committees. Data is obtained from
	# <tt>committee-info.txt</tt>
	def self.pmcs
	committees = ASF::Committee.load_committee_info
	committees - @nonpmcs
	end

	# return a list of non-PMC committees. Data is obtained from
	# <tt>committee-info.txt</tt>
	def self.nonpmcs
	@nonpmcs
	end

	# Finds a committee based on the name of the Committee. Is aware of
	# a number of aliases for a given committee. Will set display name
	# if the name being searched on contains an uppercase character.
	def self.find(name)
	result = super(@@namemap.call(name))
	result.display_name = name if name =~ /[A-Z]/
	result
	end

	# Return the Last Changed Date for <tt>committee-info.txt</tt> in svn as
	# a <tt>Time</tt> object. Data is based on the previous call to
	# ASF::Committee.load_committee_info.
	def self.svn_change
	@@svn_change
	end

	# returns the (first) chair as an instance of the ASF::Person class.
	def chair
	Committee.load_committee_info
	if @chairs.length >= 1
	ASF::Person.find(@chairs.first[:id])
	else
	nil
	end
	end

	# Version of name suitable for display purposes. Typically in uppercase.
	# Data is sourced from <tt>committee-info.txt</tt>.
	def display_name
	Committee.load_committee_info
	@display_name \|\| name
	end

	# setter for display_name, should only be used by
	# ASF::Committee.load_committee_info
	def display_name=(name)
	@display_name \|\|= name
	end

	# when this committee is next expected to report. May be a string
	# containing values such as "Next month: missing in May", "Next month: new,
	# montly through July". Or may be a list of months, separated by commas.
	# Data is obtained from <tt>committee-info.txt</tt>.
	def report
	@report \|\| @schedule
	end

	# setter for display_name, should only be used by
	# ASF::Committee.load_committee_info
	def info=(list)
	@info = list
	end

	# hash of availid => public_name for members (owners) of this committee
	# Data is obtained from <tt>committee-info.txt</tt>.
	def names
	Committee.load_committee_info
	Hash[@roster.map {\|id, info\| [id, info[:name]]}]
	end

	# if true, this committee is not a PMC.
	# Data is obtained from <tt>committee-info.txt</tt>.
	def nonpmc?
	Committee.nonpmcs.include? self
	end
	end
	end