zebra-zpl 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faa19461aac4741df172e4172665a34e25d7be83b925e9da52d23a9afe398c13
-  data.tar.gz: dc6f760289525d0a06654e6b706ca11be6f55d1c5e2baa70b6851104b0a34571
+  metadata.gz: 8f71f645c261f13d07c249d0aa2185d0457eb9cd82950bccc7cece4affd4e8ae
+  data.tar.gz: 54584c33bbadbc85afdd1d3d6909ed2f97fb310a914fbb06937563c6382699a5
 SHA512:
-  metadata.gz: ae75990790ea00a4f036f0c8aa015db79cc6c481988e3f8ba9014f2ff6cf941895c2e875c9149dcf62fe59a457a378447827f8b0e9a5fc51a1a76275bed93704
-  data.tar.gz: e7895c004ef9ff44b9cd32edbe6d870b58d92fb2970f373f8fe468d8703ede85ccf43cb93cdc932eb1ebb04e363be127a09bbcd30d1c281cb5140b22c62cc233
+  metadata.gz: fa31bbcf69048fb620115dfd1e7da60d7c01dc366486019cccefb0d70889c4028676a539375dffec5cface9693fb00f64bf21a97ada1394847710ec60b6cf129
+  data.tar.gz: 0c07546694365b8549429e9690de5942f2c161703c3c5691336f44a109906fcabd8b207a123dacef94e93ecabb675011b84afdb23224e7e3497cd0e6b84cb029

data/.gitignore

@@ -1,4 +1,4 @@
-*.gem
+
 *.rbc
 .bundle
 .config

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * Your contribution here.
 
+### 1.1.1 (12/19/2019)
+
+* [#58](https://github.com/bbulpett/zebra-zpl/pull/58): Add access to source `Img2Zpl::Image` object - [@mtking2](https://github.com/mtking2)
+
 ### 1.1.0 (11/04/2019)
 
 * [#54](https://github.com/bbulpett/zebra-zpl/pull/54): Fix height bug with ^B commands - [@mtking2](https://github.com/mtking2)

data/README.md

@@ -325,7 +325,10 @@ You can also create graphics elements from an image using the `Zebra::Zpl::Image
 * `black_threshold`: A value between 0 and 1 that sets the darkness threshold which determines how dark a pixel should be in order to become black in the resulting b/w image. Use larger value for a more saturated image and smaller value for a less saturated one. Default: `0.5`
 * `invert`: set to `true` to invert which pixels are set to black and which are set to white. Default is, depending on the `black_threshold`, dark pixels become black and light pixels become white.
 
+#### Usage
 ```ruby
+label = Zebra::Zpl::Label.new width: 600, length: 305, print_speed: 6
+
 image = Zebra::Zpl::Image.new(
   path: '/path/to/my/image.jpg',
   position: [100, 50],
@@ -334,6 +337,29 @@ image = Zebra::Zpl::Image.new(
   rotation: -90,
   black_threshold: 0.35
 )
+
+label << image
+```
+**Modifying Images**
+
+<p align="center">
+  <img src="docs/images/image_manipulation.png" width="500">
+</p>  
+
+Image elements can also be modified in many ways before being added to the label by calling ImageMagick commands (provided by the [minimagick](https://github.com/minimagick/minimagick) & [img2zpl](https://github.com/mtking2/img2zpl) gems) on the source `Img2Zpl::Image < MiniMagick::Image` object.
+
+**Example:** Flattening an image's layers, so it is properly converted, and then trimming out unnecessary white space around the edges:
+
+```ruby
+label = Zebra::Zpl::Label.new width: 600, length: 305, print_speed: 6
+image = Zebra::Zpl::Image.new path: 'path/to/image.png', position: [0, 0]
+
+img_src = image.source #=> instance of Img2Zpl::Image < MiniMagick::Image
+
+img_src.flatten
+img_src.trim
+
+label << image
 ```
 
 ## Options

data/docs/example.rb

@@ -143,6 +143,7 @@ image = Zebra::Zpl::Image.new(
 label << image
 print_zpl_str('image', label)
 
+# inverted image
 label = new_label
 image = Zebra::Zpl::Image.new(
   path: File.expand_path('./images/earth.jpg', File.dirname(__FILE__)),
@@ -154,6 +155,33 @@ image = Zebra::Zpl::Image.new(
 label << image
 print_zpl_str('image_inverted', label)
 
+################################################################################
+# Image Manipulation
+################################################################################
+label = new_label
+image = Zebra::Zpl::Image.new(
+  path: File.expand_path('./images/ruby.png', File.dirname(__FILE__)),
+  position: [0, 0],
+  width: 305,
+  height: 305,
+  black_threshold: 0.65
+)
+src = image.source
+src.background('white').flatten
+
+# perform edge detection on the image
+MiniMagick::Tool::Convert.new do |convert|
+  convert << src.path
+  convert << '-colorspace' << 'gray'
+  convert << '-edge' << '4'
+  convert << '-negate'
+  convert << src.path
+end
+
+src.trim
+
+label << image
+print_zpl_str('image_manipulation', label)
 
 ################################################################################
 # Justification

data/lib/zebra/zpl/image.rb

@@ -15,6 +15,12 @@ module Zebra
         @path = @img.path
       end
 
+      def source
+        @img
+      end
+
+      alias src source
+
       def width=(value)
         raise InvalidSizeError.new('Invalid image width') unless value.to_i.positive?
         @width = value.to_i

data/lib/zebra/zpl/version.rb

@@ -1,5 +1,5 @@
 module Zebra
   module Zpl
-    VERSION = "1.1.0"
+    VERSION = '1.1.1'.freeze
   end
 end

data/spec/zebra/zpl/image_spec.rb

@@ -61,7 +61,7 @@ describe Zebra::Zpl::Image do
     end
   end
 
-  describe '#to_zpl' do
+  context "instance methods" do
     let(:valid_attributes) { {
       path:       'spec/fixtures/default.jpg',
       position:   [50, 50],
@@ -69,45 +69,78 @@ describe Zebra::Zpl::Image do
       height:     150
     }}
     let(:image) { described_class.new valid_attributes }
-    let(:tokens) { image.to_zpl.split(/(\^[A-Z]+|\,)/).reject{ |e| ['', ',', nil].include?(e) } }
 
-    it 'raises an error if the X position is not given' do
-      qrcode = described_class.new position: [nil, 50]
-      expect {
-        qrcode.to_zpl
-      }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the X value is not given")
+    describe '#source' do
+      it 'returns an Img2Zpl::Image object' do
+        expect(image.source.class).to eq Img2Zpl::Image
+      end
+
+      it 'responds to ImageMagick (MiniMagick::Image) commands' do
+        attr = valid_attributes
+        attr.delete(:width)
+        attr.delete(:height)
+        img = described_class.new attr
+        src = img.src
+        expect(src.respond_to?(:resize)).to be true
+        expect(src.respond_to?(:trim)).to be true
+        expect(src.respond_to?(:crop)).to be true
+        expect(src.respond_to?(:flatten)).to be true
+        expect(src.respond_to?(:rotate)).to be true
+      end
+
+      it 'properly manipulates the image with ImageMagick (MiniMagick::Image) commands' do
+        attr = valid_attributes
+        attr.delete(:width)
+        attr.delete(:height)
+        img = described_class.new attr
+
+        img.source.resize '123x'
+        expect(img.width).to eq 123
+        img.source.resize 'x321'
+        expect(img.height).to eq 321
+      end
     end
 
-    it 'raises an error if the Y position is not given' do
-      qrcode = described_class.new position: [50, nil]
-      expect {
-        qrcode.to_zpl
-      }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the Y value is not given")
+    describe '#to_zpl' do
+      let(:tokens) { image.to_zpl.split(/(\^[A-Z]+|\,)/).reject{ |e| ['', ',', nil].include?(e) } }
+
+      it 'raises an error if the X position is not given' do
+        qrcode = described_class.new position: [nil, 50]
+        expect {
+          qrcode.to_zpl
+        }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the X value is not given")
+      end
+
+      it 'raises an error if the Y position is not given' do
+        qrcode = described_class.new position: [50, nil]
+        expect {
+          qrcode.to_zpl
+        }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the Y value is not given")
+      end
+
+      it 'raises an error if the path is not given' do
+        valid_attributes.delete :path
+
+        expect {
+          image.to_zpl
+        }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the path is invalid or not given")
+      end
+
+      it "contains the Graphics Field command '^GF'" do
+        expect(image.to_zpl).to match /\^GF/
+      end
+
+      it 'contains the X position' do
+        expect(tokens[1]).to eq '50'
+      end
+
+      it 'contains the Y position' do
+        expect(tokens[2]).to eq '50'
+      end
+
+      it 'contains the properly encoded image' do
+        expect(tokens[3..-1].join).to eq '^GFA1079107913:::::K078Q03J07FF8P038I01JFP078I03JF8O0FCI0KFCO0FC001KFEN01FE003LFN01FE003LF8M03FF007LFCM03FF8007LFCM07FF800MFCM0IFC00MFEM0IFC00MFEL01IFE01MFEL01IFE01MFEL03JF01NFL07JF8:01NFL0KFC:01MFEK01KFE00MFEK01LF00MFEK03LF00MFEK07LF8007LFCK07LF8007LFCK0MFC003LF8K0MFC003LFK01MFE001KFEK01NFI0KFCK03NFI07JF8K07NF8I01JFL04N08J07FFCK0FC::::::N01MFE:::::::::::::::::::::::::::::::::::^FS'
+      end
     end
-
-    it 'raises an error if the path is not given' do
-      valid_attributes.delete :path
-
-      expect {
-        image.to_zpl
-      }.to raise_error(Zebra::Zpl::Printable::MissingAttributeError, "Can't print if the path is invalid or not given")
-    end
-
-    it "contains the Graphics Field command '^GF'" do
-      expect(image.to_zpl).to match /\^GF/
-    end
-
-    it 'contains the X position' do
-      expect(tokens[1]).to eq '50'
-    end
-
-    it 'contains the Y position' do
-      expect(tokens[2]).to eq '50'
-    end
-
-    it 'contains the properly encoded image' do
-      expect(tokens[3..-1].join).to eq '^GFA1079107913:::::M0FR06L0IFQ07K03IFEP0FK07JFO01F8J01KF8N01F8J03KFCN03FCJ07KFEN03FCJ07LFN07FEJ0MF8M07HFJ0MF8M0IFI01MF8L01IF8I01MFCL01IF8I01MFCL03IFCI03MFCL03IFCI03MFCL07IFEI03MFEL0KF:I03MFEK01KF8:I03MFCK03KFCI01MFCK03KFEI01MFCK07KFEI01MFCK0MFJ0MF8K0MFJ0MF8J01MF8J07LFK01MF8J07KFEK03MFCJ03KFCK03MFEJ01KF8K07MFEK0KFL0OFK03IFEL08M01L0IF8L01F8::::::P03MFC:::::::::::::::::::::::::::::::::::^FS'
-    end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zebra-zpl
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Barnabas Bulpett
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: img2zpl
@@ -122,6 +122,7 @@ files:
 - docs/images/graphics.png
 - docs/images/image.png
 - docs/images/image_inverted.png
+- docs/images/image_manipulation.png
 - docs/images/images.png
 - docs/images/justification.png
 - docs/images/qrcode.png