barcodes 0.0.1 → 0.0.2

data/lib/barcodes/symbology/ean.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 is the base class for all EAN type (EAN8, EAN13, UPC-A) barcode symbologies.
+    # EAN type barcodes can encode only the numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/European_Article_Number
     class Ean < Base
+      
+      # EAN character set
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9','S','C'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # EAN parity values table
       def self.parity
         [
           "000000", "001011", "001101", "001110",
@@ -15,6 +29,7 @@ module Barcodes
         ]
       end
       
+      # EAN left hand even values table
       def self.left_hand_even
         [
           "0001101", "0011001", "0010011", "0111101",
@@ -23,6 +38,7 @@ module Barcodes
         ]
       end
       
+      # EAN left hand odd values table
       def self.left_hand_odd
         [
           "0100111", "0110011", "0011011", "0100001",
@@ -31,6 +47,7 @@ module Barcodes
         ]
       end
       
+      # EAN right hand values table
       def self.right_hand
         [
           "1110010", "1100110", "1101100", "1000010",
@@ -39,10 +56,12 @@ module Barcodes
         ]
       end
       
+      # EAN uses special value sets so this returns an empty array
       def self.valueset
         []
       end
       
+      # Creates a new EAN instance
       def initialize(args={})
         super(args)
         
@@ -51,10 +70,12 @@ module Barcodes
         @center_character = 'C'
       end
       
+      # Returns data + checksum
       def caption_data
         @data + self.checksum
       end
       
+      # Encodes data into 1's and 0's
       def encoded_data
         if self.valid?
           formatted_data = self.formatted_data
@@ -83,10 +104,12 @@ module Barcodes
         end
       end
       
+      # EAN uses quiet zone that is 9 times the bar width in mils
       def quiet_zone_width
         self.bar_width * 9
       end
       
+      # Calculates the checksum
       def checksum
         if self.valid?
           sum = 0
@@ -108,6 +131,7 @@ module Barcodes
         end
       end
       
+      # Validates barcode using provided data
       def valid?
         self.data.each_byte do |char|
           if char.chr == 'S' || char.chr == 'C'
@@ -121,6 +145,7 @@ module Barcodes
       
       protected
       
+      # Encodes a single given character (as ASCII integer) using the given parity (1,0)
       def _encode_character_with_parity(character, parity)
         if self.class.charset.include? character
           if parity.to_i.even?
@@ -133,6 +158,7 @@ module Barcodes
         end
       end
       
+      # Encodes a single given character (as ASCII integer) using right hand values table
       def _encode_character_with_right_hand(character)
         if self.class.charset.include? character
           self.class.right_hand.at(self.class.charset.index(character))
@@ -140,7 +166,8 @@ module Barcodes
           return nil
         end
       end
-    
+      
+      # Returns nil
       def _encode_character(character)
         nil
       end

data/lib/barcodes/symbology/ean13.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 EAN13 symbology
+    # EAN13 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/International_Article_Number_(EAN)
     class Ean13 < Ean
+      
+      # Creates a new Ean13 instance
       def initialize(args={})
         unless args.has_key? :data
           args[:data] = '012345678999'
@@ -11,10 +24,14 @@ module Barcodes
         super(args)
       end
       
+      # Returns start character + data + center character + data + checksum + stop character
       def formatted_data
         @start_character + @data[0..6] + @center_character + @data[7..12] + self.checksum + @stop_character
       end
       
+      # Determines whether or not the barcode data to be encoded
+      # is valid.
+      # Data length must be exactly 12 digits
       def valid?
         unless super
           return false

data/lib/barcodes/symbology/ean8.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 EAN8 symbology
+    # EAN8 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/International_Article_Number_(EAN)
     class Ean8 < Ean
+      
+      # Creates a new Ean13 instance
       def initialize(args={})
         unless args.has_key? :data
           args[:data] = '0123456'
@@ -11,10 +24,12 @@ module Barcodes
         super(args)
       end
       
+      # Returns start character + data + center character + data + checksum + stop character
       def formatted_data
         @start_character + @data[0..3] + @center_character + @data[4..6] + self.checksum + @stop_character
       end
       
+      # Encodes data into 1's and 0's
       def encoded_data
         if self.valid?
           formatted_data = self.formatted_data
@@ -38,6 +53,9 @@ module Barcodes
         end
       end
       
+      # Determines whether or not the barcode data to be encoded
+      # is valid.
+      # Data length must be exactly 7 digits
       def valid?
         unless super
           return false

data/lib/barcodes/symbology/interleaved2of5.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 Interleaved 2 of 5 symbology
+    # Interleaved 2 of 5 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Interleaved_2_of_5
     class Interleaved2Of5 < Base
+      
+      # Interleaved 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
       
+      # Interleaved 2 of 5 values set
       def self.valueset
         [
           '101011011010','110101010110','101101010110','110110101010',
@@ -15,6 +29,9 @@ module Barcodes
         ]
       end
       
+      # Creates a new Interleaved2Of5 instance
+      # Interleaved 2 of 5 must have the start and stop characters
+      # 'S' and 'E' so they are overridden here.
       def initialize(args={})
         super(args)
         
@@ -22,6 +39,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/interleaved2of5mod10.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/interleaved2of5'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the Interleaved 2 of 5 Mod 10 symbology
+    # Interleaved 2 of 5 Mod 10 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Interleaved_2_of_5
     class Interleaved2Of5Mod10 < Interleaved2Of5
+      
+      # 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 provided data
       def checksum
         even_sum = 0
         odd_sum = 0

data/lib/barcodes/symbology/msi.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 MSI symbology
+    # MSI can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/MSI_Barcode
     class Msi < Base
+      
+      # MSI 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
       
+      # MSI values set
       def self.valueset
         [
           '100100100100','100100100110','100100110100','100100110110',
@@ -15,6 +29,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Msi 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/msimod10.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/msi'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the MSI Mod 10 symbology
+    # MSI Mod 10 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/MSI_Barcode
     class MsiMod10 < Msi
+      
+      # 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
         if self.valid?
           used_nums = []

data/lib/barcodes/symbology/msimod11.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/msi'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the MSI Mod 11 symbology
+    # MSI Mod 11 can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/MSI_Barcode
     class MsiMod11 < Msi
+      
+      # 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
         if self.valid?
           sum = 0

data/lib/barcodes/symbology/planet.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 PLANET symbology
+    # PLANET can encode only numbers 0-9
+    # 
+    # More info: http://en.wikipedia.org/wiki/Postal_Alpha_Numeric_Encoding_Technique
     class Planet < Base
+      
+      # PLANET character set
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # PLANET values set
       def self.valueset
         [
           '00111','11100','11010','11001',
@@ -15,6 +29,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Planet instance
       def initialize(args={})
         unless args.has_key? :data
           args[:data] = '012345678999'
@@ -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 12 or 14 digits
       def valid?
         @data.each_byte do |char|
           if self._encode_character(char).nil?