parallel_minion 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b02090a750670c6d1b845c4c88daf19451f591c
-  data.tar.gz: ebff60fff44c11157e93ca57fa682fd19ee226ef
+  metadata.gz: 540c677d0eab24f63240820396a79c81beaf12fd
+  data.tar.gz: 5e523e81bb240522758a1a2ef52b9ccfaa67ecab
 SHA512:
-  metadata.gz: 57033a4c8856bd4befea01eb8af8f974b15507ab9cfabbf65a767b05cd045fbca0b1a18ca979ebda8bdf1a301d385694aa9730b0658e75a2dbfacf2d125172a5
-  data.tar.gz: ef9594b1ae35312037a02e4dae1c3100d042964f178ea7787e46f3ef3273c5e0c1e4784ec53192c0369e321f1db22329094ddfb16fd6dfb6ac95215decfb6429
+  metadata.gz: b509dc355be13737e83c715479d660dfc390a0fd0fb3efc0d9f19b4c29d1c51f8009ed09f8f889d714ad1aff46a2a9735f270691cb30ba02c0004cf1c908611f
+  data.tar.gz: 299fb7d5ff78e5e2ebeed0db274f6481f258afc9d5b82bb2ceaeb6265c2fb68b2c41f2f2231c9627fe3d7a97b51a1650694886d51a3b5c3888b61970c3277865

data/LICENSE.txt

@@ -186,7 +186,7 @@ Apache License
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2013, 2014 Reid Morrison
+   Copyright 2013, 2014, 2015 Reid Morrison
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -1,7 +1,7 @@
 parallel_minion [![Build Status](https://secure.travis-ci.org/reidmorrison/parallel_minion.png?branch=master)](http://travis-ci.org/reidmorrison/parallel_minion)
 ===============
 
-Pragmatic approach to parallel and asynchronous processing in Ruby
+Pragmatic approach to parallel processing in Ruby
 
 ## Description
 
@@ -59,7 +59,7 @@ This project uses [Semantic Versioning](http://semver.org/).
 
 ## License
 
-Copyright 2013, 2014 Reid Morrison
+Copyright 2013, 2014, 2105 Reid Morrison
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/parallel_minion/minion.rb

@@ -15,8 +15,12 @@ module ParallelMinion
     # Returns [Array<Object>] list of arguments in the order they were passed into the initializer
     attr_reader :arguments
 
+    # Returns [Float] the number of milli-seconds the the minion took to complete
+    # Returns nil if the minion is still running
+    attr_reader :duration
+
     # Give an infinite amount of time to wait for a Minion to complete a task
-    INFINITE = -1
+    INFINITE = 0
 
     # Sets whether minions are enabled to run in their own threads
     #
@@ -61,8 +65,8 @@ module ParallelMinion
     #   :timeout [Integer]
     #     Maximum amount of time in milli-seconds that the task may take to complete
     #     before #result times out
-    #     Set to Minion::INFINITE to give the thread an infinite amount of time to complete
-    #     Default: Minion::INFINITE
+    #     Set to 0 to give the thread an infinite amount of time to complete
+    #     Default: 0 ( Wait forever )
     #
     #     Notes:
     #     - :timeout does not affect what happens to the Minion running the
@@ -77,6 +81,17 @@ module ParallelMinion
     #     Not recommended in Production, but is useful for debugging purposes
     #     Default: ParallelMinion::Minion.enabled?
     #
+    #   :on_timeout [Exception]
+    #     The class to raise on the minion when the minion times out.
+    #     By raising the exception on the running thread it ensures that the thread
+    #     ends due to the exception, rather than continuing to execute.
+    #     The exception is only raised on the running minion when #result is called.
+    #     The current call to #result will complete with a result of nil, future
+    #     calls to #result will raise the supplied exception on the current thread
+    #     since the thread will have terminated with that exception.
+    #
+    #     Note: :on_timeout has no effect if not #enabled?
+    #
     #   *args
     #     Any number of arguments can be supplied that are passed into the block
     #     in the order they are listed
@@ -115,12 +130,13 @@ module ParallelMinion
       @exception     = nil
       @arguments     = args.dup
       options        = self.class.extract_options!(@arguments)
-      @timeout       = (options.delete(:timeout) || Minion::INFINITE).to_f
+      @timeout       = options.delete(:timeout).to_f
       @description   = (options.delete(:description) || 'Minion').to_s
       @metric        = options.delete(:metric)
       @log_exception = options.delete(:log_exception)
       @enabled       = options.delete(:enabled)
       @enabled       = self.class.enabled? if @enabled.nil?
+      @on_timeout    = options.delete(:on_timeout)
 
       # Warn about any unknown options.
       options.each_pair do | key, val |
@@ -138,6 +154,8 @@ module ParallelMinion
           end
         rescue Exception => exc
           @exception = exc
+        ensure
+          @duration = Time.now - @start_time
         end
         return
       end
@@ -174,6 +192,7 @@ module ParallelMinion
           ensure
             # Return any database connections used by this thread back to the pool
             ActiveRecord::Base.clear_active_connections! if defined?(ActiveRecord::Base)
+            @duration = Time.now - @start_time
           end
         end
       end
@@ -190,6 +209,7 @@ module ParallelMinion
         ms = time_left
         logger.benchmark_info("Waited for Minion to complete: #{@description}", min_duration: 0.01) do
           if @thread.join(ms.nil? ? nil: ms / 1000).nil?
+            @thread.raise(@on_timeout.new("Minion: #{@description} timed out")) if @on_timeout
             logger.warn("Timed out waiting for result from Minion: #{@description}")
             return
           end
@@ -219,7 +239,7 @@ module ParallelMinion
     # Returns 0 if no time is left
     # Returns nil if their is no time limit. I.e. :timeout was set to Minion::INFINITE (infinite time left)
     def time_left
-      return nil if @timeout == INFINITE
+      return nil if (@timeout == 0) || (@timeout == -1)
       duration = @timeout - (Time.now - @start_time) * 1000
       duration <= 0 ? 0 : duration
     end

data/lib/parallel_minion/version.rb

@@ -1,3 +1,3 @@
 module ParallelMinion #:nodoc
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/minion_scope_test.rb

@@ -1,20 +1,14 @@
-# Allow test to be run in-place without requiring a gem install
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
-require 'semantic_logger'
-# Register an appender if one is not already registered
-SemanticLogger.default_level = :trace
-SemanticLogger.add_appender('test.log', &SemanticLogger::Appender::Base.colorized_formatter) if SemanticLogger.appenders.size == 0
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 require 'rubygems'
 require 'erb'
-require 'test/unit'
+#require 'test/unit'
 # Since we want both the AR and Mongoid extensions loaded we need to require them first
 require 'active_record'
 require 'active_record/relation'
 # Should redefines Proc#bind so must include after Rails
-require 'shoulda'
-require 'parallel_minion'
+#require 'shoulda'
+#require 'parallel_minion'
 
 ActiveRecord::Base.logger = SemanticLogger[ActiveRecord]
 ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read('test/config/database.yml')).result)
@@ -31,7 +25,7 @@ end
 class Person < ActiveRecord::Base
 end
 
-class MinionScopeTest < Test::Unit::TestCase
+class MinionScopeTest < Minitest::Test
 
   context ParallelMinion::Minion do
     [false, true].each do |enabled|

data/test/minion_test.rb

@@ -1,22 +1,8 @@
-# Allow test to be run in-place without requiring a gem install
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
-
-require 'test/unit'
-require 'shoulda'
-require 'parallel_minion'
-
-# Register an appender if one is not already registered
-SemanticLogger.default_level = :trace
-SemanticLogger.add_appender('test.log', &SemanticLogger::Appender::Base.colorized_formatter) if SemanticLogger.appenders.size == 0
-
-# Setup global callback for metric so that it can be tested below
-SemanticLogger.on_metric do |log_struct|
-  $log_struct = log_struct.dup
-end
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 # Test ParallelMinion standalone without Rails
 # Run this test standalone to verify it has no Rails dependencies
-class MinionTest < Test::Unit::TestCase
+class MinionTest < Minitest::Test
   include SemanticLogger::Loggable
 
   context ParallelMinion::Minion do
@@ -48,7 +34,7 @@ class MinionTest < Test::Unit::TestCase
 
         should 'raise exception' do
           minion = ParallelMinion::Minion.new(description: 'Test') { raise "An exception" }
-          assert_raise RuntimeError do
+          assert_raises RuntimeError do
             minion.result
           end
         end
@@ -58,7 +44,7 @@ class MinionTest < Test::Unit::TestCase
         #        should 'not have access to local variables' do
         #          name = 'Jack'
         #          minion = ParallelMinion::Minion.new(description: 'Test') { puts name }
-        #          assert_raise NameError do
+        #          assert_raises NameError do
         #            minion.result
         #          end
         #        end
@@ -118,12 +104,25 @@ class MinionTest < Test::Unit::TestCase
 
         should 'timeout' do
           minion = ParallelMinion::Minion.new(description: 'Test', timeout: 100) { sleep 1 }
-          # Only Parallel Minions time-out when they exceed the timeout
           if enabled
             assert_equal nil, minion.result
           end
         end
 
+        should 'timeout and terminate thread with Exception' do
+          minion = ParallelMinion::Minion.new(description: 'Test', timeout: 100, on_timeout: Timeout::Error) { sleep 1 }
+          if enabled
+            assert_equal nil, minion.result
+            # Give time for thread to terminate
+            sleep 0.1
+            assert_equal Timeout::Error, minion.exception.class
+            assert_equal false, minion.working?
+            assert_equal true,  minion.completed?
+            assert_equal true,  minion.failed?
+            assert_equal 0,     minion.time_left
+          end
+        end
+
         should 'make description instance variable available' do
           minion = ParallelMinion::Minion.new(description: 'Test') do
             description

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/stub_any_instance'
+require 'shoulda/context'
+require 'parallel_minion'
+require 'semantic_logger'
+
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
+# Register an appender if one is not already registered
+SemanticLogger.default_level = :trace
+SemanticLogger.add_appender('test.log', &SemanticLogger::Appender::Base.colorized_formatter) if SemanticLogger.appenders.size == 0
+
+# Setup global callback for metric so that it can be tested below
+SemanticLogger.on_metric do |log_struct|
+  $log_struct = log_struct.dup
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parallel_minion
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2015-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
@@ -43,6 +43,7 @@ files:
 - test/minion_scope_test.rb
 - test/minion_test.rb
 - test/test_db.sqlite3
+- test/test_helper.rb
 homepage: https://github.com/reidmorrison/parallel_minion
 licenses:
 - Apache License V2.0
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pragmatic approach to parallel and asynchronous processing in Ruby
@@ -72,3 +73,4 @@ test_files:
 - test/minion_scope_test.rb
 - test/minion_test.rb
 - test/test_db.sqlite3
+- test/test_helper.rb