escpos-image 0.0.9 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d77f652d199f1562943324c9d167585d0dd8720d60907e9b35dd05f9e34b9c09
-  data.tar.gz: 9948efcabb7054074d5efa222013550a6c5f6d1f386ec9f1886a341159030f34
+  metadata.gz: dc80022cd61c7bc3eff82db4ee5d577dd9dc0a31749536ea6e50a9c9305901b6
+  data.tar.gz: 2e53ed6568bdc148b20594818a44c4daaf5c7da4850a37e29b0d7ca69d1a605b
 SHA512:
-  metadata.gz: 5cfec52a3866a10b7edc431fc8c8e5da9e6bff791d9aabafe7843b9ea8d46753768f80e3bf4c4a3bb77f82d3b2b0969a190e111c7ff3306d85556efdc1df7b78
-  data.tar.gz: ace68af135955b30bb38c5951650391c28f0a64b9fcaf2b7e00f854def83a5e3017dd24ffd75b24b09ea6d13c04459127dab684c9c9047a5320c4473f4a01710
+  metadata.gz: 1dec2c046d2b46682ab5ddde4bab2ec49b518042a29f0a0db4ae10073aa7440289aa6b4afc83531a29670a1e7132bf02e09b757fe6f5aa81d1616d7deb1132ff
+  data.tar.gz: 949bf4644f2674cd62c3d0098f707da79cf8f0f59791d87e395bb65ac1ed52b0a083e57098a4c7227e3716ca0fcbf028c39bdbdb23c937918d72334de3227fce

data/.gitlab-ci.yml

@@ -13,6 +13,7 @@ before_script:
   - bundle install --jobs $(nproc) --path vendor
   - apt-get install -y imagemagick
   - gem install mini_magick
+  - gem install chunky_png
 
 test:
   stage: test

data/README.md

@@ -1,13 +1,20 @@
+[Build Status](https://gitlab.com/escpos/escpos-image/pipelines)
+
 # Escpos-image
 
 A ruby implementation of ESC/POS (thermal) printer image command specification.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this lines to your application's Gemfile:
 
 ```ruby
 gem 'escpos-image'
+
+# Depending on chosen image processor
+gem 'mini_magick'
+# or
+gem 'chunky_png'
 ```
 
 And then execute:
@@ -18,8 +25,16 @@ Or install it yourself as:
 
     $ gem install escpos-image
 
+And then depending on chosen image processor
+
+    $ gem install mini_magick
+
+or
+
+    $ gem install chunky_png
 ## Examples
 
+![](https://github.com/escpos/escpos-image/blob/master/examples/IMG_20190225_162935.jpg)
 ![](https://github.com/escpos/escpos-image/blob/master/examples/IMG_20160610_232415_HDR.jpg)
 
 ## Usage
@@ -29,13 +44,18 @@ Or install it yourself as:
 
 # Creating image from path
 image = Escpos::Image.new 'path/to/image.png', {
-  processor: "ChunkyPng" # default or MiniMagick
+  processor: "ChunkyPng" # or MiniMagick
   # ... other options, see following sections
 }
 
+# The ChunkyPng processor requires the chunky_png gem installed
 # The MiniMagick processor requires the mini_magick gem installed
 
-# The constructor also accepts an instance of ChunkyPNG::Image or MiniMagick::Image
+# The constructor accepts an instance of:
+# - String (path to image)
+# - File
+# - ChunkyPNG::Image
+# - MiniMagick::Image
 
 @printer << image
 
@@ -51,9 +71,9 @@ image = Escpos::Image.new 'path/to/image.png', {
 
 | ChunkyPng | MiniMagick |
 | --- | --- |
-| PNG | PNG, JPG, BMP, ... (everything supported by MiniMagick) |
+| PNG | PNG, JPG, GIF, BMP, TIF, PCX, ... (everything supported by MiniMagick) |
 
-When using MiniMagick processor, `mini_magick` gem has to be installed or added to the Gemfile, this makes the gem more lightweight by making this dependency optional.
+When using `ChunkyPng` processor, `chunky_png` gem has to be installed or added to the Gemfile and when using `MiniMagick` processor, `mini_magick` gem has to be installed or added to the Gemfile, this makes the gem more lightweight by making dependencies optional and based on chosen image processor.
 
 ## Image manipulation
 

data/escpos-image.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "minitest", "~> 5.4"
   spec.add_development_dependency "mini_magick"
+  spec.add_development_dependency "chunky_png"
 
-  spec.add_dependency "escpos", ">= 0.0.9"
-  spec.add_dependency "chunky_png"
+  spec.add_dependency "escpos", ">= 0.0.10"
 end

data/lib/escpos/errors.rb

@@ -12,9 +12,13 @@ module Escpos
     end
   end
 
-  class MiniMagickNotInstalled < LoadError
+  class DependencyNotInstalled < LoadError
+    attr_reader :dependency_name
+    def initialize(dependency_name)
+      @dependency_name = dependency_name
+    end
     def message
-      "Required options need the mini_magick gem installed: #{e}."
+      "Required options need the \"#{@dependency_name}\" gem installed."
     end
   end
 

data/lib/escpos/image.rb

@@ -1,4 +1,5 @@
 require_relative "errors"
+require_relative "helpers"
 require_relative "image_processors/chunky_png"
 require_relative "image_processors/mini_magick"
 
@@ -9,39 +10,29 @@ module Escpos
 
   class Image
 
-    VERSION = "0.0.9"
+    VERSION = "0.0.12"
 
     attr_reader :processor, :options
 
     def initialize(image_or_path, options = {})
       @options = options
 
-      processor_klass_name = options.fetch(:processor, "ChunkyPng")
+      processor_klass_name = options.fetch(:processor)
       processor_klass = ImageProcessors.const_get(processor_klass_name)
       @processor = processor_klass.new image_or_path, options
 
       @processor.process!
     end
 
-    def chunky_png_image
-      processor.chunky_png_image
-    end
-
     def to_escpos
       bits = []
       mask = 0x80
       i = 0
       temp = 0
 
-      0.upto(chunky_png_image.height - 1) do |y|
-        0.upto(chunky_png_image.width - 1) do |x|
-          px = chunky_png_image.get_pixel(x, y)
-          r, g, b =
-            ChunkyPNG::Color.r(px),
-            ChunkyPNG::Color.g(px),
-            ChunkyPNG::Color.b(px)
-
-          px = (r + b + g) / 3        
+      0.upto(processor.image.height - 1) do |y|
+        0.upto(processor.image.width - 1) do |x|
+          px = processor.get_pixel(x, y)
           value = px >= 128 ? 255 : 0
           value = (value << 8) | value
           temp |= mask if value == 0
@@ -58,7 +49,7 @@ module Escpos
 
       [
         Escpos.sequence(IMAGE),
-        [ chunky_png_image.width / 8, chunky_png_image.height ].pack("SS"),
+        [ processor.image.width / 8, processor.image.height ].pack("SS"),
         bits.pack("C*")
       ].join
     end

data/lib/escpos/image_processors/chunky_png.rb

@@ -5,9 +5,13 @@ module Escpos
     class ChunkyPng < Base
 
       def initialize(image_or_path, options = {})
+        require_chunky_png!
+
         @image = begin
           if image_or_path.is_a?(ChunkyPNG::Image)
             image_or_path
+          elsif image_or_path.is_a?(File)
+            ChunkyPNG::Image.from_file(image_or_path.path)
           elsif image_or_path.is_a?(String)
             ChunkyPNG::Image.from_file(image_or_path)
           else
@@ -18,14 +22,30 @@ module Escpos
         super
       end
 
-      def chunky_png_image
-        @image
-      end
-
       def assert_options!
         assert_dimensions_multiple_of_8!
       end
 
+      # ChunkyPng gem is not required intentionally
+      # This makes the gem more lightweight by making dependencies
+      # optional and based on chosen image processor
+      def require_chunky_png!
+        return if defined?(::ChunkyPng)
+        require "chunky_png"
+      rescue LoadError => e
+        raise DependencyNotInstalled.new("chunky_png")
+      end
+
+      def get_pixel(x, y)
+        px = image.get_pixel x, y
+        r, g, b =
+          ChunkyPNG::Color.r(px),
+          ChunkyPNG::Color.g(px),
+          ChunkyPNG::Color.b(px)
+
+        (r + b + g) / 3
+      end
+
       def process!
         extent = options.fetch(:extent, false)
         compose_alpha = options.fetch(:compose_alpha, false)

data/lib/escpos/image_processors/mini_magick.rb

@@ -10,6 +10,8 @@ module Escpos
         @image = begin
           if image_or_path.is_a?(::MiniMagick::Image)
             image_or_path
+          elsif image_or_path.is_a?(File)
+             ::MiniMagick::Image.open(image_or_path.path)
           elsif image_or_path.is_a?(String)
             ::MiniMagick::Image.open(image_or_path)
           else
@@ -20,8 +22,15 @@ module Escpos
         super
       end
 
-      def chunky_png_image
-        @chunky_png_image ||= ChunkyPNG::Image.from_file @image.path
+      def get_pixel(x, y)
+        @pixels ||= image.get_pixels
+
+        r, g, b =
+          @pixels[y][x][0],
+          @pixels[y][x][1],
+          @pixels[y][x][2]
+
+        (r + b + g) / 3
       end
 
       def assert_options!
@@ -29,12 +38,13 @@ module Escpos
       end
 
       # MiniMagick gem is not required intentionally
-      # This makes the gem more lightweight by making this dependency optional
+      # This makes the gem more lightweight by making dependencies
+      # optional and based on chosen image processor
       def require_mini_magick!
         return if defined?(::MiniMagick)
         require "mini_magick"
-        rescue LoadError => e
-          raise MiniMagickNotInstalled
+      rescue LoadError => e
+        raise DependencyNotInstalled.new("mini_magick")
       end
 
       def process!
@@ -70,9 +80,6 @@ module Escpos
         if options.fetch(:extent, false)
           image.extent "#{(image.width/8.0).round*8}x#{(image.height/8.0).round*8}"
         end
-
-        # Force PNG format so ChunkyPNG works
-        image.format 'png'
       end
 
     end

data/test/lib/escpos/image_test.rb

@@ -1,40 +1,42 @@
 require_relative '../../test_helper'
 
 class ImageTest < Minitest::Test
+
   def setup
     @printer = Escpos::Printer.new
   end
 
-  # TODO photos of results
-  # TODO USB with option print tests (dev dependency)
-
   def test_image
     image_path = File.join(__dir__, '../../fixtures/tux_mono.png')
-    image = Escpos::Image.new image_path,
+    image_file = File.new image_path
+    image = Escpos::Image.new image_file,
       processor: "MiniMagick"
+    image_file.close
 
     @printer << image
     @printer << "\n" * 10
     @printer.cut!
-    image.chunky_png_image.metadata = {}
-    image.chunky_png_image.save(File.join(__dir__, "../../results/#{__method__}.png"))
+    image.processor.image.write(File.join(__dir__, "../../results/#{__method__}.png"))
     file = File.join(__dir__, "../../results/#{__method__}.txt")
-    #IO.binwrite file, @printer.to_escpos
+    #@printer.save file
+
     assert_equal IO.binread(file), @printer.to_escpos
   end
 
   def test_image_conversion
     image_path = File.join(__dir__, '../../fixtures/tux_alpha.png')
     image = Escpos::Image.new image_path, grayscale: true,
-      compose_alpha: true, extent: true
+      compose_alpha: true, extent: true,
+      processor: "ChunkyPng"
 
     @printer << image.to_escpos
     @printer << "\n" * 10
     @printer.cut!
-    image.chunky_png_image.metadata = {}
-    image.chunky_png_image.save(File.join(__dir__, "../../results/#{__method__}.png"))
+    image.processor.image.metadata = {}
+    image.processor.image.save(File.join(__dir__, "../../results/#{__method__}.png"))
     file = File.join(__dir__, "../../results/#{__method__}.txt")
-    #IO.binwrite file, @printer.to_escpos
+    #@printer.save file
+
     assert_equal IO.binread(file), @printer.to_escpos
   end
 

data/test/test_helper.rb

@@ -5,5 +5,4 @@ require 'minitest/autorun'
 require 'pp'
 
 require 'escpos'
-require 'chunky_png'
 require File.expand_path('../../lib/escpos/image.rb', __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: escpos-image
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.12
 platform: ruby
 authors:
 - Jan Svoboda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-23 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,33 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: escpos
+  name: chunky_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.9
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: chunky_png
+  name: escpos
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.10
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.10
 description: A ruby implementation of ESC/POS (thermal) printer image command specification.
 email:
 - jan@mluv.cz
@@ -112,6 +112,7 @@ files:
 - bin/setup
 - escpos-image.gemspec
 - examples/IMG_20160610_232415_HDR.jpg
+- examples/IMG_20190225_162935.jpg
 - lib/escpos/errors.rb
 - lib/escpos/helpers.rb
 - lib/escpos/image.rb
@@ -145,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A ruby implementation of ESC/POS (thermal) printer image command specification.