ruby-zint 1.1.0 → 1.3.0

data/lib/zint/structs/symbol.rb

@@ -1,41 +1,44 @@
 module Zint
   module Structs
     class Symbol < FFI::ManagedStruct
-      layout :symbology, :int,
-        :height, :float,
-        :whitespace_width, :int,
-        :whitespace_height, :int,
-        :border_width, :int,
-        :output_options, :int,
-        :fgcolour, [:char, 10],
-        :bgcolour, [:char, 10],
-        :fgcolor, :pointer,
-        :bgcolor, :pointer,
-        :outfile, [:char, 256],
-        :scale, :float,
-        :option_1, :int,
-        :option_2, :int,
-        :option_3, :int,
-        :show_hrt, :int,
-        :fontsize, :int,
-        :input_mode, :int,
-        :eci, :int,
-        :text, [:uchar, 128],
-        :rows, :int,
-        :width, :int,
-        :primary, [:char, 128],
-        :encoded_data, [:uchar, 200 * 143],
-        :row_height, [:float, 200],
-        :errtxt, [:char, 100],
-        :bitmap, :pointer,
-        :bitmap_width, :int,
-        :bitmap_height, :int,
-        :alphamap, :pointer,
-        :bitmap_byte_length, :uchar,
-        :dot_size, :float,
-        :vector, Vector.by_ref,
-        :debug, :int,
-        :warn_level, :int
+      layout :symbology, :int, # Symbol to use (see BARCODE_XXX below)
+        :height, :float, # Barcode height in X-dimensions (ignored for fixed-width barcodes)
+        :scale, :float, # Scale factor when printing barcode, i.e. adjusts X-dimension. Default 1
+        :whitespace_width, :int, # Width in X-dimensions of whitespace to left & right of barcode
+        :whitespace_height, :int, # Height in X-dimensions of whitespace above & below the barcode
+        :border_width, :int, # Size of border in X-dimensions
+        :output_options, :int, # Various output parameters (bind, box etc, see below)
+        :fgcolour, [:char, 10], # Foreground as RGB/RGBA hexadecimal string, 6 or 8 characters, NUL-terminated
+        :bgcolour, [:char, 10], # Background as RGB/RGBA hexadecimal string, 6 or 8 characters, NUL-terminated
+        :fgcolor, :pointer, # Pointer to fgcolour (alternate spelling)
+        :bgcolor, :pointer, # Pointer to bgcolour (alternate spelling)
+        :outfile, [:char, 256], # Name of file to output to, NUL-terminated. Default "out.png" ("out.gif" if NO_PNG)
+        :primary, [:char, 128], # Primary message data (MaxiCode, Composite), NUL-terminated
+        :option_1, :int, # Symbol-specific options (see "../docs/manual.txt")
+        :option_2, :int, # Symbol-specific options
+        :option_3, :int, # Symbol-specific options
+        :show_hrt, :int, # Show (1) or hide (0) Human Readable Text (HRT). Default 1
+        :fontsize, :int, # Unused
+        :input_mode, :int, # Encoding of input data (see DATA_MODE etc below). Default DATA_MODE
+        :eci, :int, # Extended Channel Interpretation. Default 0 (none)
+        :dpmm, :float, # Resolution of output in dots per mm (BMP/EMF/PCX/PNG/TIF only). Default 0 (none)
+        :dot_size, :float, # Size of dots used in BARCODE_DOTTY_MODE. Default 0.8
+        :guard_descent, :float, # Height in X-dimensions that EAN/UPC guard bars descend. Default 5
+        :structapp, Structapp, # Structured Append info. Default structapp.count 0 (none)
+        :warn_level, :int, # Affects error/warning value returned by Zint API (see WARN_XXX below)
+        :debug, :int, # Debugging flags
+        :text, [:uchar, 128], # Human Readable Text (if any), UTF-8, NUL-terminated (output only)
+        :rows, :int, # Number of rows used by the symbol (output only)
+        :width, :int, # Width of the generated symbol (output only)
+        :encoded_data, [:uchar, 200 * 144], # Encoded data (output only). Allows for rows of 1152 modules
+        :row_height, [:float, 200], # Heights of rows (output only). Allows for 200 row DotCode
+        :errtxt, [:char, 100], # Error message if an error or warning occurs, NUL-terminated (output only)
+        :bitmap, :pointer, # Stored bitmap image (raster output only)
+        :bitmap_width, :int, # Width of bitmap image (raster output only)
+        :bitmap_height, :int, # Height of bitmap image (raster output only)
+        :alphamap, :pointer, # Array of alpha values used (raster output only)
+        :bitmap_byte_length, :uchar, # Size of BMP bitmap data (raster output only)
+        :vector, Vector.by_ref # Pointer to vector header (vector output only)
 
       # @private
       def self.release(ptr)

data/lib/zint/structs/vector_circle.rb

@@ -3,8 +3,9 @@ module Zint
     class VectorCircle < FFI::Struct
       layout :x, :float,
         :y, :float,
-        :diameter, :float,
-        :colour, :int,  #  Non-zero for draw with background colour
+        :diameter, :float, # Circle diameter. Does not include width (if any)
+        :width, :float, # Width of circle perimeter (circumference). 0 for fill (disc)
+        :colour, :int,  # Non-zero for draw with background colour (else draw with foreground colour)
         :next, VectorCircle.by_ref #  Pointer to next circle
 
       # x position

data/lib/zint/telepen.rb

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

data/lib/zint/telepennum.rb

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

data/lib/zint/ultra.rb

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

data/lib/zint/upc_a.rb

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

data/lib/zint/upc_a_chk.rb

@@ -1,7 +1,8 @@
 module Zint
+  # UPC-A + Check Digit
   class UpcAChk < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_UPCA_CHK, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_UPCA_CHK, **kwargs)
     end
   end
 end

data/lib/zint/upc_e.rb

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

data/lib/zint/upc_e_chk.rb

@@ -1,7 +1,8 @@
 module Zint
+  # UPC-E + Check Digit
   class UpcEChk < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_UPCE_CHK, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_UPCE_CHK, **kwargs)
     end
   end
 end

data/lib/zint/upnqr.rb

@@ -1,7 +1,8 @@
 module Zint
+  # UPNQR (Univerzalnega Plačilnega Naloga QR)
   class Upnqr < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_UPNQR, options: options)
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_UPNQR, **kwargs)
     end
   end
 end

data/lib/zint/upu_s10.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Universal Postal Union S10
+  class UpuS10 < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_UPU_S10, **kwargs)
+    end
+  end
+end

data/lib/zint/uspsimail.rb

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

data/lib/zint/version.rb

@@ -1,3 +1,3 @@
 module Zint
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/zint/vin.rb

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

data/lib/zint.rb

@@ -20,6 +20,7 @@ require "zint/structs/vector_hexagon"
 require "zint/structs/vector_rect"
 require "zint/structs/vector_string"
 require "zint/structs/vector"
+require "zint/structs/structapp"
 require "zint/structs/symbol"
 require "zint/native"
 
@@ -36,6 +37,7 @@ module Zint
   include Constants::Warnings
 
   # Barcode
+  autoload :Bc412, "zint/bc_412"
   autoload :Bitmap, "zint/bitmap"
   autoload :BitmapPixel, "zint/bitmap_pixel"
   autoload :Barcode, "zint/barcode"
@@ -53,12 +55,14 @@ module Zint
   autoload :C25logic, "zint/c25logic"
   autoload :C25matrix, "zint/c25matrix"
   autoload :C25standard, "zint/c25standard"
+  autoload :CepNet, "zint/cep_net"
   autoload :Channel, "zint/channel"
   autoload :Codabar, "zint/codabar"
   autoload :CodablockF, "zint/codablock_f"
   autoload :Code11, "zint/code11"
   autoload :Code128, "zint/code128"
-  autoload :Code128b, "zint/code128b"
+  autoload :Code128AB, "zint/code128ab"
+  autoload :Code128B, "zint/code128b"
   autoload :Code16k, "zint/code16k"
   autoload :Code32, "zint/code32"
   autoload :Code39, "zint/code39"
@@ -103,6 +107,8 @@ module Zint
   autoload :KoreaPost, "zint/korea_post"
   autoload :Logmars, "zint/logmars"
   autoload :Mailmark, "zint/mailmark"
+  autoload :Mailmark2D, "zint/mailmark_2d"
+  autoload :Mailmark4S, "zint/mailmark_4s"
   autoload :MaxiCode, "zint/maxi_code"
   autoload :MicroPdf417, "zint/micro_pdf417"
   autoload :MicroQr, "zint/micro_qr"
@@ -136,6 +142,7 @@ module Zint
   autoload :UpcE, "zint/upc_e"
   autoload :UpcEChk, "zint/upc_e_chk"
   autoload :Upnqr, "zint/upnqr"
+  autoload :UpuS10, "zint/upu_s10"
   autoload :UspsImail, "zint/uspsimail"
   autoload :Vin, "zint/vin"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zint
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Elias Fröhner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -44,10 +44,120 @@ email:
 executables: []
 extensions:
 - ext/ruby-zint/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- lib/zint/aus_post.rb
+- lib/zint/aus_redirect.rb
+- lib/zint/aus_reply.rb
+- lib/zint/aus_route.rb
+- lib/zint/azrune.rb
+- lib/zint/aztec.rb
+- lib/zint/barcode.rb
+- lib/zint/bc_412.rb
+- lib/zint/bitmap.rb
+- lib/zint/bitmap_pixel.rb
+- lib/zint/c25iata.rb
+- lib/zint/c25ind.rb
+- lib/zint/c25inter.rb
+- lib/zint/c25logic.rb
+- lib/zint/c25matrix.rb
+- lib/zint/c25standard.rb
+- lib/zint/cep_net.rb
+- lib/zint/channel.rb
+- lib/zint/codabar.rb
+- lib/zint/codablock_f.rb
+- lib/zint/code11.rb
+- lib/zint/code128.rb
+- lib/zint/code128ab.rb
+- lib/zint/code128b.rb
+- lib/zint/code16k.rb
+- lib/zint/code32.rb
+- lib/zint/code39.rb
+- lib/zint/code49.rb
+- lib/zint/code93.rb
+- lib/zint/code_one.rb
+- lib/zint/daft.rb
+- lib/zint/data_matrix.rb
+- lib/zint/dbarexp.rb
+- lib/zint/dbarexpstk.rb
+- lib/zint/dbarltd.rb
+- lib/zint/dbaromn.rb
+- lib/zint/dbaromnstk.rb
+- lib/zint/dbarstk.rb
+- lib/zint/dependencies.rb
+- lib/zint/dot_code.rb
+- lib/zint/dpd.rb
+- lib/zint/dpident.rb
+- lib/zint/dpleit.rb
+- lib/zint/ean128.rb
+- lib/zint/ean14.rb
+- lib/zint/eanx.rb
+- lib/zint/eanxchk.rb
+- lib/zint/excode39.rb
+- lib/zint/fim.rb
+- lib/zint/flat.rb
+- lib/zint/grid_matrix.rb
+- lib/zint/gs1_128.rb
+- lib/zint/hanxin.rb
+- lib/zint/hibc128.rb
+- lib/zint/hibc39.rb
+- lib/zint/hibcaztec.rb
+- lib/zint/hibcblockf.rb
+- lib/zint/hibcdm.rb
+- lib/zint/hibcmicpdf.rb
+- lib/zint/hibcpdf.rb
+- lib/zint/hibcqr.rb
+- lib/zint/isbnx.rb
+- lib/zint/itf14.rb
+- lib/zint/japan_post.rb
+- lib/zint/kix.rb
+- lib/zint/korea_post.rb
+- lib/zint/logmars.rb
+- lib/zint/mailmark.rb
+- lib/zint/mailmark_2d.rb
+- lib/zint/mailmark_4s.rb
+- lib/zint/maxi_code.rb
+- lib/zint/micro_pdf417.rb
+- lib/zint/micro_qr.rb
+- lib/zint/msiplessey.rb
+- lib/zint/native.rb
+- lib/zint/nve18.rb
+- lib/zint/one_code.rb
+- lib/zint/pdf417.rb
+- lib/zint/pdf417comp.rb
+- lib/zint/pdf417trunc.rb
+- lib/zint/pharma.rb
+- lib/zint/pharmatwo.rb
+- lib/zint/planet.rb
+- lib/zint/plessey.rb
+- lib/zint/postnet.rb
+- lib/zint/pzn.rb
+- lib/zint/qr.rb
+- lib/zint/rmqr.rb
+- lib/zint/rss14.rb
+- lib/zint/rss14stack.rb
+- lib/zint/rss14stackomni.rb
+- lib/zint/rssexp.rb
+- lib/zint/rssexpstack.rb
+- lib/zint/rssltd.rb
+- lib/zint/telepen.rb
+- lib/zint/telepennum.rb
+- lib/zint/ultra.rb
+- lib/zint/upc_a.rb
+- lib/zint/upc_a_chk.rb
+- lib/zint/upc_e.rb
+- lib/zint/upc_e_chk.rb
+- lib/zint/upnqr.rb
+- lib/zint/upu_s10.rb
+- lib/zint/uspsimail.rb
+- lib/zint/version.rb
+- lib/zint/vin.rb
+- lib/zint/zint_recipe.rb
 files:
 - ".rspec"
 - ".standard.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -62,21 +172,22 @@ files:
 - lib/zint/azrune.rb
 - lib/zint/aztec.rb
 - lib/zint/barcode.rb
-- lib/zint/bind.rb
+- lib/zint/bc_412.rb
 - lib/zint/bitmap.rb
 - lib/zint/bitmap_pixel.rb
-- lib/zint/box.rb
 - lib/zint/c25iata.rb
 - lib/zint/c25ind.rb
 - lib/zint/c25inter.rb
 - lib/zint/c25logic.rb
 - lib/zint/c25matrix.rb
 - lib/zint/c25standard.rb
+- lib/zint/cep_net.rb
 - lib/zint/channel.rb
 - lib/zint/codabar.rb
 - lib/zint/codablock_f.rb
 - lib/zint/code11.rb
 - lib/zint/code128.rb
+- lib/zint/code128ab.rb
 - lib/zint/code128b.rb
 - lib/zint/code16k.rb
 - lib/zint/code32.rb
@@ -103,7 +214,6 @@ files:
 - lib/zint/dbarstk.rb
 - lib/zint/dependencies.rb
 - lib/zint/dot_code.rb
-- lib/zint/dotty_mode.rb
 - lib/zint/dpd.rb
 - lib/zint/dpident.rb
 - lib/zint/dpleit.rb
@@ -132,12 +242,13 @@ files:
 - lib/zint/korea_post.rb
 - lib/zint/logmars.rb
 - lib/zint/mailmark.rb
+- lib/zint/mailmark_2d.rb
+- lib/zint/mailmark_4s.rb
 - lib/zint/maxi_code.rb
 - lib/zint/micro_pdf417.rb
 - lib/zint/micro_qr.rb
 - lib/zint/msiplessey.rb
 - lib/zint/native.rb
-- lib/zint/noascii.rb
 - lib/zint/nve18.rb
 - lib/zint/one_code.rb
 - lib/zint/pdf417.rb
@@ -157,7 +268,7 @@ files:
 - lib/zint/rssexp.rb
 - lib/zint/rssexpstack.rb
 - lib/zint/rssltd.rb
-- lib/zint/stdout.rb
+- lib/zint/structs/structapp.rb
 - lib/zint/structs/symbol.rb
 - lib/zint/structs/vector.rb
 - lib/zint/structs/vector_circle.rb
@@ -172,11 +283,12 @@ files:
 - lib/zint/upc_e.rb
 - lib/zint/upc_e_chk.rb
 - lib/zint/upnqr.rb
+- lib/zint/upu_s10.rb
 - lib/zint/uspsimail.rb
 - lib/zint/version.rb
 - lib/zint/vin.rb
 - lib/zint/zint_recipe.rb
-- ports/archives/zint-2.10.0-src.tar.gz
+- ports/archives/zint-2.12.0-src.tar.gz
 homepage: https://github.com/api-walker/ruby-zint
 licenses:
 - MIT
@@ -185,7 +297,13 @@ metadata:
   source_code_uri: https://github.com/api-walker/ruby-zint
   msys2_mingw_dependencies: cmake libpng
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--main"
+- README.md
+- "--title"
+- Ruby FFI binding for libzint
+- "--exclude"
+- "/ext.ruby-zint/"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

data/lib/zint/bind.rb

@@ -1,7 +0,0 @@
-module Zint
-  class Bind < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_BIND, options: options)
-    end
-  end
-end

data/lib/zint/box.rb

@@ -1,7 +0,0 @@
-module Zint
-  class Box < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_BOX, options: options)
-    end
-  end
-end

data/lib/zint/dotty_mode.rb

@@ -1,7 +0,0 @@
-module Zint
-  class DottyMode < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_DOTTY_MODE, options: options)
-    end
-  end
-end

data/lib/zint/noascii.rb

@@ -1,7 +0,0 @@
-module Zint
-  class NoAscii < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_NO_ASCII, options: options)
-    end
-  end
-end

data/lib/zint/stdout.rb

@@ -1,7 +0,0 @@
-module Zint
-  class Stdout < Barcode
-    def initialize(value: nil, input_file: nil, options: {})
-      super(value: value, input_file: input_file, type: Zint::BARCODE_STDOUT, options: options)
-    end
-  end
-end