score-formats 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ce70736d26500e8d3866ae96a2f75e6ce8c1725
-  data.tar.gz: 16e29461a44bb4c232039b82f38d805596b47acf
+  metadata.gz: fde9c3127903e7a2bcd4d631a1a286ef1b3faf5a
+  data.tar.gz: ec30d9beb6fd14b726dbe80f549b6371e8411426
 SHA512:
-  metadata.gz: 28ed77625082a2f1b29713b03cf92354df0799c8b0189f5e40e4ccddbad34cb6e14b286b580adee97304cb3b84e8c14064dd26c33efcfea80e94e4caa7354d6e
-  data.tar.gz: bf023b724232b5ca987615d223c8d8aef928a3afcf7b9807e1f1b9167fbabfc2a80d78404220cb5de6633585be885ea5e9f05c0770d28da59a1cb89d827b63b7
+  metadata.gz: e3de1af6dd9d46f17861c31ed8a415a546f904d47a3aae525fb6ef15f169303d9edf574fe154340ee1e9cf1dfe58650e38a95e274dddc0e0ce272315a9353bde
+  data.tar.gz: 5b760ecbaf5b5163a620a729353142af71446641535254fe0a8dd7bc4491dc4b0c7970b9a0103bb97c6a06e699f2b565623a614e5e1c68d13b905543869559a8

data/Manifest.txt

@@ -5,9 +5,11 @@ Rakefile
 lib/score-formats.rb
 lib/score-formats/formats.rb
 lib/score-formats/parser.rb
+lib/score-formats/printer.rb
 lib/score-formats/score.rb
 lib/score-formats/version.rb
 lib/score/formats.rb
 test/helper.rb
 test/test_formats.rb
+test/test_printer.rb
 test/test_score.rb

data/README.md

@@ -8,11 +8,162 @@
 * forum :: [opensport](http://groups.google.com/group/opensport)
 
 
+
 ## Usage
 
 
-to be done
+The idea is to follow the `Date` class and make `Score`
+into a top-level free-standing class. Let's say you have the match score:
+
+6-5 pen. 2-2 a.e.t. 1-1 (1-0)
+
+Using
+
+``` ruby
+require "score/formats"
+
+score = Score.parse( "6-5 pen. 2-2 a.e.t. 1-1 (1-0)" )
+score.ht  #=> [1,0]
+score.ft  #=> [1,1]
+score.et  #=> [2,2]
+score.p   #=> [6,5]
+```
+
+you can parse the score into its components, that is, the
+half time (ht), full time (ft), extra time (et)
+and the penalties (p) shootout score.
+
+Like `Date` you can initialize `Score` with "to-the-metal"
+integer numbers e.g.:
+
+``` ruby
+score = Score.new( 1, 0, 1, 1, 2, 2, 6, 5 )
+score.ht  #=> [1,0]
+score.ft  #=> [1,1]
+score.et  #=> [2,2]
+score.p   #=> [6,5]
+```
+
+For now `Score` offers in addition to the read-only `ht`, `ft`, `et`, `p`  accessors some more methods:
+
+
+Use `ht?`, `ft?`, `et?`, `p?` for checking if the score components are present e.g.
+
+``` ruby
+score = Score.new
+score.ht?  #=> false
+score.ft?  #=> false
+score.et?  #=> false
+score.p?   #=> false
+
+# -or-
+
+score = Score.parse( "8-2 (4-1)" )
+score.ht?  #=> true
+score.ft?  #=> true
+score.et?  #=> false
+score.p?   #=> false
+```
+
+Use `to_a` to get an array of score component pairs (or an empty array for none) e.g.
+
+``` ruby
+score = Score.parse( "8-2 (4-1)" )
+score.to_a  #=> [[4,1], [8-2]]
+
+# -or-
+score = Score.parse( "0-0" )
+score.to_a  #=> [0,0]
+```
+
+Use `values` to get an array of "flat" integer numbers e.g.
+
+``` ruby
+score = Score.parse( "6-5 pen. 2-2 a.e.t. 1-1 (1-0)" )
+score.values #=> [1,0,1,1,2,2,6,5]
+```
+
+Use `to_h` to get a hash with key / value pairs e.g.
+
+``` ruby
+score = Score.parse( "6-5 pen. 2-2 a.e.t. 1-1 (1-0)" )
+score.to_h #=> { ht: [1,0],
+           #     ft: [1,1],
+           #     et: [2,2],
+           #     p:  [6,5] }
+
+# -or -
+score = Score.parse( "8-2 (4-1)" )
+score.to_h #=> { ht: [4,1],
+           #     ft: [8,2] }
+```
+
+Use the `:db` format to get a hash with "flat" key / value pairs e.g.
+
+``` ruby
+score = Score.parse( "6-5 pen. 2-2 a.e.t. 1-1 (1-0)" )
+score.to_h( :db ) #=> { score1i:  1, score2i:  0,
+                  #     score1:   1, score2:   1,
+                  #     score1et: 2, score2et: 2,
+                  #     score1p:  6, score2p:  5 }
+
+# -or -
+score = Score.parse( "8-2 (4-1)" )
+score.to_h( :db ) #=> { score1i:  4,   score2i:  1,
+                  #     score1:   8,   score2:   2,
+                  #     score1et: nil, score2et: nil,
+                  #     score1p:  nil, score2p:  nil}
+```
+
+Use `to_s` to pretty print / get the score (as string) e.g.
+
+``` ruby
+score = Score.new( 1, 0, 1, 1, 2, 2, 6, 5 )
+score.to_s #=> "6-5 pen. 2-2 a.e.t. 1-1 (1-0)"
+
+# -or -
+
+score = Score.new( 0, 0, 0, 0 )
+score.to_s #=> "0-0"
+
+# -or -
+
+score = Score.new
+score.to_s #=> "-"
+```
+
+
+
+## Bonus: Multi-language internationalization (i18n) support
+
+_Sprichst du Deutsch? • ¿Hablas español? • Parles tu français?_
+
+Using the `lang` option you can switch the language.
+For now only `de`, that is, German (Deutsch) is built-in / supported.
+Example:
+
+``` ruby
+score = Score.parse( "2:2 (1:1, 1:0) n.V. 6:5 i.E.", lang: "de" )
+score.ht  #=> [1,0]
+score.ft  #=> [1,1]
+score.et  #=> [2,2]
+score.p   #=> [6,5]
+```
+
+That's all for now.
+
+
+
+
+## Installation
+
+Use
+
+    gem install score-formats
+
+or add the gem to your Gemfile
 
+    gem 'score-formats'
 
 
 

data/lib/score-formats.rb

@@ -23,6 +23,7 @@ end # module ScoreFormats
 require 'score-formats/score'
 require 'score-formats/formats'
 require 'score-formats/parser'
+require 'score-formats/printer'
 
 
 
@@ -40,7 +41,7 @@ module ScoreFormats
 
     ## note: cache all "built-in" lang versions (e.g. formats == nil)
     @@parser ||= {}
-    parser = @@parser[ lang ] ||= ScoreParser.new( lang: lang )
+    @@parser[ lang ] ||= ScoreParser.new( lang: lang )
   end
 
   def self.parse( line, lang: ScoreFormats.lang )

data/lib/score-formats/parser.rb

@@ -80,7 +80,7 @@ private
 
     ## puts "[parse_date_time] match_data:"
     ## pp h
-    logger.debug "   [parse_matchdata] hash: >#{h.inspect}<"
+    ## logger.debug "   [parse_matchdata] hash: >#{h.inspect}<"
 
     score1i   = nil    # half time (ht) scores
     score2i   = nil

data/lib/score-formats/printer.rb

@@ -0,0 +1,89 @@
+class Score
+
+  def to_formatted_s( format=:default, lang: ScoreFormats.lang )
+    ## note: format gets ignored for now (only one available)
+    case lang.to_sym
+    when :de   then   format_de( format )
+    else              format_en( format ) # note: for now always fallback to english
+    end
+  end
+  alias_method :to_s, :to_formatted_s
+
+
+
+  def format_en( format=:default )
+    ## note: format gets ignored for now (only one available)
+
+    buf = String.new('')
+    ## note: also allow (minimal) scores only with a.e.t. (and no full time)
+    if ft? || et?
+      if p?
+        buf << "#{@score1p}-#{@score2p} pen."
+      end
+      if et?
+        buf << " #{@score1et}-#{@score2et} a.e.t."
+      end
+      if ft?
+         if buf.empty?
+           buf << " #{@score1}-#{@score2}"
+           ## note:
+           ##   avoid 0-0 (0-0)
+           ##  only print if score1 & score2 NOT 0-0
+           if ht? && ft != [0,0]
+             buf << " (#{@score1i}-#{@score2i})"
+           end
+         else  ## assume pen. and/or a.e.t.
+           buf << " (#{@score1}-#{@score2}"
+           if ht? && ft != [0,0]
+             buf << ", #{@score1i}-#{@score2i}"
+           end
+           buf << ")"
+         end
+      end
+    else # assume empty / unknown score
+       buf << '-'
+    end
+    buf.strip
+  end
+
+
+  def format_de( format=:default )
+    ## note: format gets ignored for now (only one available)
+
+    buf = String.new('')
+    ## note: also allow (minimal) scores only with a.e.t. (and no full time)
+    if ft? || et?        # 2-2 (1-1) n.V. 5-1 i.E.
+      if et?
+        buf << "#{@score1et}:#{@score2et}"
+      end
+      if ft?
+        if buf.empty?
+          buf << " #{@score1}:#{@score2}"
+          ## note:
+          ##   avoid 0-0 (0-0)
+          ##  only print if score1 & score2 NOT 0-0
+          if ht? && ft != [0,0]
+            buf << " (#{@score1i}:#{@score2i})"
+          end
+        else  ## assume pen. and/or a.e.t.
+          buf << " (#{@score1}:#{@score2}"
+          if ht? && ft != [0,0]
+            buf << ", #{@score1i}:#{@score2i}"
+          end
+          buf << ")"
+        end
+      end
+      if et?
+        buf << " n.V."
+      end
+      if p?
+        buf << " #{@score1p}:#{@score2p} i.E."
+      end
+    else # assume empty / unknown score
+      buf << '-'
+    end
+    buf.strip
+  end
+
+
+end # class Score

data/lib/score-formats/score.rb

@@ -15,7 +15,7 @@ class Score
    ## e.g. allow/support
    ##      1-1 or 1 - 1      - "english" style
    ##      1:1               - "german / deutsch" style
-   ##      1x1 1X1           - "brazil/portugese" style
+   ##      1x1 1X1           - "brazil - português / portuguese" style
 
    ## note: add unicode "fancy" dash too (e.g. –)
    ## add some more - why? why not?
@@ -23,16 +23,15 @@ class Score
    if m=SCORE_SPLIT_RE.match(str)
      [m[1].to_i, m[2].to_i]
    else
-     # no match - warn if str is not empty? why? why not?
-     ##
-     ## todo/fix:
-     ## do NOT warn on
-     ##    assert_equal [], Score.split( '-' )
-     ##    assert_equal [], Score.split( '-:-' )
-     ##    assert_equal [], Score.split( '?' )
-     ## for now - add more?
-
-     puts "!! WARN - cannot match (split) score format >#{str}<"  unless str.empty?
+     # no match - warn if str is NOT empty? why? why not?
+
+     if str.empty? || ['-', '-:-', '?'].include?( str )
+       ## do NOT warn for known "good" empty scores for now - why? why not?
+       ##   add some more?? use Score.empty? or such - why? why not?
+     else
+       puts "!! WARN - cannot match (split) score format >#{str}<"
+     end
+
      []
    end
  end
@@ -123,7 +122,6 @@ class Score
       exit 1
     end
  end
- alias_method :to_hash, :to_h  ## add alias - why? why not?
 
 
  def values

data/lib/score-formats/version.rb

@@ -1,8 +1,8 @@
 
 module ScoreFormats
   MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-  MINOR = 0
-  PATCH = 1
+  MINOR = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_printer.rb

@@ -0,0 +1,51 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_printer.rb
+
+
+require 'helper'
+
+class TestPrinter < MiniTest::Test
+
+  def test_en
+     [['0-0',                   [nil,nil, 0, 0]],
+      ['0-0',                   [0, 0, 0, 0]],
+      ['1-0',                   [nil,nil, 1, 0]],
+      ['3-2 (1-0)',             [1, 0, 3, 2]],
+      ['2-0 (0-0)',             [0, 0, 2, 0]],
+      ['5-4 a.e.t.',            [nil,nil,nil,nil, 5, 4]],
+      ['5-4 a.e.t. (3-2, 1-0)', [1, 0, 3, 2, 5, 4]],
+      ['5-4 a.e.t. (3-2)',      [nil,nil, 3, 2, 5, 4]],
+      ['6-3 pen. (3-2, 1-0)',   [1, 0, 3, 2, nil, nil, 6, 3]],
+      ['6-3 pen. (3-2)',        [nil,nil, 3, 2, nil, nil, 6, 3]],
+      ['6-3 pen. 5-4 a.e.t. (3-2, 1-0)',  [1, 0, 3, 2, 5, 4, 6, 3]],
+     ].each do |rec|
+       exp    = rec[0]
+       values = rec[1]
+
+       assert_equal exp, Score.new( *values ).to_s( lang: 'en' )
+     end
+  end
+
+  def test_de
+    [['0:0',                   [nil,nil, 0, 0]],
+     ['0:0',                   [0, 0, 0, 0]],
+     ['1:0',                   [nil,nil, 1, 0]],
+     ['3:2 (1:0)',             [1, 0, 3, 2]],
+     ['2:0 (0:0)',             [0, 0, 2, 0]],
+     ['5:4 n.V.',              [nil,nil,nil,nil, 5, 4]],
+     ['5:4 (3:2, 1:0) n.V.',   [1, 0, 3, 2, 5, 4]],
+     ['5:4 (3:2) n.V.',        [nil,nil, 3, 2, 5, 4]],
+     ['3:2 (1:0) 6:3 i.E.',    [1, 0, 3, 2, nil, nil, 6, 3]],
+     ['3:2 6:3 i.E.',          [nil,nil, 3, 2, nil, nil, 6, 3]],
+     ['5:4 (3:2, 1:0) n.V. 6:3 i.E.',  [1, 0, 3, 2, 5, 4, 6, 3]],
+    ].each do |rec|
+      exp    = rec[0]
+      values = rec[1]
+
+      assert_equal exp, Score.new( *values ).to_s( lang: 'de' )
+    end
+  end
+
+end  # class TestPrinter
+

data/test/test_score.rb

@@ -71,6 +71,6 @@ class TestScore < MiniTest::Test
                        score1:   2,   score2:  3,
                        score1et: nil, score2et: nil,
                        score1p:  nil, score2p:  nil ), score.to_h( :db )
- end
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: score-formats
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-17 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -55,11 +55,13 @@ files:
 - lib/score-formats.rb
 - lib/score-formats/formats.rb
 - lib/score-formats/parser.rb
+- lib/score-formats/printer.rb
 - lib/score-formats/score.rb
 - lib/score-formats/version.rb
 - lib/score/formats.rb
 - test/helper.rb
 - test/test_formats.rb
+- test/test_printer.rb
 - test/test_score.rb
 homepage: https://github.com/sportdb/sport.db
 licenses: