brocade 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Andy Stewart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Brocade
+
+Brocade generates barcodes for Rails ActiveRecord models.
+
+I extracted this from one of my projects and, although the code is nice and extensible, right now it only does what I need in that project.  So for example it could produce barcodes in any symbology -- but currently only does Code 128.
+
+There are two parts to Brocade: barcode generation and file management (because the barcodes are saved as image files).  I use [Barby][barby] to generate the barcodes and code copied from [Paperclip][paperclip] to manage the files.
+
+
+## Features
+
+* No configuration necessary...or possible ;)
+* Supports Code 128 symbology.  Could support any symbology.
+* Generates barcode images as PNGs via ImageMagick.  Could support other output formats.
+* Stores barcode images on disk.  Could support other storage.
+
+
+## Basic Usage
+
+Brocade is simple to use:
+
+    class Item < ActiveRecord::Base
+      has_barcode
+
+      def barcodable
+        :serial_number
+      end
+    end
+
+First declare declare your model `has_barcode`.  Second override the `barcodable` method to return the name of the method Brocade should call to get the data to barcode.
+
+Now you get this:
+
+    >> item = Item.create :serial_number => 42, :name => 'Deep Thought'
+    # writes barcode to /path/to/your/app/public/system/barcodes/items/3615/code128.png
+
+-- assuming `item`'s id is 3615.
+
+    >> item.update_attributes :name => 'Deeper Thought'
+    # no change to barcode
+
+    >> item.update_attributes :serial_number => 153
+    # writes barcode to /path/to/your/app/public/system/barcodes/items/3615/code128.png
+    # i.e. writes out a new barcode image over the top of the original one
+
+    >> item.barcode_path
+    # => "/path/to/your/app/public/system/barcodes/items/3615/code128.png"
+
+    >> item.barcode_url
+    # => "/system/barcodes/items/3615/code128.png"
+
+    >> item.destroy
+    # deletes barcode image.
+
+
+## Installation.
+
+Install as a gem.  In your `config.rb`:
+
+    config.gem 'brocade'
+
+
+## Dependencies
+
+The [Barby][barby] and [PNG][png] gems, and ImageMagick.
+
+
+## Problems
+
+Please use GitHub's [issue tracker](http://github.com/airblade/brocade/issues).
+
+
+## To do
+
+* Tests.  Yes, yes, I know.
+* Configurable way to specify data to be barcoded.
+* Configurable symbology.
+* Multiple symbologies per model.
+* Configurable file path and URL.
+* Other outputters.
+* Other storage.
+
+
+## Further reading
+
+* [Barcode Basics](http://www.barcodediscount.com/solutions/library/barcode_basics.htm)
+* [Barcode Online Reference](http://www.teklynx.com/barcodes/article_1.html)
+
+
+## Inspiration
+
+* [Barby][barby]
+* [Paperclip][paperclip]
+
+
+## Intellectual Property
+
+Copyright (c) 2010 Andy Stewart. See LICENSE for details.
+
+
+  [barby]: http://github.com/toretore/barby
+  [paperclip]: http://github.com/thoughtbot/paperclip
+  [png]: http://seattlerb.rubyforge.org/png/

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "brocade"
+    gem.summary = %Q{Generates barcodes for Rails ActiveRecord models.}
+    gem.email = "boss@airbladesoftware.com"
+    gem.homepage = "http://github.com/airblade/brocade"
+    gem.authors = ["Andy Stewart"]
+    gem.add_dependency 'barby'
+    gem.add_dependency 'png'
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "brocade #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require 'brocade'

data/install.rb

@@ -0,0 +1 @@
+puts 'Thank you for installing Brocade.  You can visit http://github.com/airblade/brocade to read the documentation.'

data/lib/brocade/has_barcode.rb

@@ -0,0 +1,87 @@
+require 'barby'
+require 'barby/outputter/png_outputter'
+
+# A way of managing barcodes based closely on Thoughtbot's Paperclip.
+# It consists of two parts: barcode creation and file management.
+# Currently the file management is DIY but it might be better to delegate to Paperclip.
+module Brocade
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def has_barcode
+      send :include, InstanceMethods
+
+      after_create  :create_barcode
+      before_update :update_barcode
+      after_destroy :destroy_barcode
+    end
+  end
+
+  module InstanceMethods
+    # Returns the name of the method (as a symbol) to call to get the
+    # data to be barcoded.
+    #
+    # Override this in your model as appropriate.
+    def barcodable
+      :code
+    end
+
+    def symbology
+      :code128
+    end
+
+    def create_barcode
+      barcode = Barby::Code128B.new send(barcodable)
+      path = barcode_path
+      FileUtils.mkdir_p File.dirname(path)
+      File.open(path, 'wb') do |f|
+        f.write barcode.to_png
+      end
+      FileUtils.chmod 0644, path
+    end
+
+    def update_barcode
+      create_barcode if changed.include? barcodable
+    end
+
+    def destroy_barcode
+      path = barcode_path
+      begin
+        FileUtils.rm path if File.exist? path
+      rescue Errno::ENOENT => e
+        # Ignore file-not-found; let everything else pass.
+      end
+      begin
+        while true
+          path = File.dirname path
+          FileUtils.rmdir path
+        end
+      rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
+        # Stop trying to remove parent directories
+      rescue SystemCallError => e
+        #log("There was an unexpected error while deleting directories: #{e.class}")
+        # Ignore it
+      end
+    end
+
+    def barcode_url
+      "/system/barcodes/#{klass}/#{id}/#{symbology}.png"
+    end
+
+    def barcode_path
+      "#{RAILS_ROOT}/public/system/barcodes/#{klass}/#{id}/#{symbology}.png"
+    end
+
+    def klass
+      self.class.to_s.underscore.pluralize
+    end
+  end
+
+end
+
+if Object.const_defined? 'ActiveRecord'
+  ActiveRecord::Base.send :include, Brocade
+end

data/lib/brocade.rb

@@ -0,0 +1 @@
+require 'brocade/has_barcode'

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'brocade'
+
+class Test::Unit::TestCase
+end

data/test/test_brocade.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBrocade < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: brocade
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andy Stewart
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: barby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: png
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: boss@airbladesoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/brocade.rb
+- lib/brocade/has_barcode.rb
+- test/helper.rb
+- test/test_brocade.rb
+has_rdoc: true
+homepage: http://github.com/airblade/brocade
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generates barcodes for Rails ActiveRecord models.
+test_files: 
+- test/helper.rb
+- test/test_brocade.rb