gs1 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d50c9655be44cc5487286e9bc934f75c21f3872
-  data.tar.gz: 289498f478e765b504fb6006fbe8dcd2f7010d0b
+  metadata.gz: 524381a860829321e654f5751256113a19ba135a
+  data.tar.gz: e134536208ea7e10bce1e53ead1d2e57ea31c4a8
 SHA512:
-  metadata.gz: f411ca39dc709ba23ceef51ba78984d52dc26b2130e773ebbe767fe124796a01912db4086fe8771e231921a2da9b7b45eba83a326f215d10b487f5f12d26f9ef
-  data.tar.gz: 4067cd00f2397d755b6a44b24b15b4a53487faa55906ee4a3033fa354ad834328a0ec69417ec541312cce533466101b2472451b4500e562ddf0b92f7a2eaec1d
+  metadata.gz: fdc1e69f3e91208c624e14bb1c7300f0e81b6c1a371aa909afe44bb644b1ecef54aa8dd62fad7274fb9dc111f0a33917a85eeffcb05ce241cc52e7447148f037
+  data.tar.gz: 1b1ca6dd02ac6220a2fef92884c22f8a900030c285df815da1bc11b8890f8d347e533d2de2b11cf6e179ccfdb630f2c59839d44163ad699bb207083f3fb2d091

data/lib/gs1/barcode/base.rb

@@ -5,77 +5,33 @@ module GS1
     class Base
       include Definitions
 
-      class UnknownRecordError < StandardError; end
-
-      attr_reader :errors
-
       def initialize(options = {})
         self.class.records.each do |record|
           data = options.fetch(record.underscore_name, nil)
 
           instance_variable_set("@#{record.underscore_name}", record.new(data))
         end
+      end
 
-        @errors = []
+      def errors
+        @errors ||= []
       end
 
       class << self
-        def from_scan(barcode, separator: "\u001E")
-          new(scan_to_params(barcode, separator: separator))
-        end
-
-        def scan_to_params(barcode, separator: "\u001E")
-          data = barcode.chars
-
-          {}.tap do |params|
-            params.merge!(scan_to_param(data, separator)) until data.empty?
-          end
+        def from_scan!(barcode, separator: DEFAULT_SEPARATOR)
+          new(scan_to_params!(barcode, separator: separator))
         end
 
-        private
-
-        def scan_to_param(data, separator)
-          record = record_from_data(data)
-
-          { record.underscore_name => shift_length(data, record, separator) }
-        end
-
-        # Fetch the two first characters (interpreted as AI) from the remaining
-        # data and try to find record class. If no record class was found, fetch
-        # a third character and try again, and then finally a forth, as no AI
-        # currently have more then 4 characters.
-        def record_from_data(data)
-          ai_variants = []
-
-          record = process_ai_variants(ai_variants, data, 2) ||
-                   process_ai_variants(ai_variants, data, 1) ||
-                   process_ai_variants(ai_variants, data, 1)
-
-          return record if record
-
-          raise UnknownRecordError, "Unable to retrieve record from application identifier(s) #{ai_variants.join(', ')}"
-        end
-
-        def process_ai_variants(ai_variants, data, shifts)
-          ai_variants << ai_variants.last.to_s + data.shift(shifts).join
-
-          AI_CLASSES[ai_variants.last]
+        def from_scan(barcode, separator: DEFAULT_SEPARATOR)
+          new(scan_to_params(barcode, separator: separator))
         end
 
-        def shift_length(data, record, separator)
-          return data.shift(record.barcode_length).join if record.barcode_length
-
-          if data.find_index(separator) && data.find_index(separator) < record.barcode_max_length
-            shift_variable_length(data, separator)
-          else
-            data.shift(record.barcode_max_length).join
-          end
+        def scan_to_params!(barcode, separator: DEFAULT_SEPARATOR)
+          Tokenizer.new(barcode, separator: separator).to_params!
         end
 
-        def shift_variable_length(data, separator)
-          data.shift(data.find_index(separator)).join.tap do
-            data.shift unless data.empty? # Shift separator character
-          end
+        def scan_to_params(barcode, separator: DEFAULT_SEPARATOR)
+          Tokenizer.new(barcode, separator: separator).to_params
         end
       end
     end

data/lib/gs1/barcode/healthcare.rb

@@ -5,7 +5,7 @@ module GS1
     class Healthcare < Base
       define_records GTIN, ExpirationDate, Batch, SerialNumber
 
-      def to_s(level: AIDCMarketingLevels::ENHANCED, separator: "\u001E")
+      def to_s(level: AIDCMarketingLevels::ENHANCED, separator: DEFAULT_SEPARATOR)
         return unless valid?(level: level)
 
         [

data/lib/gs1/barcode/segment.rb

@@ -0,0 +1,126 @@
+module GS1
+  module Barcode
+    # A segment of a barcode. Retrives a single segment and keeps the rest.
+    #
+    class Segment
+      attr_reader :data, :separator
+
+      def initialize(data, separator: DEFAULT_SEPARATOR)
+        @data = data.chars
+        @separator = separator
+      end
+
+      def to_params
+        return {} unless record
+
+        { record.underscore_name => record_data }
+      end
+
+      # Fetch the two first characters (interpreted as AI) from the remaining
+      # data and try to find record class. If no record class was found, fetch
+      # a third character and try again, and then finally a forth, as no AI
+      # currently have more then 4 characters.
+      def record
+        @record ||= process_ai_variants(2) ||
+                    process_ai_variants(1) ||
+                    process_ai_variants(1)
+      end
+
+      def record_data
+        return unless record
+
+        @record_data ||= _record_data
+      end
+
+      def rest
+        record_data # Trigger segment retrieval
+
+        @data.join
+      end
+
+      def valid?
+        errors.clear
+
+        validate
+
+        errors.empty?
+      end
+
+      def validate
+        if record
+          errors << "Unable to retrieve data to #{record}" unless record_data
+        else
+          errors << "Unable to retrieve record from application identifier(s) #{ai_variants.join(', ')}"
+        end
+      end
+
+      def validate!
+        return true if valid?
+
+        raise InvalidTokenError, errors.join(', ')
+      end
+
+      def errors
+        @errors ||= []
+      end
+
+      private
+
+      def ai_variants
+        @ai_variants ||= []
+      end
+
+      def process_ai_variants(shifts)
+        return unless can_shift_ai_data?(shifts)
+
+        ai_variants << ai_variants.last.to_s + data.shift(shifts).join
+
+        AI_CLASSES[ai_variants.last]
+      end
+
+      def can_shift_ai_data?(shifts)
+        data.size >= shifts
+      end
+
+      def _record_data
+        shift_barcode_length ||
+          shift_separator_length ||
+          shift_max_barcode_length
+      end
+
+      # Record has a fixed barcode length
+      def shift_barcode_length
+        return unless record.barcode_length
+
+        shift_fixed_length(record.barcode_length)
+      end
+
+      # Record has a variable barcode length
+      def shift_separator_length
+        separator_index = data.find_index(separator)
+
+        return unless separator_index && separator_index < record.barcode_max_length
+
+        shift_fixed_length(separator_index).tap do
+          data.shift # Shift separator character
+        end
+      end
+
+      def shift_max_barcode_length
+        shift_fixed_length(record.barcode_max_length)
+      end
+
+      def shift_fixed_length(shifts)
+        normalized_shifts = [data.size, shifts].min
+
+        return unless can_shift_record_data?(normalized_shifts)
+
+        data.shift(normalized_shifts).join
+      end
+
+      def can_shift_record_data?(shifts)
+        data.size >= shifts && record.allowed_lengths.include?(shifts)
+      end
+    end
+  end
+end

data/lib/gs1/barcode/tokenizer.rb

@@ -0,0 +1,46 @@
+module GS1
+  module Barcode
+    # Class for parsing barcodes. Uses {Segment} for splitting up the individual
+    # parts.
+    #
+    class Tokenizer
+      attr_reader :data, :separator, :params
+
+      def initialize(data, separator: DEFAULT_SEPARATOR)
+        @data = data
+        @separator = separator
+        @params = {}
+      end
+
+      def to_params
+        @to_params ||= segment_to_params(data)
+      end
+
+      def to_params!
+        @to_params ||= segment_to_params(data, true)
+      end
+
+      private
+
+      def segment_to_params(input, bang = false)
+        segment_from_input(input, bang) do |segment|
+          next if segment.to_params.empty?
+
+          params.merge!(segment.to_params)
+          next if segment.rest.empty?
+
+          segment_to_params(segment.rest, bang)
+        end
+
+        params
+      end
+
+      def segment_from_input(input, bang)
+        Segment.new(input, separator: separator).tap do |segment|
+          segment.validate! if bang
+          yield segment if block_given?
+        end
+      end
+    end
+  end
+end

data/lib/gs1/barcode.rb

@@ -2,3 +2,13 @@ require 'gs1/barcode/definitions'
 
 require 'gs1/barcode/base'
 require 'gs1/barcode/healthcare'
+require 'gs1/barcode/segment'
+require 'gs1/barcode/tokenizer'
+
+module GS1
+  module Barcode
+    DEFAULT_SEPARATOR = "\u001E".freeze
+
+    class InvalidTokenError < StandardError; end
+  end
+end

data/lib/gs1/definitions.rb

@@ -2,6 +2,7 @@ module GS1
   # Module for handling definitions.
   #
   module Definitions
+    class InvalidDefinitionType < StandardError; end
     class MissingLengthDefinition < StandardError; end
     class UnknownDefinition < StandardError; end
 
@@ -37,9 +38,9 @@ module GS1
       # Defaults barcode length to allowed length if not explicitly defined, only
       # if there is one significant allowed.
       def normalize_length_options(options)
-        options[:allowed] = normalize_multiple_option(options[:allowed])
+        options[:allowed] = normalize_multiple_option(options[:allowed] || options[:barcode])
         options[:barcode] = normalize_singlural_option(options[:barcode])
-        options[:max_barcode] = normalize_singlural_option(options[:barcode] || options[:allowed])
+        options[:max_barcode] = options[:allowed]&.last
 
         options
       end
@@ -54,10 +55,11 @@ module GS1
       end
 
       def normalize_singlural_option(option_value)
-        case option_value
-        when Array then option_value.last
-        else option_value
-        end
+        return unless option_value
+
+        raise InvalidDefinitionType unless option_value.is_a?(Numeric)
+
+        option_value
       end
 
       def barcode_length

data/lib/gs1/extensions/gtin.rb

@@ -16,6 +16,8 @@ module GS1
 
       # Default to GTIN-14 since it is the most common format.
       def to_s
+        return unless data
+
         to_gtin_14
       end
     end

data/lib/gs1/record.rb

@@ -43,7 +43,7 @@ module GS1
     end
 
     def to_ai
-      "#{ai}#{to_s}" # rubocop:disable Lint/StringConversionInInterpolation
+      ai + to_s
     end
 
     def ==(other)

data/lib/gs1/version.rb

@@ -1,3 +1,3 @@
 module GS1
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gs1
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Stefan Åhman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,8 @@ files:
 - lib/gs1/barcode/base.rb
 - lib/gs1/barcode/definitions.rb
 - lib/gs1/barcode/healthcare.rb
+- lib/gs1/barcode/segment.rb
+- lib/gs1/barcode/tokenizer.rb
 - lib/gs1/batch.rb
 - lib/gs1/check_digit_calculator.rb
 - lib/gs1/content.rb