gs1 1.1.0 → 2.0.1

data/lib/gs1/record.rb

@@ -15,7 +15,10 @@ module GS1
     @descendants = []
 
     class << self
+      def generated = false
+
       def inherited(subclass)
+        super
         descendants << subclass
       end
 

data/lib/gs1/syntax_dictionary/parser.rb

@@ -0,0 +1,223 @@
+require 'gs1/syntax_dictionary/specification_parser'
+
+module GS1
+  module SyntaxDictionary
+    # Parser for the GS1 syntax dictionary.
+    #
+    # The latest version of the syntax dictionary is available at:
+    # https://ref.gs1.org/tools/gs1-barcode-syntax-resource/syntax-dictionary.
+    #
+    # The syntax dictionary has been copied to gs1-syntax-dictionary.txt. The
+    # format of the syntax dictionary is available at the top of the dictionary.
+    class Parser
+      # Some generic String helpers.
+      module StringHelpers
+        refine String do
+          def blank? = empty? || /\A[[:space:]]*\z/.match?(self)
+
+          def comment? = start_with?('#')
+        end
+      end
+
+      using StringHelpers
+
+      # Corresponds to a single entry in the syntax dictionary.
+      class Entry
+        # @return [String] the application identifier
+        attr_reader :ai
+
+        # @return [Boolean] indicates if a separator is required or not
+        attr_reader :separator_required
+
+        # @return [Range<Integer>] the length of the AI
+        attr_reader :length
+
+        # @return [String] the title of the AI
+        attr_reader :title
+
+        # rubocop:disable Naming/MethodParameterName
+        def initialize(ai:, separator_required:, length:, title:)
+          # rubocop:enable Naming/MethodParameterName
+          @ai = ai
+          @separator_required = separator_required
+          @length = length
+          @title = title
+        end
+      end
+
+      # @param data [String] the syntax dictionary data to parse
+      def initialize(data)
+        @data = data
+      end
+
+      # Parses the syntax dictionary data and returns a list of dictionary
+      # entries.
+      #
+      # @return [Array<Entry>] a list of syntax dictionary entries
+      def parse = entry_lines.flat_map { parse_line(_1) }
+
+      private
+
+      attr_reader :data
+
+      def lines = @lines ||= data.split("\n")
+
+      def entry_lines = @entry_lines ||= lines.reject { _1.comment? || _1.blank? }
+
+      def columns(line_data)
+        line_data.match(column_patterns.entry_rx)
+                 &.named_captures
+                 &.values_at(*%w[ais flags spec title]) or
+          raise "Invalid entry format: #{line_data}"
+      end
+
+      def parse_line(line_data)
+        ais, flags, specification, base_title = columns(line_data)
+
+        parse_ais(ais, base_title).map do |(ai, title)|
+          Entry.new(
+            ai: ai,
+            separator_required: separator_required?(flags),
+            length: SpecificationParser.new(specification).parse,
+            title: title
+          )
+        end
+      end
+
+      def parse_ais(ai_data, base_title)
+        first, last = ai_data.split('-')
+        last ||= first
+        range = first..last
+        range.map { [_1, build_title(range, base_title, _1)] }
+      end
+
+      def build_title(ai_range, base_title, current_ai)
+        if ai_range.count == 1
+          base_title || current_ai
+        else
+          base_title ? "#{base_title}_#{current_ai}" : current_ai
+        end
+      end
+
+      def separator_required?(flags) = !flags.include?('*')
+
+      def column_patterns = @column_patterns ||= ColumnPatterns.new
+
+      # Patterns stolen from: https://github.com/gs1/gs1-syntax-engine/blob/f8b6345655fa9fa25ce1c5a11c5a317f9239529a/src/c-lib/build-embedded-ai-table.pl#L17-L100
+      # The naming and extra indentation is to keep the code as close to the
+      # original Perl code above.
+      #
+      # rubocop:disable Lint/DuplicateRegexpCharacterClassElement
+      # rubocop:disable Style/RegexpLiteral
+      class ColumnPatterns
+        # rubocop:disable Metrics/MethodLength
+        def entry_rx
+          /
+              ^
+              (?<ais>#{ai_rng_rx})
+              (
+                  \s+
+                  (?<flags>#{flags_rx})
+              )?
+              \s+
+              (?<spec>#{spec_rx})
+              (
+                  \s+
+                  (?<keyvals>
+                      (#{keyval_rx}\s+)*
+                      #{keyval_rx}
+                  )
+              )?
+              (
+                  \s+
+                  \#
+                  \s
+                  (?<title>#{title_rx})
+              )?
+              \s*
+              $
+          /x
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        def ai_rx
+          /
+              (
+                  (0\d)
+              |
+                  ([1-9]\d{1,3})
+              )
+          /x
+        end
+
+        def ai_rng_rx = /#{ai_rx}(-#{ai_rx})?/
+
+        def flags_rx
+          /
+              [
+                  *?!"%&'()+,.:;<=>@\[_`{|}~
+                  \$  \-  \/  \\  \]  \^
+              ]+
+          /x
+        end
+
+        def type_mand_rx
+          /
+              [XNYZ]
+              (
+                  ([1-9]\d?)
+                  |
+                  (\.\.[1-9]\d?)
+              )
+          /x
+        end
+
+        def type_opt_rx
+          /
+              \[#{type_mand_rx}\]
+          /x
+        end
+
+        def type_rx
+          /
+              (
+                  #{type_mand_rx}
+                  |
+                  #{type_opt_rx}
+              )
+          /x
+        end
+
+        def comp_rx
+          /
+              #{type_rx}
+              (,\w+)*
+          /x
+        end
+
+        def spec_rx
+          /
+              #{comp_rx}
+              (\s+#{comp_rx})*
+          /x
+        end
+
+        def keyval_rx
+          /
+              (
+                  (\w+)
+                  |
+                  (\w+=\S+)
+              )
+          /x
+        end
+
+        def title_rx = /\S.*\S/
+      end
+      # rubocop:enable Lint/DuplicateRegexpCharacterClassElement
+      # rubocop:enable Style/RegexpLiteral
+    end
+  end
+end

data/lib/gs1/syntax_dictionary/specification_parser.rb

@@ -0,0 +1,74 @@
+require 'English'
+require 'gs1/syntax_dictionary/specification_parser'
+
+module GS1
+  module SyntaxDictionary
+    # Parses the specification column.
+    class SpecificationParser
+      def initialize(specification_data)
+        @data = specification_data
+      end
+
+      # @return [Range<Integer>] returns the length
+      def parse
+        lengths = components
+                  .map { parse_component(_1) }
+                  .reduce(Length.new(0, 0), :+)
+
+        lengths.min..lengths.max
+      end
+
+      private
+
+      class Length
+        attr_reader :min, :max
+
+        def initialize(min, max)
+          @min = min
+          @max = max
+        end
+
+        def +(other) = Length.new(other.calculate_min(min), max + other.max)
+
+        def calculate_min(other_min) = other_min + min
+      end
+
+      private_constant :Length
+
+      class OptionalLength < Length
+        def calculate_min(other_min) = other_min
+      end
+
+      private_constant :OptionalLength
+
+      attr_reader :data
+
+      def components = @components ||= data.split
+
+      # rubocop:disable Metrics/MethodLength
+      def parse_component(component)
+        types = 'NXYZ'
+        fixed = /^[#{types}](?<length>\d+)/
+        fixed_optional = /^\[[#{types}](?<length>\d+)\]/
+        variable = /^[#{types}]\.\.(?<length>\d+)/
+        variable_optional = /^\[[#{types}]\.\.(?<length>\d+)\]/
+
+        case component
+        when fixed
+          length = $LAST_MATCH_INFO[:length].to_i
+          Length.new(length, length)
+        when fixed_optional
+          length = $LAST_MATCH_INFO[:length].to_i
+          OptionalLength.new(length, length)
+        when variable
+          Length.new(1, $LAST_MATCH_INFO[:length].to_i)
+        when variable_optional
+          OptionalLength.new(1, $LAST_MATCH_INFO[:length].to_i)
+        else
+          raise "Invalid format for component of specification column: #{component}"
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+  end
+end

data/lib/gs1/version.rb

@@ -1,3 +1,3 @@
 module GS1
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.0.1'.freeze
 end

data/lib/gs1.rb

@@ -1,21 +1,3 @@
-require 'gs1/version'
-
-require 'gs1/ai'
-require 'gs1/check_digit_calculator'
-require 'gs1/extensions'
-require 'gs1/definitions'
-require 'gs1/validations'
-
-require 'gs1/record'
-require 'gs1/batch'
-require 'gs1/content'
-require 'gs1/expiration_date'
-require 'gs1/gtin'
-require 'gs1/serial_number'
-require 'gs1/sscc'
-
-require 'gs1/barcode'
-
 # GS1 module.
 #
 module GS1
@@ -36,16 +18,27 @@ module GS1
   # Configuration holds custom configuration parameters.
   #
   class Configuration
-    attr_accessor :company_prefix
+    attr_accessor :company_prefix, :ignore_extra_barcode_elements
     attr_writer :barcode_separator
 
+    def initialize
+      @ignore_extra_barcode_elements = true
+    end
+
     def barcode_separator
       @barcode_separator || GS1::Barcode::DEFAULT_SEPARATOR
     end
   end
 
-  AI_CLASSES = GS1::Record.descendants.each_with_object({}) do |klass, hash|
-    hash[klass.ai] = klass
+  def self.ai_classes
+    @ai_classes ||= begin
+      GeneratedAIClasses.ai_classes
+      # sort to get non-generated classes first
+      ai_classes = GS1::Record.descendants.sort_by { _1.generated ? 1 : 0 }
+      ai_classes.each_with_object({}) do |klass, hash|
+        hash[klass.ai] ||= klass
+      end
+    end
   end
 
   module AIDCMarketingLevels
@@ -54,3 +47,22 @@ module GS1
            HIGHEST = 3].freeze
   end
 end
+
+require 'gs1/version'
+
+require 'gs1/ai'
+require 'gs1/check_digit_calculator'
+require 'gs1/extensions'
+require 'gs1/definitions'
+require 'gs1/validations'
+
+require 'gs1/record'
+require 'gs1/generated_ai_classes'
+require 'gs1/batch'
+require 'gs1/content'
+require 'gs1/expiration_date'
+require 'gs1/gtin'
+require 'gs1/serial_number'
+require 'gs1/sscc'
+
+require 'gs1/barcode'

metadata

@@ -1,113 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gs1
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Stefan Åhman
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: 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: rb-readline
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.49.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: GS1 defines a set of GS1 standards directly from the documentation
 email:
 - stefan.ahman@apoex.se
@@ -115,24 +16,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - gs1.gemspec
 - lib/gs1.rb
 - lib/gs1/ai.rb
 - lib/gs1/barcode.rb
+- lib/gs1/barcode/attribute_validator.rb
+- lib/gs1/barcode/attribute_validators/ignoring_record_validator.rb
+- lib/gs1/barcode/attribute_validators/record_validator.rb
 - lib/gs1/barcode/base.rb
 - lib/gs1/barcode/definitions.rb
 - lib/gs1/barcode/error.rb
@@ -149,10 +43,13 @@ files:
 - lib/gs1/extensions/date.rb
 - lib/gs1/extensions/date_month_based.rb
 - lib/gs1/extensions/gtin.rb
+- lib/gs1/generated_ai_classes.rb
 - lib/gs1/gtin.rb
 - lib/gs1/record.rb
 - lib/gs1/serial_number.rb
 - lib/gs1/sscc.rb
+- lib/gs1/syntax_dictionary/parser.rb
+- lib/gs1/syntax_dictionary/specification_parser.rb
 - lib/gs1/validations.rb
 - lib/gs1/validations/check_digit_validation.rb
 - lib/gs1/validations/date_validation.rb
@@ -163,7 +60,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -171,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A ruby gem for implementing GS1 standards
 test_files: []

data/.gitignore

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-Gemfile.lock
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.3
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-    - 'gs1.gemspec'
-
-Metrics/LineLength:
-  Max: 120
-
-Style/FrozenStringLiteralComment:
-  Enabled: false

data/.ruby-gemset

@@ -1 +0,0 @@
-gs1

data/.ruby-version

@@ -1 +0,0 @@
-2.7.0

data/.travis.yml

@@ -1,18 +0,0 @@
----
-env:
-  global:
-    secure: lQbZqhDx1dIuRA26K9vxaHWCwquTuJe4fuG9NEnJK1XnHWZge12NmFbGKrYrGEXsvzVRG6u4L6+MLudGT6nr1NOfOWHpA3FD73RcbBpuSrjrLGrnk1Z2OgBWQDbAMD8OszH3ciRQuqO780JZcTD3L6RULPJ6xHPcXI3UpCcQC78ZjuBjNGVPg6qBKmB6HeErj/THWiz4R4ouSo6/p4MsVS3ELqlukw1m6bx0wyyxI6sF33i5zC6V0dn7TUNrRDljNjO/bHfhYwRfabrTl0q4MzGC4rqS+CC8JXRMlCl7AHTKFeiRvSeI+Co8zidfGBCsocFAT4jshXC+NTddhtTnVbQ3GmSt6BGdfnprwbg8/GfsFE14L7IBlUDH1hzpuJYTsCQzR6+8UE8LA76z48Ttuv4of5TLAhDCCtKhRleVi9lbVuTT2xqlCTMwMWY3iH535L0Ou584BEYG7eRcdZS3rA96JWAlmuhmSVd8YBnXwhJC74eS5dJsb0qYSvCsUzfBUn7RbeWpCelnNRV4eX8n8Gn46DFSB414tAjCUL7rvIeSnouuI15lYaaqeORdGbhECnNoryxOsfPqp/zhpiT6dQW4LnF4WgMErzbyyZcVydFAB454XtM40kTEqLJ0S6bPfoYycR1yD/v4YjoH1nHB89om/zFVpB0VJ9BltMbAZJ8=
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-- 2.5.1
-- 2.7.0
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rake
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in gs1.gemspec
-gemspec

data/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'gs1'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require 'pry'
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here