syc-barcode 0.0.1

data/README.rdoc

@@ -0,0 +1,15 @@
+= Barcode
+Creating barcodes (at the moment only Interleave2of5). 
+
+== Usage
+Create the barcode string and the barcode graphics data
+    i2o5 = Interleave2of5("01199")
+    code = i2o5.encode
+    barcode = i2o5.barcode
+    pdf = Prawn::Document.new
+    barcode.to_pdf(pdf)
+
+The barcode can be used to create a graphical representation of the barcode.
+
+== Licencse
+Barcode is published under the MIT license

data/lib/barcode.rb

@@ -0,0 +1,19 @@
+require_relative 'visual'
+
+# Barcode is the base class for barcodes it requires subclasses to implement
+# #encode and #barcode
+class Barcode
+
+  include Visual
+
+  # Encodes the string into a barcode
+  def encode
+    raise "needs to be implemented by sub class"
+  end
+
+  # Creates the coordinates for a barcode
+  def barcode
+    raise "needs to be implemented by sub class"
+  end
+
+end

data/lib/checked_attributes.rb

@@ -0,0 +1,24 @@
+# Checked attributes are checked for validity
+module CheckedAttributes
+
+  # Includes base
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  # Creates the attr_checked method
+  module ClassMethods
+
+    # attr_checked evaluates whether the value is valid
+    def attr_checked(attribute, &validation)
+      define_method "#{attribute}=" do |value|
+        raise ArgumentError unless validation.call(value)
+        instance_variable_set("@#{attribute}", value)
+      end
+
+      define_method attribute do
+        instance_variable_get "@#{attribute}"
+      end
+    end
+  end
+end

data/lib/interleave2of5.rb

@@ -0,0 +1,120 @@
+require_relative 'checked_attributes'
+require_relative 'barcode'
+
+# Creates a Interleave 2 of 5 barcode
+class Interleave2of5 < Barcode
+  include CheckedAttributes
+
+  # Holds the options for an Interleave 2 of 5 barcode
+  OPTIONS = {
+    x: 0,
+    y: 0,
+    width: 1,
+    factor: 2,
+    quiet: 20,
+    bearer: :none, # possible selections :none, :frame, :rule
+    bearer_width: 1,
+    top_margin: 10,
+    bottom_margin: 10,
+    height: 50
+  }
+
+  # Symbology the translates numbers to barcode symbology
+  SYMBOLOGY = { 
+    start: "0000", 
+    stop:  "100", 
+    "0" => "00110", 
+    "1" => "10001", 
+    "2" => "01001",
+    "3" => "11000",
+    "4" => "00101",
+    "5" => "10100",
+    "6" => "01100",
+    "7" => "00011",
+    "8" => "10010",
+    "9" => "01010" 
+  }
+                
+  attr_checked  :value do
+    |v| v.scan(/\D/).empty?
+  end
+
+  attr_accessor :check, :options
+  attr_reader   :code, :encodable, :graph
+
+  # Takes a value and whether a check digit is required
+  def initialize(value, check=true)
+    raise ArgumentError unless value.scan(/\D/).empty?
+    @value = value
+    @check = check
+  end
+
+  # Prints the values of Interleave2of5
+  def to_s
+    "value: #{@value}\n"+
+    "options: #{@options.inspect}\n"+
+    "encodable: #{@encodable ? @encodable : '#encode not run yet'}\n"+
+    "code: #{@code}\n"
+  end
+
+  # Encodes the value string to a barcode sequence consistent of 0 and 1
+  def encode
+    @code = ""
+    add_check_digit_and_ensure_even_digit_size
+    0.step(@encodable.size - 1, 2) do |i|
+      first = SYMBOLOGY[@encodable[i]]
+      second = SYMBOLOGY[@encodable[i+1]]
+      @code += 0.upto(4).map { |j| first[j] + second[j] }.join
+    end 
+    @code = SYMBOLOGY[:start] + @code + SYMBOLOGY[:stop]
+    self
+  end
+
+  # Creates the barcode coordinates for a visual representation
+  def barcode(options={})
+    @options = OPTIONS.merge(options)
+    
+    y_offset = @options[:bearer] != :none  ? @options[:bearer_width] : 0 
+    x_offset = @options[:bearer] == :frame ? @options[:bearer_width] : 0 
+
+    @graph = { 
+      total_width: 2 * x_offset + 2 * @options[:quiet],
+      total_height: @options[:height] + 2 * y_offset + @options[:top_margin] + 
+                    @options[:bottom_margin],
+      x: @options[:x] + @options[:quiet] + x_offset, 
+      y: @options[:y] + @options[:bottom_margin] + y_offset,
+      height: @options[:height],
+      bars: [],
+      graph_width: 0
+    }
+
+    x = @graph[:x]
+    
+    @code.each_char.with_index do |v, i|
+      width = @options[:width]
+      if v == "1"
+        width = width * @options[:factor]
+      end
+      @graph[:bars] << { x: x, width: width } if i.even?
+      x += width
+      @graph[:graph_width] += width
+    end
+
+    @graph[:total_width] += @graph[:graph_width]
+    @graph
+  end
+
+  private
+    
+    # Adds a check digit if check is true and ensures even digit size
+    def add_check_digit_and_ensure_even_digit_size
+      reverse_value = @value.split('').reverse
+      @check_digit = 10 - reverse_value.each_with_index.collect do |v, i|
+        i.even? ? v.to_i * 3 : v.to_i
+      end.inject(:+) % 10 if @check
+      @encodable = @value + (@check ? @check_digit.to_s : "")
+      @encodable = "0" + @encodable if @encodable.size.odd?
+      @encodable
+    end
+
+end

data/lib/visual.rb

@@ -0,0 +1,41 @@
+require 'prawn'
+
+# Methods to visualize a barcode
+module Visual
+
+  # Adds a barcode to a pdf file
+  def to_pdf(pdf, options={})
+    pdf.undash
+    barcode(options)
+    @graph[:bars].each do |b|
+      pdf.move_to(b[:x],             @graph[:y])
+      pdf.line_to(b[:x],             @graph[:y] + @graph[:height])
+      pdf.line_to(b[:x] + b[:width], @graph[:y] + @graph[:height])
+      pdf.line_to(b[:x] + b[:width], @graph[:y])
+      pdf.line_to(b[:x],             @graph[:y])
+      pdf.fill
+    end
+    if @options[:bearer] == :frame
+      pdf.move_to(@options[:x], @graph[:y])
+      pdf.line_to(@options[:x], 
+                  @graph[:y] + @graph[:height])
+      pdf.line_to(@options[:x] + 2 * @options[:quiet] + @graph[:graph_width],
+                  @graph[:y] + @graph[:height])
+      pdf.line_to(@options[:x] + 2 * @options[:quiet] + @graph[:graph_width],
+                  @graph[:y]) 
+      pdf.line_to(@options[:x],
+                  @graph[:y])
+    elsif @options[:bearer] == :rule
+      pdf.move_to(@options[:x], 
+                  @options[:y] + @options[:bottom_margin] + @graph[:height])
+      pdf.line_to(@options[:x] + 2 * @options[:quiet] + @graph[:graph_width],
+                  @options[:y] + @options[:bottom_margin] + @graph[:height])
+      pdf.move_to(@options[:x] + 2 * @options[:quiet] + @graph[:graph_width],
+                  @options[:y] + @options[:bottom_margin]) 
+      pdf.line_to(@options[:x],
+                  @options[:y] + @options[:bottom_margin])
+    end
+    @graph
+  end
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: syc-barcode
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pierre Sugar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "= Barcode\nCreating barcodes (at the moment only Interleave2of5).
+  \n\n== Usage\nCreate the barcode string and the barcode graphics data\n    i2o5
+  = Interleave2of5(\"01199\")\n    code = i2o5.encode\n    barcode = i2o5.barcode\n
+  \   pdf = Prawn::Document.new\n    barcode.to_pdf(pdf)\n\nThe barcode can be used
+  to create a graphical representation of the barcode.\n\n== Licencse\nBarcode is
+  published under the MIT license\n"
+email: pierre@sugaryourcoffee.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/barcode.rb
+- lib/checked_attributes.rb
+- lib/interleave2of5.rb
+- lib/visual.rb
+- README.rdoc
+homepage: http://syc.dyndns.org/drupal
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- sycbarcode
+- --main
+- README.rdoc
+- -ri
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Simple barcode creator
+test_files: []