queue_dispatcher 1.3.1 → 1.5.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yzc0ZDM1ZDgzMzcwYjE4OTkyZDc1ZjU4N2VhNjc1NWI5ODk2MTFiZA==
+  data.tar.gz: !binary |-
+    NDZkODM3YTg3NTg1YjM4NDM2YzM2NDVjOGViZTc1MDFmYTU4NGUyNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODhlY2E5NTcyOTk3YTRmZTY2NDcwNTZjNDkxMjkyYmZiNTJkMWE3Njk4MGIw
+    MGIwY2U3YzdiNzE3ZmIwNDMyZGRjMTBlNmJjZGM3YWIwMzQyMWUzZTVlYWJh
+    ZmFjYjIxMTkwMjQwNzAzOTQzYzZiZDIyMjRhMjBjZjcwOTQ2YmU=
+  data.tar.gz: !binary |-
+    MWRiMTkwODU5YTNmY2Y1ZjFmYjJiMzZiNGYyOGQxYWVmYjM5Yzg2NGNhYjA4
+    ZGEwMTg5MTc3YmQ5MTUxMjM4NjhjNGMxOTgwMWQxMjY2YmFkNzFiNzMzZmRj
+    Y2VkZjVlZTA1ZWUzYThkYzhhZTg1ZDZiNmI3MTQ3Y2UzMzE0YzA=

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea

data/README.rdoc

@@ -1,5 +1,7 @@
 = QueueDispatcher for Rails3
 
+{<img src="https://codeclimate.com/github/InWork/queue_dispatcher.png" />}[https://codeclimate.com/github/InWork/queue_dispatcher]
+
 This Rails3 Gem implements a method to perform long running methods in the background.
 Background tasks will be executed by persistent workers.
 

data/lib/generators/queue_dispatcher/migration/migration_generator.rb

@@ -43,8 +43,10 @@ module QueueDispatcher
 
     def create_migration_file
       migration_template 'task_queues.rb', 'db/migrate/create_task_queues.rb'
-      migration_template 'tasks.rb', 'db/migrate/create_tasks.rb'
       migration_template 'task_dependencies.rb', 'db/migrate/create_task_dependencies.rb'
+      migration_template 'change_message_type_for_tasks.rb', 'db/migrate/change_message_type_for_tasks.rb'
+      migration_template 'add_interrupts_to_tasks_queues.rb', 'db/migrate/add_interrupts_to_tasks_queues.rb'
+      migration_template 'add_result_to_tasks.rb', 'db/migrate/add_result_to_tasks.rb'
     end
 
   end

data/lib/generators/queue_dispatcher/migration/templates/add_interrupts_to_tasks_queues.rb

@@ -0,0 +1,9 @@
+class AddInterruptsToTasksQueues < ActiveRecord::Migration
+  def up
+    add_column "<%= options[:task_queues_table_name] %>", :interrupts, :text
+  end
+
+  def down
+    remove_column "<%= options[:task_queues_table_name] %>", :interrupts, :string
+  end
+end

data/lib/generators/queue_dispatcher/migration/templates/add_result_to_tasks.rb

@@ -0,0 +1,9 @@
+class AddResultToTasks < ActiveRecord::Migration
+  def up
+    add_column "<%= options[:tasks_table_name] %>", :result, :text
+  end
+
+  def down
+    remove_column "<%= options[:tasks_table_name] %>", :result, :text
+  end
+end

data/lib/generators/queue_dispatcher/migration/templates/change_message_type_for_tasks.rb

@@ -0,0 +1,9 @@
+class ChangeMessageTypeForTasks < ActiveRecord::Migration
+  def up
+    change_column "<%= options[:tasks_table_name] %>", :message, :text
+  end
+
+  def down
+    change_column "<%= options[:tasks_table_name] %>", :message, :string
+  end
+end

data/lib/queue_dispatcher/acts_as_task.rb

@@ -15,7 +15,7 @@ module QueueDispatcher
 
 
     module ClassMethods
-      def acts_as_task args = {}
+      def acts_as_task(args = {})
         # Include number-helper for number_to_human_size method
         include ActionView::Helpers::NumberHelper
 
@@ -32,6 +32,7 @@ module QueueDispatcher
         validates_presence_of :target, :method_name, :state
         serialize             :target
         serialize             :args
+        serialize             :result
 
         # Add dynamic associations to task_dependency and task_property according to the class name
         TaskDependency.instance_eval %Q{
@@ -64,29 +65,33 @@ module QueueDispatcher
 
 
       # This method updates the task state according to the return code of their corresponding command and removes it from the task_queue
-      def update_state(rc_and_msg, remove_from_queue = false)
+      def update_state(result, remove_from_queue = false)
         rc = output = error_msg = nil
 
-        if rc_and_msg.is_a?(QueueDispatcher::RcAndMsg)
-          rc = rc_and_msg.rc
-          output = rc_and_msg.output
-          error_msg = rc_and_msg.error_msg
-        elsif rc_and_msg.kind_of?(Hash)
-          rc = rc_and_msg[:rc]
-          output = rc_and_msg[:output]
-          error_msg = rc_and_msg[:error_msg]
+        if result.methods.include?(:rc) && result.methods.include?(:output) && result.methods.include?(:error_msg)
+          rc        = result.rc
+          output    = result.output
+          error_msg = result.error_msg
+          result    = nil
+        elsif result.kind_of?(Hash)
+          rc        = result[:rc]
+          output    = result[:output]
+          error_msg = result[:error_msg]
+          result    = nil
         end
 
-        output ||= ""
+        output ||= ''
 
         if rc.nil? || rc == 0
-          self.update_attributes :state => "successful",
+          self.update_attributes :state         => 'successful',
                                  :perc_finished => 100,
-                                 :message => output.truncate(10256)
+                                 :message       => output.truncate(10256),
+                                 :result        => result
         else
-          self.update_attributes :state => "error",
+          self.update_attributes :state     => 'error',
                                  :error_msg => error_msg,
-                                 :message => output.truncate(10256)
+                                 :message   => output.truncate(10256),
+                                 :result    => result
         end
 
         self.update_attributes :task_queue_id => nil if remove_from_queue
@@ -96,7 +101,7 @@ module QueueDispatcher
 
 
       # Update the attributes perc_finished and message according to the args
-      def update_message args = {}
+      def update_message(args = {})
         msg = args[:msg]
         perc_finished = args[:perc_finished]
 
@@ -190,7 +195,7 @@ module QueueDispatcher
 
       # Calculate md5-Checksum
       def md5
-        attr_str = ""
+        attr_str = ''
         Task.attribute_names.each{ |a| attr_str += self.send(a).to_s }
         Digest('MD5').digest(attr_str)
       end

data/lib/queue_dispatcher/acts_as_task_queue.rb

@@ -32,7 +32,7 @@ module QueueDispatcher
 
 
     module ClassMethods
-      def acts_as_task_queue args = {}
+      def acts_as_task_queue(args = {})
         include Spawn
         include ActionView::Helpers::UrlHelper
         include QdLogger
@@ -79,7 +79,7 @@ module QueueDispatcher
 
 
       # Find or create a task_queue by its name which is not in state 'error'. Create one, if there does not exists one
-      def find_or_create_by_name name, options = {}
+      def find_or_create_by_name(name, options = {})
         transaction do
           self.where(:name => name).where("state != 'error'").first || self.create(:name => name, :state => 'new', terminate_immediately: options[:terminate_immediately])
         end
@@ -112,29 +112,29 @@ module QueueDispatcher
 
 
       # Put a new task into the queue
-      def push task
+      def push(task)
         acts_as_task_queue_tasks << task
       end
 
 
       # Get the next ready to run task out of the queue. Consider the priority and the dependent tasks, which is defined in the association defined on
       # top of this model.
-      def pop args = {}
+      def pop(args = {})
         task      = nil
         log_debug = acts_as_task_queue_config.debug
 
         transaction do
           # Find next pending task, where all dependent tasks are executed
           all_tasks = acts_as_task_queue_tasks.lock(true).all
-          i         = 0
-          while task.nil? && i < all_tasks.count do
-            t = all_tasks[i]
+          pos       = 0
+          while task.nil? && pos < all_tasks.count do
+            t = all_tasks[pos]
             if t.dependent_tasks_executed?
               task = t if t.state == 'new'
             else
               log :msg => "Task #{t.id}: Waiting for dependent tasks #{t.dependent_tasks.map{|dt| dt.id}.join ','}...", :sev => :debug if log_debug
             end
-            i += 1
+            pos += 1
           end
 
           # Remove task from current queue
@@ -268,7 +268,7 @@ module QueueDispatcher
 
 
       # Execute all tasks in the queue
-      def run! args = {}
+      def run!(args = {})
         task          = nil
         @logger       = args[:logger] || Logger.new("#{File.expand_path(Rails.root)}/log/task_queue.log")
         finish_state  = 'aborted'
@@ -278,7 +278,7 @@ module QueueDispatcher
         task_queue.update_attribute :state, 'running'
 
         # Set logger in engine
-        @engine.logger = @logger if defined? @engine
+        @engine.logger = @logger if defined? @engine && @engine.methods.include?(:logger=)
         log :msg => "#{name}: Starting TaskQueue #{task_queue.id}...", :print_log => print_log
 
         # Init. Pop first task from queue, to show init_queue-state
@@ -311,26 +311,26 @@ module QueueDispatcher
               # Execute the method defined in task.method
               if task.target.methods.include?(task.method_name) || task.target.methods.include?(task.method_name.to_sym)
                 if task.dependent_tasks_had_errors
-                  error_msg = "Dependent tasks had errors!"
+                  error_msg = 'Dependent tasks had errors!'
                   log :msg => error_msg,
                       :sev => :warn, 
                       :print_log => print_log
-                  rc_and_msg = QueueDispatcher::RcAndMsg.bad_rc error_msg
+                  result = QueueDispatcher::RcAndMsg.bad_rc error_msg
                 else
                   target = task.target
                   target.logger = @logger if target.methods.include?(:logger=) || target.methods.include?('logger=')
-                  rc_and_msg = task.execute!
+                  result = task.execute!
                 end
               else
                 error_msg = "unknown method '#{task.method_name}' for #{task.target.class.name}!"
                 log :msg => error_msg,
                     :sev => :warn,
                     :print_log => print_log
-                rc_and_msg = QueueDispatcher::RcAndMsg.bad_rc error_msg
+                result = QueueDispatcher::RcAndMsg.bad_rc error_msg
               end
 
               # Change task state according to the return code and remove it from the queue
-              task.update_state rc_and_msg
+              task.update_state result
               cleanup_locks_after_error_for task
               task.update_attribute :task_queue_id, nil unless acts_as_task_queue_config.leave_finished_tasks_in_queue
               log :msg => "#{name}: Task #{task.id} (#{task.target.class.name}.#{task.method_name}) finished with state '#{task.state}'.", :print_log => print_log
@@ -410,7 +410,7 @@ module QueueDispatcher
       end
 
 
-      def determine_state_of_task_array task_array
+      def determine_state_of_task_array(task_array)
         successful = true
         new = true
         pending = false
@@ -444,17 +444,17 @@ module QueueDispatcher
 
 
       # Get Lock
-      def get_lock_for task
+      def get_lock_for(task)
       end
 
 
       # Release Lock
-      def release_lock_for task
+      def release_lock_for(task)
       end
 
 
       # Clean up locks after an error occured
-      def cleanup_locks_after_error_for task
+      def cleanup_locks_after_error_for(task)
         release_lock_for task
       end
 

data/lib/queue_dispatcher/message_sending.rb

@@ -16,8 +16,8 @@ module QueueDispatcher
       task_queue = ::TaskQueue.find_or_create_by_name task_queue_name, terminate_immediately: terminate_immediately
 
       # Create Task
-      default_values = {priority: 100}
-      mandatory_values = {target: @target, method_name: method, args: args, state: 'new', task_queue: task_queue}
+      default_values   = {priority: 100}
+      mandatory_values = {target: @target, method_name: method, args: args, state: 'new', task_queue_id: task_queue.id}
       ::Task.create default_values.merge(@options).merge(mandatory_values)
     end
   end

data/lib/queue_dispatcher/version.rb

@@ -1,3 +1,3 @@
 module QueueDispatcher
-  VERSION = "1.3.1"
+  VERSION = "1.5.1"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: queue_dispatcher
 version: !ruby/object:Gem::Version
-  version: 1.3.1
-  prerelease: 
+  version: 1.5.1
 platform: ruby
 authors:
 - Philip Kurmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-23 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: deadlock_retry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: spawn
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -141,6 +128,9 @@ files:
 - app/views/queue_dispatcher_views/my_events.js.erb
 - app/views/queue_dispatcher_views/update_events.js.erb
 - lib/generators/queue_dispatcher/migration/migration_generator.rb
+- lib/generators/queue_dispatcher/migration/templates/add_interrupts_to_tasks_queues.rb
+- lib/generators/queue_dispatcher/migration/templates/add_result_to_tasks.rb
+- lib/generators/queue_dispatcher/migration/templates/change_message_type_for_tasks.rb
 - lib/generators/queue_dispatcher/migration/templates/task_dependencies.rb
 - lib/generators/queue_dispatcher/migration/templates/task_queues.rb
 - lib/generators/queue_dispatcher/migration/templates/tasks.rb
@@ -162,26 +152,25 @@ files:
 - script/queue_worker_dispatcher
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: This Gem installs a queue dispatcher for handling asynchronous tasks
 test_files: []