barcodevalidation 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1472674218493f67abaf42f2c94c4009ca1aabb07180cee0bfd9ef3c6c2fed5
-  data.tar.gz: f8aa280b1ca3ad091d13c4a1391d7598b82cbcd5db3d9a3c92c65cdb4ce2407b
+  metadata.gz: b6949efb809df8a20b1d2816bd27f5fada9ed3273f5ed52e1008c85169a29151
+  data.tar.gz: 120483828346597e8e418737d8bba2f7348104117008caf2e69245720f4f9eaa
 SHA512:
-  metadata.gz: 87096371c819a9efa4f2493edf47ae2d21cccb16922e9b1661aa11de5fcf82aab7a2031ba8ec2660d6026003f905488c793d996c65bc21ab3e0fd44255e672f4
-  data.tar.gz: 7eaebe15a7d9ff6c8922b46ec6c1cea2b392235c5b2d245038456ae10c3e72618c5b20c465f1f13094cda06fae3aa123dd3c1fdd189c8f717e9fa04875c6c390
+  metadata.gz: 451437593aad8dbf1ccd2c180be239c5b87c7503760cccae4e37583e1fdde899ddcbd8b3a3ab5eb4b53a1e1c6e6f7c3ae7c5155bfab6bd2ea83839c6da092a47
+  data.tar.gz: 84024a6d521aa3dbe7a205d37fbb3f7c5efaec448fb2ab6d43a8b4e58b2d9ccae349ba91020cec18f2d02a4806a8ff646a6eb33e1494dd5f2476d50335a6675a

data/README.md

@@ -63,6 +63,46 @@ bad.to_all_valid         # => []
 ```
 
 
+Custom GTINs
+------------
+
+If the standard GTINs provided are not enough for your needs, you can implement your own by subclassing `BarcodeValidation::GTIN::Base` or any of its subclasses. If your custom class overlaps with a default class or one of your other custom classes, you can declare `prioritize_before <other class>` to re-order their evaluation order.
+
+An example:
+
+```ruby
+# A custom class that handles any length GTIN as long as it starts with "123".
+# Note that we must still provide a VALID_LENGTH to allow transcoding to other GTINs by zero-padding.
+# Due to this inheriting from Base, it is automatically registered and added to the end of the list of classes to check if it `handles?` an input.
+class MyCustomGTIN < BarcodeValidation::GTIN::Base
+  VALID_LENGTH = 20
+
+  def self.handles?(input)
+    input.start_with?("123") && input.length <= VALID_LENGTH
+  end
+
+  # Custom validity check
+  def valid?
+    self.class.handles?(input) && check_digit.valid?
+  end
+end
+
+# A custom implementation of GTIN13, which addresses a subset of the GTIN13 range.
+class MyCustomGTIN13 < BarcodeValidation::GTIN::GTIN13
+  # Ensure we get a chance to handle GTINs before our parent,
+  # so we can handle the subset we care about and have our parent handle the rest.
+  prioritize_before BarcodeValidation::GTIN::GTIN13
+
+  def self.handles?(input)
+    input.start_with?("123") && super
+  end
+
+  def valid?
+    input.start_with?("123") && super
+  end
+end
+```
+
 
 Development
 -----------
@@ -94,11 +134,10 @@ bin/rake
 
 #### Code Quality Checks
 
-Rubocop is used to enforce coding standards.
+[StandardRB](https://github.com/standardrb/standard) is used to enforce coding standards.
 
 ```
-bin/rubocop
-bin/rubocop --help
+bin/standardrb
 ```
 
 
@@ -123,7 +162,7 @@ Gem, created using `bundler gem barcodevalidation`.
     * `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`)
+    * `standardrb`: Runs standardrb (equivalent to `bin/bundle exec standardrb`)
     * `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

data/barcodevalidation.gemspec

@@ -5,23 +5,23 @@ $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"]
-  spec.email         = ["it@marketplacer.com"]
+  spec.required_ruby_version = ">= 3.1"
+  spec.name = "barcodevalidation"
+  spec.version = BarcodeValidation::VERSION
+  spec.authors = ["Marketplacer"]
+  spec.email = ["it@marketplacer.com"]
 
-  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.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         = %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.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"]
 end

data/config/boot.rb

@@ -24,9 +24,9 @@ require "pathname"
 project_root = Pathname.new(__FILE__).parent.parent
 
 # Add lib directory to load path
-lib = project_root + "lib"
+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
+ENV["BUNDLE_GEMFILE"] ||= (project_root / "Gemfile").to_s
 require "bundler"

data/lib/barcodevalidation/digit.rb

@@ -18,7 +18,7 @@ module BarcodeValidation
       raise Digit::ArgumentError, input
     end
 
-    alias to_i __getobj__
+    alias_method :to_i, :__getobj__
 
     ArgumentError = Error::ArgumentErrorClass.new(self)
   end

data/lib/barcodevalidation/digit_sequence.rb

@@ -31,6 +31,10 @@ module BarcodeValidation
       end
     end
 
+    def all_zeros?
+      all? { |digit| digit.to_i.zero? }
+    end
+
     def *(other)
       self.class.new(super)
     end

data/lib/barcodevalidation/error/argument_error_class.rb

@@ -15,7 +15,7 @@ module BarcodeValidation
       end
 
       def initialize(input)
-        super "invalid value for #{klass}(): #{input.inspect}"
+        super("invalid value for #{klass}(): #{input.inspect}")
       end
     end
   end

data/lib/barcodevalidation/gtin/base.rb

@@ -19,12 +19,49 @@ module BarcodeValidation
         BarcodeValidation::InvalidGTIN.new(input, error: e)
       end
 
+      # Does this class (potentially) handle a GTIN that matches the input?
+      # Subclasses can choose to implement their own logic. The default is to look at +VALID_LENGTH+ and use that to match the length of the input the class handles.
+      def self.handles?(input)
+        return false unless const_defined?(:VALID_LENGTH)
+
+        input.length == self::VALID_LENGTH
+      end
+
+      # Upon inheritance, register the subclass so users of the library can dynamically add more GTINs in their own code.
+      def self.inherited(subclass)
+        BarcodeValidation::GTIN.append_gtin_class(subclass)
+        super
+      end
+
+      # Ensure this class is earlier in the GTIN classes list than +other_gtin_class+ and thus will get asked earlier if it handles a GTIN.
+      def self.prioritize_before(other_gtin_class)
+        unless GTIN.gtin_class?(other_gtin_class)
+          raise ArgumentError,
+            "The class you want to prioritize before is not a registered prioritized GTIN class."
+        end
+
+        GTIN.reprioritize_before(self, other_gtin_class)
+      end
+
+      # This class is abstract and should not be included in the list of GTIN classes that actually implement a GTIN.
+      def self.abstract_class
+        BarcodeValidation::GTIN.remove_gtin_class(self)
+      end
+
+      # GTIN::Base is an abstract class. See GTIN8/12/13/14 for implementations of actual GTINs.
+      abstract_class
+
       def valid?
-        valid_length == length && check_digit.valid?
+        valid_length == length && !all_zeros? && check_digit.valid?
       end
 
       def valid_length
-        raise(AbstractMethodError, "Concrete classes must define the VALID_LENGTH constant") unless self.class.const_defined?(:VALID_LENGTH)
+        unless self.class.const_defined?(:VALID_LENGTH)
+          raise(
+            AbstractMethodError,
+            "Concrete classes must define the VALID_LENGTH constant"
+          )
+        end
 
         self.class::VALID_LENGTH
       end
@@ -36,7 +73,7 @@ module BarcodeValidation
           to_gtin_8,
           to_gtin_12,
           to_gtin_13,
-          to_gtin_14,
+          to_gtin_14
         ].select(&:valid?)
       end
 
@@ -84,14 +121,14 @@ module BarcodeValidation
       # 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+/, "")))
+        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),
+            error: klass::ConversionError.new(klass).exception(input)
           )
         end
       end

data/lib/barcodevalidation/gtin.rb

@@ -2,27 +2,62 @@
 
 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
+  # GTIN is responsible for wrapping input in an appropriate GTIN::Base sub-class.
+  # An important part of this involves managing the prioritized list of GTIN classes we use for handling input.
+  # The methods implemented here are used by GTIN::Base to manage this list and prioritize classes.
   module GTIN
     class << self
       def new(input)
         (class_for_input(input) || BarcodeValidation::InvalidGTIN).new(input)
       end
 
+      # Adds the provided class to the back of the list of prioritized GTIN classes.
+      def append_gtin_class(gtin_class)
+        prioritized_gtin_classes.push(gtin_class) unless gtin_class?(gtin_class)
+        nil
+      end
+
+      # Ensure the provided class is removed from the list of prioritized GTIN classes.
+      def remove_gtin_class(gtin_class)
+        prioritized_gtin_classes.delete(gtin_class)
+        nil
+      end
+
+      # Is this a registered prioritized GTIN class?
+      # @return [true, false]
+      def gtin_class?(gtin_class)
+        prioritized_gtin_classes.include?(gtin_class)
+      end
+
+      # @param [Class] high_priority_class The higher priority GTIN class you want to move before the low priority class
+      # @param [Class] low_priority_class The low priority GTIN class that the high priority one is moved before
+      def reprioritize_before(high_priority_class, low_priority_class)
+        low_priority_index = prioritized_gtin_classes.index(low_priority_class)
+        remove_gtin_class(high_priority_class)
+        prioritized_gtin_classes.insert(low_priority_index, high_priority_class)
+        nil
+      end
+
       private
 
+      def prioritized_gtin_classes
+        @prioritized_gtin_classes ||= []
+      end
+
       def class_for_input(input)
-        [GTIN8, GTIN12, GTIN13, GTIN14].find do |klass|
-          input.to_s.size == klass::VALID_LENGTH
-        end
+        input = input.to_s.freeze
+        prioritized_gtin_classes.find { |klass| klass.handles?(input) }
       end
     end
   end
 end
+
+# Load GTIN implementations after we have our registration setup
+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"

data/lib/barcodevalidation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BarcodeValidation
-  VERSION = "2.5.0"
+  VERSION = "2.7.0"
 end

data/lib/barcodevalidation.rb

@@ -34,7 +34,7 @@ module BarcodeValidation
     include Error
 
     def initialize(input)
-      super "Invalid GTIN #{input.inspect}"
+      super("Invalid GTIN #{input.inspect}")
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: barcodevalidation
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Marketplacer
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A RubyGem to parse and validate barcodes
 email:
@@ -42,7 +41,6 @@ homepage: https://github.com/marketplacer/barcodevalidation
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -50,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Parses and validates barcodes
 test_files: []