ruby-zint 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 486ea5eb1e9c5382337612a19ce2101cbbcba980dc30b9d1ff702f2dbc4beba9
-  data.tar.gz: 0be779d097b3e9f99d7c79d4f8da8895c2e8931ea6be84165f77d40bc9f0a5a8
+  metadata.gz: 64af83d59b1d29bdae5808430c36817e3517bee6cd7bbd34147cb377cccc02b2
+  data.tar.gz: 17a44a73c35894b6b7f7f8b884e18fa622400746cf9331c19e68b43994a2f958
 SHA512:
-  metadata.gz: a33d8244d461e0dac91b66f086aa153d26ed188ae418fa3b1ba1d03139e424d678b2ef92a988f8db7c23d6e46627912e2f04a753c66e77b7c5b1b51e9383f3e5
-  data.tar.gz: c97890ca409f5393478f14b4630147229c8e4f282b640a51ff781d98fc8f4c31f42eaed3167d9e16d6b2dc021884af14fd92a75234f573bcbb46562db62d326d
+  metadata.gz: 580e3329db01adf7bae175780221cc3dbdbb45f4578e439e6c1cb6425e28ca7b0118f11576cb463d8588da6298ccf963f7edf481cba15b6b37d2d902bb1280b7
+  data.tar.gz: ce7b11a96fd7ce11a16ecd97b4b479beb2a2ca09eb67da67409096b0b0a6b1eedd77eb1059b3cd9894ec426b36df9f6ef5bd52720eb39b75b2db7e47276eaa33

data/Gemfile

@@ -16,3 +16,5 @@ gem "byebug"
 gem "standard", "~> 1.3"
 
 gem "mini_portile2"
+
+gem "yard"

data/README.md

@@ -44,6 +44,10 @@ Optionally set the install option by running bundler like so:
 bundle config build.ruby-zint --enable-system-libzint
 ```
 
+### PNG support
+
+Please install libpng (e. g. `apt install libpng-dev`) before installing the gem if you want to use the PNG format.
+
 ## Usage
 
 ```ruby

data/Rakefile

@@ -3,9 +3,12 @@ require "rspec/core/rake_task"
 require_relative "lib/zint/zint_recipe"
 
 CLOBBER.include "pkg"
-CLEAN.include "ports"
+CLOBBER.add("ports/*").exclude(%r{ports/archives$})
 CLEAN.include "tmp"
 CLEAN.include "ext/ruby-zint/tmp"
+CLEAN.include "lib/*.a"
+CLEAN.include "lib/*.so*"
+CLEAN.include "lib/*.dll*"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/zint/barcode.rb

@@ -25,7 +25,7 @@ module Zint
       @zint_symbol = Native.ZBarcode_Create
       self.symbology = symbology
       kwargs.each do |k, v|
-        send("#{k}=", v)
+        send(:"#{k}=", v)
       end
 
       @value = value
@@ -39,7 +39,7 @@ module Zint
     #                      Must end in .png, .gif, .bmp, .emf, .eps, .pcx, .svg, .tif or .txt
     # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
     def to_file(path:, rotate_angle: 0)
-      unless outfile == 'out.png'
+      unless outfile == "out.png"
         raise AlreadyGenerated, "to_file was already executed"
       end
       @zint_symbol[:outfile] = path
@@ -47,7 +47,7 @@ module Zint
       if input_file
         call_function(:ZBarcode_Encode_File_and_Print, @zint_symbol, input_file, rotate_angle)
       else
-        call_function(:ZBarcode_Encode_and_Print, @zint_symbol, value, 0, rotate_angle)
+        call_function(:ZBarcode_Encode_and_Print, @zint_symbol, value, value.bytesize, rotate_angle)
       end
     end
 
@@ -83,10 +83,10 @@ module Zint
       if input_file
         call_function(:ZBarcode_Encode_File_and_Buffer, @zint_symbol, input_file, rotate_angle)
       else
-        call_function(:ZBarcode_Encode_and_Buffer, @zint_symbol, value, 0, rotate_angle)
+        call_function(:ZBarcode_Encode_and_Buffer, @zint_symbol, value, value.bytesize, rotate_angle)
       end
 
-      @zint_symbol[:bitmap].read_bytes((@zint_symbol[:bitmap_width] * @zint_symbol[:bitmap_height]))
+      @zint_symbol[:bitmap].read_bytes(@zint_symbol[:bitmap_width] * @zint_symbol[:bitmap_height])
     end
 
     # Exports barcode to buffer
@@ -117,7 +117,7 @@ module Zint
       if input_file
         call_function(:ZBarcode_Encode_File_and_Buffer_Vector, @zint_symbol, input_file, rotate_angle)
       else
-        call_function(:ZBarcode_Encode_and_Buffer_Vector, @zint_symbol, value, 0, rotate_angle)
+        call_function(:ZBarcode_Encode_and_Buffer_Vector, @zint_symbol, value, value.bytesize, rotate_angle)
       end
 
       v = @zint_symbol[:vector]
@@ -126,6 +126,20 @@ module Zint
       v
     end
 
+    # Encodes the symbology without exporting to a bitmap or vector data
+    #
+    # This method fills the output accessors of the {Barcode} object.
+    #
+    # @return self
+    def encode
+      if input_file
+        call_function(:ZBarcode_Encode_File, @zint_symbol, input_file)
+      else
+        call_function(:ZBarcode_Encode, @zint_symbol, value, value.bytesize)
+      end
+      self
+    end
+
     # Free barcode and all memory associated with it.
     #
     # Note: This method is dangerous insofar, that previously exported vectors (by #to_vector ) are no longer usable and any access to them will result in a segfault.
@@ -377,13 +391,6 @@ module Zint
       @zint_symbol[:text].to_s.force_encoding(Encoding::UTF_8)
     end
 
-    # Sets Human Readable Text (if any), UTF-8, NUL-terminated (output only) of barcode
-    #
-    # @param text [String] Text of barcode
-    def text=(text)
-      @zint_symbol[:text] = text
-    end
-
     # Gets rows of barcode
     def rows
       @zint_symbol[:rows]
@@ -406,23 +413,57 @@ module Zint
       @zint_symbol[:primary] = primary
     end
 
-    # Gets encoded data of barcode
-    def encoded_data
+    # Gets encoded data of barcode as internal FFI::StructLayout::CharArray object
+    #
+    # Don't use this method, it might be changed in future releases.
+    def encoded_data_raw_ffi
       @zint_symbol[:encoded_data]
     end
 
-    # Sets encoded data (output only). Allows for rows of 1144 modules of barcode
-    #
-    # @param encoded_data [String] Encoded data of barcode
-    def encoded_data=(encoded_data)
-      @zint_symbol[:encoded_data] = encoded_data
+    # Return the raw encoded data as array of strings.
+    #
+    # Each row of the symbology is represented by one item of the array.
+    # The columns are represented by "0" and "1" characters of the stings.
+    #
+    # @example
+    #   Zint::DataMatrix.new(value: "12345").encode.encoded_data_as_array_of_strings
+    #   # => ["1010101010",
+    #   #     "1101100111",
+    #   #     "1100010110",
+    #   #     "1100110101",
+    #   #     "1100111000",
+    #   #     "1000011111",
+    #   #     "1101011110",
+    #   #     "1110000111",
+    #   #     "1101100100",
+    #   #     "1111111111"]
+    #
+    # @return [Array<String>] encoded data
+    def encoded_data_as_array_of_strings
+      rows.times.map do |row|
+        binstr = @zint_symbol[:encoded_data].to_ptr.get_bytes(144 * row, (width + 7) / 8)
+        binstr.unpack1("b*")[0, width]
+      end
     end
 
-    # Gets row height of barcode
-    def row_height
+    # Gets row heights of barcode as internal FFI::Struct::InlineArray object
+    #
+    # Don't use this method, it might be changed in future releases.
+    def row_height_raw_ffi
       @zint_symbol[:row_height]
     end
 
+    # Gets heights of all barcode rows
+    #
+    # @example
+    #   Zint::Kix.new(value: "130203").encode.row_heights
+    #   # => [3.0, 2.0, 3.0]
+    #
+    # @return [Array<Float>] row heights
+    def row_heights
+      @zint_symbol[:row_height].to_a[0, rows]
+    end
+
     # Gets error message in the event that an error occurred
     def errtxt
       @zint_symbol[:errtxt].to_s.force_encoding(Encoding::UTF_8)

data/lib/zint/native.rb

@@ -17,60 +17,60 @@ module Zint
     typedef :int32, :rotate_angle
     typedef :int32, :symbol_id
     typedef :uint32, :cap_flag
-    typedef :string, :source
+    typedef :pointer, :source
 
     # Create and initialize a symbol structure
-    attach_function(:ZBarcode_Create, [], :zint_symbol)
+    attach_function(:ZBarcode_Create, [], :zint_symbol, blocking: true)
 
     # Free any output buffers that may have been created and initialize output fields
-    attach_function(:ZBarcode_Clear, [:zint_symbol], :void)
+    attach_function(:ZBarcode_Clear, [:zint_symbol], :void, blocking: true)
 
     # Free a symbol structure, including any output buffers
     #
     # For use with ruby's garbage collector ZBarcode_Delete must be called with a plain :pointer and not an :zint_symbol.
-    attach_function(:ZBarcode_Delete, [:pointer], :void)
+    attach_function(:ZBarcode_Delete, [:pointer], :void, blocking: true)
 
     # Encode a barcode. If `length` is 0, `source` must be NUL-terminated.
-    attach_function(:ZBarcode_Encode, [:zint_symbol, :source, :length], :error_code)
+    attach_function(:ZBarcode_Encode, [:zint_symbol, :source, :length], :error_code, blocking: true)
 
     # Encode a barcode using input data from file `filename`
-    attach_function(:ZBarcode_Encode_File, [:zint_symbol, :filename], :error_code)
+    attach_function(:ZBarcode_Encode_File, [:zint_symbol, :filename], :error_code, blocking: true)
 
     # Output a previously encoded symbol to file `symbol->outfile`
-    attach_function(:ZBarcode_Print, [:zint_symbol, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Print, [:zint_symbol, :rotate_angle], :error_code, blocking: true)
 
     # Encode and output a symbol to file `symbol->outfile`
-    attach_function(:ZBarcode_Encode_and_Print, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_and_Print, [:zint_symbol, :source, :length, :rotate_angle], :error_code, blocking: true)
 
     # Encode a symbol using input data from file `filename` and output to file `symbol->outfile`
-    attach_function(:ZBarcode_Encode_File_and_Print, [:zint_symbol, :filename, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_File_and_Print, [:zint_symbol, :filename, :rotate_angle], :error_code, blocking: true)
 
     # Output a previously encoded symbol to memory as raster (`symbol->bitmap`)
-    attach_function(:ZBarcode_Buffer, [:zint_symbol, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Buffer, [:zint_symbol, :rotate_angle], :error_code, blocking: true)
 
     # Encode and output a symbol to memory as raster (`symbol->bitmap`)
-    attach_function(:ZBarcode_Encode_and_Buffer, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_and_Buffer, [:zint_symbol, :source, :length, :rotate_angle], :error_code, blocking: true)
 
     # Encode a symbol using input data from file `filename` and output to memory as raster (`symbol->bitmap`)
-    attach_function(:ZBarcode_Encode_File_and_Buffer, [:zint_symbol, :filename, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_File_and_Buffer, [:zint_symbol, :filename, :rotate_angle], :error_code, blocking: true)
 
     # Output a previously encoded symbol to memory as vector (`symbol->vector`)
-    attach_function(:ZBarcode_Buffer_Vector, [:zint_symbol, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Buffer_Vector, [:zint_symbol, :rotate_angle], :error_code, blocking: true)
 
     # Encode and output a symbol to memory as vector (`symbol->vector`)
-    attach_function(:ZBarcode_Encode_and_Buffer_Vector, [:zint_symbol, :source, :length, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_and_Buffer_Vector, [:zint_symbol, :source, :length, :rotate_angle], :error_code, blocking: true)
 
     # Encode a symbol using input data from file `filename` and output to memory as vector (`symbol->vector`)
-    attach_function(:ZBarcode_Encode_File_and_Buffer_Vector, [:zint_symbol, :filename, :rotate_angle], :error_code)
+    attach_function(:ZBarcode_Encode_File_and_Buffer_Vector, [:zint_symbol, :filename, :rotate_angle], :error_code, blocking: true)
 
     # Is `symbol_id` a recognized symbology?
-    attach_function(:ZBarcode_ValidID, [:symbol_id], :bool)
+    attach_function(:ZBarcode_ValidID, [:symbol_id], :bool, blocking: true)
 
     # Return the capability flags for symbology `symbol_id` that match `cap_flag`
-    attach_function(:ZBarcode_Cap, [:symbol_id, :cap_flag], :uint32)
+    attach_function(:ZBarcode_Cap, [:symbol_id, :cap_flag], :uint32, blocking: true)
 
     # Return the version of Zint linked to
-    attach_function(:ZBarcode_Version, [], :int32)
+    attach_function(:ZBarcode_Version, [], :int32, blocking: true)
 
     # Raises specific error for API return code
     #

data/lib/zint/structs/vector.rb

@@ -18,22 +18,22 @@ module Zint
         self[:width]
       end
 
-      # Calls the given block and passes a VectorRect object for each rectangle to be printed.
+      # Calls the given block and passes a {VectorRect} object for each rectangle to be printed.
       def each_rectangle(&block)
         each_vector(:rectangles, &block)
       end
 
-      # Calls the given block and passes a VectorHexagon object for each hexagon to be printed.
+      # Calls the given block and passes a {VectorHexagon} object for each hexagon to be printed.
       def each_hexagon(&block)
         each_vector(:hexagons, &block)
       end
 
-      # Calls the given block and passes a VectorString object for each text string to be printed.
+      # Calls the given block and passes a {VectorString} object for each text string to be printed.
       def each_string(&block)
         each_vector(:strings, &block)
       end
 
-      # Calls the given block and passes a VectorCircle object for each circle to be printed.
+      # Calls the given block and passes a {VectorCircle} object for each circle to be printed.
       def each_circle(&block)
         each_vector(:circles, &block)
       end

data/lib/zint/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ruby-zint
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Elias Fröhner
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -38,7 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
-description: 
 email:
 - apiwalker96@gmail.com
 executables: []
@@ -296,7 +294,7 @@ metadata:
   homepage_uri: https://github.com/api-walker/ruby-zint
   source_code_uri: https://github.com/api-walker/ruby-zint
   msys2_mingw_dependencies: cmake libpng
-post_install_message: 
+  documentation_uri: https://rubydoc.info/gems/ruby-zint
 rdoc_options:
 - "--main"
 - README.md
@@ -317,8 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
-signing_key: 
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Ruby FFI binding for libzint
 test_files: []