active_scheduler 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c723aa094616a7530ea528c8910f5abfe695d91b
-  data.tar.gz: a8286d5ebc009739893d72912fc3534158161dbe
+SHA256:
+  metadata.gz: 3073d561f9035ada866836665d88d99bb7a23badd33171706a7f84c7f0b97a58
+  data.tar.gz: 5b50684ed4c4882d05ebc42b44f09d6f252333884c01177cc379c335324d684f
 SHA512:
-  metadata.gz: 42cc510cc65ff67895469f65ee436024faeaf4b064bf2e18e2264219ba89b55603c6f0f489008838db3e8c6bf107dcbc771d986d0e1599ab4e19b41e751ba4d3
-  data.tar.gz: 71cba03ce129f5a22a5b948f71a3cc3428d0a09939c0df418c77ce364e43d3251a6f2aae43c3639c1c9a0c38425e6d44ce0e0e7d89c58cbc9d0e46a93b73ba2f
+  metadata.gz: 16df38caebab620ed732b88ae40b6296b05afb7d1d78ed62b116a9cfebc55e281908935f886447c1380f405f323e4848d1594815f5ba069b45f7f9187dd520b5
+  data.tar.gz: 3c72338f022ef31687ffd9085f32bbaf21c318cad169e1fc17feff73c55ee5445fe23e28cfbad2197da1d18c74e60b291fd5df2d5b48ce9faa95890515a6fc01

data/.gitignore

@@ -22,3 +22,4 @@
 .DS_Store
 /.rvmrc
 /.yardoc
+.idea/

data/.travis.yml

@@ -1,15 +1,48 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.5
-  - 2.2.0
-matrix:
-  allow_failures:
-    - rvm: 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
 env:
   - "RAILS_VERSION=4.2.0"
+  - "RAILS_VERSION=5.0.0"
+  - "RAILS_VERSION=5.1.0"
+  - "RAILS_VERSION=5.2.0"
+  - "RAILS_VERSION=6.0.0"
+matrix:
+  exclude:
+    - rvm: 2.0
+      env: "RAILS_VERSION=5.0.0"
+    - rvm: 2.0
+      env: "RAILS_VERSION=5.1.0"
+    - rvm: 2.0
+      env: "RAILS_VERSION=5.2.0"
+    - rvm: 2.0
+      env: "RAILS_VERSION=6.0.0"
+    - rvm: 2.1
+      env: "RAILS_VERSION=5.0.0"
+    - rvm: 2.1
+      env: "RAILS_VERSION=5.1.0"
+    - rvm: 2.1
+      env: "RAILS_VERSION=5.2.0"
+    - rvm: 2.1
+      env: "RAILS_VERSION=6.0.0"
+    - rvm: 2.2
+      env: "RAILS_VERSION=5.1.0"
+    - rvm: 2.2
+      env: "RAILS_VERSION=6.0.0"
+    - rvm: 2.3
+      env: "RAILS_VERSION=6.0.0"
+    - rvm: 2.4
+      env: "RAILS_VERSION=4.2.0"
+    - rvm: 2.4
+      env: "RAILS_VERSION=6.0.0"
+
 notifications:
   email:
     recipients:

data/CHANGELOG.markdown

@@ -1,9 +1,33 @@
+# 0.7.0
+- Remove deprecated Rubyforge reference [#19](https://github.com/JustinAiken/active_scheduler/pull/19) (Thanks @kensentor)
+- Implement ActiveScheduler::ResqueWrapper.scheduled [#17](https://github.com/JustinAiken/active_scheduler/pull/17) (Thanks @AMHOL)
+
+# 0.6.0
+
+- Add `persist` option [#15](https://github.com/JustinAiken/active_scheduler/pull/15) (Thanks @SpiffyStores)
+- Remove hardcoded class references [#16](https://github.com/JustinAiken/active_scheduler/pull/16) (Thanks @kensentor)
+
+# 0.5.0
+- Expand Travis matrix to include Rails 5 and more ruby versions
+- Allow `rails_env` option since [resque-scheduler](https://github.com/resque/resque-scheduler) does [#10](https://github.com/JustinAiken/active_scheduler/pull/10) (Thanks @blahutka)
+
+# 0.4.0
+- Use job's queue instead of hardcoded `default` [#9](https://github.com/JustinAiken/active_scheduler/pull/9) (Thanks @r3trofitted)
+
+# 0.3.0
+
+- Remove explicit active_support dependency (it's pulled in by activejob)
+- Updated testing matrix for more rubies 💎💎💎
+- Support named args [#6](https://github.com/JustinAiken/active_scheduler/pull/6) (Thanks @jdguzman)
+
 # 0.2.0
 
-- Deprecate `arguments` in favor of `args` [#5](https://github.com/JustinAiken/active_scheduler/pull/5)
+- Deprecate `arguments` in favor of `args` [#5](https://github.com/JustinAiken/active_scheduler/pull/5) (Thanks @ximus)
 
 # 0.1.0
 
-- Only wrap jobs that are descendants of `ActiveJob::Base` [#3](https://github.com/JustinAiken/active_scheduler/pull/3)
+- Only wrap jobs that are descendants of `ActiveJob::Base` [#3](https://github.com/JustinAiken/active_scheduler/pull/3) (Thanks @ximus)
 
 # 0.0.3
+
+- Use schedule name as class name if unspecified [#1](https://github.com/JustinAiken/active_scheduler/pull/1) (Thanks @jeremycrosbie)

data/Gemfile

@@ -4,6 +4,10 @@ rails_version = ENV['RAILS_VERSION'] || '4.2.0'
 rails         = "~> #{rails_version}"
 
 gem "activejob",     rails
-gem "activesupport", rails
+
+gem "guard-rspec", '~> 4.2' unless ENV['CI']
+
+# Randomly grabbed 'tins' version doesn't like ancient rubies
+gem "tins", '~> 1.6.0' if RUBY_VERSION == '1.9.3'
 
 gemspec

data/README.markdown

@@ -8,9 +8,10 @@ Currently only Resque is supported, but pull requests to add other queues (sidek
 
 ## Requirements/Support
 
-- Rails
-  - ActiveJob 4.2+
-  - ActiveSupport 4.2+
+- Ruby 2.0+
+- ActiveJob
+  - 4.2 is tested and used in production
+  - 5.0-6.0 is tested against CI, but I haven't tried it in production.
 - Resque
 - Resque Scheduler
 
@@ -57,11 +58,36 @@ ThisIsTheClass:
 
 Only classes that are descended from `ActiveJob::Base` will be wrapped
 
+### Job Classes With Named Args
+
+If you have a job class that uses named arguments you can specify that. `args`
+should be a hash nested in the array and you need to add the named_args key.
+
+```yaml
+simple_job:
+  every: "30s"
+  queue: "simple"
+  class: "SimpleJob"
+  args:
+    - foo: 1
+      bar: 2
+  description: "It's a simple job."
+  named_args: true
+```
+
 ## Credits
 
 - Written by [@JustinAiken](https://www.github.com/JustinAiken)
 - Wrapper class idea by [@ryanwjackson](https://www.github.com/ryanwjackson)
-- Special thanks to [Rocketmade](http://www.rocketmade.com/) for development resources.
+- Special thanks to [Rocketmade](https://www.rocketmade.com/) for development resources.
+- Other Contributors:
+  - [@jeremycrosbie](https://github.com/jeremycrosbie)
+  - [@ximus](https://github.com/ximus)
+  - [@jdguzman](https://github.com/jdguzman)
+  - [@r3trofitted](https://github.com/r3trofitted)
+  - [@blahutka](https://github.com/blahutka)
+  - [@SpiffyStores](https://github.com/SpiffyStores)
+  - [@kensentor](https://github.com/kensentor)
 
 ## License
 

data/active_scheduler.gemspec

@@ -6,22 +6,18 @@ Gem::Specification.new do |s|
   s.name        = "active_scheduler"
   s.version     = ActiveScheduler::VERSION
   s.authors     = ["Justin Aiken"]
-  s.email       = ["jaiken@rocketmade.com"]
+  s.email       = ["60tonangel@gmail.com"]
   s.license     = 'MIT'
   s.homepage    = "https://github.com/JustinAiken/active_scheduler"
   s.summary     = %q{Scheduling for ActiveJob}
   s.description = %q{A wrapper for scheduling jobs through ActiveJob}
 
-  s.rubyforge_project = "active_scheduler"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency             'activejob',     '>= 4.2.0'
-  s.add_dependency             'activesupport', '>= 4.2.0'
-
-  s.add_development_dependency 'rspec-rails',   '~> 3.1'
-  s.add_development_dependency 'guard-rspec',   '~> 4.2'
+  s.add_dependency             'rake'
+  s.add_dependency             'activejob', '>= 4.2.0'
+  s.add_development_dependency 'rspec',     '~> 3.5'
   s.add_development_dependency 'coveralls'
 end

data/lib/active_scheduler.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_job'
 require 'active_scheduler/version'
 require 'active_scheduler/resque_wrapper'

data/lib/active_scheduler/resque_wrapper.rb

@@ -3,24 +3,38 @@ module ActiveScheduler
 
     def self.perform(job_data)
       klass = Object.const_get job_data['job_class']
+      named_args = job_data.delete('named_args') || false
 
       if job_data.has_key? 'arguments'
-        klass.perform_later *job_data['arguments']
+        if named_args
+          args = job_data['arguments'].first.symbolize_keys
+        else
+          args = job_data['arguments']
+        end
+
+        named_args ? klass.perform_later(**args) : klass.perform_later(*args)
       else
         klass.perform_later
       end
     end
 
+    def self.scheduled(_queue, _wrapper_klass, *args)
+      perform(*args)
+    end
+
     def self.wrap(schedule)
       schedule = HashWithIndifferentAccess.new(schedule)
 
       schedule.each do |job, opts|
         class_name = opts[:class] || job
-        next if class_name =~ /ActiveScheduler::ResqueWrapper/
-        next unless class_name.constantize <= ActiveJob::Base
+        next if class_name =~ /#{self.to_s}/
+
+        klass = class_name.constantize
+        next unless klass <= ActiveJob::Base
 
-        queue = opts[:queue] || 'default'
+        queue = opts[:queue] || klass.queue_name
         args = opts[:args]
+        named_args = opts[:named_args] || false
 
         if !args && opts.has_key?(:arguments)
           warn 'active_scheduler: [DEPRECATION] using the `arguments` key in ' \
@@ -30,18 +44,22 @@ module ActiveScheduler
         end
 
         schedule[job] = {
-          class:        'ActiveScheduler::ResqueWrapper',
+          class:        self.to_s,
           queue:        queue,
           args: [{
-            job_class:  class_name,
-            queue_name: queue,
-            arguments:  args
-          }]
+                   job_class:  class_name,
+                   queue_name: queue,
+                   arguments:  args,
+                 }]
         }
 
+        schedule[job][:args].first.merge!({ named_args: named_args }) if named_args
+
         schedule[job][:description] = opts.fetch(:description, nil) if opts.fetch(:description, nil)
         schedule[job][:every]       = opts.fetch(:every, nil)       if opts.fetch(:every, nil)
         schedule[job][:cron]        = opts.fetch(:cron, nil)        if opts.fetch(:cron, nil)
+        schedule[job][:rails_env]   = opts.fetch(:rails_env, nil)   if opts.fetch(:rails_env, nil)
+        schedule[job][:persist]     = true                          if opts.fetch(:persist, nil)
       end
     end
   end

data/lib/active_scheduler/version.rb

@@ -1,3 +1,3 @@
 module ActiveScheduler
-  VERSION = "0.2.0"
+  VERSION = "0.7.0"
 end

data/spec/active_scheduler/resque_wrapper_spec.rb

@@ -15,6 +15,7 @@ describe ActiveScheduler::ResqueWrapper do
           "queue"       => "simple",
           "description" => "It's a simple job.",
           "every"       => "30s",
+          "rails_env"   => "test",
           "args"        => [{
             "job_class"  => "SimpleJob",
             "queue_name" => "simple",
@@ -31,10 +32,34 @@ describe ActiveScheduler::ResqueWrapper do
             "queue"       => "simple",
             "description" => "It's a simple job.",
             "every"       => "30s",
+            "rails_env"   => "test",
             "args"        => ['foo-arg-1', 'foo-arg-2'],
           )
         end
       end
+
+      context 'with a custom wrapper class' do
+        class CustomWrapper < ActiveScheduler::ResqueWrapper
+        end
+
+        let(:schedule) { YAML.load_file 'spec/fixtures/simple_job.yaml' }
+
+        it "queues up a simple job" do
+          stub_jobs("SimpleJob")
+          expect(CustomWrapper.wrap(schedule)['simple_job']).to eq(
+            "class"       => "CustomWrapper",
+            "queue"       => "simple",
+            "description" => "It's a simple job.",
+            "every"       => "30s",
+            "rails_env"   => "test",
+            "args"        => [{
+               "job_class"  => "SimpleJob",
+               "queue_name" => "simple",
+               "arguments"  => ['foo-arg-1', 'foo-arg-2'],
+              }]
+           )
+        end
+      end
     end
 
     context "with a simple job json" do
@@ -56,6 +81,27 @@ describe ActiveScheduler::ResqueWrapper do
       end
     end
 
+    context "with a persist key" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/persist_job.yaml' }
+
+      it "queues up a simple job" do
+        stub_jobs("SimpleJob")
+        expect(wrapped['persist_job']).to eq(
+          "class"       => "ActiveScheduler::ResqueWrapper",
+          "queue"       => "simple",
+          "description" => "It's a simple job. That persists.",
+          "every"       => "30s",
+          "rails_env"   => "test",
+          "persist"     => true,
+          "args"        => [{
+            "job_class"  => "SimpleJob",
+            "queue_name" => "simple",
+            "arguments"  => ['foo-arg-1', 'foo-arg-2'],
+          }]
+        )
+      end
+    end
+
     context "with a multiple jobs in the schedule" do
       let(:schedule) { YAML.load_file 'spec/fixtures/two_jobs.yaml' }
 
@@ -79,9 +125,14 @@ describe ActiveScheduler::ResqueWrapper do
     context "when the queue is blank" do
       let(:schedule) { YAML.load_file 'spec/fixtures/no_queue.yaml' }
 
-      it "uses 'default'" do
-        stub_jobs("SimpleJob")
-        expect(wrapped['no_queue_job']['queue']).to eq 'default'
+      it "uses the job's queue" do
+        simple_job = Class.new(ActiveJob::Base) do
+          queue_as :myscheduledjobqueue
+        end
+
+        stub_const("SimpleJob", simple_job)
+
+        expect(wrapped['no_queue_job']['queue']).to eq 'myscheduledjobqueue'
       end
     end
 
@@ -103,6 +154,26 @@ describe ActiveScheduler::ResqueWrapper do
         )
       end
     end
+
+    context "when the schedule is for a job with named arguments" do
+      let(:schedule) { YAML.load_file 'spec/fixtures/named_args_job.yaml' }
+
+      it "queues up a job, specifing that there are named args in the job" do
+        stub_jobs("NamedArgsJob")
+        expect(wrapped['named_args_job']).to eq(
+          "class"       => "ActiveScheduler::ResqueWrapper",
+          "queue"       => "simple",
+          "description" => "It's a named args job.",
+          "every"       => "30s",
+          "args"        => [{
+            "job_class"  => "NamedArgsJob",
+            "queue_name" => "simple",
+            "arguments"  => [{'foo' => 1, 'bar' => 2}],
+            "named_args" => true
+          }]
+        )
+      end
+    end
   end
 
   describe ".perform" do
@@ -124,5 +195,36 @@ describe ActiveScheduler::ResqueWrapper do
         expect(TestKlass).to receive(:perform_later).with 1, 2
       end
     end
+
+    context "with named_arguments specified" do
+      let(:job_data) do
+        {
+          'job_class' => 'TestKlass',
+          'arguments' => [{ 'foo' => 1, 'bar' => 2 }],
+          'named_args' => true
+        }
+      end
+
+      it "passed the arguments as Named args" do
+        expect(TestKlass).to receive(:perform_later).with(foo: 1, bar: 2)
+      end
+    end
+  end
+
+  describe '.scheduled' do
+    let(:queue_name) { 'test_queue' }
+    let(:job_data) { {'job_class' => 'TestKlass'} }
+
+    before do
+      allow(described_class).to receive(:perform)
+    end
+
+    after do
+      described_class.scheduled(queue_name, described_class, job_data)
+    end
+
+    it 'delegates to .perform with job_data' do
+      expect(described_class).to receive(:perform).with(job_data)
+    end
   end
 end

data/spec/fixtures/named_args_job.yaml

@@ -0,0 +1,9 @@
+named_args_job:
+  every: "30s"
+  queue: "simple"
+  class: "NamedArgsJob"
+  args:
+    - foo: 1
+      bar: 2
+  description: "It's a named args job."
+  named_args: true

data/spec/fixtures/persist_job.yaml

@@ -0,0 +1,10 @@
+persist_job:
+  every: "30s"
+  queue: "simple"
+  class: "SimpleJob"
+  rails_env: "test"
+  args:
+    - foo-arg-1
+    - foo-arg-2
+  description: "It's a simple job. That persists."
+  persist: true

data/spec/fixtures/simple_job.yaml

@@ -2,6 +2,7 @@ simple_job:
   every: "30s"
   queue: "simple"
   class: "SimpleJob"
+  rails_env: "test"
   args:
     - foo-arg-1
     - foo-arg-2

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: active_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Aiken
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-08 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activejob
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,33 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +68,7 @@ dependencies:
         version: '0'
 description: A wrapper for scheduling jobs through ActiveJob
 email:
-- jaiken@rocketmade.com
+- 60tonangel@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -102,7 +88,9 @@ files:
 - lib/active_scheduler/version.rb
 - spec/active_scheduler/resque_wrapper_spec.rb
 - spec/fixtures/cron_job.yaml
+- spec/fixtures/named_args_job.yaml
 - spec/fixtures/no_queue.yaml
+- spec/fixtures/persist_job.yaml
 - spec/fixtures/schedule_name_is_class_name.yaml
 - spec/fixtures/simple_job.json
 - spec/fixtures/simple_job.yaml
@@ -112,7 +100,7 @@ homepage: https://github.com/JustinAiken/active_scheduler
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,10 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: active_scheduler
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Scheduling for ActiveJob
 test_files: []
-has_rdoc: