ruby-zint 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f734d5ae4c7959fb5753621a438396bccf285508bb17d80a847e80722f30378
+  data.tar.gz: 2207324efb9029cd4f6423b4b1aa04d8d8f9339e3fcca5464d048162c72f631d
+SHA512:
+  metadata.gz: 58b054d6ca8c39d9421a9dfdc49517402659b0935455fc61d0d3b7a65791980ef93b8ce10c36a820940d1a54240589dd928c6cb6ef618e7d87dddd655ae450b0
+  data.tar.gz: 9b7184006218407385bd2f84c1eb465ab3aa1742b08a98eae58dde5a6653e839d80835f8d234f2d6f768908b10926de94f215a32d6446c0c1de2e202f9a85a7b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+parallel: true
+format: progress
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ruby-zint.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "simplecov", require: false
+
+gem "chunky_png"
+
+gem "byebug"
+
+gem "standard", "~> 1.3"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    ruby-zint (1.0.0)
+      ffi (~> 1.15)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    chunky_png (1.4.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    ffi (1.15.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.25.3)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  chunky_png
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  ruby-zint!
+  simplecov
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.4.8

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,80 @@
+# 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 the libzint binary with your package manager (eg. `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:
+
+```
+$ gem install ruby-zint
+```
+
+Or include `gem "ruby-zint"` in your Gemfile.
+
+## Usage
+
+```ruby
+require "zint"
+
+barcode = Zint::Barcode.new(value: "Test", type: 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_buffer
+bitmap.pixels.each do |pixel|
+  png.compose_pixel(pixel.x, pixel.y, (pixel.colour == "K") ? black : white)
+end
+
+png.save(buffer_outfile)
+
+# Use vector export
+vector_struct = barcode.to_vector
+# See 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).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/ruby-zint.rb

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

data/lib/zint/aus_post.rb

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

data/lib/zint/aus_redirect.rb

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

data/lib/zint/aus_reply.rb

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

data/lib/zint/aus_route.rb

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

data/lib/zint/azrune.rb

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

data/lib/zint/aztec.rb

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

data/lib/zint/barcode.rb

@@ -0,0 +1,148 @@
+module Zint
+  # Base class to represent the barcode
+  #
+  # @example Create new barcode
+  #   barcode = Zint::Barcode.new(value: "Test", type: Zint::BARCODE_QRCODE, options: {option_1: 1})
+  #   barcode.to_file(path: "qr.png")
+  class Barcode
+    # @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
+    # @param type [Integer] Type of barcode
+    # @param options [Hash] Specific options for Zint symbol
+    def initialize(value: nil, input_file: nil, type: Zint::BARCODE_CODE128, options: {})
+      raise ArgumentError, "value or input_file must be given!" if value&.empty? && input_file&.empty?
+      raise ArgumentError, "input_file not found!" if input_file && !File.exist?(input_file)
+
+      @zint_symbol = create_symbol(type)
+      options.each do |key, value|
+        @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
+    # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
+    def to_file(path:, rotate_angle: 0)
+      @zint_symbol[:outfile] = path
+
+      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)
+      end
+    end
+
+    # Exports barcode to memory file
+    #
+    # @param extension [String] Extension exported memory file
+    # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
+    # @return [String] Exported memory file
+    def to_memory_file(extension: ".png", rotate_angle: 0)
+      require "tempfile"
+      file = Tempfile.new(["zint", extension])
+
+      to_file(path: file.path, rotate_angle: rotate_angle)
+
+      file.rewind
+      buffer = file.read
+      file.close
+      file.unlink
+
+      buffer
+    end
+
+    # 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)
+      @zint_symbol[:output_options] = Zint::OUT_BUFFER_INTERMEDIATE
+
+      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)
+      end
+
+      zint_bitmap = zint_symbol[:bitmap].read_string((zint_symbol[:bitmap_width] * zint_symbol[:bitmap_height]))
+
+      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
+
+        Bitmap.new(zint_symbol[:bitmap_width], zint_symbol[:bitmap_height], pixels)
+      end
+    end
+
+    # Exports barcode as Zint vector
+    #
+    # @param rotate_angle [Integer] Rotate angle in degrees (0, 90, 180, 270)
+    # @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)
+      else
+        call_function(:ZBarcode_Encode_and_Buffer_Vector, zint_symbol, value, 0, rotate_angle)
+      end
+
+      Structs::Vector.new(zint_symbol[:vector])
+    end
+
+    private
+
+    def call_function(function_name, *args)
+      error_code = Zint.send(function_name.to_s, *args)
+
+      if Zint::ERRORS[error_code]
+        Zint.raise_error(error_code, zint_symbol[:errtxt])
+      end
+
+      error_code
+    end
+
+    def create_symbol(type)
+      symbol = Structs::Symbol.new(Zint.ZBarcode_Create)
+      symbol[:symbology] = type
+
+      symbol
+    end
+  end
+end

data/lib/zint/bind.rb

@@ -0,0 +1,7 @@
+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/bitmap.rb

@@ -0,0 +1,4 @@
+module Zint
+  # A class to represents a pixel from the bitmap
+  Bitmap = Struct.new(:width, :height, :pixels)
+end

data/lib/zint/bitmap_pixel.rb

@@ -0,0 +1,4 @@
+module Zint
+  # A class to represents a pixel from the bitmap
+  BitmapPixel = Struct.new(:x, :y, :colour)
+end

data/lib/zint/box.rb

@@ -0,0 +1,7 @@
+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/c25iata.rb

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

data/lib/zint/c25ind.rb

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

data/lib/zint/c25inter.rb

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

data/lib/zint/c25logic.rb

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

data/lib/zint/c25matrix.rb

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

data/lib/zint/c25standard.rb

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

data/lib/zint/channel.rb

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

data/lib/zint/codabar.rb

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

data/lib/zint/codablock_f.rb

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

data/lib/zint/code11.rb

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

data/lib/zint/code128.rb

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

data/lib/zint/code128b.rb

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

data/lib/zint/code16k.rb

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

data/lib/zint/code32.rb

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

data/lib/zint/code39.rb

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

data/lib/zint/code49.rb

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

data/lib/zint/code93.rb

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

data/lib/zint/code_one.rb

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

data/lib/zint/constants/capability_flags.rb

@@ -0,0 +1,18 @@
+module Zint
+  module Constants
+    # Capability flags (ZBarcode_Cap() `cap_flag`)
+    module CapabilityFlags
+      ZINT_CAP_HRT = 0x0001 # Prints Human Readable Text?
+      ZINT_CAP_STACKABLE = 0x0002 # Is stackable?
+      ZINT_CAP_EXTENDABLE = 0x0004 # Is extendable with add-on data? (Is UPC/EAN?)
+      ZINT_CAP_COMPOSITE = 0x0008 # Can have composite data?
+      ZINT_CAP_ECI = 0x0010 # Supports Extended Channel Interpretations?
+      ZINT_CAP_GS1 = 0x0020 # Supports GS1 data?
+      ZINT_CAP_DOTTY = 0x0040 # Can be output as dots?
+      ZINT_CAP_FIXED_RATIO = 0x0100 # Has fixed width-to-height (aspect) ratio?
+      ZINT_CAP_READER_INIT = 0x0200 # Supports Reader Initialisation?
+      ZINT_CAP_FULL_MULTIBYTE = 0x0400 # Supports full-multibyte option?
+      ZINT_CAP_MASK = 0x0800 # Is mask selectable?
+    end
+  end
+end

data/lib/zint/constants/debug_flags.rb

@@ -0,0 +1,9 @@
+module Zint
+  module Constants
+    # Debug flags (debug)
+    module DebugFlags
+      ZINT_DEBUG_PRINT = 1 # Print debug info (if any) to stdout
+      ZINT_DEBUG_TEST = 2 # For internal test use only
+    end
+  end
+end