worlddb 1.5.0 → 1.6.0

data/Rakefile

@@ -3,12 +3,12 @@ require 'hoe'
 require './lib/worlddb/version.rb'
 
 ## NB: plugin (hoe-manifest) not required; just used for future testing/development
-Hoe::plugin :manifest   # more options for manifests (in the future; not yet)
+### Hoe::plugin :manifest   # more options for manifests (in the future; not yet)
 
 
 Hoe.spec 'worlddb' do
   
-  self.version = WorldDB::VERSION
+  self.version = WorldDb::VERSION
   
   self.summary = "worlddb - world.db command line tool"
   self.description = summary
@@ -38,7 +38,7 @@ end
 ##
 ## NB: use rake -I ./lib dev:test      # fresh import (starts w/ clean wipe out)
 
-namespace :dev do
+namespace :worlddb do
   
   BUILD_DIR = "./build"
   
@@ -67,19 +67,19 @@ namespace :dev do
 
   task :create => :env do
     LogDb.create
-    WorldDB.create
+    WorldDb.create
   end
   
   task :import => :env do
-    WorldDB.read_setup( 'setups/sport.db.admin', '../world.db', { skip_tags: true } )  # populate world tables
-    WorldDB.stats
+    WorldDb.read_setup( 'setups/sport.db.admin', '../world.db', skip_tags: true )  # populate world tables
+    WorldDb.stats
   end
 
 
-  desc 'worlddb - test loading of builtin fixtures'
-  task :test => [:clean, :create, :import]
+  desc 'worlddb - build from scratch'
+  task :build => [:clean, :create, :import]
 
-  desc 'worlddb - test loading of builtin fixtures (update)'
+  desc 'worlddb - update'
   task :update => [:import]
 
-end  # namespace :dev
+end  # namespace :worlddb

data/bin/worlddb

@@ -4,4 +4,4 @@ require 'worlddb'
 
 ## todo: set x flag for file
 
-WorldDB.main
+WorldDb.main

data/lib/worlddb/cli/main.rb

@@ -9,8 +9,8 @@ LogUtils::Logger.root.level = :info   # set logging level to info
 
 
 program :name,  'worlddb'
-program :version, WorldDB::VERSION
-program :description, "world.db command line tool, version #{WorldDB::VERSION}"
+program :version, WorldDb::VERSION
+program :description, "world.db command line tool, version #{WorldDb::VERSION}"
 
 
 # default_command :help
@@ -36,7 +36,7 @@ Further information:
 
 
 ## todo: find a better name e.g. change to settings? config? safe_opts? why? why not?
-myopts = WorldDB::Opts.new
+myopts = WorldDb::Opts.new
 
 ### global option (required)
 ## todo: add check that path is valid?? possible?
@@ -51,7 +51,7 @@ global_option '-w', '--verbose', "Show debug messages"
 
 
 def connect_to_db( options )
-  puts WorldDB.banner
+  puts WorldDb.banner
 
   puts "working directory: #{Dir.pwd}"
 
@@ -80,8 +80,8 @@ command :create do |c|
     myopts.merge_commander_options!( options.__hash__ )
     connect_to_db( myopts )
     
-    LogDB.create
-    WorldDB.create
+    LogDb.create
+    WorldDb.create
     puts 'Done.'
   end # action
 end # command create
@@ -102,13 +102,13 @@ command :setup do |c|
 
     if options.delete.present?
       # w/ delete flag assume tables already exit
-      WorldDB.delete!
+      WorldDb.delete!
     else
-      LogDB.create
-      WorldDB.create
+      LogDb.create
+      WorldDb.create
     end
 
-    WorldDB.read_all( myopts.data_path )
+    WorldDb.read_all( myopts.data_path )
     puts 'Done.'
   end # action
 end  # command setup
@@ -135,21 +135,21 @@ command :load do |c|
     myopts.merge_commander_options!( options.__hash__ )
     connect_to_db( myopts )
     
-    WorldDB.delete! if options.delete.present?
+    WorldDb.delete! if options.delete.present?
 
     # read plain text country/region/city fixtures
-    reader = WorldDB::Reader.new
+    reader = WorldDb::Reader.new( myopts.data_path )
     args.each do |arg|
       name = arg     # File.basename( arg, '.*' )
 
       if myopts.countries?
-        reader.load_countries( name, myopts.data_path )
+        reader.load_countries( name )
       elsif myopts.regions?
-        reader.load_regions( myopts.country, name, myopts.data_path )
+        reader.load_regions( myopts.country, name )
       elsif myopts.cities?
-        reader.load_cities( myopts.country, name, myopts.data_path )
+        reader.load_cities( myopts.country, name )
       else
-        reader.load( name, myopts.data_path )
+        reader.load( name )
         ## todo: issue a warning here; no fixture type specified; assume country?
       end
       
@@ -171,7 +171,7 @@ command :stats do |c|
     myopts.merge_commander_options!( options.__hash__ )
     connect_to_db( myopts ) 
     
-    WorldDB.tables
+    WorldDb.tables
     
     puts 'Done.'
   end
@@ -189,7 +189,7 @@ command :props do |c|
     myopts.merge_commander_options!( options.__hash__ )
     connect_to_db( myopts ) 
     
-    WorldDB.props
+    WorldDb.props
     
     puts 'Done.'
   end
@@ -207,7 +207,7 @@ command :logs do |c|
     myopts.merge_commander_options!( options.__hash__ )
     connect_to_db( myopts ) 
     
-    LogDB::Models::Log.all.each do |log|
+    LogDb::Models::Log.all.each do |log|
       puts "[#{log.level}] -- #{log.msg}"
     end
     

data/lib/worlddb/cli/opts.rb

@@ -1,4 +1,4 @@
-module WorldDB
+module WorldDb
 
 class Opts
 
@@ -74,4 +74,4 @@ class Opts
 
 end # class Opts
 
-end # module WorldDB
+end # module WorldDb

data/lib/worlddb/console.rb

@@ -14,12 +14,12 @@ require 'yaml'
 
 ## shortcuts for models
 
-Tag     = WorldDB::Models::Tag
-Tagging = WorldDB::Models::Tagging
-Country = WorldDB::Models::Country
-Region  = WorldDB::Models::Region
-City    = WorldDB::Models::City
-Prop    = WorldDB::Models::Prop
+Tag     = WorldDb::Models::Tag
+Tagging = WorldDb::Models::Tagging
+Country = WorldDb::Models::Country
+Region  = WorldDb::Models::Region
+City    = WorldDb::Models::City
+Prop    = WorldDb::Models::Prop
 
 ## connect to db
 
@@ -35,7 +35,7 @@ ActiveRecord::Base.establish_connection( DB_CONFIG )
 
 ## test drive
 
-puts "Welcome to world.db, version #{WorldDB::VERSION}!"
+puts "Welcome to world.db, version #{WorldDb::VERSION}!"
 puts "  #{'%6d' % Country.count} countries"
 puts "  #{'%6d' % Region.count} regions"
 puts "  #{'%6d' % City.count} cities"

data/lib/worlddb/deleter.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 
-module WorldDB
+module WorldDb
 
   class Deleter
     
     ## make models available in worlddb module by default with namespace
     #  e.g. lets you use City instead of Models::City 
-    include WorldDB::Models
+    include WorldDb::Models
 
     def run
       # for now delete all tables
@@ -23,4 +23,4 @@ module WorldDB
     
   end # class Deleter
 
-end # module WorldDB
+end # module WorldDb

data/lib/worlddb/models/city.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
 class City < ActiveRecord::Base
   self.table_name = 'cities'
@@ -111,4 +111,4 @@ class City < ActiveRecord::Base
 
 end # class Cities
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/country.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
 class Country < ActiveRecord::Base
   self.table_name = 'countries'
@@ -96,4 +96,4 @@ class Country < ActiveRecord::Base
 end # class Country
 
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/lang.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
   class Lang < ActiveRecord::Base
     
@@ -12,4 +12,4 @@ module WorldDB::Models
 
   end  # class Lang
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/prop.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
   class Prop < ActiveRecord::Base
 
@@ -28,4 +28,4 @@ private
     
   end  # class Prop
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/region.rb

@@ -1,4 +1,4 @@
-module WorldDB::Models
+module WorldDb::Models
 
 class Region < ActiveRecord::Base
 
@@ -50,4 +50,4 @@ class Region < ActiveRecord::Base
 
 end # class Region
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/tag.rb

@@ -1,14 +1,14 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
   class Tag < ActiveRecord::Base
     
     has_many :taggings
     
-    has_many :cities,    :through => :taggings, :source => :taggable, :source_type => 'WorldDB::Models::City',    :class_name => 'City'
-    has_many :countries, :through => :taggings, :source => :taggable, :source_type => 'WorldDB::Models::Country', :class_name => 'Country'
-    has_many :regions,   :through => :taggings, :source => :taggable, :source_type => 'WorldDB::Models::Region',  :class_name => 'Region'
+    has_many :cities,    :through => :taggings, :source => :taggable, :source_type => 'WorldDb::Models::City',    :class_name => 'City'
+    has_many :countries, :through => :taggings, :source => :taggable, :source_type => 'WorldDb::Models::Country', :class_name => 'Country'
+    has_many :regions,   :through => :taggings, :source => :taggable, :source_type => 'WorldDb::Models::Region',  :class_name => 'Region'
 
     ## nb: only allow spaces and underscore inbetween; do not allow digit as first char
     validates :key,  :format => { :with => /^[a-z]$|^[a-z][a-z0-9_ ]*[a-z0-9]$/, :message => 'expected one or more lowercase letters a-z or 0-9 digits or space or underscore' }
@@ -29,4 +29,4 @@ module WorldDB::Models
       
   end  # class Tag
   
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/tagging.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
   class Tagging < ActiveRecord::Base
 
@@ -9,4 +9,4 @@ module WorldDB::Models
 
   end  # class Tagging
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/models/usage.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-module WorldDB::Models
+module WorldDb::Models
 
   class Usage < ActiveRecord::Base
 
@@ -9,4 +9,4 @@ module WorldDB::Models
 
   end  # class Usage
 
-end # module WorldDB::Models
+end # module WorldDb::Models

data/lib/worlddb/reader.rb

@@ -1,4 +1,4 @@
-module WorldDB
+module WorldDb
 
 class Reader
 
@@ -6,18 +6,9 @@ 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 WorldDb::Models
 
-  ### todo/fix: make include_path
-  ## required first arg in ctor!!!
-  ## cleanup load_   and remove include_path
-
-  def initialize( opts = {} )
-    ## option: do NOT generate/add any tags for countries/regions/cities
-    @skip_tags =  opts[:skip_tags].present? ? true : false
-    ## option: for now issue warning on update, that is, if key/record (country,region,city) already exists
-    @strict    =  opts[:strict].present? ? true : false
-  end
+  attr_reader :include_path
 
   def skip_tags?
     @skip_tags == true
@@ -27,9 +18,19 @@ class Reader
     @strict == true
   end
 
+  def initialize( include_path, opts = {} )
+    
+    @include_path = include_path
+    
+    ## option: do NOT generate/add any tags for countries/regions/cities
+    @skip_tags =  opts[:skip_tags].present? ? true : false
+    ## option: for now issue warning on update, that is, if key/record (country,region,city) already exists
+    @strict    =  opts[:strict].present? ? true : false
+  end
+
 
-  def load_setup( setup, include_path )
-    ary = load_fixture_setup( setup, include_path )
+  def load_setup( setup )
+    ary = load_fixture_setup( setup )
 
     ### fix/todo:
     #  use to setups - use comment to remove fixtures
@@ -43,13 +44,13 @@ class Reader
     ary = ary - fixture_excludes
 
     ary.each do |name|
-      load( name, include_path )
+      load( name )
     end
   end # method load_setup
 
 
   ## fix/todo: rename ??
-  def load_fixture_setup( name, include_path )
+  def load_fixture_setup( name )
     
    ## todo/fix: cleanup quick and dirty code
     
@@ -86,34 +87,34 @@ class Reader
   end # load_fixture_setup
 
 
-  def load( name, include_path )
+  def load( name )
 
     if name =~ /^lang/
-       load_langs( name, include_path )
+       load_langs( name )
     elsif name =~ /\/lang/
-       load_usages( name, include_path )
+       load_usages( name )
     elsif name =~ /\/fifa/
-       load_xxx( 'fifa', name, include_path )
+       load_xxx( 'fifa', name )
     elsif name =~ /\/iso3/
-       load_xxx( 'iso3', name, include_path )
+       load_xxx( 'iso3', name )
     elsif name =~ /\/internet/
-       load_xxx( 'net', name, include_path )
+       load_xxx( 'net', name )
     elsif name =~ /\/motor/
-       load_xxx( 'motor', name, include_path )
+       load_xxx( 'motor', name )
     elsif name =~ /^tag.*\.(\d)$/
-       load_tags( name, include_path, :grade => $1.to_i )
+       load_tags( name, :grade => $1.to_i )
     elsif name =~ /^([a-z][a-z\-]+[a-z])\/countries/     # e.g. africa/countries or america/countries
       ### NB: continent changed to regions (e.g. middle-east, caribbean, north-america, etc.)
       ### fix/cleanup/todo:
       ## auto-add continent (from folder structure) as tag
       ## load_countries( name, include_path, :tags => $1 )
-      load_countries( name, include_path )
+      load_countries( name )
     elsif name =~ /\/([a-z]{2})\/cities/
       ## auto-add required country code (from folder structure)
-      load_cities( $1, name, include_path )
+      load_cities( $1, name )
     elsif name =~ /\/([a-z]{2})\/regions/
       ## auto-add required country code (from folder structure)
-      load_regions( $1, name, include_path )
+      load_regions( $1, name )
     else
       logger.error "unknown world.db fixture type >#{name}<"
       # todo/fix: exit w/ error
@@ -121,29 +122,29 @@ class Reader
   end
   
 
-  def load_countries( name, include_path, more_values={} )
-    load_fixtures_for( Country, name, include_path, more_values )
+  def load_countries( name, more_values={} )
+    load_fixtures_for( Country, name, more_values )
   end
 
 
-  def load_regions( country_key, name, include_path )
+  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, include_path, country_id: country.id )
+    load_fixtures_for( Region, name, country_id: country.id )
   end
 
 
-  def load_cities( country_key, name, include_path )
+  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, include_path, country_id: country.id )
+    load_fixtures_for( City, name, country_id: country.id )
   end
 
 
 
-  def with_path_for( name, include_path )
+  def with_path_for( name )
     ## todo: find a better name?
     # e.g. find_path_for  or open_fixture_for ??
 
@@ -158,9 +159,9 @@ class Reader
 
 
 
-  def load_langs( name, include_path )
+  def load_langs( name )
     
-    with_path_for( name, include_path) do |path|
+    with_path_for( name ) do |path|
   
       reader = HashReader.new( path )
 
@@ -194,9 +195,9 @@ class Reader
   end # method load_langs
 
 
-  def load_tags( name, include_path, more_values={} )
+  def load_tags( name, more_values={} )
     
-    with_path_for( name, include_path) do |path|
+    with_path_for( name ) do |path|
 
       reader = HashReader.new( path )
 
@@ -250,7 +251,7 @@ class Reader
   end # method load_tags
 
 
-  def load_usages( name, include_path )
+  def load_usages( name )
     path = "#{include_path}/#{name}.yml"
 
     puts "*** parsing data '#{name}' (#{path})..."
@@ -279,7 +280,7 @@ class Reader
   end
 
 
-  def load_xxx( xxx, name, include_path )
+  def load_xxx( xxx, name )
     path = "#{include_path}/#{name}.yml"
 
     puts "*** parsing data '#{name}' (#{path})..."
@@ -297,7 +298,7 @@ class Reader
 
 
 private
-  def load_fixtures_for( clazz, name, include_path, more_values={} )  # load from file system
+  def load_fixtures_for( clazz, name, more_values={} )  # load from file system
     path = "#{include_path}/#{name}.txt"
 
     puts "*** parsing data '#{name}' (#{path})..."
@@ -556,4 +557,4 @@ private
 
   
 end # class Reader
-end # module WorldDB
+end # module WorldDb

data/lib/worlddb/schema.rb

@@ -1,14 +1,9 @@
 
-module WorldDB
+module WorldDb
 
-class CreateDB
+class CreateDb < ActiveRecord::Migration
 
-  include WorldDB::Models
-
-
-def self.up
-
-  ActiveRecord::Schema.define do
+def up
 
 create_table :countries do |t|
   t.string  :title,  :null => false
@@ -115,18 +110,19 @@ create_table :usages do |t|  # join table for countries_langs
   t.timestamps
 end
 
+### fix: move to PropDb ? into props gem? why? why not?
 create_table :props do |t|
   t.string :key,   :null => false
   t.string :value, :null => false
   t.timestamps
 end
 
-  end # block Schema.define
-
-  Prop.create!( key: 'db.schema.world.version', value: WorldDB::VERSION )
-
 end # method up
 
-end # class CreateDB
+def down
+  raise ActiveRecord::IrreversibleMigration
+end
+
+end # class CreateDb
 
-end # module WorldDB
+end # module WorldDb

data/lib/worlddb/stats.rb

@@ -1,9 +1,9 @@
 # encoding: utf-8
 
-module WorldDB
+module WorldDb
 
   class Stats
-    include WorldDB::Models
+    include WorldDb::Models
 
     def tables
       puts "Stats:"
@@ -27,4 +27,4 @@ module WorldDB
   end # class Stats
 
 
-end # module WorldDB
+end # module WorldDb

data/lib/worlddb/version.rb

@@ -1,4 +1,9 @@
 
-module WorldDB
-  VERSION = '1.5.0'  # sync version w/ sport.db - why? why not?
+module WorldDb
+  VERSION = '1.6.0'  # sync version w/ sport.db - why? why not?
 end
+
+###########################################
+## fix: remove old alias for WorldDb
+
+WorldDB = WorldDb

data/lib/worlddb.rb

@@ -22,6 +22,8 @@ require 'textutils'
 
 # our own code
 
+
+
 require 'worlddb/version'
 
 require 'worlddb/models/prop'
@@ -42,7 +44,7 @@ require 'worlddb/data/fixtures'
 
 
 
-module WorldDB
+module WorldDb
 
   def self.banner
     "worlddb #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
@@ -58,28 +60,29 @@ module WorldDB
   end
   
   def self.create
-    CreateDB.up
+    CreateDb.new.up
+    WorldDb::Models::Prop.create!( key: 'db.schema.world.version', value: VERSION )
   end
 
 
   def self.read( ary, include_path )
-    reader = Reader.new
+    reader = Reader.new( include_path )
     ary.each do |name|
-      reader.load( name, include_path )
+      reader.load( name )
     end
   end
 
 
   def self.read_setup( setup, include_path, opts={} )
-    reader = Reader.new( opts )
-    reader.load_setup( setup, include_path )
+    reader = Reader.new( include_path, opts )
+    reader.load_setup( setup )
   end
 
   def self.read_all( include_path, opts={} )  # load all builtins (using plain text reader); helper for convenience
     read_setup( 'setups/all', include_path, opts )
   end # method read_all
 
-  
+
   # delete ALL records (use with care!)
   def self.delete!
     puts '*** deleting world table records/data...'
@@ -101,12 +104,12 @@ module WorldDB
     Stats.new.props
   end
 
-end  # module WorldDB
+end  # module WorldDb
 
 
 if __FILE__ == $0
-  WorldDB.main
+  WorldDb.main
 else
   # say hello
-  puts WorldDB.banner
+  puts WorldDb.banner
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worlddb
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: textutils
-  requirement: &79173230 !ruby/object:Gem::Requirement
+  requirement: &82489880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *79173230
+  version_requirements: *82489880
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &79173010 !ruby/object:Gem::Requirement
+  requirement: &82489650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 4.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *79173010
+  version_requirements: *82489650
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &79172800 !ruby/object:Gem::Requirement
+  requirement: &82489410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *79172800
+  version_requirements: *82489410
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &79172580 !ruby/object:Gem::Requirement
+  requirement: &82489190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *79172580
+  version_requirements: *82489190
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &79172360 !ruby/object:Gem::Requirement
+  requirement: &82488960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.3'
   type: :development
   prerelease: false
-  version_requirements: *79172360
+  version_requirements: *82488960
 description: worlddb - world.db command line tool
 email: opensport@googlegroups.com
 executables: