pigeon_band 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9bb12b73441bd04685095520d4beb619b64b821
-  data.tar.gz: db6173092cf90a4a29deb5ca97dc3bc602744114
+  metadata.gz: c068f38af42b53131bb136a6ad108e06de31f2d2
+  data.tar.gz: cb14f929059911297cd641889c7ee823fea2515a
 SHA512:
-  metadata.gz: 855afe5fddec55de982a639dcef2fede78965998f28a14db6e0e737db3296a4d72fe668a0c64d2335d4760926bf4f5108f049b4f648cb5da32752c259da23bbc
-  data.tar.gz: cd104cd192bc447279a57ff88d7ceb2e1e164b943a15d1d9ed07b6771bb6c9f7e85622359f618a448fac73140f1c1db51cb7bc4b221b3c1a4854c8e327c2789f
+  metadata.gz: 9e6d54d61de19af266e2a451ca497ff4d9dc173e741afa96165beaf29993f4bc71b12659b60a9f58298237952550f9fc32048c0d1eaa935bf746be97e5a7a84c
+  data.tar.gz: d40911654fd7f86e5ba15d390e0bfac2d44820be38152c8dd6050ddff0bf45ae402bc5f5d8caa0c78b8264e34ab1c7b4463c38749e6974bd644e0a6c1e48eb39

data/Makefile

@@ -22,4 +22,5 @@ install: build
 build:
 	git add lib
 	git add test
+	rake test
 

data/README.md

@@ -30,12 +30,23 @@ 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 four fields. Thus, giben the
+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:
 
+* band
+    * The normalized band as it should be displayed
+* coll
+    * The band formatted for easy collation (filled e.g. with leading spaces)
+* year
+    * The (four-digit) year as extracted from the band
+* code
+    * The (ISO3166-1) country code as extracted from the band
+* error
+    * The error message if the band is invalid, otherwise nil
+
 ```ruby
 PigeonBand.format("DV-06914-12-479")
-  { band: "DV-06914-12-479" coll: "DV-06914-12-0479" year: 2012 code: "DE" }
+  { band: "DV-06914-12-479" coll: "DV-06914-12-0479" year: 2012 code: "DE"  error: nil }
 ```
 ## Development
 

data/lib/pigeon_band/version.rb

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

metadata

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