worlddb 1.8.2 → 2.0.0

data/lib/worlddb/models/country_comp.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+#############################################################
+# collect depreciated or methods for future removal here
+#  - keep for now for commpatibility (for old code)
+
+
+class Country
+
+  def title()       name;              end
+  def title=(value) self.name = value; end
+
+  scope :by_title, ->{ order( 'name asc' ) }   # order by title (a-z)
+
+
+  def synonyms()       alt_names;      end
+  def synonyms=(value) self.alt_names = value; end
+
+  def title_w_synonyms( opts={} )  all_names( opts );  end    # depreciated: use all_names instead
+
+
+end # class Country
+
+  end # module Model
+end # module WorldDb
+

data/lib/worlddb/models/forward.rb

@@ -0,0 +1,53 @@
+
+### forward references
+##   require first to resolve circular references
+
+module WorldDb
+  module Model
+
+#############
+# ConfDb
+Prop      = ConfDb::Model::Prop
+
+###########
+# TagDb
+Tagging   = TagDb::Model::Tagging
+Tag       = TagDb::Model::Tag
+
+
+class Name < ActiveRecord::Base ; end
+class Place < ActiveRecord::Base ; end
+class Continent < ActiveRecord::Base ; end
+class Country < ActiveRecord::Base ; end
+class Region < ActiveRecord::Base ; end
+class City < ActiveRecord::Base ; end
+
+class Lang < ActiveRecord::Base ; end
+class Usage < ActiveRecord::Base ; end
+
+  end
+
+  # note: convenience alias for Model
+  # lets you use include WorldDb::Models
+  Models = Model   
+end # module # WorldDb
+
+
+module TagDb
+  module Model
+
+# add alias? why? why not? # is there a better way?
+#  - just include WorldDb::Models  - why? why not?
+
+Name      = WorldDb::Model::Name
+Place     = WorldDb::Model::Place
+Continent = WorldDb::Model::Continent
+Country   = WorldDb::Model::Country
+Region    = WorldDb::Model::Region
+City      = WorldDb::Model::City
+
+Lang      = WorldDb::Model::Lang
+Usage     = WorldDb::Model::Usage
+
+  end
+end

data/lib/worlddb/models/lang.rb

@@ -1,17 +1,19 @@
 # encoding: utf-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
 
-  class Lang < ActiveRecord::Base
+class Lang < ActiveRecord::Base
     
-    has_many :usages  # join table for countries_langs
+  has_many :usages  # join table for countries_langs
     
-    has_many :countries, :through => :usages
+  has_many :countries, :through => :usages
 
-    validates :key, :format => { :with => /^[a-z]{2}$/, :message => 'expected two lowercase letters a-z' }
+  validates :key, format: { with: /^[a-z]{2}$/, message: 'expected two lowercase letters a-z' }
 
-  end  # class Lang
+end  # class Lang
 
-end # module WorldDb::Model
+  end # module Model
+end # module WorldDb
 
 

data/lib/worlddb/models/lang_comp.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+#############################################################
+# collect depreciated or methods for future removal here
+#  - keep for now for commpatibility (for old code)
+
+
+class Lang
+
+  #####################################################
+  # alias for name (remove! add depreciated api call ???)
+  def title()       name;              end
+  def title=(value) self.name = value; end
+
+  scope :by_title, ->{ order( 'name asc' ) }   # order by title (a-z)
+
+end # class Lang
+
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/name.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+class Name < ActiveRecord::Base
+
+
+end  # class Name
+
+
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/place.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+class Place < ActiveRecord::Base
+
+  ## todo: depending on type
+  ##  has_one continent, country, region, city etc.
+
+end  # class Place
+
+
+  end # module Model
+end # module WorldDb
+

data/lib/worlddb/models/region.rb

@@ -1,6 +1,8 @@
 # encoding: UTF-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
+
 
 class Region < ActiveRecord::Base
 
@@ -10,25 +12,44 @@ class Region < ActiveRecord::Base
   #   self.create_or_update_from_values
   extend TextUtils::ValueHelper  # e.g. is_year?, is_region?, is_address?, is_taglist? etc.
 
+  belongs_to :place,   class_name: 'Place',   foreign_key: 'place_id'
+  belongs_to :country, class_name: 'Country', foreign_key: 'country_id'
+
+  has_many :cities, class_name: 'City', foreign_key: 'region_id'
+
+  has_many_tags
+
+  validates :key,  format: { with: /^[a-z]+$/,      message: 'expected one or more lowercase letters a-z' }
+  validates :code, format: { with: /^[A-Z_]{2,3}$/, message: 'expected two or three uppercase letters A-Z (and _)' }, allow_nil: true
 
-  belongs_to :country, :class_name => 'Country', :foreign_key => 'country_id'
+  before_create :on_create
+  before_update :on_update
 
-  has_many :cities, :class_name => 'City', :foreign_key => 'region_id'
+  def on_create
+    place_rec = Place.create!( name: name, kind: place_kind )
+    self.place_id = place_rec.id 
+  end
+
+  def on_update
+    ## fix/todo: check - if name or kind changed - only update if changed ?? why? why not??
+    place.update_attributes!( name: name, kind: place_kind )
+  end
 
-  has_many :taggings, :as => :taggable
-  has_many :tags,     :through => :taggings
+  def place_kind   # use place_kind_of_code ??
+    'ADM1'
+  end
 
-  validates :key, :format => { :with => /^[a-z]+$/, :message => 'expected one or more lowercase letters a-z' }
-  validates :code, :format => { :with => /^[A-Z_]{2,3}$/, :message => 'expected two or three uppercase letters A-Z (and _)' }, :allow_nil => true
 
+  def all_names( opts={} )
+    ### fix:
+    ## allow to passing in sep or separator e.g. | or other
 
-  def title_w_synonyms
-    return title if synonyms.blank?
+    return name if alt_names.blank?
     
     buf = ''
-    buf << title
+    buf << name
     buf << ' | '
-    buf << synonyms.split('|').join(' | ')
+    buf << alt_names.split('|').join(' | ')
     buf
   end
 
@@ -150,4 +171,5 @@ class Region < ActiveRecord::Base
 
 end # class Region
 
-end # module WorldDb::Model
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/region_comp.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+#############################################################
+# collect depreciated or methods for future removal here
+#  - keep for now for commpatibility (for old code)
+
+class Region
+  
+  def title()       name;              end
+  def title=(value) self.name = value; end
+
+  scope :by_title, ->{ order( 'name asc' ) } # order by title (a-z)
+
+  def synonyms()       alt_names;      end
+  def synonyms=(value) self.alt_names = value; end
+
+  def title_w_synonyms( opts={} )  all_names( opts );  end    # depreciated: use all_names instead
+
+
+end # class Region
+
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/tagdb/tag.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module TagDb
+  module Model
+
+class Tag
+
+  has_many :cities,    :through => :taggings, :source => :taggable, source_type: 'WorldDb::Model::City',    class_name: 'WorldDb::Model::City'
+  has_many :countries, :through => :taggings, :source => :taggable, source_type: 'WorldDb::Model::Country', class_name: 'WorldDb::Model::Country'
+  has_many :regions,   :through => :taggings, :source => :taggable, source_type: 'WorldDb::Model::Region',  class_name: 'WorldDb::Model::Region'
+
+end  # class Tag
+
+  end # module Model
+end # module WorldDb
+

data/lib/worlddb/models/tagdb/tagging.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module TagDb
+  module Model
+
+
+class Tagging
+
+  ## add some code here
+
+end  # class Tagging
+
+
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/usage.rb

@@ -1,13 +1,17 @@
 # encoding: utf-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
 
-  class Usage < ActiveRecord::Base
 
-    belongs_to :country
-    belongs_to :lang
+class Usage < ActiveRecord::Base
 
-  end  # class Usage
+  belongs_to :country
+  belongs_to :lang
 
-end # module WorldDb::Model
+end  # class Usage
+
+
+  end # module Model
+end # module WorldDb
 

data/lib/worlddb/reader.rb

@@ -9,24 +9,19 @@ class Reader
 
 ## make models available in sportdb module by default with namespace
 #  e.g. lets you use City instead of Models::City
-  include WorldDb::Models
-
+  include Models
+  include Matcher  # e.g. match_cities_for_country, match_regions_for_country, etc.
 
 ## value helpers e.g. is_year?, is_taglist? etc.
   include TextUtils::ValueHelper
   
-  include WorldDb::Matcher  # e.g. match_cities_for_country, match_regions_for_country, etc.
 
 
   attr_reader :include_path
 
-  def skip_tags?
-    @skip_tags == true
-  end
+  def skip_tags?()   @skip_tags == true;  end
+  def strict?()      @strict == true;     end
 
-  def strict?
-    @strict == true
-  end
 
   def initialize( include_path, opts = {} )
     
@@ -67,9 +62,13 @@ class Reader
     elsif name =~ /\/continents/
        load_continent_refs( name )
     elsif name =~ /^lang/
-       load_langs( name )
+       ## todo: pass along opts too
+       ## use match_usage( name ) - why? why not?? ???
+       LangReader.new( include_path ).read( name )
     elsif name =~ /\/lang/
-       load_usages( name )
+       ## todo: pass along opts too
+       ## use match_usage( name ) - why? why not?? ???
+       UsageReader.new( include_path ).read( name )
     elsif name =~ /\/fifa/
        load_xxx( 'fifa', name )
     elsif name =~ /\/iso3/
@@ -78,17 +77,25 @@ class Reader
        load_xxx( 'net', name )
     elsif name =~ /\/motor/
        load_xxx( 'motor', name )
-    elsif name =~ /^tag.*\.(\d)$/
-       load_tags( name, :grade => $1.to_i )
+    elsif name =~ /^tag.*\.\d$/
+       ## todo: pass along opts too
+       ## use match_tags( name ) - why? why not?? ???
+       TagDb::TagReader.new( include_path ).read( name )
     elsif match_countries_for_continent( name ) do |continent|  # # e.g. africa/countries or america/countries
             ### NB: continent changed to regions (e.g. middle-east, caribbean, north-america, etc.)
             ## auto-add continent (from folder structure) as tag
             ## fix: allow dash/hyphen/minus in tag
-            load_countries( name, :tags => continent.tr('-', '_') )
+
+            r = CountryReader.new( include_path )
+            r.read( name, tags: continent.tr('-', '_') )
           end
     elsif match_cities_for_country( name ) do |country_key|  #  name =~ /\/([a-z]{2})\/cities/
             ## auto-add required country code (from folder structure)
-            load_cities( country_key, name )
+            country = Country.find_by_key!( country_key )
+            logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
+
+            r = CityReader.new( include_path )
+            r.read( name, country_id: country.id )
           end
     elsif match_regions_abbr_for_country( name ) do |country_key|   # name =~ /\/([a-z]{2})\/regions\.abbr/
             load_regions_xxx( country_key, 'abbr', name )
@@ -101,7 +108,11 @@ class Reader
           end
     elsif match_regions_for_country( name ) do |country_key|  # name =~ /\/([a-z]{2})\/regions/
             ## auto-add required country code (from folder structure)
-            load_regions( country_key, name )
+            country = Country.find_by_key!( country_key )
+            logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
+
+            r = RegionReader.new( include_path )
+            r.read( name, country_id: country.id )
           end
     else
       logger.error "unknown world.db fixture type >#{name}<"
@@ -110,20 +121,7 @@ class Reader
   end
 
 
-
-  def load_countries( name, more_attribs={} )
-    load_fixtures_for( Country, name, more_attribs )
-  end
-
-
-  def load_regions( country_key, name )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-
-    load_fixtures_for( Region, name, country_id: country.id )
-  end
-
-
+  ### use RegionAttrReader
   def load_regions_xxx( country_key, xxx, name )
     country = Country.find_by_key!( country_key )
     logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
@@ -138,14 +136,7 @@ class Reader
   end
 
 
-  def load_cities( country_key, name )
-    country = Country.find_by_key!( country_key )
-    logger.debug "Country #{country.key} >#{country.title} (#{country.code})<"
-
-    load_fixtures_for( City, name, country_id: country.id )
-  end
-
-
+  ### use ContinentRefReader
   def load_continent_refs( name )
     reader = HashReaderV2.new( name, include_path )
 
@@ -157,7 +148,7 @@ class Reader
     end
   end
 
-
+  ### use ContinentDef Reader
   def load_continent_defs( name, more_attribs={} )
     reader = ValuesReaderV2.new( name, include_path, more_attribs )
 
@@ -183,115 +174,7 @@ class Reader
     end # each lines
   end # load_continent_defs
 
-
-  def load_langs( name )
-
-    reader = HashReaderV2.new( name, include_path )
-
-    reader.each do |key, value|
-
-        logger.debug "adding lang >>#{key}<< >>#{value}<<..."
-      
-        lang_key   = key.strip
-        lang_title = value.strip
-      
-        lang_attribs = {}
-        
-        ## check if it exists
-        lang = Lang.find_by_key( lang_key )
-        if lang.present?
-          logger.debug "update lang #{lang.id}-#{lang.key}:"
-        else
-          logger.debug "create lang:"
-          lang = Lang.new
-          lang_attribs[ :key ] = lang_key
-        end
-        
-        lang_attribs[ :title ] = lang_title
-        
-        logger.debug lang_attribs.to_json
-     
-        lang.update_attributes!( lang_attribs )
-    end # each key,value
-
-  end # method load_langs
-
-
-  def load_tags( name, more_attribs={} )
-    
-      reader = HashReaderV2.new( name, include_path )
-
-      grade = 1
-    
-      if more_attribs[:grade].present?
-        grade = more_attribs[:grade].to_i
-      end
-
-      reader.each do |key, value|
-        ### split value by comma (e.g. northern america,southern america, etc.)
-        logger.debug "adding grade #{grade} tags >>#{key}<< >>#{value}<<..."
-        tag_pairs = value.split(',')
-        tag_pairs.each do |pair|
-        ## split key|title
-          values = pair.split('|')
-        
-          key   = values[0]
-          ### remove (optional comment) from key (e.g. carribean (islands))
-          key = key.gsub( /\(.+\)/, '' )
-          ## remove leading n trailing space
-          key = key.strip
-        
-          title = values[1] || ''  # nb: title might be empty/missing
-          title = title.strip
-        
-          tag_attribs = {}
-        
-          ## check if it exists
-          ## todo/fix: add country_id for lookup?
-          tag = Tag.find_by_key( key )
-          if tag.present?
-            logger.debug "update tag #{tag.id}-#{tag.key}:"
-          else
-            logger.debug "create tag:"
-            tag = Tag.new
-            tag_attribs[ :key ] = key
-          end
-        
-          tag_attribs[ :title ] = title
-          tag_attribs[ :grade ] = grade
-        
-          logger.debug tag_attribs.to_json
-   
-          tag.update_attributes!( tag_attribs )
-        end
-    end # each key,value
-
-  end # method load_tags
-
-
-  def load_usages( name )
-    reader = HashReaderV2.new( name, include_path )
-
-    reader.each do |key, value|
-      logger.debug "   adding langs >>#{value}<<to country >>#{key}<<"
-      
-      country = Country.find_by_key!( key )
-      
-      lang_keys = value.split(',')
-      lang_keys.each do |lang_key|
-
-        ### remove (optional comment) from key (e.g. carribean (islands))
-        lang_key = lang_key.gsub( /\(.+\)/, '' )
-        ## remove leading n trailing space
-        lang_key = lang_key.strip
-
-        lang = Lang.find_by_key!( lang_key )
-        Usage.create!( country_id: country.id, lang_id: lang.id, official: true, minor: false )
-      end
-    end
-  end
-
-
+  ### use CountryAttr Reader
   def load_xxx( xxx, name )
     reader = HashReaderV2.new( name, include_path )
 
@@ -302,15 +185,5 @@ class Reader
     end
   end
 
-private
-  def load_fixtures_for( clazz, name, more_attribs={} )
-    reader = ValuesReaderV2.new( name, include_path, more_attribs )
-    
-    reader.each_line do |attribs, values|
-      opts = { skip_tags: skip_tags? }
-      clazz.create_or_update_from_attribs( attribs, values, opts )
-    end
-  end
-
 end # class Reader
 end # module WorldDb