concurrent-ruby 0.7.0 → 0.7.1

data/lib/concurrent/scheduled_task.rb

@@ -4,6 +4,7 @@ require 'concurrent/executor/safe_task_executor'
 
 module Concurrent
 
+  # {include:file:doc/scheduled_task.md}
   class ScheduledTask < IVar
 
     attr_reader :schedule_time

data/lib/concurrent/timer_task.rb

@@ -10,7 +10,7 @@ module Concurrent
   # intervals. The thread that performs the task sleeps for the given interval then
   # wakes up and performs the task. Lather, rinse, repeat... This pattern causes two
   # problems. First, it is difficult to test the business logic of the task because the
-  # task itself is tightly coupled with the concurrency logic. Second, an exception in
+  # task itself is tightly coupled with the concurrency logic. Second, an exception
   # raised while performing the task can cause the entire thread to abend. In a
   # long-running application where the task thread is intended to run for days/weeks/years
   # a crashed task thread can pose a significant problem. `TimerTask` alleviates both problems.
@@ -23,13 +23,13 @@ module Concurrent
   # performing logging or ancillary operations. `TimerTask` can also be configured with a
   # timeout value allowing it to kill a task that runs too long.
   # 
-  # One other advantage of `TimerTask` is it forces the business logic to be completely decoupled
+  # One other advantage of `TimerTask` is that it forces the business logic to be completely decoupled
   # from the concurrency logic. The business logic can be tested separately then passed to the
   # `TimerTask` for scheduling and running.
   # 
   # In some cases it may be necessary for a `TimerTask` to affect its own execution cycle.
-  # To facilitate this a reference to the task object is passed into the block as a block
-  # argument every time the task is executed.
+  # To facilitate this, a reference to the TimerTask instance is passed as an argument
+  # to the provided block every time the task is executed.
   # 
   # The `TimerTask` class includes the `Dereferenceable` mixin module so the result of
   # the last execution is always available via the `#value` method. Derefencing options
@@ -39,13 +39,13 @@ module Concurrent
   # `TimerTask` supports notification through the Ruby standard library
   # {http://ruby-doc.org/stdlib-2.0/libdoc/observer/rdoc/Observable.html Observable}
   # module. On execution the `TimerTask` will notify the observers
-  # with threes arguments: time of execution, the result of the block (or nil on failure),
+  # with three arguments: time of execution, the result of the block (or nil on failure),
   # and any raised exceptions (or nil on success). If the timeout interval is exceeded
   # the observer will receive a `Concurrent::TimeoutError` object as the third argument.
   #
   # @example Basic usage
   #   task = Concurrent::TimerTask.new{ puts 'Boom!' }
-  #   task.run!
+  #   task.execute
   #   
   #   task.execution_interval #=> 60 (default)
   #   task.timeout_interval   #=> 30 (default)
@@ -53,7 +53,7 @@ module Concurrent
   #   # wait 60 seconds...
   #   #=> 'Boom!'
   #   
-  #   task.stop #=> true
+  #   task.shutdown #=> true
   #
   # @example Configuring `:execution_interval` and `:timeout_interval`
   #   task = Concurrent::TimerTask.new(execution_interval: 5, timeout_interval: 5) do
@@ -65,7 +65,7 @@ module Concurrent
   #
   # @example Immediate execution with `:run_now`
   #   task = Concurrent::TimerTask.new(run_now: true){ puts 'Boom!' }
-  #   task.run!
+  #   task.execute
   #   
   #   #=> 'Boom!'
   #
@@ -75,7 +75,7 @@ module Concurrent
   #     execution_interval: 5
   #   ){ Time.now }
   #   
-  #   task.run!
+  #   task.execute
   #   Time.now   #=> 2013-11-07 18:06:50 -0500
   #   sleep(10)
   #   task.value #=> 2013-11-07 18:06:55 -0500
@@ -87,11 +87,11 @@ module Concurrent
   #     task.execution_interval += 1
   #     if task.execution_interval > 5
   #       puts 'Stopping...'
-  #       task.stop
+  #       task.shutdown
   #     end
   #   end
   #   
-  #   timer_task.run # blocking call - this task will stop itself
+  #   timer_task.execute # blocking call - this task will stop itself
   #   #=> Boom!
   #   #=> Boom! Boom!
   #   #=> Boom! Boom! Boom!
@@ -114,30 +114,30 @@ module Concurrent
   #   
   #   task = Concurrent::TimerTask.new(execution_interval: 1, timeout_interval: 1){ 42 }
   #   task.add_observer(TaskObserver.new)
-  #   task.run!
+  #   task.execute
   #   
   #   #=> (2013-10-13 19:08:58 -0400) Execution successfully returned 42
   #   #=> (2013-10-13 19:08:59 -0400) Execution successfully returned 42
   #   #=> (2013-10-13 19:09:00 -0400) Execution successfully returned 42
-  #   task.stop
+  #   task.shutdown
   #   
   #   task = Concurrent::TimerTask.new(execution_interval: 1, timeout_interval: 1){ sleep }
   #   task.add_observer(TaskObserver.new)
-  #   task.run!
+  #   task.execute
   #   
   #   #=> (2013-10-13 19:07:25 -0400) Execution timed out
   #   #=> (2013-10-13 19:07:27 -0400) Execution timed out
   #   #=> (2013-10-13 19:07:29 -0400) Execution timed out
-  #   task.stop
+  #   task.shutdown
   #   
   #   task = Concurrent::TimerTask.new(execution_interval: 1){ raise StandardError }
   #   task.add_observer(TaskObserver.new)
-  #   task.run!
+  #   task.execute
   #   
   #   #=> (2013-10-13 19:09:37 -0400) Execution failed with error StandardError
   #   #=> (2013-10-13 19:09:38 -0400) Execution failed with error StandardError
   #   #=> (2013-10-13 19:09:39 -0400) Execution failed with error StandardError
-  #   task.stop
+  #   task.shutdown
   #
   # @see http://ruby-doc.org/stdlib-2.0/libdoc/observer/rdoc/Observable.html
   # @see http://docs.oracle.com/javase/7/docs/api/java/util/TimerTask.html
@@ -316,7 +316,7 @@ module Concurrent
     # @!visibility private
     def execute_task(completion)
       return unless @running.true?
-      Concurrent::timer(timeout_interval, completion, &method(:timeout_task))
+      Concurrent::timer(execution_interval, completion, &method(:timeout_task))
       success, value, reason = @executor.execute(self)
       if completion.try?
         self.value = value

data/lib/concurrent/tvar.rb

@@ -4,6 +4,8 @@ module Concurrent
 
   # A `TVar` is a transactional variable - a single-element container that
   # is used as part of a transaction - see `Concurrent::atomically`.
+  #
+  # {include:file:doc/tvar.md}
   class TVar
 
     # Create a new `TVar` with an initial value.

data/lib/concurrent/version.rb

@@ -1,3 +1,3 @@
 module Concurrent
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: concurrent-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Jerry D'Antonio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
-dependencies: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ref
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 description: |2
       Modern concurrency tools including agents, futures, promises, thread pools, actors, supervisors, and more.
       Inspired by Erlang, Clojure, Go, JavaScript, actors, and classic concurrency patterns.
@@ -19,7 +33,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE.txt
+- CHANGELOG.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/concurrent.rb
@@ -94,6 +110,7 @@ files:
 - lib/concurrent/executor/executor.rb
 - lib/concurrent/executor/fixed_thread_pool.rb
 - lib/concurrent/executor/immediate_executor.rb
+- lib/concurrent/executor/indirect_immediate_executor.rb
 - lib/concurrent/executor/java_cached_thread_pool.rb
 - lib/concurrent/executor/java_fixed_thread_pool.rb
 - lib/concurrent/executor/java_single_thread_executor.rb
@@ -150,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Modern concurrency tools for Ruby. Inspired by Erlang, Clojure, Scala, Haskell,