worlddb 1.8.2 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bcd0cfff41045906128dcc7c1d4a21a161f97f8
+  data.tar.gz: 77b2b023d09ffd92a1f6b409dc12cea150f4204a
+SHA512:
+  metadata.gz: 15bb7a864dcb23fcfb99f15c64c83cdc8a2f0d17e1f51ea59ac81f581114ccca9f647d7e6ed9a3dcba58847d4768a0171f2cc3c7a43c294ebd4dab246e1fadc3
+  data.tar.gz: fa1f5a379da46acd7ce1b250b98ab61a41a1d8e7940420758c5c7631adf4ce8d0b55c4eef3ad64cb4ae91b59e6f27ba85395c75cadf433291a42c4a92c6f6a6c

data/Manifest.txt

@@ -1,4 +1,4 @@
-History.md
+HISTORY.md
 Manifest.txt
 README.md
 Rakefile
@@ -10,19 +10,36 @@ lib/worlddb/console.rb
 lib/worlddb/deleter.rb
 lib/worlddb/matcher.rb
 lib/worlddb/models/city.rb
+lib/worlddb/models/city_comp.rb
 lib/worlddb/models/continent.rb
+lib/worlddb/models/continent_comp.rb
 lib/worlddb/models/country.rb
+lib/worlddb/models/country_comp.rb
+lib/worlddb/models/forward.rb
 lib/worlddb/models/lang.rb
-lib/worlddb/models/prop.rb
+lib/worlddb/models/lang_comp.rb
+lib/worlddb/models/name.rb
+lib/worlddb/models/place.rb
 lib/worlddb/models/region.rb
-lib/worlddb/models/tag.rb
-lib/worlddb/models/tagging.rb
+lib/worlddb/models/region_comp.rb
+lib/worlddb/models/tagdb/tag.rb
+lib/worlddb/models/tagdb/tagging.rb
 lib/worlddb/models/usage.rb
 lib/worlddb/reader.rb
+lib/worlddb/readers/base.rb
+lib/worlddb/readers/city.rb
+lib/worlddb/readers/country.rb
+lib/worlddb/readers/lang.rb
+lib/worlddb/readers/region.rb
+lib/worlddb/readers/usage.rb
 lib/worlddb/schema.rb
 lib/worlddb/stats.rb
 lib/worlddb/utils.rb
 lib/worlddb/version.rb
 test/helper.rb
 test/test_fixture_matchers.rb
-test/test_values.rb
+test/test_model_city.rb
+test/test_model_comp.rb
+test/test_model_country.rb
+test/test_model_region.rb
+test/test_models.rb

data/README.md

@@ -11,7 +11,7 @@ world.db Command Line Tool in Ruby
 
 ## Usage Command Line
 
-    world.db command line tool, version 1.8.0
+    world.db command line tool, version 2.0.0
     
     Commands:
       create               Create DB schema
@@ -34,10 +34,70 @@ world.db Command Line Tool in Ruby
       -t, --trace          Display backtrace when an error occurs
 
 
+
 ## Usage Models
 
+`Country` Model - Example:
 
-TBD
+    at = Country.find_by! key: 'at'
+    at.name
+    # => 'Austria'
+    at.pop
+    # => 8_414_638
+    at.area
+    # => 83_871
+    
+    at.regions.count
+    # => 9
+    at.regions
+    # => [ 'Wien', 'Niederösterreich', 'Oberösterreich', ... ]
+
+    at.cities.by_pop
+    # => [ 'Wien', 'Graz', 'Linz', 'Salzburg', ... ]
+
+
+'City' Model - Example:
+
+    c = City.find_by! key: 'wien'
+    c.name
+    # => 'Wien'
+    c.country.name
+    # => 'Austria'
+    c.country.continent.name
+    # => 'Europe'
+
+    la = City.find_by! key: 'losangeles'
+    la.name
+    # => 'Los Angeles'
+    la.region.name
+    # => 'California'
+    la.region.key
+    # => 'ca'
+    la.country.name
+    # => 'United States'
+    la.country.key
+    # => 'us'
+    la.country.continent.name
+    # => 'North America'
+
+
+'Tag' Model - Example:
+
+    euro = Tag.find_by! key: 'euro'
+    euro.countries.count
+    # => 17
+    euro.countries
+    # => ['Austria, 'Belgium', 'Cyprus', ... ]
+    
+    flanders = Tag.find_by! key: 'flanders'
+    flanders.regions.count
+    # => 5
+    flanders.regions
+    # => ['Antwerpen', 'Brabant Wallon', 'Limburg', 'Oost-Vlaanderen', ... ]
+    flanders.regions.first.country.name
+    # => 'Belgium'
+
+and so on.
 
 
 ## Install

data/Rakefile

@@ -1,9 +1,6 @@
 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.spec 'worlddb' do
   
@@ -18,12 +15,23 @@ Hoe.spec 'worlddb' do
   self.email   = 'openmundi@googlegroups.com'
 
   self.extra_deps = [
-    ['textutils', '~> 0.6'], # e.g.  >= 0.6 && <= 1.0
-    ['commander', '~> 4.1.3'],
-    ['activerecord', '~> 3.2']  # NB: will include activesupport,etc.
+    ['props'],         # settings / prop(ertie)s / env / INI
+    ['logutils'],     # logging
+    ['textutils', '>= 0.8.7'], # e.g.  >= 0.6 && <= 1.0  ## will include logutils, props
+    ['tagutils'],     # tags n categories for activerecord
+
+     ## 3rd party
+    ['gli', '>= 2.9'],
+    ['activerecord']  # NB: will include activesupport,etc.
     ### ['sqlite3',      '~> 1.3']  # NB: install on your own; remove dependency
   ]
 
+  # switch extension to .markdown for gihub formatting
+  #  -- NB: auto-changed when included in manifest
+  self.readme_file  = 'README.md'
+  self.history_file = 'HISTORY.md'
+
+
   self.licenses = ['Public Domain']
 
   self.spec_extras = {

data/lib/worlddb.rb

@@ -18,32 +18,48 @@ require 'active_record'   ## todo: add sqlite3? etc.
 
 require 'logutils'
 require 'textutils'
+require 'tagutils'
+require 'props'
+require 'props/db'  # includes ConfDb (ConfDb::Model::Prop, etc.)
 
 
 # our own code
 
+require 'worlddb/version'   # always goes first
 
+require 'worlddb/utils'
 
-require 'worlddb/version'
+require 'worlddb/models/forward'
 
-require 'worlddb/utils'
-require 'worlddb/models/prop'
+require 'worlddb/models/name'
+require 'worlddb/models/place'
 require 'worlddb/models/continent'
+require 'worlddb/models/continent_comp'
 require 'worlddb/models/country'
+require 'worlddb/models/country_comp'
 require 'worlddb/models/region'
+require 'worlddb/models/region_comp'
 require 'worlddb/models/city'
-require 'worlddb/models/tag'
-require 'worlddb/models/tagging'
+require 'worlddb/models/city_comp'
 require 'worlddb/models/lang'
+require 'worlddb/models/lang_comp'
 require 'worlddb/models/usage'
 
-module WorldDb
-  Models = Model   # note: alias for Model - remove later -- DEPRECIATED!!
-end
+require 'worlddb/models/tagdb/tag'
+require 'worlddb/models/tagdb/tagging'
+
 
 
 require 'worlddb/schema'       # NB: requires worlddb/models (include WorldDB::Models)
 require 'worlddb/matcher'
+
+require 'worlddb/readers/base'
+require 'worlddb/readers/lang'
+require 'worlddb/readers/usage'
+require 'worlddb/readers/country'
+require 'worlddb/readers/region'
+require 'worlddb/readers/city'
+
 require 'worlddb/reader'
 require 'worlddb/deleter'
 require 'worlddb/stats'
@@ -52,7 +68,7 @@ require 'worlddb/stats'
 module WorldDb
 
   def self.banner
-    "worlddb #{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+    "worlddb/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
   end
 
   def self.root
@@ -63,10 +79,10 @@ module WorldDb
     require 'worlddb/cli/main'
     ## Runner.new.run(ARGV) - old code
   end
-  
+
   def self.create
     CreateDb.new.up
-    WorldDb::Model::Prop.create!( key: 'db.schema.world.version', value: VERSION )
+    ConfDb::Model::Prop.create!( key: 'db.schema.world.version', value: VERSION )
   end
 
 
@@ -94,7 +110,8 @@ module WorldDb
     Deleter.new.run
   end # method delete!
 
- 
+ ####
+ ## todo: remove stats ??? why? why not? better use .tables
   def self.stats
     stats = Stats.new
     stats.tables
@@ -106,11 +123,16 @@ module WorldDb
   end
 
   def self.props
+    ### fix: use ConfDb.props delegate or similar !!!
     Stats.new.props
   end
 
 end  # module WorldDb
 
+###########################################
+# fix: remove old alias for WorldDb ??
+WorldDB = WorldDb
+
 
 if __FILE__ == $0
   WorldDb.main

data/lib/worlddb/cli/main.rb

@@ -1,24 +1,22 @@
 # encoding: utf-8
 
-require 'commander/import'
+require 'gli'
+ 
+include GLI::App
 
-require 'logutils/db'   # add support for logging to db
-require 'worlddb/cli/opts'
-
-LogUtils::Logger.root.level = :info   # set logging level to info 
+# our own code / additional for cli only
 
+require 'logutils/db'     # add support for logging to db
+require 'worlddb/cli/opts'
 
-program :name,  'worlddb'
-program :version, WorldDb::VERSION
-program :description, "world.db command line tool, version #{WorldDb::VERSION}"
 
+program_desc 'world.db command line tool'
 
-# default_command :help
-default_command :load
+version WorldDb::VERSION
 
-program :help_formatter, Commander::HelpFormatter::TerminalCompact
 
-## program :help, 'Examples', 'yada yada -try multi line later'
+LogUtils::Logger.root.level = :info   # set logging level to info 
+logger = LogUtils::Logger.root
 
 =begin
 ### add to help use new sections
@@ -35,19 +33,30 @@ Further information:
 =end
 
 
+
 ## todo: find a better name e.g. change to settings? config? safe_opts? why? why not?
-myopts = WorldDb::Opts.new
+opts = WorldDb::Opts.new
+
 
 ### global option (required)
 ## todo: add check that path is valid?? possible?
 
-global_option '-i', '--include PATH', String, "Data path (default is #{myopts.data_path})"
-global_option '-d', '--dbpath PATH', String, "Database path (default is #{myopts.db_path})"
-global_option '-n', '--dbname NAME', String, "Database name (datault is #{myopts.db_name})"
+desc 'Database path'
+arg_name 'PATH'
+default_value opts.db_path
+flag [:d, :dbpath]
+
+desc 'Database name'
+arg_name 'NAME'
+default_value opts.db_name
+flag [:n, :dbname]
+
+desc '(Debug) Show debug messages'
+switch [:verbose], negatable: false ## todo: use -w for short form? check ruby interpreter if in use too?
+
+desc 'Only show warnings, errors and fatal messages'
+switch [:q, :quiet], negatable: false
 
-global_option '-q', '--quiet', "Only show warnings, errors and fatal messages"
-### todo/fix: just want --debug/--verbose flag (no single letter option wanted) - fix
-global_option '-w', '--verbose', "Show debug messages"
 
 
 def connect_to_db( options )
@@ -69,144 +78,144 @@ def connect_to_db( options )
 end
 
 
-command :create do |c|
-  c.syntax = 'worlddb create [options]'
-  c.description = 'Create DB schema'
-  c.action do |args, options|
+desc 'Create DB schema'
+command [:create] do |c|
+  c.action do |g,o,args|
+    
+    connect_to_db( opts )
+    
+    LogDb.create
+    ConfDb.create
+    TagDb.create
+    WorldDb.create
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+    puts 'Done.'
+  end # action
+end # command create
+
+
+desc "Create DB schema 'n' load all world data"
+arg_name 'NAME' # optional setup profile name
+command [:setup,:s] do |c|
+
+  c.desc 'World data path'
+  c.arg_name 'PATH'
+  c.default_value opts.data_path
+  c.flag [:i,:include]
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts )
+  c.action do |g,o,args|
+
+    connect_to_db( opts )
+ 
+    ## todo: document optional setup profile arg (defaults to all)
+    setup = args[0] || 'all'
     
     LogDb.create
+    ConfDb.create
+    TagDb.create
     WorldDb.create
+
+    WorldDb.read_setup( "setups/#{setup}", opts.data_path )
+
     puts 'Done.'
   end # action
-end # command create
+end # command setup
 
-command :setup do |c|
-  c.syntax = 'worlddb setup [options]'
-  c.description = "Create DB schema 'n' load all data"
+desc 'Update all world data'
+arg_name 'NAME' # optional setup profile name
+command [:update,:up,:u] do |c|
 
-  c.option '--delete', 'Delete all records'
+  c.desc 'World data path'
+  c.arg_name 'PATH'
+  c.default_value opts.data_path
+  c.flag [:i,:include]
 
-  c.action do |args, options|
+  c.desc 'Delete all world data records'
+  c.switch [:delete], negatable: false
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+  c.action do |g,o,args|
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts )
+    connect_to_db( opts )
 
-    if options.delete.present?
-      # w/ delete flag assume tables already exit
+    ## todo: document optional setup profile arg (defaults to all)
+    setup = args[0] || 'all'
+
+    if o[:delete].present?
+      ## todo/fix: also delete TagDb.delete!
       WorldDb.delete!
-    else
-      LogDb.create
-      WorldDb.create
     end
 
-    WorldDb.read_all( myopts.data_path )
+    WorldDb.read_setup( "setups/#{setup}", opts.data_path )
+
     puts 'Done.'
   end # action
-end  # command setup
+end # command setup
 
-command :load do |c|
-  ## todo: how to specify many fixutes <>... ??? in syntax
-  c.syntax = 'worlddb load [options] <fixtures>'
-  c.description = 'Load fixtures'
 
-  c.option '--country KEY', String, "Default country for regions 'n' cities"
-  
-  ### todd/check - type flags still needed? dispatch using name and convention?
-  c.option '--countries', 'Use country plain text fixture reader'
-  c.option '--regions',   'Use regions plain text fixture reader'
-  c.option '--cities',    'Use cities  plain text fixture reader'
 
-  c.option '--delete', 'Delete all records'
+desc 'Load world fixtures'
+arg_name 'NAME' # multiple fixture names - todo/fix: use multiple option
+command [:load, :l] do |c|
 
-  c.action do |args, options|
+  c.desc 'Delete all world data records'
+  c.switch [:delete], negatable: false
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+  c.action do |g,o,args|
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts )
+    connect_to_db( opts )
     
-    WorldDb.delete! if options.delete.present?
+    if o[:delete].present?
+      ## todo/fix: also delete TagDb.delete!
+      WorldDb.delete!
+    end
+
+    reader = WorldDb::Reader.new( opts.data_path )
 
-    # read plain text country/region/city fixtures
-    reader = WorldDb::Reader.new( myopts.data_path )
     args.each do |arg|
-      name = arg     # File.basename( arg, '.*' )
-
-      if myopts.countries?
-        reader.load_countries( name )
-      elsif myopts.regions?
-        reader.load_regions( myopts.country, name )
-      elsif myopts.cities?
-        reader.load_cities( myopts.country, name )
-      else
-        reader.load( name )
-        ## todo: issue a warning here; no fixture type specified; assume country?
-      end
-      
+      name = arg # File.basename( arg, '.*' )
+      reader.load( name )
     end # each arg
-    
+
     puts 'Done.'
   end
 end # command load
 
 
+desc 'Show stats'
 command :stats do |c|
-  c.syntax = 'worlddb stats [options]'
-  c.description = 'Show stats'
-  c.action do |args, options|
+  c.action do |g,o,args|
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+    connect_to_db( opts )
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts ) 
-    
     WorldDb.tables
-    
+    TagDb.tables
+
     puts 'Done.'
   end
 end
 
 
+desc 'Show props'
 command :props do |c|
-  c.syntax = 'worlddb props [options]'
-  c.description = 'Show props'
-  c.action do |args, options|
+  c.action do |g,o,args|
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
-
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts ) 
+    connect_to_db( opts )
     
+    ### fix: use ConfDb.dump or similar  (for reuse) !!!
     WorldDb.props
-    
+
     puts 'Done.'
   end
 end
 
 
+desc 'Show logs'
 command :logs do |c|
-  c.syntax = 'worlddb logs [options]'
-  c.description = 'Show logs'
-  c.action do |args, options|
+  c.action do |g,o,args|
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+    connect_to_db( opts )
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts ) 
-    
+    ### fix: use LogDb.dump or similar (for reuse) !!!!    
     LogDb::Models::Log.all.each do |log|
       puts "[#{log.level}] -- #{log.msg}"
     end
@@ -216,18 +225,57 @@ command :logs do |c|
 end
 
 
-
+desc '(Debug) Test command suite'
 command :test do |c|
-  c.syntax = 'worlddb test [options]'
-  c.description = 'Debug/test command suite'
-  c.action do |args, options|
+  c.action do |g,o,args|
+
     puts "hello from test command"
     puts "args (#{args.class.name}):"
     pp args
-    puts "options:"
-    pp options
-    puts "options.__hash__:"
-    pp options.__hash__
+    puts "o (#{o.class.name}):"
+    pp o
+    puts "g (#{g.class.name}):"
+    pp g
+    
+    LogUtils::Logger.root.debug 'test debug msg'
+    LogUtils::Logger.root.info 'test info msg'
+    LogUtils::Logger.root.warn 'test warn msg'
+    
     puts 'Done.'
   end
 end
+
+
+pre do |g,c,o,args|
+  opts.merge_gli_options!( g )
+  opts.merge_gli_options!( o )
+
+  puts WorldDb.banner
+
+  if opts.verbose?
+    LogUtils::Logger.root.level = :debug
+  end
+
+  logger.debug "Executing #{c.name}"
+  true
+end
+
+post do |global,c,o,args|
+  logger.debug "Executed #{c.name}"
+  true
+end
+
+
+on_error do |e|
+  puts
+  puts "*** error: #{e.message}"
+
+  if opts.verbose?
+    puts e.backtrace
+  end
+
+  false # skip default error handling
+end
+
+
+exit run(ARGV)