resque-scheduler-web 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e0d9ae424811136f0f35b1c596f174b5e452d56
-  data.tar.gz: 558a1cc70f5fb9262acc90eae0977f6e15917f88
+  metadata.gz: b22c9cd715e57dce44caa7853e7e08d4e350d2f4
+  data.tar.gz: 7373cef2f98ff902b01525ecd803d89cd800028a
 SHA512:
-  metadata.gz: 4a179c41dd6f5c3a9f8366e00adf05956006adcf0b1d9be60587b61607bf4c9da9deb435362d0903fb1ebf52c976003799b8b07f4ddd9ec9cc14ba523ce8ed80
-  data.tar.gz: 1a064fb3d53f6a127e95001a2284f165920a627b8b9d2d91ce69366afaa8030a252b8060e5d14e8f7b32eef300b99af7f8703f839c9a407dcf65c2ed10904fe1
+  metadata.gz: bc136875c3fe92e0bfd7901f64aa172fa3618126fe2eb0837475bbb920c4811ff5dc6a72db848d1873db0b56ebdeb14026668d1145582e044adee4e23275cf33
+  data.tar.gz: 73c33314f777d50f0a0c390f8bd59befa2430e0bccab88ab6b6488a14d355c607d6b3475304b07c54b203046514afc460a6c45158a7d7d4e94473b1f46d2152c

data/README.md

@@ -7,9 +7,22 @@
 [![Dependency Status](https://gemnasium.com/mattgibson/resque-scheduler-web.svg)](https://gemnasium.com/mattgibson/resque-scheduler-web)
 [![Build Status](https://travis-ci.org/mattgibson/resque-scheduler-web.svg?branch=master)](https://travis-ci.org/mattgibson/resque-scheduler-web)
 
-This gem provides tabs in [Resque Web](https://github.com/resque/resque-web)
-for managing [Resque Scheduler](https://github.com/resque/resque-scheduler). It uses the
-new Rails Engine approach, rather than the old Sinatra one.
+This gem provides tabs in [Resque Web](https://github.com/resque/resque-web) for managing 
+[Resque Scheduler](https://github.com/resque/resque-scheduler). 
+
+It works with any version
+of Resque and Resque Scheduler, but requires the [Resque Web gem](https://github.com/resque/resque-web),
+rather than the older [Resque Web Sinatra interface](https://github.com/resque/resque/tree/1-x-stable#the-front-end)
+that comes bundled with Resque 1.x. 
+
+This gem is a port of the old Sinatra code to the new REsque Web plugin architecture and has better test coverage 
+and a number of bug fixes compared to the older Resque Scheduler Sinatra code
+which it is based on. The only reason to use the old Sinatra interface right now is if you have other
+Resque plugins that have web interfaces that you need, but which have not been upgraded for the new Resque Web gem yet.
+
+The Sinatra interface will be deprecated when Resque 2 is released, so if you want
+to get ahead of the curve, you can start using the latest Resque Web gem today.
+
 
 ## Installation
 

data/app/controllers/resque_web/plugins/resque_scheduler/delayed_controller.rb

@@ -21,19 +21,9 @@ module ResqueWeb
           klass = Resque::Scheduler::Util.constantize(params[:klass])
           @args = params[:args] ? JSON.load(URI.decode(params[:args])) : []
 
-          # ActiveJob hack. The wrapper class does not know what queue the
-          # wrapped class wants to use, so we need to tell Resque Scheduler
-          # the queue, rather than have it use Resque's internal guessing
-          # mechanism.
-          if klass.to_s == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper'
-            queue_name = @args.first['queue_name']
-            hashed_job = Resque.send :job_to_hash_with_queue, queue_name, klass, @args
-            search = Resque.send :encode, hashed_job
-            @timestamps = Resque.instance_eval do
-              redis.smembers("timestamps:#{search}").map do |key|
-                key.tr('delayed:', '').to_i
-              end
-            end
+          if this_is_the_activejob_wrapper(klass)
+            # @timestamps = get_timestamps_for_activejob_wrapper(klass)
+            @timestamps = ActiveJobWrapperTimestampFinder.new(@args).perform
           else
             @timestamps = Resque.scheduled_at(klass, *@args)
           end
@@ -82,6 +72,12 @@ module ResqueWeb
           @size = Resque.delayed_timestamp_size(@timestamp)
           @jobs = Resque.delayed_timestamp_peek(@timestamp, @start, 20)
         end
+
+        protected
+
+        def this_is_the_activejob_wrapper(klass)
+          klass.to_s == 'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper'
+        end
       end
     end
   end

data/app/controllers/resque_web/plugins/resque_scheduler/schedules_controller.rb

@@ -12,27 +12,18 @@ module ResqueWeb
         # GET /schedule
         def index
           Resque.reload_schedule! if Resque::Scheduler.dynamic
-          jobs_in_this_env = Resque.schedule.select do |name|
-            scheduled_in_this_env?(name)
-          end
-          keys = jobs_in_this_env.keys.sort
-          @scheduled_jobs = keys.inject({}) do |jobs, job_name|
-            jobs.merge(job_name => Resque.schedule[job_name])
-          end
+          @scheduled_jobs = scheduled_jobs_in_alphabetical_order
         end
 
         # DELETE /schedule
         def destroy
-          if Resque::Scheduler.dynamic
-            job_name = params['job_name'] || params[:job_name]
-            Resque.remove_schedule(job_name)
-          end
+          Resque.remove_schedule(params[:job_name]) if Resque::Scheduler.dynamic
           redirect_to Engine.app.url_helpers.schedules_path
         end
 
         # POST /schedule/requeue
         def requeue
-          @job_name = params['job_name'] || params[:job_name]
+          @job_name = params[:job_name]
           config = Resque.schedule[@job_name]
           @parameters = config['parameters'] || config[:parameters]
           if @parameters
@@ -46,20 +37,34 @@ module ResqueWeb
         # POST /schedule/requeue_with_params
         def requeue_with_params
           config = Resque.schedule[params[:job_name]]
-          # Build args hash from post data (removing the job name)
-          submitted_args = params.reject do |key, _value|
+          new_config = original_config_merged_with_submitted_params(config)
+          Resque::Scheduler.enqueue_from_config(new_config)
+          redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+        end
+
+        protected
+
+        def original_config_merged_with_submitted_params(config)
+          existing_config_args = config['args'] || config[:args] || {}
+          new_config_args = existing_config_args.merge(submitted_params_for_job)
+          config.merge('args' => new_config_args)
+        end
+
+        # Build args hash from post data (removing the job name)
+        def submitted_params_for_job
+          params.reject do |key, _value|
             %w(job_name action controller).include?(key)
           end
+        end
 
-          # Merge constructed args hash with existing args hash for
-          # the job, if it exists
-          existing_config_args = config['args'] || config[:args] || {}
-          new_config_args = existing_config_args.merge(submitted_args)
+        def jobs_in_this_env
+          Resque.schedule.select { |name| scheduled_in_this_env?(name) }
+        end
 
-          # Insert the args hash into config and queue the resque job
-          config = config.merge('args' => new_config_args)
-          Resque::Scheduler.enqueue_from_config(config)
-          redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
+        def scheduled_jobs_in_alphabetical_order
+          jobs_in_this_env.keys.sort.inject({}) do |jobs, job_name|
+            jobs.merge(job_name => Resque.schedule[job_name])
+          end
         end
       end
     end

data/app/models/resque_web/plugins/resque_scheduler/active_job_wrapper_timestamp_finder.rb

@@ -0,0 +1,44 @@
+module ResqueWeb
+  module Plugins
+    module ResqueScheduler
+      # The way ActiveJob works breaks Resque Scheduler's method for finding
+      # the timestamps when jobs have been scheduled. This is because the
+      # queue name is stored as a parameter and is not accessible as an instance
+      # variable or via a class method. This class is used by the controller
+      # to handle the special case.
+      class ActiveJobWrapperTimestampFinder
+        def initialize(args)
+          @args = args
+        end
+
+        def perform
+          search_string = "timestamps:#{encoded_search_string}"
+          Resque.instance_eval do
+            redis.smembers(search_string).map do |key|
+              key.tr('delayed:', '').to_i
+            end
+          end
+        end
+
+        def encoded_search_string
+          Resque.send :encode, hashed_job
+        end
+
+        def hashed_job
+          Resque.send :job_to_hash_with_queue,
+                      queue_name,
+                      active_job_wrapper_class_name,
+                      @args
+        end
+
+        def queue_name
+          @args.first['queue_name']
+        end
+
+        def active_job_wrapper_class_name
+          'ActiveJob::QueueAdapters::ResqueAdapter::JobWrapper'
+        end
+      end
+    end
+  end
+end

data/lib/resque/scheduler/web/version.rb

@@ -1,7 +1,7 @@
 module Resque
   module Scheduler
     module Web
-      VERSION = '0.0.4'
+      VERSION = '1.0.0'
     end
   end
 end

data/resque-scheduler-web.gemspec

@@ -17,16 +17,17 @@ Gem::Specification.new do |spec|
                        'Resque 1.x'
   spec.homepage      = 'https://github.com/mattgibson/resque-scheduler-web'
   spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 1.9.3'
 
   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_runtime_dependency 'resque-web', '~> 0'
+  spec.add_runtime_dependency 'resque-web', '~> 0.0.8'
   spec.add_runtime_dependency 'resque-scheduler', '~> 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rails', '~> 4.2'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
@@ -35,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
   spec.add_development_dependency 'rubocop', '~> 0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.0'
-  spec.add_development_dependency 'launchy', '~> 0'
+  spec.add_development_dependency 'launchy', '~> 2.4'
   # Avoids non-thread-safe error.
   spec.add_development_dependency 'sass', '~> 3.4'
 end

data/spec/features/delayed/cancel_delayed_job_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'cancelling a delayed job' do
-
   include SharedFunctionsForFeatures
 
   scenario 'cancelling the job from the search page' do
@@ -25,4 +24,4 @@ feature 'cancelling a delayed job' do
   def and_the_job_should_not_be_present_on_the_page
     expect(page).to_not have_content 'SomeIvarJob'
   end
-end
+end

data/spec/features/delayed/clear_all_jobs_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'clearing all of the delayed jobs' do
-
   include SharedFunctionsForFeatures
 
   scenario 'clearing the jobs from the delayed index' do
@@ -20,5 +19,4 @@ feature 'clearing all of the delayed jobs' do
   def and_i_click_the_clear_all_jobs_button
     click_button 'Clear All Delayed Jobs'
   end
-
-end
+end

data/spec/features/delayed/delayed_jobs_index_page_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'seeing all the delayed jobs on the index page' do
-
   include SharedFunctionsForFeatures
 
   scenario 'delayed jobs show up on the page when at different times' do

data/spec/features/delayed/see_all_timestamps_for_a_class_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'seeing all of the timestamps where a class is delayed' do
-
   include SharedFunctionsForFeatures
 
   scenario 'viewing the timestamps page with no params' do
@@ -26,11 +25,15 @@ feature 'seeing all of the timestamps where a class is delayed' do
   end
 
   def then_i_should_be_on_the_delayed_class_page
-    expect(current_path).to eq resque_scheduler_engine_routes.delayed_job_class_path klass: 'SomeIvarJob'
+    path_params = {klass: 'SomeIvarJob'}
+    path = resque_scheduler_engine_routes.delayed_job_class_path path_params
+    expect(current_path).to eq path
   end
 
   def then_i_should_be_on_the_delayed_class_page_with_params
-    expect(current_path).to eq resque_scheduler_engine_routes.delayed_job_class_path klass: 'JobWithParams'
+    path_params = {klass: 'JobWithParams'}
+    path = resque_scheduler_engine_routes.delayed_job_class_path path_params
+    expect(current_path).to eq path
   end
 
   def and_i_should_see_the_timestamp_on_the_page
@@ -38,7 +41,9 @@ feature 'seeing all of the timestamps where a class is delayed' do
   end
 
   def given_there_is_a_delayed_job_with_params
-    Resque.enqueue_at(some_time_in_the_future, JobWithParams, argument: 'thingy')
+    Resque.enqueue_at(some_time_in_the_future,
+                      JobWithParams,
+                      argument: 'thingy')
   end
 
   def given_there_is_a_delayed_job_with_active_job
@@ -50,6 +55,8 @@ feature 'seeing all of the timestamps where a class is delayed' do
   end
 
   def then_i_should_be_on_the_timestamp_page
-    expect(current_path).to eq resque_scheduler_engine_routes.timestamp_path timestamp: some_time_in_the_future.to_i
+    path_params = { timestamp: some_time_in_the_future.to_i }
+    path = resque_scheduler_engine_routes.timestamp_path path_params
+    expect(current_path).to eq path
   end
 end

data/spec/features/delayed/send_a_delayed_job_to_the_queue_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'Sending a delayed job to the queue for immediate execution' do
-
   include SharedFunctionsForFeatures
 
   let(:queue_name) { 'ivar' }
@@ -26,4 +25,4 @@ feature 'Sending a delayed job to the queue for immediate execution' do
   def then_i_should_not_see_any_delayed_jobs
     expect(page).to have_content 'There are no delayed jobs'
   end
-end
+end

data/spec/features/navigation_spec.rb

@@ -32,5 +32,4 @@ feature 'the tabs added to the resque web interface work correctly' do
   def then_i_should_be_on_the_delayed_page
     expect(current_path).to eq resque_scheduler_engine_routes.delayed_path
   end
-
 end

data/spec/features/schedules/cannot_delete_a_job_when_the_schedule_is_static.rb

@@ -1,6 +1,6 @@
 require 'rails_helper'
-feature 'deleting a job from the dynamic schedule' do
 
+feature 'deleting a job from the dynamic schedule' do
   include SharedFunctionsForFeatures
 
   scenario 'the delete button is not present when the schedule is static' do

data/spec/features/schedules/delete_a_job_from_the_dynamic_schedule_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'deleting a job from the dynamic schedule' do
-
   include SharedFunctionsForFeatures
 
   before do

data/spec/features/schedules/requeuing_a_job_with_parameters_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'requeuing a job that has defined params' do
-
   include SharedFunctionsForFeatures
 
   before do

data/spec/features/schedules/requeuing_a_job_without_parameters_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'requeuing a job that has no params' do
-
   include SharedFunctionsForFeatures
 
   before do
@@ -42,6 +41,4 @@ feature 'requeuing a job that has no params' do
   def and_i_requeue_the_job
     click_button "requeue_job_#{job_name}"
   end
-
-
 end

data/spec/features/schedules/scheduled_jobs_index_page_spec.rb

@@ -1,7 +1,6 @@
 require 'rails_helper'
 
 feature 'Viewing the schedule page and interacting with it' do
-
   include SharedFunctionsForFeatures
 
   before do
@@ -90,5 +89,4 @@ feature 'Viewing the schedule page and interacting with it' do
   def when_i_visit_the_scheduler_page
     visit resque_scheduler_engine_routes.schedules_path
   end
-
 end

data/spec/spec_helper.rb

@@ -8,7 +8,6 @@ require 'resque-scheduler'
 require_relative 'support/functions'
 require_relative 'support/shared_steps'
 
-
 Resque::Scheduler.configure do |c|
   c.quiet = true
 end
@@ -95,4 +94,3 @@ end
 def resque_scheduler_engine_routes
   ResqueWeb::Plugins::ResqueScheduler::Engine.app.url_helpers
 end
-

data/spec/support/functions.rb

@@ -4,4 +4,4 @@ def reset_the_resque_schedule
   Resque.schedule = {}
   Resque::Scheduler.load_schedule!
   Resque::Scheduler.env = 'test'
-end
+end

data/spec/support/shared_steps.rb

@@ -1,5 +1,7 @@
+# This should be mixed in to all of the Rspec feature specs so that we can
+# avoid duplication of common functions and can be sure that Resque and the
+# queues will be reset cleanly after each scenario.
 module SharedFunctionsForFeatures
-
   def self.included(base)
     base.instance_eval do
       let(:some_time_in_the_future) { Time.now + 3600 }
@@ -44,4 +46,3 @@ module SharedFunctionsForFeatures
     expect(page).to have_content job_class
   end
 end
-

data/spec/support/test_jobs.rb

@@ -48,6 +48,8 @@ JobWithoutParams = Class.new(JobWithParams) do
   @queue = :quick
 end
 
+# Allows us to test whether jobs added via the ActiveJob wrapper are correctly
+# handled.
 class ActiveJobTest < ActiveJob::Base
   queue_as :test_queue
 
@@ -56,7 +58,6 @@ class ActiveJobTest < ActiveJob::Base
   end
 
   def perform
-
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-scheduler-web
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Matt Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-02 00:00:00.000000000 Z
+date: 2016-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque-web
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.8
 - !ruby/object:Gem::Dependency
   name: resque-scheduler
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,7 @@ files:
 - app/controllers/resque_web/plugins/resque_scheduler/schedules_controller.rb
 - app/helpers/resque_web/plugins/resque_scheduler/delayed_helper.rb
 - app/helpers/resque_web/plugins/resque_scheduler/schedules_helper.rb
+- app/models/resque_web/plugins/resque_scheduler/active_job_wrapper_timestamp_finder.rb
 - app/models/resque_web/plugins/resque_scheduler/job_finder.rb
 - app/models/resque_web/plugins/resque_scheduler/job_finder/working_job_finder.rb
 - app/views/resque_web/plugins/resque_scheduler/delayed/_next_more.erb
@@ -309,7 +310,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -317,7 +318,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: This gem provides tabs in Resque Web for managing Resque Scheduler.