barcodes 0.0.1 → 0.0.2

data/lib/barcodes/symbology/codabar.rb

@@ -1,12 +1,33 @@
+# 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 Codabar symbology.
+    # Codabar can encode the numbers 0-9 and the 
+    # following symbols: -,$,:,/,.,+
+    # 
+    # More info: http://en.wikipedia.org/wiki/Codabar
     class Codabar < Base
+      
+      # Start character
+      attr_accessor :start_character
+      
+      # Stop character
+      attr_accessor :stop_character
+      
+      # Codabar character set (0-9,-,$,:,/,.,+)
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9','-','$',':','/','.','+','A','B','C','D'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # Codabar values set
       def self.valueset
         [
           '1010100110','1010110010','1010010110','110010101',
@@ -17,6 +38,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Codabar instance with given arguments.
       def initialize(args={})
         unless args.has_key? :start_character
           args[:start_character] = 'A'
@@ -28,6 +50,7 @@ module Barcodes
         super(args)
       end
       
+      # Start character + data + stop character
       def formatted_data
         @start_character + @data + @stop_character
       end

data/lib/barcodes/symbology/code11.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 Code 11 symbology.
+    # Code 11 can encode the numbers 0-9 and the '-' dash symbol.
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_11
     class Code11 < Base
+      
+      # The Code 11 character set 0-9 and the '-' dash symbol.
       def self.charset
         ['0','1','2','3','4','5','6','7','8','9','-','S'].collect {|c| c.bytes.to_a[0] }
       end
       
+      # The Code 11 values set
       def self.valueset
         [
           '1010110','11010110','10010110',
@@ -16,6 +30,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Code11 instance.
       def initialize(args={})
         super(args)
         
@@ -23,6 +38,7 @@ module Barcodes
         @stop_character = 'S'
       end
       
+      # Start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -30,6 +46,7 @@ module Barcodes
         end
       end
       
+      # Calculates the C and K checksums from the barcode data
       def checksum
         if valid?
           unless @data.length >= 10
@@ -45,6 +62,7 @@ module Barcodes
       
       protected
       
+      # Calculate the checksum with given data and weighting
       def _checksum(data, weight_max)
         sum = 0
         weight = 0

data/lib/barcodes/symbology/code128.rb

@@ -1,17 +1,44 @@
+# 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 Code 128 symbology.
+    # Code 128 can encode all 128 ASCII characters using
+    # three different code sets.
+    #
+    # More info: http://en.wikipedia.org/wiki/Code_128
+    # 
+    # Assigned to code sets where applicable are the following 
+    # special characters representing Code 128 functions:
+    # 
+    # * START_A - \xF4
+    # * START_B - \xF5
+    # * START_C - \xF6
+    # * CODE_A - \xF7
+    # * CODE_B - \xF8
+    # * CODE_C - \xF9
+    # * FNC1 - \xFA
+    # * FNC2 - \xFB 
+    # * FNC3 - \xFC
+    # * FNC4 - \xFD
+    # * SHIFT - \xFE
+    # * STOP - \xFF
     class Code128 < Base
-      # Assigned to codesets are the following special characters representing Code 128 functions
-      # START_A - \xF4, START_B - \xF5, START_C - \xF6, 
-      # CODE_A - \xF7, CODE_B - \xF8, CODE_C - \xF9,
-      # FNC1 - \xFA, FNC2 - \xFB, FNC3 - \xFC, FNC4 - \xFD,
-      # SHIFT - \xFE, STOP - \xFF
+      
+      # Code 128 uses three special character sets so this
+      # returns an empty array
       def self.charset
         [].collect {|c| c.bytes.to_a[0] }
       end
       
+      # Character code set A
       def self.charset_a
         [
           " ","!","\"","#","$","%","&","'","(",")","*","+",",","-",".","/",
@@ -26,6 +53,7 @@ module Barcodes
         ].collect {|c| c.bytes.to_a[0] }
       end
       
+      # Character code set B
       def self.charset_b
         [
           " ","!","\"","#","$","%","&","'","(",")","*","+",",","-",".","/",
@@ -38,6 +66,7 @@ module Barcodes
         ].collect {|c| c.bytes.to_a[0] }
       end
       
+      # Character code set C
       def self.charset_c
         [
           "00","01","02","03","04","05","06","07","08","09","10","11","12","13",
@@ -51,6 +80,7 @@ module Barcodes
         ].collect {|c| c.bytes.to_a.length > 1 ? c.bytes.to_a : c.bytes.to_a[0] }
       end
       
+      # Code 128 values set
       def self.valueset
         [
           "11011001100","11001101100","11001100110","10010011000","10010001100",
@@ -78,10 +108,12 @@ module Barcodes
         ]
       end
       
+      # Data + checksum + stop character
       def formatted_data
         self._prepared_data + self.checksum + "\xFF"
       end
       
+      # Data encoded as 1's and 0's using three code sets
       def encoded_data
         if self.valid?
           encoded_data = ""
@@ -141,6 +173,7 @@ module Barcodes
         end
       end
       
+      # Calculates the checksum using barcode data
       def checksum
         if valid?
           sum = 0
@@ -204,6 +237,7 @@ module Barcodes
         end
       end
       
+      # Validates the data
       def valid?
         valid = @data.length > 0 ? true : false
       
@@ -219,6 +253,8 @@ module Barcodes
       
       protected
       
+      # Inspects barcode data and determines the best character sets to use
+      # for provided data
       def _prepared_data
         start = "\xF5"
         charset = "B"
@@ -290,10 +326,13 @@ module Barcodes
         return data
       end
     
+      # Returns nil due to Code 128 using special character sets
       def _encode_character(character)
         return nil
       end
       
+      # Encodes a single character (as ASCII integer) using given 
+      # character set
       def _encode_character_in_charset(character, charset)
         case charset
         when 'A'

data/lib/barcodes/symbology/code39.rb

@@ -1,8 +1,23 @@
+# 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 Code 39 symbology.
+    # Code 39 can encode the numbers 0-9 and all capital
+    # letters along with the following symbols: ' ','-',
+    # '.','$','/','+','%','*'
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_39
     class Code39 < Base
+      
+      # The Code 39 character set
       def self.charset
         [
           '0','1','2','3','4','5','6','7','8','9',
@@ -13,6 +28,7 @@ module Barcodes
         ].collect {|c| c.bytes.to_a[0] }
       end
       
+      # The Code 39 values set
       def self.valueset
         [
           "1010011011010","1101001010110","1011001010110","1101100101010",
@@ -29,6 +45,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Code39 instance.
       def initialize(args={})
         super(args)
         
@@ -36,10 +53,14 @@ module Barcodes
         @stop_character = '*'
       end
       
+      # Code 39 includes the start and stop symbols in
+      # the caption so caption_data is overridden here
+      # to return the formatted data string
       def caption_data
         self.formatted_data
       end
       
+      # Start character + data + stop character
       def formatted_data
         @start_character + @data + @stop_character
       end

data/lib/barcodes/symbology/code39extended.rb

@@ -1,11 +1,23 @@
+# 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/code39'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the Code 39 Extended symbology.
+    # Code 39 Extended can encode all standard ASCII characters.
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_39
     class Code39Extended < Code39
       
       protected
       
+      # Encodes given character (as ASCII integer) into 1's and 0's
       def _encode_character(character)
         unless (character == 36 || character == 37 || character == 43)
           unless super(character).nil?

data/lib/barcodes/symbology/code39extendedmod43.rb

@@ -1,12 +1,25 @@
+# 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/code39extended'
 
 module Barcodes
   module Symbology
+    
+    # Modulo 43 checksum version of Code 39 Extended
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_39
     class Code39ExtendedMod43 < Code39Extended
+      
+      # Returns caption data without checksum
       def caption_data
         @start_character + @data + @stop_character
       end
       
+      # Start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -14,6 +27,7 @@ module Barcodes
         end
       end
       
+      # Calculates the checksum using the provided data
       def checksum
         if valid?
           sum = 0

data/lib/barcodes/symbology/code39mod43.rb

@@ -1,12 +1,25 @@
+# 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/code39'
 
 module Barcodes
   module Symbology
+    
+    # Modulo 43 checksum version of Code 39
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_39
     class Code39Mod43 < Code39
+      
+      # Returns caption data without checksum
       def caption_data
         @start_character + @data + @stop_character
       end
       
+      # Start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -14,6 +27,7 @@ module Barcodes
         end
       end
       
+      # Calculates the checksum using the provided data
       def checksum
         if self.valid?
           sum = 0

data/lib/barcodes/symbology/code93.rb

@@ -1,8 +1,23 @@
+# 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 Code 93 symbology.
+    # Code 93 can encode the characters 0-9 and A-Z along
+    # with the following characters: "-","."," ","$",
+    # "/","+","%","*"
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_93
     class Code93 < Base
+      
+      # The Code 93 character set
       def self.charset
         [
           "0","1","2","3","4","5","6","7","8","9",
@@ -13,6 +28,7 @@ module Barcodes
         ].collect {|c| c.bytes.to_a[0] }
       end
       
+      # The Code 93 values set
       def self.valueset
         [
           "100010100","101001000","101000100","101000010",
@@ -30,6 +46,7 @@ module Barcodes
         ]
       end
       
+      # Creates a new Code93 instance.
       def initialize(args={})
         super(args)
         
@@ -37,10 +54,14 @@ module Barcodes
         @stop_character = '*'
       end
       
+      # Code 39 includes the start and stop symbols in
+      # the caption so caption_data is overridden here
+      # to return the formatted data string
       def caption_data
         @start_character + @data + @stop_character
       end
       
+      # Start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -48,6 +69,7 @@ module Barcodes
         end
       end
       
+      # Calculates the C and K checksum values
       def checksum
         if self.valid?
           c_value = self._checksum(@data, 20)
@@ -58,6 +80,7 @@ module Barcodes
       
       protected
       
+      # Calculates the checksum with given data and given weighting
       def _checksum(data, weight_max)
         sum = 0
         weight = 1

data/lib/barcodes/symbology/code93extended.rb

@@ -1,9 +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/code93'
 
 module Barcodes
   module Symbology
+    
+    # This class represents the Code 93 Extended symbology.
+    # Code 93 Extended can encode all standard ASCII characters.
+    # 
+    # More info: http://en.wikipedia.org/wiki/Code_93
     class Code93Extended < Code93
       
+      # Start character + data + checksum + stop character
       def formatted_data
         checksum = self.checksum
         unless checksum.nil?
@@ -11,6 +23,7 @@ module Barcodes
         end
       end
       
+      # Calculates the C and K checksum values
       def checksum
         if self.valid?
           data = self._data
@@ -20,12 +33,15 @@ module Barcodes
         end
       end
       
+      # Validates the data
       def valid?
         return !self._data.nil?
       end
       
       protected
-
+      
+      # Format the data string by adding shift characters when
+      # applicable
       def _data
         _data = ''
         self.data.each_byte do |char|