zebra-zpl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02d6f5e561ffabed62717502d3f762fa518bfd00
+  data.tar.gz: 3bcba1f5caedeebf16bea8e9018021f116644378
+SHA512:
+  metadata.gz: 3e3fd2f85335014ff4afe6350aef68752fd7dd318a4c02e1823a55620361e2e571626708b227e096274cb38540cced96c326b13add7b51e6fca8819dd7bdf7f4
+  data.tar.gz: e5dad045be5b3eb38bb74749f3c3eabb7196f1da24b1c5e3f5a4f091f4a0e1c5694c8a06832f5ad58d8faf9a6899f39ef987954d79c08597b01568a90ebf3e8a

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tags
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zebra-zpl.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 bulpettb
+
+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/LICENSE_ORIGINAL.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Cássio Marques
+
+MIT License
+
+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,180 @@
+#### This is a gem based on a terrific older gem by Cassio Marques. Although the new printers are mostly compatible with old Eltron (Epl) code, my needs require many of the new Zebra (ZPL) functions. 
+
+# Zebra::Zpl
+
+### ToDo: Update documentation with instructions for new features such as font sizing, margins, and text alignment
+
+Zebra::Zpl offers a Ruby DSL to design and print labels using the ZPL programming language. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'zebra-zpl'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zebra-zpl
+
+## Usage
+
+### Building labels
+
+You create new labels with an instance of the `Zebra::Zpl::Label` class. It accepts the following options:
+
+* `copies`: The number of copies to print. This option defaults to 1.
+* `width`: The label's width, in dots.
+* `length`: The label's length, is dots.
+* `gap`: The gap between labels, in dots.
+* `print_speed`: The print speed to be used. You can use values between 0 and 6. This option is required.
+* `print_density`: The print density to be used. You can use values between 0 and 15. This option is required.
+
+With a label, you can start adding elements to it:
+
+	label = Zebra::Zpl::Label.new :print_density => 8, :print_speed => 3
+	text  = Zebra::Zpl::Text.new :data => "Hello, printer!", :position => [100, 100], :font_size => Zebra::Zpl::FontSize::SIZE_2
+	label << text
+	
+You can add as many elements as you want.
+
+### Printing the labels
+
+You need to have your printer visible to CUPS. Once your printer is configured and you know its name on CUPS, you can send the labels to the printer using a `Zebra::PrintJob` instance.
+
+	label = Zebra::Zpl::Label.new(
+	  :width         => 200,
+	  :length        => 200,
+	  :print_speed   => 3,
+	  :print_density => 6
+	)
+	
+	
+	barcode = Zebra::Zpl::Barcode.new(
+	  :data                      => "12345678",
+	  :position                  => [50, 50],
+	  :height                    => 50,
+	  :print_human_readable_code => true,
+	  :narrow_bar_width          => 4,
+	  :wide_bar_width            => 8,
+	  :type                      => Zebra::Zpl::BarcodeType::CODE_128_AUTO
+	)
+	
+	label << barcode
+	
+	print_job = Zebra::PrintJob.new "your-printer-name-on-cups"
+	
+	print_job.print label
+
+This will persist the label contents to a tempfile (using Ruby's tempfile core library) and copy the file to the printer using either `lpr -P <your-printer-name-on-cups> -o raw <path-to-the-temp-file>` (if you're on Mac OSX) or `lp -d <your-printer-name-on-cups> -o raw <path-to-the-tempfile>` (if you're on Linux). All the tempfile creation/path resolution, as well as which command has to be used, are handled by the `PrintJob` class. 
+
+### Printing QR codes
+
+    label = Zebra::Zpl::Label.new(
+      :width=>350,
+      :length=>250,
+      :print_speed=>3,
+      :print_density=>6
+    )
+
+    qrcode = Zebra::Zpl::Qrcode.new(
+      :data=>"www.github.com",
+      :position=>[50,10],
+      :scale_factor=>3,
+      :correction_level=>"H"
+    )
+
+    label << qrcode
+
+    print_job = Zebra::PrintJob.new "your-qr-printer-name-on-cups"
+
+    print_job.print label
+	
+### Available elements
+
+#### Text
+
+You create text elements to print using instances of the `Zebra::Zpl::Text` class. It accepts the following options:
+
+* `position`: An array with the coordinates to place the text, in dots. 
+* `rotation`: The rotation for the text. More about the possible values below.
+* `data`: The text to be printed.
+* `v_multiplier`: The vertical multiplier to use. 
+* `h_multiplier`: The horizontal multipler to use.
+* `print_mode`: The print mode. Can be normal ("N") or reverse ("R").
+* `font_size`: The font size to use. You can use values between 1 and 5.
+
+For the print modes, you can also use the constants:
+
+* `Zebra::Zpl::PrintMode::NORMAL`
+* `Zebra::Zpl::PrintMode::REVERSE`
+
+
+#### Barcodes
+
+You create barcode elements to print using instances of the `Zebra::Zpl::Barcode` class. It accepts the following options:
+
+* `position`: An array with the coordinates to place the text, in dots. 
+* `height`: The barcode's height, in dots.
+* `rotation`: The rotation for the text. More about the possible values below.
+* `data`: The text to be printed.
+* `type`: The type os barcode to use. More on the available types below.
+* `narrow_bar_width`: The barcode's narrow bar width, in dots.
+* `wide_bar_width`: The barcode's wide bar width, in dots.
+* `print_human_readable_code`: Can be `true` or `false`, indicates if the human readable contents should be printed below the barcode.
+
+The available barcode types are:
+
+* `Zebra::Zpl::BarcodeType::CODE_39`
+* `Zebra::Zpl::BarcodeType::CODE_93`
+* `Zebra::Zpl::BarcodeType::CODE_128_AUTO`
+* `Zebra::Zpl::BarcodeType::CODABAR`
+* `Zebra::Zpl::BarcodeType::CODE_AZTEC`
+* `Zebra::Zpl::BarcodeType::CODE_AZTEC_PARAMS`
+* `Zebra::Zpl::BarcodeType::CODE_UPS_MAXICODE`
+* `Zebra::Zpl::BarcodeType::CODE_QR`
+
+#### QR Codes
+
+You can create QR Codes elements to print using instances of the `Zebra::Zpl::Qrcode` class. It accepts the following options:
+
+* `position`: An array with the coordinates to place the QR code, in dots.
+* `scale factor`: Crucial variable of the QR codes's size. Accepted values: 1-99.
+* `error correction level`: Algorithm enables reading damaged QR codes. There are four error correction levels: L - 7% of codewords can be restored, M - 15% can be restored, Q - 25% can be restored, H - 30% can be restored.
+
+#### Boxes
+
+You can draw boxes in your labels:
+
+	box = Zebra::Zpl::Box.new :position => [20, 20], :end_position => [100, 100], :line_thickness => 39
+	
+#### Elements Rotation
+
+All printable elements can be rotated on the label, using the `:Rotation` option. The accepted rotation values are:
+
+* `Zebra::Zpl::Rotation::NO_ROTATION`: will not rotate the element.
+* `Zebra::Zpl::Rotation::DEGREES_90`: will rotate the element 90 degrees.
+* `Zebra::Zpl::Rotation::DEGREES_180`: will rotate the element 180 degrees.
+* `Zebra::Zpl::Rotation::DEGREES_270`: will rotate the element 270 degrees.
+
+#### Elements Justification
+
+There are four ZPL-supported `:Justification` parameters. "LEFT" (left-justified) is the default.
+
+* `Zebra::Zpl::Justification::LEFT` ~ left-justified
+* `Zebra::Zpl::Justification::RIGHT` ~ right-justified
+* `Zebra::Zpl::Justification::CENTER` ~ centered
+* `Zebra::Zpl::Justification::JUSTIFIED` ~ full-width-justifed _(YMMV)_
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/zebra/print_job.rb

@@ -0,0 +1,35 @@
+module Zebra
+  class PrintJob
+    # class UnknownPrinter < StandardError
+    #   def initialize(printer)
+    #     super("Could not find a printer named #{printer}")
+    #   end
+    # end
+
+    attr_reader :printer
+
+    def initialize(printer)
+      #check_existent_printers printer
+
+      @printer = printer
+    end
+
+    def print(label, ip)
+      @remote_ip = ip
+      tempfile = label.persist
+      send_to_printer tempfile.path
+    end
+
+    private
+
+    # def check_existent_printers(printer)
+    #   existent_printers = Cups.show_destinations
+    #   raise UnknownPrinter.new(printer) unless existent_printers.include?(printer)
+    # end
+
+    def send_to_printer(path)
+      puts "* * * * * * * * * * * * Sending file to printer #{@printer} at #{@remote_ip} * * * * * * * * * * "
+      `lp -h #{@remote_ip} -d #{@printer} -o raw #{path}`
+    end
+  end
+end

data/lib/zebra/zpl/barcode.rb

@@ -0,0 +1,55 @@
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class Barcode
+      include Printable
+
+      class InvalidNarrowBarWidthError < StandardError; end
+      class InvalidWideBarWidthError   < StandardError; end
+
+      attr_accessor :height
+      attr_reader :type, :narrow_bar_width, :wide_bar_width, :width
+      attr_writer :print_human_readable_code
+
+      def width=(width)
+        @width = width || 0
+      end
+
+      def type=(type)
+        BarcodeType.validate_barcode_type(type)
+        @type = type
+      end
+
+      def narrow_bar_width=(width)
+        raise InvalidNarrowBarWidthError unless (1..10).include?(width.to_i)
+        @narrow_bar_width = width
+      end
+
+      def wide_bar_width=(width)
+        raise InvalidWideBarWidthError unless (2..30).include?(width.to_i)
+        @wide_bar_width = width
+      end
+
+      def print_human_readable_code
+        @print_human_readable_code || false
+      end
+
+      def to_zpl
+        check_attributes
+        human_readable = print_human_readable_code ? "Y" : "N"
+        "^FW#{rotation}^FO#{x},#{y}^BY#{narrow_bar_width}^B#{type}#{rotation},#{height},#{human_readable}^FD#{data}^FS"
+      end
+
+      private
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the barcode type to be used is not given") unless @type
+        raise MissingAttributeError.new("the height to be used is not given") unless @height
+        raise MissingAttributeError.new("the narrow bar width to be used is not given") unless @narrow_bar_width
+        raise MissingAttributeError.new("the wide bar width to be used is not given") unless @wide_bar_width
+      end
+    end
+  end
+end

data/lib/zebra/zpl/barcode_type.rb

@@ -0,0 +1,34 @@
+module Zebra
+  module Zpl
+    module BarcodeType
+      class InvalidBarcodeTypeError < StandardError; end
+
+      CODE_39             = "3"
+      CODE_93             = "A"
+      CODE_128_AUTO       = "C"
+      CODABAR             = "K"
+      CODE_AZTEC          = "0"
+      CODE_AZTEC_PARAMS   = "O"
+      CODE_UPS_MAXICODE   = "D"
+      CODE_QR             = "Q"
+
+      # Legacy (EPL) bar code suffixes
+      # CODE_39             = "3"
+      # CODE_39_CHECK_DIGIT = "3C"
+      # CODE_93             = "9"
+      # CODE_128_AUTO       = "1"
+      # CODE_128_A          = "1A"
+      # CODE_128_B          = "1B"
+      # CODE_128_C          = "1C"
+      # CODABAR             = "K"
+
+      def self.valid_barcode_type?(type)
+        %w(3 A C K 0 O D Q).include? type
+      end
+
+      def self.validate_barcode_type(type)
+        raise InvalidBarcodeTypeError unless valid_barcode_type?(type)
+      end
+    end
+  end
+end

data/lib/zebra/zpl/box.rb

@@ -0,0 +1,50 @@
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class Box
+      include Printable
+
+      class InvalidLineThickness < StandardError; end
+
+      attr_reader :line_thickness, :box_width, :box_height, :width
+
+      def line_thickness=(thickness)
+        raise InvalidLineThickness unless thickness.nil? || thickness.to_i.to_s == thickness.to_s
+        @line_thickness = thickness
+      end
+
+      def box_width=(width)
+        @box_width = width
+      end
+
+      ### The method below refers to the "label width"
+      def width=(width)
+        @width = width || 0
+      end
+
+      def box_height=(height)
+        @box_height = height
+      end
+
+      def to_zpl
+        check_attributes
+        # "^FO#{x},#{y}^GB#{box_width},#{box_height},#{line_thickness}^FS"
+        "^FO#{x},#{y}^GB#{box_width},#{box_height},#{line_thickness}^FS"
+      end
+
+      private
+
+      def has_data?
+        false
+      end
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the line thickness is not given") unless line_thickness
+        raise MissingAttributeError.new("the box_width is not given") unless box_width
+        raise MissingAttributeError.new("the box_height is not given") unless box_height
+      end
+    end
+  end
+end

data/lib/zebra/zpl/character_set.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+module Zebra
+  module Zpl
+    class CharacterSet
+      class InvalidNumberOfDataBits                     < StandardError; end
+      class CountryCodeNotApplicableForNumberOfDataBits < StandardError; end
+      class MissingAttributeError                       < StandardError
+        def initialize(attr)
+          super("Can't set character set if the #{attr} is not given")
+        end
+      end
+
+      attr_reader :number_of_data_bits, :language, :country_code
+
+      def initialize(options = {})
+        options.each_pair { |attribute, value| self.__send__ "#{attribute}=", value }
+      end
+
+      def number_of_data_bits=(nodb)
+        raise InvalidNumberOfDataBits unless [7, 8, nil].include?(nodb)
+        @number_of_data_bits = nodb
+      end
+
+      def language=(l)
+        Language.validate_language(l) unless l.nil?
+        @language = l
+      end
+
+      def country_code=(code)
+        CountryCode.validate_country_code(code) unless code.nil?
+        @country_code = code
+      end
+
+      def to_zpl
+        raise MissingAttributeError.new("language") if language.nil?
+        raise MissingAttributeError.new("number of data bits") if number_of_data_bits.nil?
+        raise MissingAttributeError.new("country code") if number_of_data_bits == 8 && country_code.nil?
+        raise CountryCodeNotApplicableForNumberOfDataBits if number_of_data_bits == 7 && !country_code.nil?
+        Language.validate_language_for_number_of_data_bits language, number_of_data_bits
+
+        ["I#{number_of_data_bits}", language, country_code].compact.join(",")
+      end
+    end
+  end
+end

data/lib/zebra/zpl/country_code.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module Zebra
+  module Zpl
+    class CountryCode
+      class InvalidCountryCodeError < StandardError; end
+
+      BELGIUM       = "032"
+      CANADA        = "002"
+      DENMARK       = "045"
+      FINLAND       = "358"
+      FRANCE        = "033"
+      GERMANY       = "049"
+      NETHERLANDS   = "031"
+      ITALY         = "039"
+      LATIN_AMERICA = "003"
+      NORWAY        = "047"
+      PORTUGAL      = "351"
+      SOUTH_AFRICA  = "027"
+      SPAIN         = "034"
+      SWEDEN        = "046"
+      SWITZERLAND   = "041"
+      UK            = "044"
+      USA           = "001"
+
+      def self.valid_country_code?(code)
+        [BELGIUM, CANADA, DENMARK, FINLAND, FRANCE, GERMANY, NETHERLANDS,
+         ITALY, LATIN_AMERICA, NORWAY, PORTUGAL, SOUTH_AFRICA, SPAIN, SWEDEN, SWITZERLAND,
+         UK, USA].include?(code)
+      end
+
+      def self.validate_country_code(code)
+        raise InvalidCountryCodeError unless valid_country_code?(code)
+      end
+    end
+  end
+end

data/lib/zebra/zpl/font.rb

@@ -0,0 +1,47 @@
+module Zebra
+  module Zpl
+    module FontSize
+      class InvalidFontSizeError < StandardError; end
+
+      SIZE_0 = 12 # tiny
+      SIZE_1 = 17 # 6pt
+      SIZE_2 = 22 # 8pt
+      SIZE_3 = 28 # 10pt
+      SIZE_4 = 33 # 12pt
+      SIZE_5 = 44 # 16pt
+      SIZE_6 = 67 # 24pt
+      SIZE_7 = 100 # 32pt
+      SIZE_8 = 111 # 40pt
+      SIZE_9 = 133 # 48pt
+
+      def self.valid_font_size?(font_size)
+        [12, 17, 22, 28, 33, 44, 67, 100, 111, 133].include?(font_size.to_i)
+      end
+
+      def self.validate_font_size(font_size)
+        raise InvalidFontSizeError unless valid_font_size?(font_size)
+      end
+    end
+
+    module FontType
+      class InvalidFontTypeError < StandardError; end
+
+      TYPE_0  = "0" # 6pt
+      TYPE_CD = "CD" # 6pt
+      TYPE_A  = "A" # 6pt
+      TYPE_B  = "B" # 6pt
+      TYPE_E  = "E" # 6pt
+      TYPE_F  = "F" # 6pt
+      TYPE_G  = "G" # 6pt
+      TYPE_H  = "H" # 6pt
+
+      def self.valid_font_type?(font_type)
+        ["0", "CD", "A", "B", "E", "F", "G", "H"].include?(font_type)
+      end
+
+      def self.validate_font_type(font_type)
+        raise InvalidFontTypeError unless valid_font_type?(font_type)
+      end
+    end
+  end
+end

data/lib/zebra/zpl/justification.rb

@@ -0,0 +1,21 @@
+module Zebra
+  module Zpl
+    module Justification
+      class InvalidJustificationError < StandardError; end
+
+      # ZPL-supported values ("L" is default)
+      LEFT        = 'L'
+      RIGHT       = 'R'
+      CENTER      = 'C'
+      JUSTIFIED   = 'J'
+
+      def self.valid_justification?(justification)
+        [LEFT, RIGHT, CENTER, JUSTIFIED].include? justification
+      end
+
+      def self.validate_justification(justification)
+        raise InvalidJustificationError unless valid_justification?(justification)
+      end
+    end
+  end
+end