worlddb 0.8.0 → 1.0.0

data/Manifest.txt

@@ -3,103 +3,12 @@ Manifest.txt
 README.md
 Rakefile
 bin/worlddb
-data/africa/1_codes/fifa.yml
-data/africa/1_codes/internet.yml
-data/africa/1_codes/iso3.yml
-data/africa/2_names/de.yml
-data/africa/3_more/en.wikipedia.yml
-data/africa/3_more/lang.yml
-data/africa/countries.txt
-data/america/1_codes/fifa.yml
-data/america/1_codes/internet.yml
-data/america/1_codes/iso3.yml
-data/america/1_codes/motor.yml
-data/america/2_names/de.yml
-data/america/2_names/es.yml
-data/america/3_more/en.wikipedia.yml
-data/america/3_more/lang.yml
-data/america/br/regions.txt
-data/america/ca/cities.txt
-data/america/ca/regions.txt
-data/america/countries.txt
-data/america/mx/cities.txt
-data/america/mx/regions.txt
-data/america/us/cities.txt
-data/america/us/regions.txt
-data/america/ve/cities.txt
-data/america/ve/regions.txt
-data/asia/1_codes/fifa.yml
-data/asia/1_codes/internet.yml
-data/asia/1_codes/iso3.yml
-data/asia/2_names/de.yml
-data/asia/3_more/en.wikipedia.yml
-data/asia/3_more/lang.yml
-data/asia/countries.txt
-data/asia/jp/cities.txt
-data/europe/1_codes/fifa.yml
-data/europe/1_codes/internet.yml
-data/europe/1_codes/iso3.yml
-data/europe/1_codes/motor.yml
-data/europe/2_names/de.yml
-data/europe/2_names/es.yml
-data/europe/3_more/en.wikipedia.yml
-data/europe/3_more/lang.yml
-data/europe/at/cities.txt
-data/europe/at/regions.txt
-data/europe/be/cities.txt
-data/europe/be/regions.txt
-data/europe/bg/cities.txt
-data/europe/by/cities.txt
-data/europe/ch/cities.txt
-data/europe/countries.txt
-data/europe/cy/cities.txt
-data/europe/cz/cities.txt
-data/europe/cz/regions.txt
-data/europe/de/cities.txt
-data/europe/de/regions.txt
-data/europe/dk/cities.txt
-data/europe/ee/cities.txt
-data/europe/en/cities.txt
-data/europe/en/regions.txt
-data/europe/es/cities.txt
-data/europe/es/regions.txt
-data/europe/fi/cities.txt
-data/europe/fr/cities.txt
-data/europe/fr/regions.txt
-data/europe/gr/cities.txt
-data/europe/hr/cities.txt
-data/europe/hu/cities.txt
-data/europe/ie/cities.txt
-data/europe/it/cities.txt
-data/europe/lt/cities.txt
-data/europe/lv/cities.txt
-data/europe/nl/cities.txt
-data/europe/no/cities.txt
-data/europe/pl/cities.txt
-data/europe/pt/cities.txt
-data/europe/ro/cities.txt
-data/europe/rs/cities.txt
-data/europe/ru/cities.txt
-data/europe/sc/cities.txt
-data/europe/se/cities.txt
-data/europe/tr/cities.txt
-data/europe/ua/cities.txt
-data/europe/wa/cities.txt
-data/langs.yml
-data/oceania/1_codes/fifa.yml
-data/oceania/1_codes/internet.yml
-data/oceania/1_codes/iso3.yml
-data/oceania/2_names/de.yml
-data/oceania/3_more/en.wikipedia.yml
-data/oceania/3_more/lang.yml
-data/oceania/au/cities.txt
-data/oceania/countries.txt
-data/tags.1.yml
-data/tags.3.yml
 lib/worlddb.rb
+lib/worlddb/cli/main.rb
 lib/worlddb/cli/opts.rb
-lib/worlddb/cli/runner.rb
 lib/worlddb/console.rb
+lib/worlddb/data/fixtures.rb
+lib/worlddb/deleter.rb
 lib/worlddb/models/city.rb
 lib/worlddb/models/country.rb
 lib/worlddb/models/lang.rb
@@ -109,10 +18,7 @@ lib/worlddb/models/tag.rb
 lib/worlddb/models/tagging.rb
 lib/worlddb/models/usage.rb
 lib/worlddb/reader.rb
-lib/worlddb/readers/code_reader.rb
-lib/worlddb/readers/hash_reader.rb
-lib/worlddb/readers/line_reader.rb
-lib/worlddb/readers/values_reader.rb
 lib/worlddb/schema.rb
+lib/worlddb/stats.rb
 lib/worlddb/utils.rb
 lib/worlddb/version.rb

data/Rakefile

@@ -6,12 +6,6 @@ require './lib/worlddb/version.rb'
 Hoe::plugin :manifest   # more options for manifests (in the future; not yet)
 
 
-###########
-#### NB: if you try this script at home
-#    you need to create a (symbolic) link to the world.db fixtures
-#     e.g. use ln -s ../world.db  data  or similar
-
-
 Hoe.spec 'worlddb' do
   
   self.version = WorldDB::VERSION
@@ -25,6 +19,7 @@ Hoe.spec 'worlddb' do
   self.email   = 'opensport@googlegroups.com'
   
   self.extra_deps = [
+    ['textutils', '~> 0.3.0'],
     ['activerecord', '~> 3.2']  # NB: will include activesupport,etc.
     ### ['sqlite3',      '~> 1.3']  # NB: install on your own; remove dependency
   ]

data/lib/worlddb/cli/main.rb

@@ -0,0 +1,170 @@
+# encoding: utf-8
+
+require 'commander/import'
+
+require 'worlddb/cli/opts'
+
+
+
+program :name,  'worlddb'
+program :version, WorldDB::VERSION
+program :description, "world.db command line tool, version #{WorldDB::VERSION}"
+
+
+# default_command :help
+default_command :load
+
+program :help_formatter, Commander::HelpFormatter::TerminalCompact
+
+## program :help, 'Examples', 'yada yada -try multi line later'
+
+=begin
+### add to help use new sections
+
+Examples:
+    worlddb at/cities                      # import austrian cities
+    worlddb --create                       # create database schema
+
+More Examples:
+    worlddb                                # show stats (table counts, table props)
+
+Further information:
+  http://geraldb.github.com/world.db=end
+=end
+
+
+## todo: find a better name e.g. change to settings? config? safe_opts? why? why not?
+myopts = 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})"
+
+
+def connect_to_db( options )
+  puts WorldDB.banner
+
+  puts "working directory: #{Dir.pwd}"
+
+  db_config = {
+    :adapter  => 'sqlite3',
+    :database => "#{options.db_path}/#{options.db_name}"
+  }
+
+  puts "Connecting to db using settings: "
+  pp db_config
+
+  ActiveRecord::Base.establish_connection( db_config )
+end
+
+
+command :create do |c|
+  c.syntax = 'worlddb create [options]'
+  c.description = 'Create DB schema'
+  c.action do |args, options|
+    myopts.merge_commander_options!( options.__hash__ )
+    connect_to_db( myopts )
+    
+    LogDB.create
+    WorldDB.create
+    puts 'Done.'
+  end # action
+end # command create
+
+command :setup do |c|
+  c.syntax = 'worlddb setup [options]'
+  c.description = "Create DB schema 'n' load all data"
+
+  c.option '--delete', 'Delete all records'
+
+  c.action do |args, options|
+    myopts.merge_commander_options!( options.__hash__ )
+    connect_to_db( myopts )
+
+    if options.delete.present?
+      # w/ delete flag assume tables already exit
+      WorldDB.delete!
+    else
+      LogDB.create
+      WorldDB.create
+    end
+
+    WorldDB.read_all( myopts.data_path )
+    puts 'Done.'
+  end # action
+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'
+
+  c.action do |args, options|
+    myopts.merge_commander_options!( options.__hash__ )
+    connect_to_db( myopts )
+    
+    WorldDB.delete! if options.delete.present?
+
+    # read plain text country/region/city fixtures
+    reader = WorldDB::Reader.new  # todo: add logger here?
+    args.each do |arg|
+      name = arg     # File.basename( arg, '.*' )
+
+      if myopts.countries?
+        reader.load_countries_with_include_path( name, myopts.data_path )
+      elsif myopts.regions?
+        reader.load_regions_with_include_path( myopts.country, name, myopts.data_path )
+      elsif myopts.cities?
+        reader.load_cities_with_include_path( myopts.country, name, myopts.data_path )
+      else
+        reader.load_with_include_path( name, myopts.data_path )
+        ## todo: issue a warning here; no fixture type specified; assume country?
+      end
+      
+    end # each arg
+    
+    puts 'Done.'
+  end
+end # command load
+
+
+command :stats do |c|
+  c.syntax = 'worlddb stats [options]'
+  c.description = 'Show stats'
+  c.action do |args, options|
+    myopts.merge_commander_options!( options.__hash__ )
+    connect_to_db( myopts ) 
+    
+    WorldDB.stats
+    
+    puts 'Done.'
+  end
+end
+
+
+command :test do |c|
+  c.syntax = 'worlddb test [options]'
+  c.description = 'Debug/test command suite'
+  c.action do |args, options|
+    puts "hello from test command"
+    puts "args (#{args.class.name}):"
+    pp args
+    puts "options:"
+    pp options
+    puts "options.__hash__:"
+    pp options.__hash__
+    puts 'Done.'
+  end
+end

data/lib/worlddb/cli/opts.rb

@@ -2,6 +2,30 @@ 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 country=(value)
     @country = value
   end
@@ -37,56 +61,6 @@ class Opts
     return false if @cities.nil?   # default cities flag is false
     @cities == true
   end
-
-
-  def create=(boolean)
-    @create = boolean
-  end
-
-  def create?
-    return false if @create.nil?   # default create flag is false
-    @create == true
-  end
-
-
-  def setup=(boolean)
-    @setup = boolean
-  end
-
-  def setup?
-    return false if @setup.nil?   # default create flag is false
-    @setup == true
-  end
-
-
-  def delete=(boolean)
-    @delete = boolean
-  end
-
-  def delete?
-    return false if @delete.nil?   # default create flag is false
-    @delete == true
-  end
-
-
-  # use loader? (that is, built-in seed data)
-  def load=(boolean)
-    @load = boolean
-  end
-
-  def load?
-    return false if @load.nil?   # default create flag is false
-    @load == true
-  end
-
-
-  def output_path=(value)
-    @output_path = value
-  end
-  
-  def output_path
-    @output_path || '.'
-  end
   
 
   def data_path=(value)

data/lib/worlddb/data/fixtures.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+
+
+def find_world_db_path_from_gemfile_gitref!
+  puts "[debug] find_world_db_path..."
+  puts "load path:"
+  pp $LOAD_PATH
+  
+  candidates = []
+  $LOAD_PATH.each do |path|
+    
+    # nb: avoid matching /world.db.ruby/ (e.g. gem "worlddb", "0.10.0", :path => "../world.db.ruby")
+    
+    if path =~ /\/(world\.db-[a-z0-9]+)|(world\.db)\//
+      candidates << path.dup
+    end
+  end
+  
+  puts "found candidates:"
+  pp candidates
+  
+  cand = candidates[0]
+  
+  puts "cand before: #{cand}"
+  
+  ## nb: *? is non-greedy many operator
+  
+  ## todo: why not just cut off trailing /lib - is it good enough??
+  # it's easier  
+  
+  regex = /(\/world\.db.*?)(\/.*)/
+  cand = cand.sub( regex ) do |_|
+    puts "cutting off >>#{$2}<<"
+    $1
+  end
+  
+  puts "cand after: #{cand}"
+  
+  ## todo:exit with error if not found!!!
+  
+  cand
+end
+
+
+
+module WorldDB
+
+  module Fixtures   # use shortcut/alias Fx?
+
+  def self.all  # all builtin fixtures; helper for covenience
+     tag_fixtures  + 
+     country_fixtures +
+     lang_fixtures +
+     africa_fixtures  +
+     america_fixtures +
+     europe_fixtures  +
+     asia_fixtures    +
+     oceania_fixtures
+  end
+
+  def self.tag_fixtures
+    ['tags.1', 'tags.3']
+  end
+  
+  def self.country_fixtures
+    ['africa/countries',
+     'america/countries',
+     'asia/countries',
+     'europe/countries',
+     'oceania/countries']
+  end
+
+  def self.lang_fixtures
+    ['langs',
+     'africa/3_more/lang',
+     'america/3_more/lang',
+     'asia/3_more/lang',
+     'europe/3_more/lang',
+     'oceania/3_more/lang'
+    ]
+  end
+
+  def self.africa_fixtures
+    ['1_codes/fifa',
+     '1_codes/internet',
+     '1_codes/iso3'].map { |path| "africa/#{path}" }
+  end
+
+  def self.america_fixtures
+  ['1_codes/fifa',
+   '1_codes/internet',
+   '1_codes/iso3',
+   '1_codes/motor',
+   'br/regions',
+   'ca/regions',
+   'ca/cities',
+   'mx/regions',
+   'mx/cities',
+   'us/regions',
+   'us/cities',
+   've/regions',
+   've/cities'].map { |path| "america/#{path}" }
+  end
+
+  def self.asia_fixtures
+  ['1_codes/fifa',
+   '1_codes/internet',
+   '1_codes/iso3',
+   'jp/cities'].map { |path| "asia/#{path}" }
+  end
+  
+  def self.europe_fixtures
+  ['1_codes/fifa',
+   '1_codes/internet',
+   '1_codes/iso3',
+   '1_codes/motor',
+   'at/regions',
+   'at/cities',
+   'be/regions',
+   'be/cities',
+   'bg/cities',
+   'by/cities',
+   'ch/cities',
+   'cy/cities',
+   'cz/regions',
+   'cz/cities',
+   'de/regions',
+   'de/cities',
+   'dk/cities',
+   'ee/cities',
+   'en/regions',
+   'en/cities',
+   'es/regions',
+   'es/cities',
+   'fi/cities',
+   'fr/regions',
+   'fr/cities',
+   'gr/cities',
+   'hr/cities',
+   'hu/cities',
+   'ie/cities',
+   'it/cities',
+   'lt/cities',
+   'lv/cities',
+   'nl/cities',
+   'no/cities',
+   'pl/cities',
+   'pt/cities',
+   'ro/cities',
+   'rs/cities',
+   'ru/cities',
+   'sc/cities',
+   'se/cities',
+   'tr/cities',
+   'ua/cities',
+   'wa/cities'].map { |path| "europe/#{path}" }
+  end
+
+  def self.oceania_fixtures
+   ['1_codes/fifa',
+    '1_codes/internet',
+    '1_codes/iso3',
+    'au/cities'].map { |path| "oceania/#{path}" }
+  end
+
+  end # module Fixtures
+
+end # module WorldDB

data/lib/worlddb/deleter.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+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
+
+    def run
+      # for now delete all tables
+      
+      Tagging.delete_all
+      Tag.delete_all
+      City.delete_all
+      Region.delete_all
+      Country.delete_all
+      Usage.delete_all
+      Lang.delete_all
+      Prop.delete_all
+    end
+    
+  end # class Deleter
+
+end # module WorldDB