USPS-intelligent-barcode 0.2.0 → 0.2.1

data/USPS-intelligent-barcode.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "USPS-intelligent-barcode"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Wayne Conrad"]
-  s.date = "2012-12-27"
+  s.date = "2012-12-28"
   s.description = "A pure Ruby gem to generate a USPS Intelligent Mail barcode.  It generates the string of characters to print with one of the USPS Intelligent Mail barcode fonts."
   s.email = "wayne@databill.com"
   s.extra_rdoc_files = [
@@ -38,7 +38,6 @@ Gem::Specification.new do |s|
     "lib/USPS-intelligent-barcode/RoutingCode.rb",
     "lib/USPS-intelligent-barcode/SerialNumber.rb",
     "lib/USPS-intelligent-barcode/ServiceType.rb",
-    "lib/USPS-intelligent-barcode/autoload.rb",
     "lib/USPS-intelligent-barcode/bar_to_character_mapping.yml",
     "lib/USPS-intelligent-barcode/codeword_to_character_mapping.yml",
     "spec/BarMap_spec.rb",

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/USPS-intelligent-barcode.rb

@@ -2,4 +2,15 @@ require 'andand'
 require 'memoizer'
 require 'yaml'
 
-require 'USPS-intelligent-barcode/autoload.rb'
+require 'USPS-intelligent-barcode/BarMap'
+require 'USPS-intelligent-barcode/BarPosition'
+require 'USPS-intelligent-barcode/Barcode'
+require 'USPS-intelligent-barcode/BarcodeId'
+require 'USPS-intelligent-barcode/CharacterPosition'
+require 'USPS-intelligent-barcode/CodewordMap'
+require 'USPS-intelligent-barcode/Crc'
+require 'USPS-intelligent-barcode/MailerId'
+require 'USPS-intelligent-barcode/NumericConversions'
+require 'USPS-intelligent-barcode/RoutingCode'
+require 'USPS-intelligent-barcode/SerialNumber'
+require 'USPS-intelligent-barcode/ServiceType'

data/lib/USPS-intelligent-barcode/BarMap.rb

@@ -1,11 +1,26 @@
+require 'USPS-intelligent-barcode/CharacterPosition'
+
 module Imb
 
+  # Maps intelligent barcode "characters" to codes that indicate what
+  # type of bar to print at each given position.  This class is
+  # internal and may change.
+
   class BarMap
 
+    # Create.
+
     def initialize
       @mapping = load_mapping
     end
 
+    # Given an array of intelligent barcode "characters", return an
+    # array of codes for each barcode position.  The codes are:
+    # * 0 - tracking mark (neither ascending nor descending)
+    # * 1 - descending mark
+    # * 2 - ascending mark
+    # * 3 - full mark (both ascending and descending)
+
     def barcode(characters)
       @mapping.map do |bar_position|
         bar_position.map(characters)

data/lib/USPS-intelligent-barcode/BarPosition.rb

@@ -1,12 +1,26 @@
 module Imb
 
+  # Represents a position (one line) in the barcode.  This class is
+  # internal and may change.
+
   class BarPosition
 
+    # Create.
+    # * +descender_character_position+ - the CharacterPosition for the descender
+    # * +ascender_character_position* - the CharacterPosition for the ascender
+
     def initialize(descender_character_position, ascender_character_position)
       @descender_character_position = descender_character_position
       @ascender_character_position = ascender_character_position
     end
 
+    # Given an array of characters, return a code for this barcode
+    # position.  The codes are:
+    # * 0 - tracking mark (neither ascending nor descending)
+    # * 1 - descending mark
+    # * 2 - ascending mark
+    # * 3 - full mark (both ascending and descending)
+
     def map(characters)
       2 * ascender_bit(characters) + descender_bit(characters)
     end

data/lib/USPS-intelligent-barcode/Barcode.rb

@@ -1,8 +1,11 @@
+require 'USPS-intelligent-barcode/CodewordMap'
+
 # The namespace for everything in this gem.
 
 module Imb
 
-  # This class represents a barcode
+  # This class represents a barcode.  It is the main class: you will
+  # probably seldom need to touch any of the others.
 
   class Barcode
 

data/lib/USPS-intelligent-barcode/CharacterPosition.rb

@@ -1,12 +1,19 @@
 module Imb
 
+  # Represents the position of one bit in the array of intelligent
+  # barcode "characters".  This class is internal and may change.
+
   class CharacterPosition
 
+    # Create.
+
     def initialize(character_index, bit_number)
       @character_index = character_index
       @bit_number = bit_number
     end
 
+    # Given an array of characters, return the bit for this position.
+
     def extract_bit_from_characters(characters)
       characters[@character_index][@bit_number]
     end

data/lib/USPS-intelligent-barcode/CodewordMap.rb

@@ -1,11 +1,18 @@
 module Imb
 
+  # Maps codewords to characters.  This class is internal and may
+  # change.
+
   class CodewordMap
 
+    # Constructor
+
     def initialize
       @characters = load_characters
     end
 
+    # Given an array of codewords, ruturn their characters.
+
     def characters(codewords)
       codewords.map do |codeword|
         @characters[codeword]

data/lib/USPS-intelligent-barcode/Crc.rb

@@ -1,9 +1,16 @@
+require 'USPS-intelligent-barcode/NumericConversions'
+
 module Imb
 
+  # Calculates the Intelligent Mail Barcode CRC.  This class is
+  # internal and may change.
+
   class Crc
 
     extend NumericConversions
-    
+
+    # Calculate a CRC.  +binary_data+ on an Integer.
+
     def self.crc(binary_data)
       crc = MASK
       bytes = numeric_to_bytes(binary_data, NUM_INPUT_BYTES)
@@ -16,6 +23,8 @@ module Imb
 
     private
 
+    # :stopdoc:
+
     LEADING_BITS_TO_IGNORE = 2
     CRC_BITS = 11
     CRC_MSB_MASK = 1 << (CRC_BITS - 1)
@@ -24,6 +33,8 @@ module Imb
     MASK = (1 << CRC_BITS) - 1
     NUM_INPUT_BYTES = 13
 
+    # :startdoc:
+
     def self.crc_byte(crc, byte, leading_bits_to_ignore)
       num_bits = BITS_PER_BYTE - leading_bits_to_ignore
       data = byte << CRC_BITS - BITS_PER_BYTE + leading_bits_to_ignore

data/lib/USPS-intelligent-barcode/NumericConversions.rb

@@ -1,7 +1,11 @@
 module Imb
 
+  # Numeric conversions This class is internal and may change.
+
   module NumericConversions
 
+    # Convert a numberic to an array of at least +min_bytes+ bytes.
+
     def numeric_to_bytes(n, min_bytes=0)
       n.to_s(16).rjust(2 * min_bytes, '0').scan(/../).map do |s|
         s.to_i(16)

data/lib/USPS-intelligent-barcode/RoutingCode.rb

@@ -1,5 +1,7 @@
 module Imb
 
+  # Represents a routing code
+
   class RoutingCode
 
     # Turn the argument into a RoutingCode if possible.  Accepts:

data/lib/USPS-intelligent-barcode/ServiceType.rb

@@ -1,5 +1,7 @@
 module Imb
 
+  # This class represents a service type.
+
   class ServiceType
 
     # The valid range of a service type

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: USPS-intelligent-barcode
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Wayne Conrad
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-12-27 00:00:00 Z
+date: 2012-12-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: andand
@@ -108,7 +108,6 @@ files:
 - lib/USPS-intelligent-barcode/RoutingCode.rb
 - lib/USPS-intelligent-barcode/SerialNumber.rb
 - lib/USPS-intelligent-barcode/ServiceType.rb
-- lib/USPS-intelligent-barcode/autoload.rb
 - lib/USPS-intelligent-barcode/bar_to_character_mapping.yml
 - lib/USPS-intelligent-barcode/codeword_to_character_mapping.yml
 - spec/BarMap_spec.rb

data/lib/USPS-intelligent-barcode/autoload.rb

@@ -1,61 +0,0 @@
-# class Autoload courtesy of www.databill.com
-
-class Autoload
-
-  def self.setup(*args)
-    new(*args).setup
-  end
-
-  def initialize(namespace, path)
-    @namespace = namespace
-    @path = path
-  end
-
-  def setup
-    autoload_classes_and_modules
-    require_utilities
-  end
-
-  private
-
-  def require_utilities
-    utility_paths.each do |path|
-      require File.expand_path(path)
-    end
-  end
-
-  def autoload_classes_and_modules
-    class_and_module_paths.each do |path|
-      module_name = File.basename(path).chomp('.rb')
-      @namespace.instance_eval do
-        autoload(module_name, File.expand_path(path))
-      end
-    end
-  end
-
-  def utility_paths
-    ruby_paths - class_and_module_paths - [@path]
-  end
-
-  def ruby_paths
-    dirname = File.directory?(@path) ? @path : File.dirname(@path)
-    paths = Dir[File.join(dirname, '*.rb')]
-    paths.reject do |path|
-      File.basename(path) == File.basename(@path)
-    end
-    # Force require statements to happen in a random order to discover
-    # missing direct dependencies
-    paths.sort_by {rand}
-  end
-
-  def class_and_module_paths
-    ruby_paths.find_all do |path|
-      File.basename(path) =~ /[A-Z]/
-    end
-  end
-
-end
-
-module Imb ; end
-
-Autoload.setup(Imb, __FILE__)