sportdb 1.6.17 → 1.6.18

data/README.md

@@ -11,7 +11,88 @@
 
 ## Usage
 
-TBD
+The sportdb gem lets you load fixtures in plain text into your sports database (also includes schema & models for easy reuse) 
+
+~~~
+SYNOPSIS
+    sportdb [global options] command [command options] [arguments...]
+
+VERSION
+    1.6
+
+GLOBAL OPTIONS
+    -d, --dbpath=PATH - Database path (default: .)
+    -n, --dbname=NAME - Database name (default: sport.db)
+    --verbose         - (Debug) Show debug messages
+    --version         - Show version
+
+COMMANDS
+    create        - Create DB schema
+    setup, s      - Create DB schema 'n' load all world and sports data
+    update, up, u - Update all sports data
+    load, l       - Load sports fixtures
+    logs          - Show logs
+    props         - Show props
+    stats         - Show stats
+    test          - (Debug) Test command suite
+    help          - Shows a list of commands or help for one command
+~~~
+
+
+### `setup` Command
+
+~~~
+NAME
+    setup - Create DB schema 'n' load all world and sports data
+
+SYNOPSIS
+    sportdb [global options] setup [command options] NAME
+
+COMMAND OPTIONS
+    -i, --include=PATH  - Sports data path (default: .)
+    --worldinclude=PATH - World data path (default: none)
+
+EXAMPLES
+    sportdb setup --include ./at-austria --worldinclude ./world.db
+    sportdb setup 2013_14 --include ./at-austria --worldinclude ./world.db
+~~~
+
+
+### `update` Command
+
+~~~
+NAME
+    update - Update all sports data
+
+SYNOPSIS
+    sportdb [global options] update [command options] NAME
+
+COMMAND OPTIONS
+    --delete           - Delete all sports data records
+    -i, --include=PATH - Sports data path (default: .)
+
+EXAMPLES
+    sportdb update --include ./at-austria
+    sportdb update --include ./at-austria --delete
+    sportdb update 2013_14 --include ./at-austria --delete
+~~~
+
+### `load` Command
+
+~~~
+NAME
+    load - Load sports fixtures
+
+SYNOPSIS
+    sportdb [global options] load [command options] NAME
+
+COMMAND OPTIONS
+    --delete - Delete all sports data records
+
+EXAMPLES
+    sportdb load --include ./at-austria 2013_14/bl
+    sportdb load --include ./at-austria 2013_14/bl 2013_14/cup
+~~~
 
 
 ## Install
@@ -21,6 +102,20 @@ Just install the gem:
     $ gem install sportdb
 
 
+## Free Open Public Domain Datasets
+
+- [`football.db`](https://github.com/openfootball) - free open public domain football (soccer) data for use in any (programming) language
+- [`formula1.db`](https://github.com/geraldb/formula1.db) - free open public domain Formula 1/Formula One data for use in any (programming) language
+- [`sport.db`](https://github.com/geraldb/sport.db) - free open public domain sports data for use in any (programming) language
+- [`ski.db`](https://github.com/geraldb/ski.db) - free open public domain Ski Alpin/Alpine Ski data for use in any (programming) language
+
+
+## Questions? Comments?
+
+Send them along to the
+[Open Sports & Friends Forum/Mailing List](http://groups.google.com/group/opensport).
+Thanks!
+
 ## License
 
 The `sportdb` scripts are dedicated to the public domain.

data/Rakefile

@@ -29,7 +29,7 @@ Hoe.spec 'sportdb' do
                                #         - textutils
     
     ## 3rd party
-    ['commander', '~> 4.1.3']   # remove? -- already included as dep in worlddb
+    ['gli', '>= 2.5.6']
 
     ## ['activerecord', '~> 3.2'],  # NB: will include activesupport,etc.
     ### ['sqlite3',      '~> 1.3']  # NB: install on your own; remove dependency

data/lib/sportdb/cli/main.rb

@@ -9,26 +9,24 @@
 #        --include ../../github/football.db
 
 
-require 'commander/import'
+require 'gli'
+ 
+include GLI::App
 
 # our own code / additional for cli only
 
 require 'logutils/db'
 require 'sportdb/cli/opts'
+  
+ 
+program_desc 'sport.db command line tool'
 
-LogUtils::Logger.root.level = :info   # set logging level to info 
-
-program :name,  'sportdb'
-program :version, SportDb::VERSION
-program :description, "sport.db command line tool, version #{SportDb::VERSION}"
-
+version SportDb::VERSION
 
-# default_command :help
-default_command :load
 
-program :help_formatter, Commander::HelpFormatter::TerminalCompact
+LogUtils::Logger.root.level = :info   # set logging level to info 
+logger = LogUtils::Logger.root
 
-## program :help, 'Examples', 'yada yada -try multi line later'
 
 =begin
 ### add to help use new sections
@@ -47,18 +45,28 @@ Further information:
 
 
 ## todo: find a better name e.g. change to settings? config? safe_opts? why? why not?
-myopts = SportDb::Opts.new
+opts = SportDb::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})"
 
-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"
+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
+
 
 
 def connect_to_db( options )
@@ -80,16 +88,11 @@ def connect_to_db( options )
 end
 
 
-command :create do |c|
-  c.syntax = 'sportdb 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|
     
-    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 )
     
     LogDb.create
     WorldDb.create
@@ -98,108 +101,94 @@ command :create do |c|
   end # action
 end # command create
 
-command :setup do |c|
-  c.syntax = 'sportdb setup [options]'
-  c.description = "Create DB schema 'n' load all data"
 
-  c.option '--world', 'Populate world tables'
-  ## todo: use --world-include - how? find better name?
-  c.option '--worldinclude PATH', String, 'World data path'
+desc "Create DB schema 'n' load all world and sports data"
+arg_name 'NAME'   # optional setup profile name
+command [:setup,:s] do |c|
 
-  c.option '--sport', 'Populate sport tables'
-  c.option '--delete', 'Delete all records'
+  c.desc 'Sports data path'
+  c.arg_name 'PATH'
+  c.default_value opts.data_path
+  c.flag [:i,:include]
 
-  c.action do |args, options|
+  c.desc 'World data path'
+  c.arg_name 'PATH'
+  c.flag [:worldinclude]   ## todo: use --world-include - how? find better name? add :'world-include' ???
 
-    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 )
  
     ## todo: document optional setup profile arg (defaults to all)
     setup = args[0] || 'all'
     
-    if options.world.present? || options.sport.present?
-      
-      ## todo: check order for reference integrity
-      #  not really possible to delete world data if sport data is present
-      #   delete sport first
-      
-      if options.delete.present?
-        SportDb.delete! if options.sport.present?
-        WorldDb.delete! if options.world.present?
-      end
-      
-      if options.world.present?
-        WorldDb.read_all( myopts.world_data_path )
-      end
-      
-      if options.sport.present?
-        SportDb.read_setup( "setups/#{setup}", myopts.data_path )
-      end
-
-    else  # assume "plain" regular setup
-      LogDb.create
-      WorldDb.create
-      SportDb.create
+    LogDb.create
+    WorldDb.create
+    SportDb.create
     
-      WorldDb.read_all( myopts.world_data_path )
-      SportDb.read_setup( "setups/#{setup}", myopts.data_path )
-    end
+    WorldDb.read_all( opts.world_data_path )
+    SportDb.read_setup( "setups/#{setup}", opts.data_path )
     puts 'Done.'
   end # action
 end  # command setup
 
-command :load do |c|
-  ## todo: how to specify many fixutes <>... ??? in syntax
-  c.syntax = 'sportdb load [options] FIXTURE...'
-  c.description = 'Load fixtures'
 
-  c.option '-e', '--event KEY', String, 'Event to load'
-  c.option '--delete', 'Delete all records'
+desc 'Update all sports data'
+arg_name 'NAME'   # optional setup profile name
+command [:update,:up,:u] do |c|
+
+  c.desc 'Sports data path'
+  c.arg_name 'PATH'
+  c.default_value opts.data_path
+  c.flag [:i,:include]
+
+  c.desc 'Delete all sports data records'
+  c.switch [:delete], negatable: false 
+
+  c.action do |g,o,args|
+
+    connect_to_db( opts )
+
+    ## todo: document optional setup profile arg (defaults to all)
+    setup = args[0] || 'all'
+
+    SportDb.delete! if o[:delete].present?
+
+    SportDb.read_setup( "setups/#{setup}", opts.data_path )
+    puts 'Done.'
+  end # action
+end  # command setup
 
-  c.action do |args, options|
 
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+desc 'Load sports fixtures'
+arg_name 'NAME'   # multiple fixture names - todo/fix: use multiple option
+command [:load, :l] do |c|
 
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts )
+  c.desc 'Delete all sports data records'
+  c.switch [:delete], negatable: false 
+
+  c.action do |g,o,args|
+
+    connect_to_db( opts )
     
-    SportDb.delete! if options.delete.present?
+    SportDb.delete! if o[:delete].present?
 
-    reader = SportDb::Reader.new( myopts.data_path )
+    reader = SportDb::Reader.new( opts.data_path )
 
     args.each do |arg|
       name = arg     # File.basename( arg, '.*' )
-
-      if myopts.event.present?
-        ## fix: rename to load_event_fixtures_w... or similar
-        reader.load_fixtures( myopts.event, name )
-      else
-        ## fix> add a convenience method for loading single fixture
-        ary = []
-        ary << name
-        reader.load( ary )
-      end
+      reader.load( name )
     end # each arg
 
     puts 'Done.'
   end
 end # command load
 
-
+desc 'Show logs'
 command :logs do |c|
-  c.syntax = 'sportdb 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?
-
-    myopts.merge_commander_options!( options.__hash__ )
-    connect_to_db( myopts ) 
+    connect_to_db( opts ) 
     
     LogDb::Models::Log.all.each do |log|
       puts "[#{log.level}] -- #{log.msg}"
@@ -210,16 +199,11 @@ command :logs do |c|
 end
 
 
+desc 'Show stats'
 command :stats do |c|
-  c.syntax = 'sportdb stats [options]'
-  c.description = 'Show stats'
-  c.action do |args, options|
-
-    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 ) 
     
     SportDb.tables
     
@@ -228,16 +212,11 @@ command :stats do |c|
 end
 
 
+desc 'Show props'
 command :props do |c|
-  c.syntax = 'sportdb props [options]'
-  c.description = 'Show props'
-  c.action do |args, options|
-
-    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 )
     
     SportDb.props
     
@@ -246,21 +225,17 @@ command :props do |c|
 end
 
 
+desc '(Debug) Test command suite'
 command :test do |c|
-  c.syntax = 'sportdb test [options]'
-  c.description = 'Debug/test command suite'
-  c.action do |args, options|
-
-    LogUtils::Logger.root.level = :warn    if options.quiet.present?
-    LogUtils::Logger.root.level = :debug   if options.verbose.present?
+  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'
@@ -269,3 +244,39 @@ command :test do |c|
     puts 'Done.'
   end
 end
+
+
+
+pre do |g,c,o,args|
+  opts.merge_gli_options!( g )
+  opts.merge_gli_options!( o )
+
+  puts SportDb.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)

data/lib/sportdb/cli/opts.rb

@@ -2,33 +2,34 @@ module SportDb
 
 class Opts
 
-  def merge_commander_options!( options = {} )
+  def merge_gli_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?
-    @event     = options[:event]   if options[:event].present?
+    @verbose = true     if options[:verbose] == true
 
+    @data_path       = options[:include]      if options[:include].present?
     @world_data_path = options[:worldinclude] if options[:worldinclude].present? 
   end
 
 
-  def db_path
-    @db_path || '.'
+  def verbose=(boolean)   # add: alias for debug ??
+    @verbose = boolean
   end
 
-  def db_name
-    @db_name || 'sport.db'
+  def verbose?
+    return false if @verbose.nil?   # default verbose/debug flag is false
+    @verbose == true
   end
 
-  def event=(value)
-    @event = value
-  end
 
-  def event
-    @event   # NB: option has no default; return nil  ## || '.'
+  def db_path
+    @db_path || '.'
   end
 
+  def db_name
+    @db_name || 'sport.db'
+  end
 
   def data_path=(value)
     @data_path = value

data/lib/sportdb/reader.rb

@@ -68,7 +68,13 @@ class Reader
       load_records( name, race_id: race.id ) # e.g. 2013/04-gp-monaco.txt in formula1.db
     elsif name =~ /(?:^|\/)seasons/  # NB: ^seasons or also possible at-austria!/seasons
       load_seasons( name )
-    elsif name =~ /^leagues/
+    elsif match_leagues_for_country( name ) do |country_key|  # name =~ /^([a-z]{2})\/leagues/
+            # auto-add country code (from folder structure) for country-specific leagues
+            #  e.g. at/leagues
+            country = Country.find_by_key!( country_key )
+            load_leagues( name, club: true, country_id: country.id )
+          end
+    elsif name =~ /(?:^|\/)leagues/   # NB: ^leagues or also possible world!/leagues  - NB: make sure goes after leagues_for_country!!
       if name =~ /club/
         # e.g. leagues_club
         load_leagues( name, club: true )
@@ -76,19 +82,13 @@ class Reader
         # e.g. leagues
         load_leagues( name )
       end
-    elsif match_leagues_for_country( name ) do |country_key|  # name =~ /^([a-z]{2})\/leagues/
-            # auto-add country code (from folder structure) for country-specific leagues
-            #  e.g. at/leagues
-            country = Country.find_by_key!( country_key )
-            load_leagues( name, club: true, country_id: country.id )
-          end
     elsif match_teams_for_country( name ) do |country_key|   # name =~ /^([a-z]{2})\/teams/
             # auto-add country code (from folder structure) for country-specific teams
             #  e.g. at/teams at/teams.2 de/teams etc.                
             country = Country.find_by_key!( country_key )
             load_teams( name, club: true, country_id: country.id )
           end
-    elsif name =~ /\/teams/
+    elsif name =~ /(?:^|\/)teams/
       if name =~ /club/
         # club teams (many countries)
         # e.g. club/europe/teams

data/lib/sportdb/version.rb

@@ -1,6 +1,6 @@
 
 module SportDb
-  VERSION = '1.6.17'
+  VERSION = '1.6.18'
 end
 
 ###########################################

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sportdb
 version: !ruby/object:Gem::Version
-  version: 1.6.17
+  version: 1.6.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000Z
+date: 2013-06-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: worlddb
-  requirement: &16188720 !ruby/object:Gem::Requirement
+  requirement: &13812420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,21 @@ dependencies:
         version: '1.7'
   type: :runtime
   prerelease: false
-  version_requirements: *16188720
+  version_requirements: *13812420
 - !ruby/object:Gem::Dependency
-  name: commander
-  requirement: &16188324 !ruby/object:Gem::Requirement
+  name: gli
+  requirement: &13812156 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.1.3
+        version: 2.5.6
   type: :runtime
   prerelease: false
-  version_requirements: *16188324
+  version_requirements: *13812156
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &16187760 !ruby/object:Gem::Requirement
+  requirement: &13811748 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '4.0'
   type: :development
   prerelease: false
-  version_requirements: *16187760
+  version_requirements: *13811748
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &16187424 !ruby/object:Gem::Requirement
+  requirement: &13811340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '3.6'
   type: :development
   prerelease: false
-  version_requirements: *16187424
+  version_requirements: *13811340
 description: sportdb - sport.db command line tool
 email: opensport@googlegroups.com
 executables: