sportdb-catalogs 1.2.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4615353b8720394e2c0edcd97de249822923718bf9d7703e4ce2f93f4411b372
-  data.tar.gz: ac4536c29d15caf8bf5c3de62539785f17fbad3e6098c5e0d18282c1e5cccb2a
+  metadata.gz: 8b593473df2d17fc60175c907bf78b0794f3bc26a6234cc247d58e788f8850ec
+  data.tar.gz: 0a9f535f23da1d3da21173d1c7d7588188e287b299c448f47bb8fa0cf9e33aa7
 SHA512:
-  metadata.gz: 93dc76f6a2dd70d04a9ebb6700e66bbcd41a98cd517a9f1ed24b6a2ad667806963ffd2fda6991a02600c3aa4d61c45431201b4f350a37b4a080e53bf664866ec
-  data.tar.gz: f0cc52b6590c598ec8ae40abdb7b8238a647617b10825b76d4c910bcd01ca7facde765cf977e0abb807312fa7fa55ffa83a239446962b209c8a747004e43e03a
+  metadata.gz: 927b572cef955abbc720ce43b4fab2cff7ac3f1eaae1514069302421d4172dcb96d3b02e96d36141a900f19e12efe1a820e44881e9a43ad3eeae983c8166f060
+  data.tar.gz: 7058a7524a1381e28b46586db1fd0b93d35ebbd807d2b75a20b2ef6071bdf738ad3db0bb3f142c83632c0b4203c42da314e6e7b6bfbcfcbf9741c7ab3f89083d

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 1.2.1
+### 1.2.3
 ### 0.0.1 / 2019-06-29
 
 * Everything is new. First release.

data/README.md

@@ -9,23 +9,19 @@
 
 
 
-## Usage  
+## Usage
 
 Let's use the [/clubs datasets](https://github.com/openfootball/clubs)
-(1500+ football clubs from around the world)
+(3000+ football clubs from around the world)
 to match name "variants" e.g. `Arsenal`  to canonical global unique
 names e.g. `Arsenal FC, London, England`:
 
 ``` ruby
 require 'sportdb/catalogs'
 
-## note: requires a local copy of the football.db clubs datasets
-##          see https://github.com/openfootball/clubs
-SportDb::Import.config.clubs_dir = './clubs'
+Club = CatalogDb::Metal::Club
 
-CLUBS = SportDb::Import.catalog.clubs
-
-m = CLUBS.match( 'Arsenal' )
+m = Club.match_by( name: 'Arsenal' )
 m.size     # 3 club matches found
 #=> 3
 m[0].name; m[0].city; m[0].country
@@ -36,20 +32,20 @@ m[2].name; m[2].city; m[2].country
 #=> "Arsenal de Sarandí", "Sarandí", "Argentina"
 
 
-m = CLUBS.match_by( name: 'Arsenal', country: 'eng' )
+m = Club.match_by( name: 'Arsenal', country: 'eng' )
 # -or- try alternative names (and auto-generated spelling variants)
-m = CLUBS.match_by( name: 'Arsenal FC', country: 'eng' )
-m = CLUBS.match_by( name: 'Arsenal F.C.', country: 'eng' )
-m = CLUBS.match_by( name: '...A.r.s.e.n.a.l... F.C...', country: 'eng' )
+m = Club.match_by( name: 'Arsenal FC', country: 'eng' )
+m = Club.match_by( name: 'Arsenal F.C.', country: 'eng' )
+m = Club.match_by( name: '...A.r.s.e.n.a.l... F.C...', country: 'eng' )
 m.size     # 1 club match found
 #=> 1
 m[0].name; m[0].city; m[0].country
 #=> "Arsenal FC", "London", "England"
 
-m = CLUBS.match_by( name: 'Arsenal', country: 'ar' )
+m = Club.match_by( name: 'Arsenal', country: 'ar' )
 # -or- try alternative names (and auto-generated spelling variants)
-m = CLUBS.match_by( name: 'Arsenal Sarandí', country: 'ar' )
-m = CLUBS.match_by( name: 'Arsenal Sarandi', country: 'ar' )
+m = Club.match_by( name: 'Arsenal Sarandí', country: 'ar' )
+m = Club.match_by( name: 'Arsenal Sarandi', country: 'ar' )
 m.size     # 1 club match found
 #=> 1
 m[0].name; m[0].city; m[0].country
@@ -57,15 +53,15 @@ m[0].name; m[0].city; m[0].country
 
 
 # try some more
-m = CLUBS.match( 'AZ' )
+m = Club.match_by( name: 'AZ' )
 m[0].name; m[0].city; m[0].country
 #=> "AZ Alkmaar", "Alkmaar", "Netherlands"
 
-m = CLUBS.match( 'Bayern' )
+m = Club.match_by( name: 'Bayern' )
 # -or- try alternative names (and auto-generated spelling variants)
-m = CLUBS.match( 'Bayern München' )
-m = CLUBS.match( 'Bayern Munchen' )
-m = CLUBS.match( 'Bayern Muenchen' )
+m = Club.match_by( name: 'Bayern München' )
+m = Club.match_by( name: 'Bayern Munchen' )
+m = Club.match_by( name: 'Bayern Muenchen' )
 m[0].name; m[0].city; m[0].country
 #=> "Bayern München", "München", "Germany"
 

data/Rakefile

@@ -20,9 +20,9 @@ Hoe.spec 'sportdb-catalogs' do
   self.licenses = ['Public Domain']
 
   self.extra_deps = [
-    ['sportdb-formats', '>= 2.0.0'],
+    ['sportdb-structs', '>= 0.3.1'],
     ['sqlite3'],          ## add sqlite for "metal" use (no activerecord etc.)
-    ['footballdb-data']   ## add builtin default db
+    ['footballdb-data', '>= 2024.8.23']   ## add builtin default db
   ]
 
   self.spec_extras = {

data/lib/sportdb/catalogs/base.rb

@@ -8,29 +8,29 @@ module Metal
 
 
 class BaseRecord   ## or just use Base or such - why? why not?
- 
-      def self.execute( sql ) 
+
+      def self.execute( sql )
          ## puts "==> sql query [#{self.name}]"
          ## puts sql
-         database.execute( sql ) 
+         database.execute( sql )
       end
- 
+
       def self.tablename=(name) @tablename = name; end
       def self.tablename() @tablename; end
- 
-      def self.columns=(names) 
+
+      def self.columns=(names)
          ## note: auto-add table name to qualify
-         @columns = names.map {|name| "#{self.tablename}.#{name}" } 
+         @columns = names.map {|name| "#{self.tablename}.#{name}" }
          @columns
       end
       def self.columns() @columns; end
- 
+
       def self.count
          sql = "SELECT count(*) FROM #{self.tablename}"
          rows = execute( sql )
          rows[0][0]    # e.g. returns [[241]]
       end
- 
+
   ## helpers from country - use a helper module for includes (share with clubs etc.) - why? why not?
   # include NameHelper
   extend SportDb::NameHelper
@@ -48,7 +48,7 @@ class BaseRecord   ## or just use Base or such - why? why not?
        ## use TypeError - why? why not? or if exits ValueError?
        raise ArgumentError, "0 or 1 expected for bool in sqlite; got #{value}"
      end
-   end             
+   end
 
 
    ##
@@ -58,7 +58,7 @@ class BaseRecord   ## or just use Base or such - why? why not?
       if country.is_a?( String ) || country.is_a?( Symbol )
         # note: query/find country via catalog db
         rec = Country.find_by_code( country )
-        rec = Country.find_by_name( country )  if rec.nil?  
+        rec = Country.find_by_name( country )  if rec.nil?
         if rec.nil?
           puts "** !!! ERROR !!! - unknown country >#{country}< - no match found, sorry - add to world/countries.txt in config"
           exit 1
@@ -72,41 +72,50 @@ end  # class BaseRecord
 
 
 class PlayerRecord  < BaseRecord
+
+      ## lets you query if datbase setup
+      def self.database?() defined?( @@db ); end
+
       def self.database
          ### note: only one database for all derived records/tables!!!
          ##   thus MUST use @@ and not @!!!!!
          ##  todo - change later to built-in database
          ##   or download on request???
-         @@db ||= SQLite3::Database.new( './players.db' ) 
+         @@db ||= SQLite3::Database.new( './players.db', readonly: true )
          @@db
       end
- 
+
       def self.database=(path)
          puts "==> setting (internal) players db to: >#{path}<"
-         @@db = SQLite3::Database.new( path )
+         @@db = SQLite3::Database.new( path, readonly: true )
          pp @@db
          @@db
-      end 
+      end
 end   # class PlayerRecord
 
 
 
 ##############
 ### todo (fix) / rename to CatalogRecord - why? why not?
-class Record  < BaseRecord    
+class Record  < BaseRecord
     ## add db alias why? why not?
+
+     ## lets you query if datbase setup
+     def self.database?() defined?( @@db ); end
+
      def self.database
         ### note: only one database for all derived records/tables!!!
         ##   thus MUST use @@ and not @!!!!!
         ##
         ##  default to built-in via footballdb-data gem for now!!!
-        @@db ||= SQLite3::Database.new( './catalog.db' ) 
+        @@db ||= SQLite3::Database.new( "#{FootballDb::Data.data_dir}/catalog.db",
+                                        readonly: true )
         @@db
      end
 
      def self.database=(path)
         puts "==> setting (internal) catalog db to: >#{path}<"
-        @@db = SQLite3::Database.new( path )
+        @@db = SQLite3::Database.new( path, readonly: true )
         pp @@db
         @@db
      end
@@ -118,14 +127,14 @@ def self._to_league( key )
    League._record( key )
 end
 
-def self._to_country( key ) 
+def self._to_country( key )
    # note: use cached record or (faster) key lookup on fallback
-   Country._record( key )   
+   Country._record( key )
 end
 
 def self._to_city( key )   ### rename; use find_by_key / find_by( key: )
    # note: use cached record or (faster) key lookup on fallback
-   City._record( key )   
+   City._record( key )
 end
 
 
@@ -146,6 +155,29 @@ def self._city( city )
      city  ## (re)use city struct - no need to run lookup again
    end
 end
+
+
+def self._league( league )
+   if league.is_a?( String ) || league.is_a?( Symbol )
+     # note: query/find country via catalog db
+     ##   only query by code - why? why not?
+     recs = League.match_by_name_or_code( league )
+     if recs.empty?
+       puts "** !!! ERROR !!! - unknown league >#{league}< - no match found, sorry"
+       exit 1
+     elsif recs.size > 1
+       puts "** !!! ERROR !!! - league >#{league}< - too many matches found (#{recs.size}), sorry"
+       pp recs
+       exit 1
+     end
+     recs[0]
+   else   ## assume league struct
+     league  ## (re)use league struct - no need to run lookup again
+   end
+end
+
+
+
 end  # class Record
 
 

data/lib/sportdb/catalogs/event_info.rb

@@ -4,20 +4,22 @@ module Metal
 class EventInfo < Record
     self.tablename = 'event_infos'
 
-    self.columns = ['league_key', 
-                    'season', 
-                    'teams',    
+    self.columns = ['league_key',
+                    'season',
+                    'teams',
                     'matches',
                     'goals',
-                    'start_date',  
+                    'start_date',
                     'end_date']
-          
+
 
      def self._build_event_info( row )
         ## note: cache structs by key (do NOT rebuild duplicates; reuse)
         @cache ||= Hash.new
-        ## note: move EventInfo from sports/format to structs - why? why not?
-        @cache[ row[0] ] ||= SportDb::Import::EventInfo.new(
+        ## note cache key MUST be unique!
+        ##   use league PLUS season   (row[0] season only will NOT work)
+        key = "#{row[0]}_#{row[1]}"
+        @cache[ key ] ||= Sports::EventInfo.new(
                                 league: _to_league( row[0] ),
                                 season: Season.parse(row[1]),
                                 teams: row[2],
@@ -25,35 +27,33 @@ class EventInfo < Record
                                 goals: row[4],
                                 start_date: row[5] ? Date.strptime( row[5], '%Y-%m-%d' ) : nil,
                                 end_date: row[6]   ? Date.strptime( row[6], '%Y-%m-%d' ) : nil,
-                              )   
-     end                
-          
+                              )
+     end
+
 
     def self.seasons( league )
-      league_key = league.is_a?( String ) ? League.find!( league ).key 
-                                          : league.key
+      league_key = _league( league ).key
 
              rows =  execute( <<-SQL )
         SELECT #{self.columns.join(', ')}
-        FROM event_infos 
-        WHERE event_infos.league_key = '#{league_key}' 
+        FROM event_infos
+        WHERE event_infos.league_key = '#{league_key}'
 SQL
 
          rows.map {|row| _build_event_info( row ) }
     end
 
-    
+
     def self.find_by( league:, season: )
-      league_key = league.is_a?( String ) ? League.find!( league ).key 
-                                          : league.key
-      season_key = season.is_a?( String ) ? Season.parse(season).key 
+      league_key = _league( league ).key
+      season_key = season.is_a?( String ) ? Season.parse(season).key
                                           : season.key
 
              rows =  execute( <<-SQL )
         SELECT #{self.columns.join(', ')}
-        FROM event_infos 
+        FROM event_infos
         WHERE event_infos.league_key = '#{league_key}' AND
-              event_infos.season     = '#{season_key}' 
+              event_infos.season     = '#{season_key}'
 SQL
 
       if rows.empty?

data/lib/sportdb/catalogs/version.rb

@@ -5,7 +5,7 @@ module Catalogs
 
   MAJOR = 1    ## todo: namespace inside version or something - why? why not??
   MINOR = 2
-  PATCH = 1
+  PATCH = 3
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/sportdb/catalogs.rb

@@ -1,7 +1,4 @@
-### our own sportdb libs / gems
-###  try min. dependencies  - change to structs only (NOT formats) - why? why not?
-## require 'sportdb/structs'
-require 'sportdb/formats'
+require 'sportdb/structs'
 
 require 'sqlite3'
 
@@ -15,77 +12,17 @@ require_relative 'catalogs/base'       ## base record
 require_relative 'catalogs/country'
 require_relative 'catalogs/city'
 
-require_relative 'catalogs/club'   
+require_relative 'catalogs/club'
 require_relative 'catalogs/national_team'
 require_relative 'catalogs/league'
 require_relative 'catalogs/event_info'
-require_relative 'catalogs/ground'   
+require_relative 'catalogs/ground'
 
 ## more
 require_relative 'catalogs/player'
 
 
 
-module SportDb
-module Import
-
-class Configuration
-  ## note: add more configs (open class), see sportdb-structs for original config!!!
-
-  ###   
-  #  find a better name for setting - why? why not?
-  #     how about catalogdb or ???
-  attr_reader   :catalog_path 
-  def catalog_path=(path)
-      @catalog_path = path
-      ######## 
-      # reset database here to new path
-      CatalogDb::Metal::Record.database = path
-
-      ##  plus automagically set world search too (to use CatalogDb)
-      self.world = WorldSearch.new( 
-                          countries: CatalogDb::Metal::Country,
-                          cities:    CatalogDb::Metal::City, 
-                        ) 
-
-      @catalog_path
-  end
-
-  def catalog      
-       @catalog ||= SportSearch.new( 
-                           leagues:        CatalogDb::Metal::League,
-                           national_teams: CatalogDb::Metal::NationalTeam,
-                           clubs:          CatalogDb::Metal::Club,
-                           grounds:        CatalogDb::Metal::Ground,
-                           events:         CatalogDb::Metal::EventInfo,
-                           players:        CatalogDb::Metal::Player,    # note - via players.db !!!
-                        )
-  end
-
-  ###   
-  #  find a better name for setting - why? why not?
-  #     how about playersdb or ???
-  attr_reader   :players_path 
-  def players_path=(path)
-      @players_path = path
-      ######## 
-      # reset database here to new path
-      CatalogDb::Metal::PlayerRecord.database = path
-
-      @players_path
-  end
-end # class Configuration
-
-
-  ##  e.g. use config.catalog  -- keep Import.catalog as a shortcut (for "read-only" access)
-  def self.catalog() config.catalog;  end
-end   # module Import
-end   # module SportDb
-
-
-
-
-
 ###
 # add status
 module CatalogDb
@@ -94,34 +31,48 @@ module Metal
 def self.tables
 
   puts "==> table stats"
-  catalog_path = SportDb::Import.config.catalog_path 
-  if catalog_path
-    puts "  #{File.basename(catalog_path)} in (#{File.dirname(catalog_path)})"
-    puts "    #{Country.count} countries / #{City.count} cities" 
+  if Record.database?
+    db = Record.database
+    filename = db.filename
+    if filename  # note - nil for memory or tempary db?
+      puts "  #{File.basename(filename)} in (#{File.dirname(filename)})"
+    else
+      puts  "no filename; memory or temporary db?"
+    end
+
+    ## pp Record.database
+    ## puts
+    puts "    #{Country.count} countries / #{City.count} cities"
     puts "    #{NationalTeam.count} national teams"
     puts "    #{League.count} leagues"
     puts "    #{Club.count} clubs"
     puts "    #{Ground.count} grounds"
       ## add more
-
   else
     puts "  - no catalog.db set - "
   end
 
-  ## todo/fix:
-  ##   check if players_path configured???
-  players_path = SportDb::Import.config.players_path 
-  if players_path
-    puts "  #{File.basename(players_path)} in (#{File.dirname(players_path)})"
+
+  if PlayerRecord.database?
+    db = PlayerRecord.database
+    filename = db.filename
+    if filename  # note - nil for memory or tempary db?
+      puts "  #{File.basename(filename)} in (#{File.dirname(filename)})"
+    else
+      puts  "no filename; memory or temporary db?"
+    end
+
+    ## pp PlayerRecord.database
+    ## puts
     puts "    #{Player.count} players"
   else
-    puts " - no players.db set -"
+    puts "  - no players.db set -"
   end
 end
 
 end # module Metal
 end # module CatalogDb
-        
+
 
 
 ###
@@ -131,34 +82,34 @@ end # module CatalogDb
 ##  what name to use?
 ##    find_countries_for_league_clubs or such
 ##     find_countries_for_league  - why? why not?
-##     note -  returns array of countries OR single country 
+##     note -  returns array of countries OR single country
 
 def find_countries_for_league( league )
-    ## todo/fix: assert league is a League with country record/struct !!!!! 
+    ## todo/fix: assert league is a League with country record/struct !!!!!
 
-    countries = [] 
+    countries = []
     countries << league.country   ### assume league.country is already db record/struct - why? why not?
-    ## check for 2nd countries for known leagues 
+    ## check for 2nd countries for known leagues
     ## (re)try with second country - quick hacks for known leagues
     ##  e.g. Swanse, cardiff  in premier league
     ##       san mariono in serie a (italy)
     ##       monaco  in ligue 1 (france)
     ##       etc.
     ##   add  andorra to spanish la liga (e.g. andorra fc???)
- 
+
     case league.country.key
-    when 'eng' then countries << CatalogDb::Metal::Country._record('wal') 
+    when 'eng' then countries << CatalogDb::Metal::Country._record('wal')
     when 'sco' then countries << CatalogDb::Metal::Country._record('eng')
-    when 'ie'  then countries << CatalogDb::Metal::Country._record('nir')   
-    when 'fr'  then countries << CatalogDb::Metal::Country._record('mc') 
-    when 'es'  then countries << CatalogDb::Metal::Country._record('ad') 
+    when 'ie'  then countries << CatalogDb::Metal::Country._record('nir')
+    when 'fr'  then countries << CatalogDb::Metal::Country._record('mc')
+    when 'es'  then countries << CatalogDb::Metal::Country._record('ad')
     when 'it'  then countries << CatalogDb::Metal::Country._record('sm')
-    when 'ch'  then countries << CatalogDb::Metal::Country._record('li') 
+    when 'ch'  then countries << CatalogDb::Metal::Country._record('li')
     when 'us'  then countries << CatalogDb::Metal::Country._record('ca')
     when 'au'  then countries << CatalogDb::Metal::Country._record('nz')
-    end 
+    end
 
-    ## use single ("unwrapped") item for one country 
+    ## use single ("unwrapped") item for one country
     ##    otherwise use array
     country =  countries.size == 1 ? countries[0] : countries
     country
@@ -168,15 +119,8 @@ end
 
 
 
-
 require 'footballdb/data'   ## pull in catalog.db (built-in/default data/db)
 
-###
-## add default/built-in catalog here - why? why not?
-##  todo/fix  - set catalog_path on demand 
-##   note:  for now required for world search setup etc.
-SportDb::Import.config.catalog_path = "#{FootballDb::Data.data_dir}/catalog.db"
-
 
 
 puts SportDb::Module::Catalogs.banner   # say hello

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sportdb-catalogs
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-22 00:00:00.000000000 Z
+date: 2024-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sportdb-formats
+  name: sportdb-structs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2024.8.23
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2024.8.23
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement