music_ids 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d75caff64b4e4891c3f7ec2f74cd69565326ad32
+  data.tar.gz: ce0f8a0238c334c6f9fae24e73d2a4e56c0047d9
+SHA512:
+  metadata.gz: 8c011793f6cc32c44a74add1a360e30c6b1c44791c145500ac1ac75b154a7d0dfed11e852d118035f55a564d6813ee9ad9c22a071da9c7bcf41998d03fa27f30
+  data.tar.gz: 5ba4a46d7e81136e56299c0f6e1247735f133108527587305d55c8f492dbbb39e09e443a197e1e819001f775bba22500cef8ddadded324ca30c2bb8228cba4fd

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in music_ids.gemspec
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 tape.tv AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# MusicIds
+
+`music_ids` contains classes that represent some of the main ID formats in use in the music industry for identifying individual pieces of recorded music.
+
+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).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'music_ids'
+```
+
+And then execute:
+
+    $ bundle
+
+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.)
+
+```ruby
+require 'music_ids'
+
+isrc = MusicIds::ISRC.parse('FRZ039800212')
+isrc.country #=> 'FR'
+isrc.registrant #=> 'Z03'
+isrc.year #=> '98'
+isrc.designation #=> '00212'
+
+other = ISRC.parse('FR-Z03-98-00212')
+other.registrant #=> 'Z03'
+
+isrc == other #=> true
+
+isrc.to_s #=> 'FRZ039800212'
+isrc.as(:full) #=> 'FR-Z03-98-00212'
+```
+
+## 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).
+
+## Contributing
+1. Fork it ( https://github.com/[my-github-username]/music_ids/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "music_ids"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/music_ids/isrc.rb

@@ -0,0 +1,156 @@
+module MusicIds
+  # The ISRC class represents an International Standard Recording Code, and
+  # provides simple methods to parse and re-present them.
+  #
+  # == What is an ISRC?
+  # An ISRC is a globally unique ID for an audio / video recording of a piece
+  # of music. (That is, two different recordings of the same song should have
+  # different ISRCs)
+  #
+  # ISRCs consist of four blocks of information: a two-letter country code,
+  # three-character registrant code, two-digit year (see #year), and five-digit
+  # designation code. There are two main string representations: the canonical
+  # 12-character version, and a 15-character version that inserts hyphens (-)
+  # between the blocks.
+  #
+  # The first two blocks identify, essentially, a record company / distributor
+  # and their country of origin, the last two blocks provide a unique recording
+  # number for that company in a particular year.
+  #
+  # You can get more details from
+  # https://en.wikipedia.org/wiki/International_Standard_Recording_Code and
+  # http://www.usisrc.org/
+  #
+  # == Well-formedness and validity
+  # ISRC's are supposed to be able to be looked
+  # up in a global database, so we need to draw a distinction between *valid*
+  # ISRC's, which are ISRC's we have looked up in that database and verified,
+  # and well-formed ISRC's, which is to say strings matching the requirements
+  # above.
+  #
+  # Checking or enforcing validity is beyond the scope of this class.
+  # Well-formedness, on the other hand, is easy to check and enforce.
+  #
+  # While you don't want to be emitting badly-formed ISRCs, if you handle
+  # ISRC's from elsewhere you may well run across bad metadata that you need to
+  # preserve, but probably want to be aware of the fact that it's bad.
+  #
+  # To help with that there are two parsing modes, strict (the default), and
+  # relaxed.
+  #
+  # In strict parsing mode, <tt>ISRC.parse</tt> will raise an error if passed a
+  # badly-formed ISRC string. In relaxed mode, it will return an <tt>ISRC</tt>
+  # instance that will return <tt>false</tt> from <tt>#ok?</tt> and will return
+  # nil from all the component methods like <tt>#registrant</tt>
+  class ISRC
+    # See http://www.ifpi.org/content/library/isrc_handbook.pdf §3.5
+    WELL_FORMED_INPUT = /\A[A-Z]{2}-?[A-Z0-9]{3}-?[0-9]{2}-?[0-9]{5}\Z/
+
+    class << self
+      # Parse an ISRC string into an ISRC instance
+      #
+      # @param input [String] The input ISRC string to parse
+      # @param opts [Hash] Parsing options
+      # @option opts [true, false] :relaxed (false) Whether to parse in relaxed mode
+      # @return [ISRC] the ISRC instance
+      def parse(input, opts = {})
+        input = input.to_s.upcase
+        opts[:relaxed] ? parse_relaxed(input) : parse_strict(input)
+      end
+
+      private
+
+      def parse_strict(input)
+        if WELL_FORMED_INPUT.match(input)
+          new(input.gsub('-', ''))
+        else
+          raise ArgumentError, "'#{input}' is not the right length to be a 12- or 15-character ISRC"
+        end
+      end
+
+      def parse_relaxed(input)
+        if WELL_FORMED_INPUT.match(input)
+          new(input.gsub('-', ''))
+        else
+          new(input, ok: false)
+        end
+      end
+    end
+
+    # @api private
+    # @param isrc_string [String] The ISRC string
+    # @param opts [Hash]
+    # @option opts [true, false] :ok (true) Whether the ISRC is well-formed or not
+    def initialize(isrc_string, opts = {ok: true})
+      @isrc_string = isrc_string.dup.freeze
+      @ok = opts[:ok] ? true : false
+    end
+
+    # Is this a well-formed ISRC?
+    # @return [true,false]
+    def ok?
+      @ok
+    end
+
+    # Return the ISRC's two-letter country code
+    # @return [String]
+    def country
+      return unless ok?
+      @country ||= @isrc_string[0,2].freeze
+    end
+
+    # Return the ISRC's three-character registrant code
+    # @return [String]
+    def registrant
+      return unless ok?
+      @registrant ||= @isrc_string[2,3].freeze
+    end
+
+    # Return the ISRC's two-digit year.
+    #
+    # Note that year > 40 is a 19YY year, and 00 to 39 are 20YY years
+    # see http://www.ifpi.org/content/library/isrc_handbook.pdf section 4.8
+    # @return [String]
+    def year
+      return unless ok?
+      @year ||= @isrc_string[5,2].freeze
+    end
+
+    # Return the ISRC's five-character designation code.
+    #
+    # @return [String]
+    def designation
+      return unless ok?
+      @designation ||= @isrc_string[7,5].freeze
+    end
+
+    # return the ISRC as a normalised 12-character string
+    # @reuturn [String]
+    def to_s
+      @isrc_string.dup
+    end
+
+    def to_isrc
+      self
+    end
+
+    def ==(other)
+      to_s == other.to_s
+    end
+
+    # Returns the ISRC as a string, either the 12-character normalised string
+    # (:data) or the 15-character display string (:full). Note that a badly-formed ISRC will simply return the original string whichever format you ask for
+    # @param format [:data, :full] the output format to use
+    # @return [String]
+    def as(format)
+      case format
+      when :data
+        to_s
+      when :full
+        ok? ? "#{country}-#{registrant}-#{year}-#{designation}" : to_s
+      else
+        raise ArgumentError, "format must be one of [:data, :full], but it was #{format.inspect}"
+      end
+    end
+  end
+end

data/lib/music_ids/version.rb

@@ -0,0 +1,3 @@
+module MusicIds
+  VERSION = "0.1.0"
+end

data/lib/music_ids.rb

@@ -0,0 +1,5 @@
+require "music_ids/version"
+
+module MusicIds
+  # Your code goes here...
+end

data/music_ids.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'music_ids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "music_ids"
+  spec.version       = MusicIds::VERSION
+  spec.authors       = ["Matt Patterson"]
+  spec.email         = ["matt@reprocessed.org"]
+
+  spec.summary       = %q{A library to handle parsing, normalisation, and output of music industry ID formats like ISRC and GRid}
+  spec.description   = %q{music_ids contains classes that represent some of the main ID formats in use in the music industry for identifying individual pieces of recorded music.
+
+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.}
+  spec.homepage      = "https://github.com/tape-tv/music_ids"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: music_ids
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Patterson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  music_ids contains classes that represent some of the main ID formats in use in the music industry for identifying individual pieces of recorded music.
+
+  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.
+email:
+- matt@reprocessed.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/music_ids.rb
+- lib/music_ids/isrc.rb
+- lib/music_ids/version.rb
+- music_ids.gemspec
+homepage: https://github.com/tape-tv/music_ids
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A library to handle parsing, normalisation, and output of music industry
+  ID formats like ISRC and GRid
+test_files: []
+has_rdoc: