genki-background_fu 1.0.8.2 → 1.0.9

data/History.txt

@@ -1,6 +1,10 @@
-=== 1.0.8.1 / 2008-09-7
+=== Master / 2008-11-06
 
-* Suppress the warning on Rails-2.1.1.
+* Allow concurrency is deprecated in Rails 2.2 so we check if we can use it. (thanks fixlr).
+
+=== 1.0.9 / 2008-10-22
+
+* Merged a few important fixes from Keith Morrison. Bumped version, fixed gemspec (thanks  森山 誠二郎). Closes #4. [Keith Morrison, 森山 誠二郎, ncr]
 
 === Master / 2008-07-31
 

data/README.txt

@@ -17,13 +17,14 @@ Background tasks in Ruby On Rails made dead simple.
 * Clean and straightforward approach (database-based priority queue).
 * Uses database table (migration included) to store jobs reliably.
 * Capistrano tasks included. 
-* Generators with migrations and example views included (to be used with concurrency enabled).
+* Generators with migrations and example views (Prototype required) included (to be used with concurrency enabled).
 * Multiple worker daemons available.
 * Easy to deploy in distributed environments.
 * Enables prioritizing and simple scheduling.
 * Optional worker monitoring (good for AJAX progress bars).
 * Proven its stability and reliability in production use.
 
+
 == SYNOPSIS:
 
   ruby ./script/generate background

data/background-fu.gemspec

@@ -1,16 +1,16 @@
 Gem::Specification.new do |s|
   s.name = %q{background_fu}
-  s.version = "1.0.8.2"
+  s.version = "1.0.9"
 
   s.specification_version = 2 if s.respond_to? :specification_version=
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacek Becela"]
-  s.date = %q{2008-05-28}
+  s.date = %q{2008-10-22}
   s.description = %q{Background tasks in Ruby On Rails made dead simple.}
   s.email = ["jacek.becela@gmail.com"]
   s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "background-fu.gemspec", "generators/background/USAGE", "generators/background/background_generator.rb", "generators/background/templates/background.rb", "generators/background/templates/background_ctl", "generators/background/templates/daemons", "generators/background/templates/daemons.yml", "generators/background/templates/example_monitored_worker.rb", "generators/background/templates/example_worker.rb", "generators/background/templates/migration.rb", "generators/background/templates/scaffold/_job.html.erb", "generators/background/templates/scaffold/_job_deleted.html.erb", "generators/background/templates/scaffold/_progress_indicator.html.erb", "generators/background/templates/scaffold/background_fu.css", "generators/background/templates/scaffold/index.html.erb", "generators/background/templates/scaffold/jobs.html.erb", "generators/background/templates/scaffold/jobs_controller.rb", "generators/background/templates/scaffold/jobs_helper.rb", "lib/background_fu.rb", "lib/background_fu/worker_monitoring.rb", "lib/job.rb", "lib/job/bonus_features.rb", "rails/init.rb"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "background-fu.gemspec", "generators/background/USAGE", "generators/background/background_generator.rb", "generators/background/templates/background.rb", "generators/background/templates/background_ctl", "generators/background/templates/daemons", "generators/background/templates/daemons.yml", "generators/background/templates/example_monitored_worker.rb", "generators/background/templates/example_worker.rb", "generators/background/templates/migration.rb", "generators/background/templates/scaffold/_form.html.erb", "generators/background/templates/scaffold/_job.html.erb", "generators/background/templates/scaffold/_job_deleted.html.erb", "generators/background/templates/scaffold/_progress_indicator.html.erb", "generators/background/templates/scaffold/application_controller.rb", "generators/background/templates/scaffold/background_fu.css", "generators/background/templates/scaffold/index.html.erb", "generators/background/templates/scaffold/jobs.html.erb", "generators/background/templates/scaffold/jobs_controller.rb", "generators/background/templates/scaffold/jobs_helper.rb", "generators/background/templates/scaffold/new.html.erb", "lib/background_fu.rb", "lib/background_fu/worker_monitoring.rb", "lib/job.rb", "lib/job/bonus_features.rb", "rails/init.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/ncr/background-fu}
   s.rdoc_options = ["--main", "README.txt"]

data/generators/background/templates/background.rb

@@ -11,7 +11,7 @@ else
 end
 
 loop do
-  if job = Job.find(:first, :conditions => ["state='pending' and start_at <= ?", Time.now.utc], :order => "priority desc, start_at asc")
+  if job = Job.find(:first, :conditions => ["state='pending' and start_at <= ?", Time.now], :order => "priority desc, start_at asc")
     job.get_done!
   else
     RAILS_DEFAULT_LOGGER.info("BackgroundFu: Waiting for jobs...")

data/generators/background/templates/scaffold/_form.html.erb

@@ -0,0 +1,10 @@
+<%= error_messages_for :job %>
+<% form_for(:job, :html => {:class => "job"}) do |f| %>
+  <%= f.label :worker_class %><br />
+  <%= f.text_field :worker_class, :class => "worker-class" %><br />
+  <%= f.label :worker_method %><br />
+  <%= f.text_field :worker_method, :class => "worker-method" %><br />
+  <%= f.label :args, "Args - each line (including empty) is interpreted as a string argument" %><br />
+  <%= f.text_area :args %><br />
+  <%= f.submit "Enqueue", :class => "button" %>
+<% end %>

data/generators/background/templates/scaffold/application_controller.rb

@@ -0,0 +1,2 @@
+class Admin::ApplicationController < ApplicationController
+end

data/generators/background/templates/scaffold/new.html.erb

@@ -0,0 +1,2 @@
+<%= render :partial => "form", :locals => { :job => @job } %>
+<%= link_to "Back to Jobs", admin_jobs_path %><br />

data/lib/background_fu.rb

@@ -1,5 +1,5 @@
 module BackgroundFu
   
-  VERSION = "1.0.8"
+  VERSION = "1.0.9"
   
 end

data/lib/job/bonus_features.rb

@@ -16,6 +16,7 @@ module Job::BonusFeatures
       invoke_worker_without_threads; nil
     end
     
+    self.reload
     self.state = res ? "stopped" : "finished"
   end
 
@@ -44,7 +45,7 @@ module Job::BonusFeatures
     end
   end
   
-  # Overwritten because of new "stopped" state.
+  # Overridden because of new "stopped" state.
   def restart_with_threads!
     if stopped? || failed?
       update_attributes!(
@@ -57,13 +58,11 @@ module Job::BonusFeatures
     end
   end
 
-  # This is the only place where multi-threading 
-  # is used in the plugin and is completely optional.
+  # Monitors the worker and updates the job progress.  If the job's status
+  # is changed to 'stopping', the worker is requested to stop.
   def monitor_worker
     Thread.new do
-      # 1. running? - check if not failed or finished.
-      # 2. !Job.find(id).stopping? - check if someone ordered stopping the job.  
-      while(running? && !Job.find(id).stopping?)
+      while running? && !Job.find(id).stopping?
         current_progress = @worker.instance_variable_get("@progress")
 
         if current_progress == progress
@@ -74,11 +73,11 @@ module Job::BonusFeatures
         end
       end
 
-      # If someone ordered stopping a job we infrom the worker that it should stop.
-      if(Job.find(id).stopping?)
+      if Job.find(id).stopping?
         @worker.instance_variable_set("@stopping", true)
       end
     end
+    
     logger.info("BackgroundFu: Job monitoring started. Job(id: #{id}).")
   end
 

data/lib/job.rb

@@ -25,6 +25,19 @@ class Job < ActiveRecord::Base
     
     job
   end
+  
+  def self.enqueue_with_delay!(delay_in_minutes, worker_class, worker_method, *args)
+    job = create!(
+      :start_at      => Time.now + (delay_in_minutes * 60),
+      :worker_class  => worker_class.to_s,
+      :worker_method => worker_method.to_s,
+      :args          => args
+    )
+    
+    logger.info("BackgroundFu: Job enqueued with #{delay_in_minutes} minute delay. Job(id: #{job.id}, worker: #{worker_class}, method: #{worker_method}, argc: #{args.size}).")
+    
+    job
+  end
 
   # Invoked by a background daemon.
   def get_done!
@@ -50,7 +63,7 @@ class Job < ActiveRecord::Base
   end
   
   def initialize_worker
-    update_attributes!(:started_at => Time.now.utc, :state => "running")
+    update_attributes!(:started_at => Time.now, :state => "running")
     @worker = worker_class.constantize.new
     logger.info("BackgroundFu: Job initialized. Job(id: #{id}).")
   end
@@ -107,7 +120,7 @@ class Job < ActiveRecord::Base
   def setup_start_at
     return unless start_at.blank?
     
-    self.start_at = Time.now.utc
+    self.start_at = Time.now
   end
 
 end  

data/rails/init.rb

@@ -3,9 +3,8 @@ require 'background_fu/worker_monitoring'
 require 'job'
 require 'job/bonus_features'
 
-# ActiveSupport::Dependencies will be here after edge becomes stable.
 ActiveSupport::Dependencies.load_paths << "#{RAILS_ROOT}/lib/workers"
 
-if ActiveRecord::Base.allow_concurrency
+if ActiveRecord::Base.method_defined?(:allow_concurrency) and ActiveRecord::Base.allow_concurrency
   Job.send!(:include, Job::BonusFeatures)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: genki-background_fu
 version: !ruby/object:Gem::Version 
-  version: 1.0.8.2
+  version: 1.0.9
 platform: ruby
 authors: 
 - Jacek Becela
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-05-28 00:00:00 -07:00
+date: 2008-10-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,14 +47,17 @@ files:
 - generators/background/templates/example_monitored_worker.rb
 - generators/background/templates/example_worker.rb
 - generators/background/templates/migration.rb
+- generators/background/templates/scaffold/_form.html.erb
 - generators/background/templates/scaffold/_job.html.erb
 - generators/background/templates/scaffold/_job_deleted.html.erb
 - generators/background/templates/scaffold/_progress_indicator.html.erb
+- generators/background/templates/scaffold/application_controller.rb
 - generators/background/templates/scaffold/background_fu.css
 - generators/background/templates/scaffold/index.html.erb
 - generators/background/templates/scaffold/jobs.html.erb
 - generators/background/templates/scaffold/jobs_controller.rb
 - generators/background/templates/scaffold/jobs_helper.rb
+- generators/background/templates/scaffold/new.html.erb
 - lib/background_fu.rb
 - lib/background_fu/worker_monitoring.rb
 - lib/job.rb