activejob-perform_later 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b5b407399e36460850a38bd2d99322b5fd57803
+  data.tar.gz: 322ad837ea9516cb06506ed841a76e08a139b0c1
+SHA512:
+  metadata.gz: 5257e7665e29dcec2d66c42030ceeb5a2f6bfd3879a5754fb50cfe8cf2c07f29127a6d049a97168b1a9a95fac19ec1d30d3e8fba22f6de901ddf0f6b206d798c
+  data.tar.gz: 73709080400ecad1ccfb36a77b4ca16e4fd669b3f2f062daac202ba515834d4bea0a69ca5e77ae72f7ba47d8ef37ac4c37ab947baa2b2991873733d8913b2e96

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activejob', github: 'rails/rails', branch: '4-2-stable'
+gem 'activesupport', github: 'rails/rails', branch: '4-2-stable'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Cristian Bica
+
+MIT License
+
+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,87 @@
+# Activejob::PerformLater
+
+Make any method perfomed later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activejob-perform_later'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activejob-perform_later
+
+## Usage
+
+### Declare your class methods as always performed later
+
+```ruby
+class MyClass
+  def self.a_method(arg1, arg2)
+    # do stuff
+  end
+  perform_later :a_method
+  perform_later :a_method, queue: :low_priority
+  perform_later :a_method, wait: 10.minutes
+  perform_later :a_method, wait: 60.minutes, queue: :low_priority
+end
+
+#calling the method will actually schedule the method to be performed later by ActiveJob
+MyClass.a_method(1, 2)
+```
+
+### Perform your class method delayed whenever you need that
+
+```ruby
+class MyClass
+  def self.a_method(arg1, arg2)
+    # do stuff
+  end
+end
+
+# calling the method directly will perform it inline
+MyClass.a_method(1,2)
+
+# calling the method with perform_later will schedule the performing in Active Job
+MyClass.perform_later.a_method(1,2)
+MyClass.perform_later(queue: :low_priority).a_method(1,2)
+MyClass.perform_later(wait: 10.minutes).a_method(1,2)
+MyClass.perform_later(wait: 10.minutes, queue: :low_priority).a_method(1,2)
+MyClass.perform_later(wait_until: 60.minutes.from_now, queue: :low_priority).a_method(1,2)
+end
+```
+
+### Perform your instance method delayed
+
+This works only if your class is safe to be passed to Active Job (e.g.: it's global
+identificable with GlobalID. Active Record implements GlobalID since 4.2.0):
+
+```ruby
+class User < ActiveRecord::Base
+  def recalculate_billing
+    # do stuff
+  end
+end
+
+# calling the method with perform_later will schedule the performing in Active Job
+User.last.perform_later.recalculate_billing
+User.last.perform_later(queue: :low_priority).recalculate_billing
+User.last.perform_later(wait: 10.minutes).recalculate_billing
+User.last.perform_later(wait_until: 60.minutes.from_now).recalculate_billing
+User.last.perform_later(wait: 10.minutes, queue: :low_priority).recalculate_billing
+User.last.perform_later(wait_until: 60.minutes.from_now, queue: :low_priority).recalculate_billing
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/cristianbica/activejob-perform_later/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/cases/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/activejob-perform_later.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activejob/perform_later/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activejob-perform_later"
+  spec.version       = Activejob::PerformLater::VERSION
+  spec.authors       = ["Cristian Bica"]
+  spec.email         = ["cristian.bica@gmail.com"]
+  spec.summary       = %q{Make any method perfomed later.}
+  spec.description   = %q{Take advantage of Active Job you can perform any class method later.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activejob'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/activejob/perform_later.rb

@@ -0,0 +1,15 @@
+require "activejob/perform_later/version"
+require 'active_support'
+require 'active_job'
+
+module Activejob
+  module PerformLater
+    extend ActiveSupport::Autoload
+
+    autoload :Job
+    autoload :Proxy
+    autoload :Mixin
+  end
+end
+
+Object.send(:include, Activejob::PerformLater::Mixin)

data/lib/activejob/perform_later/job.rb

@@ -0,0 +1,10 @@
+module Activejob
+  module PerformLater
+    class Job < ActiveJob::Base
+      def perform(target, method_name, args)
+        target = target.safe_constantize if target.is_a?(String)
+        target.public_send method_name, args
+      end
+    end
+  end
+end

data/lib/activejob/perform_later/mixin.rb

@@ -0,0 +1,34 @@
+module Activejob
+  module PerformLater
+    module Mixin
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def perform_later(*args)
+          if args[0].is_a?(Symbol)
+            raise ArgumentError, "#{self} does not have a `#{args[0]}` class method" unless respond_to?(args[0])
+            method  = args[0]
+            options = args[1]||{}
+
+            aliased_method, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+            now_method, later_method = "#{aliased_method}_now#{punctuation}", "#{aliased_method}_later#{punctuation}"
+
+            singleton_class.send(:define_method, later_method) do |*args|
+              Job.new(self.name, now_method, args).enqueue options
+            end
+
+            singleton_class.send(:alias_method, now_method, method)
+            singleton_class.send(:alias_method, method, later_method)
+          else
+            options = args[0]||{}
+            Proxy.new(self.name, options)
+          end
+        end
+      end
+
+      def perform_later(options={})
+        Proxy.new(self, options)
+      end
+    end
+  end
+end

data/lib/activejob/perform_later/proxy.rb

@@ -0,0 +1,14 @@
+module Activejob
+  module PerformLater
+    class Proxy < BasicObject
+      def initialize(target, options)
+        @target = target
+        @options = options
+      end
+
+      def method_missing(method_name, *args)
+        Job.new(@target, method_name.to_s, args).enqueue @options
+      end
+    end
+  end
+end

data/lib/activejob/perform_later/version.rb

@@ -0,0 +1,5 @@
+module Activejob
+  module PerformLater
+    VERSION = "1.0.0"
+  end
+end

data/test/cases/class_methods_always_test.rb

@@ -0,0 +1,56 @@
+require 'helper'
+require 'classes/test_class'
+
+class ClassMethodsAlwaysTest < ActiveSupport::TestCase
+  include ActiveJob::TestHelper
+
+  def test_creates_later_and_now_methods
+    assert_respond_to TestClass, :one_later
+    assert_respond_to TestClass, :one_now
+  end
+
+  def test_creates_later_and_now_methods_with_punctuation
+    assert_respond_to TestClass, :four_later?
+    assert_respond_to TestClass, :four_now?
+  end
+
+  def test_enqueues_the_job
+    assert_enqueued_jobs 1 do
+      TestClass.one
+    end
+  end
+
+  def test_enqueues_the_job_with_delay
+    travel_to Time.now do
+      assert_enqueued_with(job: Activejob::PerformLater::Job, args: ["TestClass", "two_now", [1, 2]], at: 60.seconds.from_now.to_f) do
+        TestClass.two(1, 2)
+      end
+    end
+  end
+
+  def test_enqueues_the_job_on_a_queue
+    assert_enqueued_with(job: Activejob::PerformLater::Job, args: ["TestClass", "three_now", [1, 2]], queue: 'non_default') do
+      TestClass.three(1, 2)
+    end
+  end
+
+  def test_performs_the_job
+    assert_performed_jobs 1 do
+      TestClass.one
+    end
+  end
+
+  def test_performs_the_job_with_delay
+    travel_to Time.now do
+      assert_performed_with(job: Activejob::PerformLater::Job, args: ["TestClass", "two_now", [1, 2]], at: 60.seconds.from_now.to_f) do
+        TestClass.two(1, 2)
+      end
+    end
+  end
+
+  def test_performs_the_job_on_a_queue
+    assert_performed_with(job: Activejob::PerformLater::Job, args: ["TestClass", "three_now", [1, 2]], queue: 'non_default') do
+      TestClass.three(1, 2)
+    end
+  end
+end

data/test/cases/class_methods_on_demand_test.rb

@@ -0,0 +1,59 @@
+require 'helper'
+require 'classes/test_class'
+
+class ClassMethodsAlwaysTest < ActiveSupport::TestCase
+  include ActiveJob::TestHelper
+
+  def test_enqueues_the_job
+    assert_enqueued_jobs 1 do
+      TestClass.perform_later.five
+    end
+  end
+
+  def test_enqueues_the_job_with_arguments
+    assert_enqueued_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]]) do
+      TestClass.perform_later.five(1, 2)
+    end
+  end
+
+  def test_enqueues_the_job_with_delay
+    travel_to Time.now do
+      assert_enqueued_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]], at: 60.seconds.from_now.to_f) do
+        TestClass.perform_later(wait: 60.seconds).five(1, 2)
+      end
+    end
+  end
+
+  def test_enqueues_the_job_on_a_queue
+    assert_enqueued_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]], queue: 'non_default') do
+        TestClass.perform_later(queue: "non_default").five(1, 2)
+    end
+  end
+
+
+  def test_performs_the_job
+    assert_performed_jobs 1 do
+      TestClass.perform_later.five
+    end
+  end
+
+  def test_performs_the_job_with_arguments
+    assert_performed_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]]) do
+      TestClass.perform_later.five(1, 2)
+    end
+  end
+
+  def test_performs_the_job_with_delay
+    travel_to Time.now do
+      assert_performed_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]], at: 60.seconds.from_now.to_f) do
+        TestClass.perform_later(wait: 60.seconds).five(1, 2)
+      end
+    end
+  end
+
+  def test_performs_the_job_on_a_queue
+    assert_performed_with(job: Activejob::PerformLater::Job, args: ["TestClass", "five", [1, 2]], queue: 'non_default') do
+        TestClass.perform_later(queue: "non_default").five(1, 2)
+    end
+  end
+end

data/test/cases/instance_methods_on_demand_test.rb

@@ -0,0 +1,60 @@
+require 'helper'
+require 'classes/test_class'
+
+class ClassMethodsAlwaysTest < ActiveSupport::TestCase
+  include ActiveJob::TestHelper
+
+  def test_enqueues_the_job
+    assert_enqueued_jobs 1 do
+      TestClass.new.perform_later.six
+    end
+  end
+
+  def test_enqueues_the_job_with_arguments
+    assert_enqueued_with(job: Activejob::PerformLater::Job, args: [{"_aj_globalid"=>"gid://ajpl/TestClass/0"}, 'six', [1, 2]]) do
+      TestClass.new.perform_later.six(1, 2)
+    end
+  end
+
+  def test_enqueues_the_job_with_delay
+    travel_to Time.now do
+      assert_enqueued_with(job: Activejob::PerformLater::Job, at: 60.seconds.from_now.to_f) do
+        TestClass.new.perform_later(wait: 60.seconds).six
+      end
+    end
+  end
+
+  def test_enqueues_the_job_on_a_queue
+    assert_enqueued_with(job: Activejob::PerformLater::Job, queue: 'non_default') do
+        TestClass.new.perform_later(queue: "non_default").six
+    end
+  end
+
+
+  def test_performs_the_job
+    assert_performed_jobs 1 do
+      TestClass.new.perform_later.six
+    end
+  end
+
+  def test_performs_the_job_with_arguments
+    assert_performed_with(job: Activejob::PerformLater::Job, args: [{"_aj_globalid"=>"gid://ajpl/TestClass/0"}, 'six', [1, 2]]) do
+      TestClass.new.perform_later.six(1, 2)
+    end
+  end
+
+  def test_performs_the_job_with_delay
+    travel_to Time.now do
+      assert_performed_with(job: Activejob::PerformLater::Job, at: 60.seconds.from_now.to_f) do
+        TestClass.new.perform_later(wait: 60.seconds).six
+      end
+    end
+  end
+
+  def test_performs_the_job_on_a_queue
+    assert_performed_with(job: Activejob::PerformLater::Job, queue: 'non_default') do
+      TestClass.new.perform_later(queue: "non_default").six
+    end
+  end
+
+end

data/test/classes/test_class.rb

@@ -0,0 +1,33 @@
+class TestClass
+  include GlobalID::Identification
+
+  def self.find(*)
+    new
+  end
+
+  def id
+    0
+  end
+
+  def self.one(*)
+  end
+  perform_later :one
+
+  def self.two(*)
+  end
+  perform_later :two, wait: 60
+
+  def self.three(*)
+  end
+  perform_later :three, queue: 'non_default'
+
+  def self.four?(*)
+  end
+  perform_later :four?
+
+  def self.five(*)
+  end
+
+  def six(*)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler.setup
+
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib'
+
+require 'activejob/perform_later'
+require 'active_support/core_ext/numeric/time'
+
+ActiveSupport::TestCase.test_order = :random
+ActiveJob::Base.queue_adapter = :test
+GlobalID.app = 'ajpl'
+ActiveJob::Base.logger.level = Logger::ERROR
+
+require 'active_support/testing/autorun'

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: activejob-perform_later
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cristian Bica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Take advantage of Active Job you can perform any class method later.
+email:
+- cristian.bica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activejob-perform_later.gemspec
+- lib/activejob/perform_later.rb
+- lib/activejob/perform_later/job.rb
+- lib/activejob/perform_later/mixin.rb
+- lib/activejob/perform_later/proxy.rb
+- lib/activejob/perform_later/version.rb
+- test/cases/class_methods_always_test.rb
+- test/cases/class_methods_on_demand_test.rb
+- test/cases/instance_methods_on_demand_test.rb
+- test/classes/test_class.rb
+- test/helper.rb
+homepage: ''
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Make any method perfomed later.
+test_files:
+- test/cases/class_methods_always_test.rb
+- test/cases/class_methods_on_demand_test.rb
+- test/cases/instance_methods_on_demand_test.rb
+- test/classes/test_class.rb
+- test/helper.rb
+has_rdoc: