barcodevalidation 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db8ad560ea3e5057b6cbaee32f7d3e4075a1e432
-  data.tar.gz: a0022217ccfac363462b8bdac2c4e9d4b314d6ab
+  metadata.gz: 84bbd3fe9cbb881208a51ecfafa282d5ee9bc5e9
+  data.tar.gz: 5ac9ff35d2d81d7ea0d67192acde59a29b94e681
 SHA512:
-  metadata.gz: 1130c129b9825032db6054694b393bf58be61f2ce855ed46b56c9b139f94a08498ff5e9f903331b93093af5905241f86190ec418ad53fc3d8413d9a0a7ab476d
-  data.tar.gz: 8d49c76a546b5b32d886f5fa32f03924c5a2de39c55047497a3e2d7c0f992f32b53a935e8c97b2a798a7c117dee62fc0254f87ebc168170da65e0ecabf8dbc4e
+  metadata.gz: f4a4842daa354e183476db6a0c61a70f99d4a0aa426a90f5ff166dba01718fa7557f8d3a7576c6aa13ca2180c51cafc9e0c80ba5a6b2bb85e430e22b8fa09769
+  data.tar.gz: be9e9f1e3a9393c93030a2979e1d4a9232c502b792831e79dc7e5d160c8bfcabd4bf0aa042fea598150facff3aa43e52833ccde03e03b507a9684b4510954fbf

data/LICENSE.md

@@ -0,0 +1,23 @@
+MIT License
+===========
+
+Copyright (c) 2016 Marketplacer
+
+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

@@ -1,14 +1,26 @@
-[![Build Status](https://travis-ci.org/exchangegroup/barcodevalidation.svg?branch=master)](https://travis-ci.org/exchangegroup/barcodevalidation)
+barcodevalidation
+=================
 
-# Barcodevalidation
+[![Build Status][travis-badge]][travis]
+[![Gem Version][rubygems-badge]][rubygems]
 
-A simple library to validate barcodes
+[travis]: <https://travis-ci.org/marketplacer/barcodevalidation>
+[travis-badge]: <https://travis-ci.org/marketplacer/barcodevalidation.svg?branch=master>
+[rubygems]: <https://badge.fury.io/rb/barcodevalidation>
+[rubygems-badge]: <https://badge.fury.io/rb/barcodevalidation.svg>
 
-## Installation
+A RubyGem to parse and validate barcodes.
+
+
+
+Installation
+------------
 
 Add this line to your application's Gemfile:
 
-    gem 'barcodevalidation'
+```ruby
+gem "barcodevalidation"
+```
 
 And then execute:
 
@@ -18,14 +30,107 @@ Or install it yourself as:
 
     $ gem install barcodevalidation
 
-## Usage
 
-Barcodevalidator.valid?(937179004167)
 
-## Contributing
+Usage
+-----
+
+The main API is `BarcodeValidation.scan`. It accepts a single argument,
+and it's pretty flexible about what you give it.
+
+```ruby
+gtin = BarcodeValidation.scan("937179-004167")
+# => #<BarcodeValidation::GTIN(937179004167)>
+gtin.to_s        # => "937179004167"
+gtin.valid?      # => true
+gtin.check_digit # => #<BarcodeValidation::GTIN::CheckDigit(7)>
+gtin.first(6)    # => #<BarcodeValidation::DigitSequence(937179)>
+gtin.slice(0..5) # => #<BarcodeValidation::DigitSequence(937179)>
+
+bad = BarcodeValidation.scan(937_179_004_162)
+# => #<BarcodeValidation::GTIN(937179004162)>
+bad.valid?               # => false
+bad.check_digit          # => #<BarcodeValidation::GTIN::CheckDigit(2) invalid: expected 7>
+bad.check_digit.valid?   # => false
+bad.check_digit.actual   # => #<BarcodeValidation::Digit(2)>
+bad.check_digit.expected # => #<BarcodeValidation::Digit(7)>
+```
+
+
+
+Development
+-----------
+
+Download the code from GitHub:
+
+```
+git clone git@github.com:marketplacer/barcodevalidation.git
+```
+
+Set up dependencies using Bundler:
+
+```
+cd barcodevalidation
+bin/setup
+```
+
+Start the interactive development console:
+
+```
+bin/console
+```
+
+Run a build:
+
+```
+bin/rake
+```
+
+#### Code Quality Checks
+
+Rubocop is used to enforce coding standards.
+
+```
+bin/rubocop
+bin/rubocop --help
+```
+
+
+
+Continuous Integration
+----------------------
+
+Code is automatically tested with each push, on both Travis CI and
+Marketplacer's internal Buildkite.
+
+
+
+Project Structure
+-----------------
+This project's structure is inspired by the Bundler skeleton for a new
+Gem, created using `bundler gem barcodevalidation`.
+
+* `.bundle/config`: Configuration for Bundler
+* `.ruby-version`: Gives rvm, rbenv, chruby etc. a Ruby version to use
+* `Gemfile`: Lists RubyGem dependencies, to be installed by Bundler
+* `Rakefile`: Defines Rake tasks
+* `bin/`: Contains binstubs, useful for development tasks
+    * `bundle`: Runs Bundler, in the correct way
+    * `console`: development console (equiv. to `bin/bundle exec pry`)
+    * `rake`: Runs Rake (equivalent to `bin/bundle exec rake`)
+    * `rubocop`: Runs Rubocop (equivalent to `bin/bundle exec rubocop`)
+    * `setup`: Sets up the project to be ready for development
+* `config/boot.rb`: Prepares dependencies before loading the library
+* `lib/`: Source files; this directory is added to Ruby's load path
+* `script/ci`: The script run by Buildkite to start a build
+
+
+
+License
+-------
+
+This project is licensed under the [MIT License]. See [LICENSE.md] for
+the full text.
 
-1. Fork it ( https://github.com/exchangegroup/barcodevalidation/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
+[MIT License]: <https://opensource.org/licenses/MIT>
+[LICENSE.md]: <https://github.com/marketplacer/barcodevalidation/blob/master/LICENSE.md>

data/barcodevalidation.gemspec

@@ -1,20 +1,27 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'barcodevalidation/version'
+require "barcodevalidation/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "barcodevalidation"
-  spec.version       = Barcodevalidation::VERSION
+  spec.version       = BarcodeValidation::VERSION
   spec.authors       = ["Marketplacer"]
   spec.email         = ["it@marketplacer.com"]
-  spec.summary       = %q{Barcode validation library}
-  spec.description   = %q{Simple barcode validator. Just verifies that barcode checksum is valid}
-  spec.homepage      = ""
+
+  spec.summary       = "Parses and validates barcodes"
+  spec.description   = "A RubyGem to parse and validate barcodes"
+  spec.homepage      = "https://github.com/marketplacer/#{spec.name}"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = %w(LICENSE.md README.md barcodevalidation.gemspec
+                          config/*.rb lib/**/*.rb)
+                       .flat_map { |pattern| Dir.glob(pattern) }
+                       .reject { |f| File.directory?(f) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files
+                           .grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "adamantium"
 end

data/config/boot.rb

@@ -0,0 +1,30 @@
+# This script sets up the common environment for the project
+#
+# Require this file using:
+#
+#     require File.expand_path("../config/boot.rb", __FILE__)
+#
+# This would work from any file located in the root of the project.
+# For files that are nested within a subdirectory, use a relative path:
+#
+#     # From within foo/bar/baz.rb relative to the root of the project
+#     require File.expand_path("../../../config/boot.rb", __FILE__)
+#
+# Then, to all RubyGems in the Gemfile available, use one of:
+#
+#   - require "bundler/setup"
+#   - Bundler.setup
+#
+# To make only certain groups available, use:
+#
+#     Bundler.setup(:default, :ci)
+require "pathname"
+project_root = Pathname.new(__FILE__).parent.parent
+
+# Add lib directory to load path
+lib = project_root + "lib"
+$LOAD_PATH.unshift(lib.to_s) unless $LOAD_PATH.include?(lib.to_s)
+
+# Tell Bundler explicitly which Gemfile to use
+ENV["BUNDLE_GEMFILE"] ||= (project_root + "Gemfile").to_s
+require "bundler"

data/lib/barcodevalidation.rb

@@ -1,26 +1,37 @@
+require "barcodevalidation/mixin"
+require "barcodevalidation/error"
+require "barcodevalidation/digit"
+require "barcodevalidation/digit_sequence"
+require "barcodevalidation/gtin"
+require "barcodevalidation/invalid_gtin"
 require "barcodevalidation/version"
 
-module Barcodevalidation
-  def self.valid?(barcode)
-    barcode = barcode.to_s.strip
-    # only accept numeric codes
-    return false unless barcode =~ /^\d+$/
-    # accept lengths defined at gtin.info
-    return false unless [8, 12, 13, 14].include?(barcode.length)
-
-    parts = barcode.rjust(18, '0').chars.map(&:to_i)
-    checksum = parts.pop
+module BarcodeValidation
+  class << self
+    def scan(input)
+      GTIN.new(sanitize(input))
+    end
 
-    calculated_checksum = 0
-    parts.each_with_index do |part, index|
-      if index % 2 == 0
-        calculated_checksum += (part * 3)
-      else
-        calculated_checksum += part
+    def scan!(input)
+      scan(input).tap do |result|
+        raise InvalidGTINError, input unless result.valid?
       end
     end
 
-    calculated_checksum = ((calculated_checksum.to_f / 10).ceil * 10) - calculated_checksum
-    checksum == calculated_checksum
+    private
+
+    # Strips punctuation
+    def sanitize(input)
+      return input.gsub(/(\s|[-_])/, "") if input.respond_to? :gsub
+      input
+    end
+  end
+
+  class InvalidGTINError < ::ArgumentError
+    include Error
+
+    def initialize(input)
+      super "Invalid GTIN #{input.inspect}"
+    end
   end
 end

data/lib/barcodevalidation/digit.rb

@@ -0,0 +1,26 @@
+require "delegate"
+
+module BarcodeValidation
+  class Digit < DelegateClass(Integer)
+    include Mixin::ValueObject
+
+    INTEGER_CAST_ERRORS = [::ArgumentError, ::TypeError].freeze
+
+    # Memoize constructor based on the integer value given
+    def self.memoization_key(input, *)
+      Integer(input)
+    rescue *INTEGER_CAST_ERRORS
+      nil # the constructor will raise
+    end
+
+    def initialize(input)
+      value = Integer(input)
+      raise ::ArgumentError unless (0..9).cover? value
+      super(value)
+    rescue *INTEGER_CAST_ERRORS
+      raise Digit::ArgumentError, input
+    end
+
+    ArgumentError = Error::ArgumentErrorClass.new(self)
+  end
+end

data/lib/barcodevalidation/digit_sequence.rb

@@ -0,0 +1,46 @@
+require "forwardable"
+
+module BarcodeValidation
+  class DigitSequence < Array
+    extend Forwardable
+    include Mixin::ValueObject
+
+    delegate to_s: :join
+    delegate cast: "self.class"
+
+    # Memoize constructor based on the integer value given
+    def self.memoization_key(input, *)
+      input.respond_to?(:join) ? input.join : input.to_s
+    end
+
+    def self.cast(input)
+      input = input.to_s if input.is_a? Integer
+      input = input.chars if input.is_a? String
+      input
+    end
+
+    def initialize(values)
+      values = cast(values)
+      raise ArgumentError, values unless values.respond_to? :map
+      super(values.map { |value| BarcodeValidation::Digit.new(value) })
+    end
+
+    def ==(other)
+      case other
+      when String, Numeric then super(self.class.new(other))
+      else super
+      end
+    end
+
+    %i(* + - drop first last reverse rotate slice shuffle
+       take).each do |method_name|
+      define_method method_name do |*args|
+        super(*args).tap do |result|
+          return DigitSequence.new(result) if result.is_a? Enumerable
+        end
+      end
+    end
+
+    ArgumentError = Error::ArgumentErrorClass.new(DigitSequence)
+  end
+end

data/lib/barcodevalidation/error.rb

@@ -0,0 +1 @@
+require_relative "error/argument_error_class"

data/lib/barcodevalidation/error/argument_error_class.rb

@@ -0,0 +1,20 @@
+require "forwardable"
+
+module BarcodeValidation
+  module Error
+    class ArgumentErrorClass < ::ArgumentError
+      include BarcodeValidation::Error
+      extend Forwardable
+
+      delegate klass: "self.class"
+
+      def self.new(klass)
+        Class.new(self) { define_singleton_method(:klass) { klass } }
+      end
+
+      def initialize(input)
+        super "invalid value for #{klass}(): #{input.inspect}"
+      end
+    end
+  end
+end

data/lib/barcodevalidation/gtin.rb

@@ -0,0 +1,42 @@
+require "forwardable"
+
+module BarcodeValidation
+  class GTIN < BarcodeValidation::DigitSequence
+    extend Forwardable
+    include Mixin::HasCheckDigit
+
+    VALID_LENGTHS = [8, 12, 13, 14].freeze
+
+    def self.new(input)
+      super
+    rescue BarcodeValidation::Error => e
+      return InvalidGTIN.new(input, error: e)
+    end
+
+    def valid?
+      VALID_LENGTHS.include?(length) && check_digit.valid?
+    end
+
+    class CheckDigit < DelegateClass(Digit)
+      include Mixin::ValueObject
+
+      attr_reader :actual, :expected
+
+      def initialize(actual, expected: nil)
+        expected = actual if expected.nil?
+        @expected = Digit.new(expected)
+        @actual = Digit.new(actual)
+        super(@actual)
+      end
+
+      def valid?
+        actual == expected
+      end
+
+      def inspect
+        return super if valid?
+        "#<#{self.class}(#{actual}) invalid: expected #{expected}>"
+      end
+    end
+  end
+end

data/lib/barcodevalidation/invalid_gtin.rb

@@ -0,0 +1,23 @@
+require "delegate"
+
+module BarcodeValidation
+  class InvalidGTIN < SimpleDelegator
+    def initialize(input, error: nil)
+      @error = error
+      super(input)
+    end
+
+    def valid?
+      false
+    end
+
+    def inspect
+      %(#<#{self.class} input=#{super} error="#{error_message}">)
+    end
+
+    def error_message
+      return @error.message if @error.respond_to? :message
+      @error.inspect
+    end
+  end
+end

data/lib/barcodevalidation/mixin.rb

@@ -0,0 +1,2 @@
+require_relative "mixin/has_check_digit"
+require_relative "mixin/value_object"

data/lib/barcodevalidation/mixin/has_check_digit.rb

@@ -0,0 +1,29 @@
+module BarcodeValidation
+  module Mixin
+    # Wraps #last as a CheckDigit
+    module HasCheckDigit
+      MODULUS = 10
+
+      def check_digit
+        GTIN::CheckDigit.new(last, expected: expected_check_digit)
+      end
+
+      private
+
+      def expected_check_digit
+        (MODULUS - weighted_checkable_digit_sum) % MODULUS
+      end
+
+      def weighted_checkable_digit_sum
+        checkable_digits
+          .zip([3, 1].cycle)
+          .map { |l, r| l * r }
+          .reduce(&:+)
+      end
+
+      def checkable_digits
+        take(length - 1).reverse
+      end
+    end
+  end
+end

data/lib/barcodevalidation/mixin/value_object.rb

@@ -0,0 +1,42 @@
+require "adamantium"
+
+module BarcodeValidation
+  module Mixin
+    module ValueObject
+      def self.included(mod)
+        mod.extend ClassMethods
+        mod.include Adamantium
+      end
+
+      module ClassMethods
+        # Memoizes return values based on the inputs
+        def new(*args)
+          (@__new_cache ||= {})[memoization_key(*args)] ||= super
+        end
+
+        # Customise the memoisation logic in classes which include this
+        def memoization_key(*args)
+          args
+        end
+      end
+
+      def eql?(other)
+        object_id == other.object_id
+      end
+
+      def inspect
+        "#<#{description}>"
+      end
+
+      def pretty_print(pp)
+        pp.text inspect
+      end
+
+      private
+
+      def description
+        "#{self.class}(#{self})"
+      end
+    end
+  end
+end

data/lib/barcodevalidation/version.rb

@@ -1,3 +1,3 @@
-module Barcodevalidation
-  VERSION = "1.0.1"
+module BarcodeValidation
+  VERSION = "2.0.0".freeze
 end

metadata

@@ -1,34 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: barcodevalidation
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Marketplacer
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
-dependencies: []
-description: Simple barcode validator. Just verifies that barcode checksum is valid
+date: 2016-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: adamantium
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A RubyGem to parse and validate barcodes
 email:
 - it@marketplacer.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- Rakefile
 - barcodevalidation.gemspec
+- config/boot.rb
 - lib/barcodevalidation.rb
+- lib/barcodevalidation/digit.rb
+- lib/barcodevalidation/digit_sequence.rb
+- lib/barcodevalidation/error.rb
+- lib/barcodevalidation/error/argument_error_class.rb
+- lib/barcodevalidation/gtin.rb
+- lib/barcodevalidation/invalid_gtin.rb
+- lib/barcodevalidation/mixin.rb
+- lib/barcodevalidation/mixin/has_check_digit.rb
+- lib/barcodevalidation/mixin/value_object.rb
 - lib/barcodevalidation/version.rb
-- test/minitest_helper.rb
-- test/test_barcodevalidation.rb
-homepage: ''
+homepage: https://github.com/marketplacer/barcodevalidation
 licenses:
 - MIT
 metadata: {}
@@ -48,10 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Barcode validation library
-test_files:
-- test/minitest_helper.rb
-- test/test_barcodevalidation.rb
+summary: Parses and validates barcodes
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.0
-  - 2.1.2
-addons:
-  code_climate:
-    repo_token: 9d0616ce6c97ce19ed8aef10e7a94cf8405ebe59a00551aa7cc9e509ad9c4301

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 The Exchange Group
-
-MIT License
-
-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/Rakefile

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-end
-
-task :default => :test
-

data/test/minitest_helper.rb

@@ -1,4 +0,0 @@
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'barcodevalidation'
-
-require 'minitest/autorun'

data/test/test_barcodevalidation.rb

@@ -1,35 +0,0 @@
-require 'minitest_helper'
-
-class TestBarcodevalidation < MiniTest::Test
-  def test_valid_barcodes
-    [
-      937179004167,
-      '937179004167',
-      9312631133233,
-      '0753759137885'
-    ].each { |barcode| assert Barcodevalidation.valid?(barcode), barcode }
-  end
-
-  def test_invalid_barcodes
-    [
-      144793, #too short
-      1234567890123, #invalid check digit
-      50140424, #invalid check digit
-      5420056646861,
-      10004336,
-      '48cm',
-      123,
-      1, #make sure only valid length barcodes are accepted
-      22,
-      333,
-      4444,
-      55555,
-      666666,
-      777777,
-      99999999,
-      12345678901,
-      123456789012345,
-      'BODGYBARCODE'
-    ].each { |barcode| refute Barcodevalidation.valid?(barcode), barcode }
-  end
-end