football-to-psql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79affa06d1e38ff1e8d4d7c91dce434b1046a104
+  data.tar.gz: 5183a62a72e7a11148017b538b42a8a63e48ecb4
+SHA512:
+  metadata.gz: d93a901601582e668cf5cf48304ba42f53d05a3709203654e832015636ac66627e0462a9fedbcc097c3e5ee03e6fd46730811517de79523e990e4be6180b96c2
+  data.tar.gz: 7c852682e58cb61aece7356a6a838cb7835e103a3b86a7f7f8c15b5bb534ff7cf8872802bf9579e4693238cd04e48f5d7c96d40732dadd694d27e1a21b58f077

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2020-10-28
+
+* Everything is new. First release.

data/Manifest.txt

@@ -0,0 +1,10 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+bin/football-to-psql
+bin/football2psql
+lib/football-to-psql.rb
+lib/football-to-psql/version.rb
+test/helper.rb
+test/test_version.rb

data/README.md

@@ -0,0 +1,138 @@
+# football-to-psql - load / read football.txt datafiles into a postgresql database
+
+
+* home  :: [github.com/sportdb/football.db](https://github.com/sportdb/football.db)
+* bugs  :: [github.com/sportdb/football.db/issues](https://github.com/sportdb/football.db/issues)
+* gem   :: [rubygems.org/gems/football-to-psql](https://rubygems.org/gems/football-to-psql)
+* rdoc  :: [rubydoc.info/gems/football-to-psql](http://rubydoc.info/gems/football-to-psql)
+* forum :: [opensport](http://groups.google.com/group/opensport)
+
+
+
+
+## Usage
+
+Try:
+
+```
+$ football-to-psql --help
+```
+
+printing:
+
+
+```
+Usage: football-to-psql [options] DATABASE PATHS...
+    -u, --username USERNAME     database username (default: postgres)
+    -p, --password PASSWORD     database password (default: postgres)
+    -h, --host HOST             database host     (default: localhost)
+```
+
+
+
+
+Run this tool against match files (for clubs or national teams) in the Football.TXT format like so:
+
+```
+$ football-to-psql england.db 2020-21/1-premierleague.txt
+
+# -or-
+
+$ football-to-psql worldcup.db 2018--russia/cup.txt
+```
+
+or pass in more than one match file (e.g. different leagues or more seasons / years ):
+
+```
+$ football-to-psql england.db 2020-21/1-premierleague.txt  \
+                              2020-21/2-championship.txt   \
+                              2020-21/3-league1.txt        \
+                              2020-21/4-league2.txt        \
+                             2020-21/5-nationalleague.txt
+
+# -or-
+
+$ football-to-psql premier.db 2020-21/1-premierleague.txt  \
+                              2019-20/1-premierleague.txt  \
+                              2018-19/1-premierleague.txt  \
+                              2017-18/1-premierleague.txt  \
+                              2016-17/1-premierleague.txt
+
+# -or-
+
+$ football-to-psql worldcup.db 2018--russia/cup.txt                     \
+                               2018--russia/cup_finals.txt              \
+                               2014--brazil/cup.txt                     \
+                               2014--brazil/cup_finals.txt              \
+                               2010--south-africa/cup.txt               \
+                               2010--south-africa/cup_finals.txt        \
+                               2006--germany/cup.txt                    \
+                               2006--germany/cup_finals.txt             \
+                               2002--south-korea-n-japan/cup.txt        \
+                               2002--south-korea-n-japan/cup_finals.txt \
+                               1998--france/cup.txt                     \
+                               1998--france/cup_finals.txt              \
+                               1994--united-states/cup.txt              \
+                              1994--united-states/cup_finals.txt
+```
+
+
+Note: If the PostgreSQL database (and its tables, views & indices) do not (yet) exist, they get auto-created / auto-migrated on the first run.
+
+
+Note: You can use `football2psql` as an alias / alternate name.
+
+
+**Pipes & Standard Input (STDIN)**
+
+You can use any command line tool to download match files and pipe (via stdin) into this tool like so:
+
+```
+$ curl https://raw.githubusercontent.com/openfootball/world-cup/master/2018--russia/cup.txt | football-to-psql worldcup.db
+```
+
+That's it for now.
+
+
+
+
+## Limitations
+
+Note: For now you CANNOT update match files, that is,
+if you try to add the same match twice (assuming with updated scores or such), the match reader will fail for now.
+The workaround is to always re-create/re-build your database from zero / scratch for now.
+
+
+
+## Datasets
+
+For some open public domain Football.TXT datasets to get started, see the [open football org](https://github.com/openfootball).
+
+
+Add your datasets here!
+
+
+
+## Installation
+
+Use
+
+    gem install football-to-psql
+
+or add the gem to your Gemfile
+
+    gem 'football-to-psql'
+
+
+## License
+
+The `football-to-psql` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Send them along to the
+[Open Sports & Friends Forum/Mailing List](http://groups.google.com/group/opensport).
+Thanks!
+

data/Rakefile

@@ -0,0 +1,34 @@
+require 'hoe'
+require './lib/football-to-psql/version.rb'
+
+
+Hoe.spec 'football-to-psql' do
+
+  self.version = SportDb::Module::FootballToPsql::VERSION
+
+  self.summary = 'football-to-psql - load / read football.txt datafiles into a postgresql database'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/sportdb/football.db'}
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'opensport@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  #  -- Note: auto-changed when included in manifest
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['sportdb-readers', '>= 1.1.2'],
+
+    ## ['activerecord'],  # Note: will include activesupport,etc.
+    ## ['postgres'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+end

data/bin/football-to-psql

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/football-to-psql
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/football-to-psql
+#
+
+require 'football-to-psql'
+
+FootballToPsql.main

data/bin/football2psql

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/football2psql
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/football2psql
+#
+
+require 'football-to-psql'
+
+FootballToPsql.main

data/lib/football-to-psql.rb

@@ -0,0 +1,124 @@
+require 'optparse'
+
+require 'sportdb/readers'
+
+require 'logutils/activerecord'   ## NOTE: check - add to/include in/move to sportdb/models
+
+
+
+###
+# our own code
+require 'football-to-psql/version' # let version always go first
+
+
+module FootballToPsql
+class Tool
+
+def initialize
+  LogUtils::Logger.root.level = :info   # set logging level to info
+end
+
+
+
+def connect( dbconfig )
+  puts "working directory: #{Dir.pwd}"
+
+  SportDb.connect( dbconfig )
+
+  SportDb.auto_migrate!
+
+  LogDb.setup  # start logging to db (that is, save logs in logs table in db)
+end
+
+
+
+def run( args )
+  dbconfig = {
+    adapter:   'postgresql',
+    encoding:  'unicode',
+    username:  'postgres',
+    password:  'postgres',
+    host:      'localhost',
+    database:  'sport.db',
+    pool:       5,
+    timeout:    5000
+  }
+
+  options = {}
+  optparser = OptionParser.new do |parser|
+    parser.banner = "Usage: football-to-psql [options] DATABASE PATHS..."
+
+    parser.on( '-u', '--user USERNAME', '--username USERNAME',
+                 "database username (default: #{dbconfig[:username]})" ) do |username|
+      options[:username] = username
+    end
+
+    parser.on( '-p', '--password PASSWORD',
+                 "database password (default: #{dbconfig[:password]})" ) do |password|
+      options[:password] = password
+    end
+
+    parser.on( '-h', '--host HOST',
+                 "database host (default: #{dbconfig[:host]})" ) do |host|
+      options[:host] = host
+    end
+  end
+  optparser.parse!( args )
+
+  if args.empty?
+    puts "!! ERROR - postgresql database name expected (e.g. sport.db)"
+    puts optparser.help
+    exit 1
+  end
+
+
+
+  dbname = args.shift
+  puts "dbname: >#{dbname}<"
+  puts "args:"
+  p args
+
+  dbconfig[:database] = dbname
+
+  dbconfig[:username] = options[:username]  if options[:username]
+  dbconfig[:password] = options[:password]  if options[:password]
+  dbconfig[:host]     = options[:host]      if options[:host]
+
+
+  connect( dbconfig )
+
+  args.each do |arg|
+    puts "reading #{arg}..."
+    ## note: only support reading matchfiles for now (NOT zips & dirs or clubs & leagues etc.)
+    SportDb.read_match( arg )
+  end
+
+  ## todo: check if stdin is always utf-8 or such?
+  unless STDIN.tty?
+    puts "reading STDIN..."
+    ## assume/ read stdin as utf8 - possible?
+    txt = STDIN.read
+    puts "[------------->>>"
+    puts txt
+    puts "<<<-------------]"
+    SportDb.parse_match( txt )
+    puts "encoding: #{txt.encoding}"
+  end
+
+
+  ## print some stats
+  SportDb.tables
+
+  puts "Done."
+end # method run
+
+
+end  # class Tool
+
+
+  def self.main( args=ARGV ) Tool.new.run( args ); end
+end  # module FootballToPsql
+
+
+
+puts SportDb::Module::FootballToPsql.banner   # say hello

data/lib/football-to-psql/version.rb

@@ -0,0 +1,24 @@
+module SportDb
+module Module
+module FootballToPsql
+
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "football-to-psql/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module FootballToPsql
+end # module Module
+end # module SportDb

data/test/helper.rb

@@ -0,0 +1,9 @@
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+require 'football-to-psql'
+
+

data/test/test_version.rb

@@ -0,0 +1,17 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_version.rb
+
+
+require 'helper'
+
+class TestVersion < MiniTest::Test
+
+  def test_version
+    puts SportDb::Module::FootballToPsql.banner
+    puts SportDb::Module::FootballToPsql.root
+    puts SportDb::Module::FootballToPsql::VERSION
+  end
+
+end # class TestVersion
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: football-to-psql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sportdb-readers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.22'
+description: football-to-psql - load / read football.txt datafiles into a postgresql
+  database
+email: opensport@googlegroups.com
+executables:
+- football-to-psql
+- football2psql
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/football-to-psql
+- bin/football2psql
+- lib/football-to-psql.rb
+- lib/football-to-psql/version.rb
+- test/helper.rb
+- test/test_version.rb
+homepage: https://github.com/sportdb/football.db
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: football-to-psql - load / read football.txt datafiles into a postgresql database
+test_files: []