gs1 0.1.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8b0dc64a41c3fe49a82a223e72874ad311984b2d
-  data.tar.gz: 5cb771c68a729928379a46af24a3afaa97d25f23
+SHA256:
+  metadata.gz: 14ba1001a69817100cb96969f21f6471e96cce9167fb89d9eeb71592686195ea
+  data.tar.gz: d264ed32f56e3425db1e3d5063e30fc62128005a3aa1836383d2b5d2cd82699d
 SHA512:
-  metadata.gz: 957d8f5c2f904905ae3377c2899eaeba0a9a320a3d780b2fbd63a38c54b554086b9148f08eee1991b9d3250635a6c448638fbbce9ebf2758e6aee150d895e91a
-  data.tar.gz: 192af55f2f121b00bb50c6e01dbeed50aaacca4c511635f048cecd5c96ab48943f3a1013934bd077b0314c75c56f30f7165137896ea4ea137a9d7c0d5d4b16ce
+  metadata.gz: 4bdae90c963c4b50bda44b6acc4b4b4e087c9d460840d6be9f153a0235abf0b6e52b045916acba833b7183b0dc306afe34f89be54e5f3f397640367d77cc5f85
+  data.tar.gz: 9018273502be8aa631a7112aea4e48d1ae1367bcf1a0aa40aeea9cb2e7421f9973f88ad2ef630519a1e90a65de455627f89bc8e318f83637245858bfc28f6e6d

data/.ruby-version

@@ -1 +1 @@
-ruby-2.3.0
+ruby-2.6.1

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+### 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,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  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'

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/barcode/base.rb

@@ -6,17 +6,18 @@ module GS1
       include Definitions
 
       def initialize(options = {})
-        @params_order = options.keys
-
-        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

@@ -41,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(:missing)
+        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

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/version.rb

@@ -1,3 +1,3 @@
 module GS1
-  VERSION = '0.1.8'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: gs1
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Stefan Åhman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-20 00:00:00.000000000 Z
+date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +120,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -133,6 +134,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
@@ -174,8 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: A ruby gem for implementing GS1 standards