zebra-epl 0.0.7 → 0.0.8

data/Guardfile

@@ -1,7 +1,7 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec' do
+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" }

data/README.md

@@ -1,6 +1,6 @@
 # Zebra::Epl
 
-TODO: Write a gem description
+Zebra::Epl offers a Ruby DSL to design and print labels using the EPL programming language. 
 
 ## Installation
 
@@ -18,7 +18,143 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Building labels
+
+You create new labels with an instance of the `Zebra::Epl::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::Epl::Label.new :print_density => 8, :print_speed => 3
+	text  = Zebra::Epl::Text.new :data => "Hello, printer!", :position => [100, 100], :font => Zebra::Epl::Font::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::Epl::Label.new(
+	  :width         => 200,
+	  :length        => 200,
+	  :print_speed   => 3,
+	  :print_density => 6
+	)
+	
+	
+	barcode = Zebra::Epl::Barcode.new(
+	  :data                      => "12345678",
+	  :position                  => [50, 50],
+	  :height                    => 50,
+	  :print_human_readable_code => true,
+	  :narrow_bar_width          => 4,
+	  :wide_bar_width            => 8,
+	  :type                      => Zebra::Epl::BarcodeType::CODE_128_AUTO
+	)
+	
+	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::Epl::Label.new(
+      :width=>350,
+      :length=>250,
+      :print_speed=>3,
+      :print_density=>6
+    )
+
+    qrcode = Zebra::Epl::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::Epl::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`: The font size to use. You can use values between 1 and 5.
+
+For the print modes, you can also use the constants:
+
+* `Zebra::Epl::PrintMode::NORMAL`
+* `Zebra::Epl::PrintMode::REVERSE`
+
+
+#### Barcodes
+
+You create barcode elements to print using instances of the `Zebra::Epl::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::Epl::BarcodeType::CODE_39`
+* `Zebra::Epl::BarcodeType::CODE_39_CHECK_DIGIT`
+* `Zebra::Epl::BarcodeType::CODE_93`
+* `Zebra::Epl::BarcodeType::CODE_128_AUTO`
+* `Zebra::Epl::BarcodeType::CODE_128_A`
+* `Zebra::Epl::BarcodeType::CODE_128_B`
+* `Zebra::Epl::BarcodeType::CODE_128_C`
+* `Zebra::Epl::BarcodeType::CODABAR`
+
+#### QR Codes
+
+You can create QR Codes elements to print using instances of the `Zebra::Epl::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::Epl::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::Epl::Rotation::NO_ROTATION`: will not rotate the element.
+* `Zebra::Epl::Rotation::DEGREES_90`: will rotate the element 90 degrees.
+* `Zebra::Epl::Rotation::DEGREES_180`: will rotate the element 180 degrees.
+* `Zebra::Epl::Rotation::DEGREES_270`: will rotate the element 270 degrees.
+
+
 
 ## Contributing
 

data/lib/zebra/epl.rb

@@ -14,4 +14,4 @@ require "zebra/epl/text"
 require "zebra/epl/barcode"
 require "zebra/epl/barcode_type"
 require "zebra/print_job"
-
+require "zebra/epl/qrcode"

data/lib/zebra/epl/qrcode.rb

@@ -0,0 +1,37 @@
+require "zebra/epl/printable"
+
+module Zebra
+  module Epl
+    class Qrcode
+      include Printable
+
+      class InvalidScaleFactorError < StandardError; end
+      class InvalidCorrectionLevelError < StandardError; end
+
+      attr_reader :scale_factor, :correction_level
+
+      def scale_factor=(value)
+        raise InvalidScaleFactorError unless (1..99).include?(value.to_i)
+        @scale_factor = value
+      end
+
+      def correction_level=(value)
+        raise InvalidCorrectionLevelError unless %w[L M Q H].include?(value.to_s)
+        @correction_level = value
+      end
+
+      def to_epl
+        check_attributes
+        ["b#{x}", y, "Q", "s#{scale_factor}", "e#{correction_level}", "\"#{data}\""].join(",")
+      end
+
+      private
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the scale factor to be used is not given") unless @scale_factor
+        raise MissingAttributeError.new("the error correction level to be used is not given") unless @correction_level
+      end
+    end
+  end
+end

data/lib/zebra/epl/version.rb

@@ -1,5 +1,5 @@
 module Zebra
   module Epl
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/spec/zebra/epl/qrcode_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Zebra::Epl::Qrcode do
+    it "can be initialized with the scale factor" do 
+      qrcode = described_class.new :scale_factor => 3
+      expect(qrcode.scale_factor).to eq 3
+    end 
+
+    it "can be initialized with the error correction level" do
+      qrcode = described_class.new :correction_level => "M"
+      expect(qrcode.correction_level).to eq "M"
+    end
+
+    describe "#scale_factor" do
+      it "raises an error if the scale factor is not within the range 1-99" do
+        expect{described_class.new :scale_factor=>100}.to raise_error(Zebra::Epl::Qrcode::InvalidScaleFactorError)
+      end
+    end
+
+    describe "#correction_level" do
+      it "raises an error if the error correction_level not in [LMQH]" do
+        expect{described_class.new :correction_level=>"A"}.to raise_error(Zebra::Epl::Qrcode::InvalidCorrectionLevelError)
+      end
+    end              
+
+    describe "#to_epl" do
+      let(:valid_attributes) { {
+        :position         => [50, 50],
+        :scale_factor     => 3,
+        :correction_level => "M",
+        :data             => "foobar"
+      }}
+      let(:qrcode) { described_class.new valid_attributes }
+      let(:tokens) { qrcode.to_epl.split(",") }
+
+      it "raises an error if the X position is not given" do
+        qrcode = described_class.new :position => [nil, 50], :data => "foobar"
+        expect {
+          qrcode.to_epl
+        }.to raise_error(Zebra::Epl::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], :data => "foobar"
+        expect {
+          qrcode.to_epl
+        }.to raise_error(Zebra::Epl::Printable::MissingAttributeError, "Can't print if the Y value is not given")
+      end      
+
+      it "raises an error if the data to be printed was not informed" do
+        qrcode.data = nil
+        expect {
+          qrcode.to_epl
+        }.to raise_error(Zebra::Epl::Printable::MissingAttributeError, "Can't print if the data to be printed is not given")
+      end  
+      
+      it "raises an error if the scale factor is not given" do
+        valid_attributes.delete :scale_factor
+
+        expect {
+          qrcode.to_epl
+        }.to raise_error(Zebra::Epl::Printable::MissingAttributeError, "Can't print if the scale factor to be used is not given")
+      end
+
+      it "raises an error if the correction level is not given" do
+        valid_attributes.delete :correction_level
+
+        expect {
+          qrcode.to_epl
+        }.to raise_error(Zebra::Epl::Printable::MissingAttributeError, "Can't print if the error correction level to be used is not given")
+      end  
+
+      it "begins with the command 'b'" do
+        qrcode.to_epl.should =~ /\Ab/
+      end 
+
+      it "contains the X position" do
+        tokens[0].match(/b(\d+)/)[1].should eq "50"
+      end
+
+      it "contains the Y position" do
+        tokens[1].should eq "50"
+      end
+
+      it "contains QR code type" do
+        tokens[2].should eq "Q"
+      end
+
+      it "contains the scale factor" do
+        tokens[3].should eq "s3"
+      end
+
+      it "contains the error correction level" do
+        tokens[4].should eq "eM"
+      end
+
+      it "contains the data to be printed in the qrcode" do
+        tokens[5].should eq "\"foobar\""
+      end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zebra-epl
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-14 00:00:00.000000000 Z
+date: 2014-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cups
@@ -133,6 +133,7 @@ files:
 - lib/zebra/epl/multipliers.rb
 - lib/zebra/epl/print_mode.rb
 - lib/zebra/epl/printable.rb
+- lib/zebra/epl/qrcode.rb
 - lib/zebra/epl/rotation.rb
 - lib/zebra/epl/text.rb
 - lib/zebra/epl/version.rb
@@ -143,6 +144,7 @@ files:
 - spec/zebra/epl/character_set_spec.rb
 - spec/zebra/epl/epl_spec.rb
 - spec/zebra/epl/label_spec.rb
+- spec/zebra/epl/qrcode_spec.rb
 - spec/zebra/epl/text_spec.rb
 - spec/zebra/print_job_spec.rb
 - zebra-epl.gemspec
@@ -161,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: 892169269347069094
+      hash: 196605653010155924
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments:
       - 0
       version: '0'
-      hash: 892169269347069094
+      hash: 196605653010155924
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -185,5 +187,6 @@ test_files:
 - spec/zebra/epl/character_set_spec.rb
 - spec/zebra/epl/epl_spec.rb
 - spec/zebra/epl/label_spec.rb
+- spec/zebra/epl/qrcode_spec.rb
 - spec/zebra/epl/text_spec.rb
 - spec/zebra/print_job_spec.rb