persondb-models 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3da2b33fdafe18b96c185cc7917c19da383f99c
+  data.tar.gz: be15b5111437540510df731ad51315d97ed7de37
+SHA512:
+  metadata.gz: 6d25360bbcfb330021ff1662838385e2b174fc61e0f2947e583e46b49e97b3977234f77f9d585f386aea4b6c853b18edbc5f57fde6619513ecbf070de360cc2d
+  data.tar.gz: a16843304349ee92544a26e01f26d8781dddc80f704afba593973732d9dc2b0c0d0bb56dad4df26dba77af5e6e193b9da637cb10092450cf1efb27ef386aa349

data/HISTORY.md

@@ -0,0 +1,4 @@
+### 0.0.1 / 2014-03-05
+
+* Everything is new. First release.
+

data/Manifest.txt

@@ -0,0 +1,17 @@
+HISTORY.md
+Manifest.txt
+README.md
+Rakefile
+lib/persondb/models.rb
+lib/persondb/models/forward.rb
+lib/persondb/models/person.rb
+lib/persondb/models/world/city.rb
+lib/persondb/models/world/country.rb
+lib/persondb/models/world/region.rb
+lib/persondb/reader.rb
+lib/persondb/schema.rb
+lib/persondb/version.rb
+test/data/players/south-america/br-brazil/players.txt
+test/helper.rb
+test/test_models.rb
+test/test_reader.rb

data/README.md

@@ -0,0 +1,34 @@
+# persondb-models
+
+persondb-models gem - person.db schema 'n' models for easy (re)use
+
+* home  :: [github.com/persondb/person.db.models](https://github.com/persondb/person.db.models)
+* bugs  :: [github.com/persondb/person.db.models/issues](https://github.com/persondb/person.db.models/issues)
+* gem   :: [rubygems.org/gems/persondb-models](https://rubygems.org/gems/persondb-models)
+* rdoc  :: [rubydoc.info/gems/persondb-models](http://rubydoc.info/gems/persondb-models)
+
+## Usage
+
+TBD
+
+## Alternatives
+
+TBD
+
+
+## Real World Usage
+
+[wine.db](https://github.com/openwine) - Used for Winemakers
+
+[football.db](https://github.com/openfootball) - Used for Football Players (Goalies, Defenders, Midfielders, etc.)
+
+[ski.db](https://github.com/opensport/ski.db) - Use for Alpine Ski Racers
+
+[forumula1.db](https://github.com/opensport/formula1.db) - Used for Formula 1 Race Drivers
+
+
+
+## License
+
+The `persondb-models` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'hoe'
+require './lib/persondb/version.rb'
+
+Hoe.spec 'persondb-models' do
+
+  self.version = PersonDb::VERSION
+
+  self.summary = "persondb-models - person schema 'n' models for easy (re)use"
+  self.description = summary
+
+  self.urls    = ['https://github.com/persondb/person.db.models']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'opensport@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+  self.extra_deps = [
+    ['worlddb-models']    ## get all (extra) dependencies via worlddb-models
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 1.9.2'
+  }
+
+end
+

data/lib/persondb/models.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'logger'
+
+# 3rd party gems / libs
+require 'worlddb/models'    # note: let worlddb pull in all 3rd party gems / libs (do NOT duplicate here)
+
+
+### our own code
+
+require 'persondb/version'  # let it always go first
+require 'persondb/schema'
+
+require 'persondb/models/forward'
+
+require 'persondb/models/world/city'
+require 'persondb/models/world/region'
+require 'persondb/models/world/country'
+
+require 'persondb/models/person'
+require 'persondb/reader'
+
+
+
+module PersonDb
+
+  def self.test_data_path
+    "#{root}/test/data"
+  end
+
+
+  def self.create
+    CreateDb.new.up
+
+    Model::Prop.create!( key: 'db.schema.person.version', value: VERSION )
+  end
+
+  def self.delete!
+    ## fix/todo: move into deleter class (see worlddb,sportdb etc.)
+    Model::Person.delete_all
+  end
+
+  def self.tables
+    ## fix/todo: move into stats class (see worlddb,sportdb etc.)
+    puts "  #{Model::Person.count} persons"
+  end
+
+  def self.setup_in_memory_db
+    # Database Setup & Config
+
+    ActiveRecord::Base.logger = Logger.new( STDOUT )
+    ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+    ## NB: every connect will create a new empty in memory db
+    ActiveRecord::Base.establish_connection(
+                                  adapter:  'sqlite3',
+                                  database: ':memory:' )
+
+    ## build schema
+    LogDb.create
+    ConfDb.create
+    TagDb.create
+    WorldDb.create
+    PersonDb.create
+  end  # method setup_in_memory_db
+
+
+end  # module PersonDb
+
+# say hello
+puts PersonDb.banner  if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)  

data/lib/persondb/models/forward.rb

@@ -0,0 +1,33 @@
+### forward references
+##   require first to resolve circular references
+
+module PersonDb
+  module Model
+
+    ## todo: why? why not use include WorldDb::Models here???
+    Continent = WorldDb::Model::Continent
+    Country   = WorldDb::Model::Country
+    Region    = WorldDb::Model::Region
+    City      = WorldDb::Model::City
+
+    Tagging   = TagDb::Model::Tagging
+    Tag       = TagDb::Model::Tag
+
+    Prop      = ConfDb::Model::Prop
+
+    class Person < ActiveRecord::Base ; end
+
+  end # module Model
+
+  ## note: for convenciene (and compatibility) add alias Models for Model namespace
+  ##  e.g lets you use include PersonDb::Models
+  Models = Model
+
+end # module PersonDb
+
+
+module WorldDb
+  module Model
+    Person   = PersonDb::Model::Person
+  end
+end

data/lib/persondb/models/person.rb

@@ -0,0 +1,109 @@
+# encoding: UTF-8
+
+module PersonDb
+  module Model
+
+class Person < ActiveRecord::Base
+
+  self.table_name = 'persons'
+
+  def title()       name               end  # alias for name
+  def title=(value) self.name = value  end  # alias for name
+
+
+  def self.create_or_update_from_values( new_attributes, values )
+
+    ## fix: add/configure logger for ActiveRecord!!!
+    logger = LogKernel::Logger.root
+
+    ## check optional values
+    values.each_with_index do |value, index|
+      if value =~ /^[a-z]{2}$/  ## assume two-letter country key e.g. at,de,mx,etc.
+        value_country = Country.find_by_key!( value )
+        new_attributes[ :country_id ] = value_country.id
+      elsif value =~ /^[A-Z]{3}$/  ## assume three-letter code e.g. AUS, MAL, etc.
+        new_attributes[ :code ] = value
+
+      #### fix: use more generic/better date reader (allow more formats!!!)
+      elsif value =~ /^([0-9]{1,2})\s(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s([0-9]{4})$/  ## assume birthday
+        value_date_str = '%02d/%s/%d' % [$1, $2, $3]     ## move to matcher!!
+        value_date = Date.strptime( value_date_str, '%d/%b/%Y' )  ## %b - abbreviated month name (e.g. Jan,Feb, etc.)
+        logger.debug "   birthday #{value_date_str}  -  #{value_date}"
+        new_attributes[ :born_at ] = value_date
+        ## todo: convert to date
+      else
+        ## todo: assume title2 ??
+        ## assume title2 if title2 is empty (not already in use)
+        ##  and if it title2 contains at least two letter e.g. [a-zA-Z].*[a-zA-Z]
+        # issue warning: unknown type for value
+        logger.warn "unknown type for value >#{value}< - key #{new_attributes[:key]}"
+      end
+    end
+
+    ## quick hack: set nationality_id if not present to country_id
+    if new_attributes[ :nationality_id ].blank?
+      new_attributes[ :nationality_id ] = new_attributes[ :country_id ]
+    end
+
+
+    ####################################################
+    # title-ize / normal-ize names (titles/synonyms)
+
+    ##
+    ##  make sure title and synonyms do NOT use all UPPERCASE
+    ##   e.g. convert Neymar DA SILVA SANTOS to Neymar Da Sliva Santos etc.
+
+    ### fix:  add auto camelcase/titlecase
+    ## move to textutils
+    ##  make it an option for name to auto Camelcase/titlecase?
+    ##  e.g. BONFIM COSTA SANTOS    becomes
+    ##       Bonfim Costa Santos  etc.
+    ##  fix: better move into person parser?
+    ##   store all alt_names titleized!!!
+
+    raw_title = new_attributes[ :title ]
+    new_title = titleize( raw_title )
+    if raw_title != new_title
+      logger.debug "  change person title/name to <#{new_title}> from >#{raw_title}<"
+      new_attributes[ :title ] = new_title
+    end
+
+    raw_synonyms = new_attributes[ :synonyms ]
+    if raw_synonyms.present?
+       new_synonyms = raw_synonyms.split('|').map { |value| titleize(value) }.join('|')
+       
+       if raw_synonyms != new_synonyms
+         logger.debug "  change person synonyms/alt_names to <#{new_synonyms}> from >#{raw_synonyms}<"
+         new_attributes[ :synonyms ] = new_synonyms
+       end
+    end
+
+
+
+    rec = Person.find_by_key( new_attributes[ :key ] )
+    if rec.present?
+      logger.debug "update Person #{rec.id}-#{rec.key}:"
+    else
+      logger.debug "create Person:"
+      rec = Person.new
+    end
+
+    logger.debug new_attributes.to_json
+
+    rec.update_attributes!( new_attributes )
+  end # create_or_update_from_values
+
+private
+
+
+  def self.titleize( str )    # note: added as class-level method for self.create etc.
+    ## fix: for now works only with ASCII only
+    ##  words 2 letters and ups
+    ##  fix also allow words w/ quote e.g.  O'Connor etc.
+    str.gsub(/\b[A-Z]{2,}\b/) { |match| match.capitalize }
+  end
+
+end # class Person
+
+  end # module Model
+end # module PersonDb

data/lib/persondb/models/world/city.rb

@@ -0,0 +1,10 @@
+module WorldDb
+  module Model
+
+class City
+  has_many :persons,   class_name: 'PersonDb::Model::Person',  foreign_key: 'city_id'
+end # class City
+
+  end # module Model
+end # module WorldDb
+

data/lib/persondb/models/world/country.rb

@@ -0,0 +1,10 @@
+module WorldDb
+  module Model
+
+class Country
+  has_many :persons,   class_name: 'PersonDb::Model::Person',  foreign_key: 'country_id'
+end # class Country
+
+  end # module Model
+end # module WorldDb
+

data/lib/persondb/models/world/region.rb

@@ -0,0 +1,10 @@
+module WorldDb
+  module Model
+
+class Region
+  has_many :persons,   class_name: 'PersonDb::Model::Person',  foreign_key: 'region_id'
+end # class Region
+
+  end # module Model
+end # module WorldDb
+

data/lib/persondb/reader.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+
+module PersonDb
+
+
+class PersonReader
+
+  include LogUtils::Logging
+
+## make models available by default with namespace
+#  e.g. lets you use Usage instead of Model::Usage
+  include Models
+
+  def self.from_zip( zip_file, entry_path, more_attribs={} )
+    ## get text content from zip
+    entry = zip_file.find_entry( entry_path )
+
+    text = entry.get_input_stream().read()
+    text = text.force_encoding( Encoding::UTF_8 )
+
+    self.from_string( text, more_attribs )
+  end
+
+  def self.from_file( path, more_attribs={} )
+    ## note: assume/enfore utf-8 encoding (with or without BOM - byte order mark)
+    ## - see textutils/utils.rb
+    text = File.read_utf8( path )
+    self.from_string( text, more_attribs )
+  end
+
+  def self.from_string( text, more_attribs={} )
+    PersonReader.new( text, more_attribs )
+  end  
+
+
+  def initialize( text, more_attribs={} )
+    ## todo/fix: how to add opts={} ???
+    @text = text
+    @more_attribs = more_attribs
+  end
+
+  def read()
+    reader = ValuesReader.from_string( @text, @more_attribs )
+
+    reader.each_line do |new_attributes, values|
+      Person.create_or_update_from_values( new_attributes, values )
+    end # each lines
+  end
+
+end # class PersonReader
+end # module PersonDb

data/lib/persondb/schema.rb

@@ -0,0 +1,66 @@
+# encoding: UTF-8
+
+module PersonDb
+
+class CreateDb
+
+def up
+  ActiveRecord::Schema.define do
+
+###########
+# use people ? instead of persons (person/persons makes it easier?)
+
+create_table :persons do |t|
+  t.string      :key,      null: false   # import/export key
+  t.string      :name,     null: false
+  t.string      :synonyms  # comma separated list of synonyms
+  ### fix: change to alt_names
+
+  t.string      :code       # three letter code (short title)  e.g used for formula1 driver etc.
+
+
+  ## todo: add gender flag (male/female -man/lady  how?)
+  t.date        :born_at     # optional date of birth (birthday)
+  ## todo: add country of birth  might not be the same as nationality
+
+  t.references  :city
+  t.references  :region
+  t.references  :country      ## ,  null: false
+
+  t.references  :nationality  ## , null: false  # by default assume same as country of birth (see above)
+## fix: add nationality2 n nationality3 too
+
+  t.timestamps
+end
+
+
+  end  # Schema.define
+end # method up
+
+end # class CreateDb
+
+end # module PersonDb
+
+
+
+=begin
+# old (original) sportdb persons table
+create_table :persons do |t|    # use people ? instead of persons (person/persons makes it easier?)
+  t.string      :key,      null: false   # import/export key
+  t.string      :name,     null: false
+  t.string      :synonyms  # comma separated list of synonyms
+  t.string      :code       # three letter code (short title)
+
+  ## todo: add gender flag (male/female -man/lady  how?)
+  t.date        :born_at     # optional date of birth (birthday)
+  ## todo: add country of birth  might not be the same as nationality
+
+  t.references  :city
+  t.references  :region
+  t.references  :country,   null: false
+
+  t.references  :nationality, null: false  # by default assume same as country of birth (see above)
+
+  t.timestamps
+end
+=end

data/lib/persondb/version.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module PersonDb
+
+  MAJOR = 0 ## todo: namespace inside version or something - why? why not??
+  MINOR = 4
+  PATCH = 2
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "persondb-models/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+end # module PersonDb

data/test/data/players/south-america/br-brazil/players.txt

@@ -0,0 +1,39 @@
+###
+# NB: let official (player) shirt name go first (e.g. Neymar Jr)
+
+
+## GK / Goalkeepers
+
+Jefferson|Jefferson DE OLIVEIRA GALVAO,          2 Jan 1983, 190
+Júlio César|Júlio César SOARES DE ESPINDOLA,     3 Sep 1979, 186
+D. Cavalieri|Diego CAVALIERI,                    1 Dec 1982, 189
+
+
+## DF / Defenders
+
+Dani Alves|Daniel ALVES DA SILVA,    6 May 1983, 172
+T. Silva|Thiago SILVA|Thiago EMILIANO DA SILVA, 22 Sep 1984, 183
+David Luiz, David Luiz MOREIRA MARINHO,  22 Apr 1987, 189
+Marcelo|Marcelo VIEIRA DA SILVA JUNIOR, 12 May 1988, 174
+Dante|Dante BONFIM COSTA SANTOS, 18 Oct 1983, 188
+Filipe Luís|Filipe Luís KASMIRSKI, 9 Aug 1985, 182
+Réver|Réver Humberto ALVES ARAUJO, 4 Jan 1985, 192
+
+## MF / Midfielders
+
+Fernando|Fernando Lucas MARTINS, 3 Mar 1992, 175
+Lucas|Lucas RODRIGUES MOURA SILVA, 13 Aug 1992, 173
+Hernanes|Anderson Hernanes DE CARVALHO VIANA LIMA, 29 May 1985, 180
+Oscar|Oscar DOS SANTOS EMBOABA JUNIOR,  9 Sep 1991, 180
+Jean|Jean Raphael VANDERLEI MOREIRA,  24 Jun 1986, 170
+L. Gustavo|Luiz Gustavo|Luiz Gustavo DIAS,   23 Jul 1987, 186
+Paulinho|José Paulo BEZERRA MACIEL JUNIOR, 25 Jul 1988, 182
+Bernard|Bernard ANICIO CALDEIRA DUARTE, 8 Sep 1992, 164
+Jádson|Jádson RODRIGUES, 5 Oct 1983, 169
+
+## FW / Forwards
+
+Fred|Frederico CHAVES GUEDES, 3 Oct 1983, 185
+Neymar Jr|Neymar|Neymar DA SILVA SANTOS JUNIOR,  5 Feb 1992, 174
+Hulk|Givanildo VIEIRA DE SOUSA, 25 Jul 1986, 180
+Jô|João Alves de Assis Silva,  20 Mar 1987

data/test/helper.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+require 'minitest/autorun'
+
+# our own code
+
+require 'persondb/models'
+
+
+################
+# shortcuts
+Country = WorldDb::Model::Country
+Region  = WorldDb::Model::Region
+City    = WorldDb::Model::City
+
+## todo: get all models aliases (e.g. from console script)
+
+Person        = PersonDb::Model::Person
+PersonReader  = PersonDb::PersonReader
+
+
+############
+# setup
+PersonDb.setup_in_memory_db
+

data/test/test_models.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+
+require 'helper'
+
+
+class TestModels < MiniTest::Test
+
+  def setup  # runs before every test
+    PersonDb.delete!   # always clean-out tables
+    WorldDb.delete!
+    add_world
+  end
+
+  def add_world
+    ## add some counties
+    at          = Country.create!( key: 'at', title: 'Austria', code: 'AUT', pop: 0, area: 0 )
+    n           = Region.create!( key: 'n', title: 'Niederösterreich', country_id: at.id )
+    feuersbrunn = City.create!( key: 'feuersbrunn', title: 'Feuersbrunn', country_id: at.id, region_id: n.id )
+  end
+
+
+  def test_worlddb_assocs
+    at          =  Country.find_by_key!( 'at' )
+    n           =  Region.find_by_key!( 'n' )
+    feuersbrunn =  City.find_by_key!( 'feuersbrunn' )
+
+    assert_equal 0, at.persons.count
+    assert_equal 0, n.persons.count
+    assert_equal 0, feuersbrunn.persons.count
+  end
+
+  def test_count
+    assert_equal 0, Person.count
+
+    PersonDb.tables  # print stats
+  end
+
+end # class TestModels

data/test/test_reader.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'helper'
+
+
+class TestReader < MiniTest::Test
+
+  def setup  # runs before every test
+    PersonDb.delete!   # always clean-out tables
+    WorldDb.delete!
+    add_world
+  end
+
+  def add_world
+    ## add some counties
+    Country.create!( key: 'br', title: 'Brazil', code: 'BRA', pop: 0, area: 0 )
+  end
+
+  def test_read
+    br = Country.find_by_key!( 'br' )
+
+    path = "#{PersonDb.test_data_path}/players/south-america/br-brazil/players.txt"
+    reader = PersonReader.from_file( path, country_id: br.id )
+    reader.read()
+
+    assert_equal  23, Person.count
+    assert_equal  23, br.persons.count
+    
+    jefferson = Person.find_by_key!( 'jefferson' )
+    assert_equal 'Jefferson De Oliveira Galvao', jefferson.synonyms
+    ## todo: add more asserts - use assert_persons ?
+
+  end
+
+end # class TestReader
+

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: persondb-models
+version: !ruby/object:Gem::Version
+  version: 0.4.2
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: worlddb-models
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: persondb-models - person schema 'n' models for easy (re)use
+email: opensport@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.md
+- Manifest.txt
+- README.md
+files:
+- ".gemtest"
+- HISTORY.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/persondb/models.rb
+- lib/persondb/models/forward.rb
+- lib/persondb/models/person.rb
+- lib/persondb/models/world/city.rb
+- lib/persondb/models/world/country.rb
+- lib/persondb/models/world/region.rb
+- lib/persondb/reader.rb
+- lib/persondb/schema.rb
+- lib/persondb/version.rb
+- test/data/players/south-america/br-brazil/players.txt
+- test/helper.rb
+- test/test_models.rb
+- test/test_reader.rb
+homepage: https://github.com/persondb/person.db.models
+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: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: persondb-models - person schema 'n' models for easy (re)use
+test_files:
+- test/test_models.rb
+- test/test_reader.rb