ruby-zint 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f734d5ae4c7959fb5753621a438396bccf285508bb17d80a847e80722f30378
-  data.tar.gz: 2207324efb9029cd4f6423b4b1aa04d8d8f9339e3fcca5464d048162c72f631d
+  metadata.gz: 7cbe79d9fd528474b3cffe957b55cf8cb4aec0bdc97cca55314dc675e74f58c3
+  data.tar.gz: a99a851ff4cfc42387d58e2d439c2ae01976fe03ad81595ccdc60cd94f0f5a89
 SHA512:
-  metadata.gz: 58b054d6ca8c39d9421a9dfdc49517402659b0935455fc61d0d3b7a65791980ef93b8ce10c36a820940d1a54240589dd928c6cb6ef618e7d87dddd655ae450b0
-  data.tar.gz: 9b7184006218407385bd2f84c1eb465ab3aa1742b08a98eae58dde5a6653e839d80835f8d234f2d6f768908b10926de94f215a32d6446c0c1de2e202f9a85a7b
+  metadata.gz: 75f8c14c3f4a3ad2f3990fa1c60204264f7120902e2ca31e2a51afc011c5e069d88bd3dcbeb0a8a73757163703c457c0ca49003da7470704afef01fb204585fe
+  data.tar.gz: '0689e71889b46f0278886f717ad3966c2a1b215dd6502666637913112fc84abad23f5ae604d0a1b82bcf2c0379d77975bedaa43887d24d2dab6295734abf0b23'

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/).
+**NOTE:** It is assumed that you are using libzint with the version [2.12](https://sourceforge.net/projects/zint/files/zint/2.12.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.12 libzint zint])
+    attach_function(:ZBarcode_Version, [], :int32)
+  end
+
+  (21200...21300) === 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/aus_post.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Australia Post 4-State Barcode
   class AusPost < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AUSPOST, options: options)

data/lib/zint/aus_redirect.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Australia Post Redirection
   class AusRedirect < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AUSREDIRECT, options: options)

data/lib/zint/aus_reply.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Australia Post Reply Paid
   class AusReply < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AUSREPLY, options: options)

data/lib/zint/aus_route.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Australia Post Routing
   class AusRoute < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AUSROUTE, options: options)

data/lib/zint/azrune.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Aztec Runes
   class Azrune < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AZRUNE, options: options)

data/lib/zint/aztec.rb

@@ -1,4 +1,5 @@
 module Zint
+  # Aztec Code
   class Aztec < Barcode
     def initialize(value: nil, input_file: nil, options: {})
       super(value: value, input_file: input_file, type: Zint::BARCODE_AZTEC, options: options)