sportdb-config 0.4.1 → 0.5.0

data/lib/sportdb/config/club_reader.rb

@@ -1,278 +1,278 @@
-# encoding: utf-8
-
-
-module SportDb
-module Import
-
-
-class ClubReader
-
-
-def self.read( path )   ## use - rename to read_file or from_file etc. - why? why not?
-  txt = File.open( path, 'r:utf-8' ).read
-  parse( txt )
-end
-
-
-def self.parse( txt )
-  recs = []
-  last_rec  = nil
-  headings = []   ## headings stack
-
-  txt.each_line do |line|
-    line = line.strip
-
-    next if line.empty?
-    next if line.start_with?( '#' )   ## skip comments too
-
-    ## strip inline (until end-of-line) comments too
-    ##  e.g Eupen        => KAS Eupen,    ## [de]
-    ##   => Eupen        => KAS Eupen,
-    line = line.sub( /#.*/, '' ).strip
-    pp line
-
-
-    next if line =~ /^={1,}$/          ## skip "decorative" only heading e.g. ========
-
-     ## note: like in wikimedia markup (and markdown) all optional trailing ==== too
-     ##  todo/check:  allow ===  Text  =-=-=-=-=-=   too - why? why not?
-    if line =~ /^(={1,})       ## leading ======
-                 ([^=]+?)      ##  text   (note: for now no "inline" = allowed)
-                 =*            ## (optional) trailing ====
-                 $/x
-       heading_marker = $1
-       heading_level  = $1.length   ## count number of = for heading level
-       heading        = $2.strip
-
-       puts "heading #{heading_level} >#{heading}<"
-
-       ## 1) first pop headings if present
-       while headings.size+1 > heading_level
-         headings.pop
-       end
-
-       ## 2) add missing (hierarchy) level if
-       while headings.size+1 < heading_level
-         ##  todo/fix: issue warning about "skipping" hierarchy level
-         puts "!!! warn [team reader] - skipping hierarchy level in headings "
-         headings.push( nil )
-       end
-
-       if heading =~ /^\?+$/    ## note: use ? or ?? or ?? to reset level to nil
-         ## keep level empty
-       else
-
-         ## quick hack:   if level is 1 assume country for now
-         ##                 and extract country code e.g.
-         ##                    Austria (at) => at
-         ##  todo/fix:  allow code only e.g. at or aut without enclosing () too - why? why not?
-         if heading_level == 1
-             if heading =~ /\(([a-z]{2,3})\)/i    ## note allow (at) or (AUT) too
-               country_code = $1
-
-               ## check country code - MUST exist for now!!!!
-               country = SportDb::Import.config.countries[ country_code ]
-               if country.nil?
-                 puts "!!! error [team reader] - unknown country with code >#{country_code}< - sorry - add country to config to fix"
-                 exit 1
-               end
-
-               headings.push( country_code )
-             else
-               puts "!!! error - heading level 1 - missing country code - >#{heading}<"
-               exit 1
-             end
-         else
-          ## quick hack:
-          ##   remove known fill/dummy words incl:
-          ##     Provincia San Juan  =>  San Juan   (see argentina, for example)
-          ##
-          ##   use geo tree long term with alternative names - why? why not?
-           words = ['Provincia']
-           words.each { |word| heading = heading.gsub( word, '' ) }
-           heading = heading.strip
-
-           headings.push( heading )
-         end
-
-         ## assert that hierarchy level is ok
-         if headings.size != heading_level
-           puts "!!! error - headings hierarchy/stack out of order - #{heading.size}<=>#{heading_level}"
-           exit 1
-         end
-       end
-
-       pp headings
-
-    elsif line.start_with?( '|' )
-      ## assume continuation with line of alternative names
-      ##  note: skip leading pipe
-      values = line[1..-1].split( '|' )   # team names - allow/use pipe(|)
-      ## strip and  squish (white)spaces
-      #   e.g. New York FC      (2011-)  => New York FC (2011-)
-      values = values.map { |value| value.strip.gsub( /[ \t]+/, ' ' ) }
-      last_rec.alt_names += values
-      last_rec.add_variants( values ) # auto-add (possible) auto-generated variant names
-
-      ## check for duplicates
-      if last_rec.duplicates?
-        duplicates = last_rec.duplicates
-        puts "*** !!! WARN !!! - #{duplicates.size} duplicate alt name mapping(s):"
-        pp duplicates
-        pp last_rec
-        ##
-        ##  todo/fix:  make it only an error with exit 1
-        ##               if (not normalized) names are the same (not unique/uniq)
-        ##                  e.g. don't exit on  A.F.C. == AFC etc.
-        ## exit 1
-      end
-    else
-      values = line.split( ',' )
-
-      rec = Club.new
-      value = values.shift    ## get first item
-      ## strip and  squish (white)spaces
-      #   e.g. New York FC      (2011-)  => New York FC (2011-)
-      value = value.strip.gsub( /[ \t]+/, ' ' )
-      rec.name = value            # canoncial name (global unique "beautiful/long" name)
-      rec.add_variants( value )   # auto-add (possible) auto-generated variant names
-
-      ## note:
-      ##   check/todo!!!!!!!!!!!!!!!!!-
-      ##  strip year if to present e.g. (2011-)
-      ##
-      ##  do NOT strip for defunct / historic clubs e.g.
-      ##    (1899-1910)
-      ## or (-1914) or (-2011) etc.
-
-      ###
-      ##  todo: move year out of canonical team name - why? why not?
-
-      ## check if canonical name include (2011-) or similar in name
-      ##   if yes, remove (2011-) and add to (alt) names
-      ##   e.g. New York FC (2011) => New York FC
-      if rec.name =~ /\(.+?\)/   ## note: use non-greedy (?) match
-        name = rec.name.gsub( /\(.+?\)/, '' ).strip
-
-        if rec.name =~ /\(([0-9]{4})-\)/            ## e.g. (2014-)
-          rec.year     = $1.to_i
-        elsif  rec.name =~ /\(-([0-9]{4})\)/            ## e.g. (-2014)
-          rec.year_end = $1.to_i
-        elsif  rec.name =~ /\(([0-9]{4})-([0-9]{4})\)/  ## e.g. (2011-2014)
-          rec.year     = $1.to_i
-          rec.year_end = $2.to_i
-        else
-          ## todo/check: warn about unknown year format
-        end
-      end
-
-      ##  todo/check - check for unknown format values
-      ##    e.g. too many values, duplicate years, etc.
-      ##         check for overwritting, etc.
-      while values.size > 0
-        value = values.shift
-        ##  strip and squish (white)spaces
-        #   e.g. León     › Guanajuato     => León › Guanajuato
-        value = value.strip.gsub( /[ \t]+/, ' ' )
-        if value =~/^\d{4}$/   # e.g 1904
-          ## todo/check: issue warning if year is already set!!!!!!!
-          if rec.year
-            puts "!!! error - year already set to #{rec.year} - CANNOT overwrite with #{value}:"
-            pp rec
-            exit 1
-          end
-          rec.year  = value.to_i
-        elsif value.start_with?( '@' )   # e.g. @ Anfield
-          ## cut-off leading @ and spaces
-          rec.ground  = value[1..-1].strip
-        else
-          ## assume city / geo tree
-          ## split into geo tree
-          geos = split_geo( value )
-          city = geos[0]
-          ## check for "embedded" district e.g. London (Fulham) or Hamburg (St. Pauli) etc.
-          if city =~ /\((.+?)\)/   ## note: use non-greedy (?) match
-            rec.district  = $1.strip
-            city          = city.gsub( /\(.+?\)/, '' ).strip
-          end
-          rec.city = city
-
-          if geos.size > 1
-             ## cut-off city and keep the rest (of geo tree)
-             rec.geos = geos[1..-1]
-          end
-        end
-      end  ## while values
-
-
-      ###############
-      ## use headings text for geo tree
-
-      ## 1) add country if present
-      if headings.size > 0 && headings[0]
-        country = SportDb::Import.config.countries[ headings[0] ]
-        rec.country = country
-      else
-        ## make it an error - why? why not?
-        puts "!!! error - country missing in headings hierarchy - sorry - add to quicklist"
-        exit 1
-      end
-
-      ## 2) check geo tree with headings hierarchy
-      if headings.size > 1 && headings[1]
-         geos = split_geo( headings[1] )
-         if rec.geos
-           if rec.geos[0] != geos[0]
-             puts "!!! error - geo tree - headings mismatch >#{rec.geos[0]}< <=> >#{geos[0]}<"
-             exit 1
-           end
-           if rec.geos[1] && rec.geos[1] != geos[1]   ## check optional 2nd level too
-             puts "!!! error - geo tree - headings mismatch >#{rec.geos[1]}< <=> >#{geos[1]}<"
-             exit 1
-           end
-         else
-           ## add missing region (state/province) from headings hierarchy
-           rec.geos = geos
-         end
-      end
-
-      last_rec = rec
-
-
-    ### todo/fix:
-    ##  auto-add alt name with dots stripped - why? why not?
-    ##    e.g.  D.C. United    => DC United
-    ##    e.g.  Liverpool F.C. => Liverpool FC
-    ##    e.g.  St. Albin       => St Albin etc.
-    ##    e.g.  1. FC Köln     => 1 FC Köln  -- make special case for 1. - why? why not?
-
-    ##
-    ## todo/fix:  unify mapping entries
-    ##   always lowercase !!!!  (case insensitive)
-    ##   always strip (2011-) !!!
-    ##   always strip dots (e.g. St., F.C, etc.)
-
-      recs << rec
-    end
-  end  # each_line
-  recs
-end  # method read
-
-###  helpers
-def self.split_geo( str )
-  ## assume city / geo tree
-  ##  strip and squish (white)spaces
-  #   e.g. León     › Guanajuato     => León › Guanajuato
-  str = str.strip.gsub( /[ \t]+/, ' ' )
-
-  ## split into geo tree
-  geos = str.split( /[<>‹›]/ )   ## note: allow > < or › ‹
-  geos = geos.map { |geo| geo.strip }   ## remove all whitespaces
-  geos
-end
-
-end  # class ClubReader
-
-
-end ## module Import
-end ## module SportDb
+# encoding: utf-8
+
+
+module SportDb
+module Import
+
+
+class ClubReader
+
+
+def self.read( path )   ## use - rename to read_file or from_file etc. - why? why not?
+  txt = File.open( path, 'r:utf-8' ).read
+  parse( txt )
+end
+
+
+def self.parse( txt )
+  recs = []
+  last_rec  = nil
+  headings = []   ## headings stack
+
+  txt.each_line do |line|
+    line = line.strip
+
+    next if line.empty?
+    next if line.start_with?( '#' )   ## skip comments too
+
+    ## strip inline (until end-of-line) comments too
+    ##  e.g Eupen        => KAS Eupen,    ## [de]
+    ##   => Eupen        => KAS Eupen,
+    line = line.sub( /#.*/, '' ).strip
+    pp line
+
+
+    next if line =~ /^={1,}$/          ## skip "decorative" only heading e.g. ========
+
+     ## note: like in wikimedia markup (and markdown) all optional trailing ==== too
+     ##  todo/check:  allow ===  Text  =-=-=-=-=-=   too - why? why not?
+    if line =~ /^(={1,})       ## leading ======
+                 ([^=]+?)      ##  text   (note: for now no "inline" = allowed)
+                 =*            ## (optional) trailing ====
+                 $/x
+       heading_marker = $1
+       heading_level  = $1.length   ## count number of = for heading level
+       heading        = $2.strip
+
+       puts "heading #{heading_level} >#{heading}<"
+
+       ## 1) first pop headings if present
+       while headings.size+1 > heading_level
+         headings.pop
+       end
+
+       ## 2) add missing (hierarchy) level if
+       while headings.size+1 < heading_level
+         ##  todo/fix: issue warning about "skipping" hierarchy level
+         puts "!!! warn [team reader] - skipping hierarchy level in headings "
+         headings.push( nil )
+       end
+
+       if heading =~ /^\?+$/    ## note: use ? or ?? or ?? to reset level to nil
+         ## keep level empty
+       else
+
+         ## quick hack:   if level is 1 assume country for now
+         ##                 and extract country code e.g.
+         ##                    Austria (at) => at
+         ##  todo/fix:  allow code only e.g. at or aut without enclosing () too - why? why not?
+         if heading_level == 1
+             if heading =~ /\(([a-z]{2,3})\)/i    ## note allow (at) or (AUT) too
+               country_code = $1
+
+               ## check country code - MUST exist for now!!!!
+               country = SportDb::Import.config.countries[ country_code ]
+               if country.nil?
+                 puts "!!! error [team reader] - unknown country with code >#{country_code}< - sorry - add country to config to fix"
+                 exit 1
+               end
+
+               headings.push( country_code )
+             else
+               puts "!!! error - heading level 1 - missing country code - >#{heading}<"
+               exit 1
+             end
+         else
+          ## quick hack:
+          ##   remove known fill/dummy words incl:
+          ##     Provincia San Juan  =>  San Juan   (see argentina, for example)
+          ##
+          ##   use geo tree long term with alternative names - why? why not?
+           words = ['Provincia']
+           words.each { |word| heading = heading.gsub( word, '' ) }
+           heading = heading.strip
+
+           headings.push( heading )
+         end
+
+         ## assert that hierarchy level is ok
+         if headings.size != heading_level
+           puts "!!! error - headings hierarchy/stack out of order - #{heading.size}<=>#{heading_level}"
+           exit 1
+         end
+       end
+
+       pp headings
+
+    elsif line.start_with?( '|' )
+      ## assume continuation with line of alternative names
+      ##  note: skip leading pipe
+      values = line[1..-1].split( '|' )   # team names - allow/use pipe(|)
+      ## strip and  squish (white)spaces
+      #   e.g. New York FC      (2011-)  => New York FC (2011-)
+      values = values.map { |value| value.strip.gsub( /[ \t]+/, ' ' ) }
+      last_rec.alt_names += values
+      last_rec.add_variants( values ) # auto-add (possible) auto-generated variant names
+
+      ## check for duplicates
+      if last_rec.duplicates?
+        duplicates = last_rec.duplicates
+        puts "*** !!! WARN !!! - #{duplicates.size} duplicate alt name mapping(s):"
+        pp duplicates
+        pp last_rec
+        ##
+        ##  todo/fix:  make it only an error with exit 1
+        ##               if (not normalized) names are the same (not unique/uniq)
+        ##                  e.g. don't exit on  A.F.C. == AFC etc.
+        ## exit 1
+      end
+    else
+      values = line.split( ',' )
+
+      rec = Club.new
+      value = values.shift    ## get first item
+      ## strip and  squish (white)spaces
+      #   e.g. New York FC      (2011-)  => New York FC (2011-)
+      value = value.strip.gsub( /[ \t]+/, ' ' )
+      rec.name = value            # canoncial name (global unique "beautiful/long" name)
+      rec.add_variants( value )   # auto-add (possible) auto-generated variant names
+
+      ## note:
+      ##   check/todo!!!!!!!!!!!!!!!!!-
+      ##  strip year if to present e.g. (2011-)
+      ##
+      ##  do NOT strip for defunct / historic clubs e.g.
+      ##    (1899-1910)
+      ## or (-1914) or (-2011) etc.
+
+      ###
+      ##  todo: move year out of canonical team name - why? why not?
+
+      ## check if canonical name include (2011-) or similar in name
+      ##   if yes, remove (2011-) and add to (alt) names
+      ##   e.g. New York FC (2011) => New York FC
+      if rec.name =~ /\(.+?\)/   ## note: use non-greedy (?) match
+        name = rec.name.gsub( /\(.+?\)/, '' ).strip
+
+        if rec.name =~ /\(([0-9]{4})-\)/            ## e.g. (2014-)
+          rec.year     = $1.to_i
+        elsif  rec.name =~ /\(-([0-9]{4})\)/            ## e.g. (-2014)
+          rec.year_end = $1.to_i
+        elsif  rec.name =~ /\(([0-9]{4})-([0-9]{4})\)/  ## e.g. (2011-2014)
+          rec.year     = $1.to_i
+          rec.year_end = $2.to_i
+        else
+          ## todo/check: warn about unknown year format
+        end
+      end
+
+      ##  todo/check - check for unknown format values
+      ##    e.g. too many values, duplicate years, etc.
+      ##         check for overwritting, etc.
+      while values.size > 0
+        value = values.shift
+        ##  strip and squish (white)spaces
+        #   e.g. León     › Guanajuato     => León › Guanajuato
+        value = value.strip.gsub( /[ \t]+/, ' ' )
+        if value =~/^\d{4}$/   # e.g 1904
+          ## todo/check: issue warning if year is already set!!!!!!!
+          if rec.year
+            puts "!!! error - year already set to #{rec.year} - CANNOT overwrite with #{value}:"
+            pp rec
+            exit 1
+          end
+          rec.year  = value.to_i
+        elsif value.start_with?( '@' )   # e.g. @ Anfield
+          ## cut-off leading @ and spaces
+          rec.ground  = value[1..-1].strip
+        else
+          ## assume city / geo tree
+          ## split into geo tree
+          geos = split_geo( value )
+          city = geos[0]
+          ## check for "embedded" district e.g. London (Fulham) or Hamburg (St. Pauli) etc.
+          if city =~ /\((.+?)\)/   ## note: use non-greedy (?) match
+            rec.district  = $1.strip
+            city          = city.gsub( /\(.+?\)/, '' ).strip
+          end
+          rec.city = city
+
+          if geos.size > 1
+             ## cut-off city and keep the rest (of geo tree)
+             rec.geos = geos[1..-1]
+          end
+        end
+      end  ## while values
+
+
+      ###############
+      ## use headings text for geo tree
+
+      ## 1) add country if present
+      if headings.size > 0 && headings[0]
+        country = SportDb::Import.config.countries[ headings[0] ]
+        rec.country = country
+      else
+        ## make it an error - why? why not?
+        puts "!!! error - country missing in headings hierarchy - sorry - add to quicklist"
+        exit 1
+      end
+
+      ## 2) check geo tree with headings hierarchy
+      if headings.size > 1 && headings[1]
+         geos = split_geo( headings[1] )
+         if rec.geos
+           if rec.geos[0] != geos[0]
+             puts "!!! error - geo tree - headings mismatch >#{rec.geos[0]}< <=> >#{geos[0]}<"
+             exit 1
+           end
+           if rec.geos[1] && rec.geos[1] != geos[1]   ## check optional 2nd level too
+             puts "!!! error - geo tree - headings mismatch >#{rec.geos[1]}< <=> >#{geos[1]}<"
+             exit 1
+           end
+         else
+           ## add missing region (state/province) from headings hierarchy
+           rec.geos = geos
+         end
+      end
+
+      last_rec = rec
+
+
+    ### todo/fix:
+    ##  auto-add alt name with dots stripped - why? why not?
+    ##    e.g.  D.C. United    => DC United
+    ##    e.g.  Liverpool F.C. => Liverpool FC
+    ##    e.g.  St. Albin       => St Albin etc.
+    ##    e.g.  1. FC Köln     => 1 FC Köln  -- make special case for 1. - why? why not?
+
+    ##
+    ## todo/fix:  unify mapping entries
+    ##   always lowercase !!!!  (case insensitive)
+    ##   always strip (2011-) !!!
+    ##   always strip dots (e.g. St., F.C, etc.)
+
+      recs << rec
+    end
+  end  # each_line
+  recs
+end  # method read
+
+###  helpers
+def self.split_geo( str )
+  ## assume city / geo tree
+  ##  strip and squish (white)spaces
+  #   e.g. León     › Guanajuato     => León › Guanajuato
+  str = str.strip.gsub( /[ \t]+/, ' ' )
+
+  ## split into geo tree
+  geos = str.split( /[<>‹›]/ )   ## note: allow > < or › ‹
+  geos = geos.map { |geo| geo.strip }   ## remove all whitespaces
+  geos
+end
+
+end  # class ClubReader
+
+
+end ## module Import
+end ## module SportDb