music_ids 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99fedf4553606e27aeca66af5e88e8cb2a025b37
-  data.tar.gz: e9036104e3dc813a9381cceefcec0ffea8611246
+  metadata.gz: d075e77c1c9c168a277ebbe0f9c4cd56742f86eb
+  data.tar.gz: 9798bab45ac443c338230e84bad99fc3b3d4b102
 SHA512:
-  metadata.gz: 1934b523cab56481e0be5d72a930be3617725ff7eb8291ba27e9b4836362eb7c404defc3399870b0bd02096aa8d9b43afbcd950fe2be11597018fd05000482d8
-  data.tar.gz: e39e0d7a3ac778418ef2b70a1811784b94265d16a575903e54c39bb2184bd720c225f1f3d497aae722d6717c6b90469e37cf24e306d18bebd4f507b31a1cf1a4
+  metadata.gz: f46dcd3fb1756625c484f3b3eba6b525137a13a085f11fc2750745824c49ada705ca945e3bad4042b95c0a1de19c8bea17fa9319546566bd6d0d23245ada1359
+  data.tar.gz: 60c280f55d3515da25fe9eb878ff73040c65aaab86d70a716f8512b8aefc64e48c499477ce6fbb89a5405f8a69e79388afeadf2f608647624344ddfc66270277

data/README.md

@@ -6,7 +6,7 @@
 
 There are often several ways that these IDs can be written, so the classes provide standard APIs to parse and normalise ID strings, as well as to break them into their components.
 
-Currently we offer a class for the ISRC (International Standard Recording Code).
+Currently we have classes for the ISRC (International Standard Recording Code) and GRid (Global Release Identifier).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -24,15 +24,23 @@ Or install it yourself as:
     $ gem install music_ids
 
 ## Usage
-(See API docs at <http://www.rubydoc.info/gems/music_ids> for more details including links to the relevant ID specifications.)
+(See API docs at <http://www.rubydoc.info/gems/music_ids> for more details
+including links to the relevant ID specifications.)
+
+`MusicIds::GRid` and `MusicIds::ISRC` have the same basic API pattern: a
+`parse` class method, `to_s` returns normalised string version of the ID and
+`as(format)` returns different string representations of the Id.
+
+Instances compare equal if their normalised string representations match.
+Parsing an existing instance just returns another instance of the same ID.
 
 ```ruby
 require 'music_ids'
 
 isrc = MusicIds::ISRC.parse('FRZ039800212')
-isrc.country #=> 'FR'
-isrc.registrant #=> 'Z03'
-isrc.year #=> '98'
+isrc.country     #=> 'FR'
+isrc.registrant  #=> 'Z03'
+isrc.year        #=> '98'
 isrc.designation #=> '00212'
 
 other = ISRC.parse('FR-Z03-98-00212')
@@ -42,12 +50,38 @@ isrc == other #=> true
 
 isrc.to_s #=> 'FRZ039800212'
 isrc.as(:full) #=> 'FR-Z03-98-00212'
+
+MusicIds::ISRC.parse(isrc) == isrc #=> true
+
+grid_with_hyphens = MusicIds::GRid.parse('A1-2425G-ABC1234002-M')
+grid =              MusicIds::GRid.parse('A12425GABC1234002M')
+# You do see this form with GRids
+grid_with_prefix =  MusicIds::GRid.parse('GRID:A1-2425G-ABC1234002-M')
+
+grid.scheme  #=> 'A1'
+grid.issuer  #=> '2425G'
+grid.release #=> 'ABC1234002'
+grid.check   #=> 'M'
+
+grid_with_hyphens == grid #=> true
+grid_with_prefix == grid #=> true
+
+grid.to_s #=> 'A12425GABC1234002M'
+grid.as(:full) #=> 'A1-2425G-ABC1234002-M'
+grid.as(:prefixed) #=> 'GRID:A1-2425G-ABC1234002-M'
+
+MusicIds::GRid.parse(grid) == grid #=> true
 ```
 
 ## Development
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git
+commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 1. Fork it ( https://github.com/[my-github-username]/music_ids/fork )

data/lib/music_ids/version.rb

@@ -1,3 +1,3 @@
 module MusicIds
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: music_ids
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Matt Patterson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler