zpl-scaler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b41f6026b7cfa2103d123dd1f16739881deac3d5
+  data.tar.gz: 2c7439b046e13cc4f89d12b3e83efea758213c60
+SHA512:
+  metadata.gz: 47719d5d2f94260116f25a99bdb1e5b5a4273584c6356bc356441d9293306e2dfb16652cb4116bef8cebe255c6894d7110586e1404af6e7622fcc41798b46558
+  data.tar.gz: 87d66700d1ee74c88a5f2a73a61343499eea43a6adcd09a4405358fc3cbc77fa6001303c74cdf0ad7721b709b94e060f9413ee2df0a2a0c58333a856e4188617

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.17.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zpl-scaler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Benoit de Chezelles
+
+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,70 @@
+# ZplScaler
+
+TODO: why?!
+
+
+TODO: list handled commands (only the commands that manipulate coordinates and that need to be re-calculated, all other commands are ignored and left as is)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zpl-scaler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zpl-scaler
+
+## Usage
+
+**Simple example**:
+```rb
+require 'zpl-scaler'
+
+# Scale by dpi:
+ZplScaler.dpi_scale '^XA^GB12,30,2,B^XZ', from_dpi: 203, to_dpi: 300
+# => "^XA^GB17,44,2,B^XZ"
+
+# Scale by ratio:
+ZplScaler.ratio_scale '^XA^GB12,30,2,B^XZ', 1.2
+# => "^XA^GB14,36,2,B^XZ"
+```
+
+**Complete example**:
+```rb
+require 'zpl-scaler'
+
+zpl_content = File.read("label_at_203dpi.zpl")
+
+puts '-- Unique used commands ----'
+p ZplScaler::ZplReader.uniq_commands zpl_content
+
+scaled_zpl = ZplScaler.dpi_scale zpl_content, from_dpi: 203, to_dpi: 300
+
+puts '-- Scaled ZPL --------------'
+puts scaled_zpl
+
+File.open("label_at_300dpi.zpl", "w") do |file|
+  file.write(scaled_zpl)
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bew/zpl-scaler.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zpl/scaler"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/zpl-scaler.rb

@@ -0,0 +1,196 @@
+require 'strscan'
+require 'set'
+require 'zpl-scaler/version'
+
+module ZplScaler
+
+  class Error < StandardError; end
+
+  # Data class that holds the name & params of a ZPL command.
+  class ZplCommand
+    attr_accessor :name
+    attr_accessor :params
+
+    def initialize(name, params)
+      @name = name
+      @params = params
+    end
+
+    # Converts the command to a ZPL string.
+    def to_zpl_string
+      "^#{ @name }#{ @params.join(',') }"
+    end
+  end
+
+  # NOTE: doesn't handle ZPL that changes the control char (default: '^')
+  class ZplReader
+    # Example format: ^XXparam1,param2,,param4
+    # ZplCommand name: XX (the command is read as 2 chars, no more no less)
+    # 4 (5) params (param 3 & 5 are not given)
+    RX_ZPL_COMMAND = /\^([A-Z0-9]{2})([^\^]*)/
+
+    # Returns the list of unique commands used in the given ZPL.
+    def self.uniq_commands(zpl_content)
+      uniq_cmds = Set.new
+      new(zpl_content).each_command do |cmd|
+        uniq_cmds << cmd.name
+      end
+      uniq_cmds.to_a
+    end
+
+    # Creates a new reader that will read ZPL commands from *content* string.
+    def initialize(content)
+      @scanner = StringScanner.new content
+    end
+
+    # Returns the next zpl command if any, or nil.
+    def next_command
+      return if @scanner.eos?
+
+      @scanner.scan(RX_ZPL_COMMAND)
+
+      cmd_name = @scanner[1]
+      raw_params = @scanner[2]
+
+      ZplCommand.new(cmd_name, raw_params&.split(',') || [])
+    end
+
+    # Yields each ZPL command to the block. Stops when there are no more commands to read.
+    def each_command
+      while cmd = next_command
+        yield cmd
+      end
+    end
+  end
+
+  # TODO: doc
+  # It works by parsing ZPL commands, then edit the parameters of specific commands
+  # to scale the coordinates to the new dpi
+  #
+  # NOTE: Cannot work for embedded images
+  class Scaler
+    COMMANDS_PARAM_INDEXES_TO_SCALE = {
+      # ^MN - Media Tracking
+      #
+      # Param 0: media being used
+      # Param 1: black mark offset in dots (optional)
+      "MN" => [1],
+
+      # ^BY - Bar Code Field Default
+      #
+      # Param 0: module width in dots
+      # Param 1: wide bar to narrow bar width ratio (float)
+      # Param 2: bar code height in dots
+      "BY" => [0, 2],
+
+      # ^FO - Field Origin
+      #
+      # Param 0: x-axis location in dots
+      # Param 1: y-axis location in dots
+      # Param 2: justification (enum)
+      "FO" => [0, 1],
+
+      # ^B2 - Interleaved 2 of 5 Bar Code
+      #
+      # Param 0: orientation (enum)
+      # Param 1: bar code height in dots
+      # Param 2: print interpretation line above code (bool)
+      "B2" => [1],
+
+      # ^GB - Graphic Box
+      #
+      # Param 0: box width in dots
+      # Param 1: box height in dots
+      # Param 2: border thickness
+      # Param 3: line color (enum)
+      # Param 4: degree of corner rounding (enum)
+      "GB" => [0, 1, 2],
+
+      # ^BC - Code 128 Bar Code (Subsets A, B, and C)
+      #
+      # Param 0: orientation (enum)
+      # Param 1: bar code height in dots
+      # Param 2: print interpretation line (bool)
+      # Param 3: print interpretation line above code (bool)
+      # Param 4: UCC check digit (bool)
+      # Param 5: mode (enum)
+      "BC" => [1],
+    }
+
+    # ^A - Scalable/Bitmapped Font
+    #
+    # Param -1: font name (value: [A-Z0-9])
+    # Param  0: field orientation (enum)
+    # Param  1: character height in dots
+    # Param  2: width in dots
+    #
+    # (Param -1 is part of the command name, it will not appear in ZplCommand's params)
+    # ---
+    # This must be done externally because the command is 1 char long, with the second
+    # char being the font name, this means there are 36 2-char commands with the same
+    # fonctionnality.
+    #
+    # So instead of:
+    # AA: [....]
+    # AB: [....]
+    # AC: [....]
+    # etc..
+    # We simply generate it. Simple.
+    (('A'..'Z').to_a.concat ('0'..'9').to_a).each do |font_name|
+      COMMANDS_PARAM_INDEXES_TO_SCALE["A" + font_name] = [1, 2]
+    end
+
+    def self.ratio_scale(zpl_content, scale_ratio)
+      reader = ZplReader.new zpl_content
+      scaled_zpl = StringIO.new
+
+      reader.each_command do |cmd|
+        scale_cmd!(cmd, scale_ratio)
+        scaled_zpl << cmd.to_zpl_string
+      end
+
+      scaled_zpl.string
+    end
+
+    protected
+
+    def self.cmd_need_scale?(cmd)
+      !!COMMANDS_PARAM_INDEXES_TO_SCALE[cmd.name]
+    end
+
+    def self.scale_cmd!(cmd, scale_ratio)
+      return unless cmd_need_scale? cmd
+
+      cmd_params = cmd.params
+
+      param_indexes_to_scale = COMMANDS_PARAM_INDEXES_TO_SCALE[cmd.name]
+      param_indexes_to_scale.each do |param_index|
+
+        if (param_s = cmd_params[param_index]) && (param_i = param_to_i?(param_s))
+          cmd_params[param_index] = (param_i * scale_ratio).to_i
+        end
+      end
+    end
+
+    # Returns an integer converted from the string *param*, or nil if it cannot be
+    # converted.
+    def self.param_to_i?(param)
+      begin
+        Integer(param)
+      rescue ArgumentError # raised when *param* string cannot be converted to Integer
+        nil
+      end
+    end
+  end
+
+  def self.dpi_scale(zpl_content, from_dpi:, to_dpi:)
+    scale_ratio = to_dpi.to_f / from_dpi.to_f
+
+    Scaler.ratio_scale(zpl_content, scale_ratio)
+  end
+
+  def self.ratio_scale(zpl_content, scale_ratio)
+    Scaler.ratio_scale(zpl_content, scale_ratio)
+  end
+
+end

data/lib/zpl-scaler/version.rb

@@ -0,0 +1,3 @@
+module ZplScaler
+  VERSION = "0.1.0"
+end

data/zpl-scaler.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zpl-scaler/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zpl-scaler"
+  spec.version       = ZplScaler::VERSION
+  spec.authors       = ["Benoit de Chezelles"]
+  spec.email         = ["benoit.dechezelles@gmail.com"]
+
+  spec.summary       = %q{Simple gem to scale ZPL label}
+  spec.homepage      = "https://github.com/bew/zpl-scaler.rb"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: zpl-scaler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benoit de Chezelles
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- benoit.dechezelles@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zpl-scaler.rb
+- lib/zpl-scaler/version.rb
+- zpl-scaler.gemspec
+homepage: https://github.com/bew/zpl-scaler.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Simple gem to scale ZPL label
+test_files: []