resque-scheduler-web 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e03854b76a62075cb549985fff801655ebea3d5
-  data.tar.gz: c17f6ae62c750215da4aa0a57985a4187f7ff354
+  metadata.gz: 117651b5c62bac5f16c145b3f4aa0f6f38f3d9bc
+  data.tar.gz: 31af2fd0dc677d3014f097436dc1e7e2c06b577f
 SHA512:
-  metadata.gz: 7a869d83a46db7b6e5e66e0090f0d54cc2fb5e61772b4512043e5c74ba486a729fb03ce775aa8eddf563e936aca433cc1847f4bcf2efd5c8f76c25cd5df84dd8
-  data.tar.gz: b3a62b9f4cde28c559480b9aa452a4ab3ef8b984923d02417b01e66749a8aa7b734ced4949f8ba468018b83e339d1325ca71ff1592aa691dd9143d333dd1890f
+  metadata.gz: 7205b8b5e211acac1efc24d102e34fe6cb2f7c0ff5f1a187b608dedb22c7a071577e629b4bf13e8c380e00ec184e4a833455929558d6fb8b240ded5552ec1cec
+  data.tar.gz: f70ea78760c27134564163b973f2a900c6ae797f8357526f5bf0bb1abfea5c33fb2a147cf8afa04f6497ce068d7898afa16edabbea8779517d0124fdde72ea14

data/.gitignore

@@ -12,9 +12,9 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
-test/tmp
-test/dummy/log
-test/version_tmp
+spec/tmp
+spec/dummy/log
+spec/version_tmp
 tmp
 *.bundle
 *.so

data/.rubocop.yml

@@ -0,0 +1 @@
+require: rubocop-rspec

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.0
+  - 2.1.5
+  - 2.0.0
+  - 1.9.3
+
+addons:
+  code_climate:
+    repo_token: 854dad5a427f26dc32dcfafd54d1824c8f052a31c4b11fa51b5181334e53a434

data/README.md

@@ -1,5 +1,12 @@
 # Resque::Scheduler::Web
 
+[![Gem Version](https://badge.fury.io/rb/resque-scheduler-web.svg)](http://badge.fury.io/rb/resque-scheduler-web)
+[![Code Climate](https://codeclimate.com/github/mattgibson/resque-scheduler-web/badges/gpa.svg)](https://codeclimate.com/github/mattgibson/resque-scheduler-web)
+[![Test Coverage](https://codeclimate.com/github/mattgibson/resque-scheduler-web/badges/coverage.svg)](https://codeclimate.com/github/mattgibson/resque-scheduler-web)
+[![Inline docs](http://inch-ci.org/github/mattgibson/resque-scheduler-web.svg?branch=master)](http://inch-ci.org/github/mattgibson/resque-scheduler-web)
+[![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.
@@ -28,8 +35,7 @@ Web engine mounted like this in routes.rb:
 ## Running the tests
 
     cd resque-scheduler-web
-    bundle exec rspec spec
-
+    bundle exec rake
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  puts 'RSpec is not installed!'
+end

data/app/assets/stylesheets/resque_web/plugins/resque_scheduler/application.css

@@ -0,0 +1,3 @@
+.container form {
+    margin-top: 0;
+}

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

@@ -5,6 +5,7 @@ module ResqueWeb
       # application, so here, they can be run immediately, deleted from the
       # queue, or rescheduled.
       class DelayedController < ResqueWeb::ApplicationController
+        # GET /delayed
         def index
           @start = params[:start].to_i
           @number_to_show = 20
@@ -12,6 +13,9 @@ module ResqueWeb
           @timestamps = Resque.delayed_queue_peek(@start, @number_to_show)
         end
 
+        # GET /delayed/jobs/:klass
+        # Shows us all of the jobs of this type, with these args. Accessed by
+        # clicking the 'All schedules' link next to a delayed job.
         def jobs_klass
           klass = Resque::Scheduler::Util.constantize(params[:klass])
           @args = JSON.load(URI.decode(params[:args]))
@@ -20,10 +24,12 @@ module ResqueWeb
           @timestamps = []
         end
 
+        # POST /delayed/search
         def search
           @jobs = JobFinder.new(params[:search]).find_jobs
         end
 
+        # POST /delayed/cancel_now
         def cancel_now
           klass = Resque::Scheduler::Util.constantize(params['klass'])
           timestamp = params['timestamp']
@@ -32,11 +38,13 @@ module ResqueWeb
           redirect_to Engine.app.url_helpers.delayed_path
         end
 
+        # POST /delayed/clear
         def clear
           Resque.reset_delayed_queue
           redirect_to Engine.app.url_helpers.delayed_path
         end
 
+        # POST /delayed/queue_now
         def queue_now
           timestamp = params['timestamp'].to_i
           if timestamp > 0
@@ -45,10 +53,10 @@ module ResqueWeb
           redirect_to ResqueWeb::Engine.app.url_helpers.overview_path
         end
 
+        # GET /delayed/:timestamp
         def timestamp
           @timestamp = params[:timestamp].to_i
         end
-
       end
     end
   end

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

@@ -3,10 +3,13 @@ require 'resque/scheduler/server'
 module ResqueWeb
   module Plugins
     module ResqueScheduler
+      # Controller for the schedule. If it is dynamic, then the actions allow
+      # the jobs to be destroyed. Otherwise, the jobs can be manually queued
+      # for immediate execution.
       class SchedulesController < ResqueWeb::ApplicationController
-
         include Resque::Scheduler::Server::HelperMethods
 
+        # GET /schedule
         def index
           Resque.reload_schedule! if Resque::Scheduler.dynamic
           jobs_in_this_env = Resque.schedule.select do |name|
@@ -18,6 +21,7 @@ module ResqueWeb
           end
         end
 
+        # DELETE /schedule
         def destroy
           if Resque::Scheduler.dynamic
             job_name = params['job_name'] || params[:job_name]
@@ -26,6 +30,7 @@ module ResqueWeb
           redirect_to Engine.app.url_helpers.schedules_path
         end
 
+        # POST /schedule/requeue
         def requeue
           @job_name = params['job_name'] || params[:job_name]
           config = Resque.schedule[@job_name]
@@ -38,6 +43,7 @@ module ResqueWeb
           end
         end
 
+        # POST /schedule/requeue_with_params
         def requeue_with_params
           job_name = params['job_name'] || params[:job_name]
           config = Resque.schedule[job_name]

data/app/helpers/resque_web/plugins/resque_scheduler/delayed_helper.rb

@@ -1,7 +1,16 @@
 module ResqueWeb
   module Plugins
     module ResqueScheduler
+      # Helper methods for the delayed jobs UI
       module DelayedHelper
+        # Outputs the time in a human readable way.
+        #
+        # @example
+        #   format_time(Time.at(timestamp))
+        #
+        # @param t [Time]
+        # @return [String] A string in this  format: 2015-04-12 12:27:05 +0100
+        #
         def format_time(t)
           t.strftime('%Y-%m-%d %H:%M:%S %z')
         end

data/app/helpers/resque_web/plugins/resque_scheduler/schedules_helper.rb

@@ -1,16 +1,31 @@
 module ResqueWeb
   module Plugins
     module ResqueScheduler
+      # Helper methods for the schedule UI
       module SchedulesHelper
+        # Tells us whether this job is scheduled for e.g. the production env.
+        # Jobs for other environments may be in Redis but should be ignored.
+        #
+        # @param [String] name
+        # @return [true, false]
         def scheduled_in_this_env?(name)
           return true if Resque.schedule[name]['rails_env'].nil?
           rails_env(name).split(/[\s,]+/).include?(Resque::Scheduler.env)
         end
 
+        # Returns the Rails env for the Resque schedule
+        #
+        # @param [String] name
+        # @return [String]
         def rails_env(name)
           Resque.schedule[name]['rails_env']
         end
 
+        # Outputs a human readable string showing the schedule for a job when it
+        # it configured for every X interval.
+        #
+        # @param [Array] every
+        # @return [String]
         def schedule_interval_every(every)
           every = [*every]
           s = 'every: ' << every.first
@@ -24,6 +39,11 @@ module ResqueWeb
           s << meta.join(', ') << ')'
         end
 
+        # Outputs a human readable string for the UI, showing when the job is
+        # scheduled.
+        #
+        # @param [Hash] config Config hash for one job
+        # @return [String]
         def schedule_interval(config)
           if config['every']
             schedule_interval_every(config['every'])
@@ -34,6 +54,10 @@ module ResqueWeb
           end
         end
 
+        # Retrieves the class name of the job from the job config and returns it
+        #
+        # @param [Hash] config
+        # @return [String]
         def schedule_class(config)
           if config['class'].nil? && !config['custom_job_class'].nil?
             config['custom_job_class']
@@ -42,9 +66,13 @@ module ResqueWeb
           end
         end
 
+        # Returns the name of the queue that a given class uses.
+        #
+        # @param [String] class_name
+        # @return [String]
         def queue_from_class_name(class_name)
           Resque.queue_from_class(
-              Resque::Scheduler::Util.constantize(class_name)
+            Resque::Scheduler::Util.constantize(class_name)
           )
         end
       end

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

@@ -4,14 +4,19 @@ module ResqueWeb
       # This class exists to find jobs which match a search term. They may be
       # being processed, in the queue, or delayed.
       class JobFinder
-
+        # The search term that the user entered.
         attr_accessor :search_term
 
+        # @param [String] search_term
         def initialize(search_term = nil)
           @search_term = search_term || ''
           @search_term.downcase!
         end
 
+        # Finds all jobs that match the search term supplied when the class was
+        # initialized.
+        #
+        # @return [Array]
         def find_jobs
           return [] if search_term.empty?
           results = []
@@ -20,13 +25,15 @@ module ResqueWeb
           results + queued_jobs_where_class_name_matches_search_term
         end
 
+        protected
+
         def working_jobs_where_class_name_contains_search_term
           WorkingJobFinder.new(search_term).find_jobs
         end
 
         def delayed_jobs_where_class_name_contains_search_term
-          delayed_job_timestamps.inject([]) do |matching_jobs, timestamp|
-            matching_jobs + delayed_jobs_for_timestamp_that_match_search_term(timestamp)
+          delayed_job_timestamps.inject([]) do |jobs, timestamp|
+            jobs + delayed_jobs_for_timestamp_that_match_search_term(timestamp)
           end
         end
 
@@ -67,15 +74,14 @@ module ResqueWeb
         end
 
         def queued_jobs_from_queue(queue)
-          bits = Resque.peek(queue, 0, Resque.size(queue))
-          if bits.is_a? Array
-            bits
+          jobs = Resque.peek(queue, 0, Resque.size(queue))
+          if jobs.is_a? Array
+            jobs
           else
-            [bits]
+            [jobs]
           end
         end
-
       end
     end
   end
-end
+end

data/app/models/resque_web/plugins/resque_scheduler/job_finder/working_job_finder.rb

@@ -4,15 +4,32 @@ module ResqueWeb
       class JobFinder
         # This class finds working jobs that Resque is currently processing
         class WorkingJobFinder
-
+          # The terms that the user entered.
           attr_accessor :search_term
 
+          # The search term will be used to match against the class name of any
+          # jobs that are currently being processed by any of the workers.
+          #
+          # @param search_term [String]
           def initialize(search_term)
             @search_term = search_term
           end
 
+          # Finds all jobs that match the search term provided when the class
+          # was instantiated.
+          #
+          # [
+          #   {
+          #     'class' => 'SomeClass',
+          #     'queue' => 'some_queue',
+          #     'where_at' => 'working'
+          #   }
+          # ]
+          #
+          # @return [Array] Returns an array of hashes.
+          #
           def find_jobs
-            workers_with_jobs_that_match_search_term.collect do |w|
+            workers_with_jobs_that_match_search_term.map do |w|
               w.job['payload'].merge(
                 'queue' => w.job['queue'],
                 'where_at' => 'working'
@@ -20,6 +37,8 @@ module ResqueWeb
             end
           end
 
+          protected
+
           def workers_with_jobs_that_match_search_term
             all_working_jobs.select do |w|
               w.job &&
@@ -28,8 +47,6 @@ module ResqueWeb
             end
           end
 
-          protected
-
           def all_working_jobs
             [*Resque.working]
           end
@@ -37,4 +54,4 @@ module ResqueWeb
       end
     end
   end
-end
+end

data/app/views/resque_web/plugins/resque_scheduler/delayed/index.erb

@@ -23,7 +23,7 @@
     <th>All schedules</th>
   </tr>
   <% @timestamps.each do |timestamp| %>
-    <tr>
+    <tr class="delayed-job">
       <td>
         <form action="<%= queue_now_path %>" method="post">
           <input type="hidden" name="timestamp" value="<%= timestamp.to_i %>">

data/lib/resque/scheduler/web.rb

@@ -1,4 +1,4 @@
-require "resque/scheduler/web/version"
+require 'resque/scheduler/web/version'
 
 require 'resque_web'
 require 'resque/scheduler'

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

@@ -1,7 +1,7 @@
 module Resque
   module Scheduler
     module Web
-      VERSION = "0.0.1"
+      VERSION = '0.0.2'
     end
   end
 end

data/lib/resque_web/plugins/resque_scheduler/engine.rb

@@ -3,16 +3,12 @@ require 'resque_web'
 module ResqueWeb
   module Plugins
     module ResqueScheduler
+      # Main engine class for the Resque Scheduler Web plugin.
       class Engine < ::Rails::Engine
         isolate_namespace ResqueWeb::Plugins::ResqueScheduler
-
-        # paths['app'] << 'app'
-        # paths['app/helpers'] << 'app/helpers'
-        # paths['app/views'] << 'app/views'
-        # paths['app/controllers'] << 'app/controllers'
-        # paths['app/models'] << 'app/models'
       end
 
+      # Draws the routes for the engine.
       Engine.routes do
         get 'schedule', to: 'schedules#index', as: 'schedules'
         post 'schedule/requeue', to: 'schedules#requeue', as: 'requeue'
@@ -32,10 +28,18 @@ module ResqueWeb
         post '/delayed/clear', to: 'delayed#clear', as: 'clear'
       end
 
+      # provides the path where the engine will live. This is appended after
+      # the main resque-web path.
+      #
+      # @return [String]
       def self.engine_path
         '/scheduler'
       end
 
+      # Tells Resque web what extra tabs to ass to the main navigation at the
+      # top of the resque-web interface.
+      #
+      # @return [Array]
       def self.tabs
         [
           {