resque-progress 1.0.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Idris Mokhtarzada
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,48 @@
+resque-progress
+===============
+Depends on [Resque](http://github.com/defunkt/resque/) 1.8 and 
+[resque-meta](http://github.com/lmarlow/resque-meta/) 1.0.0
+
+
+About
+-----
+Inspired by [resque-status](http://github.com/quirkey/resque-status/). 
+Unfortunately, resque-status seems incompatible with resque-meta, so this 
+plugin uses resque-meta to provide a similar functionality. This plugin 
+differs a bit because it's mainly focused on progress. The resque-meta plugin 
+already includes methods for `finished?`, `working?`, `succeeded?`, etc.
+
+
+Examples
+--------
+	class MyJob
+	  extend Resque::Plugins::Progress
+
+	  def self.perform(meta_id, *args)
+	    (0..9).each do |i|
+	      at(i, 10, "Lifted \#{num} heavy things. \#{10-num} more to go!")
+	      heavy_lifting(i)
+	    end
+		at(10, 10, "Finished lifting everything. Kthxbai!")
+	  end
+	end
+
+	meta0 = MyJob.enqueue('stuff')
+	meta0.progress.num_complete # => 0
+	meta0.progress.total # => 10
+	meta0.progress.percent # => 100
+	meta0.progress.message # => nil
+
+	# later
+	meta1 = MyJob.get_meta('03c9e1a045ad012dd20500264a19273c')
+	meta1.finished? # => false
+	meta1.progress.num_complete # => 4
+	meta1.progress.total # => 10
+	meta1.progress.percent # => 40
+	meta1.progress.message # => 'Lifted 4 heavy things. 6 more to go!'
+
+
+Requirements
+------------
+* [resque](http://github.com/defunkt/resque/) 1.8
+* [resque-meta](http://github.com/lmarlow/resque-meta/) 1.0.0

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake/testtask'
+
+def command?(command)
+  system("type #{command} > /dev/null")
+end
+
+#
+# Tests
+#
+
+task :default => :test
+
+if command? :turn
+  desc 'Run tests'
+  task :test do
+    suffix = "-n #{ENV['TEST']}" if ENV['TEST']
+    sh "turn test/*_test.rb #{suffix}"
+  end
+else
+  Rake::TestTask.new do |t|
+    t.libs << 'lib'
+    t.pattern = 'test/**/*_test.rb'
+    t.verbose = false
+  end
+end
+
+#
+# Gems
+#
+
+begin
+  require 'mg'
+  MG.new('resque-progress.gemspec')
+rescue LoadError
+  warn 'mg not available.'
+  warn 'Install it with: gem i mg'
+end

data/lib/resque/plugins/progress.rb

@@ -0,0 +1,29 @@
+require 'resque/plugins/meta'
+
+module Resque
+  module Plugins
+    module Progress
+      def self.extended(mod)
+        mod.extend(Resque::Plugins::Meta)
+        Resque::Plugins::Meta::Metadata.send(:include, Resque::Plugins::Progress::Metadata)
+      end
+
+      def at(num, total, message)
+        meta = get_meta(meta_id)
+        meta.progress = [num, total, message]
+        meta.save
+      end
+
+      module Metadata
+        def progress
+          p = self['progress'] || [0, 1, nil]
+          { :num => p[0].to_i, :total => p[1].to_i, :percent => 100*(p[0].to_f / p[1].to_i), :message => p[2] }
+        end
+
+        def progress=(p)
+          self['progress'] = p
+        end
+      end
+    end
+  end
+end

data/lib/resque/plugins/progress/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module Progress
+      Version = '1.0.0'
+    end
+  end
+end

data/test/progress_test.rb

@@ -0,0 +1,70 @@
+require 'resque'
+require 'resque/plugins/progress'
+require 'resque/plugins/progress/version'
+
+class ProgressJob
+  extend Resque::Plugins::Progress
+  @queue = :test
+
+  def self.expire_meta_in
+    10
+  end
+
+  def self.perform(meta_id)
+    (0..4).each do |i|
+      at(i, 5, 'working')
+    end
+    at(5, 5, 'complete')
+  end
+end
+class ProgressTest < Test::Unit::TestCase
+  def setup
+    Resque.redis.flushall
+  end
+
+  def test_progress_version
+    assert_equal('1.0.0', Resque::Plugins::Progress::Version)
+  end
+
+  def test_resque_version
+    major, minor, patch = Resque::Version.split('.')
+    assert_equal 1, major.to_i
+    assert minor.to_i >= 8
+  end
+
+  def test_meta_version
+    major, minor, patch = Resque::Plugins::Meta::Version.split('.')
+    assert_equal 1, major.to_i
+  end
+
+  def test_lint
+    assert_nothing_raised do
+      Resque::Plugin.lint(Resque::Plugins::Progress)
+    end
+  end
+
+  def test_initial_progress
+    meta = ProgressJob.enqueue
+    assert_not_nil(meta)
+    assert_not_nil(meta.progress)
+    assert_equal(0, meta.progress[:num])
+    assert_equal(1, meta.progress[:total])
+    assert_equal(0, meta.progress[:percent])
+    assert_nil(meta.progress[:message])
+  end
+
+  def test_final_progress
+    meta = ProgressJob.enqueue
+    worker = Resque::Worker.new(:test)
+    worker.work(0)
+
+    meta = ProgressJob.get_meta(meta.meta_id)
+    assert_not_nil(meta)
+    assert(meta.finished?)
+    assert_not_nil(meta.progress)
+    assert_equal(5, meta.progress[:num])
+    assert_equal(5, meta.progress[:total])
+    assert_equal(100, meta.progress[:percent])
+    assert_equal('complete', meta.progress[:message])
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: resque-progress
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Idris Mokhtarzada
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: resque-meta
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+description: |
+  A Resque plugin that provides helpers for progress updates from within your 
+  jobs.
+  
+  For example:
+  
+      class MyJob
+        extend Resque::Plugins::Progress
+  
+        def self.perform(meta_id, *args)
+          (0..10).each do |i|
+            at(i, 10, "Lifted #{num} heavy things. #{10-num} more to go!")
+            heavy_lifting(i)
+          end
+        end
+      end
+  
+      meta0 = MyJob.enqueue('stuff')
+      meta0.progress.num_complete # => 0
+      meta0.progress.total # => 10
+      meta0.progress.percent # => 100
+      meta0.progress.message # => nil
+  
+      # later
+      meta1 = MyJob.get_meta('03c9e1a045ad012dd20500264a19273c')
+      meta1.progress.num_complete # => 4
+      meta1.progress.total # => 10
+      meta1.progress.percent # => 40
+      meta1.progress.message # => 'Lifted 4 heavy things. 6 more to go!'
+
+email: idris@umd.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- LICENSE
+- lib/resque/plugins/progress/version.rb
+- lib/resque/plugins/progress.rb
+- test/progress_test.rb
+has_rdoc: true
+homepage: http://github.com/idris/resque-progress
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Resque plugin for progress updates on jobs.
+test_files: []
+