resque_def 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e97978c1e1e7b7361fc20e62cdad2791d0fc205b
+  data.tar.gz: 4b134ee7cc1316f0052076bb17af5376751798fd
+SHA512:
+  metadata.gz: fc5c45d2c0177dd2b82d2926b6197c2d3efdafcbd3c4395a7b0d42867ae510e92cb96dbcc8175933f557271ac2c8d1c40ab35d50fd295d1566719744f573e74d
+  data.tar.gz: d302af7e191e301010cf95060cda342f69011d884f67e3ea4854fd73472fcad09329fad0acdc268805d39061229528fa1adb995de2fe4419f2323c6e82ba7b98

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+test/fixtures/repos/*
+*.gem
+
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,100 @@
+## ResqueDef
+
+Forget resque boilerplate: focus on your code.
+
+## Install
+
+In your `Gemfile` add:
+
+```ruby
+gem 'resque_def'
+```
+
+Then run `$ bundle install`
+
+## What
+
+I love Resque, but I'm not in love with the amount of code needed to define and use a Resque task to do something like pull a user from a database, find open issues (assuming an issue model) and sending an email might look like this:
+
+```ruby
+class User < ActiveRecord::Base
+
+  class DelaySendIssues
+    @queue = :delay_send_issues
+
+    def self.perform(id, state)
+      user   = User.find(id)
+      issues = user.issues.where(state: state).all
+      UserMailer.send_issues(user: user, issues: issues).deliver
+    end
+  end
+end
+
+user = User.last
+Resque.enqueue(User::SendDailyTriageEmail, user.id, 'open')
+```
+
+With ResqueDef, you can include a module, and define and use a Resque job like this:
+
+```ruby
+class User < ActiveRecord::Base
+  include ResqueDef
+
+  resque_def(:delay_send_issues) do |id, state|
+    user   = User.find(id)
+    issues = user.issues.where(state: state).all
+    UserMailer.send_issues(user: user, issues: issues).deliver
+  end
+end
+
+user = User.last
+User.delay_send_issues(user.id, 'open')
+```
+
+So looking at the boiler plate (and none of the logic) we are reducing this:
+
+
+```ruby
+  class DelaySendIssues
+    @queue = :delay_send_issues
+
+    def self.perform(id, state)
+    end
+  end
+```
+
+To this:
+
+```ruby
+resque_def(:delay_send_issues) do |id, state|
+end
+```
+
+Pretty cool, huh? To do this, ResqueDef uses simple metaprogramming: `Class.new` is used to define the require class, and then `define_singleton_method` adds our method to the class included `ResqueDef`. Not doing anything too magical. Check out the code for yourself!
+
+
+## Serializing Objects
+
+By default Resque can only store JSON-able objects (strings, arrays, hashes, booleans). It cannot store active record objects.
+
+## TIL with Blocks
+
+You can set default values in blocks like this:
+
+```ruby
+resque_def(:foo) do |id, state = 'open', username = 'schneems'|
+  # ...
+end
+```
+
+You can have an unlimited amount of args using a splat:
+
+```ruby
+resque_def(:foo) do |id, *args|
+  # ...
+end
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'bundler/gem_tasks'
+
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+test_task = Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/resque_def.rb

@@ -0,0 +1,46 @@
+module ResqueDef
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def resque_def(resque_name, &block)
+      # convert resque_name like :delay_send_issues to DelaySendIssues for klass name
+      resque_klass_name = resque_name.to_s.capitalize.gsub(/_\S/) {|m| m.upcase}.gsub('_', '')
+
+      # create the resque klass
+      resque_klass = Class.new do
+        @queue = resque_name
+
+        def self.perform(*args)
+          @job.call(*args)
+        end
+
+        def self.job=(job)
+          @job = job
+        end
+
+        def self.queue=(queue)
+          @queue = queue
+        end
+      end
+      resque_klass.job   = block
+      resque_klass.queue = name
+
+      # assign the object to a constant we can look up later
+      resque_klass = self.const_set(resque_klass_name, resque_klass)
+
+      # create the class method to enqueue the resque job
+      define_singleton_method(resque_name) do |*args|
+        Resque.enqueue(resque_klass, *args)
+      end
+
+      # helper instance method, calls the class method
+      define_method(resque_name) do |*args|
+        self.class.send(resque_name, *args)
+      end
+    end
+  end
+end
+
+require 'resque_def/version'

data/lib/resque_def/version.rb

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

data/resque_def.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque_def/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "resque_def"
+  gem.version       = ResqueDef::VERSION
+  gem.authors       = ["Richard Schneeman"]
+  gem.email         = ["richard.schneeman+rubygems@gmail.com"]
+  gem.description   = %q{ Defining Resque boilerplate since 2013 }
+  gem.summary       = %q{ Defining Resque boilerplate since 2013 }
+  gem.homepage      = "https://github.com/heroku/resque_def"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "resque"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "mocha"
+end
+

data/test/resque_def_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class ResqueDefTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_enqueue
+    Resque.expects(:enqueue).with(User::Foo, 1,2,3).once
+    Resque.expects(:enqueue).with(User::Foo, 4,5,6).once
+
+    User.foo(1,2,3)
+    User.new.foo(4,5,6)
+  end
+
+  def test_dequeue
+    User.expects(:bar).with("a", "b", "c").twice
+    User.bar("a", "b", "c")
+    User.new.bar("a", "b", "c")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+Bundler.require
+
+require 'resque'
+require 'resque_def'
+require 'test/unit'
+require "mocha/setup"
+
+
+Resque.inline = true # for testing, tasks are called automatically
+
+
+class User
+  include ResqueDef
+
+  def self.find(id)
+    self.new
+  end
+
+  resque_def :foo do
+  end
+
+  def self.bar(*args)
+  end
+
+  resque_def :bar do |*args|
+    User.bar(*args)
+  end
+end
+
+
+# make sure the namespace works correctly Foo::Bar and User::Bar
+class Foo
+  include ResqueDef
+
+  def self.bar(*args)
+  end
+
+  resque_def :bar do |*args|
+    Foo.bar(*args)
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: resque_def
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Richard Schneeman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ' Defining Resque boilerplate since 2013 '
+email:
+- richard.schneeman+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/resque_def.rb
+- lib/resque_def/version.rb
+- resque_def.gemspec
+- test/resque_def_test.rb
+- test/test_helper.rb
+homepage: https://github.com/heroku/resque_def
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: Defining Resque boilerplate since 2013
+test_files:
+- test/resque_def_test.rb
+- test/test_helper.rb