concurrent-ruby 0.8.0 → 0.9.0.pre2

data/lib/concurrent/utility/timeout.rb

@@ -2,34 +2,38 @@ require 'rbconfig'
 require 'thread'
 
 require 'concurrent/errors'
+require 'concurrent/concern/deprecation'
 
 module Concurrent
+  extend Concern::Deprecation
 
-  # Wait the given number of seconds for the block operation to complete.
+  # [DEPRECATED] Wait the given number of seconds for the block operation to complete.
+  # Intended to be a simpler and more reliable replacement to the Ruby
+  # standard library `Timeout::timeout` method. It does not kill the task
+  # so it finishes anyway. Advantage is that it cannot cause any ugly errors by
+  # killing threads.
   #
   # @param [Integer] seconds The number of seconds to wait
-  #
   # @return [Object] The result of the block operation
   #
   # @raise [Concurrent::TimeoutError] when the block operation does not complete
   #   in the allotted number of seconds.
   #
-  # @note This method is intended to be a simpler and more reliable replacement
-  # to the Ruby standard library `Timeout::timeout` method.
-  def timeout(seconds)
-
-    thread = Thread.new do
-      Thread.current[:result] = yield
-    end
-    success = thread.join(seconds)
+  # @see http://ruby-doc.org/stdlib-2.2.0/libdoc/timeout/rdoc/Timeout.html Ruby Timeout::timeout
+  #
+  # @!macro monotonic_clock_warning
+  #
+  # @deprecated timeout is deprecated and will be removed
+  def timeout(seconds, &block)
+    deprecated 'timeout is deprecated and will be removed'
 
-    if success
-      return thread[:result]
+    future = Future.execute(&block)
+    future.wait(seconds)
+    if future.complete?
+      future.value!
     else
       raise TimeoutError
     end
-  ensure
-    Thread.kill(thread) unless thread.nil?
   end
   module_function :timeout
 end

data/lib/concurrent/utility/timer.rb

@@ -1,21 +1,26 @@
 require 'concurrent/configuration'
-require 'thread'
+require 'concurrent/concern/deprecation'
 
 module Concurrent
+  extend Concern::Deprecation
 
-  # Perform the given operation asynchronously after the given number of seconds.
+  # [DEPRECATED] Perform the given operation asynchronously after
+  # the given number of seconds.
   #
   # @param [Fixnum] seconds the interval in seconds to wait before executing the task
   #
   # @yield the task to execute
   #
-  # @return [Boolean] true
+  # @return [Concurrent::ScheduledTask] IVar representing the task
+  #
+  # @see Concurrent::ScheduledTask
+  #
+  # @deprecated use `ScheduledTask` instead
   def timer(seconds, *args, &block)
+    deprecated_method 'Concurrent.timer', 'ScheduledTask'
     raise ArgumentError.new('no block given') unless block_given?
     raise ArgumentError.new('interval must be greater than or equal to zero') if seconds < 0
-
-    Concurrent.configuration.global_timer_set.post(seconds, *args, &block)
-    true
+    Concurrent.global_timer_set.post(seconds, *args, &block)
   end
   module_function :timer
 end

data/lib/concurrent/version.rb

@@ -1,3 +1,4 @@
 module Concurrent
-  VERSION = '0.8.0'
+  VERSION      = '0.9.0.pre2'
+  EDGE_VERSION = '0.1.0.pre2'
 end

data/lib/concurrent_ruby.rb

@@ -1 +1,2 @@
+warn "'[DEPRECATED] use `require 'concurrent'` instead of `require 'concurrent_ruby'`"
 require 'concurrent'

metadata

@@ -1,39 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: concurrent-ruby
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0.pre2
 platform: ruby
 authors:
 - Jerry D'Antonio
+- The Ruby Concurrency Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 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'
-    - - ">="
-      - !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'
-    - - ">="
-      - !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.
-email: jerry.dantonio@gmail.com
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Modern concurrency tools including agents, futures, promises, thread pools, actors, supervisors, and more.
+  Inspired by Erlang, Clojure, Go, JavaScript, actors, and classic concurrency patterns.
+email:
+- jerry.dantonio@gmail.com
+- concurrent-ruby@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -45,51 +28,19 @@ files:
 - LICENSE.txt
 - README.md
 - lib/concurrent.rb
-- lib/concurrent/actor.rb
-- lib/concurrent/actor/behaviour.rb
-- lib/concurrent/actor/behaviour/abstract.rb
-- lib/concurrent/actor/behaviour/awaits.rb
-- lib/concurrent/actor/behaviour/buffer.rb
-- lib/concurrent/actor/behaviour/errors_on_unknown_message.rb
-- lib/concurrent/actor/behaviour/executes_context.rb
-- lib/concurrent/actor/behaviour/linking.rb
-- lib/concurrent/actor/behaviour/pausing.rb
-- lib/concurrent/actor/behaviour/removes_child.rb
-- lib/concurrent/actor/behaviour/sets_results.rb
-- lib/concurrent/actor/behaviour/supervised.rb
-- lib/concurrent/actor/behaviour/supervising.rb
-- lib/concurrent/actor/behaviour/terminates_children.rb
-- lib/concurrent/actor/behaviour/termination.rb
-- lib/concurrent/actor/context.rb
-- lib/concurrent/actor/core.rb
-- lib/concurrent/actor/default_dead_letter_handler.rb
-- lib/concurrent/actor/envelope.rb
-- lib/concurrent/actor/errors.rb
-- lib/concurrent/actor/internal_delegations.rb
-- lib/concurrent/actor/public_delegations.rb
-- lib/concurrent/actor/reference.rb
-- lib/concurrent/actor/root.rb
-- lib/concurrent/actor/type_check.rb
-- lib/concurrent/actor/utils.rb
-- lib/concurrent/actor/utils/ad_hoc.rb
-- lib/concurrent/actor/utils/balancer.rb
-- lib/concurrent/actor/utils/broadcast.rb
-- lib/concurrent/actor/utils/pool.rb
-- lib/concurrent/actress.rb
-- lib/concurrent/agent.rb
 - lib/concurrent/async.rb
-- lib/concurrent/atomic.rb
+- lib/concurrent/atom.rb
 - lib/concurrent/atomic/atomic_boolean.rb
 - lib/concurrent/atomic/atomic_fixnum.rb
+- lib/concurrent/atomic/atomic_reference.rb
 - lib/concurrent/atomic/condition.rb
-- lib/concurrent/atomic/copy_on_notify_observer_set.rb
-- lib/concurrent/atomic/copy_on_write_observer_set.rb
 - lib/concurrent/atomic/count_down_latch.rb
 - lib/concurrent/atomic/cyclic_barrier.rb
 - lib/concurrent/atomic/event.rb
+- lib/concurrent/atomic/read_write_lock.rb
 - lib/concurrent/atomic/semaphore.rb
-- lib/concurrent/atomic/synchronization.rb
 - lib/concurrent/atomic/thread_local_var.rb
+- lib/concurrent/atomic/thread_local_var/weak_key_map.rb
 - lib/concurrent/atomic_reference/concurrent_update_error.rb
 - lib/concurrent/atomic_reference/direct_update.rb
 - lib/concurrent/atomic_reference/jruby.rb
@@ -98,23 +49,23 @@ files:
 - lib/concurrent/atomic_reference/rbx.rb
 - lib/concurrent/atomic_reference/ruby.rb
 - lib/concurrent/atomics.rb
-- lib/concurrent/channel/buffered_channel.rb
-- lib/concurrent/channel/channel.rb
-- lib/concurrent/channel/unbuffered_channel.rb
-- lib/concurrent/channel/waitable_list.rb
-- lib/concurrent/channels.rb
-- lib/concurrent/collection/blocking_ring_buffer.rb
+- lib/concurrent/collection/copy_on_notify_observer_set.rb
+- lib/concurrent/collection/copy_on_write_observer_set.rb
 - lib/concurrent/collection/priority_queue.rb
-- lib/concurrent/collection/ring_buffer.rb
-- lib/concurrent/collections.rb
+- lib/concurrent/concern/deprecation.rb
+- lib/concurrent/concern/dereferenceable.rb
+- lib/concurrent/concern/logging.rb
+- lib/concurrent/concern/obligation.rb
+- lib/concurrent/concern/observable.rb
 - lib/concurrent/configuration.rb
 - lib/concurrent/dataflow.rb
 - lib/concurrent/delay.rb
-- lib/concurrent/dereferenceable.rb
+- lib/concurrent/edge.rb
 - lib/concurrent/errors.rb
 - lib/concurrent/exchanger.rb
 - lib/concurrent/executor/cached_thread_pool.rb
 - lib/concurrent/executor/executor.rb
+- lib/concurrent/executor/executor_service.rb
 - lib/concurrent/executor/fixed_thread_pool.rb
 - lib/concurrent/executor/immediate_executor.rb
 - lib/concurrent/executor/indirect_immediate_executor.rb
@@ -122,37 +73,49 @@ files:
 - lib/concurrent/executor/java_fixed_thread_pool.rb
 - lib/concurrent/executor/java_single_thread_executor.rb
 - lib/concurrent/executor/java_thread_pool_executor.rb
-- lib/concurrent/executor/per_thread_executor.rb
 - lib/concurrent/executor/ruby_cached_thread_pool.rb
 - lib/concurrent/executor/ruby_fixed_thread_pool.rb
 - lib/concurrent/executor/ruby_single_thread_executor.rb
 - lib/concurrent/executor/ruby_thread_pool_executor.rb
-- lib/concurrent/executor/ruby_thread_pool_worker.rb
 - lib/concurrent/executor/safe_task_executor.rb
 - lib/concurrent/executor/serialized_execution.rb
+- lib/concurrent/executor/simple_executor_service.rb
 - lib/concurrent/executor/single_thread_executor.rb
 - lib/concurrent/executor/thread_pool_executor.rb
 - lib/concurrent/executor/timer_set.rb
 - lib/concurrent/executors.rb
 - lib/concurrent/future.rb
+- lib/concurrent/immutable_struct.rb
 - lib/concurrent/ivar.rb
 - lib/concurrent/lazy_register.rb
-- lib/concurrent/logging.rb
+- lib/concurrent/maybe.rb
+- lib/concurrent/mutable_struct.rb
 - lib/concurrent/mvar.rb
-- lib/concurrent/obligation.rb
-- lib/concurrent/observable.rb
-- lib/concurrent/options_parser.rb
 - lib/concurrent/promise.rb
 - lib/concurrent/scheduled_task.rb
+- lib/concurrent/settable_struct.rb
+- lib/concurrent/synchronization.rb
+- lib/concurrent/synchronization/abstract_object.rb
+- lib/concurrent/synchronization/abstract_struct.rb
+- lib/concurrent/synchronization/condition.rb
+- lib/concurrent/synchronization/java_object.rb
+- lib/concurrent/synchronization/lock.rb
+- lib/concurrent/synchronization/monitor_object.rb
+- lib/concurrent/synchronization/mutex_object.rb
+- lib/concurrent/synchronization/object.rb
+- lib/concurrent/synchronization/rbx_object.rb
 - lib/concurrent/timer_task.rb
 - lib/concurrent/tvar.rb
 - lib/concurrent/utilities.rb
-- lib/concurrent/utility/processor_count.rb
+- lib/concurrent/utility/at_exit.rb
+- lib/concurrent/utility/engine.rb
+- lib/concurrent/utility/monotonic_time.rb
+- lib/concurrent/utility/native_extension_loader.rb
+- lib/concurrent/utility/processor_counter.rb
 - lib/concurrent/utility/timeout.rb
 - lib/concurrent/utility/timer.rb
 - lib/concurrent/version.rb
 - lib/concurrent_ruby.rb
-- lib/extension_helper.rb
 homepage: http://www.concurrent-ruby.com
 licenses:
 - MIT
@@ -168,14 +131,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Modern concurrency tools for Ruby. Inspired by Erlang, Clojure, Scala, Haskell,
   F#, C#, Java, and classic concurrency patterns.
 test_files: []
+has_rdoc: 

data/lib/concurrent/actor.rb

@@ -1,103 +0,0 @@
-require 'concurrent/configuration'
-require 'concurrent/executor/serialized_execution'
-require 'concurrent/ivar'
-require 'concurrent/logging'
-require 'concurrent/atomic/synchronization'
-
-module Concurrent
-  # TODO https://github.com/celluloid/celluloid/wiki/Supervision-Groups ?
-  # TODO Remote actors using DRb
-  # TODO IO interoperation
-  # TODO un/become
-
-  # TODO doc
-  # - what happens if I try to supervise using a normal Context?
-  # - how to change behaviours
-  # - how to implement custom restarting?
-  # - pool for io operations using different executor
-  # - document guaranteed ordering
-
-  # {include:file:doc/actor/main.md}
-  module Actor
-
-    require 'concurrent/actor/type_check'
-    require 'concurrent/actor/errors'
-    require 'concurrent/actor/public_delegations'
-    require 'concurrent/actor/internal_delegations'
-    require 'concurrent/actor/envelope'
-    require 'concurrent/actor/reference'
-    require 'concurrent/actor/core'
-    require 'concurrent/actor/behaviour'
-    require 'concurrent/actor/context'
-
-    require 'concurrent/actor/default_dead_letter_handler'
-    require 'concurrent/actor/root'
-    require 'concurrent/actor/utils'
-
-    # @return [Reference, nil] current executing actor if any
-    def self.current
-      Thread.current[:__current_actor__]
-    end
-
-    @root = Delay.new do
-      Core.new(parent: nil, name: '/', class: Root, initialized: ivar = IVar.new).reference.tap do
-        ivar.no_error!
-      end
-    end
-
-    # A root actor, a default parent of all actors spawned outside an actor
-    def self.root
-      @root.value!
-    end
-
-    # Spawns a new actor.
-    #
-    # @example simple
-    #   Actor.spawn(AdHoc, :ping1) { -> message { message } }
-    #
-    # @example complex
-    #   Actor.spawn name:     :ping3,
-    #                 class:    AdHoc,
-    #                 args:     [1]
-    #                 executor: Concurrent.configuration.global_task_pool do |add|
-    #     lambda { |number| number + add }
-    #   end
-    #
-    # @param block for context_class instantiation
-    # @param args see {.spawn_optionify}
-    # @return [Reference] never the actual actor
-    def self.spawn(*args, &block)
-      if Actor.current
-        Core.new(spawn_optionify(*args).merge(parent: Actor.current), &block).reference
-      else
-        root.ask([:spawn, spawn_optionify(*args), block]).value!
-      end
-    end
-
-    # as {.spawn} but it'll raise when Actor not initialized properly
-    def self.spawn!(*args, &block)
-      spawn(spawn_optionify(*args).merge(initialized: ivar = IVar.new), &block).tap { ivar.no_error! }
-    end
-
-    # @overload spawn_optionify(context_class, name, *args)
-    #   @param [AbstractContext] context_class to be spawned
-    #   @param [String, Symbol] name of the instance, it's used to generate the {Core#path} of the actor
-    #   @param args for context_class instantiation
-    # @overload spawn_optionify(opts)
-    #   see {Core#initialize} opts
-    def self.spawn_optionify(*args)
-      if args.size == 1 && args.first.is_a?(Hash)
-        args.first
-      else
-        { class: args[0],
-          name:  args[1],
-          args:  args[2..-1] }
-      end
-    end
-
-    # call this to disable experimental warning
-    def self.i_know_it_is_experimental!
-      warn 'Method Actor.i_know_it_is_experimental! is deprecated. The Actors are no longer experimental.'
-    end
-  end
-end

data/lib/concurrent/actor/behaviour.rb

@@ -1,70 +0,0 @@
-module Concurrent
-  module Actor
-
-    # Actors have modular architecture, which is achieved by combining a light core with chain of
-    # behaviours. Each message or internal event propagates through the chain allowing the
-    # behaviours react based on their responsibility. listing few as an example:
-    #
-    # -   {Behaviour::Linking}:
-    #
-    #     > {include:Actor::Behaviour::Linking}
-    #
-    # -   {Behaviour::Awaits}:
-    #
-    #     > {include:Actor::Behaviour::Awaits}
-    #
-    # See {Behaviour}'s namespace fo other behaviours.
-    # If needed new behaviours can be added, or old one removed to get required behaviour.
-    module Behaviour
-      MESSAGE_PROCESSED = Object.new
-
-      require 'concurrent/actor/behaviour/abstract'
-      require 'concurrent/actor/behaviour/awaits'
-      require 'concurrent/actor/behaviour/buffer'
-      require 'concurrent/actor/behaviour/errors_on_unknown_message'
-      require 'concurrent/actor/behaviour/executes_context'
-      require 'concurrent/actor/behaviour/linking'
-      require 'concurrent/actor/behaviour/pausing'
-      require 'concurrent/actor/behaviour/removes_child'
-      require 'concurrent/actor/behaviour/sets_results'
-      require 'concurrent/actor/behaviour/supervised'
-      require 'concurrent/actor/behaviour/supervising'
-      require 'concurrent/actor/behaviour/termination'
-      require 'concurrent/actor/behaviour/terminates_children'
-
-      def self.basic_behaviour_definition
-        [*base,
-         *user_messages(:terminate!)]
-      end
-
-      def self.restarting_behaviour_definition
-        [*base,
-         *supervised,
-         [Behaviour::Supervising, [:reset!, :one_for_one]],
-         *user_messages(:pause!)]
-      end
-
-      def self.base
-        [[SetResults, [:terminate!]],
-         # has to be before Termination to be able to remove children form terminated actor
-         [RemovesChild, []],
-         [Termination, []],
-         [TerminatesChildren, []],
-         [Linking, []]]
-      end
-
-      def self.supervised
-        [[Supervised, []],
-         [Pausing, []]]
-      end
-
-      def self.user_messages(on_error)
-        [[Buffer, []],
-         [SetResults, [on_error]],
-         [Awaits, []],
-         [ExecutesContext, []],
-         [ErrorsOnUnknownMessage, []]]
-      end
-    end
-  end
-end