footballdb-clubs 2019.11.22

data/lib/footballdb/clubs.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+
+###
+#  sport.db gems / libraries
+require 'fifa'
+require 'sportdb/clubs'
+
+
+###
+# our own code
+require 'footballdb/clubs/version' # let version always go first
+
+
+module FootballDb
+module Import
+
+## add "fake" configuration for stand-alone usage
+class Configuration
+  def initialize
+    recs       = Fifa.countries
+    @countries = SportDb::Import::CountryIndex.new( recs )
+  end
+
+  def countries() @countries; end
+end
+
+
+
+
+class Club    ## todo/check: use a module instead of class - why? why not?
+  def self.clubs()      club_index.clubs; end   ## return all clubs (struct-like) records
+  def self.all()   clubs; end  ## use ActiveRecord-like alias for clubs
+
+  def self.mappings()   club_index.mappings; end
+
+  def self.[]( name )   club_index[ name ]; end  ## lookup by canoncial name only
+  def self.match( name ) club_index.match( name ); end
+  def self.match_by( name:, country: ) club_index.match_by( name: name, country: country ); end
+
+
+  def self.club_index
+    @club_index ||= build_club_index
+    @club_index
+  end
+
+private
+  def self.build_club_index
+    if defined?( SportDb::Import::Configuration )
+       # assume running "inside" sportdb - (re)use sportdb configuration
+    else
+       # assume running "stand-alone" - setup configuration for countries / country mapping
+       config = Configuration.new
+       SportDb::Import::ClubReader.config = config
+       SportDb::Import::ClubIndex.config  = config
+       SportDb::Import::WikiReader.config = config
+    end
+
+    recs = SportDb::Import::ClubReader.read( "#{FootballDb::Clubs.data_dir}/clubs.txt" )
+    club_index = SportDb::Import::ClubIndex.new
+    club_index.add( recs )
+    recs = SportDb::Import::WikiReader.read( "#{FootballDb::Clubs.data_dir}/clubs.wiki.txt" )
+    club_index.add_wiki( recs )
+    club_index
+  end
+end # class Club
+
+end # module Import
+end # module FootballDb
+
+
+
+### add top-level (global) convenience alias
+Club = FootballDb::Import::Club
+
+
+
+puts FootballDb::Clubs.banner   # say hello

data/lib/footballdb/clubs/version.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+
+module FootballDb
+module Clubs
+
+  MAJOR = 2019    ## todo: namespace inside version or something - why? why not??
+  MINOR = 11
+  PATCH = 22
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "footballdb-clubs/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )
+  end
+
+  def self.data_dir  ## rename to config_dir - why? why not?
+    "#{root}/config"
+  end
+
+end # module Clubs
+end # module FootballDb

data/test/helper.rb

@@ -0,0 +1,10 @@
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'footballdb/clubs'

data/test/test_club.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_club.rb
+
+
+require 'helper'
+
+class TestClub < MiniTest::Test
+
+  def test_match
+
+    m = Club.match( 'Rapid Wien' )
+    assert_equal 'SK Rapid Wien', m[0].name
+    assert_equal 'Austria',       m[0].country.name
+    assert_equal 'Wien',          m[0].city
+
+    m = Club.match( 'rapid wien' )
+    assert_equal 'SK Rapid Wien', m[0].name
+    assert_equal 'Austria',       m[0].country.name
+    assert_equal 'Wien',          m[0].city
+
+    ## note: all dots (.) get always removed
+    m = Club.match( '...r.a.p.i.d w.i.e.n...' )
+    assert_equal 'SK Rapid Wien', m[0].name
+    assert_equal 'Austria',       m[0].country.name
+    assert_equal 'Wien',          m[0].city
+
+    ## note: all spaces and dashes (-) get always removed
+    m = Club.match( '--- r a p i d  w i e n ---' )
+    assert_equal 'SK Rapid Wien', m[0].name
+    assert_equal 'Austria',       m[0].country.name
+    assert_equal 'Wien',          m[0].city
+
+    m = Club.match( 'RAPID WIEN' )
+    assert_equal 'SK Rapid Wien', m[0].name
+    assert_equal 'Austria',       m[0].country.name
+    assert_equal 'Wien',          m[0].city
+
+
+    c = Club[ 'SK Rapid Wien' ]   ## check canoncial name match (only)
+    assert_equal 'SK Rapid Wien', c.name
+    assert_equal 'Austria',       c.country.name
+    assert_equal 'Wien',          c.city
+
+
+    m = Club.match( 'Arsenal' )
+    assert_equal 3, m.size
+
+    m = Club.match( 'ARSENAL' )
+    assert_equal 3, m.size
+
+    m = Club.match_by( name: 'Arsenal', country: 'eng' )
+    assert_equal 1, m.size
+    assert_equal 'Arsenal FC', m[0].name
+    assert_equal 'England',    m[0].country.name
+    assert_equal 'London',     m[0].city
+
+    m = Club.match_by( name: 'Arsenal', country: 'ar' )
+    assert_equal 1, m.size
+    assert_equal 'Arsenal de Sarandí', m[0].name
+    assert_equal 'Argentina',          m[0].country.name
+    assert_equal 'Sarandí',            m[0].city
+
+    m = Club.match_by( name: 'Arsenal', country: 'ru' )
+    assert_equal 1, m.size
+    assert_equal 'Arsenal Tula', m[0].name
+    assert_equal 'Russia',       m[0].country.name
+    assert_equal 'Tula',         m[0].city
+
+
+    m = Club.match( 'Arsenal FC' )
+    assert_equal 2, m.size
+
+    m = Club.match( 'Arsenal F.C.' )
+    assert_equal 2, m.size
+
+    m = Club.match( '...A.r.s.e.n.a.l... F.C...' )
+    assert_equal 2, m.size
+end
+
+
+def test_wikipedia    # test wikipedia names and links/urls
+
+    m = Club.match( 'Club Brugge KV' )
+    assert_equal 1, m.size
+    assert_equal 'Club Brugge KV', m[0].wikipedia
+    assert_equal 'https://en.wikipedia.org/wiki/Club_Brugge_KV', m[0].wikipedia_url
+
+    m = Club.match( 'RSC Anderlecht' )
+    assert_equal 1, m.size
+    assert_equal 'R.S.C. Anderlecht', m[0].wikipedia
+    assert_equal 'https://en.wikipedia.org/wiki/R.S.C._Anderlecht', m[0].wikipedia_url
+  end
+
+end # class TestClub

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: footballdb-clubs
+version: !ruby/object:Gem::Version
+  version: 2019.11.22
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sportdb-clubs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: fifa
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: footballdb-clubs - the world's top football clubs
+email: opensport@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- config/clubs.txt
+- config/clubs.wiki.txt
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- config/clubs.txt
+- config/clubs.wiki.txt
+- lib/footballdb/clubs.rb
+- lib/footballdb/clubs/version.rb
+- test/helper.rb
+- test/test_club.rb
+homepage: https://github.com/sportdb/sport.db
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: footballdb-clubs - the world's top football clubs
+test_files: []