zebra-zpl 1.1.3 → 1.1.4

data/lib/zebra/zpl/barcode.rb

@@ -1,72 +1,124 @@
-require "zebra/zpl/printable"
-
-module Zebra
-  module Zpl
-    class Barcode
-      include Printable
-
-      class InvalidRatioError < StandardError; end
-      class InvalidNarrowBarWidthError < StandardError; end
-      class InvalidWideBarWidthError   < StandardError; end
-
-      attr_accessor :height
-      attr_reader :type, :ratio, :narrow_bar_width, :wide_bar_width
-      attr_writer :print_human_readable_code
-
-      def width=(value)
-        @width = value || 0
-      end
-
-      def width
-        @width || @narrow_bar_width || @wide_bar_width || 0
-      end
-
-      def type=(type)
-        BarcodeType.validate_barcode_type(type)
-        @type = type
-      end
-
-      def ratio=(value)
-        raise InvalidRatioError unless value.to_f >= 2.0 && value.to_f <= 3.0
-        @ratio = value
-      end
-
-      def ratio
-        if !@wide_bar_width.nil? && !@narrow_bar_width.nil?
-          (@wide_bar_width.to_f / @narrow_bar_width.to_f).round(1)
-        else
-          @ratio
-        end
-      end
-
-      def narrow_bar_width=(value)
-        raise InvalidNarrowBarWidthError unless (1..10).include?(value.to_i)
-        @narrow_bar_width = value
-      end
-
-      def wide_bar_width=(value)
-        raise InvalidWideBarWidthError unless (2..30).include?(value.to_i)
-        @wide_bar_width = value
-      end
-
-      def print_human_readable_code
-        @print_human_readable_code || false
-      end
-
-      def to_zpl
-        check_attributes
-        human_readable = print_human_readable_code ? "Y" : "N"
-        "^FW#{rotation}^FO#{x},#{y}^BY#{width},#{ratio},#{height}^B#{type}#{rotation},,#{human_readable}^FD#{data}^FS"
-      end
-
-      private
-
-      def check_attributes
-        super
-        raise MissingAttributeError.new("the barcode type to be used is not given") unless @type
-        raise MissingAttributeError.new("the height to be used is not given") unless @height
-        raise MissingAttributeError.new("the width to be used is not given") unless @width || @narrow_bar_width || @wide_bar_width
-      end
-    end
-  end
-end
+require "zebra/zpl/printable"
+
+module Zebra
+  module Zpl
+    class Barcode
+      include Printable
+
+      class InvalidRatioError < StandardError; end
+      class InvalidNarrowBarWidthError < StandardError; end
+      class InvalidWideBarWidthError   < StandardError; end
+
+      attr_accessor :height, :mode
+      attr_reader :type, :ratio, :narrow_bar_width, :wide_bar_width
+      attr_writer :print_human_readable_code, :print_text_above
+
+      def width=(value)
+        @width = value || 0
+      end
+
+      def width
+        @width || @narrow_bar_width || @wide_bar_width || 0
+      end
+
+      def type=(type)
+        BarcodeType.validate_barcode_type(type)
+        @type = type
+      end
+
+      def ratio=(value)
+        raise InvalidRatioError unless value.to_f >= 2.0 && value.to_f <= 3.0
+        @ratio = value
+      end
+
+      def ratio
+        if !@wide_bar_width.nil? && !@narrow_bar_width.nil?
+          (@wide_bar_width.to_f / @narrow_bar_width.to_f).round(1)
+        else
+          @ratio
+        end
+      end
+
+      def narrow_bar_width=(value)
+        raise InvalidNarrowBarWidthError unless (1..10).include?(value.to_i)
+        @narrow_bar_width = value
+      end
+
+      def wide_bar_width=(value)
+        raise InvalidWideBarWidthError unless (2..30).include?(value.to_i)
+        @wide_bar_width = value
+      end
+
+      def print_human_readable_code
+        @print_human_readable_code || false
+      end
+
+      def print_text_above
+        @print_text_above || false
+      end
+
+      def to_zpl
+        check_attributes
+
+        barcode = case type
+        when BarcodeType::CODE_39
+          # Code 39 Bar Code: ^B3o,e,h,f,g
+          "^B3#{rotation},,,#{interpretation_line},#{interpretation_line_above}"
+        when BarcodeType::CODE_93
+          # Code 93 Bar Code: ^BAo,h,f,g,e
+          "^BA#{rotation},,#{interpretation_line},#{interpretation_line_above}"
+        when BarcodeType::CODE_128_AUTO
+          # Code 128 Bar Code: ^BCo,h,f,g,e,m
+          "^BC#{rotation},,#{interpretation_line},#{interpretation_line_above},,#{mode}"
+        when BarcodeType::CODABAR
+          # ANSI Codabar Bar Code: ^BKo,e,h,f,g,k,l
+          "^BK#{rotation},,,#{interpretation_line},#{interpretation_line_above}"
+        when BarcodeType::CODE_AZTEC
+          # Aztec Bar Code Parameters: ^B0a,b,c,d,e,f,g
+          "^B0#{rotation},6"
+        when BarcodeType::CODE_AZTEC_PARAMS
+          # Aztec Bar Code Parameters: ^BOa,b,c,d,e,f,g
+          "^BO#{rotation},6"
+        when BarcodeType::CODE_UPS_MAXICODE
+          # UPS MaxiCode Bar Code: ^BDm,n,t
+          "^BD"
+        when BarcodeType::CODE_QR
+          # QR Code Bar Code: ^BQa,b,c,d,e
+          "^BQ#{rotation}"
+        when BarcodeType::CODE_UPCA
+          # UPC-A Bar Code: ^BUo,h,f,g,e
+        when BarcodeType::CODE_UPCE
+          # UPC-E Bar Code: ^B9o,h,f,g,e
+          "^B9#{rotation},,#{interpretation_line},#{interpretation_line_above}"
+        when BarcodeType::CODE_EAN8
+          # EAN-8 Bar Code: ^B8o,h,f,g
+          "^B8#{rotation},,#{interpretation_line},#{interpretation_line_above}"
+        when BarcodeType::CODE_EAN13
+          # EAN-13 Bar Code: ^BEo,h,f,g
+          "^BE#{rotation},,#{interpretation_line},#{interpretation_line_above}"
+        else
+          raise BarcodeType::InvalidBarcodeTypeError
+        end
+
+        "^FW#{rotation}^FO#{x},#{y}^BY#{width},#{ratio},#{height}#{barcode}^FD#{data}^FS"
+      end
+
+      private
+
+      def check_attributes
+        super
+        raise MissingAttributeError.new("the barcode type to be used is not given") unless @type
+        raise MissingAttributeError.new("the height to be used is not given") unless @height
+        raise MissingAttributeError.new("the width to be used is not given") unless @width || @narrow_bar_width || @wide_bar_width
+      end
+
+      def interpretation_line
+        print_human_readable_code ? "Y" : "N"
+      end
+
+      def interpretation_line_above
+        print_text_above ? "Y" : "N"
+      end
+    end
+  end
+end

data/lib/zebra/zpl/barcode_type.rb

@@ -1,37 +1,38 @@
-module Zebra
-  module Zpl
-    module BarcodeType
-      class InvalidBarcodeTypeError < StandardError; end
-
-      CODE_39             = "3"
-      CODE_93             = "A"
-      CODE_128_AUTO       = "C"
-      CODABAR             = "K"
-      CODE_AZTEC          = "0"
-      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"
-      # CODE_39_CHECK_DIGIT = "3C"
-      # CODE_93             = "9"
-      # CODE_128_AUTO       = "1"
-      # CODE_128_A          = "1A"
-      # CODE_128_B          = "1B"
-      # CODE_128_C          = "1C"
-      # CODABAR             = "K"
-
-      def self.valid_barcode_type?(type)
-        %w(3 A C K 0 O D Q U 9 E).include? type
-      end
-
-      def self.validate_barcode_type(type)
-        raise InvalidBarcodeTypeError unless valid_barcode_type?(type)
-      end
-    end
-  end
-end
+module Zebra
+  module Zpl
+    module BarcodeType
+      class InvalidBarcodeTypeError < StandardError; end
+
+      CODE_39             = "3"
+      CODE_93             = "A"
+      CODE_128_AUTO       = "C"
+      CODABAR             = "K"
+      CODE_AZTEC          = "0"
+      CODE_AZTEC_PARAMS   = "O"
+      CODE_UPS_MAXICODE   = "D"
+      CODE_QR             = "Q"
+      CODE_UPCA           = "U"
+      CODE_UPCE           = "9"
+      CODE_EAN8           = "8"
+      CODE_EAN13          = "E"
+
+      # Legacy (EPL) bar code suffixes
+      # CODE_39             = "3"
+      # CODE_39_CHECK_DIGIT = "3C"
+      # CODE_93             = "9"
+      # CODE_128_AUTO       = "1"
+      # CODE_128_A          = "1A"
+      # CODE_128_B          = "1B"
+      # CODE_128_C          = "1C"
+      # CODABAR             = "K"
+
+      def self.valid_barcode_type?(type)
+        %w(3 A C K 0 O D Q U 9 8 E).include? type
+      end
+
+      def self.validate_barcode_type(type)
+        raise InvalidBarcodeTypeError unless valid_barcode_type?(type)
+      end
+    end
+  end
+end

data/lib/zebra/zpl/font.rb

@@ -1,47 +1,48 @@
-module Zebra
-  module Zpl
-    module FontSize
-      class InvalidFontSizeError < StandardError; end
-
-      SIZE_0 = 12 # tiny
-      SIZE_1 = 17 # 6pt
-      SIZE_2 = 22 # 8pt
-      SIZE_3 = 28 # 10pt
-      SIZE_4 = 33 # 12pt
-      SIZE_5 = 44 # 16pt
-      SIZE_6 = 67 # 24pt
-      SIZE_7 = 100 # 32pt
-      SIZE_8 = 111 # 40pt
-      SIZE_9 = 133 # 48pt
-
-      def self.valid_font_size?(font_size)
-        (0..32000).include?(font_size.to_i)
-      end
-
-      def self.validate_font_size(font_size)
-        raise InvalidFontSizeError unless valid_font_size?(font_size)
-      end
-    end
-
-    module FontType
-      class InvalidFontTypeError < StandardError; end
-
-      TYPE_0  = "0" # 6pt
-      TYPE_CD = "CD" # 6pt
-      TYPE_A  = "A" # 6pt
-      TYPE_B  = "B" # 6pt
-      TYPE_E  = "E" # 6pt
-      TYPE_F  = "F" # 6pt
-      TYPE_G  = "G" # 6pt
-      TYPE_H  = "H" # 6pt
-
-      def self.valid_font_type?(font_type)
-        ["0", "CD", "A", "B", "E", "F", "G", "H"].include?(font_type)
-      end
-
-      def self.validate_font_type(font_type)
-        raise InvalidFontTypeError unless valid_font_type?(font_type)
-      end
-    end
-  end
-end
+module Zebra
+  module Zpl
+    module FontSize
+      class InvalidFontSizeError < StandardError; end
+
+      SIZE_0 = 12 # tiny
+      SIZE_1 = 17 # 6pt
+      SIZE_2 = 22 # 8pt
+      SIZE_3 = 28 # 10pt
+      SIZE_4 = 33 # 12pt
+      SIZE_5 = 44 # 16pt
+      SIZE_6 = 67 # 24pt
+      SIZE_7 = 100 # 32pt
+      SIZE_8 = 111 # 40pt
+      SIZE_9 = 133 # 48pt
+
+      def self.valid_font_size?(font_size)
+        (0..32000).include?(font_size.to_i)
+      end
+
+      def self.validate_font_size(font_size)
+        raise InvalidFontSizeError unless valid_font_size?(font_size)
+      end
+    end
+
+    module FontType
+      class InvalidFontTypeError < StandardError; end
+
+      TYPE_0  = "0" # 6pt
+      TYPE_CD = "CD" # 6pt
+      TYPE_A  = "A" # 6pt
+      TYPE_B  = "B" # 6pt
+      TYPE_D  = "D" # 6pt
+      TYPE_E  = "E" # 6pt
+      TYPE_F  = "F" # 6pt
+      TYPE_G  = "G" # 6pt
+      TYPE_H  = "H" # 6pt
+
+      def self.valid_font_type?(font_type)
+        ["0", "CD", "A", "B", "D", "E", "F", "G", "H"].include?(font_type)
+      end
+
+      def self.validate_font_type(font_type)
+        raise InvalidFontTypeError unless valid_font_type?(font_type)
+      end
+    end
+  end
+end

data/lib/zebra/zpl/graphic.rb

@@ -1,91 +1,93 @@
-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
+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 BOX
+          "^GB#{graphic_width},#{graphic_height},#{line_thickness},#{color},#{rounding_degree}"
+        when CIRCLE
+          "^GC#{graphic_width},#{line_thickness},#{color}"
+        when DIAGONAL
+          "^GD#{graphic_width},#{graphic_height},#{line_thickness},#{color},#{orientation}"
+        when ELLIPSE
+          "^GE#{graphic_width},#{graphic_height},#{line_thickness},#{color}"
+        when SYMBOL
+          sym = !symbol_type.nil? ? "^FD#{symbol_type}" : ''
+          "^GS,#{graphic_height},#{graphic_width}#{sym}"
+        else
+          raise InvalidGraphicType
+        end
+        "^FW#{rotation}^FO#{x},#{y}#{graphic}^FS"
+      end
+
+      private
+
+      def has_data?
+        false
+      end
+
+      def check_attributes
+        super
+        raise InvalidGraphicType if @graphic_type.nil?
+      end
+    end
+  end
+end