USPS-intelligent-barcode 0.1.0

data/spec/BarMap_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe BarMap do
+
+    let(:characters) do
+      [
+        0x1FE0, 0x001F, 0x001F, 0x001F, 0x0ADB,
+        0x01A3, 0x1BC3, 0x1838, 0x012B, 0x0076,
+      ]
+    end
+    let(:barcode) do
+      [
+        2, 0, 0, 3, 2, 0, 0, 1, 0, 0, 2, 1, 0,
+        2, 2, 0, 0, 1, 0, 1, 0, 2, 0, 0, 1, 2,
+        3, 1, 1, 3, 2, 1, 3, 1, 3, 0, 3, 3, 3,
+        3, 3, 0, 2, 0, 3, 2, 2, 2, 2, 0, 1, 3,
+        3, 0, 1, 2, 2, 1, 3, 0, 3, 1, 0, 1, 0,
+      ]
+    end
+    let(:bar_map) {BarMap.new}
+
+    specify do
+      bar_map.barcode(characters).should == barcode
+    end
+
+  end
+
+end

data/spec/BarPosition_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe BarPosition do
+
+    describe '#map' do
+
+      let(:characters) {mock 'array of characters'}
+      let(:descender_character_position) {mock CharacterPosition}
+      let(:ascender_character_position) {mock CharacterPosition}
+      let(:bar_position) do
+        BarPosition.new(descender_character_position,
+                        ascender_character_position)
+      end
+
+      before(:each) do
+        descender_character_position.stub(:extract_bit_from_characters)\
+        .with(characters).and_return(descender_bit)
+        ascender_character_position.stub(:extract_bit_from_characters)\
+        .with(characters).and_return(ascender_bit)
+      end
+
+      context 'without ascender, without descender' do
+        let(:ascender_bit) {0}
+        let(:descender_bit) {0}
+        specify {bar_position.map(characters).should == 0}
+      end
+
+      context 'without ascender, with descender' do
+        let(:ascender_bit) {0}
+        let(:descender_bit) {1}
+        specify {bar_position.map(characters).should == 1}
+      end
+
+      context 'with ascender, without descender' do
+        let(:ascender_bit) {1}
+        let(:descender_bit) {0}
+        specify {bar_position.map(characters).should == 2}
+      end
+
+      context 'with ascender, with descender' do
+        let(:ascender_bit) {1}
+        let(:descender_bit) {1}
+        specify {bar_position.map(characters).should == 3}
+      end
+
+    end
+
+  end
+
+end

data/spec/BarcodeId_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe BarcodeId do
+
+    describe '::coerce' do
+
+      subject {BarcodeId.coerce(o)}
+
+      context 'BarcodeId' do
+        let(:o) {BarcodeId.new(12)}
+        its(:to_i) {should == 12}
+      end
+
+      context 'String' do
+        let(:o) {'12'}
+        its(:to_i) {should == 12}
+      end
+
+      context 'Integer' do
+        let(:o) {12}
+        its(:to_i) {should == 12}
+      end
+
+      context 'unknown' do
+        let(:o) {Object.new}
+        specify do
+          expect {
+            BarcodeId.coerce(o)
+          }.to raise_error ArgumentError, 'Cannot coerce to BarcodeId'
+        end
+      end
+
+    end
+
+    describe '#to_i' do
+      let(:value) {23}
+      subject {BarcodeId.new(value)}
+      its(:to_i) {should == value}
+    end
+
+    describe '#=' do
+      def o1 ; BarcodeId.new(1) ; end
+      def o2 ; 1 ; end
+      def o3 ; BarcodeId.new(2) ; end
+      def o4 ; Object.new ; end
+      specify {o1.should == o1}
+      specify {o1.should == o2}
+      specify {o1.should_not == o3}
+      specify {o1.should_not == o4}
+    end
+
+    describe '#most_significant_digit' do
+      specify do
+        BarcodeId.new(12).most_significant_digit.should == 1
+      end
+    end
+
+    describe '#least_significant_digit' do
+      specify do
+        BarcodeId.new(12).least_significant_digit.should == 2
+      end
+    end
+
+    describe '#validate' do
+
+      let(:long_mailer_id?) {mock 'long_mailer_id?'}
+
+      def validate(value)
+        BarcodeId.new(value).validate(long_mailer_id?)
+      end
+
+      def self.is_valid(value)
+        context "#{value}" do
+          specify {validate(value)}
+        end
+      end
+
+      def self.is_out_of_range(value)
+        context "#{value}" do
+          specify do
+            expect {
+              validate(value)
+            }.to raise_error ArgumentError, 'Must be 0..94'
+          end
+        end
+      end
+
+      def self.has_bad_least_significant_digit(value)
+        context "#{value}" do
+          specify do
+            expect {
+              validate(value)
+            }.to raise_error(ArgumentError,
+                             'Least significant digit must be 0..4')
+          end
+        end
+      end
+
+      is_out_of_range -1
+      is_valid 0
+      is_valid 4
+      has_bad_least_significant_digit 5
+      is_valid 94
+      is_out_of_range 95
+
+    end
+
+    describe '#shift_and_add_to' do
+      let(:barcode_id) {BarcodeId.new(12)}
+      let(:long_mailer_id?) {mock 'long mailer id'}
+      specify {barcode_id.shift_and_add_to(1, long_mailer_id?).should == 57}
+    end
+
+  end
+
+end

data/spec/Barcode_spec.rb

@@ -0,0 +1,213 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe Barcode do
+
+    let(:barcode) do
+      Barcode.new(barcode_id,
+                  service_type,
+                  mailer_id,
+                  serial_number,
+                  routing_code)
+    end
+    subject {barcode}
+
+    describe 'Examples from USPS-B-3200 rev. G, Appendix B' do
+
+      describe '#1' do
+
+        let(:barcode_id) {'01'}
+        let(:service_type) {'234'}
+        let(:mailer_id) {'567094'}
+        let(:serial_number) {'987654321'}
+        let(:routing_code) {nil}
+
+        its(:binary_data) {should == 0x00000000001122103B5C2004B1}
+        its(:frame_check_sequence) {should == 0x051}
+        its(:codewords) do
+          should == [0, 0, 0, 0, 559, 202, 508, 451, 124, 17]
+        end
+        its(:codewords_with_orientation_in_character_j) do
+          should == [0, 0, 0, 0, 559, 202, 508, 451, 124, 34]
+        end
+        its(:codewords_with_fcs_bit_in_character_a) do
+          should == [0, 0, 0, 0, 559, 202, 508, 451, 124, 34]
+        end
+        its(:characters) do
+          should == [
+            0x001F, 0x001F, 0x001F, 0x001F, 0x1524, 
+            0x01A3, 0x043C, 0x1838, 0x012B, 0x0076,
+          ]
+        end
+        its(:characters_with_fcs_bits_0_through_9) do
+          should == [
+            0x1FE0, 0x001F, 0x001F, 0x001F, 0x0ADB,
+            0x01A3, 0x1BC3, 0x1838, 0x012B, 0x0076,
+          ]
+        end
+        its(:barcode_letters) do
+          should == ('ATTFATTDTTADTAATTDTDTATTDAFDDFADF'\
+                     'DFTFFFFFTATFAAAATDFFTDAADFTFDTDT')
+        end
+
+      end
+
+      describe '#2' do
+
+        let(:barcode_id) {'01'}
+        let(:service_type) {'234'}
+        let(:mailer_id) {'567094'}
+        let(:serial_number) {'987654321'}
+        let(:routing_code) {'01234'}
+
+        its(:binary_data) {should == 0x0000000D138A87BAB5CF3804B1}
+        its(:frame_check_sequence) {should == 0x065}
+        its(:codewords) do
+          should == [0, 0, 15, 14, 290, 567, 385, 48, 388, 333]
+        end
+        its(:codewords_with_orientation_in_character_j) do
+          should == [0, 0, 15, 14, 290, 567, 385, 48, 388, 666]
+        end
+        its(:codewords_with_fcs_bit_in_character_a) do
+          should == [0, 0, 15, 14, 290, 567, 385, 48, 388, 666]
+        end
+        its(:characters) do
+          should == [
+            0x001F, 0x001F, 0x1D40, 0x0057, 0x0255, 
+            0x0724, 0x04E8, 0x009D, 0x030B, 0x0583,
+          ]
+        end
+        its(:characters_with_fcs_bits_0_through_9) do
+          should == [
+            0x1FE0, 0x001F, 0x02BF, 0x0057, 0x0255,
+            0x18DB, 0x1B17, 0x009D, 0x030B, 0x0583,
+          ]
+        end
+        its(:barcode_letters) do
+          should == ('DTTAFADDTTFTDTFTFDTDDADADAFADFATD'\
+                     'DFTAAAFDTTADFAAATDFDTDFADDDTDFFT')
+        end
+
+      end
+
+      describe '#3' do
+
+        let(:barcode_id) {'01'}
+        let(:service_type) {'234'}
+        let(:mailer_id) {'567094'}
+        let(:serial_number) {'987654321'}
+        let(:routing_code) {'012345678'}
+
+        its(:binary_data) {should == 0x000202BDC097711204D21804B1}
+        its(:frame_check_sequence) {should == 0x606}
+        its(:codewords) do
+          should == [0, 110, 1113, 1363, 198, 413, 470, 468, 1333, 513]
+        end
+        its(:codewords_with_orientation_in_character_j) do
+          should == [0, 110, 1113, 1363, 198, 413, 470, 468, 1333, 1026]
+        end
+        its(:codewords_with_fcs_bit_in_character_a) do
+          should == [659, 110, 1113, 1363, 198, 413, 470, 468, 1333, 1026]
+        end
+        its(:characters) do
+          should == [
+            0x1154, 0x00F8, 0x1E01, 0x0110, 0x019A, 
+            0x1298, 0x03A2, 0x03A1, 0x0084, 0x0B11,
+          ]
+        end
+        its(:characters_with_fcs_bits_0_through_9) do
+          should == [
+            0x1154, 0x1F07, 0x01FE, 0x0110, 0x019A,
+            0x1298, 0x03A2, 0x03A1, 0x0084, 0x14EE,
+          ]
+        end
+        its(:barcode_letters) do
+          should == ('ADFTTAFDTTTTFATTADTAAATFTFTATDAAA'\
+                     'FDDADATATDTDTTDFDTDATADADTDFFTFA')
+        end
+
+      end
+
+      describe '#4' do
+
+        let(:barcode_id) {'01'}
+        let(:service_type) {'234'}
+        let(:mailer_id) {'567094'}
+        let(:serial_number) {'987654321'}
+        let(:routing_code) {'01234567891'}
+
+        its(:binary_data) {should == 0x016907B2A24ABC16A2E5C004B1}
+        its(:frame_check_sequence) {should == 0x751}
+        its(:codewords) do
+          should == [14, 787, 607, 1022, 861, 19, 816, 1294, 35, 301]
+        end
+        its(:codewords_with_orientation_in_character_j) do
+          should == [14, 787, 607, 1022, 861, 19, 816, 1294, 35, 602]
+        end
+        its(:codewords_with_fcs_bit_in_character_a) do
+          should == [673, 787, 607, 1022, 861, 19, 816, 1294, 35, 602]
+        end
+        its(:characters) do
+          should == [
+            0x1234, 0x085C, 0x08E4, 0x0B06, 0x1922, 
+            0x1740, 0x0839, 0x1200, 0x0DC0, 0x04D4,
+          ]
+        end
+        its(:characters_with_fcs_bits_0_through_9) do
+          should == [
+            0x0DCB, 0x085C, 0x08E4, 0x0B06, 0x06DD,
+            0x1740, 0x17C6, 0x1200, 0x123F, 0x1B2B,
+          ]
+        end
+        its(:barcode_letters) do
+          should == ('AADTFFDFTDADTAADAATFDTDDAAADDTDTT'\
+                     'DAFADADDDTFFFDDTTTADFAAADFTDAADA')
+        end
+
+      end
+
+    end
+
+    describe '#accessors' do
+
+      let(:barcode) do
+        Barcode.new(barcode_id,
+                    service_type,
+                    mailer_id,
+                    serial_number,
+                    routing_code)
+      end
+      subject {barcode}
+
+      context 'when constructed with strings' do
+        let(:barcode_id) {'01'}
+        let(:service_type) {'234'}
+        let(:mailer_id) {'567094'}
+        let(:serial_number) {'987654321'}
+        let(:routing_code) {'98765432109'}
+        its(:barcode_id) {should == 1}
+        its(:service_type) {should == 234}
+        its(:mailer_id) {should == 567094}
+        its(:serial_number) {should == 987654321}
+        its(:routing_code) {should == RoutingCode.new(98765, 4321, 9)}
+      end
+
+      context 'when constructed with integers' do
+        let(:barcode_id) {01}
+        let(:service_type) {234}
+        let(:mailer_id) {567094}
+        let(:serial_number) {987654321}
+        let(:routing_code) {[98765, 4321, 9]}
+        its(:barcode_id) {should == 1}
+        its(:service_type) {should == 234}
+        its(:mailer_id) {should == 567094}
+        its(:serial_number) {should == 987654321}
+        its(:routing_code) {should == RoutingCode.new(98765, 4321, 9)}
+      end
+
+    end
+
+  end
+
+end

data/spec/CharacterPosition_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe CharacterPosition do
+
+    describe '#extract_bit_from_characters' do
+
+      let(:characters) {[1, 2]}
+
+      def extract(character_index, bit_number)
+        CharacterPosition.new(character_index, bit_number)\
+        .extract_bit_from_characters(characters)
+      end
+
+      specify {extract(0, 0).should == 1}
+      specify {extract(0, 1).should == 0}
+      specify {extract(1, 0).should == 0}
+      specify {extract(1, 1).should == 1}
+
+    end
+
+  end
+
+end

data/spec/CodewordMap_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+module Imb
+
+  describe CodewordMap do
+
+    let(:characters) do
+      [
+        0x001F, 0x001F, 0x001F, 0x001F, 0x1524, 
+        0x01A3, 0x043C, 0x1838, 0x012B, 0x0076,
+      ]
+    end
+    let(:codewords) {[0, 0, 0, 0, 559, 202, 508, 451, 124, 34]}
+    let(:codeword_map) {CodewordMap.new}
+
+    specify do
+      codeword_map.characters(codewords).should == characters
+    end
+
+  end
+
+end