barcodes 0.0.1 → 0.0.2

data/lib/barcodes/symbology/postnet.rb

@@ -1,12 +1,26 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'barcodes/symbology/base'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the POSTNET symbology
+    # POSTNET can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/POSTNET
     class Postnet < Base
+      
+      # POSTNET character set
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # POSTNET values set
       def self.valueset
         [
           '11000','00011','00101','00110',
@@ -15,6 +29,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Postnet instance
       def initialize(args={})
         unless args.has_key? :data
           args[:data] = '01234'
@@ -23,6 +38,7 @@ module Barcodes
         super(args)
       end
       
+      # Returns data + checksum
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -30,6 +46,7 @@ module Barcodes
         end
       end
       
+      # Returns the barcode data encoded as 1's and 0's.
       def encoded_data
         if self.valid?
           encoded_data = ''
@@ -40,6 +57,7 @@ module Barcodes
         end
       end
       
+      # Calculates the checksum using the provided data
       def checksum
         if self.valid?
           sum = 0
@@ -58,17 +76,22 @@ module Barcodes
         end
       end
       
+      # Returns the overall width of the barcode in mils.
       def width
         if self.valid?
           return (((self.encoded_data.length * 2) - 1) * 20)
         end
         return 0
       end
-    
+      
+      # Returns the overall height of the barcode in mils.
       def height
         125
       end
       
+      # Determines whether or not the barcode data to be encoded
+      # is valid.
+      # Data length must be 5, 9 or 11 digits
       def valid?
         @data.each_byte do |char|
           if self._encode_character(char).nil?

data/lib/barcodes/symbology/standard2of5.rb

@@ -1,12 +1,26 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'barcodes/symbology/base'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the Standard 2 of 5 symbology
+    # Standard 2 of 5 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Two-out-of-five_code
     class Standard2Of5 < Base
+      
+      # Standard 2 of 5 character set
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9','S','E'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # Standard 2 of 5 values set
       def self.valueset
         [
           '10101110111010','11101010101110','10111010101110','11101110101010',
@@ -15,6 +29,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Standard2Of5 instance
       def initialize(args={})
         super(args)
         
@@ -22,6 +37,7 @@ module Barcodes
         @stop_character = 'E'
       end
       
+      # Returns start character + data + stop character
       def formatted_data
         @start_character + @data + @stop_character
       end

data/lib/barcodes/symbology/standard2of5mod10.rb

@@ -1,8 +1,21 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'barcodes/symbology/standard2of5'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the Standard 2 of 5 Mod 10 symbology
+    # Standard 2 of 5 Mod 10 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Two-out-of-five_code
     class Standard2Of5Mod10 < Standard2Of5
+      
+      # Returns start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -10,6 +23,7 @@ module Barcodes
         end
       end
       
+      # Calculates the checksum using the provided data
       def checksum
         even_sum = 0
         odd_sum = 0

data/lib/barcodes/symbology/upca.rb

@@ -1,8 +1,21 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'barcodes/symbology/ean'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the UPC-A symbology
+    # UPC-A can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Universal_Product_Code
     class UpcA < Ean
+      
+      # Creates a new UpcA instance
       def initialize(args={})
         unless args.has_key? :data
           args[:data] = '01234567899'
@@ -11,10 +24,13 @@ module Barcodes
         super(args)
       end
       
+      # Returns start character + 0 + data + center character + data + checksum + stop character
       def formatted_data
         @start_character + '0' + @data[0..5] + @center_character + @data[6..10] + self.checksum + @stop_character
       end
       
+      # Validates barcode using provided data
+      # Data length must be 11 digits
       def valid?
         unless super
           return false

data/lib/barcodes/version.rb

@@ -1,3 +1,11 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
+# 
 module Barcodes
-  VERSION = "0.0.1"
+  # Returns the current version
+  VERSION = "0.0.2"
 end

data/spec/barcodes/exec_spec.rb

@@ -1,9 +1,15 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/exec'
 
 describe Barcodes::Exec do
   describe "#new" do
-    it "should accept command line arguments and return a new Barcodes::Exec class" do
+    it "should accept an array of command line arguments and return a new Barcodes::Exec class" do
       
     end
   end

data/spec/barcodes/renderer/ascii_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/renderer/ascii'
 

data/spec/barcodes/renderer/pdf_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/renderer/pdf'
 

data/spec/barcodes/symbology/base_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/base'
 

data/spec/barcodes/symbology/codabar_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/codabar'
 

data/spec/barcodes/symbology/code11_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code11'
 

data/spec/barcodes/symbology/code128_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code128'
 

data/spec/barcodes/symbology/code39_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code39'
 

data/spec/barcodes/symbology/code39extended_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code39extended'
 

data/spec/barcodes/symbology/code39extendedmod43_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code39extendedmod43'
 

data/spec/barcodes/symbology/code39mod43_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code39mod43'
 

data/spec/barcodes/symbology/code93_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code93'
 

data/spec/barcodes/symbology/code93extended_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/code93extended'
 

data/spec/barcodes/symbology/ean13_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/ean13'
 

data/spec/barcodes/symbology/ean8_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/ean8'
 

data/spec/barcodes/symbology/ean_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/ean'
 

data/spec/barcodes/symbology/interleaved2of5_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/interleaved2of5'
 

data/spec/barcodes/symbology/interleaved2of5mod10_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/interleaved2of5mod10'
 

data/spec/barcodes/symbology/msi_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/msi'
 

data/spec/barcodes/symbology/msimod10_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/msimod10'
 

data/spec/barcodes/symbology/msimod11_spec.rb

@@ -1,3 +1,9 @@
+# Barcodes is a RubyGem for creating and rendering common barcode symbologies.
+#
+# Author::    Aaron Wright  (mailto:acwrightdesign@gmail.com)
+# Copyright:: Copyright (c) 2012 Infinite Token LLC
+# License::  MIT License
+
 require 'spec_helper'
 require 'barcodes/symbology/msimod11'