sportdb-formats 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dfb4b397ab313f54b1a8c6943d7707777737af9
+  data.tar.gz: d1d8413b546a02575adce273ba2fe95db93893f3
+SHA512:
+  metadata.gz: 65403f493c15c5ca2113416570567bf0d5f7b68655cd85462ae609480119bfab417f5e318cbf7b5e97d02b09022845ab886ca675392b5f1358610c7c00eb5d4f
+  data.tar.gz: c941e27074b31c830c3cf9ac3e8c5581852aec1ee8490b732fc56f8afc69862a0ae2f91f1a28d061da3e55f1f9d235c140c438ff198fa8dcd53af192e863b95e

data/CHANGELOG.md

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

data/Manifest.txt

@@ -0,0 +1,10 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/sportdb/formats.rb
+lib/sportdb/formats/outline_reader.rb
+lib/sportdb/formats/version.rb
+test/helper.rb
+test/test_csv_reader.rb
+test/test_outline_reader.rb

data/README.md

@@ -0,0 +1,26 @@
+# sportdb-formats - sport.db format and text utilities  
+
+
+* home  :: [github.com/sportdb/sport.db](https://github.com/sportdb/sport.db)
+* bugs  :: [github.com/sportdb/sport.db/issues](https://github.com/sportdb/sport.db/issues)
+* gem   :: [rubygems.org/gems/sportdb-formats](https://rubygems.org/gems/sportdb-formats)
+* rdoc  :: [rubydoc.info/gems/sportdb-formats](http://rubydoc.info/gems/sportdb-formats)
+* forum :: [opensport](http://groups.google.com/group/opensport)
+
+
+
+## Usage
+
+To be done
+
+## License
+
+The `sportdb-formats` 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,31 @@
+require 'hoe'
+require './lib/sportdb/formats/version.rb'
+
+Hoe.spec 'sportdb-formats' do
+
+  self.version = SportDb::Formats::VERSION
+
+  self.summary = "sportdb-formats - sport.db format and text utilities"
+  self.description = summary
+
+  self.urls = ['https://github.com/sportdb/sport.db']
+
+  self.author = 'Gerald Bauer'
+  self.email = 'opensport@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.licenses = ['Public Domain']
+
+  self.extra_deps = [
+    ['alphabets',   '>= 0.1.0'],
+    ['csvreader',   '>= 1.2.4'],
+  ]
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/sportdb/formats.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'pp'
+require 'date'
+require 'fileutils'
+
+
+## 3rd party gems
+require 'alphabets'      # downcase_i18n, unaccent, variants, ...
+require 'csvreader'
+
+def read_csv( path )
+  CsvHash.read( path, :header_converters => :symbol )
+end
+
+def parse_csv( txt )
+  CsvHash.parse( txt, :header_converters => :symbol )
+end
+
+
+###
+# our own code
+require 'sportdb/formats/version' # let version always go first
+require 'sportdb/formats/outline_reader'
+
+
+
+
+## let's put test configuration in its own namespace / module
+module SportDb
+class Test    ## todo/check: works with module too? use a module - why? why not?
+
+  ####
+  #  todo/fix:  find a better way to configure shared test datasets - why? why not?
+  #    note: use one-up (..) directory for now as default - why? why not?
+  def self.data_dir()        @data_dir ||= '../test'; end
+  def self.data_dir=( path ) @data_dir = path; end
+end
+end   # module SportDb
+
+
+
+puts SportDb::Formats.banner   # say hello

data/lib/sportdb/formats/outline_reader.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+module SportDb
+
+class OutlineReader
+
+  def self.read( path )   ## use - rename to read_file or from_file etc. - why? why not?
+    txt = File.open( path, 'r:utf-8' ).read
+    parse( txt )
+  end
+
+  def self.parse( txt )
+    outline=[]   ## outline structure
+
+    txt.each_line do |line|
+        line = line.strip      ## todo/fix: keep leading and trailing spaces - why? why not?
+
+        next if line.empty?    ## todo/fix: keep blank line nodes e.g. just remove comments and process headings?! - why? why not?
+        break if line == '__END__'
+
+        next if line.start_with?( '#' )   ## skip comments too
+        ## strip inline (until end-of-line) comments too
+        ##  e.g Eupen | KAS Eupen ## [de]
+        ##   => Eupen | KAS Eupen
+        ##  e.g bq   Bonaire,  BOE        # CONCACAF
+        ##   => bq   Bonaire,  BOE
+        line = line.sub( /#.*/, '' ).strip
+        pp line
+
+        next if line =~ /^={1,}$/          ## skip "decorative" only heading e.g. ========
+
+         ## note: like in wikimedia markup (and markdown) all optional trailing ==== too
+         ##  todo/check:  allow ===  Text  =-=-=-=-=-=   too - why? why not?
+        if line =~ /^(={1,})       ## leading ======
+                     ([^=]+?)      ##  text   (note: for now no "inline" = allowed)
+                     =*            ## (optional) trailing ====
+                     $/x
+           heading_marker = $1
+           heading_level  = $1.length   ## count number of = for heading level
+           heading        = $2.strip
+
+           puts "heading #{heading_level} >#{heading}<"
+           outline << [:"h#{heading_level}", heading]
+        else
+           ## assume it's a (plain/regular) text line
+           outline << [:l, line]
+        end
+    end
+    outline
+  end # method read
+end # class OutlineReader
+
+end # module SportDb

data/lib/sportdb/formats/version.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+
+module SportDb
+module Formats
+
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "sportdb-formats/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(File.dirname(__FILE__)))) )
+  end
+
+end # module Formats
+end # module SportDb

data/test/helper.rb

@@ -0,0 +1,8 @@
+## $:.unshift(File.dirname(__FILE__))
+
+## minitest setup
+require 'minitest/autorun'
+
+
+## our own code
+require 'sportdb/formats'

data/test/test_csv_reader.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_csv_reader.rb
+
+
+require 'helper'
+
+class TestCsvReader < MiniTest::Test
+
+  def test_parse
+    recs = parse_csv( <<TXT )
+### World Countries
+
+key, fifa, name
+af,  AFG,  Afghanistan
+al,  ALB,  Albania
+dz,  ALG,  Algeria
+as,  ASA,  American Samoa (US)
+TXT
+
+   pp recs
+   assert_equal  [{ key:'af', fifa:'AFG', name:'Afghanistan'},
+                  { key:'al', fifa:'ALB', name:'Albania'},
+                  { key:'dz', fifa:'ALG', name:'Algeria'},
+                  { key:'as', fifa:'ASA', name:'American Samoa (US)'},
+                 ], recs[0..3]
+  end
+
+end   # class TestCsvReader

data/test/test_outline_reader.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_outline_reader.rb
+
+
+require 'helper'
+
+class TestOutlineReader < MiniTest::Test
+
+  def test_parse
+    outline = SportDb::OutlineReader.parse( <<TXT )
+=============================
+= ÖFB Cup 2011/12
+=============================
+
+FC Red Bull Salzburg      ## Bundesliga
+FK Austria Wien
+TXT
+
+    pp outline
+
+    assert_equal 3, outline.size
+
+    assert_equal [:h1, 'ÖFB Cup 2011/12'],       outline[0]
+    assert_equal [:l,  'FC Red Bull Salzburg'],  outline[1]
+    assert_equal [:l,  'FK Austria Wien'],       outline[2]
+  end
+
+end # class TestOutlineReader

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sportdb-formats
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: alphabets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: csvreader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: sportdb-formats - sport.db format and text utilities
+email: opensport@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/sportdb/formats.rb
+- lib/sportdb/formats/outline_reader.rb
+- lib/sportdb/formats/version.rb
+- test/helper.rb
+- test/test_csv_reader.rb
+- test/test_outline_reader.rb
+homepage: https://github.com/sportdb/sport.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: sportdb-formats - sport.db format and text utilities
+test_files: []