@@ -1,13 +1,29 @@ -Barby makes barcodes - -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## -## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## - B A R B Y +Barby is a Ruby barcode generator. It does not depend on other libraries +(for the core functionality) and is easily extentable. + +The barcode objects are separated from the process of generating graphical +(or other) representations. A barcode's only responsibility is to provide +a string representation consisting of 1s and 0s representing bars and spaces. +This string can then be used to generate (for example) an image with the +RMagickOutputter, or an ASCII string such as the one below. + +See Barby::Barcode and Barby::Outputter for more information. + + require 'barby' + require 'barby/outputter/ascii_outputter' + + barcode = Barby::Code128B.new('BARBY') + + puts barcode.to_ascii + + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + ## # # # # ## # # ## ## # ### # # ## ### ## # ## ### ### ## ### # ## + B A R B Y README @@ -1,6 +1,29 @@ module Barby + #The base class for all barcodes. It includes some method_missing magic + #that is used to find registered outputters. + # + #The only interface requirement of a barcode class is that is has an encoding + #method that returns a string consisting of 1s and 0s representing the barcode's + #"black" and "white" parts. One digit is the width of the "X dimension"; that is, + #"101100" represents a single-width bar followed by a single-width space, then + #a bar and a space twice that width. + # + #Example implementation: + # + # class StaticBarcode < Barby::Barcode1D + # def encoding + # '101100111000111100001' + # end + # end + # + # require 'barby/outputter/ascii_outputter' + # puts StaticBarcode.new.to_ascii(:height => 3) + # + # # ## ### #### # + # # ## ### #### # + # # ## ### #### # class Barcode @@ -58,9 +81,13 @@ module Barby end + #Most barcodes are one-dimensional. They have bars. class Barcode1D < Barcode end + #There is currently only support for one-dimensional barcodes, + #but in the future it should also be possible to support barcodes + #with two dimensions. class Barcode2D < Barcode end lib/barby/barcode.rb @@ -8,12 +8,22 @@ module Barby #Outputters can register methods on barcodes that will be associated with #them. # - #Yes, it needs a better name. + #The basic structure of an outputter class: + # + # class FooOutputter < Barby::Outputter + # register :to_foo + # def to_too + # do_something_with(barcode.encoding) + # end + # end + # + #Barcode#to_foo will now be available to all barcodes class Outputter attr_accessor :barcode + #An outputter instance will have access to a Barcode def initialize(barcode) self.barcode = barcode end @@ -52,7 +62,7 @@ module Barby #Converts the barcode's encoding (a string containing 1s and 0s) #to true and false values (1 == true == "black bar") - def booleans + def booleans#:doc: barcode.encoding.split(//).map{|c| c == '1' } end lib/barby/outputter.rb @@ -2,6 +2,8 @@ require 'barby/outputter' module Barby + #Outputs an ASCII representation of the barcode. This is mostly useful for printing + #the barcode directly to the terminal for testing. class ASCIIOutputter < Outputter register :to_ascii lib/barby/outputter/ascii_outputter.rb 30c2bd9898d1d814e31f72bc0686fc5714943185 Tore Darell toredarell@gmail.com http://github.com/toretore/barby/commit/6c381d754df8b766fdbb3830dff63157cf17f4e6 6c381d754df8b766fdbb3830dff63157cf17f4e6 2008-03-17T14:05:14-07:00 2008-03-17T14:05:14-07:00 Added some more documentation 817930f7882d35ee10e8e6ee485888d18332dff9 Tore Darell toredarell@gmail.com