pigeon_band 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c068f38af42b53131bb136a6ad108e06de31f2d2
-  data.tar.gz: cb14f929059911297cd641889c7ee823fea2515a
+  metadata.gz: b4f596ce451ea151bfec0ba842528aea903ccadd
+  data.tar.gz: ce1bba537837b579f5cef50119921775cb7565a9
 SHA512:
-  metadata.gz: 9e6d54d61de19af266e2a451ca497ff4d9dc173e741afa96165beaf29993f4bc71b12659b60a9f58298237952550f9fc32048c0d1eaa935bf746be97e5a7a84c
-  data.tar.gz: d40911654fd7f86e5ba15d390e0bfac2d44820be38152c8dd6050ddff0bf45ae402bc5f5d8caa0c78b8264e34ab1c7b4463c38749e6974bd644e0a6c1e48eb39
+  metadata.gz: 6fd01f51b0ced92e93d55681a87189be06fff73fdf7be902284f603bd25eaa448cbcc6c0cb9949f6b27c9bf54918534ba4f779af080edc4fe0dd8f57c2f19ca8
+  data.tar.gz: d8ebbc5e12d7cc5df095f98b20a103931d8562c01d262f38ed174aa46b2b1a0b3e38637ce804c31659ad2e158a9d1f8a0f7d588a8c23007d0967f8529ac532d1

data/Makefile

@@ -19,8 +19,13 @@ install: build
 	rake install
 	rm -rf pkg
 
+update: build
+	gem uninstall pigeon_band --all
+	rake install
+
 build:
 	git add lib
 	git add test
 	rake test
+	vim README.md
 

data/README.md

@@ -30,8 +30,7 @@ Or install it yourself as:
 ## Usage
 
 After loading the pigeon_band gem, there is a new object PigeonBand with one method #format.
-Given a band as a string, it returns a hash consisting of five fields. Thus, given the
-above bands a input, a call to PigeonBand#format would return the following hashes:
+Given a band as a string, it returns a hash consisting of five fields.
 
 * band
     * The normalized band as it should be displayed
@@ -44,10 +43,47 @@ above bands a input, a call to PigeonBand#format would return the following hash
 * error
     * The error message if the band is invalid, otherwise nil
 
+Given the above bands a input, a call to PigeonBand#format would return the following hashes:
+
 ```ruby
 PigeonBand.format("DV-06914-12-479")
-  { band: "DV-06914-12-479" coll: "DV-06914-12-0479" year: 2012 code: "DE"  error: nil }
+  { band: "DV-06914-12-479", coll: "DV-06914-12-0479", year: 2012, code: "DE", error: nil }
+
+PigeonBand.format("DV-099-09-850")
+  { band: "DV-099-09-850", coll: "DV-00099-09-0850", year: 2009, code: "DE", error: nil }
 ```
+
+## Error messages
+
+The following error messages are sent when the corresponding error is detected:
+
+* input_missing
+    * The input is blank or consists entirely of white space.
+
+* country_unknown
+    * The given country was not recognized.
+    * You can help improving this gem by contributing it :-)
+    * See below for details.
+
+* year_range
+    * The given year is outside the valid range of 00 to 99
+
+* club_below
+    * The given club (for countries with club numbers) is too low
+
+* club_above
+    * The given club (for countries with club numbers) is too high
+
+* sequ_below
+    * The given running number is too low
+
+* sequ_above
+    * The given running number is too high
+
+## Complete Rails example
+
+TODO: show model, controller, view, route and locale data
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pigeon_band/version.rb

@@ -1,5 +1,5 @@
 module PigeonBand
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
   COUNTRY = "DV"
   HOMEPAGE = "https://github.com/volkerwiegand/pigeon_band"
 end

data/lib/pigeon_band.rb

@@ -2,62 +2,60 @@ require "pigeon_band/version"
 
 module PigeonBand
   def self.format(band, country = COUNTRY)
-    return { error: "missing input for pigeon band" } if band.nil? or band.match(/\A[[:space:]]*\z/)
-    band_msg = "in pigeon band '#{band}'"
+    return { error: "input_missing" } if band.nil? or band.match(/\A[[:space:]]*\z/)
     band.upcase!
     band.tr!('. /', '---')
     band = country + '-' + band unless band.match(/^[A-Z]/)
     list = band.split('-')
     case list[0]
       when 'B'
-        year = get_year(band, list[1], band_msg)
+        year = get_year(band, list[1])
         return year if year.is_a?(Hash)
-        sequ = get_number(band, list[2], "counter", 1, 9999999, band_msg)
+        sequ = get_number(band, list[2], "sequ", 1000001, 9999999)
         return sequ if sequ.is_a?(Hash)
         band = sprintf("B-%02d-%07d", year % 100, sequ)
         coll = band
         code = 'BE'
       when 'DV'
-        club = get_number(band, list[1], "club", 1, 9999, band_msg)
+        club = get_number(band, list[1], "club", 1, 9999)
         return club if club.is_a?(Hash)
-        year = get_year(band, list[2], band_msg)
+        year = get_year(band, list[2])
         return year if year.is_a?(Hash)
-        sequ = get_number(band, list[3], "counter", 1, 9999, band_msg)
+        sequ = get_number(band, list[3], "sequ", 1, 9999)
         return sequ if sequ.is_a?(Hash)
         band = sprintf("DV-0%d-%02d-%d", club, year % 100, sequ)
         coll = sprintf("DV-%05d-%02d-%04d", club, year % 100, sequ)
         code = 'DE'
       when 'NL'
-        year = get_year(band, list[1], band_msg)
+        year = get_year(band, list[1])
         return year if year.is_a?(Hash)
-        sequ = get_number(band, list[2], "counter", 1, 9999999, band_msg)
+        sequ = get_number(band, list[2], "sequ", 1000001, 9999999)
         return sequ if sequ.is_a?(Hash)
         band = sprintf("NL-%02d-%07d", year % 100, sequ)
         coll = band
         code = 'NL'
       else
-        url = PigeonBand::HOMEPAGE
-        return { error: "unknown country '#{list[0]}'. Please add more countries at #{url}" }
+        return { error: "country_unknown" }
     end
-    { band: band, coll: coll, year: year, code: code, error: nil}
+    { band: band, coll: coll, year: year, code: code, error: nil }
   end
 
 private
 
-  def self.get_number(band, num, num_type, min_num, max_num, band_msg)
-    return { error: "missing #{num_type} #{band_msg}" } if num.nil? or num.empty?
-    return { error: "invalid #{num_type} '#{num}' #{band_msg}" } unless num.match(/^\d/)
+  def self.get_number(band, num, num_type, min_num, max_num)
+    return { error: "#{num_type}_missing" } if num.nil? or num.empty?
+    return { error: "#{num_type}_invalid" } unless num.match(/^\d/)
     num = num.to_i
-    return { error: "#{num_type} '#{num}' too small #{band_msg}" } if num < min_num
-    return { error: "#{num_type} '#{num}' too big #{band_msg}"   } if num > max_num
+    return { error: "#{num_type}_below" } if num < min_num
+    return { error: "#{num_type}_above" } if num > max_num
     return num
   end
 
-  def self.get_year(band, year, band_msg)
-    return { error: "missing year #{band_msg}" } if year.nil? or year.empty?
-    return { error: "invalid year '#{year}' #{band_msg}" } unless year.match(/^\d/)
+  def self.get_year(band, year)
+    return { error: "year_missing" } if year.nil? or year.empty?
+    return { error: "year_invalid" } unless year.match(/^\d/)
     year = year.to_i
-    return { error: "year '#{year}' out of range #{band_msg}" } if year < 0 or year > 99
+    return { error: "year_range" } if year < 0 or year > 99
     year += 2000
     year -= 100 if year > (Time.now.to_date.year + 5)
     return year

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pigeon_band
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Volker Wiegand