queued 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation --backtrace

data/.rvmrc

@@ -0,0 +1 @@
+rvm ree@queued

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in queued.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Rob Ares
+
+Permission  is  hereby granted, free of charge, to any person ob-
+taining a copy of  this  software  and  associated  documentation
+files  (the "Software"), to deal in the Software without restric-
+tion, including without limitation the rights to use, copy, modi-
+fy, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is  fur-
+nished 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  NONIN-
+FRINGEMENT. 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,54 @@
+Queued
+============
+
+Provides a high-level abstraction of [Resque](https://github.com/defunkt/resque) jobs
+that map cleanly to [ActiveRecord (Rails)](https://github.com/rails/rails) instances.
+
+Normally, Resque jobs are seperate classes that model job specific functionality. This
+requires seperate tests, etc. Queued's approach is to just treat any instance method as
+a something that can be invoked as a job by Resque.
+
+What It Does
+--------------
+
+Queued patches a smart proxy into your AR instances that allow you to acces the functionality
+by calling `.queued` or `.qd`. From there any instance method may be called and invoked
+asynchronously.
+
+Caveats
+--------------
+* A record must be saved and reachable by an `id` accessor.
+* Assumes a Rails application with Resque setup.
+* does not handle Singleton methods (yet).
+* defaults the queue name to the instance class name. the `queued` method accepts an override.
+* Be sensible when calling methods and passing large objects to them. These arguments must be marshalled as json to be enqueued by resque. It is a best practice (in Resque as well) to pass simple parameters.
+
+Install
+--------------
+
+`gem "queued", "0.0.1"`
+
+Usage
+--------------
+
+Basic Example:
+
+```ruby
+record = Thing.find(42)
+record.queued.do_long_running_operation(:times => 50)
+```
+
+To Target a Specific Resque Queue:
+
+```ruby
+record = Thing.find(42)
+record.queued(:archive).truncate!
+```
+
+Additionally, the `.queued` method is aliased to `.qd` for brevity.
+
+Contributing
+--------------
+Fork it. Patches or pull requests are welcome.
+
+[License](https://github.com/rares/queued/blob/master/LICENSE)

data/Rakefile

@@ -0,0 +1,13 @@
+require "rake"
+require "bundler"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "run test suite"
+RSpec::Core::RakeTask.new do |t|
+end
+
+task :default  => :spec
+

data/lib/queued/active_record_integration.rb

@@ -0,0 +1,26 @@
+module Queued
+
+ module ActiveRecordIntegration
+   extend ActiveSupport::Concern
+
+   included do
+     alias :qd :queued
+   end
+
+   module ClassMethods
+
+     def perform(id, method, *args)
+       find(id).__send__(method, *args)
+     end
+   end
+
+   module InstanceMethods
+
+     def queued(queue_name = nil)
+       ::Queued::QueueingProxy.new(self, queue_name)
+     end
+   end
+
+ end
+
+end

data/lib/queued/queueing_proxy.rb

@@ -0,0 +1,29 @@
+require "resque"
+
+module Queued
+
+  class QueueingProxy
+    attr_reader :queue_name, :target
+
+    def initialize(target, queue_name = nil)
+      @target     = target
+      @queue_name = (queue_name || @target.class.name.tableize).to_sym
+    end
+
+    def method_missing(method, *args)
+      unless target.respond_to?(method)
+        raise NoMethodError.new "Can't be invoked", method, *args
+      end
+
+      Resque::Job.create(queue_name,
+        target.class,
+        target.id,
+        method.to_sym,
+        *args)
+
+      nil
+    end
+
+  end
+
+end

data/lib/queued/railtie.rb

@@ -0,0 +1,11 @@
+module Queued
+
+  class Railtie < ::Rails::Railtie
+    initializer "queued.initialize" do |app|
+      ActiveSupport.on_load :active_record do
+        include ::Queued::ActiveRecordIntegration
+      end
+    end
+  end
+
+end

data/lib/queued/version.rb

@@ -0,0 +1,3 @@
+module Queued
+  VERSION = "0.0.1"
+end

data/lib/queued.rb

@@ -0,0 +1,7 @@
+module Queued
+  autoload :Version,                 "queued/version"
+  autoload :QueueingProxy,           "queued/queueing_proxy"
+  autoload :ActiveRecordIntegration, "queued/active_record_integration"
+end
+
+require "queued/railtie" if defined?(::Rails::Railtie)

data/queued.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "queued/version"
+
+Gem::Specification.new do |s|
+  s.name        = "queued"
+  s.version     = Queued::VERSION
+  s.authors     = ["Rob Ares"]
+  s.email       = ["rob.ares@gmail.com"]
+  s.homepage    = "https://github.com/rares/queued"
+  s.summary     = %q{Call any ActiveRecord instance method as though it was a Resque job}
+  s.description = %q{}
+
+  s.rubyforge_project = "queued"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("activerecord", ["~> 3.0"])
+  s.add_runtime_dependency("resque", ["<= 1.17.1"])
+
+ s.add_development_dependency("rspec-rails", ["= 2.6.1"])
+ s.add_development_dependency("sqlite3-ruby", ["= 1.2.5"])
+end

data/spec/active_record_integration_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Queued::ActiveRecordIntegration do
+  subject { thing }
+
+  its(:queued) { should be_instance_of(Queued::QueueingProxy) }
+  its(:queued) { should be_respond_to(:present?) }
+  its(:qd)     { should_not be_nil }
+
+  context "perform" do
+
+    it "looks up the record" do
+      lambda { Thing.perform(subject.id, :id) }.should_not
+        raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "fails if the record does not exists" do
+      lambda { Thing.perform(0, :id) }.should
+        raise_error(ActiveRecord::RecordNotFound)
+    end
+
+    it "executes the passed method" do
+      Thing.perform(subject.id, :id).should eql(subject.id)
+    end
+
+    it "executes the passed method with arguments" do
+      Thing.perform(subject.id, :update_attribute, :name, "Derp").should eql(true)
+    end
+
+    it "fails when the method does not exist" do
+      lambda { Thing.perform(subject.id, :derp_it!) }.should
+        raise_error(NoMethodError)
+    end
+
+  end
+
+end
+

data/spec/queueing_proxy_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+describe Queued::QueueingProxy do
+  subject { thing }
+
+  it "returns a wrapped instance" do
+    described_class.new(subject).should_not be_nil
+  end
+
+  it "makes the target object accessable" do
+    described_class.new(subject).target.should eql(subject)
+  end
+
+  it "makes the queue name accessable" do
+    described_class.new(subject, :fast).queue_name.should eql(:fast)
+  end
+
+  it "default the queue name to that of the table" do
+    described_class.new(subject).queue_name.should eql(:things)
+  end
+
+  context "method_missing" do
+
+    it "raises when the queued method does not exist" do
+      lambda { described_class.new(subject).herp_it! }.should
+        raise_error(NoMethodError)
+    end
+
+    it "returns nil" do
+      Resque::Job.should_receive(:create).once
+
+      described_class.new(subject).save.should eql(nil)
+    end
+
+    it "enqueues a job containing the passed method" do
+      proxy = described_class.new(subject)
+
+      Resque::Job.should_receive(:create).with(proxy.queue_name,
+                                              subject.class,
+                                              subject.id,
+                                              :save,
+                                              false).once
+
+      proxy.save(false)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require "active_record/railtie"
+
+require "queued"
+
+# railties don't fire unless controllers are around, lame
+ActiveRecord::Base.__send__ :include, ::Queued::ActiveRecordIntegration
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:")
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :things, :force => true do |t|
+    t.string :name
+  end
+end
+
+class Thing < ActiveRecord::Base; end
+
+require "rspec/rails"
+
+module Helpers
+
+  def thing
+    Thing.create(:name => "Herglebergle Snartbirk")
+  end
+
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.fail_fast = true
+  config.include Helpers
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: queued
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rob Ares
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <=
+      - !ruby/object:Gem::Version 
+        hash: 81
+        segments: 
+        - 1
+        - 17
+        - 1
+        version: 1.17.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :development
+  version_requirements: *id004
+description: ""
+email: 
+- rob.ares@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/queued.rb
+- lib/queued/active_record_integration.rb
+- lib/queued/queueing_proxy.rb
+- lib/queued/railtie.rb
+- lib/queued/version.rb
+- queued.gemspec
+- spec/active_record_integration_spec.rb
+- spec/queueing_proxy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/rares/queued
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: queued
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Call any ActiveRecord instance method as though it was a Resque job
+test_files: []
+