gs1 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16ce4a66d335b1d7fa0ac83b3fdc3064390b0a3ffe74d09734b9876cdd305449
-  data.tar.gz: ab4df39306570b00b5a0da26030f7c8011358f359e86c51920290e1d645685b6
+  metadata.gz: 8e902d0a871c447d704c90970bb54e21cb6608a34ef77ef8fca7515b605bd833
+  data.tar.gz: 874725a50d5a89582e06f2bee8adce07a98f7583c79fd10026fb75cd75fa8e1b
 SHA512:
-  metadata.gz: 7615850e8245725560bf4af80f68d107292a83c24e9c6b0e3c6a0f7042e2c632c23664cc37f947ed46332aada6dc3ef496319c5017bd07d5a7bc05cbca87002c
-  data.tar.gz: 0c7196620e4531ee06a32944a9cf52a9b2fa84f1012ca27210ba9084e7ed01f8edbeca4facd1aea3e487cfa368b8b2fb2434d3fecded4cc10f7013a7b9960d61
+  metadata.gz: 876b0b4d0923c166a38affb96b274f9fe799fddf15d0ac75fdd472e2cc02907816e336fb300e2881ecdf191f4a02599b44abf2f4c9f46f3a8c878a8204a4de21
+  data.tar.gz: 50bb2bcd58750950edd5bc2dcfc512d4c9e09af725809a467f3432ab7a69b754d167930111c73d6d194f74a886def551b8e350516e3e93c13d0015b37eca9cc7

data/CHANGELOG.md

@@ -1,15 +1,54 @@
-### 1.1.0 - 2021-08-23
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* enhancements
-  * Adds support to calculating checksum for GSIN
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-### 1.0.0 - 2019-08-30
+## [Unreleased]
 
-* breaking
-  * Returns `nil` unless no attribute for barcode segment
+## [2.0.0] - 2025-04-22
+### Changed
+- Minimum supported version of Ruby is now 3.0.5 (breaking change)
 
-* enhancements
-  * Add errors to a barcode
+- Extra elements in barcodes are now ignored (breaking change). Set the
+    `ignore_extra_barcode_elements` configuration option to `false` to restore
+    previous behavior
 
-* bug fixes
-  * Fix `nil` argument for barcode
+- AI classes are lazy loaded now (possibly breaking change)
+
+### Added
+- Add a new option (`ignore_extra_barcode_elements`) to configure if extra
+    elements in barcodes should be reported as an error or ignored. By default,
+    ignore
+
+- Added the `GS1.ai_classes` method. This contains all AI classes. This is the
+    same as `GS1::AI_CLASSES` from previous versions, buy lazy loaded
+
+- All application identifiers (as of 2025-01-30) are now recognized
+
+### Removed
+- Removed the `GS1::AI_CLASSES` constant. Use `GS1.ai_classes` instead
+- The following classes have been removed: `GS1::Batch` and `GS1::SerialNumber`.
+    They have been replaced with generated anonymous classes.
+
+## [1.1.0] - 2021-08-23
+
+### Added
+- Adds support to calculating checksum for GSIN
+
+## [1.0.0] - 2019-08-30
+
+### Changed
+- Returns `nil` unless no attribute for barcode segment (breaking change)
+
+### Added
+- Add errors to a barcode
+
+### Fixed
+- Fix `nil` argument for barcode
+
+[Unreleased]: https://github.com/apoex/gs1/compare/v2.0.0...HEAD
+
+[2.0.0]: https://github.com/apoex/gs1/compare/v1.1.0...v2.0.0
+[1.1.0]: https://github.com/apoex/gs1/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/apoex/gs1/releases/tag/v1.0.0

data/README.md

@@ -30,6 +30,7 @@ There are some configuration you can do before start using this lib.
 GS1.configure do |config|
   config.company_prefix = '123456789'
   config.barcode_separator = '~' # Default is "\u001E"
+  config.ignore_extra_barcode_elements = false # Default is true
 end
 ```
 
@@ -77,18 +78,79 @@ GS1::Barcode::Healthcare.from_scan("01034531200000111719112510ABCD1234\u001E2110
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+### Creating a Release
+
+#### Update the Changelog
+
+1. Rename the [Unreleased] section to match the version that is being released
+1. Add the current date in the section from previous step. See existing entries
+1. Add a new section for the `Unreleased` section at the top
+1. Add a new reference link for the new section at the bottom of the changelog
+1. Update the `Unreleased` reference link at the bottom of the changelog
+
+#### Publish New Version of Gem
+
+To publish a new version of this gem, follow the steps below:
+
+1. Update the version in the [version.rb](lib/gs1/version.rb) file
+1. Run `bundle` to update Gemfile.lock
+1. Commit and push the changes
+
+1. Run `rake release:initiate`. This initiates a new release by creating a Git
+    tag with the version specified in [version.rb](lib/gs1/version.rb). It will
+    then push the Git tag. This will trigger a job in the CI pipeline, which
+    will build the gem and publish it to https://rubygems.org. It will also
+    create a GitHub Release, in draft mode
+
+1. Check the GitHub Release and then publish it
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/apoex/gs1. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/apoex/gs1. This project is intended to be a safe, welcoming
+space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+### Changelog
+
+The changelog is maintained in the [CHANGELOG.md](CHANGELOG.md) file, following
+the [Keep a Changelog] format. The changelog is updated incrementally. That is,
+for every new feature or bugfix, add an entry to the changelog. New entries are
+added below the [Unreleased] section, with an appropriate sub header.
+
+### Update Known Application Identifiers
+
+1. Download the latest version of the [GS1 syntax dictionary](gs1_syntax_dictionary)
+
+1. Place the syntax dictionary in the
+    [gs1-syntax-dictionary.txt](gs1-syntax-dictionary.txt) file
+
+1. Run the script to generate the AI classes from the syntax
+    dictionary: [`./bin/generate_ai_classes`](bin/generate_ai_classes)
+
+1. Commit all changed files
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Gs1 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/apoex/gs1/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Gs1 project’s codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the [code of
+conduct](https://github.com/apoex/gs1/blob/master/CODE_OF_CONDUCT.md).
+
+[gs1_syntax_dictionary]: https://ref.gs1.org/tools/gs1-barcode-syntax-resource/syntax-dictionary
+[Keep a Changelog]: https://keepachangelog.com/en/1.1.0
+[Unreleased]: https://github.com/apoex/gs1/blob/master/CHANGELOG.md#unreleased

data/gs1.gemspec

@@ -19,24 +19,21 @@ Gem::Specification.new do |spec|
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`
+      .split("\x0")
+      .filter { _1.start_with?('lib') } +
+      %w[gs1.gemspec CHANGELOG.md CODE_OF_CONDUCT.md LICENSE.txt README.md]
   end
   spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = '>= 3.0.5'
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'byebug', '~> 10.0'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'rb-readline', '~> 0.1'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49.0'
-  spec.add_development_dependency 'simplecov', '~> 0.1'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/gs1/barcode/attribute_validator.rb

@@ -0,0 +1,33 @@
+module GS1
+  module Barcode
+    class AttributeValidator
+      def self.for(configuration:)
+        attribute_record_validator = if configuration.ignore_extra_barcode_elements
+                                       AttributeValidators::IgnoringRecordValidator
+                                     else
+                                       AttributeValidators::RecordValidator
+                                     end
+
+        new(attribute_record_validator: attribute_record_validator.new)
+      end
+
+      def initialize(attribute_record_validator: AttributeValidators::IgnoringRecordValidator.new)
+        @attribute_record_validator = attribute_record_validator
+      end
+
+      def validate_data(barcode, attribute_name)
+        return unless barcode.instance_variable_get("@#{attribute_name}")
+
+        barcode.errors[attribute_name] << Error.new(:already_defined, persistent: true)
+      end
+
+      def validate_record(barcode, attribute_name, &block)
+        attribute_record_validator.validate(barcode, attribute_name, &block)
+      end
+
+      private
+
+      attr_reader :attribute_record_validator
+    end
+  end
+end

data/lib/gs1/barcode/attribute_validators/ignoring_record_validator.rb

@@ -0,0 +1,11 @@
+module GS1
+  module Barcode
+    module AttributeValidators
+      class IgnoringRecordValidator < RecordValidator
+        private
+
+        def on_error(_barcode, _attribute_name); end
+      end
+    end
+  end
+end

data/lib/gs1/barcode/attribute_validators/record_validator.rb

@@ -0,0 +1,24 @@
+module GS1
+  module Barcode
+    module AttributeValidators
+      class RecordValidator
+        def validate(barcode, attribute_name)
+          barcode.class.records.find { |r| r.underscore_name == attribute_name }.tap do |record|
+            if record
+              yield record
+              next
+            end
+
+            on_error(barcode, attribute_name)
+          end
+        end
+
+        private
+
+        def on_error(barcode, attribute_name)
+          barcode.errors[attribute_name] << Error.new(:unknown_attribute, persistent: true)
+        end
+      end
+    end
+  end
+end

data/lib/gs1/barcode/base.rb

@@ -5,15 +5,16 @@ module GS1
     class Base
       include Definitions
 
-      def initialize(options = {})
-        options.each do |(attribute_name, data)|
-          validate_attribute_data(attribute_name)
-          validate_attribute_record(attribute_name) do |record|
-            instance_variable_set("@#{attribute_name}", record.new(data))
+      def initialize(attributes = {}, options = {})
+        attribute_validator = options[:attribute_validator] || AttributeValidator.new
+        attributes.each do |(name, data)|
+          attribute_validator.validate_data(self, name)
+          attribute_validator.validate_record(self, name) do |record|
+            instance_variable_set("@#{name}", record.new(data))
           end
         end
 
-        @params_order = options.to_h.keys
+        @params_order = attributes.to_h.keys
       end
 
       def errors
@@ -21,20 +22,33 @@ module GS1
       end
 
       class << self
-        def from_scan!(barcode, separator: GS1.configuration.barcode_separator)
-          new(scan_to_params!(barcode, separator: separator))
+        def for(attributes, configuration:)
+          attribute_validator = AttributeValidator.for(configuration: configuration)
+          new(attributes, attribute_validator: attribute_validator)
         end
 
-        def from_scan(barcode, separator: GS1.configuration.barcode_separator)
-          new(scan_to_params(barcode, separator: separator))
+        def from_scan!(barcode, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
+          self.for(
+            scan_to_params!(barcode, separator: separator, ai_classes: ai_classes),
+            configuration: GS1.configuration
+          )
         end
 
-        def scan_to_params!(barcode, separator: GS1.configuration.barcode_separator)
-          Tokenizer.new(barcode, separator: separator).to_params!
+        def from_scan(barcode, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
+          self.for(
+            scan_to_params(barcode, separator: separator, ai_classes: ai_classes),
+            configuration: GS1.configuration
+          )
         end
 
-        def scan_to_params(barcode, separator: GS1.configuration.barcode_separator)
-          Tokenizer.new(barcode, separator: separator).to_params
+        def scan_to_params!(barcode, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
+          Tokenizer.new(barcode, separator: separator, ai_classes: ai_classes)
+                   .to_params!
+        end
+
+        def scan_to_params(barcode, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
+          Tokenizer.new(barcode, separator: separator, ai_classes: ai_classes)
+                   .to_params
         end
       end
     end

data/lib/gs1/barcode/definitions.rb

@@ -5,7 +5,6 @@ module GS1
     module Definitions
       def self.included(base)
         base.extend ClassMethods
-        base.send :include, InstanceMethods
       end
 
       # Adding defintion class methods.
@@ -22,27 +21,6 @@ module GS1
           end
         end
       end
-
-      # Adding defintion instance methods.
-      #
-      module InstanceMethods
-        def validate_attribute_data(attribute_name)
-          return unless instance_variable_get("@#{attribute_name}")
-
-          errors[attribute_name] << Error.new(:already_defined, persistent: true)
-        end
-
-        def validate_attribute_record(attribute_name)
-          self.class.records.find { |r| r.underscore_name == attribute_name }.tap do |record|
-            if record
-              yield record
-              next
-            end
-
-            errors[attribute_name] << Error.new(:unknown_attribute, persistent: true)
-          end
-        end
-      end
     end
   end
 end

data/lib/gs1/barcode/errors.rb

@@ -24,8 +24,8 @@ module GS1
       end
 
       def messages
-        errors.each_with_object({}) do |(attribute_name, errors), hash|
-          hash[attribute_name] = errors.uniq.map(&:human_message)
+        errors.transform_values do |errors|
+          errors.uniq.map(&:human_message)
         end
       end
 

data/lib/gs1/barcode/healthcare.rb

@@ -57,7 +57,7 @@ module GS1
         attribute = public_send(attribute_name)
 
         if attribute.nil?
-          errors[attribute_name] << Error.new(:blank)
+          errors[attribute_name] << Error.new(:missing)
         elsif !attribute.valid?
           errors[attribute_name] << Error.new(:invalid)
         end

data/lib/gs1/barcode/segment.rb

@@ -5,9 +5,10 @@ module GS1
     class Segment
       attr_reader :data, :separator
 
-      def initialize(data, separator: GS1.configuration.barcode_separator)
+      def initialize(data, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
         @data = data.to_s.chars
         @separator = separator
+        @ai_classes = ai_classes
       end
 
       def to_params
@@ -66,6 +67,8 @@ module GS1
 
       private
 
+      attr_reader :ai_classes
+
       def ai_variants
         @ai_variants ||= []
       end
@@ -73,9 +76,9 @@ module GS1
       def process_ai_variants(shifts)
         return unless can_shift_ai_data?(shifts)
 
-        ai_variants << ai_variants.last.to_s + data.shift(shifts).join
+        ai_variants << (ai_variants.last.to_s + data.shift(shifts).join)
 
-        AI_CLASSES[ai_variants.last]
+        ai_classes[ai_variants.last]
       end
 
       def can_shift_ai_data?(shifts)

data/lib/gs1/barcode/tokenizer.rb

@@ -6,10 +6,11 @@ module GS1
     class Tokenizer
       attr_reader :data, :separator, :params
 
-      def initialize(data, separator: GS1.configuration.barcode_separator)
+      def initialize(data, separator: GS1.configuration.barcode_separator, ai_classes: GS1.ai_classes)
         @data = data
         @separator = separator
         @params = []
+        @ai_classes = ai_classes
       end
 
       def to_params
@@ -22,7 +23,11 @@ module GS1
 
       private
 
+      attr_reader :ai_classes
+
+      # rubocop:disable Style/OptionalBooleanParameter
       def segment_to_params(input, bang = false)
+        # rubocop:enable Style/OptionalBooleanParameter
         segment_from_input(input, bang) do |segment|
           next if segment.to_params.empty?
 
@@ -37,7 +42,7 @@ module GS1
       end
 
       def segment_from_input(input, bang)
-        Segment.new(input, separator: separator).tap do |segment|
+        Segment.new(input, separator: separator, ai_classes: ai_classes).tap do |segment|
           segment.validate! if bang
           yield segment if block_given?
         end

data/lib/gs1/barcode.rb

@@ -1,3 +1,6 @@
+require 'gs1/barcode/attribute_validator'
+require 'gs1/barcode/attribute_validators/record_validator'
+require 'gs1/barcode/attribute_validators/ignoring_record_validator'
 require 'gs1/barcode/definitions'
 require 'gs1/barcode/error'
 require 'gs1/barcode/errors'

data/lib/gs1/extensions/date.rb

@@ -14,7 +14,7 @@ module GS1
         if date.respond_to?(:strftime)
           super(date.strftime('%y%m%d'))
         else
-          super(date)
+          super
         end
       end
 

data/lib/gs1/extensions/date_month_based.rb

@@ -34,7 +34,7 @@ module GS1
         if date.respond_to?(:strftime)
           super(date.strftime('%y%m%d'))
         else
-          super(date)
+          super
         end
       end