sidekiq_status 1.0.4 → 1.0.5

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.0.0
 #  - jruby-19mode # JRuby in 1.9 mode
 #  - rbx-19mode
 env:
@@ -9,11 +10,10 @@ env:
     - SHOW_SIDEKIQ=true
   matrix:
     - SIDEKIQ_VERSION="~>2.4.0"
-    - SIDEKIQ_VERSION="~>2.5.4"
     - SIDEKIQ_VERSION="~>2.6.5"
-    - SIDEKIQ_VERSION="~>2.7.5"
     - SIDEKIQ_VERSION="~>2.8.0"
-    - SIDEKIQ_VERSION="~>2.9.0"
     - SIDEKIQ_VERSION="~>2.10.0"
-    - SIDEKIQ_VERSION="~>2.11.0"
+    - SIDEKIQ_VERSION="~>2.12.0"
+    - SIDEKIQ_VERSION="~>2.13.0"
+    - SIDEKIQ_VERSION="~>2.14.0"
 script: bundle exec rake

data/Gemfile

@@ -4,4 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'sidekiq', ENV['SIDEKIQ_VERSION'] if ENV['SIDEKIQ_VERSION']
+gem 'activesupport', '< 4.0.0' if RUBY_VERSION < '1.9.3'
+gem 'coveralls', require: false
 

data/README.md

@@ -1,7 +1,8 @@
 # SidekiqStatus
 
-[![Build Status](https://secure.travis-ci.org/cryo28/sidekiq_status.png)](http://travis-ci.org/cryo28/sidekiq_status)
+[![Build Status](https://travis-ci.org/cryo28/sidekiq_status.png?branch=master)](https://travis-ci.org/cryo28/sidekiq_status)
 [![Dependency Status](https://gemnasium.com/cryo28/sidekiq_status.png)](https://gemnasium.com/cryo28/sidekiq_status)
+[![Test coverage](https://coveralls.io/repos/cryo28/sidekiq_status/badge.png?branch=master)](https://coveralls.io/r/cryo28/sidekiq_status)
 
 Sidekiq extension to track job execution statuses and returning job results back to the client in a convenient manner
 
@@ -146,13 +147,26 @@ and clean status containers.
 
 ## Changelog
 
+### 1.0.5
+
+   * Sidekiq 2.14 support
+   * Do not create (and display in sidekiq_status/web) status containers
+     for the jobs scheduled to run in the future
+     by the means of perform_at/perform_in (mhfs)
+   * Sidekiq web templates converted from .slim to .erb
+   * Allow specifying worker name as a String (gumayunov)
+   * Added ruby 2.0 to travis build matrix
+   * Don't be too smart in extending Sinatra template search path (springbok)
+   * Show worker names and adjust sidekiq-web template tags to conform 
+     to Sidekiq conventions (mhfs)
+
 ### 1.0.4
 
    * Sidekiq 2.10 and 2.11 support  
 
 ### 1.0.3
 
-   * Include SidekiqStatus::Web app into Sidekiq::Web app unobtrusively (Peter Fern)
+   * Include SidekiqStatus::Web app into Sidekiq::Web app unobtrusively (pdf)
    * sidekiq 2.8.0 and 2.9.0 support
 
 ### 1.0.2
@@ -172,8 +186,7 @@ and clean status containers.
 ## Roadmap
 
    * Add some sidekiq-web specs
-
-
+   * Support running inline with sidekiq/testing
 
 ## Contributing
 

data/lib/sidekiq_status/client_middleware.rb

@@ -3,8 +3,24 @@
 module SidekiqStatus
   class ClientMiddleware
     def call(worker, item, queue)
+      worker = worker.constantize if worker.is_a?(String)
       return yield unless worker < SidekiqStatus::Worker
 
+      # Don't start reporting status if the job is scheduled for the future
+      # When perform_at/perform_in is called this middleware is invoked within the client process
+      # and job arguments have 'at' parameter. If all middlewares pass the job
+      # Sidekiq::Client#raw_push puts the job into 'schedule' sorted set.
+      #
+      # Later, Sidekiq server ruby process periodically polls this sorted sets and repushes all
+      # scheduled jobs which are due to run. This repush invokes all client middlewares, but within
+      # sidekiq server ruby process.
+      #
+      # Luckily for us, when job is repushed, it doesn't have 'at' argument.
+      # So we can distinguish the condition of the middleware invokation: we don't create SidekiqStatus::Container
+      # when job is scheduled to run in the future, but we create status container when previously scheduled
+      # job is due to run.
+      return yield if item['at']
+
       jid  = item['jid']
       args = item['args']
       item['args'] = [jid]
@@ -22,4 +38,4 @@ module SidekiqStatus
       raise exc
     end
   end
-end
+end

data/lib/sidekiq_status/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module SidekiqStatus
   # SidekiqStatus version
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

data/lib/sidekiq_status/web.rb

@@ -7,11 +7,9 @@ module SidekiqStatus
     # @param [Sidekiq::Web] app
     def self.registered(app)
       app.helpers do
-        # Calls the given block for every possible template file in views,
-        # named name.ext, where ext is registered on engine.
-        def find_template(views, name, engine, &block)
-          super(VIEW_PATH, name, engine, &block)
-          super
+        def sidekiq_status_template(name)
+          path = File.join(VIEW_PATH, name.to_s) + ".erb"
+          File.open(path).read
         end
       end
 
@@ -26,12 +24,12 @@ module SidekiqStatus
         pageidx = @current_page - 1
         @statuses = SidekiqStatus::Container.statuses(pageidx * @count, (pageidx + 1) * @count)
 
-        render(:slim, :statuses)
+        erb(sidekiq_status_template(:statuses))
       end
 
       app.get '/statuses/:jid' do
         @status = SidekiqStatus::Container.load(params[:jid])
-        render(:slim, :status)
+        erb(sidekiq_status_template(:status))
       end
 
       app.get '/statuses/:jid/kill' do

data/sidekiq_status.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SidekiqStatus::VERSION
 
-  gem.add_runtime_dependency("sidekiq", ">= 2.4", "<= 2.12")
+  gem.add_runtime_dependency("sidekiq", ">= 2.4", "< 2.15")
 
   gem.add_development_dependency("activesupport")
   gem.add_development_dependency("rspec")

data/spec/client_middleware_spec.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe SidekiqStatus::ClientMiddleware do
+  describe "cryo28/sidekiq_status#11 regression" do
+    describe "#call" do
+      before do
+        SidekiqStatus::Container.should_receive(:create).with(hash_including('worker' => 'TestWorker1'))
+      end
+
+      it "accepts a worker class" do
+        subject.call(TestWorker1, {}, nil) do
+        end
+      end
+
+      it "accepts a worker name string" do
+        subject.call("TestWorker1", {}, nil) do
+        end
+      end
+    end
+  end
+
+  it "does not create container for scheduled job" do
+    SidekiqStatus::Container.should_not_receive(:create)
+
+    subject.call("TestWorker1", { "at" => Time.now }, nil) do
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,6 +10,9 @@ SimpleCov.start do
   root GEM_ROOT
 end
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'sidekiq_status'
 require 'sidekiq/util'
 

data/spec/worker_spec.rb

@@ -133,7 +133,8 @@ describe Sidekiq::Worker do
 
       worker_thread = Thread.new{ worker.perform(jid) }
       checker_thread = Thread.new do
-        wait{ container.reload.working? }
+        wait{ container.reload.working? && container.at == 50 }
+
         container.at.should      == 50
         container.total.should   == 200
         container.message.should == '25% done'

data/web/views/status.erb

@@ -0,0 +1,65 @@
+<h3 class="wi">
+  Job <%= @status.jid %> is <%= @status.status %> (<%= @status.pct_complete %>% done)
+</h3>
+<p class="intro"></p>
+
+<div id="status_<%= @status.jid %>" rel="<%= @status.status %>">
+  <h4>Details</h4>
+  <div>
+    <table class="table table-striped table-bordered">
+      <thead>
+        <tr>
+          <th>Attribute</th>
+          <th>Value</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>jid</td>
+          <td><%= @status.jid %></td>
+        </tr>
+        <tr>
+          <td>worker</td>
+          <td><%= @status.worker %></td>
+        </tr>
+        <tr>
+          <td>status</td>
+          <td><%= @status.status %></td>
+        </tr>
+        <tr>
+          <td>last updated at</td>
+          <td><%= @status.last_updated_at %></td>
+        </tr>
+        <tr>
+          <td>at</td>
+          <td><%= @status.at %></td>
+        </tr>
+        <tr>
+          <td>total</td>
+          <td><%= @status.total %></td>
+        </tr>
+        <tr>
+          <td>message</td>
+          <td><%= @status.message %></td>
+        </tr>
+        <tr>
+          <td>payload</td>
+          <td>
+            <code class="prettyprint" language="javascript">
+              <%= @status.payload.to_json %>
+            </code>
+          </td>
+        </tr>
+        <tr>
+          <td>job args</td>
+          <td>
+            <code class="prettyprint" language="javascript">
+              <%= @status.args.to_json %>
+            </code>
+          </td>
+        </tr>
+      </tbody>
+    </table>
+    <a href="<%= to(:statuses) %>">Back</a>
+  </div>
+</div>

data/web/views/statuses.erb

@@ -0,0 +1,63 @@
+<h3 class="wi">Recent job statuses</h3>
+
+<div class="delete_jobs">
+  Delete jobs in&nbsp;
+  <a href="<%= to(:statuses) %>/delete/complete" onclick="return confirm('Are you sure? Delete is irreversible')">
+    complete
+  </a>
+  ,&nbsp;
+  <a href="<%= to(:statuses) %>/delete/finished" onclick="return confirm('Are you sure? Delete is irreversible')" title="<%= SidekiqStatus::Container::FINISHED_STATUS_NAMES.join(', ') %>">
+    finished
+  </a>
+  ,&nbsp;
+  <a href="<%= to(:statuses) %>/delete/all"      onclick="return confirm('Are you sure? Delete is irreversible')">
+    all
+  </a>
+  &nbsp;statuses
+</div>
+
+<table class="table table-striped table-bordered">
+  <tr>
+    <th>Worker/jid</th>
+    <th>Status</th>
+    <th>Last Updated ↆ</th>
+    <th>Progress</th>
+    <th>Message</th>
+    <th>Actions</th>
+  </tr>
+  <% @statuses.each do |container| -%>
+    <tr>
+      <td>
+        <a href="<%= to(:statuses) %>/<%= container.jid %>">
+          <%= container.worker %>
+          <br />
+          <%= container.jid %>
+        </a>
+      </td>
+      <td><%= container.status %></td>
+      <td><%= container.last_updated_at %></td>
+      <td>
+        <div class="progress progress-striped" style="margin-bottom: 0">
+          <div class="bar" style="width: <%= container.pct_complete %>%; text-shadow: 1px 1px 1px black">
+            <%= container.pct_complete %>%
+          </div>
+        </div>
+      <td><%= container.message %></td>
+      <td>
+        <% if container.killable? -%>
+          <a class="kill" href="<%= to(:statuses) %>/<%= container.jid %>/kill" onclick="return confirm('Are you sure?')">Kill</a>
+        <% elsif container.kill_requested? -%>
+          Kill requested
+        <% end %>
+      </td>
+    </tr>
+  <% end -%>
+  <% if @statuses.empty? -%>
+    <tr>
+      <td colspan="6"></td>
+    </tr>
+  <% end -%>
+</table>
+
+
+<%= erb :_paging, :locals => { :url => "#{root_path}statuses" } %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_status
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -19,9 +19,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.4'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,9 +30,9 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.4'
-    - - <=
+    - - <
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -169,6 +169,7 @@ files:
 - lib/sidekiq_status/worker.rb
 - log/.gitkeep
 - sidekiq_status.gemspec
+- spec/client_middleware_spec.rb
 - spec/container_spec.rb
 - spec/dummy/app/workers/test_worker1.rb
 - spec/dummy/app/workers/test_worker2.rb
@@ -176,8 +177,8 @@ files:
 - spec/integration/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/worker_spec.rb
-- web/views/status.slim
-- web/views/statuses.slim
+- web/views/status.erb
+- web/views/statuses.erb
 homepage: https://github.com/cryo28/sidekiq_status
 licenses: []
 post_install_message: 
@@ -204,6 +205,7 @@ specification_version: 3
 summary: A Sidekiq extension to track job execution statuses and return job results
   back to the client in a convenient manner
 test_files:
+- spec/client_middleware_spec.rb
 - spec/container_spec.rb
 - spec/dummy/app/workers/test_worker1.rb
 - spec/dummy/app/workers/test_worker2.rb

data/web/views/status.slim

@@ -1,44 +0,0 @@
-h1.wi
-  | Job #{@status.jid} is #{@status.status} (#{@status.pct_complete}% done)
-p.intro
-
-div id="status_#{@status.jid}" rel="#{@status.status}"
-  h2 Details
-  div
-    table class="table table-striped table-bordered"
-      thead
-        tr
-          th Attribute
-          th Value
-      tbody
-        tr
-          td jid
-          td= @status.jid
-        tr
-          td status
-          td= @status.status
-        tr
-          td last updated at
-          td= @status.last_updated_at
-        tr
-          td at
-          td= @status.at
-        tr
-          td total
-          td= @status.total
-        tr
-          td message
-          td= @status.message
-        tr
-          td payload
-          td
-            code class="prettyprint language-javascript"
-              = @status.payload.to_json
-        tr
-          td job args
-          td
-            code class="prettyprint language-javascript"
-              = @status.args.to_json
-
-    a href=(to(:statuses)) Back
-

data/web/views/statuses.slim

@@ -1,41 +0,0 @@
-h1.wi Recent job statuses
-
-div.delete_jobs
-  | Delete jobs in 
-  a href="#{to(:statuses)}/delete/complete" onclick="return confirm('Are you sure? Delete is irreversible')" = "complete"
-  |, 
-  a href="#{to(:statuses)}/delete/finished" onclick="return confirm('Are you sure? Delete is irreversible')" title="#{SidekiqStatus::Container::FINISHED_STATUS_NAMES.join(', ')}" = "finished"
-  |, 
-  a href="#{to(:statuses)}/delete/all"      onclick="return confirm('Are you sure? Delete is irreversible')" = "all"
-  | statuses
-
-table class="table table-striped table-bordered"
-  tr
-    th jid
-    th Status
-    th Last Updated ↆ
-    th Progress
-    th Message
-    th Actions
-  - @statuses.each do |container|
-    tr
-      td
-        a href="#{to(:statuses)}/#{container.jid}" = container.jid
-      td= container.status
-      td= container.last_updated_at
-      td
-        .progress.progress-striped style="margin-bottom: 0"
-          .bar style='width: #{container.pct_complete}%; text-shadow: 1px 1px 1px black'
-            = "#{container.pct_complete}%"
-
-      td= container.message
-      td
-        - if container.killable?
-          a.kill href="#{to(:statuses)}/#{container.jid}/kill" onclick="return confirm('Are you sure?');" Kill
-        - elsif container.kill_requested?
-          |Kill requested
-  - if @statuses.empty?
-    tr
-      td colspan="5"
-
-== slim :_paging, :locals => { :url => "#{root_path}statuses" }