easyzpl 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f853f7876d8290992a2f82381b54137a2b0e075
-  data.tar.gz: 6571c5eadb48bd59efc9d256dcf43b85de7ca9ba
+  metadata.gz: 0b81e4c749aa17a2e9734d74765102aa527fbdab
+  data.tar.gz: fc024aafd5ac34ee63a5138c02f65d7b8cd0306a
 SHA512:
-  metadata.gz: 3422308cb9db0d797425cc9c0da98acba974e64dd277494690a4f0f544fe342ba20088666b67c731699dd35df0832feab3b11c502ac1080609da027bea0adeb8
-  data.tar.gz: f580da3ef59fbc0d83ae92449a26e59d39bb9b2679f29f4b1e496d4bfb4f61e707119adcc7cfbca08daf251ff2a27cdeb9ff60c9df142703cb018fba75f66956
+  metadata.gz: 74d5fb8f62b747631a7919c0da2ec3bcc57b4d221fa017bfa525c25c1a051250a1919b4297dbc8e073257953284461fe7828440ee45875e969f4b582e3341833
+  data.tar.gz: 7125f9c186fdb766595fa446dbd37856bc64c73cace11059e0a243d4a644e804f1e6426c691616c38451c0d2a43a9bd4528c32186fec319c9302b5b1e4134fa2

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - jruby-19mode # JRuby in 1.9 mode

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 TODO: Write your name
+Copyright (c) 2014 Matthew Grigajtis
 
 MIT License
 

data/README.md

@@ -1,4 +1,5 @@
 # Easyzpl
+[![Build Status](https://travis-ci.org/mgrigajtis/easyzpl.svg?branch=master)](https://travis-ci.org/mgrigajtis/easyzpl)
 
 Makes it easy to write ZPL & ZPL2.
 
@@ -18,7 +19,24 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require 'rubygems'
+    require 'easyzpl'
+
+    # Create a simple label
+    label = Easyzpl::Label.new
+    label.home_position(30, 30)
+    label.draw_border(0, 0, 400, 300)
+    label.text_field('ZEBRA', 10, 10)
+    label.bar_code_39('ZEBRA', 10, 30)
+    puts label.to_s
+    
+    # Create a stored template
+    label = Easyzpl::LabelTemplate.new('Template1')
+    label.home_position(30, 30)
+    label.draw_border(0, 0, 400, 300)
+    label.variable_text_field(10, 10)
+    label.variable_bar_code_39(10, 30)
+    puts label.to_s
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,8 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task default: :spec
+task test: :spec

data/easyzpl.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/easyzpl/label.rb

@@ -0,0 +1,75 @@
+# This module is a wrapper for writing confusing ZPL and ZPL2 code
+module Easyzpl
+  # This is the label object
+  class Label
+    attr_accessor :label_data
+    attr_accessor :quantity
+
+    # Called when the new method is invoked
+    def initialize
+      # Create the array that will hold the data
+      self.label_data = []
+
+      # Set the default quantity to one
+      self.quantity = 1
+
+      # The start of the label
+      label_data.push('^XA')
+    end
+
+    # Set the number of labels to print
+    def change_quantity(q)
+      q = 1 unless numeric?(q)
+      self.quantity = q
+    end
+
+    # Set the home position of the label
+    # All other X and Y coordinates are
+    # relative to this
+    def home_position(x, y)
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+      label_data.push('^LH' + x.to_s + ',' + y.to_s)
+    end
+
+    # Draws a square border on dot in width
+    def draw_border(x, y, length, width)
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+      return unless numeric?(length) && numeric?(width)
+      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^GB' + length.to_s +
+                      ',' + width.to_s + ',1^FS')
+    end
+
+    # Prints text
+    def text_field(text, x, y, params = {})
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+      options = { height: 10.to_s, width: 10.to_s }.merge(params)
+      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^AFN,' +
+                      options[:height] + ',' + options[:width] +
+                      '^FD' + text + '^FS')
+    end
+
+    # Prints a bar code in barcode39 font
+    def bar_code_39(bar_code_string, x, y)
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^B3N,Y,20,N,N^FD' +
+                      bar_code_string + '^FS')
+    end
+
+    # Renders the ZPL code as a string
+    def to_s
+      return '' unless label_data.length > 0
+      label_data.map! { |l| "#{l}" }.join('') + '^PQ' + quantity.to_s + '^XZ'
+    end
+
+    protected
+
+    # Returns true if a variable is number, false if not
+    def numeric?(variable)
+      true if Integer(variable) rescue false
+    end
+  end
+end

data/lib/easyzpl/label_template.rb

@@ -0,0 +1,52 @@
+require_relative 'label'
+
+# This module is a wrapper for writing confusing ZPL and ZPL2 code
+module Easyzpl
+  # This is the label template object
+  # This gets uploaded and saved on the printer
+  class LabelTemplate < Easyzpl::Label
+    attr_accessor :variable_fields_count
+
+    # Called when the new method is invoked
+    def initialize(name)
+      return if name.nil?
+      return if name.strip.empty?
+
+      # Set the number of variable fields
+      self.variable_fields_count = 0
+
+      # Create the array that will hold the data
+      self.label_data = []
+
+      # Set the default quantity to one
+      self.quantity = 1
+
+      # The start of the label
+      label_data.push('^XA^DF' + name + '^FS')
+    end
+
+    # Sets a variable field that can be recalled
+    def variable_text_field(x, y)
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+
+      # update the variable field count
+      self.variable_fields_count += 1
+
+      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^FN' +
+                      variable_fields_count.to_s + '^FS')
+    end
+
+    # Sets a variable bar code that can be recalled
+    def variable_bar_code_39(x, y)
+      x = 0 unless numeric?(x)
+      y = 0 unless numeric?(y)
+
+      # update the variable field count
+      self.variable_fields_count += 1
+
+      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^B3N,Y,20,N,N^FN' +
+                      variable_fields_count.to_s + '^FS')
+    end
+  end
+end

data/lib/easyzpl/stored_label.rb

@@ -0,0 +1,39 @@
+require_relative 'label'
+
+# This module is a wrapper for writing confusing ZPL and ZPL2 code
+module Easyzpl
+  # This is the stored label object
+  class StoredLabel < Easyzpl::Label
+    attr_accessor :variable_fields_count
+
+    # Called when the new method is invoked
+    def initialize(name)
+      return if name.nil?
+      return if name.strip.empty?
+
+      # Set the number of variable fields
+      self.variable_fields_count = 0
+
+      # Create the array that will hold the data
+      self.label_data = []
+
+      # Set the default quantity to one
+      self.quantity = 1
+
+      # The start of the label
+      label_data.push('^XA^XF' + name + '^FS')
+    end
+
+    # Adds a variable that is to be applied to the saved template
+    def add_field(value)
+      return if value.nil?
+      return if value.strip.empty?
+
+      # Increment the variable field count
+      self.variable_fields_count += 1
+
+      # Add the field
+      label_data.push('^FN' + variable_fields_count.to_s + '^FD' + value + '^FS')
+    end
+  end
+end

data/lib/easyzpl/version.rb

@@ -1,3 +1,4 @@
+# Section holds the version number of the Gem
 module Easyzpl
-  VERSION = "0.0.1"
+  VERSION = '0.1.0'
 end

data/lib/easyzpl.rb

@@ -1,68 +1,3 @@
 require 'easyzpl/version'
-
-# This module is a wrapper for writing confusing ZPL and ZPL2 code
-module Easyzpl
-  # This is the label object
-  class Label
-    attr_accessor :label_data
-    attr_accessor :quantity
-
-    def initialize
-      # Create the array that will hold the data
-      self.label_data = []
-
-      # Set the default quantity to one
-      self.quantity = 1
-
-      # The start of the label
-      label_data.push('^XA')
-    end
-
-    # Set the number of labels to print
-    def change_quantity(q)
-      q = 1 unless numeric?(q)
-      self.quantity = q
-    end
-
-    def home_position(x, y)
-      x = 0 unless numeric?(x)
-      y = 0 unless numeric?(y)
-      label_data.push('^LH' + x.to_s + ',' + y.to_s)
-    end
-
-    def draw_border(x, y, length, width)
-      x = 0 unless numeric?(x)
-      y = 0 unless numeric?(y)
-      return unless numeric?(length) && numeric?(width)
-      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^GB' + length.to_s +
-                      ',' + width.to_s + ',1^FS')
-    end
-
-    def text_field(text, x, y, params = {})
-      x = 0 unless numeric?(x)
-      y = 0 unless numeric?(y)
-      options = { height: 10.to_s, width: 10.to_s }.merge(params)
-      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^AFN,' +
-                      options[:height] + ',' + options[:width] +
-                      '^FD' + text + '^FS')
-    end
-
-    def bar_code_39(bar_code_string, x, y)
-      x = 0 unless numeric?(x)
-      y = 0 unless numeric?(y)
-      label_data.push('^FO' + x.to_s + ',' + y.to_s + '^B3N,Y,20,N,N^FD' +
-                      bar_code_string + '^FS')
-    end
-
-    def to_s
-      return '' unless label_data.length > 0
-      label_data.map! { |l| "#{l}" }.join('') + '^PQ' + quantity.to_s + '^XZ'
-    end
-
-    private
-
-    def numeric?(variable)
-      true if Integer(variable) rescue false
-    end
-  end
-end
+require 'easyzpl/stored_label'
+require 'easyzpl/label_template'

data/spec/easyzpl_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'Testing easyzpl Gem' do
+  context 'When creating an empty label' do
+    it 'should output a blank label' do
+      label = Easyzpl::Label.new
+      expect(label.to_s).to eq('^XA^PQ1^XZ')
+    end
+  end
+
+  context 'When creating a simple lable' do
+    it 'should output a label with the text "Zebra" and a barcode representation' do
+      label = Easyzpl::Label.new
+      label.home_position(30, 30)
+      label.draw_border(0, 0, 400, 300)
+      label.text_field('ZEBRA', 10, 10)
+      label.bar_code_39('ZEBRA', 10, 30)
+      expect(label.to_s).to eq('^XA^LH30,30^FO0,0^GB400,300,1^FS^FO10,10^AFN,10,10^FDZEBRA^FS^FO10,30^B3N,Y,20,N,N^FDZEBRA^FS^PQ1^XZ')
+    end
+  end
+
+  context 'When creating a stored template' do
+    it 'should output a label templage with one variable text field and one variable barcode' do
+      label = Easyzpl::LabelTemplate.new('Template1')
+      label.home_position(30, 30)
+      label.draw_border(0, 0, 400, 300)
+      label.variable_text_field(10, 10)
+      label.variable_bar_code_39(10, 30)
+      expect(label.to_s).to eq('^XA^DFTemplate1^FS^LH30,30^FO0,0^GB400,300,1^FS^FO10,10^FN1^FS^FO10,30^B3N,Y,20,N,N^FN2^FS^PQ1^XZ')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'easyzpl'
+
+RSpec.configure do
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easyzpl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matthew Grigajtis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-10 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This Gem is a wrapper for the ZPL and ZPL 2 languages that are used to
   build labels for Zebra printers.
 email:
@@ -46,6 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -53,7 +69,12 @@ files:
 - Rakefile
 - easyzpl.gemspec
 - lib/easyzpl.rb
+- lib/easyzpl/label.rb
+- lib/easyzpl/label_template.rb
+- lib/easyzpl/stored_label.rb
 - lib/easyzpl/version.rb
+- spec/easyzpl_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mgrigajtis/easyzpl
 licenses:
 - GPL
@@ -78,4 +99,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Makes it easy to write ZPL & ZPL2.
-test_files: []
+test_files:
+- spec/easyzpl_spec.rb
+- spec/spec_helper.rb