rdpl 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@rdpl

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Cássio Marques
+
+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.rdoc

@@ -0,0 +1,17 @@
+= rdpl
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Cássio Marques. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rdpl"
+    gem.summary = %Q{Create Datamax™ labels using Ruby! }
+    gem.description = %Q{RDPL provides a way to create labels for the Datamax™ printers using plain Ruby, through an abstraction of the DPL (Datamax Programming Language)}
+    gem.email = "cassiommc@gmail.com"
+    gem.homepage = "http://github.com/cassiomarques/rdpl"
+    gem.authors = ["Cássio Marques"]
+    gem.add_development_dependency "rspec", ">= 1.3.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rdpl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/elements/barcode.rb

@@ -0,0 +1,37 @@
+module Rdpl
+  class Barcode
+    include Element
+
+    CODE_128       = 'e'
+    CODE_128_HUMAN = "E"
+
+    alias :wide_bar_multiplier :width_multiplier
+    alias :wide_bar_multiplier= :width_multiplier=
+    alias :narrow_bar_multiplier :height_multiplier
+    alias :narrow_bar_multiplier= :height_multiplier=
+
+    DEFAULT_HEIGHT = 25
+
+    def height=(height)
+      raise InvalidBarcodeHeightError unless valid_height_range.include?(height)
+      @height = height
+    end
+
+    def height
+      @height || DEFAULT_HEIGHT
+    end
+
+    private
+    def valid_height_range
+      0..999
+    end
+
+    def formatted_height
+      '%03d' % height
+    end
+
+    def valid_font_id_ranges
+      [('a'.. 'z'), ('A'..'Z')]
+    end
+  end
+end

data/lib/elements/bitmapped_text.rb

@@ -0,0 +1,10 @@
+module Rdpl
+  class BitmappedText
+    include Element
+
+    private
+    def valid_font_id_ranges
+      [(0..9)]
+    end
+  end
+end

data/lib/elements/box.rb

@@ -0,0 +1,34 @@
+module Rdpl
+  class Box
+    attr_writer :bottom_and_top_thickness, :sides_thickness
+
+    DEFAULT_CHARACTER = 'b'
+
+    include LinesAndBoxes
+
+    def bottom_and_top_thickness
+      @bottom_and_top_thickness || 0
+    end
+
+    def sides_thickness
+      @sides_thickness || 0
+    end
+
+    def data
+      DEFAULT_CHARACTER + 
+      formatted_horizontal_width + 
+      formatted_vertical_width +
+      formatted_bottom_and_top_thickness + 
+      formatted_sides_thickness
+    end
+
+    private
+    def formatted_bottom_and_top_thickness
+      '%04d' % normalize_number(bottom_and_top_thickness)
+    end
+
+    def formatted_sides_thickness
+      '%04d' % normalize_number(sides_thickness)
+    end
+  end
+end

data/lib/elements/element.rb

@@ -0,0 +1,134 @@
+module Rdpl
+  module Element
+    ROTATION_0_DEGREES   = 1
+    ROTATION_90_DEGREES  = 2
+    ROTATION_180_DEGREES = 3
+    ROTATION_270_DEGREES = 4
+    
+    class InvalidRotationError         < StandardError; end
+    class InvalidFontIdError           < StandardError; end
+    class InvalidWidthMultiplierError  < StandardError; end
+    class InvalidHeightMultiplierError < StandardError; end
+    class InvalidBarcodeHeightError    < StandardError; end
+    class FixedValueError              < StandardError; end
+    class InvalidAssigmentError        < StandardError; end
+
+    def initialize(options = {})
+      options.each_pair { |option, value| self.send "#{option}=", value }
+    end
+
+    def rotation=(rotation)
+      raise InvalidRotationError, rotation unless valid_rotation_range.include?(rotation)
+      @rotation = rotation
+    end
+
+    def rotation
+      @rotation || ROTATION_0_DEGREES
+    end
+
+    # Sets the element font type. Available types are:
+    #
+    # Type    Interpretation
+    # 0-9     Font
+    # A-T     Barcode with human readable text
+    # a-z     Barcode without human readable text
+    # X       Line, box, polygon, circle
+    # Y       Image
+    def font_id=(font_id)
+      raise InvalidFontIdError unless valid_font_id_ranges.any? { |range| range.include? font_id }
+      @font_id = font_id
+    end
+
+    def font_id
+      @font_id
+    end
+
+    # Valid values goes from 1 to 9 and A to O (base 25)
+    def width_multiplier=(multiplier)
+      raise InvalidWidthMultiplierError, multiplier unless valid_width_or_height_multiplier?(multiplier)
+      @width_multiplier = multiplier
+    end
+
+    def width_multiplier
+      @width_multiplier || 1
+    end
+
+    def height_multiplier=(multiplier)
+      raise InvalidHeightMultiplierError, multiplier unless valid_width_or_height_multiplier?(multiplier)
+      @height_multiplier = multiplier
+    end
+
+    # Valid values goes from 1 to 9 and A to O (base 25)
+    def height_multiplier
+      @height_multiplier || 1
+    end
+
+    # Used only by barcode and smooth/scaleble fonts, but has to be present as 000 
+    # in other elements.
+    def formatted_height
+      '000'
+    end
+
+    # Interpreted in hundredths of an inch or tenths of millimeters, depending on
+    # the measurement used in the printing job.
+    def row_position=(position)
+      @row_position = position   
+    end
+
+    def row_position
+      @row_position || 0
+    end
+
+    # Interpreted in hundredths of an inch or tenths of millimeters, depending on
+    # the measurement used in the printing job.
+    #
+    # Notice that the limits for this value depend on the printer model.
+    def column_position=(position)
+      @column_position = position
+    end
+
+    def column_position
+      @column_position || 0
+    end
+
+    def data=(data)
+      @data = data
+    end
+
+    def data
+      @data || ''
+    end
+
+    def to_s
+      [rotation, font_id, width_multiplier, height_multiplier, formatted_height, 
+        formatted_row_position, formatted_column_position, data].join
+    end
+
+    private
+    def valid_rotation_range
+      ROTATION_0_DEGREES..ROTATION_270_DEGREES
+    end
+
+    def valid_width_or_height_multiplier_ranges
+      [(1..9), ('A'..'O')]
+    end
+
+    def valid_width_or_height_multiplier?(multiplier)
+      valid_width_or_height_multiplier_ranges.any? { |range| range.include? multiplier }
+    end
+
+    def default_rotation; 1; end
+
+    def formatted_row_position
+      '%04d' % normalize_number(row_position)
+    end
+
+    def formatted_column_position
+      '%04d' % normalize_number(column_position)
+    end
+
+    def normalize_number(number)
+      number.to_s.gsub(/\./, '')
+    end
+  end
+end

data/lib/elements/graphic.rb

@@ -0,0 +1,11 @@
+module Rdpl
+  module Graphic
+    def font_id
+      'X'
+    end
+
+    def data=(data)
+      raise Element::InvalidAssigmentError, 'You cannot assign data to graphic elements'
+    end
+  end
+end

data/lib/elements/line.rb

@@ -0,0 +1,11 @@
+module Rdpl
+  class Line 
+    DEFAULT_CHARACTER = 'l'
+
+    include LinesAndBoxes
+
+    def data      
+      DEFAULT_CHARACTER + formatted_horizontal_width + formatted_vertical_width
+    end
+  end
+end

data/lib/elements/lines_and_boxes.rb

@@ -0,0 +1,37 @@
+module Rdpl
+  module LinesAndBoxes
+    attr_writer :vertical_width, :horizontal_width
+
+    include Element
+    include Graphic
+
+    def vertical_width
+      @vertical_width || 0
+    end
+
+    def horizontal_width
+      @horizontal_width || 0
+    end
+
+    def width_multiplier=(multiplier)
+      raise FixedValueError, 'for lines width multiplier is fixed to 1'
+    end
+
+    def height_multiplier=(multiplier)
+      raise FixedValueError, 'for lines height multiplier is fixed to 1'
+    end
+
+    def font_id
+      'X'
+    end
+
+    private
+    def formatted_horizontal_width
+      '%04d' % normalize_number(horizontal_width)
+    end
+
+    def formatted_vertical_width
+      '%04d' % normalize_number(vertical_width)
+    end
+  end
+end

data/lib/job.rb

@@ -0,0 +1,66 @@
+require 'tempfile'
+
+module Rdpl
+  class Job
+    attr_reader :labels, :printer, :state
+    attr_writer :sensor
+
+    include Commandable
+    include Enumerable
+
+    def initialize(options = {})
+      initialize_options options
+      @contents = ''
+      start
+      @labels = []
+    end
+
+    def each
+      @labels.each { |label| yield label }
+    end
+
+    def sensor; @sensor ||= Sensor::EDGE; end
+
+    def measurement; @measurement ||= :inches; end
+
+    def in?; measurement == :inches; end
+
+    def mm?; measurement == :metric; end
+
+    def <<(label)
+      @labels << label
+      label.job = self
+      @contents << label.dump
+      feed
+    end
+    alias :add_label :<<
+
+    def dump; @contents.dup; end
+
+    def feed; command FEED; end
+
+    def print
+      tempfile = Tempfile.new 'datamax_label'
+      tempfile << dump
+      tempfile.close
+      Kernel.system "lpr -P #{printer} #{tempfile.path}"
+    end
+
+    private
+    def printer=(printer); @printer = printer; end
+    def measurement=(measurement); @measurement = measurement; end
+
+    def initialize_options(options)
+      validate_measurement_option options[:measurement]
+      options.each_pair { |option, value| self.send("#{option}=", value) }  
+      raise MissingPrinterNameError if printer.nil?
+      @state = :open
+    end
+
+    def start; command sensor; end
+
+    def validate_measurement_option(option)
+      raise ArgumentError, 'should be :metric or :inches' unless [nil, :metric, :inches].include?(option)
+    end
+  end
+end