usps_intelligent_barcode 0.3.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    M2FiMDFlNjUzNWIyNGQxODM4MzI2MjlmNzZkMGVlN2YzNTcyZmUxZQ==
-  data.tar.gz: !binary |-
-    YTUzZDMyYWQ4NjQ3ZGZlMzEyNDVlZmEzNzdkN2Q2ZDcwNmE0YTk2OA==
+SHA1:
+  metadata.gz: cdeac04e1071c96dc596d2bec3e84ece73cf2291
+  data.tar.gz: 451155bce2c3da38ce4477268f27edcf74c252d8
 SHA512:
-  metadata.gz: !binary |-
-    MDIxZTQyM2ZiMTVjZjgwOTA3MTU4MmExMDk4ZDI5ODcwNzU5NTFhMDMyZjdi
-    NzA5NDJhYWY1YWZlNWEyM2Y1OTUyZDA2NWYwYTQ3MDE4NGQ5ZTYyYTYwMTE5
-    MDZjNDkzNjkyNjVjM2ViMGYzZjVlZTNlZWI1NDVjZTI3NDJmNDU=
-  data.tar.gz: !binary |-
-    Zjk3Mzk1OWFiODczMWI1MDE0Njg0N2Q1MjY3YWI5NjJhNDU2NzBhNTQxNWE1
-    ZDAyMmY0YTM1ZDU2NmE0MGE1NzUzZDZkYzYzODhhNDUzMGU1Yjk3Y2IyMjA0
-    OTI3MmVmYTM1YTA1ZDQ3ZjUwMzJmZGFlNzZlZTlmZDUyOThjNjg=
+  metadata.gz: 330b9a3c194405b63ac36a84cfadff64a3656fe769d0cda0f5edfeaa0478d72611812baae70b1f0e10404f9f421520f0c09f14ae41f0ce172cf1f1e10d538d8d
+  data.tar.gz: 7d067d53ea00a44f1334f1791c877b4a57f0e36282419b74addb8499c9d77f7548698a3fab0c4d83782decf0a068995de31775f6fdd6532db75251e82ec8433c

data/.travis.yml

@@ -1,8 +1,9 @@
 language: ruby
 rvm:
-- rbx-2.5
 - jruby-1.7
 - ruby-1.9.3
 - ruby-2.0
 - ruby-2.1
 - ruby-2.2
+- ruby-2.3
+bundler_args: --without development

data/Gemfile

@@ -3,11 +3,15 @@ source 'http://rubygems.org'
 gem 'andand', '~> 1.3'
 gem 'memoizer', '~> 1.0'
 
-group :development do
-  gem 'jeweler', '~> 2.0'
+group :test do
+  gem 'rake', '~> 11.2'
   gem 'rspec', '~> 3.3'
   gem 'rspec-its', '~> 1.0'
-  gem 'simplecov', '~> 0.10.0'
+end
+
+group :development do
+  gem 'jeweler', '~> 2.0'
+  gem 'rake', '~> 11.2'
+  gem 'simplecov'
   gem 'yard', '~> 0.8.5'
-  gem 'rake', '~> 10.0'
 end

data/Gemfile.lock

@@ -1,74 +1,78 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     andand (1.3.3)
     builder (3.2.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    faraday (0.9.1)
+    faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    git (1.2.9.1)
-    github_api (0.12.3)
+    git (1.3.0)
+    github_api (0.11.3)
       addressable (~> 2.3)
-      descendants_tracker (~> 0.0.4)
+      descendants_tracker (~> 0.0.1)
       faraday (~> 0.8, < 0.10)
-      hashie (>= 3.3)
+      hashie (>= 1.2)
       multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.3)
+      nokogiri (~> 1.6.0)
       oauth2
-    hashie (3.4.2)
-    highline (1.7.2)
-    jeweler (2.0.1)
+    hashie (3.4.6)
+    highline (1.7.8)
+    jeweler (2.1.2)
       builder
       bundler (>= 1.0)
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.11.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
       rake
       rdoc
-    json (1.8.3)
-    jwt (1.5.0)
+      semver
+    json (2.0.2)
+    json (2.0.2-java)
+    jwt (1.5.6)
     memoizer (1.0.1)
-    mini_portile (0.6.2)
-    multi_json (1.11.1)
+    mini_portile2 (2.1.0)
+    multi_json (1.12.1)
     multi_xml (0.5.5)
     multipart-post (2.0.0)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    nokogiri (1.6.6.2-java)
-    oauth2 (1.0.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    nokogiri (1.6.8.1-java)
+    oauth2 (1.2.0)
       faraday (>= 0.8, < 0.10)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    rack (1.6.1)
-    rake (10.4.2)
-    rdoc (4.2.0)
-      json (~> 1.4)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.0)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.0)
+      rack (>= 1.2, < 3)
+    public_suffix (2.0.4)
+    rack (2.0.1)
+    rake (11.3.0)
+    rdoc (5.0.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
+      rspec-support (~> 3.5.0)
     rspec-its (1.2.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.3.0)
+    rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    simplecov (0.10.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    semver (1.0.1)
+    simplecov (0.12.0)
       docile (~> 1.1.0)
-      json (~> 1.8)
+      json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     thread_safe (0.3.5)
@@ -83,11 +87,11 @@ DEPENDENCIES
   andand (~> 1.3)
   jeweler (~> 2.0)
   memoizer (~> 1.0)
-  rake (~> 10.0)
+  rake (~> 11.2)
   rspec (~> 3.3)
   rspec-its (~> 1.0)
-  simplecov (~> 0.10.0)
+  simplecov
   yard (~> 0.8.5)
 
 BUNDLED WITH
-   1.10.3
+   1.13.6

data/README.markdown

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/wconrad/usps_intelligent_barcode.png)](https://travis-ci.org/wconrad/usps_intelligent_barcode)
 [![Code Climate](https://codeclimate.com/github/wconrad/usps_intelligent_barcode.png)](https://codeclimate.com/github/wconrad/usps_intelligent_barcode)
 
-USPS-intelligent-barcode is a pure ruby gem to generate a USPS IMB
+usps_intelligent_barcode is a pure ruby gem to generate a USPS IMB
 (Intelligent Mail Barcode).  More specifically, it generates the
 string of characters you should print using one of the [USPS
 Intelligent Barcode
@@ -25,7 +25,7 @@ most methods and classes, and eliminated the #draw method.
     #!/usr/bin/env ruby
     
     require 'rubygems'
-    require 'USPS-intelligent-barcode'
+    require 'usps_intelligent_barcode'
     
     barcode_id = '01'
     service_type = '234'
@@ -43,7 +43,9 @@ most methods and classes, and eliminated the #draw method.
 # STANDARD
 
 This gem is based upon standard
-[USPS-B-3200G](https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/SPUSPSG.pdf)
+[USPS-B-3200H](https://ribbs.usps.gov/intelligentmail_mailpieces/documents/tech_guides/USPSB3200IntelligentMailBarcode4State.pdf),
+which is linked to from [Intelligent Mail Barcode for
+Mailpieces](https://ribbs.usps.gov/index.cfm?page=intellmailmailpieces)
 
 # RUBY VERSIONS
 
@@ -54,6 +56,7 @@ These Ruby versions are supported (these are the rvm platform names):
 * ruby-2.0
 * ruby-2.1
 * ruby-2.2
+* ruby-2.3
 
 For ruby-1.8.7 please see the deprecated
 [USPS-intelligent-barcode](https://rubygems.org/gems/USPS-intelligent-barcode)

data/Rakefile

@@ -1,40 +1,16 @@
 # encoding: utf-8
 
 require 'rubygems'
-
 require 'bundler'
 begin
-  Bundler.setup(:default, :development)
+  Bundler.setup
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "usps_intelligent_barcode"
-  gem.homepage = "http://github.com/wconrad/usps_intelligent_barcode"
-  gem.license = "MIT"
-  gem.summary = %Q{Generates a USPS Intelligent Mail Barcode.}
-  gem.description =
-    ("A pure Ruby library to generate a USPS Intelligent "\
-     "Mail barcode.  It generates the string of characters "\
-     "to print with one of the USPS Intelligent Mail barcode "\
-     "fonts.")
-  gem.email = "wconrad@yagni.com"
-  gem.authors = ["Wayne Conrad"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
 
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
+glob = File.join(File.dirname(__FILE__), "rake/*.rb")
+Dir[glob].sort.each do |path|
+  require path
 end

data/lib/usps_intelligent_barcode/bar_map.rb

@@ -4,9 +4,7 @@ require 'usps_intelligent_barcode/character_position'
 
 module Imb
 
-  # Maps intelligent barcode "characters" to codes that indicate what
-  # type of bar to print at each given position.
-
+  # Maps intelligent barcode "characters" to the actual barcode.
   class BarMap
 
     def initialize
@@ -15,9 +13,11 @@ module Imb
 
     # Given an array of intelligent barcode "characters", return an
     # the symbols for each position.
-    # @param [[Integer]] characters array of characters
-    # @return [[BarSymbol]] array of symbols
-
+    #
+    # @param characters [Array<Integer>] array of 13-bit "characters"
+    #   between 0 and 1364
+    # @return [Array<BarSymbol>] array of symbols,
+    #   e.g. [BarSymbol::TRACKER, BarSymbol::ASCENDER, ...]
     def symbols(characters)
       @mapping.map do |bar_position|
         bar_position.map(characters)
@@ -34,8 +34,10 @@ module Imb
       mapping_data.map do |descender, ascender|
         descender_character_position = CharacterPosition.new(*descender)
         ascender_character_position = CharacterPosition.new(*ascender)
-        BarPosition.new(descender_character_position,
-                        ascender_character_position)
+        BarPosition.new(
+          descender_character_position,
+          ascender_character_position,
+        )
       end
     end
 

data/lib/usps_intelligent_barcode/bar_position.rb

@@ -2,14 +2,17 @@ module Imb
 
   # @!group Internal
 
-  # Represents a position (one line) in the barcode.  This class is
-  # internal and may change.
-
+  # Represents a position (a vertical bar) in the barcode.  This class
+  # is internal and may change.
+  #
+  # Each bar represents two bits, but which two bits it represents is
+  # determined by the "Bar to Character Mapping" table in the
+  # specification (see Table 22, "Bar to Character Mapping", appendix
+  # E) in the specification linked to in the README.
   class BarPosition
 
-    # @param [CharacterPosition] descender_character_position
-    # @param [CharacterPosition] ascender_character_position
-
+    # @param descender_character_position [CharacterPosition]
+    # @param ascender_character_position [CharacterPosition]
     def initialize(descender_character_position, ascender_character_position)
       @descender_character_position = descender_character_position
       @ascender_character_position = ascender_character_position
@@ -17,12 +20,13 @@ module Imb
 
     # Given an array of characters, return a symbol for this
     # barcode position.
-    # @param [[Integer]] characters character codes
+    # @param characters [Array<Integer>] character codes
     # @return [BarSymbol] symbol code
-
     def map(characters)
-      BarSymbol.make(ascender_bit(characters),
-                     descender_bit(characters))
+      BarSymbol.make(
+        ascender_bit(characters),
+        descender_bit(characters),
+      )
     end
 
     private

data/lib/usps_intelligent_barcode/bar_symbol.rb

@@ -2,14 +2,34 @@ module Imb
 
   # @!group Internal
 
-  # Represents a symbol in the barcode.
-
+  # Represents a symbol in the barcode.  A symbol encodes two bits,
+  # and is represented as one of four characters to be printed using
+  # one of the USPS Intelligent Barcode fonts.  Each character, when
+  # printed using that font, results in a vertical bar having three
+  # part: An ascender, which may be present or missing; a descender,
+  # which may be present or missing; and between the ascender and the
+  # descender, a tracker which is always present.
+  #
+  # This chart shows the bits being encoded (ascender bit, then
+  # descender bit), the code (ASCII character) used for the barcode
+  # font, and an ASCII art repsentation of the bar that is printed by
+  # that code:
+  #
+  #     bits:           00          01           10        11
+  #
+  #     ascender:                                 |         |
+  #     tracker:         |           |            |         |
+  #     descender:                   |                      |
+  #
+  #     code:            T           D            A         F
+  #     mnemonic:     tracker    descender    ascender    full
   class BarSymbol
 
-    # @param [Integer] ascender_bit (0..1)
-    # @param [Integer] descender_bit (0..1)
+    # Return the symbol for a given ascender bit and descender bit.
+    #
+    # @param ascender_bit  [Integer] 0 or 1
+    # @param descender_bit [Integer] 0 or 1
     # @return [BarSymbol]
-
     def self.make(ascender_bit, descender_bit)
       case [ascender_bit, descender_bit]
       when [0, 0]
@@ -29,9 +49,12 @@ module Imb
     # @return [String] the letter for this symbol
     attr_reader :letter
 
-    # @param [Integer] code (0..3)
-    # @param [String] letter
-
+    # Make an instance.
+    #
+    # @param code [Integer] Binary number from 0b00 to 0b11.  Bit 1
+    #   controls the ascender; bit 0 controls the descender.
+    # @param letter [String] The character to print in the barcode
+    #   font.
     def initialize(code, letter)
       @code = code
       @letter = letter
@@ -39,10 +62,17 @@ module Imb
 
     private
 
-    TRACKER = BarSymbol.new(0, 'T')
-    DESCENDER = BarSymbol.new(1, 'D')
-    ASCENDER = BarSymbol.new(2, 'A')
-    FULL = BarSymbol.new(3, 'F')
+    TRACKER = BarSymbol.new(0b00, 'T')
+    private_constant :TRACKER
+    
+    DESCENDER = BarSymbol.new(0b01, 'D')
+    private_constant :DESCENDER
+    
+    ASCENDER = BarSymbol.new(0b10, 'A')
+    private_constant :ASCENDER
+    
+    FULL = BarSymbol.new(0b11, 'F')
+    private_constant :FULL
 
   end
 

data/lib/usps_intelligent_barcode/bar_to_character_mapping.yml

@@ -1,3 +1,27 @@
+# Represents the table from the spec. that controls how the bits of
+# the "characters" are mapped to barcode positions.  Each line of this
+# file represents a single barcode position (or vertical line), with
+# the leftmost position first.
+#
+# Let's decode the first line:
+#
+#     [
+#       [
+#         7,    # descender character index (0..)
+#         2,    # descender bit number (0..)
+#       ],
+#       [
+#         4,    # ascender character index (0..)
+#         3,    #ascender bit number (0..)
+#       ]
+#     ]
+#
+# This means that the first barcode position's ascender is controlled
+# by bit 2 of character 7; the descender is controlled by bit 3 of
+# character 4.
+#
+# See spec. section 10.0 ("Appendix E -- Tables for Converting
+# Characters"), Table 22 ("Bar to Character Mapping")
 ---
 - [[7, 2], [4, 3]]
 - [[1, 10], [0, 0]]