sportdb-models 1.10.0

data/lib/sportdb/patterns.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+module SportDb
+
+# collection of regex patterns for reuse (SportDb specific)
+
+### todo: add a patterns.md page to  github ??
+##  - add regexper pics??
+
+############
+# about ruby regexps
+#
+# try the rubular - Ruby regular expression editor and tester
+#  -> http://rubular.com
+#   code -> ??  by ??
+#
+#
+# Jeff Avallone's Regexper - Shows State-Automata Diagrams
+#  try -> http://regexper.com
+#    code -> https://github.com/javallone/regexper
+#
+#
+#  Regular Expressions | The Bastards Book of Ruby by Dan Nguyen
+# http://ruby.bastardsbook.com/chapters/regexes/
+#
+# move to notes  regex|patterns on  geraldb.github.io ??
+#
+
+  TEAM_KEY_PATTERN  = '\A[a-z]{3,}\z'
+  TEAM_KEY_PATTERN_MESSAGE = "expected three or more lowercase letters a-z /#{TEAM_KEY_PATTERN}/" 
+
+  # must start w/ letter a-z (2 n 3 can be number or underscore _)
+  TEAM_CODE_PATTERN = '\A[A-Z][A-Z0-9][A-Z0-9_]?\z'
+  TEAM_CODE_PATTERN_MESSAGE = "expected two or three uppercase letters A-Z (and 0-9_; must start with A-Z) /#{TEAM_CODE_PATTERN}/"
+
+
+end # module SportDb
+

data/lib/sportdb/reader.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+
+module SportDb
+
+class ReaderBase
+
+  include LogUtils::Logging
+
+
+## make models available in sportdb module by default with namespace
+#  e.g. lets you use Team instead of Model::Team
+  include SportDb::Models
+  include SportDb::Matcher # lets us use match_teams_for_country etc.
+
+
+  def load_setup( name )
+    reader = create_fixture_reader( name )
+
+    reader.each do |fixture_name|
+      load( fixture_name )
+    end
+  end # method load_setup
+
+
+  def load( name )   # convenience helper for all-in-one reader
+
+    logger.debug "enter load( name=>>#{name}<<)"    ## formerly also printed -> include_path=>>#{include_path}<<
+
+    if match_players_for_country( name ) do |country_key|
+            ## country = Country.find_by_key!( country_key )
+            ## fix-fix-fix-fix-fix-fix: change to new format e.g. from_file, from_zip etc!!!
+            ## reader = PersonDb::PersonReader.new( include_path )
+            ## reader.read( name, country_id: country.id )
+          end
+    elsif name =~ /\/squads\/([a-z0-9]{3,})$/    # e.g. ajax.txt bayern.txt etc.
+      ## note: for now assume club (e.g. no dash (-) allowed for country code e.g. br-brazil etc.)
+      team = Team.find_by_key!( $1 )
+      ## note: pass in @event.id - that is, last seen event (e.g. parsed via GameReader/MatchReader)
+      reader = create_club_squad_reader( name, team_id: team.id, event_id: @event.id )
+      reader.read()
+    elsif name =~ /\/squads\/([a-z]{2,3})-[^\/]+$/
+      ## fix: add to country matcher new format
+      ##   name is country! and parent folder is type name e.g. /squads/br-brazil
+      
+      # note: if two letters, assume country key
+      #       if three letters, assume team key
+  
+      ##   allow three letter codes
+      ##  assume three letter code are *team* codes (e.g. fdr, gdr, etc)
+      ##      not country code (allows multiple teams per country)
+
+      if $1.length == 2
+        ## get national team via country
+        country = Country.find_by_key!( $1 )
+        ###  for now assume country code matches team for now (do NOT forget to downcase e.g. BRA==bra)
+        logger.info "  assume country code == team code for #{country.code}"
+        team = Team.find_by_key!( country.code.downcase )
+      else  # assume length == 3
+        ## get national team directly (use three letter fifa code)
+        team = Team.find_by_key!( $1 )
+      end
+      ## note: pass in @event.id - that is, last seen event (e.g. parsed via GameReader/MatchReader)
+      reader = create_national_team_squad_reader( name, team_id: team.id, event_id: @event.id  )
+      reader.read()
+    elsif name =~ /(?:^|\/)seasons/  # NB: ^seasons or also possible at-austria!/seasons
+      reader = create_season_reader( name )
+      reader.read()
+    elsif name =~ /(?:^|\/)assocs/  # NB: ^assocs or also possible national-teams!/assocs
+      reader = create_assoc_reader( name )
+      reader.read()
+    elsif match_stadiums_for_country( name ) do |country_key|
+            country = Country.find_by_key!( country_key )
+            reader = create_ground_reader( name, country_id: country.id )
+            reader.read()
+          end
+    elsif match_leagues_for_country( name ) do |country_key|  # name =~ /^([a-z]{2})\/leagues/
+            # auto-add country code (from folder structure) for country-specific leagues
+            #  e.g. at/leagues
+            country = Country.find_by_key!( country_key )
+            reader = create_league_reader( name, club: true, country_id: country.id )
+            reader.read()
+          end
+    elsif name =~ /(?:^|\/)leagues/   # NB: ^leagues or also possible world!/leagues  - NB: make sure goes after leagues_for_country!!
+      reader = create_league_reader( name )
+      reader.read()
+    elsif match_teams_for_country( name ) do |country_key|   # name =~ /^([a-z]{2})\/teams/
+            # auto-add country code (from folder structure) for country-specific teams
+            #  e.g. at/teams at/teams.2 de/teams etc.
+            country = Country.find_by_key!( country_key )
+            reader = create_team_reader( name, country_id: country.id )
+            reader.read()
+          end
+    elsif match_clubs_for_country( name ) do |country_key|   # name =~ /^([a-z]{2})\/clubs/
+            # auto-add country code (from folder structure) for country-specific clubs
+            #  e.g. at/teams at/teams.2 de/teams etc.                
+            country = Country.find_by_key!( country_key )
+            reader = create_team_reader( name, club: true, country_id: country.id )   ## note: always sets club flag to true
+            reader.read()
+          end
+    elsif name =~ /(?:^|\/)teams/   ## fix: check if teams rule above (e.g. /^teams/ )conflicts/matches first ???
+      ### fix: use new NationalTeamReader ??? why? why not?
+      reader = create_team_reader( name )   ## note: always sets club flag to true / national to true
+      reader.read()
+    elsif name =~ /(?:^|\/)clubs/
+      ### fix: use new ClubReader ??? why? why not?
+      reader = create_team_reader( name, club: true )     ## note: always sets club flag to true / national to false
+      reader.read()
+    elsif name =~ /\/(\d{4}|\d{4}[_\-]\d{2})(--[^\/]+)?\// ||
+          name =~ /\/(\d{4}|\d{4}[_\-]\d{2})$/
+
+      # note: allow 2013_14 or 2013-14 (that, is dash or underscore)
+
+      # note: keep a "public" reference of last event in @event  - e.g. used/required by squads etc.
+      eventreader = create_event_reader( name )
+      eventreader.read()
+      @event    = eventreader.event
+
+      # e.g. must match /2012/ or /2012_13/  or   /2012--xxx/ or /2012_13--xx/
+      #  or   /2012 or /2012_13   e.g. brazil/2012 or brazil/2012_13
+      reader = create_game_reader( name )
+      reader.read()
+    else
+      logger.error "unknown sportdb fixture type >#{name}<"
+      # todo/fix: exit w/ error
+    end
+  end # method load
+
+
+end # class Reader
+end # module SportDb

data/lib/sportdb/reader_file.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+module SportDb
+
+## todo: "old" classic reader - rename to FileReader ?? why? why not?
+
+class Reader < ReaderBase
+
+  attr_reader :include_path
+
+  def initialize( include_path, opts={})
+    @include_path = include_path
+  end
+
+  def create_fixture_reader( name )
+    path = "#{@include_path}/#{name}.txt"
+
+    logger.info "parsing data (setup) '#{name}' (#{path})..."
+
+    FixtureReader.from_file( path )
+  end  
+
+  def create_club_squad_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (club squad) '#{name}' (#{path})..."
+    ClubSquadReader.from_file( path, more_attribs )
+  end
+
+  def create_national_team_squad_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (national team squad) '#{name}' (#{path})..."
+    NationalTeamSquadReader.from_file( path, more_attribs )
+  end
+
+  def create_season_reader( name )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (season) '#{name}' (#{path})..."
+    SeasonReader.from_file( path )
+  end
+
+  def create_assoc_reader( name )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (assoc) '#{name}' (#{path})..."
+    AssocReader.from_file( path )
+  end
+
+  def create_ground_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (ground) '#{name}' (#{path})..."
+    GroundReader.from_file( path, more_attribs )
+  end
+
+  def create_league_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (league) '#{name}' (#{path})..."
+    LeagueReader.from_file( path, more_attribs )
+  end
+
+  def create_team_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.txt"
+
+    logger.info "parsing data (team) '#{name}' (#{path})..."
+    TeamReader.from_file( path, more_attribs )
+  end
+
+  def create_event_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    path = "#{@include_path}/#{real_name}.yml"
+
+    logger.info "parsing data (event) '#{name}' (#{path})..."
+    EventReader.from_file( path, more_attribs )
+  end
+
+  def create_game_reader( name, more_attribs={} )
+    real_name = name_to_real_name( name )
+    
+    ## NOTE: pass in .yml as path (that is, event config!!!!)
+    path = "#{@include_path}/#{real_name}.yml"
+
+    logger.info "parsing data (fixture) '#{name}' (#{path})..."
+    GameReader.from_file( path, more_attribs )
+  end
+
+
+  def create_person_reader( name, more_attribs={} )
+    ## fix-fix-fix: change to new format e.g. from_file, from_zip etc!!!
+    ## reader = PersonDb::PersonReader.new( include_path )
+    # reader.read( name, country_id: country.id )
+  end
+
+private
+
+  def name_to_real_name( name )
+    # map name to real_name path
+    # name might include !/ for virtual path (gets cut off)
+    # e.g. at-austria!/w-wien/beers becomse w-wien/beers
+    pos = name.index( '!/')
+    if pos.nil?
+      name # not found; real path is the same as name
+    else
+      # cut off everything until !/ e.g.
+      # at-austria!/w-wien/beers becomes
+      # w-wien/beers
+      name[ (pos+2)..-1 ]
+    end
+  end # method name_to_real_name
+
+
+end # class Reader
+end # module SportDb

data/lib/sportdb/reader_zip.rb

@@ -0,0 +1,165 @@
+# encoding: utf-8
+
+module SportDb
+
+
+class ZipReader < ReaderBase
+
+  def initialize( name, include_path, opts = {} )
+
+    ## todo/fix: make include_path an opts (included in opts?) - why? why not??
+
+    path = "#{include_path}/#{name}.zip"
+    ## todo: check if zip exists
+
+    @zip_file = Zip::File.open( path )   ## NOTE: do NOT create if file is missing; let it crash
+    
+    ### allow prefix (path) in name
+    ###    e.g. assume all files relative to setup manifest
+    ## e.g. at-austria-master/setups/all.txt or
+    ##      be-belgium-master/setups/all.txt
+    ##  for
+    ##    setups/all.txt
+    ###
+    ##  will get (re)set w/ fixture/setup reader
+    ##
+    ## todo/fix: change/rename to @relative_path ?? - why? why not? 
+    @zip_prefix = ''
+  end
+
+  def close
+    ## todo/check: add a close method - why? why not ???
+    @zip_file.close
+  end
+
+
+  def create_fixture_reader( name )
+    ## e.g. pass in =>  setups/all  or setups/test etc.  e.g. w/o .txt extension
+    query = "**/#{name}.txt"
+
+    ## note: returns an array of Zip::Entry
+    candidates = @zip_file.glob( query )
+    pp candidates
+
+    ## use first candidates entry as match
+    ## todo/fix: issue warning if more than one entries/matches!!
+
+    ## get fullpath e.g. at-austria-master/setups/all.txt
+    path = candidates[0].name
+    logger.debug "  zip entry path >>#{path}<<"
+
+    ## cut-off at-austria-master/    NOTE: includes trailing slash (if present)
+    ## logger.debug "  path.size #{path.size} >>#{path}<<"
+    ## logger.debug "  name.size #{name.size+4} >>#{name}<<"
+
+    ## note: add +4 for extension (.txt)
+    @zip_prefix = path[ 0...(path.size-(name.size+4)) ]
+    logger.debug "  zip entry prefix >>#{@zip_prefix}<<"
+
+    logger.info "parsing data in zip '#{name}' (#{path})..."
+
+    FixtureReader.from_zip( @zip_file, path )
+  end
+
+  def create_club_squad_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (club squad) '#{name}' (#{path})..."
+    ClubSquadReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_national_team_squad_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (national team squad) '#{name}' (#{path})..."
+    NationalTeamSquadReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_season_reader( name )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (season) '#{name}' (#{path})..."
+    SeasonReader.from_zip( @zip_file, path )
+  end
+
+  def create_assoc_reader( name )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (assoc) '#{name}' (#{path})..."
+    AssocReader.from_zip( @zip_file, path )
+  end
+
+  def create_ground_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (ground) '#{name}' (#{path})..."
+    GroundReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_league_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (league) '#{name}' (#{path})..."
+    LeagueReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_team_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name )
+
+    logger.info "parsing data in zip (team) '#{name}' (#{path})..."
+    TeamReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_event_reader( name, more_attribs={} )
+    path = name_to_zip_entry_path( name, '.yml' )   ## NOTE: use .yml extension
+
+    logger.info "parsing data in zip (event) '#{name}' (#{path})..."
+    EventReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+  def create_game_reader( name, more_attribs={} )
+    ## NOTE: pass in .yml as path (that is, event config!!!!)
+    path = name_to_zip_entry_path( name, '.yml' )     ## NOTE: use .yml extension
+    
+    logger.info "parsing data in zip (fixture) '#{name}' (#{path})..."
+    GameReader.from_zip( @zip_file, path, more_attribs )
+  end
+
+
+  def create_person_reader( name, more_attribs={} )
+    ## fix-fix-fix: change to new format e.g. from_file, from_zip etc!!!
+    ## reader = PersonDb::PersonReader.new( include_path )
+    # reader.read( name, country_id: country.id )
+  end
+
+private
+
+  def path_to_real_path( path )
+    # map name to name_real_path
+    # name might include !/ for virtual path (gets cut off)
+    # e.g. at-austria!/w-wien/beers becomse w-wien/beers
+    pos = path.index( '!/')
+    if pos.nil?
+      path # not found; real path is the same as name
+    else
+      # cut off everything until !/ e.g.
+      # at-austria!/w-wien/beers becomes
+      # w-wien/beers
+      path[ (pos+2)..-1 ]
+    end
+  end
+
+  def name_to_zip_entry_path( name, extension='.txt' )
+    path = "#{name}#{extension}"
+
+    real_path = path_to_real_path( path )
+
+    # NOTE: add possible zip entry prefix path
+    #          (if present includes trailing slash e.g. /)
+    entry_path = "#{@zip_prefix}#{real_path}"
+    entry_path
+  end
+
+end # class ZipReader
+
+end # module SportDb