zebra-zpl 1.0.2 → 1.1.3

data/lib/zebra/zpl/barcode_type.rb

@@ -11,6 +11,9 @@ module Zebra
       CODE_AZTEC_PARAMS   = "O"
       CODE_UPS_MAXICODE   = "D"
       CODE_QR             = "Q"
+      CODE_UPCA           = "U"
+      CODE_UPCE           = "9"
+      CODE_EAN13          = "E"
 
       # Legacy (EPL) bar code suffixes
       # CODE_39             = "3"
@@ -23,7 +26,7 @@ module Zebra
       # CODABAR             = "K"
 
       def self.valid_barcode_type?(type)
-        %w(3 A C K 0 O D Q).include? type
+        %w(3 A C K 0 O D Q U 9 E).include? type
       end
 
       def self.validate_barcode_type(type)

data/lib/zebra/zpl/box.rb

@@ -5,9 +5,11 @@ module Zebra
     class Box
       include Printable
 
-      class InvalidLineThickness < StandardError; end
+      class InvalidLineThickness  < StandardError; end
+      class InvalidRoundingDegree < StandardError; end
+      class InvalidColorError     < StandardError; end
 
-      attr_reader :line_thickness, :box_width, :box_height, :width
+      attr_reader :line_thickness, :box_width, :box_height, :width, :color, :rounding_degree
 
       def line_thickness=(thickness)
         raise InvalidLineThickness unless thickness.nil? || thickness.to_i.to_s == thickness.to_s
@@ -27,10 +29,20 @@ module Zebra
         @box_height = height
       end
 
+      def rounding_degree=(value)
+        raise InvalidLineThickness unless (1..8).include?(value.to_i)
+        @rounding_degree = value
+      end
+
+      def color=(value)
+        raise InvalidColorError unless %w[B W].include?(value&.upcase)
+        @color = value
+      end
+
       def to_zpl
         check_attributes
-        # "^FO#{x},#{y}^GB#{box_width},#{box_height},#{line_thickness}^FS"
-        "^FO#{x},#{y}^GB#{box_width},#{box_height},#{line_thickness}^FS"
+        puts "The Box class is deprecated. Please switch to the Graphic class (graphic_type = box)." unless ENV['RUBY_ENV'] == 'test'
+        "^FO#{x},#{y}^GB#{box_width},#{box_height},#{line_thickness},#{color},#{rounding_degree}^FS"
       end
 
       private

data/lib/zebra/zpl/comment.rb

@@ -0,0 +1,15 @@
+module Zebra
+  module Zpl
+    class Comment
+      attr_accessor :data
+
+      def initialize(options = {})
+        options.each_pair { |attribute, value| self.__send__ "#{attribute}=", value }
+      end
+
+      def to_zpl
+        "^FX#{data}^FS"
+      end
+    end
+  end
+end

data/lib/zebra/zpl/datamatrix.rb

@@ -0,0 +1,76 @@
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class Datamatrix
+      include Printable
+
+      class InvalidOrientationError < StandardError; end
+      class InvalidQualityFactorError < StandardError; end
+      class InvalidSizeError < StandardError; end
+      class InvalidFormatError < StandardError; end
+      class InvalidRatioError < StandardError; end
+
+      attr_reader :symbol_height, :columns, :rows, :format, :aspect_ratio, :width
+      attr_accessor :escape_sequence
+
+      def width=(width)
+        @width = width || 0
+      end
+
+      def orientation=(value)
+        raise InvalidOrientationError unless %w[N R I B].include?(value)
+        @orientation = value
+      end
+
+      def orientation
+        @orientation || 'N'
+      end
+
+      def symbol_height=(height)
+        @symbol_height = height
+      end
+
+      def quality=(level)
+        raise InvalidQualityFactorError unless [0, 50, 80, 100, 140, 200].include?(level.to_i)
+        @quality = level
+      end
+
+      def quality
+        @quality || 200
+      end
+
+      def columns=(n)
+        raise InvalidSizeError unless (9..49).include?(n.to_i)
+        @columns = n
+      end
+
+      def rows=(n)
+        raise InvalidSizeError unless (9..49).include?(n.to_i)
+        @rows = n
+      end
+
+      def format=(value)
+        raise InvalidFormatError unless (0..6).include?(value.to_i)
+        @format = value
+      end
+
+      def aspect_ratio=(value)
+        raise InvalidRatioError unless [1, 2].include?(value.to_i)
+        @aspect_ratio = value
+      end
+
+      def to_zpl
+        check_attributes
+        "^FW#{rotation}^FO#{x},#{y}^BY,,10^BX#{orientation},#{symbol_height},#{quality},#{columns},#{rows},#{format},#{escape_sequence},#{aspect_ratio}^FD#{data}^FS"
+      end
+
+      private
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the symbol height to be used is not given") unless @symbol_height
+      end
+    end
+  end
+end

data/lib/zebra/zpl/font.rb

@@ -15,7 +15,7 @@ module Zebra
       SIZE_9 = 133 # 48pt
 
       def self.valid_font_size?(font_size)
-        [12, 17, 22, 28, 33, 44, 67, 100, 111, 133].include?(font_size.to_i)
+        (0..32000).include?(font_size.to_i)
       end
 
       def self.validate_font_size(font_size)

data/lib/zebra/zpl/graphic.rb

@@ -0,0 +1,91 @@
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class Graphic
+      include Printable
+
+      class InvalidGraphicType < StandardError; end
+      class InvalidLineThickness < StandardError; end
+      class InvalidColorError < StandardError; end
+      class InvalidOrientationError < StandardError; end
+      class InvalidRoundingDegree < StandardError; end
+      class InvalidSymbolType < StandardError; end
+
+      attr_reader :graphic_type, :graphic_width, :graphic_height, :line_thickness, :color, :orientation, :rounding_degree, :symbol_type
+
+      BOX      = "B"
+      CIRCLE   = "C"
+      DIAGONAL = "D"
+      ELLIPSE  = "E"
+      SYMBOL   = "S"
+
+      def graphic_type=(type)
+        raise InvalidGraphicType unless %w(E B D C S).include? type
+        @graphic_type = type
+      end
+
+      def graphic_width=(width)
+        @graphic_width = width
+      end
+
+      def graphic_height=(height)
+        @graphic_height = height
+      end
+
+      def line_thickness=(thickness)
+        raise InvalidLineThickness unless thickness.nil? || thickness.to_i.to_s == thickness.to_s
+        @line_thickness = thickness
+      end
+
+      def color=(value)
+        raise InvalidColorError unless %w[B W].include?(value&.upcase)
+        @color = value
+      end
+
+      def orientation=(value)
+        raise InvalidOrientationError unless %w[R L].include?(value&.upcase)
+        @orientation = value
+      end
+
+      def rounding_degree=(value)
+        raise InvalidRoundingDegree unless (0..8).include?(value.to_i)
+        @rounding_degree = value
+      end
+
+      def symbol_type=(value)
+        raise InvalidSymbolType unless %w[A B C D E].include?(value.upcase)
+        @symbol_type = value
+      end
+
+      def to_zpl
+        check_attributes
+        graphic = case graphic_type
+        when "B"
+          "B#{graphic_width},#{graphic_height},#{line_thickness},#{color},#{rounding_degree}"
+        when "C"
+          "C#{graphic_width},#{line_thickness},#{color}"
+        when "D"
+          "D#{graphic_width},#{graphic_height},#{line_thickness},#{color},#{orientation}"
+        when "E"
+          "E#{graphic_width},#{graphic_height},#{line_thickness},#{color}"
+        when "S"
+          sym = !symbol_type.nil? ? "^FD#{symbol_type}" : ''
+          "S,#{graphic_height},#{graphic_width}#{sym}"
+        end
+        "^FW#{rotation}^FO#{x},#{y}^G#{graphic}^FS"
+      end
+
+      private
+
+      def has_data?
+        false
+      end
+
+      def check_attributes
+        super
+        raise InvalidGraphicType if @graphic_type.nil?
+      end
+    end
+  end
+end

data/lib/zebra/zpl/image.rb

@@ -0,0 +1,97 @@
+module Zebra
+  module Zpl
+    class Image
+      include Printable
+
+      class InvalidSizeError < StandardError; end
+      class InvalidRotationError < StandardError; end
+      class InvalidThresholdError < StandardError; end
+
+      attr_reader :path
+      attr_writer :invert, :compress
+
+      def path=(p)
+        @img = Img2Zpl::Image.open(p)
+        @path = @img.path
+      end
+
+      def source
+        @img
+      end
+
+      alias src source
+
+      def width=(value)
+        raise InvalidSizeError.new('Invalid image width') unless value.to_i.positive?
+        @width = value.to_i
+      end
+
+      def width
+        @width || @img.width
+      end
+
+      def height=(value)
+        raise InvalidSizeError.new('Invalid image height') unless value.to_i.positive?
+        @height = value.to_i
+      end
+
+      def height
+        @height || @img.height
+      end
+
+      def rotation=(rot)
+        raise InvalidRotationError unless (true if Float(rot) rescue false)
+        @rotation = rot
+      end
+
+      def rotation
+        @rotation || 0
+      end
+
+      def black_threshold=(value)
+        raise InvalidThresholdError.new('Invalid black threshold') unless value.to_f >= 0 && value.to_f <= 1
+        @black_threshold = value.to_f
+      end
+
+      def black_threshold
+        @black_threshold || 0.5
+      end
+
+      def invert
+        @invert || false
+      end
+
+      def compress
+        @compress || true
+      end
+
+      def to_zpl
+        check_attributes
+        modify
+        graphics = @img.to_zpl(
+          black_threshold: black_threshold,
+          invert: invert,
+          compress: compress
+        )
+        "^FO#{x},#{y}#{graphics}"
+      end
+
+      private
+
+      def has_data?
+        false
+      end
+
+      def modify
+        @img.resize("#{width}x#{height}") if @width || @height
+        @img.rotate(@rotation) if @rotation
+      end
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the path is invalid or not given") unless @path
+      end
+
+    end
+  end
+end

data/lib/zebra/zpl/label.rb

@@ -9,34 +9,24 @@ module Zebra
 
       attr_writer :copies
       attr_reader :elements, :tempfile
-      attr_accessor :width, :length, :gap, :print_speed, :print_density
+      attr_accessor :width, :length, :print_speed
 
       def initialize(options = {})
         options.each_pair { |key, value| self.__send__("#{key}=", value) if self.respond_to?("#{key}=") }
         @elements = []
       end
 
-      def length_and_gap=(length_and_gap)
-        self.length = length_and_gap[0]
-        self.gap    = length_and_gap[1]
-      end
-
       def print_speed=(s)
-        raise InvalidPrintSpeedError unless (0..6).include?(s)
+        raise InvalidPrintSpeedError unless (0..14).include?(s)
         @print_speed = s
       end
 
-      def print_density=(d)
-        raise InvalidPrintDensityError unless (0..6).include?(d)
-        @print_density = d
-      end
-
       def copies
         @copies || 1
       end
 
       def <<(element)
-        element.width = self.width
+        element.width = self.width if element.respond_to?("width=") && element.width.nil?
         elements << element
       end
 
@@ -75,7 +65,6 @@ module Zebra
       end
 
       def persist
-        # debugger
         tempfile = Tempfile.new "zebra_label"
         dump_contents tempfile
         tempfile.close

data/lib/zebra/zpl/pdf417.rb

@@ -0,0 +1,50 @@
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class PDF417
+      include Printable
+
+      class InvalidScaleFactorError < StandardError; end
+      class InvalidSecurityLevelError < StandardError; end
+      class InvalidRowColumnNumberError < StandardError; end
+
+      attr_reader :row_height, :security_level, :column_number, :row_number, :truncate
+
+      def row_height=(value)
+        @row_height = value
+      end
+
+      def row_number=(value)
+        raise InvalidRowColumnNumberError unless (3..90).include?(value.to_i)
+        @row_number = value
+      end
+
+      def column_number=(value)
+        raise InvalidRowColumnNumberError unless (1..30).include?(value.to_i)
+        @column_number = value
+      end
+
+      def truncate=(value)
+        @truncate = value
+      end
+
+      def security_level=(value)
+        raise InvalidSecurityLevelError unless (0..8).include?(value.to_i)
+        @security_level = value
+      end
+
+      def to_zpl
+        check_attributes
+        "^FO#{x},#{y}^BY,,10^B7#{rotation},#{row_height},#{security_level},#{column_number},#{row_number},#{truncate} ^FD #{data} ^FS"
+      end
+
+      private
+
+      def check_attributes
+        super
+        raise InvalidRowColumnNumberError if !@row_number.nil? && !@column_number.nil? && @row_number.to_i * @column_number.to_i > 928
+      end
+    end
+  end
+end

data/lib/zebra/zpl/qrcode.rb

@@ -8,7 +8,11 @@ module Zebra
       class InvalidScaleFactorError < StandardError; end
       class InvalidCorrectionLevelError < StandardError; end
 
-      attr_reader :scale_factor, :correction_level
+      attr_reader :scale_factor, :correction_level, :width
+
+      def width=(width)
+        @width = width || 0
+      end
 
       def scale_factor=(value)
         raise InvalidScaleFactorError unless (1..99).include?(value.to_i)
@@ -22,7 +26,7 @@ module Zebra
 
       def to_zpl
         check_attributes
-        ["b#{x}", y, "Q", "s#{scale_factor}", "e#{correction_level}", "\"#{data}\""].join(",")
+        "^FW#{rotation}^FO#{x},#{y}^BY,,10^BQN,2,#{scale_factor},,3^FD#{correction_level}A,#{data}^FS"
       end
 
       private