resque-status 0.2.4 → 0.3.0

data/lib/resque/server/views/status.erb

@@ -1,7 +1,7 @@
 <%= status_view :status_styles, :layout => false %>
 
 <h1 class='wi'>Statuses: <%= @status.uuid %>/<%= @status.name %></h1>
-<p class='intro'>Viewing a specific job created with JobWithStatus. <a href="<%= u(:statuses) %>">Return to the list of statuses</a></p>
+<p class='intro'>Viewing a specific job created with Resque::Plugins::Status. <a href="<%= u(:statuses) %>">Return to the list of statuses</a></p>
 
 <div class="status-holder" rel="<%= @status.status %>" id="status_<%= @status.uuid %>">
   <div class="status-progress">
@@ -29,7 +29,7 @@
             var pct = json.pct_complete + "%";
           }
           $status.find('.status-progress-bar').animate({width: pct});
-          $status.find('.status-progress p').text(pct)        
+          $status.find('.status-progress p').text(pct)
           if (json.message) {
             $status.find('.status-message').html(json.message)
           }

data/lib/resque/server/views/statuses.erb

@@ -2,11 +2,14 @@
 
 <h1 class='wi'>Statuses</h1>
 <%unless @statuses.empty?%>
-  <form method="POST" action="<%= u(:statuses) %>/clear" class='clear-failed'>
-  <input type='submit' name='' value='Clear Statuses' />
+<form method="POST" action="<%= u(:statuses) %>/clear" class='clear-failed'>
+  <input type='submit' name='' value='Clear Statuses' onclick='return confirm("Are you absolutely sure? This cannot be undone.");' />
+</form>
+<form method="POST" action="<%= u(:statuses) %>/clear/completed" class='clear-failed'>
+  <input type='submit' name='' value='Clear Completed Statuses' onclick='return confirm("Are you absolutely sure? This cannot be undone.");' />
 </form>
 <%end%>
-<p class='intro'>These are recent jobs created with the JobWithStatus class</p>
+<p class='intro'>These are recent jobs created with the Resque::Plugins::Status class</p>
 <table>
   <tr>
     <th>ID</th>
@@ -32,7 +35,7 @@
       <td><% if status.killable? %><a href="<%= u(:statuses) %>/<%= status.uuid %>/kill" class="kill">Kill</a><% end %></td>
     </tr>
     <% end %>
-  <% else %>  
+  <% else %>
   <tr>
     <td colspan="7" class='no-data'>No Statuses right now...</td>
   </tr>
@@ -40,14 +43,14 @@
 </table>
 
 <% unless @statuses.empty? %>
-	<%= partial :next_more, :start => @start, :size => @size %>
+  <%= partial :next_more, :start => @start, :size => @size %>
 <% end %>
 
 <%= status_poll(@start) %>
 
 <script type="text/javascript" charset="utf-8">
   jQuery(function($) {
-    
+
     $('a.kill').click(function(e) {
       e.preventDefault();
       var $link = $(this),
@@ -66,6 +69,6 @@
         return false
       }
     });
-    
+
   });
 </script>

data/lib/resque/status.rb

@@ -2,240 +2,5 @@ require 'resque'
 require 'redisk'
 require 'uuid'
 
-module Resque
-  # Resque::Status is a Hash object that has helper methods for dealing with
-  # the common status attributes. It also has a number of class methods for
-  # creating/updating/retrieving status objects from Redis
-  class Status < Hash
-    VERSION = '0.2.4'
-
-    extend Resque::Helpers
-
-    # Create a status, generating a new UUID, passing the message to the status
-    # Returns the UUID of the new status.
-    def self.create(*messages)
-      uuid = generate_uuid
-      set(uuid, *messages)
-      redis.zadd(set_key, Time.now.to_i, uuid)
-      redis.zremrangebyscore(set_key, 0, Time.now.to_i - @expire_in) if @expire_in
-      uuid
-    end
-
-    # Get a status by UUID. Returns a Resque::Status
-    def self.get(uuid)
-      val = redis.get(status_key(uuid))
-      val ? Resque::Status.new(uuid, decode(val)) : nil
-    end
-
-    # set a status by UUID. <tt>messages</tt> can be any number of stirngs or hashes
-    # that are merged in order to create a single status.
-    def self.set(uuid, *messages)
-      val = Resque::Status.new(uuid, *messages)
-      redis.set(status_key(uuid), encode(val))
-      if expire_in
-        redis.expire(status_key(uuid), expire_in)
-      end
-      val
-    end
-
-    # clear statuses from redis passing an optional range. See `statuses` for info
-    # about ranges
-    def self.clear(range_start = nil, range_end = nil)
-      status_ids(range_start, range_end).each do |id|
-        redis.del(status_key(id))
-        redis.zrem(set_key, id)
-      end
-    end
-
-    # returns a Redisk::Logger scoped to the UUID. Any options passed are passed
-    # to the logger initialization.
-    #
-    # Ensures that Redisk is logging to the same Redis connection as Resque.
-    def self.logger(uuid, options = {})
-      Redisk.redis = redis
-      Redisk::Logger.new(logger_key(uuid), options)
-    end
-
-    def self.count
-      redis.zcard(set_key)
-    end
-
-    # Return <tt>num</tt> Resque::Status objects in reverse chronological order.
-    # By default returns the entire set.
-    # @param [Numeric] range_start The optional starting range
-    # @param [Numeric] range_end The optional ending range
-    # @example retuning the last 20 statuses
-    #   Resque::Status.statuses(0, 20)
-    def self.statuses(range_start = nil, range_end = nil)
-      status_ids(range_start, range_end).collect do |id|
-        get(id)
-      end.compact
-    end
-
-    # Return the <tt>num</tt> most recent status/job UUIDs in reverse chronological order.
-    def self.status_ids(range_start = nil, range_end = nil)
-      unless range_end && range_start
-        # Because we want a reverse chronological order, we need to get a range starting
-        # by the higest negative number.
-        redis.zrevrange(set_key, 0, -1) || []
-      else
-        # Because we want a reverse chronological order, we need to get a range starting
-        # by the higest negative number. The ordering is transparent from the API user's
-        # perspective so we need to convert the passed params
-        (redis.zrevrange(set_key, (range_start.abs), ((range_end || 1).abs)) || [])
-      end
-    end
-
-    # Kill the job at UUID on its next iteration this works by adding the UUID to a
-    # kill list (a.k.a. a list of jobs to be killed. Each iteration the job checks
-    # if it _should_ be killed by calling <tt>tick</tt> or <tt>at</tt>. If so, it raises
-    # a <tt>Resque::JobWithStatus::Killed</tt> error and sets the status to 'killed'.
-    def self.kill(uuid)
-      redis.sadd(kill_key, uuid)
-    end
-
-    # Remove the job at UUID from the kill list
-    def self.killed(uuid)
-      redis.srem(kill_key, uuid)
-    end
-
-    # Return the UUIDs of the jobs on the kill list
-    def self.kill_ids
-      redis.smembers(kill_key)
-    end
-
-    # Check whether a job with UUID is on the kill list
-    def self.should_kill?(uuid)
-      redis.sismember(kill_key, uuid)
-    end
-
-    # The time in seconds that jobs and statuses should expire from Redis (after
-    # the last time they are touched/updated)
-    def self.expire_in
-      @expire_in
-    end
-
-    # Set the <tt>expire_in</tt> time in seconds
-    def self.expire_in=(seconds)
-      @expire_in = seconds.nil? ? nil : seconds.to_i
-    end
-
-    def self.status_key(uuid)
-      "status:#{uuid}"
-    end
-
-    def self.set_key
-      "_statuses"
-    end
-
-    def self.kill_key
-      "_kill"
-    end
-
-    def self.logger_key(uuid)
-      "_log:#{uuid}"
-    end
-
-    def self.generate_uuid
-      UUID.generate(:compact)
-    end
-
-    def self.hash_accessor(name, options = {})
-      options[:default] ||= nil
-      coerce = options[:coerce] ? ".#{options[:coerce]}" : ""
-      module_eval <<-EOT
-      def #{name}
-        value = (self['#{name}'] ? self['#{name}']#{coerce} : #{options[:default].inspect})
-        yield value if block_given?
-        value
-      end
-
-      def #{name}=(value)
-        self['#{name}'] = value
-      end
-
-      def #{name}?
-        !!self['#{name}']
-      end
-      EOT
-    end
-
-    STATUSES = %w{queued working completed failed killed}.freeze
-
-    hash_accessor :uuid
-    hash_accessor :name
-    hash_accessor :status
-    hash_accessor :message
-    hash_accessor :time
-    hash_accessor :options
-
-    hash_accessor :num
-    hash_accessor :total
-
-    # Create a new Resque::Status object. If multiple arguments are passed
-    # it is assumed the first argument is the UUID and the rest are status objects.
-    # All arguments are subsequentily merged in order. Strings are assumed to
-    # be messages.
-    def initialize(*args)
-      super nil
-      base_status = {
-        'time' => Time.now.to_i,
-        'status' => 'queued'
-      }
-      base_status['uuid'] = args.shift if args.length > 1
-      status_hash = args.inject(base_status) do |final, m|
-        m = {'message' => m} if m.is_a?(String)
-        final.merge(m || {})
-      end
-      self.replace(status_hash)
-    end
-
-    # calculate the % completion of the job based on <tt>status</tt>, <tt>num</tt>
-    # and <tt>total</tt>
-    def pct_complete
-      case status
-      when 'completed' then 100
-      when 'queued' then 0
-      else
-        t = (total == 0 || total.nil?) ? 1 : total
-        (((num || 0).to_f / t.to_f) * 100).to_i
-      end
-    end
-
-    # Return the time of the status initialization. If set returns a <tt>Time</tt>
-    # object, otherwise returns nil
-    def time
-      time? ? Time.at(self['time']) : nil
-    end
-
-    STATUSES.each do |status|
-      define_method("#{status}?") do
-        self['status'] === status
-      end
-    end
-
-    # Can the job be killed? 'failed', 'completed', and 'killed' jobs cant be killed
-    # (for pretty obvious reasons)
-    def killable?
-      !['failed', 'completed', 'killed'].include?(self.status)
-    end
-
-    unless method_defined?(:to_json)
-      def to_json(*args)
-        json
-      end
-    end
-
-    # Return a JSON representation of the current object.
-    def json
-      h = self.dup
-      h['pct_complete'] = pct_complete
-      self.class.encode(h)
-    end
-
-    def inspect
-      "#<Resque::Status #{super}>"
-    end
-
-  end
-end
+require 'resque/plugins/status'
+require 'resque/job_with_status'

data/lib/resque/status_server.rb

@@ -1,53 +1,58 @@
-require 'resque/status'
+require 'resque-status'
 
 module Resque
   module StatusServer
-    
+
     VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
-    
+
     def self.registered(app)
-      
+
       app.get '/statuses' do
         @start = params[:start].to_i
         @end = @start + (params[:per_page] || 50)
-        @statuses = Resque::Status.statuses(@start, @end)
+        @statuses = Resque::Plugins::Status::Hash.statuses(@start, @end)
         @size = @statuses.size
         status_view(:statuses)
       end
-      
+
       app.get '/statuses/:id.js' do
-        @status = Resque::Status.get(params[:id])
+        @status = Resque::Plugins::Status::Hash.get(params[:id])
         content_type :js
         @status.json
       end
-      
+
       app.get '/statuses/:id' do
-        @status = Resque::Status.get(params[:id])
+        @status = Resque::Plugins::Status::Hash.get(params[:id])
         status_view(:status)
       end
-      
+
       app.post '/statuses/:id/kill' do
-        Resque::Status.kill(params[:id])
+        Resque::Plugins::Status::Hash.kill(params[:id])
         redirect u(:statuses)
       end
-      
+
       app.post '/statuses/clear' do
-        Resque::Status.clear
+        Resque::Plugins::Status::Hash.clear
         redirect u(:statuses)
       end
-      
+
+      app.post '/statuses/clear/completed' do
+        Resque::Status.clear_completed
+        redirect u(:statuses)
+      end
+
       app.get "/statuses.poll" do
         content_type "text/plain"
         @polling = true
 
         @start = params[:start].to_i
         @end = @start + (params[:per_page] || 50)
-        @statuses = Resque::Status.statuses(@start, @end)
+        @statuses = Resque::Plugins::Status::Hash.statuses(@start, @end)
         @size = @statuses.size
 
         status_view(:statuses, {:layout => false})
       end
-      
+
       app.helpers do
         def status_view(filename, options = {}, locals = {})
           erb(File.read(File.join(::Resque::StatusServer::VIEW_PATH, "#{filename}.erb")), options, locals)
@@ -62,9 +67,9 @@ module Resque
           "<p class='poll'>#{text}</p>"
         end
       end
-      
+
       app.tabs << "Statuses"
-      
+
     end
 
   end

data/resque-status.gemspec

@@ -4,26 +4,31 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{resque-status}
-  s.version = "0.2.4"
+  s.name = "resque-status"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2011-08-10}
-  s.description = %q{resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Status class which can set/get the statuses of jobs and a Resque::JobWithStatus class that when subclassed provides easily trackable/killable jobs.}
-  s.email = %q{aaron@quirkey.com}
+  s.date = "2012-01-22"
+  s.description = "resque-status is an extension to the resque queue system that provides simple trackable jobs. It provides a Resque::Plugins::Status::Hash class which can set/get the statuses of jobs and a Resque::Plugins::Status class that when included provides easily trackable/killable jobs."
+  s.email = "aaron@quirkey.com"
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
   ]
   s.files = [
     ".document",
+    "Gemfile",
+    "Gemfile.lock",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
     "examples/sleep_job.rb",
     "init.rb",
+    "lib/resque-status.rb",
     "lib/resque/job_with_status.rb",
+    "lib/resque/plugins/status.rb",
+    "lib/resque/plugins/status/hash.rb",
     "lib/resque/server/views/status.erb",
     "lib/resque/server/views/status_styles.erb",
     "lib/resque/server/views/statuses.erb",
@@ -32,25 +37,37 @@ Gem::Specification.new do |s|
     "resque-status.gemspec",
     "test/redis-test.conf",
     "test/test_helper.rb",
-    "test/test_resque-job_with_status.rb",
-    "test/test_resque-status.rb"
+    "test/test_resque_plugins_status.rb",
+    "test/test_resque_plugins_status_hash.rb"
   ]
-  s.homepage = %q{http://github.com/quirkey/resque-status}
+  s.homepage = "http://github.com/quirkey/resque-status"
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{quirkey}
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{resque-status is an extension to the resque queue system that provides simple trackable jobs.}
+  s.rubyforge_project = "quirkey"
+  s.rubygems_version = "1.8.10"
+  s.summary = "resque-status is an extension to the resque queue system that provides simple trackable jobs."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redisk>, [">= 0.2.1"])
+      s.add_runtime_dependency(%q<resque>, [">= 1.3.1"])
+      s.add_runtime_dependency(%q<uuid>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_runtime_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
       s.add_runtime_dependency(%q<uuid>, [">= 2.0.2"])
       s.add_runtime_dependency(%q<resque>, [">= 1.3.1"])
       s.add_runtime_dependency(%q<redisk>, [">= 0.2.1"])
       s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
     else
+      s.add_dependency(%q<redisk>, [">= 0.2.1"])
+      s.add_dependency(%q<resque>, [">= 1.3.1"])
+      s.add_dependency(%q<uuid>, [">= 2.0.2"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<uuid>, [">= 2.0.2"])
       s.add_dependency(%q<resque>, [">= 1.3.1"])
       s.add_dependency(%q<redisk>, [">= 0.2.1"])
@@ -58,6 +75,12 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
     end
   else
+    s.add_dependency(%q<redisk>, [">= 0.2.1"])
+    s.add_dependency(%q<resque>, [">= 1.3.1"])
+    s.add_dependency(%q<uuid>, [">= 2.0.2"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<uuid>, [">= 2.0.2"])
     s.add_dependency(%q<resque>, [">= 1.3.1"])
     s.add_dependency(%q<redisk>, [">= 0.2.1"])