gs1 0.1.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f15d386486f27cc92e1ba01d9c3d03f0633c7ac
-  data.tar.gz: e4f0b5717132652127aafeeccdda4253d68a8201
+SHA256:
+  metadata.gz: 16ce4a66d335b1d7fa0ac83b3fdc3064390b0a3ffe74d09734b9876cdd305449
+  data.tar.gz: ab4df39306570b00b5a0da26030f7c8011358f359e86c51920290e1d645685b6
 SHA512:
-  metadata.gz: 3d3f0d9472329eafe49f3bdbf6326672c442d74b8132f07d3a21d0083d7d617fd1309af82d24ba78bd3585d61b7f6daf5ecec8fcad5f72595a29d2024afdea16
-  data.tar.gz: 03d8e6d2faf2249b3077c38d67d90535f6a82d6d2fb1aec42c71e90cf9054497ab122a89014478840420c23f0c969ea1fa2c9316ebd933e623c5d395c5521c64
+  metadata.gz: 7615850e8245725560bf4af80f68d107292a83c24e9c6b0e3c6a0f7042e2c632c23664cc37f947ed46332aada6dc3ef496319c5017bd07d5a7bc05cbca87002c
+  data.tar.gz: 0c7196620e4531ee06a32944a9cf52a9b2fa84f1012ca27210ba9084e7ed01f8edbeca4facd1aea3e487cfa368b8b2fb2434d3fecded4cc10f7013a7b9960d61

data/.gitignore

@@ -1,7 +1,7 @@
 /.bundle/
 /.yardoc
 /_yardoc/
-/coverage/
+/coverage
 /doc/
 /pkg/
 /spec/reports/

data/.ruby-gemset

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

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+2.7.0

data/.travis.yml

@@ -1,8 +1,18 @@
 ---
+env:
+  global:
+    secure: lQbZqhDx1dIuRA26K9vxaHWCwquTuJe4fuG9NEnJK1XnHWZge12NmFbGKrYrGEXsvzVRG6u4L6+MLudGT6nr1NOfOWHpA3FD73RcbBpuSrjrLGrnk1Z2OgBWQDbAMD8OszH3ciRQuqO780JZcTD3L6RULPJ6xHPcXI3UpCcQC78ZjuBjNGVPg6qBKmB6HeErj/THWiz4R4ouSo6/p4MsVS3ELqlukw1m6bx0wyyxI6sF33i5zC6V0dn7TUNrRDljNjO/bHfhYwRfabrTl0q4MzGC4rqS+CC8JXRMlCl7AHTKFeiRvSeI+Co8zidfGBCsocFAT4jshXC+NTddhtTnVbQ3GmSt6BGdfnprwbg8/GfsFE14L7IBlUDH1hzpuJYTsCQzR6+8UE8LA76z48Ttuv4of5TLAhDCCtKhRleVi9lbVuTT2xqlCTMwMWY3iH535L0Ou584BEYG7eRcdZS3rA96JWAlmuhmSVd8YBnXwhJC74eS5dJsb0qYSvCsUzfBUn7RbeWpCelnNRV4eX8n8Gn46DFSB414tAjCUL7rvIeSnouuI15lYaaqeORdGbhECnNoryxOsfPqp/zhpiT6dQW4LnF4WgMErzbyyZcVydFAB454XtM40kTEqLJ0S6bPfoYycR1yD/v4YjoH1nHB89om/zFVpB0VJ9BltMbAZJ8=
 sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.0
-  - 2.5.1
-before_install: gem install bundler -v 1.16.5
+- 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/CHANGELOG.md

@@ -0,0 +1,15 @@
+### 1.1.0 - 2021-08-23
+
+* enhancements
+  * Adds support to calculating checksum for GSIN
+
+### 1.0.0 - 2019-08-30
+
+* breaking
+  * Returns `nil` unless no attribute for barcode segment
+
+* enhancements
+  * Add errors to a barcode
+
+* bug fixes
+  * Fix `nil` argument for barcode

data/gs1.gemspec

@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'byebug', '~> 10.0'
-  spec.add_development_dependency 'rake', '~> 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'

data/lib/gs1/barcode/base.rb

@@ -6,15 +6,18 @@ module GS1
       include Definitions
 
       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))
+        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))
+          end
         end
+
+        @params_order = options.to_h.keys
       end
 
       def errors
-        @errors ||= []
+        @errors ||= Errors.new
       end
 
       class << self

data/lib/gs1/barcode/definitions.rb

@@ -5,6 +5,7 @@ module GS1
     module Definitions
       def self.included(base)
         base.extend ClassMethods
+        base.send :include, InstanceMethods
       end
 
       # Adding defintion class methods.
@@ -21,6 +22,27 @@ 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/error.rb

@@ -0,0 +1,30 @@
+module GS1
+  module Barcode
+    # Error wrapper class for a barcode.
+    #
+    class Error
+      attr_reader :message
+
+      def initialize(message, persistent: false)
+        @message = message
+        @persistent = persistent
+      end
+
+      def persistent?
+        @persistent
+      end
+
+      def human_message
+        message.to_s.tr('_', ' ').capitalize
+      end
+
+      def hash
+        message.hash
+      end
+
+      def eql?(other)
+        @message == other.message
+      end
+    end
+  end
+end

data/lib/gs1/barcode/errors.rb

@@ -0,0 +1,41 @@
+module GS1
+  module Barcode
+    # Error collection handler wrapper class for a barcode.
+    #
+    class Errors
+      attr_reader :errors
+
+      def initialize
+        @errors = {}
+      end
+
+      def [](attribute_name)
+        errors[attribute_name] ||= []
+      end
+
+      def clear
+        errors.each_value do |errs|
+          errs.select!(&:persistent?)
+        end
+      end
+
+      def empty?
+        errors.values.flatten.empty?
+      end
+
+      def messages
+        errors.each_with_object({}) do |(attribute_name, errors), hash|
+          hash[attribute_name] = errors.uniq.map(&:human_message)
+        end
+      end
+
+      def full_messages
+        errors.flat_map do |(attribute_name, errors)|
+          errors.uniq.map do |error|
+            "#{error.human_message} #{attribute_name.to_s.tr('_', ' ')}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gs1/barcode/healthcare.rb

@@ -8,13 +8,14 @@ module GS1
       def to_s(level: AIDCMarketingLevels::ENHANCED, separator: GS1.configuration.barcode_separator)
         return unless valid?(level: level)
 
-        [
-          gtin.to_ai,
-          expiration_date&.to_ai,
-          batch&.to_ai,
-          separator,
-          serial_number&.to_ai
-        ].compact.join
+        @params_order.each_with_object('') do |param, out|
+          record = send(param)
+
+          next unless record.to_ai
+
+          out << record.to_ai
+          out << separator if record.class.separator? && param != @params_order.last
+        end
       end
 
       def valid?(level: AIDCMarketingLevels::ENHANCED)
@@ -40,16 +41,26 @@ module GS1
       end
 
       def validate_minimum
-        errors << 'Invalid gtin' unless gtin.valid?
+        validate_attribute(:gtin)
       end
 
       def validate_enhanced
-        errors << 'Invalid batch' unless batch&.valid?
-        errors << 'Invalid expiration date' unless expiration_date&.valid?
+        validate_attribute(:batch)
+        validate_attribute(:expiration_date)
       end
 
       def validate_highest
-        errors << 'Invalid serial number' unless serial_number&.valid?
+        validate_attribute(:serial_number)
+      end
+
+      def validate_attribute(attribute_name)
+        attribute = public_send(attribute_name)
+
+        if attribute.nil?
+          errors[attribute_name] << Error.new(:blank)
+        elsif !attribute.valid?
+          errors[attribute_name] << Error.new(:invalid)
+        end
       end
     end
   end

data/lib/gs1/barcode/segment.rb

@@ -6,14 +6,14 @@ module GS1
       attr_reader :data, :separator
 
       def initialize(data, separator: GS1.configuration.barcode_separator)
-        @data = data.chars
+        @data = data.to_s.chars
         @separator = separator
       end
 
       def to_params
-        return {} unless record
+        return [] unless record
 
-        { record.underscore_name => record_data }
+        [record.underscore_name, record_data]
       end
 
       # Fetch the two first characters (interpreted as AI) from the remaining
@@ -99,7 +99,7 @@ module GS1
       def shift_separator_length
         separator_index = data.find_index(separator)
 
-        return unless separator_index && separator_index < record.barcode_max_length
+        return unless separator_index && separator_index <= record.barcode_max_length
 
         shift_fixed_length(separator_index).tap do
           data.shift # Shift separator character

data/lib/gs1/barcode/tokenizer.rb

@@ -9,7 +9,7 @@ module GS1
       def initialize(data, separator: GS1.configuration.barcode_separator)
         @data = data
         @separator = separator
-        @params = {}
+        @params = []
       end
 
       def to_params
@@ -26,7 +26,8 @@ module GS1
         segment_from_input(input, bang) do |segment|
           next if segment.to_params.empty?
 
-          params.merge!(segment.to_params)
+          params << segment.to_params
+
           next if segment.rest.empty?
 
           segment_to_params(segment.rest, bang)

data/lib/gs1/barcode.rb

@@ -1,4 +1,6 @@
 require 'gs1/barcode/definitions'
+require 'gs1/barcode/error'
+require 'gs1/barcode/errors'
 
 require 'gs1/barcode/base'
 require 'gs1/barcode/healthcare'

data/lib/gs1/batch.rb

@@ -29,5 +29,6 @@ module GS1
     AI = AI::BATCH_LOT
 
     define :length, allowed: 1..20
+    define :separator
   end
 end

data/lib/gs1/check_digit_calculator.rb

@@ -7,7 +7,7 @@ module GS1
   #
   class CheckDigitCalculator
     MULTIPLIER_ARRAY = [3, 1] * 9
-    VALID_LENGTHS = [7, 11, 12, 13, 17].freeze
+    VALID_LENGTHS = [7, 11, 12, 13, 16, 17].freeze
 
     def initialize(sequence)
       @sequence = sequence

data/lib/gs1/definitions.rb

@@ -15,7 +15,7 @@ module GS1
     module ClassMethods
       attr_reader :definitions
 
-      DEFINITIONS = %i[check_digit date date_month_based length].freeze
+      DEFINITIONS = %i[check_digit date date_month_based length separator].freeze
 
       def define(key, options = {})
         raise UnknownDefinition, "#{key} is not a valid definition" unless DEFINITIONS.include?(key)
@@ -40,6 +40,11 @@ module GS1
         {}
       end
 
+      # Boolean value
+      def normalize_separator_options(_options)
+        true
+      end
+
       # Defaults barcode length to allowed length if not explicitly defined, only
       # if there is one significant allowed.
       def normalize_length_options(options)
@@ -67,6 +72,10 @@ module GS1
         option_value
       end
 
+      def separator?
+        definitions[:separator]
+      end
+
       def barcode_length
         lengths[:barcode]
       end

data/lib/gs1/serial_number.rb

@@ -27,5 +27,6 @@ module GS1
     AI = AI::SERIAL
 
     define :length, allowed: 1..20
+    define :separator
   end
 end

data/lib/gs1/validations.rb

@@ -39,6 +39,8 @@ module GS1
 
       def validate
         self.class.definitions.each_key do |definition|
+          next if definition == :separator
+
           public_send("validate_#{definition}")
         end
       end

data/lib/gs1/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gs1
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Stefan Åhman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-02 00:00:00.000000000 Z
+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: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -42,14 +42,14 @@ dependencies:
   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
@@ -118,8 +118,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -133,6 +135,8 @@ files:
 - lib/gs1/barcode.rb
 - lib/gs1/barcode/base.rb
 - lib/gs1/barcode/definitions.rb
+- lib/gs1/barcode/error.rb
+- lib/gs1/barcode/errors.rb
 - lib/gs1/barcode/healthcare.rb
 - lib/gs1/barcode/segment.rb
 - lib/gs1/barcode/tokenizer.rb
@@ -159,7 +163,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -174,9 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A ruby gem for implementing GS1 standards
 test_files: []