worlddb 1.8.2 → 2.0.0

data/lib/worlddb/cli/opts.rb

@@ -2,66 +2,33 @@ module WorldDb
 
 class Opts
 
-  def merge_commander_options!( options = {} )
-    @db_path   = options[:dbpath]  if options[:dbpath].present?
-    @db_name   = options[:dbname]  if options[:dbname].present?
-
-    @data_path = options[:include] if options[:include].present?
-    
-    @country   = options[:country]   if options[:country].present?
-    
-    @countries = options[:countries] if options[:countries].present?
-    @regions   = options[:regions]   if options[:regions].present?
-    @cities    = options[:cities]    if options[:cities].present?
-  end
-
-
-  def db_path
-    @db_path || '.'
-  end
-
-  def db_name
-    @db_name || 'world.db'
-  end
+  def merge_gli_options!( options = {} )
+    @db_path = options[:dbpath] if options[:dbpath].present?
+    @db_name = options[:dbname] if options[:dbname].present?
 
+    @verbose = true if options[:verbose] == true
 
-
-  def country=(value)
-    @country = value
-  end
-  
-  def country
-    @country   # NB: option has no default; return nil  ## || '.'
+    @data_path = options[:include] if options[:include].present?
   end
 
 
-  def countries=(boolean)
-    @countries = boolean
+  def verbose=(boolean) # add: alias for debug ??
+    @verbose = boolean
   end
 
-  def countries?
-    return false if @countries.nil?   # default countries flag is false
-    @countries == true
+  def verbose?
+    return false if @verbose.nil? # default verbose/debug flag is false
+    @verbose == true
   end
 
-  def regions=(boolean)
-    @regions = boolean
-  end
-
-  def regions?
-    return false if @regions.nil?   # default regions flag is false
-    @regions == true
-  end
-
-  def cities=(boolean)
-    @cities = boolean
+  def db_path
+    @db_path || '.'
   end
 
-  def cities?
-    return false if @cities.nil?   # default cities flag is false
-    @cities == true
+  def db_name
+    @db_name || 'world.db'
   end
-  
+ 
 
   def data_path=(value)
     @data_path = value

data/lib/worlddb/console.rb

@@ -14,13 +14,15 @@ require 'yaml'
 
 ## shortcuts for models
 
-Tag        = WorldDb::Model::Tag
-Tagging    = WorldDb::Model::Tagging
+Prop       = ConfDb::Model::Prop
+
+Tag        = TagDb::Model::Tag
+Tagging    = TagDb::Model::Tagging
+
 Continent  = WorldDb::Model::Continent
 Country    = WorldDb::Model::Country
 Region     = WorldDb::Model::Region
 City       = WorldDb::Model::City
-Prop       = WorldDb::Model::Prop
 
 ## connect to db
 
@@ -33,12 +35,11 @@ pp DB_CONFIG
 ActiveRecord::Base.establish_connection( DB_CONFIG )
 
 
-
 ## test drive
 
 puts "Welcome to world.db, version #{WorldDb::VERSION}!"
 
-WorldDb.stats
+WorldDb.tables
 
 puts "Ready."
 

data/lib/worlddb/deleter.rb

@@ -11,15 +11,17 @@ module WorldDb
     def run
       # for now delete all tables
       
-      Tagging.delete_all
-      Tag.delete_all
+      ## Tagging.delete_all   # - use TagDb.delete!
+      ## Tag.delete_all
+      Name.delete_all
+      Place.delete_all
       City.delete_all
       Region.delete_all
       Country.delete_all
       Continent.delete_all
       Usage.delete_all
       Lang.delete_all
-      Prop.delete_all
+      #  Prop.delete_all    # - use ConfDb.delete!
     end
     
   end # class Deleter

data/lib/worlddb/matcher.rb

@@ -33,15 +33,26 @@ module Matcher
     end
   end
 
-  def match_xxx_for_country_n_region( name, xxx ) # xxx e.g. beers|breweries
+
+  def match_xxx_for_country_n_region( name, xxx ) # xxx e.g. wine|wineries
+
     # auto-add required country n region code (from folder structure)
 
-    # note: allow  /cities and /1--hokkaido--cities
-    xxx_pattern = "(?:#{xxx}|[0-9]+--[^\\/]+?--#{xxx})"    # note: double escape \\ required for backslash
+    ## -- allow opt_folders after long regions (e.g. additional subregion/zone)
+    ## -- allow anything (prefixes) before -- for xxx
+    #       e.g.  at-austria!/1--n-niederoesterreich--eastern/wagram--wines
+    #             at-austria!/1--n-niederoesterreich--eastern/wagram--wagram--wines
+
+    # note: allow  /cities and /1--hokkaido--cities and /hokkaido--cities too
+    xxx_pattern = "(?:#{xxx}|[^\\/]+--#{xxx})"    # note: double escape \\ required for backslash
+    
+    ## allow optional folders -- TODO: add restriction ?? e.g. must be 4+ alphas ???
+    opt_folders_pattern = "(?:\/[^\/]+)*"
+    ## note: for now only (style #2) n (style #3)  that is long region allow opt folders
 
     if name =~ /(?:^|\/)([a-z]{2,3})-[^\/]+\/([a-z]{1,3})-[^\/]+\/#{xxx_pattern}/  ||                # (1)
-       name =~ /(?:^|\/)[0-9]+--([a-z]{2,3})-[^\/]+\/[0-9]+--([a-z]{1,3})-[^\/]+\/#{xxx_pattern}/ || # (2)
-       name =~ /(?:^|\/)([a-z]{2,3})-[^\/]+\/[0-9]+--([a-z]{1,3})-[^\/]+\/#{xxx_pattern}/         || # (3)
+       name =~ /(?:^|\/)[0-9]+--([a-z]{2,3})-[^\/]+\/[0-9]+--([a-z]{1,3})-[^\/]+#{opt_folders_pattern}\/#{xxx_pattern}/ || # (2)
+       name =~ /(?:^|\/)([a-z]{2,3})-[^\/]+\/[0-9]+--([a-z]{1,3})-[^\/]+#{opt_folders_pattern}\/#{xxx_pattern}/         || # (3)
        name =~ /(?:^|\/)[0-9]+--([a-z]{2,3})-[^\/]+\/([a-z]{1,3})-[^\/]+\/#{xxx_pattern}/            # (4)
 
       #######

data/lib/worlddb/models/city.rb

@@ -1,6 +1,17 @@
 # encoding: utf-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
+
+###
+##  Todo:
+##  use four classes instead of one ?
+#    e.g. Use class class Metro n class City n class District n class CityBase ?? - why? why not?
+#
+#  find a better name for CityBase ??
+#     Locality ??
+#      or CityCore or CityStd or CityAll or CityGeneric
+#      or CityLike or CityTable or CityTbl or ???
 
 class City < ActiveRecord::Base
   
@@ -13,59 +24,83 @@ class City < ActiveRecord::Base
 
   self.table_name = 'cities'
 
-  belongs_to :country, :class_name => 'Country', :foreign_key => 'country_id'
-  belongs_to :region,  :class_name => 'Region',  :foreign_key => 'region_id'
+  belongs_to :place,   class_name: 'Place',   foreign_key: 'place_id'
+  belongs_to :country, class_name: 'Country', foreign_key: 'country_id'
+  belongs_to :region,  class_name: 'Region',  foreign_key: 'region_id'
 
   ## self referencing hierachy within cities e.g. m|metro > c|city > d|district
 
   ## fix: use condition check for m|d|c flag?? why? why not? (NB: flags are NOT exclusive e.g. possible metro|city)
   
   ## (1) metro - level up
-  has_many   :cities,    :class_name => 'City', :foreign_key => 'city_id'
+  has_many   :cities,    class_name: 'City',  foreign_key: 'city_id'
 
   ## (2) city
-  belongs_to :metro,     :class_name => 'City', :foreign_key => 'city_id'   ## for now alias for parent - use parent?
-  has_many   :districts, :class_name => 'City', :foreign_key => 'city_id'   ## for now alias for cities - use cities?
+  belongs_to :metro,     class_name: 'City',  foreign_key: 'city_id'   ## for now alias for parent - use parent?
+  has_many   :districts, class_name: 'City',  foreign_key: 'city_id'   ## for now alias for cities - use cities?
 
   ## (3) district - level down
-  belongs_to :city,      :class_name => 'City', :foreign_key => 'city_id'  ## for now alias for parent - use parent?
+  belongs_to :city,      class_name: 'City',  foreign_key: 'city_id'  ## for now alias for parent - use parent?
 
+  has_many_tags
 
   ###
   #  NB: use is_  for flags to avoid conflict w/ assocs (e.g. metro?, city? etc.)
   
-  def is_metro?
-    m? == true
+  def is_metro?()    m? == true;  end
+  def is_city?()     c? == true;  end
+  def is_district?() d? == true;  end
+
+  before_create :on_create
+  before_update :on_update
+
+  def on_create
+    place_rec = Place.create!( name: name, kind: place_kind )
+    self.place_id = place_rec.id 
   end
-  
-  def is_city?
-    c? == true
+
+  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
-  
-  def is_district?
-    d? == true
+
+  def place_kind   # use place_kind_of_code ??
+    ### fix/todo: make sure city records won't overlap (e.g. using metro n city flag at the same time; use separate records)
+#//////////////////////////////////
+#// fix: add nested record syntax e.g. city w/ metro population
+#//  use (metro: 4444)  e.g. must start with (<nested_type>: props) !!! or similar
+#//
+    if is_metro?
+      'MTRO'
+    elsif is_district?
+      'DIST'
+    else
+      'CITY'
+    end
   end
 
-  
-  has_many :taggings, :as => :taggable
-  has_many :tags,  :through => :taggings
 
-  validates :key, :format => { :with => /^[a-z]{3,}$/, :message => 'expected three or more lowercase letters a-z' }
-  validates :code, :format => { :with => /^[A-Z_]{3}$/, :message => 'expected three uppercase letters A-Z (and _)' }, :allow_nil => true
+  validates :key,  format: { with: /^[a-z]{3,}$/, message: 'expected three or more lowercase letters a-z' }
+  validates :code, format: { with: /^[A-Z_]{3}$/, message: 'expected three uppercase letters A-Z (and _)' }, :allow_nil => true
+
+
+  scope :by_key,   ->{ order( 'key asc' )  }  # order by key (a-z)
+  scope :by_name,  ->{ order( 'name asc' ) } # order by title (a-z)
+  scope :by_pop,   ->{ order( 'pop desc' ) }  # order by pop(ulation)
+  scope :by_popm,  ->{ order( 'popm desc' ) } # order by pop(ulation) metropolitan area
+  scope :by_area,  ->{ order( 'area desc' ) }  # order by area (in square km)
+
 
-  scope :by_key,    order( 'key asc' )    # order by key (a-z)
-  scope :by_title,  order( 'title asc' )  # order by title (a-z)
-  scope :by_pop,    order( 'pop desc' )   # order by pop(ulation)
-  scope :by_popm,   order( 'popm desc' )  # order by pop(ulation) metropolitan area
-  scope :by_area,   order( 'area desc' )  # order by area (in square km)
+  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
 
@@ -201,4 +236,5 @@ class City < ActiveRecord::Base
 
 end # class Cities
 
-end # module WorldDb::Model
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/city_comp.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+#############################################################
+# collect depreciated or methods for future removal here
+#  - keep for now for commpatibility (for old code)
+
+class City
+
+  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 Cities
+
+  end # module Model
+end # module WorldDb
+

data/lib/worlddb/models/continent.rb

@@ -1,14 +1,36 @@
 # encoding: utf-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
 
-  class Continent < ActiveRecord::Base
-    
-    has_many :countries
+class Continent < ActiveRecord::Base
 
-    # NB: allow dots in keys e.g. concacaf.naf etc.    
-    
-  end  # class Continent
+  belongs_to :place,     class_name: 'Place',   foreign_key: 'place_id'
+  has_many   :countries
 
-end # module WorldDb::Model
+  # NB: allow dots in keys e.g. concacaf.naf etc.    
+
+  before_create :on_create
+  before_update :on_update
+
+  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
+
+  def place_kind   # use place_kind_of_code ??
+    'CONT'
+  end
+
+
+end  # class Continent
+
+
+  end # module Model
+end # module WorldDb
 

data/lib/worlddb/models/continent_comp.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module WorldDb
+  module Model
+
+#############################################################
+# collect depreciated or methods for future removal here
+#  - keep for now for commpatibility (for old code)
+
+class Continent
+
+  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
+
+end # class Continent
+
+
+  end # module Model
+end # module WorldDb

data/lib/worlddb/models/country.rb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 
-module WorldDb::Model
+module WorldDb
+  module Model
+
+########
+# Country / Supra (e.g. European Union) / Territory (e.g. Puerto Rico) or Dependency (e.g. Dependent territory) 
 
 class Country < ActiveRecord::Base
 
@@ -13,58 +17,77 @@ class Country < ActiveRecord::Base
 
   self.table_name = 'countries'
 
-  belongs_to :continent, :class_name => 'Continent', :foreign_key => 'continent_id'
-  
+  belongs_to :place,     class_name: 'Place',     foreign_key: 'place_id'
+  belongs_to :continent, class_name: 'Continent', foreign_key: 'continent_id'
+
   has_many :usages
   has_many :langs, :through => :usages # lang(uage)s through usages (that is, countries_langs) join table
 
-  has_many :regions, :class_name => 'Region', :foreign_key => 'country_id'
-  has_many :cities,  :class_name => 'City',   :foreign_key => 'country_id'
+  has_many :regions, class_name: 'Region', foreign_key: 'country_id'
+  has_many :cities,  class_name: 'City',   foreign_key: 'country_id'
   
   ## self referencing hierachy within countries e.g. EU > GB > EN
-  belongs_to :parent,    :class_name => 'Country', :foreign_key => 'country_id'
-  has_many   :countries, :class_name => 'Country', :foreign_key => 'country_id'
+  belongs_to :parent,    class_name: 'Country', foreign_key: 'country_id'
+  has_many   :countries, class_name: 'Country', foreign_key: 'country_id'
 
-  has_many :taggings, :as => :taggable
-  has_many :tags,     :through => :taggings
+  has_many_tags
 
-  validates :key, :format => { :with => /^[a-z]{2}$/, :message => 'expected two lowercase letters a-z' }
-  validates :code, :format => { :with => /^[A-Z_]{3}$/, :message => 'expected three uppercase letters A-Z (and _)' }
+  validates :key,  format: { with: /^[a-z]{2}$/,  message: 'expected two lowercase letters a-z' }
+  validates :code, format: { with: /^[A-Z_]{3}$/, message: 'expected three uppercase letters A-Z (and _)' }
 
-  scope :by_key,   order( 'key asc' )     # order by key (a-z)
-  scope :by_title, order( 'title asc' )   # order by title (a-z)
-  scope :by_code,  order( 'code asc' )    # order by code (a-z)
-  scope :by_pop,   order( 'pop desc' )    # order by pop(ulation)
-  scope :by_area,  order( 'area desc')    # order by area (in square km)
- 
-  ###
-  #  NB: use is_  for flags to avoid conflict w/ assocs 
-  
-  def is_supra?  
-    s? == true
+
+  scope :by_key,   ->{ order( 'key asc' ) }    # order by key (a-z)
+  scope :by_name,  ->{ order( 'name asc' ) }   # order by name (a-z)
+  scope :by_code,  ->{ order( 'code asc' ) }   # order by code (a-z)
+  scope :by_pop,   ->{ order( 'pop desc' ) }   # order by pop(ulation)
+  scope :by_area,  ->{ order( 'area desc') }   # order by area (in square km)
+
+  before_create :on_create
+  before_update :on_update
+
+  def on_create
+    place_rec = Place.create!( name: name, kind: place_kind )
+    self.place_id = place_rec.id 
   end
-  
-  def is_country?
-    c? == true
+
+  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
-  
-  def is_dependency?
-    d? == true
+
+  def place_kind   # use place_kind_of_code ??
+    if is_supra?
+      'SUPR'
+    elsif is_dependency?
+      'TERR'
+    else
+      'CNTY'
+    end
   end
 
- 
- 
-  def title_w_synonyms
-    return title if synonyms.blank?
+  ###
+  #  NB: use is_  for flags to avoid conflict w/ assocs 
+  
+  def is_supra?()      s? == true;  end
+  def is_country?()    c? == true;  end
+  def is_dependency?() d? == true;  end
+
+
+  def all_names( opts={} )
+    ### fix:
+    ## allow to passing in sep or separator e.g. | or other
+
+    return name if alt_names.blank?
     
     buf = ''
-    buf << title
+    buf << name
     buf << ' | '
-    buf << synonyms.split('|').join(' | ')
+    buf << alt_names.split('|').join(' | ')
     buf
   end
 
 
+
   def self.create_or_update_from_values( values, more_attribs={} )
 
       ## key & title
@@ -175,6 +198,7 @@ class Country < ActiveRecord::Base
             value_tag_keys << 'pop_1m_n_up'   if pop >=  1_000_000
 =end
 
+
       rec = Country.find_by_key( new_attributes[ :key ] )
 
       if rec.present?
@@ -224,5 +248,5 @@ class Country < ActiveRecord::Base
 
 end # class Country
 
-
-end # module WorldDb::Model
+  end # module Model
+end # module WorldDb