rdpl 0.1.0

data/lib/label.rb

@@ -0,0 +1,99 @@
+module Rdpl
+  class Label
+    attr_reader :state, :quantity
+    attr_writer :job
+
+    include Commandable
+
+    START            = 'L'
+    FINISH           = 'E'
+    DEFAULT_DOT_SIZE = 11
+    DEFAULT_HEAT     = 14
+
+    def initialize(options = {})
+      @contents = ''
+      start options
+    end
+
+    def dump
+      @contents.dup
+    end
+
+    def end!
+      self << formatted_quantity unless quantity.nil?
+      self << FINISH 
+      self.state = :finished
+    end
+
+    def [](arg)
+      @contents[arg]
+    end
+
+    def <<(arg)
+      raise EndedElementError unless state == :open
+      @contents << arg.to_s << NEW_LINE
+    end
+
+    def dot_size
+      @dot_size || DEFAULT_DOT_SIZE
+    end
+
+    def heat
+      @heat || DEFAULT_HEAT
+    end
+
+    def mm?
+      @job ? @job.mm? : false
+    end
+
+    # Returns the start of print position for the label.
+    # If the option wasn't specified in the label's constructor, nil will be returned 
+    # and the printer will assume the default start of print.
+    #
+    # It works this way since the default value for this parameter depends on the printer's model.
+    def start_of_print
+      return nil if @start_of_print.nil?
+      @start_of_print.to_f / (mm? ? 10 : 100)
+    end
+
+    {:line           => 'Line',
+     :box            => 'Box',
+     :barcode        => 'Barcode',
+     :bitmapped_text => 'BitmappedText'
+    }.each_pair do |kind, klass|
+      define_method "add_#{kind}" do |&block|
+        element = Rdpl.const_get(klass).new
+        block.call element
+        self << element.to_s
+      end
+    end
+
+    private
+    def start(options = {})
+      self.state = :open
+      command START
+      self << formatted_heat
+      self << formatted_dot_size
+      options.each_pair { |option, value| self.send("#{option}=", value) }
+    end
+
+    [:state, :heat, :dot_size, :start_of_print, :quantity].each do |method|
+      define_method "#{method}=" do |value| 
+        self.instance_variable_set :"@#{method}", value
+      end
+    end
+    public :quantity=
+
+    def formatted_dot_size
+      "D#{dot_size}"
+    end
+
+    def formatted_heat
+      "H#{heat}"
+    end
+
+    def formatted_quantity
+      "Q#{'%04d' % quantity}"       
+    end
+  end
+end

data/lib/rdpl.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+module Rdpl
+  STX      = 2.chr
+  CR       = 13.chr
+  LF       = 10.chr
+  NEW_LINE = CR + LF
+  FEED     = 'F'
+
+  module Commandable
+    def command(param)
+      raise EndedElementError if self.state == :finished
+      @contents << STX << param << NEW_LINE
+    end
+  end
+
+  module Sensor 
+    REFLEXIVE = 'r'
+    EDGE      = 'e'
+  end
+
+  class MissingPrinterNameError < StandardError; end
+  class EndedElementError         < StandardError; end
+end
+
+require 'job'
+require 'label'
+require 'elements/element'
+require 'elements/graphic'
+require 'elements/barcode'
+require 'elements/bitmapped_text'
+require 'elements/lines_and_boxes'
+require 'elements/line'
+require 'elements/box'

data/spec/elements/barcode_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Rdpl::Barcode do
+  let(:barcode) { Rdpl::Barcode.new }
+
+  describe "::CODE_128" do
+    it "equals 'e'" do
+      Rdpl::Barcode::CODE_128.should == 'e'
+    end
+  end
+
+  describe "::CODE_128_HUMAN" do
+    it "equals 'E'" do
+      Rdpl::Barcode::CODE_128_HUMAN.should == 'E'
+    end
+  end
+
+  describe "#height=" do
+    it "defines the barcode height" do
+      barcode.height = 100
+      barcode.instance_variable_get(:@height).should == 100
+    end
+
+    it "raises InvalidBarcodeHeightError if the height is less than 0" do
+      lambda do
+        barcode.height = -1
+      end.should raise_error(Rdpl::Element::InvalidBarcodeHeightError)
+    end
+
+    it "raises InvalidBarcodeHeightError if the height is above 999" do
+      lambda do
+        barcode.height = 1000
+      end.should raise_error(Rdpl::Element::InvalidBarcodeHeightError)
+    end
+  end
+
+  describe "#height" do
+    let(:barcode) { Rdpl::Barcode.new }
+
+    it "returns the barcode height" do
+      barcode.height = 100
+      barcode.height.should == 100
+    end
+
+    it "returns 25 by default" do
+      barcode.height.should == 25
+    end
+  end
+
+  describe "#to_s" do
+    it "returns the barcode's string representation" do
+      barcode = Rdpl::Barcode.new(
+        :rotation              => 4,
+        :font_id               => Rdpl::Barcode::CODE_128,
+        :data                  => 'SOME DATA 12345',
+        :height                => 123,
+        :wide_bar_multiplier   => 3,
+        :narrow_bar_multiplier => 4,
+        :row_position          => 123,
+        :column_position       => 234
+      )
+      barcode.to_s.should == '4e3412301230234SOME DATA 12345'
+    end
+  end
+end

data/spec/elements/bitmapped_text_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Rdpl::BitmappedText do
+
+  it_should_behave_like "element"
+
+  describe "#to_s" do
+    it "should return a string represention of the text element" do
+      text = Rdpl::BitmappedText.new(
+        :font_id           => 2,
+        :width_multiplier  => 2,
+        :height_multiplier => 3,
+        :row_position      => 20,
+        :column_position   => 30,
+        :data              => 'HEY LOOK AT ME'
+      )
+      text.to_s.should == '122300000200030HEY LOOK AT ME'
+    end
+  end
+end

data/spec/elements/box_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Rdpl::Box do
+  let(:element) { Rdpl::Box.new }
+
+  it_should_behave_like 'lines and boxes'
+
+  describe "#bottom_and_top_thickness=" do
+    it "defines the thickness of bottom and top box edges" do
+      element.bottom_and_top_thickness = 23.4
+      element.instance_variable_get(:@bottom_and_top_thickness).should == 23.4
+    end
+  end
+
+  describe "#bottom_and_top_thickness" do
+    it "returns the thickness of bottom and top box edges" do
+      element.bottom_and_top_thickness = 23.4
+      element.bottom_and_top_thickness.should == 23.4
+    end
+
+    it "returns 0 by default" do
+      element.bottom_and_top_thickness.should be_zero
+    end
+  end
+
+  describe "#sides_thickness=" do
+    it "defines the thickness of the box' sides" do
+      element.sides_thickness = 23.5
+      element.instance_variable_get(:@sides_thickness).should == 23.5
+    end
+  end
+
+  describe "#sides_thickness" do
+    it "returns the thickness of the box' sides" do
+      element.sides_thickness = 23.5
+      element.sides_thickness.should == 23.5
+    end
+
+    it "returns 0 by default" do
+      element.sides_thickness.should be_zero
+    end
+  end
+
+  describe "#to_s" do
+    it "should return a string represention of the graphic element" do
+      box = Rdpl::Box.new(
+        :horizontal_width         => 12.2,
+        :vertical_width           => 14.3,
+        :row_position             => 23.4,
+        :column_position          => 24.5,
+        :bottom_and_top_thickness => 34.6,
+        :sides_thickness          => 45.6
+      )
+      box.to_s.should == "1X1100002340245b0122014303460456"
+    end
+  end
+end

data/spec/elements/line_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Rdpl::Line do
+  let(:element) { Rdpl::Line.new }
+
+  it_should_behave_like 'lines and boxes'
+
+  describe "#to_s" do
+    it "should return a string represention of the graphic element" do
+      line = Rdpl::Line.new(
+        :horizontal_width => 12.2,
+        :vertical_width   => 14.3,
+        :row_position     => 23.4,
+        :column_position  => 24.5
+      )
+      line.to_s.should == "1X1100002340245l01220143"
+    end
+  end
+end

data/spec/job_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Rdpl::Job do
+  def new_job(options = {})
+    Rdpl::Job.new({:printer => 'foobar'}.merge(options))
+  end
+
+  subject { new_job }
+
+  its(:state) { should == :open }
+
+  describe "sensor" do
+    it "returns the current sensor" do
+      new_job(:sensor => Rdpl::Sensor::REFLEXIVE).sensor.should == Rdpl::Sensor::REFLEXIVE
+    end
+  end
+
+  it "uses the edge sensor by default" do
+    new_job.dump[0..1].should == Rdpl::STX + Rdpl::Sensor::EDGE
+  end
+
+  describe "#measurement" do
+    it "returns the current job measurement mode" do
+      job = new_job :measurement => :metric
+      job.measurement.should == :metric
+    end
+
+    it "returns :inches by default" do
+      new_job.measurement.should == :inches
+    end
+
+    it "do not accepts values different from inches or metric" do
+      lambda do
+        new_job(:measurement => :foo)
+      end.should raise_error(ArgumentError)      
+    end
+  end
+
+  describe "#in?" do
+    it "returns true if the current measurement mode is :inches" do
+      new_job.should be_in
+    end
+
+    it "returns false if the current measurement mode is not :inches" do
+      new_job(:measurement => :metric).should_not be_in
+    end
+  end
+
+  describe "#mm?" do
+    it "returns true if the current measurement mode is :metric" do
+      new_job(:measurement => :metric).should be_mm
+    end
+
+    it "returns false if the current measurement mode is not :metric" do
+      new_job.should_not be_mm
+    end
+  end
+
+  it "has a list of labels" do
+    new_job.labels.should be_instance_of(Array)
+  end
+
+  it "requires a CUPS printer name" do
+    lambda do
+      Rdpl::Job.new
+    end.should raise_error(Rdpl::MissingPrinterNameError)    
+  end
+
+  describe "#<<" do
+    it "adds a new label to the job" do
+      job = new_job
+      label = Rdpl::Label.new
+      expect {
+        job << label
+      }.to change { job.labels.size }.by(1)
+    end
+
+    it "sets itself as the label's job" do
+      job = Rdpl::Job.new :printer => 'foobar'
+      label = Rdpl::Label.new
+      expect {
+        job << label
+      }.to change { label.instance_variable_get :@job }.from(nil).to(job)
+    end
+  end
+
+  it "allows iteration through the labels" do
+    job = new_job
+    job << (label1 = Rdpl::Label.new)
+    job << (label2 = Rdpl::Label.new)
+    job.map.should == [label1, label2]
+  end
+
+  describe "#dump" do
+    it "returns the job's contents" do
+      job = new_job
+      label1 = Rdpl::Label.new
+      label1 << 'label1'
+      label1.end!
+      job << label1
+      label2 = Rdpl::Label.new
+      label2 << 'label2'
+      label2.end!
+      job << label2
+      expected = "\002e\r\n\002L\r\nH14\r\nD11\r\nlabel1\r\nE\r\n\002F\r\n\002L\r\nH14\r\nD11\r\nlabel2\r\nE\r\n\002F\r\n"
+      job.dump.should == expected
+    end
+  end
+
+  describe "#feed" do
+    it "adds the form feed command to the job" do
+      job = new_job
+      job.feed
+      job.dump[-4..-3].should == Rdpl::STX + Rdpl::FEED
+    end
+  end
+  describe "#print" do
+    let(:temp_file) { "" }
+
+    before :each do
+      temp_file.stub!(:close).and_return(true)
+      temp_file.stub!(:path).and_return("/tmp/datamax_label123")
+      Tempfile.stub!(:new).and_return(temp_file)
+    end
+
+    it "creates a temporary file with its contents" do
+      Tempfile.should_receive(:new).with('datamax_label').and_return(temp_file)
+      new_job.print
+    end
+
+    it "sends the job to the printer" do
+      Kernel.should_receive(:system).with('lpr -P foobar /tmp/datamax_label123')
+      new_job.print
+    end
+  end
+end

data/spec/label_spec.rb

@@ -0,0 +1,210 @@
+require 'spec_helper'
+
+
+describe Rdpl::Label do
+  def end_with_new_line
+    simple_matcher('creates a new line') { |actual| actual[-2..-1] == CR + LF }
+  end
+
+  describe "::DEFAULT_DOT_SIZE" do
+    subject { Rdpl::Label::DEFAULT_DOT_SIZE }
+    it { should == 11 }
+  end
+
+  describe "::DEFAULT_HEAT" do
+    subject { Rdpl::Label::DEFAULT_HEAT }
+    it { should == 14 }
+  end
+
+  its(:state) { should == :open }
+
+  describe "mm?" do
+    it "delegates to the printing job" do
+      label = Rdpl::Label.new
+      label.job = Rdpl::Job.new :printer => 'foobar', :measurement => :metric
+      label.should be_mm
+    end
+
+    it "returns false if the label has no job" do
+      Rdpl::Label.new.should_not be_mm
+    end
+  end
+
+  describe "#contents" do
+    it "is always started with STX L (for Label start), plus the dot size and heating settings" do
+      label = Rdpl::Label.new
+      expected = Rdpl::STX +
+                 Rdpl::Label::START +
+                 Rdpl::NEW_LINE +
+                 "H#{Rdpl::Label::DEFAULT_HEAT}" +
+                 Rdpl::NEW_LINE +
+                 "D#{Rdpl::Label::DEFAULT_DOT_SIZE}" +
+                 Rdpl::NEW_LINE
+      label.dump.should == expected
+    end
+  end
+
+  describe "#end!" do
+    let(:label) { Rdpl::Label.new }
+
+    it "marks the label's end" do
+      label.end!
+      label[-3..-1].should == 'E' + Rdpl::NEW_LINE
+    end
+
+    it "alters the state to :closed" do
+      expect {
+        label.end!
+      }.to change { label.state }.to(:finished)
+    end
+
+    it "adds the quantity command if a quantity was specified" do
+      label = Rdpl::Label.new
+      label.quantity = 5
+      label.end!
+      label.dump[-10..-6].should == 'Q0005'
+    end
+  end
+
+  it "raises Rdpl::EndedElementError if it's ended andwe try to add new content" do
+    label = Rdpl::Label.new
+    label.end!
+    lambda do
+      label << 'some content'
+    end.should raise_error(Rdpl::EndedElementError)
+  end
+
+  describe "#command" do
+    let(:label) { Rdpl::Label.new }
+    before(:each) { label.command 'FOO' }
+
+    it { end_with_new_line }
+
+    it "records the command in the label's contents" do
+      expected = Rdpl::STX + 'FOO'
+      label.dump.should include(expected)
+    end
+
+    it "ends with CR/LF" do
+      expected = Rdpl::CR + Rdpl::LF
+      label[-2..-1].should == expected
+    end
+  end
+
+  describe "#<<" do
+    let(:label) { Rdpl::Label.new }
+
+    before(:each) { label << 'BAR' }
+
+    it { end_with_new_line }
+
+    it "puts the text inside the label" do
+      label.dump.should include('BAR')
+    end
+
+    it "allows inserting non-string elements" do
+      label << Rdpl::Barcode.new(:data => 'BARCODE')
+      label.dump.should include('BARCODE')
+    end
+  end
+
+  describe "#dot_size" do
+    it "returns the current dot size" do
+      Rdpl::Label.new(:dot_size => 20).dot_size.should == 20
+    end
+
+    it "returns Label::DEFAULT_DOT_SIZE by default" do
+      Rdpl::Label.new.dot_size.should == Rdpl::Label::DEFAULT_DOT_SIZE
+    end
+  end
+
+  describe "#heat" do
+    it "returns the current heat setting" do
+      Rdpl::Label.new(:heat => 25).heat.should == 25
+    end
+
+    it "returns Label::DEFAULT_HEAT by default" do
+      Rdpl::Label.new.heat.should == Rdpl::Label::DEFAULT_HEAT
+    end
+  end
+
+  describe "#start_of_print" do
+    it "returns nil if start_of_print was not specified" do
+      Rdpl::Label.new.start_of_print.should be_nil
+    end
+
+    describe "when the measurenemt mode is inches" do
+      it "returns the configured start of print" do
+        Rdpl::Label.new(:start_of_print => '0123').start_of_print.should == 1.23
+      end
+    end
+
+    describe "when the measurement mode is metric" do
+      it "returns the configured start of print" do
+        label = Rdpl::Label.new(:start_of_print => '0123')
+        label.job = Rdpl::Job.new :printer => 'foo', :measurement => :metric
+        label.start_of_print.should == 12.3
+      end
+    end
+  end
+
+  describe "#add_line" do
+    it "should add a line element to the label's contents" do
+      label = Rdpl::Label.new
+      label.add_line do |line|
+        line.horizontal_width = 12.2
+        line.vertical_width   = 14.3
+        line.row_position     = 23.4
+        line.column_position  = 24.5
+      end
+      label.dump.should include("1X1100002340245l01220143#{Rdpl::NEW_LINE}")
+    end
+  end
+
+  describe "#add_box" do
+    it "should add a box element to the label's contents" do
+      label = Rdpl::Label.new
+      label.add_box do |box|
+        box.horizontal_width         = 12.2
+        box.vertical_width           = 14.3
+        box.row_position             = 23.4
+        box.column_position          = 24.5
+        box.bottom_and_top_thickness = 34.6
+        box.sides_thickness          = 45.6
+      end
+      label.dump.should include("1X1100002340245b0122014303460456#{Rdpl::NEW_LINE}")
+    end
+  end
+
+  describe "#add_barcode" do
+    it "should add a barcode element to the label's contents" do
+      label = Rdpl::Label.new
+      label.add_barcode do |barcode|
+        barcode.rotation              = 4
+        barcode.font_id               = 'e'
+        barcode.data                  = 'SOME DATA 12345'
+        barcode.height                = 123
+        barcode.wide_bar_multiplier   = 3
+        barcode.narrow_bar_multiplier = 4
+        barcode.row_position          = 123
+        barcode.column_position       = 234
+      end
+      label.dump.should include('4e3412301230234SOME DATA 12345')
+    end
+  end
+
+  describe "#add_bitmapped_text" do
+    it "should add a bitmapped text element to the labe's contents" do
+      label = Rdpl::Label.new
+      label.add_bitmapped_text do |text|
+        text.font_id           = 2
+        text.width_multiplier  = 2
+        text.height_multiplier = 3
+        text.row_position      = 20
+        text.column_position   = 30
+        text.data              = 'HEY LOOK AT ME'
+      end
+      label.dump.should include('122300000200030HEY LOOK AT ME')
+    end
+  end
+end