gs1 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9fad86db4d7ac36e936b37b63976378628f9b8d
-  data.tar.gz: 1eeca0b54c00df6f1ff54108ad5aa799477c1df5
+  metadata.gz: 2f15d386486f27cc92e1ba01d9c3d03f0633c7ac
+  data.tar.gz: e4f0b5717132652127aafeeccdda4253d68a8201
 SHA512:
-  metadata.gz: 6b2a4ec9172a6c31a435c8feb3a2e73a03e134269d1bf9f8fc2227a2074a404b06893e47f1053f91c17f497f4ed145385007b825c2b8f5e314a8f129a40dae5f
-  data.tar.gz: 84e62c678aa22a165c63ccbb31ac89a69ce507ad49193127cd035f42482c86398fc5e14dc35b2d6518820750e97e9804a3e0227add72354d2bab4841780eef43
+  metadata.gz: 3d3f0d9472329eafe49f3bdbf6326672c442d74b8132f07d3a21d0083d7d617fd1309af82d24ba78bd3585d61b7f6daf5ecec8fcad5f72595a29d2024afdea16
+  data.tar.gz: 03d8e6d2faf2249b3077c38d67d90535f6a82d6d2fb1aec42c71e90cf9054497ab122a89014478840420c23f0c969ea1fa2c9316ebd933e623c5d395c5521c64

data/README.md

@@ -22,6 +22,17 @@ Or install it yourself as:
 
 Follow the examples below to start using the gem.
 
+### Configuration
+
+There are some configuration you can do before start using this lib.
+
+```ruby
+GS1.configure do |config|
+  config.company_prefix = '123456789'
+  config.barcode_separator = '~' # Default is "\u001E"
+end
+```
+
 ### Application identifiers
 
 To access the defined application identifier:

data/lib/gs1/barcode/base.rb

@@ -18,19 +18,19 @@ module GS1
       end
 
       class << self
-        def from_scan!(barcode, separator: DEFAULT_SEPARATOR)
+        def from_scan!(barcode, separator: GS1.configuration.barcode_separator)
           new(scan_to_params!(barcode, separator: separator))
         end
 
-        def from_scan(barcode, separator: DEFAULT_SEPARATOR)
+        def from_scan(barcode, separator: GS1.configuration.barcode_separator)
           new(scan_to_params(barcode, separator: separator))
         end
 
-        def scan_to_params!(barcode, separator: DEFAULT_SEPARATOR)
+        def scan_to_params!(barcode, separator: GS1.configuration.barcode_separator)
           Tokenizer.new(barcode, separator: separator).to_params!
         end
 
-        def scan_to_params(barcode, separator: DEFAULT_SEPARATOR)
+        def scan_to_params(barcode, separator: GS1.configuration.barcode_separator)
           Tokenizer.new(barcode, separator: separator).to_params
         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: DEFAULT_SEPARATOR)
+      def to_s(level: AIDCMarketingLevels::ENHANCED, separator: GS1.configuration.barcode_separator)
         return unless valid?(level: level)
 
         [

data/lib/gs1/barcode/segment.rb

@@ -5,7 +5,7 @@ module GS1
     class Segment
       attr_reader :data, :separator
 
-      def initialize(data, separator: DEFAULT_SEPARATOR)
+      def initialize(data, separator: GS1.configuration.barcode_separator)
         @data = data.chars
         @separator = separator
       end

data/lib/gs1/barcode/tokenizer.rb

@@ -6,7 +6,7 @@ module GS1
     class Tokenizer
       attr_reader :data, :separator, :params
 
-      def initialize(data, separator: DEFAULT_SEPARATOR)
+      def initialize(data, separator: GS1.configuration.barcode_separator)
         @data = data
         @separator = separator
         @params = {}

data/lib/gs1/definitions.rb

@@ -15,7 +15,7 @@ module GS1
     module ClassMethods
       attr_reader :definitions
 
-      DEFINITIONS = %i[check_digit date length].freeze
+      DEFINITIONS = %i[check_digit date date_month_based length].freeze
 
       def define(key, options = {})
         raise UnknownDefinition, "#{key} is not a valid definition" unless DEFINITIONS.include?(key)
@@ -35,6 +35,11 @@ module GS1
         {}
       end
 
+      # Currently no support for options.
+      def normalize_date_month_based_options(_options)
+        {}
+      end
+
       # Defaults barcode length to allowed length if not explicitly defined, only
       # if there is one significant allowed.
       def normalize_length_options(options)

data/lib/gs1/expiration_date.rb

@@ -48,7 +48,7 @@ module GS1
   # Source: https://www.gs1.org/sites/default/files/docs/barcodes/GS1_General_Specifications.pdf
   #
   class ExpirationDate < Record
-    include Extensions::Date
+    include Extensions::DateMonthBased
 
     AI = AI::USE_BY
   end

data/lib/gs1/extensions/date_month_based.rb

@@ -0,0 +1,60 @@
+require 'date'
+
+module GS1
+  module Extensions
+    # Extension for a GS1 date. Ensures correct formating and validation.
+    #
+    # OBS! Month-based expiry
+    #
+    # Expiry dates for a batch of medicinal product are generally set by month, rather than day. If a batch
+    # expires in March 2021, for example, it expires at the very end of the month. From the 1st April 2021, the EMVS
+    # will report that the pack identifier has expired if it has not already been decommissioned for some other reason.
+    #
+    # Manufacturers represent expiry by month in one of two ways. They either set the expiry date to be the last day of
+    # the month or they set the day component of the date (DD) to '00'. Examples are shown below:
+    #
+    # Format A: 210331
+    # Format B: 210300
+    #
+    # These two formats effectively indicate the same expiry date. The first specifies a specific day (the last day of
+    # the month). The second specifies only the month of expiry.
+    #
+    # The format used in the barcodes must be exactly the same as the format used within the EMVS. If the manufacturer
+    # uploads batch data to the European Hub using one format, but prints the barcodes using the other, the dates will
+    # not match and the national system will raise 'potential falsified medicine' alerts. In this case, the packs
+    # cannot be supplied until the manufacturer corrects the data within the EMVS.
+    #
+    module DateMonthBased
+      def self.included(base)
+        base.define :date_month_based
+        base.define :length, barcode: 6
+      end
+
+      def initialize(date)
+        if date.respond_to?(:strftime)
+          super(date.strftime('%y%m%d'))
+        else
+          super(date)
+        end
+      end
+
+      def to_date
+        to_date_format_a || to_date_format_b
+      end
+
+      private
+
+      def to_date_format_a
+        ::Date.strptime(data, '%y%m%d')
+      rescue TypeError, ArgumentError
+        nil
+      end
+
+      def to_date_format_b
+        ::Date.strptime(data, '%y%m00').next_month.prev_day
+      rescue TypeError, ArgumentError
+        nil
+      end
+    end
+  end
+end

data/lib/gs1/extensions.rb

@@ -1,2 +1,3 @@
 require 'gs1/extensions/date'
+require 'gs1/extensions/date_month_based'
 require 'gs1/extensions/gtin'

data/lib/gs1/validations/date_validation.rb

@@ -9,6 +9,10 @@ module GS1
         errors << 'Invalid date' unless valid_date?
       end
 
+      def validate_date_month_based(_options = {})
+        errors << 'Invalid date' unless valid_month_based_date?
+      end
+
       def valid_date?
         return true if data.is_a?(::Date)
 
@@ -18,6 +22,31 @@ module GS1
       rescue TypeError, ArgumentError
         false
       end
+
+      def valid_month_based_date?
+        return true if data.is_a?(::Date)
+
+        valid_format_a?(data) || valid_format_b?(data)
+      end
+
+      def valid_format_a?(data)
+        valid_date_format?(data, '%y%m%d')
+      end
+
+      # Read more about this date format in the GS1::Extensions::MonthBasedDate class.
+      def valid_format_b?(data)
+        valid_date_format?(data, '%y%m00')
+      end
+
+      private
+
+      def valid_date_format?(data, pattern)
+        ::Date.strptime(data, pattern)
+
+        true
+      rescue TypeError, ArgumentError
+        false
+      end
     end
   end
 end

data/lib/gs1/version.rb

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

data/lib/gs1.rb

@@ -20,19 +20,28 @@ require 'gs1/barcode'
 #
 module GS1
   class << self
-    def configure
+    def configuration
       @configuration ||= Configuration.new
-
-      yield @configuration
     end
 
-    attr_reader :configuration
+    def configure
+      if block_given?
+        yield configuration
+      else
+        configuration
+      end
+    end
   end
 
   # Configuration holds custom configuration parameters.
   #
   class Configuration
     attr_accessor :company_prefix
+    attr_writer :barcode_separator
+
+    def barcode_separator
+      @barcode_separator || GS1::Barcode::DEFAULT_SEPARATOR
+    end
   end
 
   AI_CLASSES = GS1::Record.descendants.each_with_object({}) do |klass, hash|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gs1
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Stefan Åhman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,6 +143,7 @@ files:
 - lib/gs1/expiration_date.rb
 - lib/gs1/extensions.rb
 - lib/gs1/extensions/date.rb
+- lib/gs1/extensions/date_month_based.rb
 - lib/gs1/extensions/gtin.rb
 - lib/gs1/gtin.rb
 - lib/gs1/record.rb