img2zpl 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d438648db69b9d6a1503df5cb6169c9a21740ce15c16c032387d4e8663a65e45
-  data.tar.gz: 0f9453b3645f0fd5f284786b22c2b75108a987c9741b8dd232c602c16760c238
+  metadata.gz: 7c8010c3b5133ed81279c44419a584d87ab6b54d1777efec3c9c7c52e556b23b
+  data.tar.gz: 17200af08ebff21cac5f15e0d09c89dc765e3d0487379ffd69958582095be77d
 SHA512:
-  metadata.gz: 0372b42254b75b51cdad5a45ebf9e7018f26701c94028f0b43b63f3299b4cfd30f96861aa72ed80dd8e4f7c6e506477b7f24e29c8b06a31ff863d01b61f4d6d7
-  data.tar.gz: 34201fe23f15a11548f28aa9189868a9997310c7e5d21d8125d12e49dfc7faf248ab8944463c097e3a38709074087c7d181de2a361e37f608d281bec6f579442
+  metadata.gz: 7e0e621ec3a4dc11c2399d8808b02f750be6da3a9c2b67e9e909e186f2adc1d020e31690e51809b9e9d8740ee04bbeced89638b4b2eed361af654b98e25d8410
+  data.tar.gz: 3cda926725cc62f06e62da712fc56db9c98a179b1c1480871212aaceee872d918f622c45f8c0ec17000bd873f16ec11cca7617480d4e8816a726de65ef50c3ac

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+### v0.x.x (next)
+
+* Your contribution here.
+
+### v0.1.2 (2019/10/10)
+
+* [#3](https://github.com/mtking2/img2zpl/pull/3): Add ASCII compression to conversion - [@mtking2](https://github.com/mtking2).
+
+### v0.1.1 (2019/10/09)
+
+* [#2](https://github.com/mtking2/img2zpl/pull/2): Rename primary conversion method `.zpl` --> `.to_zpl` - [@mtking2](https://github.com/mtking2).
+
+### v0.1.0 (2019/10/08)
+* [#1](https://github.com/mtking2/img2zpl/pull/1): Add functioning algorithm - [@mtking2](https://github.com/mtking2).
+* Initial public release - [@mtking2](https://github.com/mtking2).

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+## Contributing
+
+### Fork & clone the repository
+
+```
+git clone git@github.com:<your-username>/img2zpl.git
+cd img2zpl
+git remote add upstream git@github.com:mtking2/img2zpl.git
+bundle install
+```
+
+Then check out a working branch:
+
+```
+git checkout <my-working-branch>
+```
+
+### Write tests
+
+This project uses `rspec`. After writing your tests, you can run tests with the following command:
+
+`bundle exec rspec`
+
+
+### Write code
+
+Write your code to make your tests pass.
+
+### Update the CHANGELOG with a description and your name
+
+Update the CHANGELOG with the description of your code changes and your name on the line after `"* Your contribution here"`.
+
+### Push your changes and open a pull request
+
+Push you changes to your working branch.
+
+```
+git push origin <my-working-branch>
+```
+
+Open a pull request against upstream master and your working branch. Give a brief description of what your PR does and explain what the code changes do.
+
+Thank you!

data/Gemfile

@@ -2,9 +2,8 @@ source 'https://rubygems.org'
 
 group :development, :test do
   gem 'byebug'
-
+  gem 'pry'
+  gem 'pry-nav'
 end
 
-gem 'pry'
-
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Michael
+Copyright (c) 2019 Michael King
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -5,9 +5,36 @@
 
 Ruby library to convert images to usable & printable ZPL code
 
+### Installation
+
+Add the gem to your Gemfile:
+```
+gem 'img2zpl'
+```
+And then run `bundle install`
+
+Or install it yourself with:
+```
+gem install img2zpl
+```
+
 ### Usage
 
 ```ruby
+require 'img2zpl'
+
 img = Img2Zpl::Image.open('foo.jpg')
 zpl = img.to_zpl #=> "^FO0,0^GFA, ... ^FS"
 ```
+
+### Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+#### [Changelog](CHANGELOG.md)
+
+### Copyright
+
+Copyright © 2019, [Michael King](https://twitter.com/_mtking2) and [Contributors](CHANGELOG.md).
+
+MIT License, see [LICENSE](https://github.com/mtking2/img2zpl/blob/master/LICENSE)

data/lib/img2zpl/image.rb

@@ -1,12 +1,11 @@
 class Img2Zpl::Image < MiniMagick::Image
 
-  def to_zpl(black_threshold: 0.5)
+  def to_zpl(black_threshold: 0.5, compress: true)
     bytes_per_row = (width % 8).positive? ? (width / 8) + 1 : (width / 8)
     byte_count = bytes_per_row * height
     data, line, previous_line, byte = '', '', '', ''
 
     get_pixels.each do |row|
-
       row.each_with_index do |column, i|
         r, g, b = column.map(&:to_i)
         byte << ((r + g + b) > (black_threshold * 765) ? '0' : '1')
@@ -15,18 +14,48 @@ class Img2Zpl::Image < MiniMagick::Image
           byte = ''
         end
       end
-      data << (line == previous_line ? ':' : line.gsub(/0+$/, ',').gsub(/F+$/, '!'))
+
+      data << if compress
+        (line == previous_line ? ':' : line.gsub(/0+$/, ',').gsub(/F+$/, '!'))
+      else
+        line
+      end
+
       previous_line = line
       line = ''
     end
 
-    "^FO0,0^GFA,#{byte_count},#{byte_count},#{bytes_per_row},#{data}^FS"
+    _compress(data) if compress
+    "^GFA,#{byte_count},#{byte_count},#{bytes_per_row},#{data}^FS"
   end
 
   private
 
   def _compression_map
-    # TODO: finish compression map
+    map = {}
+    start = 'G'.ord
+    19.times { |i| map[i + 1] = (start+i).chr }
+    start = 'g'.ord
+    (20..400).step(20).each_with_index { |i, j| map[i] = (start+j).chr }
+    map
+  end
+
+  def _reduce(n)
+    str = ''
+    counts = _compression_map.keys.sort.reverse
+    counts.each do |c|
+      if c <= n
+        str << (_compression_map[c])
+        n -= c
+      end
+    end
+    str
+  end
+
+  def _compress(data)
+    data.gsub!(/([\da-zA-Z])(\1+)/) do |m|
+      "#{_reduce(m.length)}#{$1}"
+    end
   end
 
 end

data/lib/img2zpl/version.rb

@@ -1,3 +1,3 @@
 module Img2Zpl
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/spec/img2zpl/image_spec.rb

@@ -4,13 +4,68 @@ describe Img2Zpl::Image do
 
   subject { described_class.open('spec/fixtures/default.jpg') }
 
-  it 'inherits from the MiniMagick::Image class' do
+  it 'should inherit from the MiniMagick::Image class' do
     expect(described_class.respond_to?(:open)).to be true
     expect(described_class.respond_to?(:read)).to be true
     expect(subject.respond_to?(:to_zpl)).to be true
   end
 
-  it 'zpl method returns a string' do
+  it 'should have the compression map' do
+    map = subject.send(:_compression_map)
+    expect(map[1]).to eq 'G'
+    expect(map[2]).to eq 'H'
+    expect(map[3]).to eq 'I'
+    expect(map[4]).to eq 'J'
+    expect(map[5]).to eq 'K'
+    expect(map[6]).to eq 'L'
+    expect(map[7]).to eq 'M'
+    expect(map[8]).to eq 'N'
+    expect(map[9]).to eq 'O'
+    expect(map[10]).to eq 'P'
+    expect(map[11]).to eq 'Q'
+    expect(map[12]).to eq 'R'
+    expect(map[13]).to eq 'S'
+    expect(map[14]).to eq 'T'
+    expect(map[15]).to eq 'U'
+    expect(map[16]).to eq 'V'
+    expect(map[17]).to eq 'W'
+    expect(map[18]).to eq 'X'
+    expect(map[19]).to eq 'Y'
+    expect(map[20]).to eq 'g'
+    expect(map[40]).to eq 'h'
+    expect(map[60]).to eq 'i'
+    expect(map[80]).to eq 'j'
+    expect(map[100]).to eq 'k'
+    expect(map[120]).to eq 'l'
+    expect(map[140]).to eq 'm'
+    expect(map[160]).to eq 'n'
+    expect(map[180]).to eq 'o'
+    expect(map[200]).to eq 'p'
+    expect(map[220]).to eq 'q'
+    expect(map[240]).to eq 'r'
+    expect(map[260]).to eq 's'
+    expect(map[280]).to eq 't'
+    expect(map[300]).to eq 'u'
+    expect(map[320]).to eq 'v'
+    expect(map[340]).to eq 'w'
+    expect(map[360]).to eq 'x'
+    expect(map[380]).to eq 'y'
+    expect(map[400]).to eq 'z'
+  end
+
+  it 'should properly compress ASCII data' do
+    d1 = '00000000000000000000000000000000000000000000000000000000008'
+    d2 = '5555555555555ADDDDDDDDDDDDDDDDDDDDDDD'
+    d3 = '00000000FFFFFFFFFFFFFFFFFFFFFFC0000000000000000000007FFFFFFFFF'
+    subject.send(:_compress, d1)
+    subject.send(:_compress, d2)
+    subject.send(:_compress, d3)
+    expect(d1).to eq 'hX08'
+    expect(d2).to eq 'S5AgID'
+    expect(d3).to eq 'N0gHFCgG07OF'
+  end
+
+  it 'should return a string when calling .to_zpl' do
     expect(subject.to_zpl).to be_kind_of String
   end
 

data/spec/spec_helper.rb

@@ -14,6 +14,10 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 require 'img2zpl'
+require 'byebug'
+require 'pry'
+require 'pry-nav'
+
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: img2zpl
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -60,6 +60,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md