ruby-zint 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f734d5ae4c7959fb5753621a438396bccf285508bb17d80a847e80722f30378
-  data.tar.gz: 2207324efb9029cd4f6423b4b1aa04d8d8f9339e3fcca5464d048162c72f631d
+  metadata.gz: ccdb5e197e8d714e8f2d336b7448a1e104a69a5969b2d811ee6b0ef8998e6cac
+  data.tar.gz: 547681f881a38f9168ac6330f07f300f578e2655eb3241633992e619394239e9
 SHA512:
-  metadata.gz: 58b054d6ca8c39d9421a9dfdc49517402659b0935455fc61d0d3b7a65791980ef93b8ce10c36a820940d1a54240589dd928c6cb6ef618e7d87dddd655ae450b0
-  data.tar.gz: 9b7184006218407385bd2f84c1eb465ab3aa1742b08a98eae58dde5a6653e839d80835f8d234f2d6f768908b10926de94f215a32d6446c0c1de2e202f9a85a7b
+  metadata.gz: 772885463ca263b7a44405a78851961817a04d97b7e2fe2bb7691a5f5b06c0a7c2055bcf5f9dcfc07e1c2b5d235dbf75dcd8a161d5b0d2d2f04629fb4fb603b4
+  data.tar.gz: 565dcf8defee2948e4a4335e9681111056b7ee81a5dd03134f77cb030425131829964f7e2847813ee8866e61de3210e1796f855ae9c09ad601b623a8609dd9e4

data/.standard.yml

@@ -1,3 +1,5 @@
 parallel: true
 format: progress
 ruby_version: 2.6
+ignore:
+  - 'ext/ruby-zint/tmp/**/*'

data/Gemfile

@@ -14,3 +14,5 @@ gem "chunky_png"
 gem "byebug"
 
 gem "standard", "~> 1.3"
+
+gem "mini_portile2"

data/README.md

@@ -8,19 +8,41 @@ See the [documentation](https://rubydoc.info/github/api-walker/ruby-zint) for a
 
 ## Installation
 
-Install the libzint binary with your package manager (eg. `apt install zint` or perhaps `brew install zint`).
+By default ruby-zint first tries to use libzint installed on the system.
+If libzint can't be found or if it isn't a supported version, then the zint version, bundled into the gem, is compiled and used.
+Both install methods can be enforced by using `--enable-system-libzint` or `--disable-system-libzint` options, see below.
+
+### With libzint source code (recommended)
+First install CMake with your package manager (e. g. `apt install cmake`).
+
+Afterwards install the gem and force builtin libzint:
+
+```
+$ gem install ruby-zint -- --disable-system-libzint
+```
+
+### With system libraries
+
+Install the libzint binary with your package manager (e. g. `apt install zint` or perhaps `brew install zint`).
 
 Other platforms require building [from source](https://www.zint.org.uk/manual/chapter/2).
 
 **NOTE:** It is assumed that you are using libzint with the version [2.10](https://sourceforge.net/projects/zint/files/zint/2.10.0/).
 
-Then install this gem with:
+Then install this gem and enforce system libzint:
 
 ```
-$ gem install ruby-zint
+$ gem install ruby-zint -- --enable-system-libzint
 ```
 
-Or include `gem "ruby-zint"` in your Gemfile.
+### Gemfile
+
+Include `gem "ruby-zint"` in your Gemfile.
+Optionally set the install option by running bundler like so:
+
+```
+bundle config build.ruby-zint --enable-system-libzint
+```
 
 ## Usage
 
@@ -41,12 +63,12 @@ png = ChunkyPNG::Image.new(bitmap.width, bitmap.height, ChunkyPNG::Color::TRANSP
 white = ChunkyPNG::Color("white")
 black = ChunkyPNG::Color("black")
 
-bitmap = barcode.to_buffer
+bitmap = barcode.to_bitmap
 bitmap.pixels.each do |pixel|
-  png.compose_pixel(pixel.x, pixel.y, (pixel.colour == "K") ? black : white)
+  png.compose_pixel(pixel.x, pixel.y, (pixel.colour == "1") ? black : white)
 end
 
-png.save(buffer_outfile)
+png.save("out.png")
 
 # Use vector export
 vector_struct = barcode.to_vector

data/Rakefile

@@ -1,8 +1,20 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require_relative "lib/zint/zint_recipe"
+
+CLOBBER.include "pkg"
+CLEAN.include "ports"
+CLEAN.include "tmp"
+CLEAN.include "ext/ruby-zint/tmp"
 
 RSpec::Core::RakeTask.new(:spec)
 
 require "standard/rake"
 
 task default: %i[spec standard]
+
+task gem: :build
+task :compile do
+  sh "ruby -C ext/ruby-zint extconf.rb --disable-system-libzint"
+  sh "make -C ext/ruby-zint install RUBYARCHDIR=../../lib"
+end

data/ext/ruby-zint/extconf.rb

@@ -0,0 +1,86 @@
+# #!/usr/bin/env ruby
+
+require "rubygems"
+require "ffi"
+require "fileutils"
+
+if RUBY_PLATFORM.match?(/java/)
+  # JRuby's C extension support is disabled by default, so we can not use it
+
+  # Implement very simple verions of mkmf-helpers used below
+  def enable_config(name, default = nil)
+    if ARGV.include?("--enable-#{name}")
+      true
+    elsif ARGV.include?("--disable-#{name}")
+      false
+    else
+      default
+    end
+  end
+
+  def arg_config(name)
+    ARGV.include?(name)
+  end
+else
+  require "mkmf"
+end
+
+if RUBY_PLATFORM.match?(/darwin/)
+  ENV["SDKROOT"] ||= `xcrun --sdk macosx --show-sdk-path`.chomp
+end
+
+def do_help
+  print <<~HELP
+    usage: ruby #{$0} [options]
+        --enable-system-libzint / --disable-system-libzint
+          Force use of system or builtin libzint library.
+          Default is to prefer system libraries and fallback to builtin.
+  HELP
+  exit! 0
+end
+
+do_help if arg_config("--help")
+
+def libzint_usable?
+  m = Module.new do
+    extend FFI::Library
+
+    ffi_lib(%w[libzint.so.2.10 libzint zint])
+    attach_function(:ZBarcode_Version, [], :int32)
+  end
+
+  (21000...21100) === m.ZBarcode_Version
+rescue LoadError
+  false
+end
+
+def build_bundled_libzint
+  puts "Build"
+  require_relative "../../lib/zint/zint_recipe"
+
+  recipe = Zint::ZintRecipe.new
+  recipe.cook_and_activate
+  recipe.path
+end
+
+unless enable_config("system-libzint", libzint_usable?)
+  # Unable to load libzint library on this system,
+  # so we build our bundled version:
+  libzint_path = build_bundled_libzint
+end
+
+# Create a Makefile which copies the libzint library files to the gem's lib dir.
+File.open("Makefile", "wb") do |mf|
+  mf.puts <<~EOT
+    RUBYARCHDIR = #{RbConfig::MAKEFILE_CONFIG["sitearchdir"].dump}
+    all:
+    clean:
+    install:
+  EOT
+
+  if libzint_path
+    mf.puts <<-EOT
+	cp -r #{libzint_path.dump}/*/libzint* $(RUBYARCHDIR)
+    EOT
+  end
+end

data/lib/zint/barcode.rb

@@ -5,14 +5,12 @@ module Zint
   #   barcode = Zint::Barcode.new(value: "Test", type: Zint::BARCODE_QRCODE, options: {option_1: 1})
   #   barcode.to_file(path: "qr.png")
   class Barcode
+    include Native
+
     # @return [String, NilClass] Content of the barcode
     attr_accessor :value
     # @return [String, NilClass] Path to input file with content of the barcode
     attr_accessor :input_file
-    # @return [Integer] Type of barcode
-    attr_reader :type
-    # @return [Zint::Structs::Symbol] The underlying FFI struct of the Zint C struct
-    attr_reader :zint_symbol
 
     # @param value [String, NilClass] Content of the barcode
     # @param input_file [String, NilClass] Path to input file with content of the barcode
@@ -27,22 +25,10 @@ module Zint
         @zint_symbol[key] = value
       end
 
-      @type = type
       @value = value
       @input_file = input_file
     end
 
-    # Sets type of barcode
-    #
-    # @param type [Integer] Type of barcode
-    def type=(type)
-      @type = type
-
-      call_function(:ZBarcode_Clear, zint_symbol)
-
-      @zint_symbol[:symbology] = type
-    end
-
     # Exports barcode to file
     #
     # @param path [String] Path to export file
@@ -51,9 +37,9 @@ module Zint
       @zint_symbol[:outfile] = path
 
       if input_file
-        call_function(:ZBarcode_Encode_File_and_Print, zint_symbol, input_file, rotate_angle)
+        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, 0, rotate_angle)
       end
     end
 
@@ -79,37 +65,34 @@ module Zint
     # Exports barcode to buffer
     #
     # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
-    # @param raw_bitmap [Boolean] Export raw zint bitmap
-    # @return [Zint::Bitmap, String] Exported memory file
-    def to_buffer(rotate_angle: 0, raw_bitmap: false)
+    # @return [String] Exported barcode buffer
+    def to_buffer(rotate_angle: 0)
       @zint_symbol[:output_options] = Zint::OUT_BUFFER_INTERMEDIATE
 
       if input_file
-        call_function(:ZBarcode_Encode_File_and_Buffer, zint_symbol, input_file, rotate_angle)
+        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, 0, rotate_angle)
       end
 
-      zint_bitmap = zint_symbol[:bitmap].read_string((zint_symbol[:bitmap_width] * zint_symbol[:bitmap_height]))
+      @zint_symbol[:bitmap].read_bytes((@zint_symbol[:bitmap_width] * @zint_symbol[:bitmap_height]))
+    end
 
-      if raw_bitmap
-        zint_bitmap
-      else
-        pixels = []
-        zint_symbol[:bitmap_height].times do |row|
-          zint_symbol[:bitmap_width].times do |column|
-            pixel = zint_bitmap.slice!(0, 1)
-            colour = if %w[0 1].include?(pixel)
-              (pixel == "1") ? "K" : "W"
-            else
-              pixel
-            end
-            pixels << BitmapPixel.new(column, row, colour)
-          end
-        end
+    # Exports barcode to buffer
+    #
+    # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
+    # @return [Zint::Bitmap] Exported bitmap
+    def to_bitmap(rotate_angle: 0)
+      zint_bitmap = to_buffer(rotate_angle: rotate_angle)
 
-        Bitmap.new(zint_symbol[:bitmap_width], zint_symbol[:bitmap_height], pixels)
+      pixels = []
+      @zint_symbol[:bitmap_height].times do |row|
+        @zint_symbol[:bitmap_width].times do |column|
+          pixels << BitmapPixel.new(column, row, zint_bitmap[pixels.size])
+        end
       end
+
+      Bitmap.new(@zint_symbol[:bitmap_width], @zint_symbol[:bitmap_height], pixels)
     end
 
     # Exports barcode as Zint vector
@@ -118,28 +101,391 @@ module Zint
     # @return [Zint::Structs::Vector] Vector data of barcode
     def to_vector(rotate_angle: 0)
       if input_file
-        call_function(:ZBarcode_Encode_File_and_Buffer_Vector, zint_symbol, input_file, rotate_angle)
+        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, 0, rotate_angle)
       end
 
-      Structs::Vector.new(zint_symbol[:vector])
+      v = @zint_symbol[:vector]
+      # Avoid garbage collection of Symbol before Vector, since the Vector is also freed by ZBarcode_Delete()
+      v.instance_variable_set(:@symbol, @zint_symbol)
+      v
+    end
+
+    # Free barcode and all memory associated with it.
+    def free
+      @zint_symbol.pointer.free
+    end
+
+    # Attributes
+
+    # Gets type of barcode
+    def symbology
+      @zint_symbol[:symbology]
+    end
+
+    # Sets type of barcode
+    #
+    # @param type [Integer] Type of barcode
+    def symbology=(type)
+      reset_symbol
+
+      @zint_symbol[:symbology] = type
+    end
+
+    # Gets height of barcode
+    def height
+      @zint_symbol[:height]
+    end
+
+    # Sets height of barcode
+    #
+    # @param height [Float] Height of barcode
+    def height=(height)
+      reset_symbol
+
+      @zint_symbol[:height] = height
+    end
+
+    # Gets scale of barcode
+    def scale
+      @zint_symbol[:scale]
+    end
+
+    # Sets scale of barcode
+    #
+    # @param scale [Float] Scale of barcode
+    def scale=(scale)
+      reset_symbol
+
+      @zint_symbol[:scale] = scale
+    end
+
+    # Gets whitespace width of barcode
+    def whitespace_width
+      @zint_symbol[:whitespace_width]
+    end
+
+    # Sets whitespace width of barcode
+    #
+    # @param whitespace width [Integer] Whitespace width of barcode
+    def whitespace_width=(whitespace_width)
+      reset_symbol
+
+      @zint_symbol[:whitespace_width] = whitespace_width
+    end
+
+    # Gets whitespace height of barcode
+    def whitespace_height
+      @zint_symbol[:whitespace_height]
+    end
+
+    # Sets whitespace height of barcode
+    #
+    # @param whitespace height [Integer] Whitespace height of barcode
+    def whitespace_height=(whitespace_height)
+      reset_symbol
+
+      @zint_symbol[:whitespace_height] = whitespace_height
+    end
+
+    # Gets border width of barcode
+    def border_width
+      @zint_symbol[:border_width]
+    end
+
+    # Sets border width of barcode
+    #
+    # @param border width [Integer] Border width of barcode
+    def border_width=(border_width)
+      reset_symbol
+
+      @zint_symbol[:border_width] = border_width
+    end
+
+    # Gets output options of barcode
+    def output_options
+      @zint_symbol[:output_options]
+    end
+
+    # Sets output options of barcode
+    #
+    # @param output options [Integer] Output options of barcode
+    def output_options=(output_options)
+      reset_symbol
+
+      @zint_symbol[:output_options] = output_options
+    end
+
+    # Gets foreground colour of barcode
+    def fgcolour
+      @zint_symbol[:fgcolour]
+    end
+
+    # Sets foreground colour of barcode
+    #
+    # @param fgcolour [String] Foreground colour of barcode
+    def fgcolour=(fgcolour)
+      reset_symbol
+
+      @zint_symbol[:fgcolour] = fgcolour
+    end
+
+    # Gets background colour of barcode
+    def bgcolour
+      @zint_symbol[:bgcolour]
+    end
+
+    # Sets background colour of barcode
+    #
+    # @param bgcolour [String] Background color of barcode
+    def bgcolour=(bgcolour)
+      reset_symbol
+
+      @zint_symbol[:bgcolour] = bgcolour
+    end
+
+    # Gets outfile of barcode
+    def outfile
+      @zint_symbol[:outfile]
+    end
+
+    # Gets option 1 of barcode
+    def option_1
+      @zint_symbol[:option_1]
+    end
+
+    # Sets option 1 of barcode
+    #
+    # @param option_1 [Integer] Option 1 of barcode
+    def option_1=(option_1)
+      reset_symbol
+
+      @zint_symbol[:option_1] = option_1
+    end
+
+    # Gets option 2 of barcode
+    def option_2
+      @zint_symbol[:option_2]
+    end
+
+    # Sets option 2 of barcode
+    #
+    # @param option 2 [Integer] Option 2 of barcode
+    def option_2=(option_2)
+      reset_symbol
+
+      @zint_symbol[:option_2] = option_2
+    end
+
+    # Gets option 3 of barcode
+    def option_3
+      @zint_symbol[:option_3]
+    end
+
+    # Sets option 3 of barcode
+    #
+    # @param option 3 [Integer] Option 3 of barcode
+    def option_3=(option_3)
+      reset_symbol
+
+      @zint_symbol[:option_3] = option_3
+    end
+
+    # Gets show_hrt of barcode
+    def show_hrt
+      @zint_symbol[:show_hrt]
+    end
+
+    # Sets show_hrt of barcode
+    # Set to 0 to hide text.
+    #
+    # @param show_hrt [Integer] show_hrt of barcode
+    def show_hrt=(show_hrt)
+      reset_symbol
+
+      @zint_symbol[:show_hrt] = show_hrt
+    end
+
+    # Gets font size of barcode
+    def fontsize
+      @zint_symbol[:fontsize]
+    end
+
+    # Sets font size of barcode
+    #
+    # @param font size [Integer] Font size of barcode
+    def fontsize=(fontsize)
+      reset_symbol
+
+      @zint_symbol[:fontsize] = fontsize
+    end
+
+    # Gets input mode of barcode
+    def input_mode
+      @zint_symbol[:input_mode]
+    end
+
+    # Sets input mode of barcode
+    #
+    # @param input_mode [Integer] Input mode of barcode
+    def input_mode=(input_mode)
+      reset_symbol
+
+      @zint_symbol[:input_mode] = input_mode
+    end
+
+    # Gets ECI of barcode
+    def eci
+      @zint_symbol[:eci]
+    end
+
+    # Sets ECI of barcode
+    #
+    # @param eci [Integer] ECI of barcode
+    def eci=(eci)
+      reset_symbol
+
+      @zint_symbol[:eci] = eci
+    end
+
+    # Gets text of barcode
+    def text
+      @zint_symbol[:text]
+    end
+
+    # Sets text of barcode
+    #
+    # @param text [String] Text of barcode
+    def text=(text)
+      reset_symbol
+
+      @zint_symbol[:text] = text
+    end
+
+    # Gets rows of barcode
+    def rows
+      @zint_symbol[:rows]
+    end
+
+    # Gets width of barcode
+    def width
+      @zint_symbol[:width]
+    end
+
+    # Gets primary message data for more complex symbols, with a terminating NUL, of barcode
+    def primary
+      @zint_symbol[:primary]
+    end
+
+    # Sets primary message of barcode
+    #
+    # @param primary [String] Primary of barcode
+    def primary=(primary)
+      reset_symbol
+
+      @zint_symbol[:primary] = primary
+    end
+
+    # Gets encoded_data of barcode
+    def encoded_data
+      @zint_symbol[:encoded_data]
+    end
+
+    # Sets encoded_data of barcode
+    #
+    # @param encoded_data [String] Encoded data of barcode
+    def encoded_data=(encoded_data)
+      reset_symbol
+
+      @zint_symbol[:encoded_data] = encoded_data
+    end
+
+    # Gets row height of barcode
+    def row_height
+      @zint_symbol[:row_height]
+    end
+
+    # Gets error text of barcode
+    def errtxt
+      @zint_symbol[:errtxt]
+    end
+
+    # Gets bitmap width of barcode
+    def bitmap_width
+      @zint_symbol[:bitmap_width]
+    end
+
+    # Gets bitmap height of barcode
+    def bitmap_height
+      @zint_symbol[:bitmap_height]
+    end
+
+    # Gets bitmap byte length of barcode
+    def bitmap_byte_length
+      @zint_symbol[:bitmap_byte_length]
+    end
+
+    # Gets dot size of barcode
+    def dot_size
+      @zint_symbol[:dot_size]
+    end
+
+    # Sets dot size of barcode
+    #
+    # @param dot size [Float] Dot size of barcode
+    def dot_size=(dot_size)
+      reset_symbol
+
+      @zint_symbol[:dot_size] = dot_size
+    end
+
+    # Gets debug level of barcode
+    def debug
+      @zint_symbol[:debug]
+    end
+
+    # Sets debug level of barcode
+    #
+    # @param debug [Integer] Debug level of barcode
+    def debug=(debug)
+      reset_symbol
+
+      @zint_symbol[:debug] = debug
+    end
+
+    # Gets warn level of barcode
+    def warn_level
+      @zint_symbol[:warn_level]
+    end
+
+    # Sets warn level of barcode
+    #
+    # @param warn_level [Integer] Warn level of barcode
+    def warn_level=(warn_level)
+      reset_symbol
+
+      @zint_symbol[:warn_level] = warn_level
     end
 
     private
 
+    def reset_symbol
+      call_function(:ZBarcode_Clear, @zint_symbol)
+    end
+
     def call_function(function_name, *args)
-      error_code = Zint.send(function_name.to_s, *args)
+      error_code = Native.send(function_name.to_sym, *args)
 
       if Zint::ERRORS[error_code]
-        Zint.raise_error(error_code, zint_symbol[:errtxt])
+        Native.raise_error(error_code, @zint_symbol[:errtxt])
       end
 
       error_code
     end
 
     def create_symbol(type)
-      symbol = Structs::Symbol.new(Zint.ZBarcode_Create)
+      symbol = Native.ZBarcode_Create
       symbol[:symbology] = type
 
       symbol

data/lib/zint/dependencies.rb

@@ -0,0 +1,8 @@
+module Zint
+  ZINT_VERSION = ENV["ZINT_VERSION"] || "2.10.0"
+  # ZINT_SOURCE_URI = "file://#{File.join(File.expand_path("../../../", __FILE__))}/ports/archives/zint-#{ZINT_VERSION}-src.tar.gz"
+  ZINT_SOURCE_URI = "https://downloads.sourceforge.net/zint/zint-#{ZINT_VERSION}-src.tar.gz"
+  ZINT_SOURCE_SHA1 = "e4a8a5ccbc9e1901e4b592ccc80e17184f2ff5e8"
+
+  MINI_PORTILE_VERSION = "~> 2.1"
+end