grid-number 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07a08910f6014d347eeb2834b9b1324c4586adaa
+  data.tar.gz: 19bb9330c758f451eebfefc2ffd8446e1ce875c3
+SHA512:
+  metadata.gz: 29e04abcc90a31be8ff5400a9e6e935079014038331d21301171ce6ea34ab0e55aa751422624ffba8173d2bcab80e5d567ee748b3d6360e85376fd8b5b8ec423
+  data.tar.gz: fbe0826f85d37b448f46198b9a07158983bc339ce1e5257ed65c11fe375eac60d0b3d4b72427f0fbefffb2e359dedb491db0be671d6f2817551a9fc65145dd6e

data/.gitignore

@@ -0,0 +1,123 @@
+
+# Created by https://www.gitignore.io/api/ruby,emacs
+
+### Emacs ###
+# -*- mode: gitignore; -*-
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# Org-mode
+.org-id-locations
+*_archive
+
+# flymake-mode
+*_flymake.*
+
+# eshell files
+/eshell/history
+/eshell/lastdir
+
+# elpa packages
+/elpa/
+
+# reftex files
+*.rel
+
+# AUCTeX auto folder
+/auto/
+
+# cask packages
+.cask/
+dist/
+
+# Flycheck
+flycheck_*.el
+
+# server auth directory
+/server/
+
+# projectiles files
+.projectile
+projectile-bookmarks.eld
+
+# directory configuration
+.dir-locals.el
+
+# saveplace
+places
+
+# url cache
+url/cache/
+
+# cedet
+ede-projects.el
+
+# smex
+smex-items
+
+# company-statistics
+company-statistics-cache.el
+
+# anaconda-mode
+anaconda-mode/
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+# End of https://www.gitignore.io/api/ruby,emacs

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+before_install:
+  gem install bundler -v 1.14.6
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grid_number.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Skye Shaw
+
+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,71 @@
+# GRid
+
+[![Build Status](https://secure.travis-ci.org/ScreenStaring/grid-number.svg)](https://secure.travis-ci.org/ScreenStaring/grid-number)
+
+Class for managing Global Release Identifiers (GRid numbers).
+GRid numbers are used to identify electronic music releases.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "grid-number"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grid-number
+
+## Usage
+
+```rb
+require "grid"
+
+grid = GRid.parse("A12425GABC1234011K")
+grid = GRid.parse("A1-2425G-ABC1234011-K")
+grid = GRid.parse("  grid:A1-2425G-ABC1234011-K  ")
+grid.valid?          # true
+grid.id_scheme       # A1
+grid.issuer_code     # 2425G
+grid.release_number  # ABC1234011
+grid.check_character # K
+
+grid = GRid.new(:issuer_code => "2425G", :release_number => "ABC1234002")
+grid.check_character # M
+grid.release_number = "X999150000"
+grid.check_character # 3
+
+grid = GRid.parse("A12425GABC1234011X") # Wrong check character
+grid.valid?                   # false
+grid.errors[:check_character] # ["verification failed"]
+
+GRid.default_issuer_code = "2425G"
+grid = GRid.new(:release_number => "ABC1234002")
+grid.to_s           # A12425GABC1234002M
+grid.formatted      # A1-2425G-ABC1234002-M
+```
+
+## Links
+
+* [Global Release Identifier](https://en.wikipedia.org/wiki/Global_Release_Identifier)
+* [Documentation](http://rdoc.info/gems/grid-number)
+* [Homepage](https://github.com/ScreenStaring/grid-number)
+
+## See Also
+
+* [DDEX](https://github.com/sshaw) - DDEX metadata serialization
+* [istwox](https://github.com/malenkiki/istwox) - Classes for ISBN, ISSN, ISRC, ISMN and ISAN numbers
+* [iTunes Store Transporter: GUI](http://transportergui.com) - GUI and workflow automation for the iTunes Store’s Transporter (`iTMSTransporter`)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+---
+
+Made by [ScreenStaring](http://screenstaring.com)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/grid-number.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "grid"
+
+Gem::Specification.new do |spec|
+  spec.name          = "grid-number"
+  spec.version       = GRid::VERSION
+  spec.authors       = ["Skye Shaw"]
+  spec.email         = ["skye.shaw@gmail.com"]
+
+  spec.summary       = %q{Class to represent Global Release Identifiers (GRid numbers).}
+  spec.description   = <<-DESC
+    Class to represent Global Release Identifiers (GRid numbers).
+    GRid numbers are used to identify electronic music releases.
+  DESC
+
+  spec.homepage      = "https://github.com/ScreenStaring"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/grid-number.rb

@@ -0,0 +1 @@
+require "grid"

data/lib/grid.rb

@@ -0,0 +1,225 @@
+class GRid
+  VERSION = "0.0.1".freeze
+
+  DEFAULT_ID_SCHEME = "A1".freeze
+  CHECK_CODES  = (("0".."9").to_a + ("A".."Z").to_a).freeze
+
+  attr_reader :id_scheme, :issuer_code, :release_number, :errors, :check_character
+
+  class << self
+    #
+    # The issuer code to use when instansating an instance and none is provided.
+    #
+    def default_issuer_code
+      @default_issuer_code
+    end
+
+    def default_issuer_code=(code)
+      @default_issuer_code = code
+    end
+
+    #
+    # Create an instance from +str+.
+    #
+    #  grid = GRid.parse("A12425GABC1234002")
+    #  grid = GRid.parse("A1-2425G-ABC1234002-M")
+    #  grid = GRid.parse("grid:A1-2425G-ABC1234002-M")
+    #
+    # === Arguments
+    #
+    # [str (String)] The GRid to parse, does not have to be valid
+    #
+    # === Returns
+    #
+    # An instance of GRid representing +str+.
+    #
+    # === Errors
+    #
+    # No errors are raised. A GRid is always returned.
+    # To determine if it's valid call its #valid? method.
+    #
+    def parse(str)
+      return GRid.new if str.nil?
+
+      str = str.strip
+      return GRid.new if str.empty?
+
+      str.upcase!
+      str.sub!(/\AGRID:/, "")
+
+      extract = lambda do |i, j|
+        val = str[i, j]
+        return unless val
+
+        # 2.5 has delete_prefix
+        str[i, j] = ""
+        str.sub!(/\A-/, "")
+
+        val
+      end
+
+      GRid.new(:id_scheme => extract[0, 2],
+               :issuer_code => extract[0, 5],
+               :release_number => extract[0, 10],
+               :check_character => extract[-1, 1])
+    end
+  end
+
+  #
+  # Create a new instance consisting of +parts+.
+  # The #check_character will be calculated if none is given.
+  #
+  # === Arguments
+  #
+  # [parts (Hash)] Parts of the GRid, optional
+  #
+  # === Parts
+  #
+  # All parts are optional.
+  #
+  # [:id_scheme (String)] ID scheme portion, defaults to +A1+
+  # [:issuer_code (String)] Issuer code portion, defaults to default_issuer_code
+  # [:release_number (String)] Release number portion
+  # [:check_character (String)] Check character portion, will be calculated if not given
+  #
+
+  def initialize(parts = nil)
+    parts ||= {}
+
+    @issuer_code = parts[:issuer_code]
+    @issuer_code = self.class.default_issuer_code.dup if @issuer_code.nil? && self.class.default_issuer_code
+    @release_number = parts[:release_number]
+    @id_scheme = parts[:id_scheme] || DEFAULT_ID_SCHEME.dup
+    @check_character = parts[:check_character] || calculate_check_character
+
+    @errors = {}
+  end
+
+  %w[id_scheme issuer_code release_number].each do |name|
+    class_eval <<-METHOD, __FILE__, __LINE__ + 1
+      def #{name}=(s)
+        @#{name} = s
+        @check_character = calculate_check_character
+        @#{name}
+      end
+    METHOD
+  end
+
+  #
+  # Validate the GRid. To get the errors call #errors.
+  #
+  #  if !grid.valid?
+  #    grid.errors.each do |attr, errors|
+  #      printf "%10s: %s", attr, errors.join(", ")
+  #    end
+  #  end
+  #
+  def valid?
+    errors.clear
+
+    validate_id_scheme!
+    validate_issuer_code!
+    validate_release_number!
+    validate_check_character!
+
+    errors.empty?
+  end
+
+  #
+  # Create a Hash representing the GRid. Keys are Symbols representing the portions of the GRid.
+  #
+  def to_h
+    { :id_scheme => id_scheme,
+      :issuer_code => issuer_code,
+      :release_number => release_number,
+      :check_character => check_character }
+  end
+
+  #
+  # Return a formatted +String+ representation of the GRid.
+  #
+  def formatted
+    [ id_scheme, issuer_code, release_number, check_character ].compact.join("-").upcase
+  end
+
+  def to_s
+    [ id_scheme, issuer_code, release_number, check_character ].compact.join("").upcase
+  end
+
+  def ==(other)
+    other = self.class.parse(other) if other.is_a?(String)
+    eql?(other)
+  end
+
+  def eql?(other)
+    other.instance_of?(self.class) && to_s == other.to_s
+  end
+
+  def hash
+    to_s.hash
+  end
+
+  private
+
+  def validate_id_scheme!
+    if id_scheme != DEFAULT_ID_SCHEME
+      errors[:id_scheme] = ["must be #{DEFAULT_ID_SCHEME}"]
+    end
+  end
+
+  def validate_issuer_code!
+    messages = []
+
+    if issuer_code.nil?
+      messages << "required"
+    elsif issuer_code !~ /\A[a-z0-9]{5}\z/i
+      messages << "must be 5 alphanumeric characters"
+    end
+
+    errors[:issuer_code] = messages if messages.any?
+  end
+
+  def validate_release_number!
+    messages = []
+
+    if release_number.nil?
+      messages << "required"
+    elsif release_number !~ /\A[a-z0-9]{10}\z/i
+      messages << "must be 10 alphanumeric characters"
+    end
+
+    errors[:release_number] = messages if messages.any?
+  end
+
+  def validate_check_character!
+    messages = []
+
+    if check_character.nil?
+      messages << "required"
+    elsif check_character != calculate_check_character
+      messages << "verification failed"
+    end
+
+    errors[:check_character] = messages if messages.any?
+  end
+
+  def calculate_check_character
+    value = to_s[0, 17]
+    char = 36
+
+    0.upto(value.size - 1) do |lng|
+      v = CHECK_CODES.index(value[lng])
+      return unless v
+
+      char += v
+      char -= 36 if char > 36
+      char *= 2
+      char -= 37 if char >= 37
+    end
+
+    char = 37 - char
+    char = 0 if char == 36
+
+    CHECK_CODES[char]
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: grid-number
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |2
+      Class to represent Global Release Identifiers (GRid numbers).
+      GRid numbers are used to identify electronic music releases.
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grid-number.gemspec
+- lib/grid-number.rb
+- lib/grid.rb
+homepage: https://github.com/ScreenStaring
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Class to represent Global Release Identifiers (GRid numbers).
+test_files: []