usps_intelligent_barcode 0.3.1 → 1.1.0

data/lib/usps_intelligent_barcode/mailer_id.rb

@@ -1,7 +1,6 @@
 module Imb
 
   # This class represents a mailer ID.
-
   class MailerId
 
     # The allowable range for a short (6-digit) mailer ID
@@ -19,7 +18,6 @@ module Imb
     # * Integer
     # @return [MailerId]
     # @raise [ArgumentError] If the argument cannot be coerced
-
     def self.coerce(o)
       case o
       when MailerId
@@ -33,39 +31,44 @@ module Imb
       end
     end
 
-    # @param [Integer] value
-
+    # Construct an instance.
+    #
+    # @param value [Integer]
     def initialize(value)
       @value = value
     end
 
     # Return true if this object is equal to o
-    # @param [Object] o Any object acceptable to {.coerce}
-
+    #
+    # @param o [Object] Any object acceptable to {.coerce}
     def ==(o)
       MailerId.coerce(o).to_i == to_i
     rescue ArgumentError
       false
     end
 
-    # @return [Integer] The value of the mailer ID
-
+    # @return [Integer] The integer value of the mailer ID
     def to_i
       @value
     end
 
+    # @return [String] The string value of the mailer ID
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Return true if this is a long (9 digit) mailer ID
-
     def long?
       LONG_RANGE === @value
     end
 
     # Validate the value.
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @raise ArgumentError if invalid
-
     def validate(long_mailer_id)
       unless in_range?
         raise ArgumentError, "Must be #{RANGES.join(' or ')}"
@@ -74,10 +77,11 @@ module Imb
     
     # Add this object's value to target, shifting it left as many
     # digts as are needed to make room.
-    # @param [Integer] target The target to be shifted and added to
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param target [Integer] The target to be shifted and added to
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @return [Integer] The new value of the target
-
     def shift_and_add_to(target, long_mailer_id)
       target * 10 ** num_digits + to_i
     end

data/lib/usps_intelligent_barcode/numeric_conversions.rb

@@ -3,14 +3,15 @@ module Imb
   # @!group Internal
 
   # Numeric conversions
-
   module NumericConversions
 
-    # Convert a numeric to an array of at least +min_bytes+ bytes.
-    # @param [Numeric] n
-    # @param [Integer] min_bytes
-    # @return [[Integer]] Array of bytes
-
+    # Convert a numeric to an array of at least +min_bytes+ bytes.  If
+    # the resulting array is larger than is needed, then the most
+    # significant bytes are zero padded.
+    #
+    # @param n [Numeric] The number to convert.
+    # @param min_bytes [Integer] The minimum number of bytes to return
+    # @return [Array<Integer>] Array of bytes between 0 and 255
     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/project_dirs.rb

@@ -0,0 +1,19 @@
+module Imb
+
+  # Provides paths to gem directories
+  module ProjectDirs
+
+    # Returns the root directory of the gem
+    # @return [String] absolute path to gem root
+    def self.project_dir
+      File.expand_path('../..', __dir__)
+    end
+
+    # Returns the bundled fonts directory
+    # @return [String] absolute path to fonts/ directory
+    def self.font_dir
+      File.join(project_dir, 'fonts')
+    end
+
+  end
+end

data/lib/usps_intelligent_barcode/routing_code.rb

@@ -1,7 +1,6 @@
 module Imb
 
   # Represents a routing code
-
   class RoutingCode
 
     # Turn the argument into a RoutingCode if possible.  Accepts:
@@ -39,11 +38,11 @@ module Imb
     # @return [Integer] The delivery point (or nil)
     attr_accessor :delivery_point
     
-    # Create a RoutingCode.  Arguments are:
-    # * +zip+ - Integer zip (or nil)
-    # * +plus4+ - Integer plus4 (or nil)
-    # * +delivery_point+ - Integer delivery poitn (or nil)
-
+    # Create a RoutingCode.
+    #
+    # @param zip [Integer, nil] Five-digit zip code.  Mayb be nil.
+    # @param plus4 [Integer, nil] Four-digit "plus 4" code.
+    # @param delivery_point [Integer, nil] Two-digit Delivery point
     def initialize(zip, plus4, delivery_point)
       @zip = arg_to_i(zip)
       @plus4 = arg_to_i(plus4)
@@ -51,8 +50,7 @@ module Imb
     end
 
     # Return true if this object is equal to o
-    # @param [Object] o Any object acceptable to {.coerce}
-
+    # @param o [Object] Any object acceptable to {.coerce}
     def ==(o)
       RoutingCode.coerce(o).to_a == to_a
     rescue ArgumentError
@@ -62,14 +60,16 @@ module Imb
     # @!group Internal
 
     # Convert a string representation of a routing code into
-    # an array that can be passed to the constructor.
-    # +s+ is a string of length:
+    # an array that can be passed to the constructor.  The routing string length may be:
+    #
     # * 0 - no routing code
     # * 5 - zip
     # * 9 - zip + plus4
     # * 11 - zip + plus4 + delivery point
-    # The result is an array of [zip, zip4, delivery point]
-
+    #
+    # @param s [String] Routing code.
+    # @return [Array<String, String, String>] zip, plus4, and
+    #   delivery_point that can be passed to the constructor.
     def self.string_to_array(s)
       s = s.gsub(/[\D]/, '')
       match = /^(?:(\d{5})(?:(\d{4})(\d{2})?)?)?$/.match(s)
@@ -81,42 +81,45 @@ module Imb
     end
 
     # Validate the value.
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    # (9 digits).
     # @raise ArgumentError if invalid
-
     def validate(long_mailer_id)
     end
 
     # Add this object's value to target, shifting it left as many
     # digts as are needed to make room.
+    #
     # @param [Integer] target The target to be shifted and added to
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @return [Integer] The new value of the target
-
     def shift_and_add_to(target, long_mailer_id)
       target * 10 ** NUM_DIGITS + convert
     end
 
     # @!endgroup
 
-    protected
-
     # Convert to an array of [zip, plus4, delivery point]
-
+    # @return [Array<Integer, Integer, Integer>]
+    # @note Public for testing
     def to_a
       [@zip, @plus4, @delivery_point]
     end
 
-    private
-
-    NUM_DIGITS = 11 #:nodoc:
-
-    def arg_to_i(o)
-      o.andand.to_i
+    # Convert to a string
+    def to_s
+      "%05d%04d%02d" % [
+        @zip,
+        @plus4,
+        @delivery_point,
+      ]
     end
-    
-    # Convert to an integer value
 
+    # Convert to an integer value
+    # @return [Integer]
+    # @note Public for testing
     def convert
       if @zip && @plus4 && @delivery_point
         @zip * 1000000 + @plus4 * 100 + @delivery_point + 1000100001
@@ -129,6 +132,14 @@ module Imb
       end
     end
 
+    private
+
+    NUM_DIGITS = 11 #:nodoc:
+
+    def arg_to_i(o)
+      o.andand.to_i
+    end
+
   end
 
 end

data/lib/usps_intelligent_barcode/serial_number.rb

@@ -9,7 +9,6 @@ module Imb
     # * String
     # * Integer
     # @return [SerialNumber]
-
     def self.coerce(o)
       case o
       when SerialNumber
@@ -23,33 +22,38 @@ module Imb
       end
     end
 
+    # Construct an instance.
+    #
     # @param [Integer] value
-
     def initialize(value)
       @value = value
     end
 
     # Return true if this object is equal to o
-    # @param [Object] o Any object acceptable to {.coerce}
-
+    # @param o [Object] Any object acceptable to {.coerce}
     def ==(o)
       SerialNumber.coerce(o).to_i == to_i
     rescue ArgumentError
       false
     end
 
-    # @return [Integer] The value of the serial number
-
+    # @return [Integer] The integer value of the serial number
     def to_i
       @value
     end
 
+    # @return [String] The string value of the serial number
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Validate the value.
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @raise ArgumentError if invalid
-
     def validate(long_mailer_id)
       range = 0..max_value(long_mailer_id)
       unless range === @value
@@ -59,10 +63,11 @@ module Imb
 
     # Add this object's value to target, shifting it left as many
     # digts as are needed to make room.
-    # @param [Integer] target The target to be shifted and added to
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param target [Integer] The target to be shifted and added to
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @return [Integer] The new value of the target
-
     def shift_and_add_to(target, long_mailer_id)
       target * 10 ** num_digits(long_mailer_id) + to_i
     end

data/lib/usps_intelligent_barcode/service_type.rb

@@ -1,7 +1,6 @@
 module Imb
 
   # This class represents a service type.
-
   class ServiceType
 
     # The valid range of a service type
@@ -11,7 +10,6 @@ module Imb
     # * {ServiceType}
     # * String
     # * Integer
-
     def self.coerce(o)
       case o
       when ServiceType
@@ -25,33 +23,36 @@ module Imb
       end
     end
 
-    # @param [Integer] value
-
+    # @param value [Integer]
     def initialize(value)
       @value = value
     end
 
     # Return true if this object is equal to o
-    # @param [Object] o Any object acceptable to {.coerce}
-
+    # @param o [Object] Any object acceptable to {.coerce}
     def ==(o)
       ServiceType.coerce(o).to_i == to_i
     rescue ArgumentError
       false
     end
 
-    # @return [Integer] The value of the service type
-
+    # @return [Integer] The integer value of the service type
     def to_i
       @value
     end
 
+    # @return [Integer] The string value of the service type
+    def to_s
+      @value.to_s
+    end
+
     # @!group Internal
 
     # Validate the value.
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    #
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @raise ArgumentError if invalid
-
     def validate(long_mailer_id)
       unless (RANGE) === @value
         raise ArgumentError, "Must be #{RANGE}"
@@ -60,10 +61,11 @@ module Imb
 
     # Add this object's value to target, shifting it left as many
     # digts as are needed to make room.
+    #
     # @param [Integer] target The target to be shifted and added to
-    # @param long_mailer_id truthy if the mailer ID is long (9 digits).
+    # @param long_mailer_id [boolean] truthy if the mailer ID is long
+    #   (9 digits).
     # @return [Integer] The new value of the target
-
     def shift_and_add_to(target, long_mailer_id)
       target * 10 ** NUM_DIGITS + to_i
     end

data/lib/usps_intelligent_barcode/usps_fonts.rb

@@ -0,0 +1,48 @@
+module Imb
+
+  # Provides access to bundled USPS Intelligent Mail Barcode fonts
+  class UspsFonts
+
+    # USPS recommended font size in points (16pt for standard fonts per spec)
+    STANDARD_FONT_SIZE = 16
+
+    # Returns path to the standard USPS IMB font (recommended for most use)
+    # USPSIMBStandard is the primary USPS Intelligent Mail Barcode font
+    # @return [String] absolute path to USPSIMBStandard.ttf
+    def self.standard_font_path
+      font_path('USPSIMBStandard.ttf')
+    end
+
+    # Returns path to the compact USPS IMB font
+    # USPSIMBCompact provides a more compact barcode rendering
+    # @return [String] absolute path to USPSIMBCompact.ttf
+    def self.compact_font_path
+      font_path('USPSIMBCompact.ttf')
+    end
+
+    # Returns paths to all bundled USPS fonts
+    # @return [Hash<Symbol, String>] font name symbols to file paths
+    def self.all_font_paths
+      {
+        standard: standard_font_path,
+        compact: compact_font_path
+      }
+    end
+
+    # Returns the USPS-recommended font size
+    # @return [Integer] font size in points (16pt)
+    def self.font_size
+      STANDARD_FONT_SIZE
+    end
+
+    private
+
+    # Returns absolute path to a font file in the bundled fonts directory
+    # @param filename [String] font filename
+    # @return [String] absolute path to font file
+    def self.font_path(filename)
+      File.join(ProjectDirs.font_dir, filename)
+    end
+
+  end
+end

data/lib/usps_intelligent_barcode.rb

@@ -12,6 +12,8 @@ require 'usps_intelligent_barcode/codeword_map'
 require 'usps_intelligent_barcode/crc'
 require 'usps_intelligent_barcode/mailer_id'
 require 'usps_intelligent_barcode/numeric_conversions'
+require 'usps_intelligent_barcode/project_dirs'
 require 'usps_intelligent_barcode/routing_code'
 require 'usps_intelligent_barcode/serial_number'
 require 'usps_intelligent_barcode/service_type'
+require 'usps_intelligent_barcode/usps_fonts'

data/rake/bundler.rb

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/rake/default.rb

@@ -0,0 +1 @@
+task :default => :spec

data/rake/rspec.rb

@@ -0,0 +1,2 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/rake/version.rb

@@ -0,0 +1,33 @@
+namespace :version do
+  VERSION_FILE = 'VERSION'
+  desc "Bump major version (X.0.0)"
+  task :bump_major do
+    bump_version(:major)
+  end
+  desc "Bump minor version (x.X.0)"
+  task :bump_minor do
+    bump_version(:minor)
+  end
+  desc "Bump patch version (x.x.X)"
+  task :bump_patch do
+    bump_version(:patch)
+  end
+  def bump_version(level)
+    current = File.read(VERSION_FILE).strip
+    major, minor, patch = current.split('.').map(&:to_i)
+    case level
+    when :major
+      major += 1
+      minor = 0
+      patch = 0
+    when :minor
+      minor += 1
+      patch = 0
+    when :patch
+      patch += 1
+    end
+    new_version = "#{major}.#{minor}.#{patch}"
+    File.write(VERSION_FILE, new_version + "\n")
+    puts "Bumped version from #{current} to #{new_version}"
+  end
+end

data/rake/yard.rb

@@ -0,0 +1,9 @@
+if Gem::Specification::find_all_by_name("yard").any?
+  
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |t|
+    t.options = ['--output-dir', 'rdoc']
+  end
+
+end

data/usps_intelligent_barcode.gemspec

@@ -1,102 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: usps_intelligent_barcode 0.3.1 ruby lib
-
 Gem::Specification.new do |s|
-  s.name = "usps_intelligent_barcode"
-  s.version = "0.3.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Wayne Conrad"]
-  s.date = "2015-06-13"
-  s.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."
-  s.email = "wconrad@yagni.com"
-  s.extra_rdoc_files = [
-    "LICENSE.md",
-    "README.markdown"
-  ]
-  s.files = [
-    ".travis.yml",
-    "CHANGELOG.markdown",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.md",
-    "README.markdown",
-    "Rakefile",
-    "USPS-intelligent-barcode.gemspec",
-    "VERSION",
-    "examples/example.rb",
-    "lib/usps_intelligent_barcode.rb",
-    "lib/usps_intelligent_barcode/bar_map.rb",
-    "lib/usps_intelligent_barcode/bar_position.rb",
-    "lib/usps_intelligent_barcode/bar_symbol.rb",
-    "lib/usps_intelligent_barcode/bar_to_character_mapping.yml",
-    "lib/usps_intelligent_barcode/barcode.rb",
-    "lib/usps_intelligent_barcode/barcode_id.rb",
-    "lib/usps_intelligent_barcode/character_position.rb",
-    "lib/usps_intelligent_barcode/codeword_map.rb",
-    "lib/usps_intelligent_barcode/codeword_to_character_mapping.yml",
-    "lib/usps_intelligent_barcode/crc.rb",
-    "lib/usps_intelligent_barcode/mailer_id.rb",
-    "lib/usps_intelligent_barcode/numeric_conversions.rb",
-    "lib/usps_intelligent_barcode/routing_code.rb",
-    "lib/usps_intelligent_barcode/serial_number.rb",
-    "lib/usps_intelligent_barcode/service_type.rb",
-    "spec/bar_map_spec.rb",
-    "spec/bar_position_spec.rb",
-    "spec/bar_symbol_spec.rb",
-    "spec/barcode_id_spec.rb",
-    "spec/barcode_spec.rb",
-    "spec/character_position_spec.rb",
-    "spec/codeword_map_spec.rb",
-    "spec/crc_spec.rb",
-    "spec/mailer_id_spec.rb",
-    "spec/numeric_conversions_spec.rb",
-    "spec/routing_code_spec.rb",
-    "spec/serial_number_spec.rb",
-    "spec/service_type_spec.rb",
-    "spec/spec_helper.rb",
-    "usps_intelligent_barcode.gemspec"
-  ]
-  s.homepage = "http://github.com/wconrad/usps_intelligent_barcode"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.4.3"
-  s.summary = "Generates a USPS Intelligent Mail Barcode."
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<andand>, ["~> 1.3"])
-      s.add_runtime_dependency(%q<memoizer>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_development_dependency(%q<rspec>, ["~> 3.3"])
-      s.add_development_dependency(%q<rspec-its>, ["~> 1.0"])
-      s.add_development_dependency(%q<simplecov>, ["~> 0.10.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.8.5"])
-      s.add_development_dependency(%q<rake>, ["~> 10.0"])
-    else
-      s.add_dependency(%q<andand>, ["~> 1.3"])
-      s.add_dependency(%q<memoizer>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.0"])
-      s.add_dependency(%q<rspec>, ["~> 3.3"])
-      s.add_dependency(%q<rspec-its>, ["~> 1.0"])
-      s.add_dependency(%q<simplecov>, ["~> 0.10.0"])
-      s.add_dependency(%q<yard>, ["~> 0.8.5"])
-      s.add_dependency(%q<rake>, ["~> 10.0"])
-    end
-  else
-    s.add_dependency(%q<andand>, ["~> 1.3"])
-    s.add_dependency(%q<memoizer>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.0"])
-    s.add_dependency(%q<rspec>, ["~> 3.3"])
-    s.add_dependency(%q<rspec-its>, ["~> 1.0"])
-    s.add_dependency(%q<simplecov>, ["~> 0.10.0"])
-    s.add_dependency(%q<yard>, ["~> 0.8.5"])
-    s.add_dependency(%q<rake>, ["~> 10.0"])
+  s.name        = 'usps_intelligent_barcode'
+  s.version     = File.read('VERSION').strip
+  s.summary     = 'Generates a USPS Intelligent Mail Barcode.'
+  s.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.'
+  s.authors     = ['Wayne Conrad']
+  s.email       = 'kf7qga@gmail.com'
+  s.homepage    = 'https://github.com/wconrad/usps_intelligent_barcode'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 3.2.0'
+  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
   end
+  s.require_paths = ['lib']
+  s.add_runtime_dependency 'andand', '~> 1.3'
+  s.add_runtime_dependency 'memoizer', '~> 1.0'
+  s.add_development_dependency 'prawn', '~> 2.5'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.12'
+  s.add_development_dependency 'rspec-its', '~> 2.0'
+  s.add_development_dependency 'simplecov', '~> 0.22'
+  s.add_development_dependency 'yard', '~> 0.9'
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/wconrad/usps_intelligent_barcode',
+    'bug_tracker_uri' => 'https://github.com/wconrad/usps_intelligent_barcode/issues'
+  }
 end
-