zebra_zpl 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.DS*
+.yardoc/
+._*
+coverage*
+pkg/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+# Specify your gem's dependencies in zebra_zpl.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    zebra_zpl (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.5)
+    configatron (2.9.0)
+      yamler (>= 0.1.0)
+    cover_me (1.2.0)
+      configatron
+      hashie
+    diff-lcs (1.1.3)
+    hashie (1.2.0)
+    method_source (0.7.1)
+    pry (0.9.8.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
+    pry-nav (0.1.0)
+      pry (~> 0.9.8.1)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    slop (2.4.4)
+    yamler (0.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cover_me
+  pry
+  pry-nav
+  rspec
+  zebra_zpl!

data/README.md

@@ -0,0 +1,29 @@
+Zebra ZPL
+=========
+
+Writing Zebra ZPL files shouldn't vomit raw ASCII in your code.
+
+The goal is to provide a DSL for creating these files without mucking about with control codes.
+
+Example of the desired usage:
+
+```ruby
+label = ZebraZpl::Label.build do
+
+  orientation   :n
+  home          [20, 0]
+  default_width 0, 0
+  print_rate    :a
+  quantity      4
+
+  field [5, 20] do
+    font  :d, height: 60
+    width 1175
+    lines 5
+    data  'Test'
+  end
+
+end
+
+label.to_s # => ^XA^FWN^LH20,0^BY0,0^PRA^PQ4^FO5,20^ADN,60^FB1175,5,,^FDTest^FS^XZ
+```

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+end
+
+namespace :cover_me do
+
+  desc 'Generates and opens code coverage report.'
+  task :report do
+    require 'cover_me'
+    CoverMe.complete!
+  end
+
+end
+
+task :test do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task :spec do
+  Rake::Task['cover_me:report'].invoke
+end
+
+task :default => :spec

data/lib/brainstorming.rb

@@ -0,0 +1,121 @@
+# maybe define re-usable stuffs?
+# font :big_header, size: 12, foo: "D"
+
+# Meh, if you want to make re-usable stuffs but don't want to
+# define custom methods like "font", "lines", whatever ... maybe just
+# define font: "Big Header", size: 12, foo: "D"
+#
+# field font: "Big Header" do
+#   font "Big Header"
+# end
+
+label do
+
+  orientation   :n
+  home          20, 0
+  default_width 0, 0
+  print_rate    :a
+  home          0, 0
+  quantity      label_quantity
+
+  bar_code origin: [130, 75], type: 3 do
+    height 100
+    data   bar_code_a
+  end
+
+  bar_code origin: [920, 2190], :type => :x do
+    orientation :n
+    height      9
+    quality     200
+    data        bar_code_b
+  end
+
+  field origin: [75, 250]   do
+    font   :d, height: 60
+    width  1175
+    lines  5
+    data  field_a
+  end
+
+  field origin: [75, 850]   do
+    font   :d, height: 60
+    data   field_b
+  end
+
+  field origin: [75, 1050]  do
+    font   :d, height: 60
+    data   field_c
+  end
+
+  field origin: [75, 1200]  do
+    font   name: 'D', height: 25
+    width  1100
+    lines  6
+    data   field_d
+  end
+
+  field origin: [995, 1600] do
+    font        :d, height: 36
+    orientation :n
+    data        field_e
+  end
+
+  field origin: [895, 1600] do
+    font        :d, height: 36
+    orientation :n
+    data        field_f
+  end
+
+  field origin: [780, 1620] do
+    font        :d, height: 36
+    orientation :n
+    data        field_g
+  end
+
+  field origin: [660, 1620] do
+    font        :d, height: 36
+    orientation :n
+    data        field_h
+  end
+
+  field origin: [565, 1620] do
+    orientation :r
+    data        field_i
+  end
+
+  field origin: [515, 1620] do
+    orientation :r
+    data        field_j
+  end
+
+  field origin: [465, 1620] do
+    orientation :r
+    data        field_k
+  end
+
+  field origin: [415, 1620] do
+    orientation :r
+    data        field_l
+  end
+
+  field origin: [325, 1620] do
+    orientation :r
+    data        field_m
+  end
+
+  field origin: [275, 1620] do
+    orientation :r
+    data        field_n
+  end
+
+  field origin: [225, 1620] do
+    orientation :r
+    data        field_o
+  end
+
+  field origin: [175, 1620] do
+    orientation :r
+    data        field_p
+  end
+
+end

data/lib/zebra_zpl.rb

@@ -0,0 +1,9 @@
+module ZebraZpl
+end
+
+require 'zebra_zpl/commands'
+
+%w[ field label ].each do |lib|
+  require "zebra_zpl/#{ lib }"
+  require "zebra_zpl/#{ lib }_builder"
+end

data/lib/zebra_zpl/commands.rb

@@ -0,0 +1,12 @@
+module ZebraZpl::Commands
+end
+
+%w[
+  default_width
+  field_origin
+  font
+  home
+  orientation
+  print_rate
+  quantity
+].each { |f| require "zebra_zpl/commands/#{ f }"}

data/lib/zebra_zpl/commands/default_width.rb

@@ -0,0 +1,18 @@
+module ZebraZpl::Commands::DefaultWidth
+
+  COMMAND = '^BY'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def default_width= width, ratio = nil, height = nil
+      params = [width, ratio, height].compact
+      @data << "#{ COMMAND }#{ params.join ',' }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/commands/field_origin.rb

@@ -0,0 +1,17 @@
+module ZebraZpl::Commands::FieldOrigin
+
+  COMMAND = '^FO'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def origin= point
+      @data << "#{ COMMAND }#{ point.join ',' }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/commands/font.rb

@@ -0,0 +1,76 @@
+# <b>^A - Scalable/Bitmapped Font</b>
+#
+# The ^A command specifies the font to use in a textfield. ^A designates the font
+# for the current ^FD statement or field. The font specified by ^A is used only once
+# for that ^FD entry. If a value for ^A is not specified again, the default ^CF font
+# is used for the next ^FD entry.
+#
+# *Format*
+#
+#     ^Afo,h,w
+#
+# Parameter f is required. If f is omitted it defaults to the last value of the ^CF
+# command.
+#
+# <b>f = font name</b>
+#   - Accepted Values: A through Z, and 0 to 9
+#
+# <b>o = field orientation</b>
+#   - Default Value: the last accepted ^FW value or the ^FW default
+#   - Accepted Values:
+#   - *N* normal
+#   - *R* rotated 90 degrees (clockwise)
+#   - *I* inverted 180 degrees
+#   - *B* read from bottom up, 270 degrees
+#
+# <b>h = character height (in dots)</b>
+#   - Default Value: last accepted ^CF
+#   - Scalable
+#     - Accepted Values: 10 to 32000
+#   - Bitmapped
+#      - Accepted Values: multiples of height from 1 to 10 times the standard height, in increments of 1
+#
+# <b>w = width (in dots)</b>
+#   - Default Value: last accepted ^CF
+#   - Scalable
+#     - Accepted Values: 10 to 32000
+#   - Bitmapped
+#     - Accepted Values: multiples of width from 1 to 10 times the standard width, in increments of 1
+#
+# _Notes_
+#
+# Fonts are built using a matrix that defines standard height-to-width ratios. If you
+# specify only the height or width value standard matrix for that font automatically
+# determines the other value. If the value is not given or a 0 (zero) is entered,
+# the height or width is determined by the standard font matrix.
+module ZebraZpl::Commands::Font
+
+  COMMAND = '^A'
+
+  # Builder Usage:
+  #   ZebraZpl::Field.build { font :a }
+  #   ZebraZpl::Field.build { font :b, :orientation => :n }
+  #   ZebraZpl::Field.build { font :c, height: 30 }
+  #   ZebraZpl::Field.build { font :d, height: 15, width: 20 }
+  #   ZebraZpl::Field.build { font :e, :orientation => :r, height: 15, width: 20 }
+  #
+  # Field Usage:
+  #   f = ZebraZpl::Field.new
+  #   f.font = :a 
+  #   f.font = :b, :orientation => :n 
+  #   f.font = :c, height: 30 
+  #   f.font = :d, height: 15, width: 20 
+  #   f.font = :e, :orientation => :r, height: 15, width: 20 
+  def font= *args
+    name, options = args
+    options ||= {}
+
+    params = [options[:height], options[:width]]
+
+    data  = "#{ COMMAND }#{ name }#{ options[:orientation] }".upcase
+    data += ",#{ params.join ',' }" if params.any?
+
+    @data << data
+  end
+
+end

data/lib/zebra_zpl/commands/home.rb

@@ -0,0 +1,17 @@
+module ZebraZpl::Commands::Home
+
+  COMMAND = '^LH'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def home= point
+      @data << "#{ COMMAND }#{ point.join ',' }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/commands/orientation.rb

@@ -0,0 +1,17 @@
+module ZebraZpl::Commands::Orientation
+
+  COMMAND = '^FW'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def orientation= rotation
+      @data << "#{ COMMAND }#{ rotation.to_s.upcase }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/commands/print_rate.rb

@@ -0,0 +1,19 @@
+module ZebraZpl::Commands::PrintRate
+
+  COMMAND = '^PR'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def print_rate= print_speed, slew_speed = nil, backfeed_speed = nil
+      rate = print_speed.to_s.upcase
+      params = [rate, slew_speed, backfeed_speed].compact
+      @data << "#{ COMMAND }#{ params.join ',' }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/commands/quantity.rb

@@ -0,0 +1,18 @@
+module ZebraZpl::Commands::Quantity
+
+  COMMAND = '^PQ'
+
+  def self.included base
+    base.send :include, InstanceMethods
+  end
+
+  module InstanceMethods
+
+    def quantity= quantity, pause = nil, replicates = nil, override = nil
+      params = [quantity, pause, replicates, override].compact
+      @data << "#{ COMMAND }#{ params.join ',' }"
+    end
+
+  end
+
+end

data/lib/zebra_zpl/field.rb

@@ -0,0 +1,24 @@
+class ZebraZpl::Field
+
+  include ZebraZpl::Commands::FieldOrigin
+  include ZebraZpl::Commands::Font
+
+  attr_accessor :data
+
+  def initialize
+    @data = []
+  end
+
+  SUFFIX = '^FS'
+
+  def self.build &block
+    builder = ZebraZpl::FieldBuilder.new
+    builder.instance_eval &block
+    builder.field
+  end
+
+  def to_s
+    "#{ data.join '' }#{ SUFFIX }"
+  end
+
+end

data/lib/zebra_zpl/field_builder.rb

@@ -0,0 +1,19 @@
+class ZebraZpl::FieldBuilder
+
+  attr_accessor :field
+
+  def initialize
+    @field = ZebraZpl::Field.new
+  end
+
+  def method_missing name, *args
+    return super unless field.respond_to? "#{ name }="
+
+    self.class.send :define_method, "#{ name }" do |*args|
+      field.send "#{ name }=", *args
+    end
+
+    send "#{ name }", *args
+  end
+
+end

data/lib/zebra_zpl/label.rb

@@ -0,0 +1,28 @@
+class ZebraZpl::Label
+
+  include ZebraZpl::Commands::DefaultWidth
+  include ZebraZpl::Commands::Home
+  include ZebraZpl::Commands::Orientation
+  include ZebraZpl::Commands::PrintRate
+  include ZebraZpl::Commands::Quantity
+
+  attr_accessor :data
+
+  def initialize
+    @data = []
+  end
+
+  PREFIX = '^XA'
+  SUFFIX = '^XZ'
+
+  def self.build &block
+    builder = ZebraZpl::LabelBuilder.new
+    builder.instance_eval &block
+    builder.label
+  end
+
+  def to_s
+    "#{ PREFIX }#{ data.join '' }#{ SUFFIX }"
+  end
+
+end

data/lib/zebra_zpl/label_builder.rb

@@ -0,0 +1,19 @@
+class ZebraZpl::LabelBuilder
+
+  attr_accessor :label
+
+  def initialize
+    @label = ZebraZpl::Label.new
+  end
+
+  def method_missing name, *args
+    return super unless label.respond_to? "#{ name }="
+
+    self.class.send :define_method, "#{ name }" do |*args|
+      label.send "#{ name }=", *args
+    end
+
+    send "#{ name }", *args
+  end
+
+end

data/lib/zebra_zpl/version.rb

@@ -0,0 +1,3 @@
+module ZebraZpl
+  VERSION = '0.0.1'
+end

data/spec/field_builder_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe ZebraZpl::FieldBuilder do
+
+  it 'returns a field' do
+    ZebraZpl::Field.build {}.should be_a(ZebraZpl::Field)
+  end
+
+  describe '#default_width' do
+
+    it 'adds an Field Origin to the field' do
+      ZebraZpl::Field.build { origin [46, 2] }.to_s.should =~ /\^FO46,2/
+    end
+
+    it 'adds a Scalable/Bitmapped Font to the field' do
+      ZebraZpl::Field.build { font :a }.to_s.should                                            =~ /\^AA/
+      ZebraZpl::Field.build { font :b, :orientation => :n }.to_s.should                        =~ /\^ABN/
+      ZebraZpl::Field.build { font :c, height: 30 }.to_s.should                                =~ /\^AC,30/
+      ZebraZpl::Field.build { font :d, height: 15, width: 20 }.to_s.should                     =~ /\^AD,15,20/
+      ZebraZpl::Field.build { font :e, :orientation => :r, height: 15, width: 20 }.to_s.should =~ /\^AER,15,20/
+    end
+
+  end
+
+end

data/spec/field_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe ZebraZpl::Field do
+
+  describe 'constants' do
+
+    it 'SUFFIX' do
+      ZebraZpl::Field::SUFFIX.should == '^FS'
+    end
+
+  end
+
+  describe 'commands' do
+
+    let(:field) { ZebraZpl::Field.new }
+
+    describe '#origin=' do
+
+      it 'adds an Field Origin to the field' do
+        field.origin = [46, 2]
+        field.data.should include('^FO46,2')
+      end
+
+    end
+
+  end
+
+  its(:to_s) { should =~ /\^FS$/ }
+
+end

data/spec/label_builder_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe ZebraZpl::LabelBuilder do
+
+  it 'returns a label' do
+    ZebraZpl::Label.build {}.should be_a(ZebraZpl::Label)
+  end
+
+  describe '#default_width' do
+
+    it 'adds an Bar Code Field Default to the label' do
+      ZebraZpl::Label.build { default_width 3 }.to_s.should =~ /\^BY3/
+    end
+
+  end
+
+  describe '#home' do
+
+    it 'adds a Label Home command to the label' do
+      ZebraZpl::Label.build { home [5, 10] }.to_s.should =~ /\^LH5,10/
+    end
+
+  end
+
+  describe '#orientation' do
+
+    it 'adds a Field Orientation command to the label' do
+      ZebraZpl::Label.build { orientation :n }.to_s.should =~ /\^FWN/
+    end
+
+  end
+
+  describe '#print_rate' do
+
+    it 'adds an Bar Code Field Default to the label' do
+      ZebraZpl::Label.build { print_rate :a }.to_s.should =~ /\^PRA/
+    end
+
+  end
+
+  describe '#quantity' do
+
+    it 'adds an Bar Code Field Default to the label' do
+      ZebraZpl::Label.build { quantity 4 }.to_s.should =~ /\^PQ4/
+    end
+
+  end
+
+end

data/spec/label_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe ZebraZpl::Label do
+
+  describe 'constants' do
+
+    it 'PREFIX' do
+      ZebraZpl::Label::PREFIX.should == '^XA'
+    end
+
+    it 'SUFFIX' do
+      ZebraZpl::Label::SUFFIX.should == '^XZ'
+    end
+
+  end
+
+  describe 'commands' do
+
+    let(:label) { ZebraZpl::Label.new }
+
+    describe '#default_width=' do
+
+      it 'adds an Bar Code Field Default to the label' do
+        label.default_width = 3
+        label.data.should include('^BY3')
+      end
+
+    end
+
+    describe '#home=' do
+
+      it 'adds a Label Home command to the label' do
+        label.home = [5, 10]
+        label.data.should include('^LH5,10')
+      end
+
+    end
+
+    describe '#orientation=' do
+
+      it 'adds a Field Orientation command to the label' do
+        label.orientation = :n
+        label.data.should include('^FWN')
+      end
+
+    end
+
+    describe '#print_rate=' do
+
+      it 'adds an Bar Code Field Default to the label' do
+        label.print_rate = :a
+        label.data.should include('^PRA')
+      end
+
+    end
+
+    describe '#quantity=' do
+
+      it 'adds an Bar Code Field Default to the label' do
+        label.quantity = 4
+        label.data.should include('^PQ4')
+      end
+
+    end
+
+  end
+
+  its(:to_s) { should =~ /^\^XA/ }
+  its(:to_s) { should =~ /\^XZ$/ }
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+%w[ cover_me zebra_zpl pry pry-nav ].each { |lib| require lib }

data/zebra_zpl.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'zebra_zpl/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'zebra_zpl'
+  s.version     = ZebraZpl::VERSION
+  s.authors     = ['BM5k']
+  s.email       = ['me@bm5k.com']
+  s.homepage    = ''
+  s.summary     = 'Create Zebra labels'
+  s.description = 'Use ruby to describe labels, fields, and barcodes for printing via ZPL II.'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename f }
+  s.require_paths = ['lib']
+
+  %w[ cover_me zebra_zpl rspec pry pry-nav ].each { |lib| s.add_development_dependency lib }
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: zebra_zpl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- BM5k
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cover_me
+  requirement: &70227107456120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227107456120
+- !ruby/object:Gem::Dependency
+  name: zebra_zpl
+  requirement: &70227107455700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227107455700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70227107455300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227107455300
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70227107454880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227107454880
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: &70227107454440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70227107454440
+description: Use ruby to describe labels, fields, and barcodes for printing via ZPL
+  II.
+email:
+- me@bm5k.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/brainstorming.rb
+- lib/zebra_zpl.rb
+- lib/zebra_zpl/commands.rb
+- lib/zebra_zpl/commands/default_width.rb
+- lib/zebra_zpl/commands/field_origin.rb
+- lib/zebra_zpl/commands/font.rb
+- lib/zebra_zpl/commands/home.rb
+- lib/zebra_zpl/commands/orientation.rb
+- lib/zebra_zpl/commands/print_rate.rb
+- lib/zebra_zpl/commands/quantity.rb
+- lib/zebra_zpl/field.rb
+- lib/zebra_zpl/field_builder.rb
+- lib/zebra_zpl/label.rb
+- lib/zebra_zpl/label_builder.rb
+- lib/zebra_zpl/version.rb
+- spec/field_builder_spec.rb
+- spec/field_spec.rb
+- spec/label_builder_spec.rb
+- spec/label_spec.rb
+- spec/spec_helper.rb
+- zebra_zpl.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Create Zebra labels
+test_files:
+- spec/field_builder_spec.rb
+- spec/field_spec.rb
+- spec/label_builder_spec.rb
+- spec/label_spec.rb
+- spec/spec_helper.rb
+has_rdoc: