ruby-zint 1.1.0 → 1.3.0

data/lib/zint/grid_matrix.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Grid Matrix
   class GridMatrix < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_GRIDMATRIX, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_GRIDMATRIX, **kwargs)
     end
   end
 end

data/lib/zint/gs1_128.rb

@@ -1,9 +1,10 @@
 module Zint
   # standard:disable Naming/ClassAndModuleCamelCase
+  # GS1-128
   class Gs1_128 < Barcode
     # standard:enable Naming/ClassAndModuleCamelCase
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_GS1_128, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_GS1_128, **kwargs)
     end
   end
 end

data/lib/zint/hanxin.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Han Xin (Chinese Sensible) Code
   class Hanxin < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HANXIN, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HANXIN, **kwargs)
     end
   end
 end

data/lib/zint/hibc128.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC (Health Industry Barcode) Code 128
   class Hibc128 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_128, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_128, **kwargs)
     end
   end
 end

data/lib/zint/hibc39.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC Code 39
   class Hibc39 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_39, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_39, **kwargs)
     end
   end
 end

data/lib/zint/hibcaztec.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC Aztec Code
   class HibcAztec < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_AZTEC, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_AZTEC, **kwargs)
     end
   end
 end

data/lib/zint/hibcblockf.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC Codablock-F
   class HibcBlockf < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_BLOCKF, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_BLOCKF, **kwargs)
     end
   end
 end

data/lib/zint/hibcdm.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC Data Matrix
   class HibcDm < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_DM, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_DM, **kwargs)
     end
   end
 end

data/lib/zint/hibcmicpdf.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC MicroPDF417
   class HibcMicpdf < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_MICPDF, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_MICPDF, **kwargs)
     end
   end
 end

data/lib/zint/hibcpdf.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC PDF417
   class HibcPdf < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_PDF, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_PDF, **kwargs)
     end
   end
 end

data/lib/zint/hibcqr.rb

@@ -1,7 +1,8 @@
 module Zint
+  # HIBC QR Code
   class HibcQr < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_HIBC_QR, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_HIBC_QR, **kwargs)
     end
   end
 end

data/lib/zint/isbnx.rb

@@ -1,7 +1,8 @@
 module Zint
+  # ISBN
   class Isbnx < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_ISBNX, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_ISBNX, **kwargs)
     end
   end
 end

data/lib/zint/itf14.rb

@@ -1,7 +1,8 @@
 module Zint
+  # ITF-14
   class Itf14 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_ITF14, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_ITF14, **kwargs)
     end
   end
 end

data/lib/zint/japan_post.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Japanese Postal Code
   class JapanPost < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_JAPANPOST, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_JAPANPOST, **kwargs)
     end
   end
 end

data/lib/zint/kix.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Dutch Post KIX Code
   class Kix < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_KIX, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_KIX, **kwargs)
     end
   end
 end

data/lib/zint/korea_post.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Korea Post
   class KoreaPost < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_KOREAPOST, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_KOREAPOST, **kwargs)
     end
   end
 end

data/lib/zint/logmars.rb

@@ -1,7 +1,8 @@
 module Zint
+  # LOGMARS
   class Logmars < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_LOGMARS, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_LOGMARS, **kwargs)
     end
   end
 end

data/lib/zint/mailmark.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class Mailmark < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_MAILMARK, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MAILMARK, **kwargs)
     end
   end
 end

data/lib/zint/mailmark_2d.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Royal Mail 2D Mailmark (CMDM) (Data Matrix)
+  class Mailmark2D < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MAILMARK_2D, **kwargs)
+    end
+  end
+end

data/lib/zint/mailmark_4s.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Royal Mail 4-State Mailmark
+  class Mailmark4S < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MAILMARK_4S, **kwargs)
+    end
+  end
+end

data/lib/zint/maxi_code.rb

@@ -1,7 +1,8 @@
 module Zint
+  # MaxiCode
   class MaxiCode < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_MAXICODE, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MAXICODE, **kwargs)
     end
   end
 end

data/lib/zint/micro_pdf417.rb

@@ -1,7 +1,8 @@
 module Zint
+  # MicroPDF417
   class MicroPdf417 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_MICROPDF417, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MICROPDF417, **kwargs)
     end
   end
 end

data/lib/zint/micro_qr.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Micro QR Code
   class MicroQr < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_MICROQR, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MICROQR, **kwargs)
     end
   end
 end

data/lib/zint/msiplessey.rb

@@ -1,7 +1,8 @@
 module Zint
+  # MSI Plessey
   class MsiPlessey < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_MSI_PLESSEY, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_MSI_PLESSEY, **kwargs)
     end
   end
 end

data/lib/zint/native.rb

@@ -5,7 +5,7 @@ module Zint
     root_path = File.expand_path("../../..", __FILE__)
     prefix = FFI::Platform::LIBPREFIX.empty? ? "lib" : FFI::Platform::LIBPREFIX
     bundled_dll = File.join(root_path, "lib/#{prefix}zint.#{FFI::Platform::LIBSUFFIX}")
-    ffi_lib [bundled_dll, "libzint.so.2.10", "libzint", "zint"]
+    ffi_lib [bundled_dll, "libzint.so.2.12", "libzint", "zint"]
 
     # Error codes (API return values)
     enum :error_code, [Constants::Warnings::WARNINGS, Constants::Errors::ERRORS].map { |h| h.to_a }.flatten

data/lib/zint/nve18.rb

@@ -1,7 +1,8 @@
 module Zint
+  # NVE-18 (SSCC-18)
   class Nve18 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_NVE18, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_NVE18, **kwargs)
     end
   end
 end

data/lib/zint/one_code.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class OneCode < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_ONECODE, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_ONECODE, **kwargs)
     end
   end
 end

data/lib/zint/pdf417.rb

@@ -1,7 +1,8 @@
 module Zint
+  # PDF417
   class Pdf417 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PDF417, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PDF417, **kwargs)
     end
   end
 end

data/lib/zint/pdf417comp.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Compact PDF417 (Truncated PDF417)
   class Pdf417comp < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PDF417COMP, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PDF417COMP, **kwargs)
     end
   end
 end

data/lib/zint/pdf417trunc.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class Pdf417trunc < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PDF417TRUNC, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PDF417TRUNC, **kwargs)
     end
   end
 end

data/lib/zint/pharma.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Pharmacode One-Track
   class Pharma < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PHARMA, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PHARMA, **kwargs)
     end
   end
 end

data/lib/zint/pharmatwo.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Pharmacode Two-Track
   class PharmaTwo < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PHARMA_TWO, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PHARMA_TWO, **kwargs)
     end
   end
 end

data/lib/zint/planet.rb

@@ -1,7 +1,8 @@
 module Zint
+  # USPS PLANET
   class Planet < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PLANET, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PLANET, **kwargs)
     end
   end
 end

data/lib/zint/plessey.rb

@@ -1,7 +1,8 @@
 module Zint
+  # UK Plessey
   class Plessey < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PLESSEY, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PLESSEY, **kwargs)
     end
   end
 end

data/lib/zint/postnet.rb

@@ -1,7 +1,8 @@
 module Zint
+  # USPS (U.S. Postal Service) POSTNET
   class Postnet < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_POSTNET, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_POSTNET, **kwargs)
     end
   end
 end

data/lib/zint/pzn.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Pharmazentralnummer
   class Pzn < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_PZN, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_PZN, **kwargs)
     end
   end
 end

data/lib/zint/qr.rb

@@ -1,4 +1,5 @@
 module Zint
+  # QR Code
   class Qr < Barcode
     # ECC Levels
     ECC_LEVEL_L = 1
@@ -9,8 +10,8 @@ module Zint
     # Current ECC level of QR code
     attr_reader :ecc_level
 
-    def initialize(value: nil, input_file: nil, ecc_level: ECC_LEVEL_L, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_QRCODE, options: options.merge(option_1: ecc_level))
+    def initialize(value: nil, input_file: nil, ecc_level: ECC_LEVEL_L, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_QRCODE, **kwargs.merge(option_1: ecc_level))
       @ecc_level = ecc_level
     end
   end

data/lib/zint/rmqr.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Rectangular Micro QR Code (rMQR)
   class Rmqr < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RMQR, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RMQR, **kwargs)
     end
   end
 end

data/lib/zint/rss14.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class Rss14 < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS14, **kwargs)
     end
   end
 end

data/lib/zint/rss14stack.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class Rss14stack < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14STACK, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS14STACK, **kwargs)
     end
   end
 end

data/lib/zint/rss14stackomni.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class Rss14stackOmni < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS14STACK_OMNI, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS14STACK_OMNI, **kwargs)
     end
   end
 end

data/lib/zint/rssexp.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class RssExp < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_EXP, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS_EXP, **kwargs)
     end
   end
 end

data/lib/zint/rssexpstack.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class RssExpstack < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_EXPSTACK, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS_EXPSTACK, **kwargs)
     end
   end
 end

data/lib/zint/rssltd.rb

@@ -1,7 +1,8 @@
 module Zint
+  # Legacy
   class RssLtd < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_RSS_LTD, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_RSS_LTD, **kwargs)
     end
   end
 end

data/lib/zint/structs/structapp.rb

@@ -0,0 +1,25 @@
+module Zint
+  module Structs
+    #  Structured Append info - ignored unless `zint_structapp.count` is set to non-zero value
+    class Structapp < FFI::Struct
+      layout :index, :int, # Position in Structured Append sequence, 1-based. Must be <= `count`
+        :count, :int, # Number of symbols in Structured Append sequence. Set >= 2 to add SA Info
+        :id, [:char, 32] # Optional ID to distinguish sequence, ASCII, NUL-terminated unless max 32 long
+
+      # Position in Structured Append sequence, 1-based. Must be <= `count`
+      def index
+        self[:index]
+      end
+
+      # Number of symbols in Structured Append sequence. Set >= 2 to add SA Info
+      def count
+        self[:count]
+      end
+
+      # Optional ID to distinguish sequence, ASCII, NUL-terminated unless max 32 long
+      def id
+        self[:id]
+      end
+    end
+  end
+end