ruby-zint 1.5.0-x86_64-linux-gnu

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e880d27afdd8ede003d49eef0c9e05f7b1d1c7eed1708c4c7f6a1a00f1706edb
+  data.tar.gz: 4e93c70135736b41fe200d3b5a0c753e718a1f644ec981c5c9626df26b5f2f08
+SHA512:
+  metadata.gz: cb9bab70916801509ac6ca30328f9b011a5b078723361d64371ae1c8b122ba0c218ae081d6ca242fda3f6df580e943baa2163e6f0c6b488d7c66daa941ab3d09
+  data.tar.gz: 89c473ad72a662ca369988f7bed84d44f49bc6b28ca8d73fba05cb2d73380b7725d5eaaf2f26a3fc832f1f5ae687de275e6a0e08a340697c553fa9555ea28bb9

data/.yardopts

@@ -0,0 +1,9 @@
+--readme          README.md
+--title           'Ruby FFI binding for libzint'
+--exclude         '/ext.ruby-zint/'
+--no-private
+--charset utf-8
+lib/**/*.rb
+-
+README.md
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Elias Fröhner
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,146 @@
+# ruby-zint
+
+[![CI](https://github.com/api-walker/ruby-zint/actions/workflows/main.yml/badge.svg)](https://github.com/api-walker/ruby-zint/actions/workflows/main.yml)
+
+This gem is a Ruby FFI binding for the [libzint](http://www.zint.org.uk) barcode generation library.
+
+See the [documentation](https://rubydoc.info/github/api-walker/ruby-zint) for a full API description.
+
+## Installation
+
+Install via RubyGems:
+
+    gem install ruby-zint
+
+This installs the binary gem, specific to the running platform by default.
+
+### Binary gem
+
+The binary gems don't depend on the libzint package on the running system or on CMake or libpng.
+They have libzint builtin and should just work.
+
+### Source gem
+
+If for some reason the binary gem doesn't work for you, the source gem can be installed alternatively.
+It can be forced by:
+
+    gem uninstall ruby-zint --all
+    gem install ruby-zint --platform ruby
+
+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 instead.
+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`).
+Please also install libpng (e. g. `apt install libpng-dev`) before installing the gem if you want to use the PNG format.
+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.15](https://sourceforge.net/projects/zint/files/zint/2.15.0/).
+
+Then install this gem and enforce system libzint:
+
+```
+$ gem install ruby-zint -- --enable-system-libzint
+```
+
+### Gemfile
+
+Include `gem "ruby-zint"` in your Gemfile.
+To make sure, the necessary platforms and the source gem are fetched by bundler, they can be added like so
+
+```
+bundle lock --add-platform x86_64-linux-gnu
+bundle lock --add-platform arm64-darwin
+bundle lock --add-platform x64-mingw-ucrt
+bundle lock --add-platform ruby
+bundle package --all-platforms
+```
+
+A re-run of `bundle package` is also necessary after `bundle update`, in order to retrieve the new specific gems of all platforms.
+
+If the binary gems don't work for some reason, it's easy to force the usage of the source gem in the Gemfile:
+
+```
+gem "ruby-zint", force_ruby_platform: true
+```
+
+Optionally set the install option by running bundler like so:
+
+```
+bundle config build.ruby-zint --enable-system-libzint
+```
+
+## Usage
+
+```ruby
+require "zint"
+
+barcode = Zint::Barcode.new(value: "Test", symbology: Zint::BARCODE_CODE128)
+
+# Export to file
+barcode.to_file(path: "out.png")
+
+# Export file to memory
+barcode.to_memory_file(extension: ".png")
+
+# Write from Bitmap to own canvas
+require "chunky_png"
+png = ChunkyPNG::Image.new(bitmap.width, bitmap.height, ChunkyPNG::Color::TRANSPARENT)
+white = ChunkyPNG::Color("white")
+black = ChunkyPNG::Color("black")
+
+bitmap = barcode.to_bitmap
+bitmap.pixels.each do |pixel|
+  png.compose_pixel(pixel.x, pixel.y, (pixel.colour == "1") ? black : white)
+end
+
+png.save("out.png")
+
+# Use vector export
+vec = Zint::Qr.new(value: "Test").to_vector
+png = ChunkyPNG::Image.new(vec.width.to_i, vec.height.to_i, ChunkyPNG::Color::WHITE)
+vec.each_rectangle do |rec|
+  png.rect(rec.x.to_i, rec.y.to_i,
+      rec.x.to_i+rec.width.to_i-1, rec.y.to_i+rec.height.to_i-1,
+      ChunkyPNG::Color::BLACK, ChunkyPNG::Color::BLACK)
+end
+png.save("out.png")
+
+# See also manual: https://zint.org.uk/manual/chapter/5#buffering-symbols-in-memory-vector
+
+# Use file as input
+barcode = Zint::Barcode.new(input_file: "/tmp/test.txt")
+barcode.to_file(path: "out.png")
+
+# Use of comfort classes
+
+# EAN
+ean_barcode = Zint::Eanx.new(value: "012345678912")
+ean_barcode.to_file(path: "ean.png")
+
+# Code128
+code_128_barcode = Zint::Code128.new(value: "012345678912")
+code_128_barcode.to_file(path: "code_128.png")
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/api-walker/ruby-zint.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+The project is based on the work and ideas of Angel Pizarro's [zint](https://github.com/delagoya/zint). I would also like to say a big thank you to [Lars Kanis](https://github.com/larskanis) for his great contributions.

data/ext/ruby-zint/extconf.rb

@@ -0,0 +1,113 @@
+# #!/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.15 libzint zint])
+    attach_function(:ZBarcode_Version, [], :int32)
+  end
+
+  (21500...21600) === m.ZBarcode_Version
+rescue LoadError
+  false
+end
+
+def build_bundled_libzint
+  puts "Build libzint and dependencies"
+  require_relative "../../lib/zint/zint_recipe"
+
+  recipe_zlib = Zint::ZintRecipe.new("zlib", Zint::LIBZ_VERSION, Zint::LIBZ_SOURCE_URI, Zint::LIBZ_SOURCE_SHA1)
+  recipe_zlib.configure_options += [
+    "-DCMAKE_C_FLAGS=-fPIC",
+    "-DZLIB_SHARED=OFF"
+  ]
+  recipe_zlib.cook_and_activate
+
+  recipe_png = Zint::ZintRecipe.new("libpng", Zint::LIBPNG_VERSION, Zint::LIBPNG_SOURCE_URI, Zint::LIBPNG_SOURCE_SHA1)
+  recipe_png.configure_options += [
+    "-DCMAKE_C_FLAGS=-fPIC",
+    "-DZLIB_ROOT=#{recipe_zlib.path}",
+    "-DPNG_SHARED=OFF"
+  ]
+  recipe_png.cook_and_activate
+
+  recipe = Zint::ZintRecipe.new("libzint", Zint::ZINT_VERSION, Zint::ZINT_SOURCE_URI, Zint::ZINT_SOURCE_SHA1)
+  recipe.configure_options += [
+    "-DZLIB_INCLUDE_DIR=#{recipe_zlib.path}/include",
+    "-DZLIB_LIBRARY=#{recipe_zlib.path}/lib/#{(RUBY_PLATFORM =~ /mingw/) ? "libzlibstatic.a" : "libz.a"}",
+    "-DPNG_PNG_INCLUDE_DIR=#{recipe_png.path}/include",
+    "-DPNG_LIBRARY=#{recipe_png.path}/lib/libpng.a"
+  ]
+  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
+
+if libzint_path
+  # For cross compiled gem
+  FileUtils.cp Dir["#{libzint_path}/*/libzint.*"].first, "libzint.#{RbConfig::CONFIG["DLEXT"]}", verbose: true
+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
+    # Only executed in source build
+    mf.puts <<-EOT
+	cp -r #{libzint_path.dump}/*/libzint* $(RUBYARCHDIR)
+    EOT
+  end
+end

data/lib/ruby-zint.rb

@@ -0,0 +1 @@
+require "zint"

data/lib/zint/aus_post.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Australia Post 4-State Barcode
+  class AusPost < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AUSPOST, **kwargs)
+    end
+  end
+end

data/lib/zint/aus_redirect.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Australia Post Redirection
+  class AusRedirect < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AUSREDIRECT, **kwargs)
+    end
+  end
+end

data/lib/zint/aus_reply.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Australia Post Reply Paid
+  class AusReply < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AUSREPLY, **kwargs)
+    end
+  end
+end

data/lib/zint/aus_route.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Australia Post Routing
+  class AusRoute < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AUSROUTE, **kwargs)
+    end
+  end
+end

data/lib/zint/azrune.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Aztec Runes
+  class Azrune < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AZRUNE, **kwargs)
+    end
+  end
+end

data/lib/zint/aztec.rb

@@ -0,0 +1,8 @@
+module Zint
+  # Aztec Code
+  class Aztec < Barcode
+    def initialize(value: nil, input_file: nil, **kwargs)
+      super(value: value, input_file: input_file, symbology: Zint::BARCODE_AZTEC, **kwargs)
+    end
+  end
+end