barcode1dtools 0.9.4.1 → 0.9.5.0

data/lib/barcode1dtools.rb

@@ -16,8 +16,8 @@ module Barcode1DTools
   # 1-dimensional barcode patterns for various code types.  The
   # library currently includes EAN-13, EAN-8, UPC-A, UPC-E, UPC
   # Supplemental 2, UPC Supplemental 5, Interleaved 2 of 5 (I 2/5),
-  # Code 3 of 9, and Code 93, but will be expanded to include most 1D
-  # symbologies in the near future.
+  # Code 3 of 9, Code 93, and Codabar, but will be expanded to
+  # include most 1D symbologies in the near future.
   #
   #== Example
   #  ean13 = Barcode1DTools::EAN13.new('0012676510226', :line_character => 'x', :space_character => ' ')
@@ -119,3 +119,4 @@ require 'barcode1dtools/upc_supplemental_2'
 require 'barcode1dtools/upc_supplemental_5'
 require 'barcode1dtools/code3of9'
 require 'barcode1dtools/code93'
+require 'barcode1dtools/codabar'

data/lib/barcode1dtools/codabar.rb

@@ -0,0 +1,249 @@
+#--
+# Copyright 2012 Michael Chaney Consulting Corporation
+#
+# Released under the terms of the MIT License or the GNU
+# General Public License, v. 2
+#++
+
+module Barcode1DTools
+
+  # Barcode1DTools::Codabar - Create and decode bar patterns for
+  # Codabar.  The value encoded is a string which may contain the
+  # digits 0-9 and the symbols dash "-", dollar sign "$", plus
+  # sign "+", colon ":", forward slash "/", and dot ".".  There are
+  # four start/stop characters which are A, B, C, and D or T, N,
+  # asterisk "*", and E.  Note that A and T are equivalent, as are
+  # B and N, C and asterisk, and D and E.  Any may be used as start
+  # and stop characters giving 16 possible combinations.
+  #
+  # Because there is no standard for check digits, we implement
+  # neither generation nor checking of one.  It is up to the caller
+  # to present a check digit if it is part of the payload.
+  #
+  # Additionally, the caller must present the start and stop
+  # characters as part of the value.  When decoding, the start/stop
+  # cahracters will be presented as A, B, C, or D.  
+  #
+  # val = "A29322930C"
+  # bc = Barcode1DTools::Codabar.new(val)
+  # pattern = bc.bars
+  # rle_pattern = bc.rle
+  # width = bc.width
+  #
+  # The object created is immutable.
+  #
+  # Barcode1DTools::Codabar creates the patterns that you need to
+  # display Codabar barcodes.  It can also decode a simple w/n
+  # string.
+  #
+  # Codabar characters consist of 4 bars and 3 spaces, with a narrow
+  # space between them.  The main characters (0-9, dash, and dollar
+  # sign) each have one wide bar and one wide space (hence the
+  # alternate name "code 2 of 7").  The start/stop codes have one
+  # wide bar and two adjacent wide spaces.  The extended characters
+  # (dot, forward slash, colon, and plus sign) each have three wide
+  # bars and all narrow spaces.
+  #
+  # There are three formats for the returned pattern:
+  #
+  #   bars - 1s and 0s specifying black lines and white spaces.  Actual
+  #          characters can be changed from "1" and 0" with options
+  #          :line_character and :space_character.
+  #
+  #   rle -  Run-length-encoded version of the pattern.  The first
+  #          number is always a black line, with subsequent digits
+  #          alternating between spaces and lines.  The digits specify
+  #          the width of each line or space.
+  #
+  #   wn -   The native format for this barcode type.  The string
+  #          consists of a series of "w" and "n" characters.  The first
+  #          item is always a black line, with subsequent characters
+  #          alternating between spaces and lines.  A "wide" item
+  #          is twice the width of a "narrow" item.
+  #
+  # The "width" method will tell you the total end-to-end width, in
+  # units, of the entire barcode.  Note that the w/n format is
+  # unavailable for this symbology.
+  #
+  #== Rendering
+  #
+  # The original Codabar specification actually included a varied
+  # w/n ratio depending on whether there were two or three wide
+  # elements in a character.  Those with two wide elements used a 3:1
+  # ratio while those with three wide elements used a 2:1 ratio.  In
+  # that way, the characters were consistently 10 units wide.
+  #
+  # Our default ratio is 3:1 for the entire code, but if you include
+  # :varied_wn_ratio => true in the options the rle and bars strings
+  # will have variable ratio that shifts between 2:1 and 3:1 and the
+  # "wn_ratio" option will be ignored.
+
+  class Codabar < Barcode1D
+
+    # Character sequence - 0-based offset in this string is character
+    # number
+    CHAR_SEQUENCE = "0123456789-$:/.+ABCD"
+
+    # Patterns for making bar codes
+    PATTERNS = {
+      '0'=> {'val'=>0 ,'wn'=>'nnnnnww'},
+      '1'=> {'val'=>1 ,'wn'=>'nnnnwwn'},
+      '2'=> {'val'=>2 ,'wn'=>'nnnwnnw'},
+      '3'=> {'val'=>3 ,'wn'=>'wwnnnnn'},
+      '4'=> {'val'=>4 ,'wn'=>'nnwnnwn'},
+      '5'=> {'val'=>5 ,'wn'=>'wnnnnwn'},
+      '6'=> {'val'=>6 ,'wn'=>'nwnnnnw'},
+      '7'=> {'val'=>7 ,'wn'=>'nwnnwnn'},
+      '8'=> {'val'=>8 ,'wn'=>'nwwnnnn'},
+      '9'=> {'val'=>9 ,'wn'=>'wnnwnnn'},
+      '-'=> {'val'=>10 ,'wn'=>'nnnwwnn'},
+      '$'=> {'val'=>11 ,'wn'=>'nnwwnnn'},
+      ':'=> {'val'=>12 ,'wn'=>'wnnnwnw'},
+      '/'=> {'val'=>13 ,'wn'=>'wnwnnnw'},
+      '.'=> {'val'=>14 ,'wn'=>'wnwnwnn'},
+      '+'=> {'val'=>15 ,'wn'=>'nnwnwnw'},
+
+      'A'=> {'val'=>16 ,'wn'=>'nnwwnwn'},
+      'B'=> {'val'=>17 ,'wn'=>'nwnwnnw'},
+      'C'=> {'val'=>18 ,'wn'=>'nnnwnww'},
+      'D'=> {'val'=>19 ,'wn'=>'nnnwwwn'},
+
+      'T'=> {'val'=>16 ,'wn'=>'nnwwnwn'},
+      'N'=> {'val'=>17 ,'wn'=>'nwnwnnw'},
+      '*'=> {'val'=>18 ,'wn'=>'nnnwnww'},
+      'E'=> {'val'=>19 ,'wn'=>'nnnwwwn'}
+    }
+
+    DEFAULT_OPTIONS = {
+      :line_character => '1',
+      :space_character => '0',
+      :w_character => 'w',
+      :n_character => 'n',
+      :wn_ratio => '3',
+      :varied_wn_ratio => false
+    }
+
+    attr_reader :start_character, :stop_character, :payload
+
+    class << self
+      # Codabar can encode digits, dash, dollar, colon, forward
+      # slash, dot, and plus.  The string must start and stop with
+      # start/stop characters.
+      def can_encode?(value)
+        value.to_s =~ /\A[ABCD][0-9\$:\/\.\+\-]*[ABCD]\z/ || value.to_s =~ /\A[TN\*E][0-9\$:\/\.\+\-]*[TN\*E]\z/
+      end
+
+      # We don't generate a check digit
+      def generate_check_digit_for(value)
+        raise NotImplementedError
+      end
+
+      def validate_check_digit_for(value)
+        raise NotImplementedError
+      end
+
+      # Decode a string in rle format.  This will return a Codabar
+      # object.
+      def decode(str, options = {})
+        if str =~ /[^1-3]/ && str =~ /[^wn]/
+          raise UnencodableCharactersError, "Pattern must be rle or wn"
+        end
+
+        # ensure a wn string
+        if str =~ /[1-3]/
+          str = str.tr('123','nww')
+        end
+
+        start_stop_pattern_match = Regexp.new(['A','B','C','D'].collect { |c| PATTERNS[c]['wn'] }.join('|'))
+
+        if str.reverse =~ /\A#{start_stop_pattern_match}n.*?#{start_stop_pattern_match}\z/
+          str.reverse!
+        end
+
+        unless str =~ /\A(#{start_stop_pattern_match}n.*?#{start_stop_pattern_match})\z/
+          raise UnencodableCharactersError, "Start/stop pattern is not detected."
+        end
+
+        # Adding an "n" to make it easier to scan
+        wn_pattern = $1 + 'n'
+
+        # Each pattern is 4 bars and 3 spaces, with a space between.
+        unless wn_pattern.size % 8 == 0
+          raise UnencodableCharactersError, "Wrong number of bars."
+        end
+
+        decoded_string = ''
+
+        wn_pattern.scan(/(.{7})n/).each do |chunk|
+
+          chunk = chunk.first
+          found = false
+
+          PATTERNS.each do |char,hsh|
+            if !['T', 'E', '*', 'N'].include?(char) && chunk == hsh['wn']
+              decoded_string += char
+              found = true
+              break;
+            end
+          end
+
+          raise UndecodableCharactersError, "Invalid sequence: #{chunk}" unless found
+
+        end
+
+        Codabar.new(decoded_string)
+      end
+
+    end
+
+    # Options are :line_character, :space_character, :w_character,
+    # :n_character, and :varied_wn_ratio.
+    def initialize(value, options = {})
+
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      # Can we encode this value?
+      raise UnencodableCharactersError unless self.class.can_encode?(value)
+
+      @value = value.to_s
+      @check_digit = nil
+
+      @encoded_string = @value
+      md = @value.match(/\A([ABCDTNE\*])(.*?)([ABCDTNE\*])\z/)
+      @start_character, @payload, @stop_character = md[1], md[2], md[3]
+    end
+
+    # Returns a string of "w" or "n" ("wide" and "narrow")
+    def wn
+      @wn ||= wn_str.tr('wn', @options[:w_character].to_s + @options[:n_character].to_s)
+    end
+
+    # returns a run-length-encoded string representation
+    def rle
+      if @options[:varied_wn_ratio]
+        @rle ||= @encoded_string.split('').collect { |c| PATTERNS[c]['wn'] }.collect { |p| p.tr('wn',(p=~/.*w.*w.*w/ ? '21' : '31')) }.join('1')
+      else
+        @rle ||= self.class.wn_to_rle(self.wn, @options)
+      end
+    end
+
+    # returns 1s and 0s (for "black" and "white")
+    def bars
+      @bars ||= self.class.rle_to_bars(self.rle, @options)
+    end
+
+    # returns the total unit width of the bar code
+    def width
+      @width ||= rle.split('').inject(0) { |a,c| a + c.to_i }
+    end
+
+    private
+
+    # Creates the actual w/n pattern.  Note that there is a narrow space
+    # between each character.
+    def wn_str
+      @wn_str ||= @encoded_string.split('').collect { |c| PATTERNS[c]['wn'] }.join('n')
+    end
+
+  end
+end

data/test/test_barcode1dcodabar.rb

@@ -0,0 +1,67 @@
+#--
+# Copyright 2012 Michael Chaney Consulting Corporation
+#
+# Released under the terms of the MIT License or the GNU
+# General Public License, v. 2
+#++
+
+require 'test/unit'
+require 'barcode1dtools'
+
+class Barcode1DToolsCodabarTest < Test::Unit::TestCase
+  def setup
+  end
+
+  def teardown
+  end
+
+  # Creates a random Codabar string
+  def random_codabar_value
+    ['A','B','C','D'][rand(4)] + (1..5+rand(10)).collect { "0123456789-$:/.+"[rand(16),1] }.join + ['A','B','C','D'][rand(4)]
+  end
+
+  def test_no_check_digit
+    assert_raise(Barcode1DTools::NotImplementedError) { Barcode1DTools::Codabar.generate_check_digit_for(random_codabar_value) }
+    assert_raise(Barcode1DTools::NotImplementedError) { Barcode1DTools::Codabar.validate_check_digit_for(random_codabar_value) }
+  end
+
+  def test_attr_readers
+    codabar = Barcode1DTools::Codabar.new('A12345678C')
+    assert_nil codabar.check_digit
+    assert_equal 'A12345678C', codabar.value
+    assert_equal 'A12345678C', codabar.encoded_string
+    assert_equal 'A', codabar.start_character
+    assert_equal 'C', codabar.stop_character
+    assert_equal '12345678', codabar.payload
+  end
+
+  def test_bad_character_errors
+    # Characters that cannot be encoded
+    assert_raise(Barcode1DTools::UnencodableCharactersError) { Barcode1DTools::Codabar.new('thisisnotgood') }
+  end
+
+  # Only need to test wn, as bars and rle are based on wn
+  def test_barcode_generation
+    codabar = Barcode1DTools::Codabar.new('A1B')
+    assert_equal "nnwwnwnnnnnnwwnnnwnwnnw", codabar.wn
+  end
+
+  def test_decode_error
+    assert_raise(Barcode1DTools::UnencodableCharactersError) { Barcode1DTools::Codabar.decode('x') }
+    assert_raise(Barcode1DTools::UnencodableCharactersError) { Barcode1DTools::Codabar.decode('x'*60) }
+    # proper start & stop, but crap in middle
+    assert_raise(Barcode1DTools::UnencodableCharactersError) { Barcode1DTools::Codabar.decode('nnnnwwwwnn') }
+    # wrong start/stop
+    assert_raise(Barcode1DTools::UnencodableCharactersError) { Barcode1DTools::Codabar.decode('nwwnwnwnwnwnwnw') }
+  end
+
+  def test_decoding
+    random_codabar_num=random_codabar_value
+    codabar = Barcode1DTools::Codabar.new(random_codabar_num)
+    codabar2 = Barcode1DTools::Codabar.decode(codabar.wn)
+    assert_equal codabar.value, codabar2.value
+    # Should also work in reverse
+    codabar4 = Barcode1DTools::Codabar.decode(codabar.wn.reverse)
+    assert_equal codabar.value, codabar4.value
+  end
+end

metadata

@@ -1,41 +1,29 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: barcode1dtools
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.9.5.0
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 4
-  - 1
-  version: 0.9.4.1
 platform: ruby
-authors: 
+authors:
 - Michael Chaney
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-05 00:00:00 -05:00
-default_executable: 
+date: 2012-08-05 00:00:00.000000000Z
 dependencies: []
-
-description: "\t Barcode1D is a small library for handling many kinds of\n\
-  \t 1-dimensional barcodes.  Currently implemented are Code 3 of 9, Code\n\
-  \t 93, Interleaved 2 of 5, EAN-13, EAN-8, UPC-A, UPC-E, UPC\n\
-  \t Supplemental 2, and UPC Supplemental 5.  Patterns are created in\n\
-  \t either a simple format of bars and spaces or as a run-length encoded\n\
-  \t string.  This only generates and decodes the patterns; actual\n\
-  \t display or reading from a device must be implemented by the\n\
-  \t programmer.  More symbologies will be added as time permits.\n"
+description: ! "\t Barcode1D is a small library for handling many kinds of\n\t 1-dimensional
+  barcodes.  Currently implemented are Code 3 of 9, Code\n\t 93, Codabar, Interleaved
+  2 of 5, EAN-13, EAN-8, UPC-A, UPC-E, UPC\n\t Supplemental 2, and UPC Supplemental
+  5.  Patterns are created in\n\t either a simple format of bars and spaces or as
+  a run-length encoded\n\t string.  This only generates and decodes the patterns;
+  actual\n\t display or reading from a device must be implemented by the\n\t programmer.
+  \ More symbologies will be added as time permits.\n"
 email: mdchaney@michaelchaney.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- lib/barcode1dtools/codabar.rb
 - lib/barcode1dtools/code3of9.rb
 - lib/barcode1dtools/code93.rb
 - lib/barcode1dtools/ean13.rb
@@ -48,6 +36,7 @@ files:
 - lib/barcode1dtools.rb
 - MIT-LICENSE
 - test/test_barcode1d.rb
+- test/test_barcode1dcodabar.rb
 - test/test_barcode1dcode3of9.rb
 - test/test_barcode1dcode93.rb
 - test/test_barcode1dean13.rb
@@ -57,45 +46,35 @@ files:
 - test/test_barcode1dupce.rb
 - test/test_barcode1dupcsupp2.rb
 - test/test_barcode1dupcsupp5.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/barcode1dtools
-licenses: 
+licenses:
 - MIT
 - GPL-2
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 59
-      segments: 
-      - 1
-      - 8
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Pattern generators for 1D barcodes
-test_files: 
+test_files:
 - test/test_barcode1d.rb
+- test/test_barcode1dcodabar.rb
 - test/test_barcode1dcode3of9.rb
 - test/test_barcode1dcode93.rb
 - test/test_barcode1dean13.rb