dmtx 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a114ad5037384a5dd7a9944663ff50f2ef82b5ccefdcf9f415cf1e364dbd6bb5
-  data.tar.gz: 4b3346d6d27a62311a04df3c6ea459ee1524920811d7d5b34104fbf61185923b
+  metadata.gz: 9aedbfc3b9bdc27d443dd1e2d65783af65da3ffb05c5a55060a04747a0ffab6f
+  data.tar.gz: 34069b336ce07010638aabccb0b5523ccc448ff31b4a5902ad061d1bb2d9d18b
 SHA512:
-  metadata.gz: '01866bc5320e4c56a495eed7c2671871b64dc7d84af57e4d3aa15078617d69aca943da63386b62fcd2e4efb1ee73d9c30b58ff9443651e2ba304237b1a2135a6'
-  data.tar.gz: 6b8e0d0d64248af532a77c4407dc884fea29cba0428115733bf3a046fde586c57eea2b3fab5b963c4f81c3c233f5c0f2cf626bb2d3069b208cb38a73f6c64746
+  metadata.gz: 7f126e2e555695137c8720f304cd9f87caea35fc38d6c6714420b6d1e62ee7ae172cf2ae39c13ee7190b0143f3e2d372a80a228e8deb47a09091025353830295
+  data.tar.gz: a40eb8a839564b6877665d92c0f8c5f7117ad9ff379594648586170547d3d1108e9dd3ea68bd1af81760e5aa336a3e34dd54e0a6c1d4d31c9d1567d1d04ee7cf

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.2.0] - 2024-02-11
+
+- Support GS1 DataMatrix
+
 ## [0.1.1] - 2021-09-02
 
 - Fix PNG bgcolor

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/dmtx.svg)](https://badge.fury.io/rb/dmtx)
+[![build](https://github.com/mtgrosser/dmtx/actions/workflows/build.yml/badge.svg)](https://github.com/mtgrosser/dmtx/actions/workflows/build.yml)
+
 # dmtx
 Pure Ruby Data Matrix generator
 
@@ -39,6 +42,13 @@ dmtx.width
 dmtx.height
 => 16
 
+dmtx.encoding
+=> :ascii
+
+dmtx.encoded_message
+=> [68, 105, 118, 111, 108, 122, 33, 67, 98, 100, 112, 111,
+    62, 103, 49, 93, 99, 53, 117, 202, 250, 186, 232, 14]
+
 # Generate SVG
 dmtx.to_svg
 => "<svg xmlns= ..."
@@ -63,4 +73,25 @@ dmtx.to_i
 
 # Binary representation
 dmtx.to_i.to_s(2)
-=> "1010101010101010101110101000001111010111111101101001101011101001100110010100111010111011111100111001011001001000100010000111010110110001101111001011001001101011110000011111110010101101101010111001101001000000111100101000110110101110011100101111111111111111"
+=> "1010101010101010
+    1011101010000011
+    1101011111110110
+    1001101011101001
+    1001100101001110
+    1011101111110011
+    1001011001001000
+    1000100001110101
+    1011000110111100
+    1011001001101011
+    1100000111111100
+    1010110110101011
+    1001101001000000
+    1111001010001101
+    1010111001110010
+    1111111111111111"
+
+# Choose encoding
+Dmtx::DataMatrix.new('Chunky Bacon', encoding: :txt)
+
+# GS1 DataMatrix
+Dmtx::DataMatrix.new("\x1d01095011010209171719050810ABCD1234\x1d2110", encoding: :gs1)

data/lib/dmtx/data_matrix.rb

@@ -6,7 +6,7 @@ require 'chunky_png'
 
 module Dmtx
   class DataMatrix
-    attr_reader :width, :height
+    attr_reader :width, :height, :encoded_message, :encoding
   
     C40 = [230,
            31, 0, 0,
@@ -43,16 +43,26 @@ module Dmtx
            64, 8,  0,
            90, 9, 51,
            255, 8,  0]
-  
-    def initialize(msg, rect: false)
+    
+    # See https://www.gs1.org/standards/gs1-datamatrix-guideline/25
+    FNC1 = 29
+    FNC1_CODEWORD = 232
+    
+    DEFAULT_ENCODINGS = %i[ascii c40 txt x12 edifact base gs1].freeze
+    ENCODINGS = (%i[gs1] + DEFAULT_ENCODINGS).freeze
+    
+    def initialize(msg, rect: false, encoding: nil)
       @m = []
       @width = 0
       @height = 0
-      encode(msg, rect)
+      raise ArgumentError, "illegal encoding #{encoding.inspect}" if encoding && !ENCODINGS.include?(encoding)
+      @encoding, @encoded_message = encode_message(msg, encoding)
+      raise EncodingError, "illegal payload" unless @encoded_message
+      encode(@encoded_message, rect)
     end
     
     def inspect
-      "#<#{self.class.name}:0x#{object_id.to_s(16)} #{width}x#{height}>"
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} #{width}x#{height}@#{encoding}>"
     end
     
     def to_i
@@ -76,7 +86,6 @@ module Dmtx
       y = height
       while y > 0
         y -= 1
-        d = 0
         x = width
         while x > 0
           x -= 1
@@ -139,6 +148,23 @@ module Dmtx
       end
       result
     end
+
+    def gs1_encode(t)
+      bytes, result = t.bytes, []
+      while c = bytes.shift
+        if !bytes.empty? && c > 47 && c < 58 && bytes.first > 47 && bytes.first < 58
+          result << (c - 48) * 10 + bytes.shift + 82
+        elsif c > 127
+          result << 235
+          result << ((c - 127) & 255)
+        elsif c == FNC1
+          result << FNC1_CODEWORD
+        else
+          result << c + 1
+        end
+      end
+      result
+    end
   
     def base_encode(t)
       bytes, result = t.bytes, [231]
@@ -204,18 +230,27 @@ module Dmtx
       result.concat ascii_encode(bytes[(i - cc)..-1].to_a.pack('C*')) if cc > 0 || i < l
       result
     end
-  
-    def encodings(msg)
-      { ascii: ascii_encode(msg),
-        c40: text_encode(msg, C40),
-        txt: text_encode(msg, TEXT),
-        x12: text_encode(msg, X12),
-        edifact: edifact_encode(msg),
-        base: base_encode(msg) }
+    
+    def c40_encode(t)
+      text_encode(t, C40)
+    end
+    
+    def txt_encode(t)
+      text_encode(t, TEXT)
+    end
+    
+    def x12_encode(t)
+      text_encode(t, X12)
+    end
+    
+    def encode_message(msg, encoding)
+      (encoding ? [encoding] : DEFAULT_ENCODINGS)
+        .map { |name| [name, send("#{name}_encode", msg)] }
+        .reject { |_, encoded| encoded.empty? }
+        .min_by { |_, encoded| encoded.size }
     end
     
-    def encode(text, rct)
-      enc = encodings(text).values.reject(&:empty?).min_by(&:size)
+    def encode(enc, rct)
       el = enc.size
       nc = nr = 1
       j = -1

data/lib/dmtx/version.rb

@@ -1,3 +1,3 @@
 module Dmtx
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/dmtx.rb

@@ -3,4 +3,5 @@ require_relative 'dmtx/data_matrix'
 
 module Dmtx
   class Error < StandardError; end
+  class EncodingError < Error; end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dmtx
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthias Grosser
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-02 00:00:00.000000000 Z
+date: 2024-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - mtgrosser@gmx.net
 executables: []
@@ -56,7 +56,7 @@ homepage: https://github.com/mtgrosser/dmtx
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Pure Ruby Datamatrix Generator
 test_files: []