backgrounded 0.3.1

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Sonnek
+
+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.rdoc

@@ -0,0 +1,68 @@
+= Backgrounded
+
+Background processing done right.
+
+= Features
+* clean and concise API
+* testable
+* integrates with any background processing framework (DelayedJob, JobFu, Workling, etc)
+
+= Usage
+
+  #declaration
+  class User
+    backgrounded :do_stuff
+    def do_stuff
+      # do all your work here
+    end
+  end
+
+  #usage
+  user = User.new
+  user.do_stuff_backgrounded
+
+= Installation
+
+Command line installation
+
+  sudo gem install wireframe-backgrounded
+
+Rails environment.rb configuration
+
+  config.gem 'wireframe-backgrounded', :source => 'http://gems.github.com', :lib => 'backgrounded'
+
+= Configuration
+
+Backgrounded provides a thin wrapper around any background processing framework that implements the Backgrounded handler API.  This makes it trivial to swap out processing frameworks with no impact on your code.
+
+= DelayedJob
+
+An implementation for DelayedJob is packaged directly with Backgrounded for a slick out of the box experience.
+see http://github.com/tobi/delayed_job/tree/master
+
+  # rails config/initializers/backgrounded.rb
+  Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
+
+= JobFu
+
+Developers using the JobFu library have it easy as well!
+see http://github.com/jnstq/job_fu/tree
+
+  # rails config/initializers/backgrounded.rb
+  Backgrounded.handler = JobFu::Backgrounded::Handler.new
+
+= Custom Handlers
+
+It's trivial to write your own plugin for processing Backgrounded events! 
+
+  # rails config/initializers/backgrounded.rb
+  class MyHandler
+    def request(object, method, *args)
+      #process the call however you want!
+    end
+  end
+  Backgrounded.handler = MyHandler.new
+
+== Copyright
+
+Copyright (c) 2009 Ryan Sonnek. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "backgrounded"
+    gem.summary = %Q{Simple API to run Model methods in the background}
+    gem.email = "ryan.sonnek@gmail.com"
+    gem.homepage = "http://github.com/wireframe/backgrounded"
+    gem.authors = ["Ryan Sonnek"]
+    # 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: sudo 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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backgrounded #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 0
+:build: 
+:minor: 3
+:patch: 1

data/backgrounded.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backgrounded}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Sonnek"]
+  s.date = %q{2009-10-26}
+  s.email = %q{ryan.sonnek@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "backgrounded.gemspec",
+     "lib/backgrounded.rb",
+     "lib/handler.rb",
+     "lib/handler/delayed_job_handler.rb",
+     "lib/handler/inprocess_handler.rb",
+     "test/backgrounded_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/wireframe/backgrounded}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Simple API to run Model methods in the background}
+  s.test_files = [
+    "test/backgrounded_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/backgrounded.rb

@@ -0,0 +1,37 @@
+require 'activesupport'
+
+module Backgrounded
+  mattr_accessor :handler
+  def self.handler
+    @@handler ||= Backgrounded::Handler::InprocessHandler.new
+  end
+  
+  autoload :Handler, 'handler'
+        
+  module Model
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def backgrounded(*methods)
+        methods.each do |method|
+          method_basename, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+          define_method :"#{method_basename}_backgrounded#{punctuation}" do |*args|
+            Backgrounded.handler.request(self, method, *args)
+          end
+        end
+        include Backgrounded::Model::InstanceMethods
+        extend Backgrounded::Model::SingletonMethods
+      end
+    end
+
+    module SingletonMethods
+    end
+
+    module InstanceMethods
+    end
+  end
+end
+
+Object.send(:include, Backgrounded::Model)

data/lib/handler.rb

@@ -0,0 +1,10 @@
+require 'activesupport'
+
+module Backgrounded
+  module Handler
+    Dir["#{File.dirname(__FILE__)}/#{name.demodulize.underscore}/*.rb"].each do |handler_file|
+      handler_name = File.basename(handler_file, '.rb').camelize.to_sym
+      autoload handler_name, File.expand_path(handler_file)
+    end
+  end
+end

data/lib/handler/delayed_job_handler.rb

@@ -0,0 +1,13 @@
+require 'delayed_job'
+
+module Backgrounded
+  module Handler
+    # invoke the operation in the background using delayed job
+    # see http://github.com/tobi/delayed_job/tree/master
+    class DelayedJobHandler
+      def request(object, method, *args)
+        object.send_later(method.to_sym, *args)
+      end
+    end
+  end
+end

data/lib/handler/inprocess_handler.rb

@@ -0,0 +1,11 @@
+module Backgrounded
+  module Handler
+    #simple handler to process synchronously and not actually in the background
+    #useful for testing
+    class InprocessHandler
+      def request(object, method, *args)
+        object.send method, *args
+      end
+    end
+  end
+end

data/test/backgrounded_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class User
+  backgrounded :do_stuff
+
+  def do_stuff
+  end
+end
+
+class Person
+  backgrounded :do_stuff
+
+  def do_stuff(name, place, location)
+  end
+end
+
+class Post
+  backgrounded :do_stuff, :notify_users
+
+  def do_stuff
+  end
+  def notify_users
+  end
+end
+
+class Comment
+  backgrounded :delete_spam!
+  
+  def delete_spam!
+  end
+end
+
+class BackgroundedTest < Test::Unit::TestCase
+  context 'an object with a single backgrounded method' do
+    setup do
+      @user = User.new
+    end
+    should "execute method in background" do
+      @user.expects(:do_stuff)
+      @user.do_stuff_backgrounded
+    end
+  end
+
+  context 'an object with a backgrounded method that accepts parameters' do
+    setup do
+      @person = Person.new
+    end
+    should 'forward them' do
+      @person.expects(:do_stuff).with('ryan', 2, 3)
+      @person.do_stuff_backgrounded('ryan', 2, 3)
+    end
+  end
+  
+  context 'an object with a backgrounded method included punctuation' do
+    setup do
+      @comment = Comment.new
+    end
+    should 'move punctuation to the end of the new method' do
+      assert @comment.respond_to?(:'delete_spam_backgrounded!')
+    end
+  end
+
+  context 'an object with multiple backgrounded methods' do
+    setup do
+      @post = Post.new
+    end
+    should "execute method either method in background" do
+      @post.expects(:do_stuff)
+      @post.do_stuff_backgrounded
+
+      @post.expects(:notify_users)
+      @post.notify_users_backgrounded
+    end
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: backgrounded
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Ryan Sonnek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ryan.sonnek@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- backgrounded.gemspec
+- lib/backgrounded.rb
+- lib/handler.rb
+- lib/handler/delayed_job_handler.rb
+- lib/handler/inprocess_handler.rb
+- test/backgrounded_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/wireframe/backgrounded
+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: Simple API to run Model methods in the background
+test_files: 
+- test/backgrounded_test.rb
+- test/test_helper.rb