barcodevalidation 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2783879bb9ef02f2f9e35dbb44141f4c21de2d6bebfb6b3643806a18eec2f13f
-  data.tar.gz: 0d839d223853a598a05434a401dd0282ea2f48713ab27ea99bf4043bdda68e77
+  metadata.gz: 69f00057d24894273af1d7404d7152f18067b861c8c0a9c553995cc442328768
+  data.tar.gz: 30864684c4ea4a27b44907ba99ba9325109344ff257cb2da3bdd10055a5d0ead
 SHA512:
-  metadata.gz: 252f2f26e2787311a8772b2513c017de0c7c9ad0d5acec5e52fbf6ab859781df4fdb30da4b477a942d42ec8997408a5193ba9ffbf7c42800c8d04f5bd5713f6c
-  data.tar.gz: 55ee58d3b10b39756e384d00e9eb3c3b2950b28572fcdd264e203639a936a92aea5523d636b0513ef329b273c45f015e21fefea4eb1b26cd3a53b5b9370b453e
+  metadata.gz: d81de8495506f006796a5f40db56b365faf3df44859f954eba74dda4ec17dd18bd86c5f9b51e9e4205b845d1593be82e50f61245e0151b9d52cff9f2e4b5fd6a
+  data.tar.gz: 46ca1e1ea7522c114501e8d72c9cbc70eaabae4886d50885a6f620abf0bb28a9ce6f982f9177b0c324fd9aa418b7d0f6558a4923e9eb51e801a350910ee9fc0b

data/README.md

@@ -40,20 +40,26 @@ and it's pretty flexible about what you give it.
 
 ```ruby
 gtin = BarcodeValidation.scan("937179-004167")
-# => #<BarcodeValidation::GTIN(937179004167)>
+# => #<BarcodeValidation::GTIN::GTIN12(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)>
+gtin.to_gtin_13  # => #<BarcodeValidation::GTIN::GTIN13(0937179004167)>
+gtin.to_all_valid
+# => [#<BarcodeValidation::GTIN::GTIN12(937179004167)>,
+#<BarcodeValidation::GTIN::GTIN123(0937179004167)>]
 
 bad = BarcodeValidation.scan(937_179_004_162)
-# => #<BarcodeValidation::GTIN(937179004162)>
+# => #<BarcodeValidation::InvalidGTIN(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)>
+bad.to_gtin_13           # => #<BarcodeValidation::InvalidGTIN(937179004162)>
+bad.to_all_valid         # => []
 ```
 
 

data/barcodevalidation.gemspec

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "barcodevalidation/version"
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = "~> 2.5"
   spec.name          = "barcodevalidation"
   spec.version       = BarcodeValidation::VERSION
   spec.authors       = ["Marketplacer"]

data/config/boot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This script sets up the common environment for the project
 #
 # Require this file using:

data/lib/barcodevalidation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "barcodevalidation/mixin"
 require "barcodevalidation/error"
 require "barcodevalidation/digit"
@@ -23,6 +25,7 @@ module BarcodeValidation
     # Strips punctuation
     def sanitize(input)
       return input.gsub(/(\s|[-_])/, "") if input.respond_to? :gsub
+
       input
     end
   end

data/lib/barcodevalidation/digit.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "delegate"
+require_relative "error/argument_error_class"
 
 module BarcodeValidation
   class Digit < DelegateClass(Integer)
@@ -10,6 +13,7 @@ module BarcodeValidation
     def initialize(input)
       value = Integer(input)
       raise ::ArgumentError unless (0..9).cover? value
+
       super(value)
     rescue *INTEGER_CAST_ERRORS
       raise Digit::ArgumentError, input

data/lib/barcodevalidation/digit_sequence.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require "forwardable"
+require_relative "error/argument_error_class"
 
 module BarcodeValidation
   class DigitSequence < Array
@@ -18,6 +21,7 @@ module BarcodeValidation
     def initialize(values)
       values = cast(values)
       raise ArgumentError, values unless values.respond_to? :map
+
       super(values.map { |value| BarcodeValidation::Digit.new(value) })
     end
 

data/lib/barcodevalidation/error.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative "error/argument_error_class"

data/lib/barcodevalidation/error/argument_error_class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "forwardable"
 
 module BarcodeValidation

data/lib/barcodevalidation/gtin.rb

@@ -1,42 +1,27 @@
+# frozen_string_literal: true
+
 require "forwardable"
+require_relative "invalid_gtin"
+require_relative "gtin/base"
+require_relative "gtin/check_digit"
+require_relative "gtin/gtin8"
+require_relative "gtin/gtin12"
+require_relative "gtin/gtin13"
+require_relative "gtin/gtin14"
 
 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
-      InvalidGTIN.new(input, error: e)
-    end
-
-    def valid?
-      VALID_LENGTHS.include?(length) && check_digit.valid?
-    end
-
-    class CheckDigit < DelegateClass(Digit)
-      include Adamantium::Flat
-      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)
+  module GTIN
+    class << self
+      def new(input)
+        (class_for_input(input) || BarcodeValidation::InvalidGTIN).new(input)
       end
 
-      def valid?
-        actual == expected
-      end
+      private
 
-      def inspect
-        return super if valid?
-        "#<#{self.class}(#{actual}) invalid: expected #{expected}>"
+      def class_for_input(input)
+        [GTIN8, GTIN12, GTIN13, GTIN14].find do |klass|
+          input.to_s.size == klass::VALID_LENGTH
+        end
       end
     end
   end

data/lib/barcodevalidation/gtin/base.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module BarcodeValidation
+  module GTIN
+    class Base < BarcodeValidation::DigitSequence
+      MODULUS = 10
+
+      extend Forwardable
+
+      attr_reader :input
+
+      def initialize(input)
+        @input = input
+
+        super
+      rescue BarcodeValidation::Error => e
+        BarcodeValidation::InvalidGTIN.new(input, error: e)
+      end
+
+      def valid?
+        valid_length == length && check_digit.valid?
+      end
+
+      def valid_length
+        raise(AbstractMethodError, "Concrete classes must define the VALID_LENGTH constant") unless self.class.const_defined?(:VALID_LENGTH)
+
+        self.class::VALID_LENGTH
+      end
+
+      class AbstractMethodError < StandardError; end
+
+      def to_all_valid
+        [
+          to_gtin_8,
+          to_gtin_12,
+          to_gtin_13,
+          to_gtin_14,
+        ].select(&:valid?)
+      end
+
+      def to_gtin_8
+        is_a?(GTIN8) ? self : transcode_to(GTIN8)
+      end
+
+      def to_gtin_12
+        is_a?(GTIN12) ? self : transcode_to(GTIN12)
+      end
+
+      def to_gtin_13
+        is_a?(GTIN13) ? self : transcode_to(GTIN13)
+      end
+
+      def to_gtin_14
+        is_a?(GTIN14) ? self : transcode_to(GTIN14)
+      end
+
+      private
+
+      def check_digit
+        CheckDigit.new(last, expected: expected_check_digit)
+      end
+
+      def expected_check_digit
+        (MODULUS - weighted_checkable_digit_sum) % MODULUS
+      end
+
+      def weighted_checkable_digit_sum
+        checkable_digits
+          .zip([3, 1].cycle)
+          .map { |digit, factor| digit * factor }
+          .reduce(&:+)
+      end
+
+      def checkable_digits
+        take(length - 1).reverse.map(&:to_i)
+      end
+
+      # Instantiates the given class with the string value of this instance
+      # with any leading zeros stripped out, and then zero-padded up to the
+      # valid length of the given class. If the resulting string is <> the
+      # valid length of the target format, the returned object will be a
+      # BarcodeValidation::InvalidGTIN with valid? = false and a meaningful
+      # error message.
+      def transcode_to(klass)
+        gtin = klass.new(format("%0#{klass::VALID_LENGTH}d", to_s.gsub(/^0+/, "")))
+
+        if gtin.valid?
+          gtin
+        else
+          BarcodeValidation::InvalidGTIN.new(
+            input,
+            error: klass::ConversionError.new(klass).exception(input),
+          )
+        end
+      end
+
+      ConversionError = Error::ArgumentErrorClass.new(self)
+    end
+  end
+end

data/lib/barcodevalidation/gtin/check_digit.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module BarcodeValidation
+  module GTIN
+    class CheckDigit < DelegateClass(Digit)
+      include Adamantium::Flat
+      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/gtin/gtin12.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BarcodeValidation
+  module GTIN
+    class GTIN12 < BarcodeValidation::GTIN::Base
+      VALID_LENGTH = 12
+    end
+  end
+end

data/lib/barcodevalidation/gtin/gtin13.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BarcodeValidation
+  module GTIN
+    class GTIN13 < BarcodeValidation::GTIN::Base
+      VALID_LENGTH = 13
+    end
+  end
+end

data/lib/barcodevalidation/gtin/gtin14.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BarcodeValidation
+  module GTIN
+    class GTIN14 < BarcodeValidation::GTIN::Base
+      VALID_LENGTH = 14
+    end
+  end
+end

data/lib/barcodevalidation/gtin/gtin8.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module BarcodeValidation
+  module GTIN
+    class GTIN8 < BarcodeValidation::GTIN::Base
+      VALID_LENGTH = 8
+    end
+  end
+end

data/lib/barcodevalidation/invalid_gtin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "delegate"
 
 module BarcodeValidation
@@ -17,7 +19,28 @@ module BarcodeValidation
 
     def error_message
       return @error.message if @error.respond_to? :message
+
       @error.inspect
     end
+
+    def to_all_valid
+      []
+    end
+
+    def to_gtin_8
+      self
+    end
+
+    def to_gtin_12
+      self
+    end
+
+    def to_gtin_13
+      self
+    end
+
+    def to_gtin_14
+      self
+    end
   end
 end

data/lib/barcodevalidation/mixin.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require_relative "mixin/has_check_digit"
 require_relative "mixin/value_object"

data/lib/barcodevalidation/mixin/has_check_digit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BarcodeValidation
   module Mixin
     # Wraps #last as a CheckDigit

data/lib/barcodevalidation/mixin/value_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "adamantium"
 
 module BarcodeValidation

data/lib/barcodevalidation/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BarcodeValidation
-  VERSION = "2.2.0".freeze
+  VERSION = "2.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: barcodevalidation
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Marketplacer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adamantium
@@ -41,6 +41,12 @@ files:
 - lib/barcodevalidation/error.rb
 - lib/barcodevalidation/error/argument_error_class.rb
 - lib/barcodevalidation/gtin.rb
+- lib/barcodevalidation/gtin/base.rb
+- lib/barcodevalidation/gtin/check_digit.rb
+- lib/barcodevalidation/gtin/gtin12.rb
+- lib/barcodevalidation/gtin/gtin13.rb
+- lib/barcodevalidation/gtin/gtin14.rb
+- lib/barcodevalidation/gtin/gtin8.rb
 - lib/barcodevalidation/invalid_gtin.rb
 - lib/barcodevalidation/mixin.rb
 - lib/barcodevalidation/mixin/has_check_digit.rb
@@ -50,24 +56,24 @@ homepage: https://github.com/marketplacer/barcodevalidation
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Parses and validates barcodes
 test_files: []