concurrent-ruby 1.0.5 → 1.1.0.pre1

data/lib/concurrent/executor/java_thread_pool_executor.rb

@@ -90,10 +90,10 @@ if Concurrent.on_jruby?
       private
 
       def ns_initialize(opts)
-        min_length = opts.fetch(:min_threads, DEFAULT_MIN_POOL_SIZE).to_i
-        max_length = opts.fetch(:max_threads, DEFAULT_MAX_POOL_SIZE).to_i
-        idletime = opts.fetch(:idletime, DEFAULT_THREAD_IDLETIMEOUT).to_i
-        @max_queue = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
+        min_length       = opts.fetch(:min_threads, DEFAULT_MIN_POOL_SIZE).to_i
+        max_length       = opts.fetch(:max_threads, DEFAULT_MAX_POOL_SIZE).to_i
+        idletime         = opts.fetch(:idletime, DEFAULT_THREAD_IDLETIMEOUT).to_i
+        @max_queue       = opts.fetch(:max_queue, DEFAULT_MAX_QUEUE_SIZE).to_i
         @fallback_policy = opts.fetch(:fallback_policy, :abort)
 
         raise ArgumentError.new("`max_threads` cannot be less than #{DEFAULT_MIN_POOL_SIZE}") if max_length < DEFAULT_MIN_POOL_SIZE
@@ -109,9 +109,12 @@ if Concurrent.on_jruby?
         end
 
         @executor = java.util.concurrent.ThreadPoolExecutor.new(
-          min_length, max_length,
-          idletime, java.util.concurrent.TimeUnit::SECONDS,
-          queue, FALLBACK_POLICY_CLASSES[@fallback_policy].new)
+            min_length,
+            max_length,
+            idletime,
+            java.util.concurrent.TimeUnit::SECONDS,
+            queue,
+            FALLBACK_POLICY_CLASSES[@fallback_policy].new)
 
         self.auto_terminate = opts.fetch(:auto_terminate, true)
       end

data/lib/concurrent/executor/single_thread_executor.rb

@@ -14,7 +14,7 @@ module Concurrent
                                        end
   private_constant :SingleThreadExecutorImplementation
 
-  # @!macro [attach] single_thread_executor
+  # @!macro single_thread_executor
   #
   #   A thread pool with a single thread an unlimited queue. Should the thread
   #   die for any reason it will be removed and replaced, thus ensuring that
@@ -35,7 +35,7 @@ module Concurrent
   # @!macro abstract_executor_service_public_api
   class SingleThreadExecutor < SingleThreadExecutorImplementation
 
-    # @!macro [new] single_thread_executor_method_initialize
+    # @!macro single_thread_executor_method_initialize
     #
     #   Create a new thread pool.
     #

data/lib/concurrent/executor/thread_pool_executor.rb

@@ -15,7 +15,7 @@ module Concurrent
                                      end
   private_constant :ThreadPoolExecutorImplementation
 
-  # @!macro [attach] thread_pool_executor
+  # @!macro thread_pool_executor
   #
   #   An abstraction composed of one or more threads and a task queue. Tasks
   #   (blocks or `proc` objects) are submitted to the pool and added to the queue.
@@ -55,12 +55,12 @@ module Concurrent
   # @!macro thread_pool_executor_public_api
   class ThreadPoolExecutor < ThreadPoolExecutorImplementation
 
-    # @!macro [new] thread_pool_executor_method_initialize
+    # @!macro thread_pool_executor_method_initialize
     #
     #   Create a new thread pool.
-    #  
+    #
     #   @param [Hash] opts the options which configure the thread pool.
-    #  
+    #
     #   @option opts [Integer] :max_threads (DEFAULT_MAX_POOL_SIZE) the maximum
     #     number of threads to be created
     #   @option opts [Integer] :min_threads (DEFAULT_MIN_POOL_SIZE) When a new task is submitted
@@ -73,12 +73,12 @@ module Concurrent
     #   @option opts [Symbol] :fallback_policy (:abort) the policy for handling new
     #     tasks that are received when the queue size has reached
     #     `max_queue` or the executor has shut down
-    #  
+    #
     #   @raise [ArgumentError] if `:max_threads` is less than one
     #   @raise [ArgumentError] if `:min_threads` is less than zero
     #   @raise [ArgumentError] if `:fallback_policy` is not one of the values specified
     #     in `FALLBACK_POLICIES`
-    #  
+    #
     #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ThreadPoolExecutor.html
 
     # @!method initialize(opts = {})

data/lib/concurrent/executor/timer_set.rb

@@ -20,7 +20,7 @@ module Concurrent
 
     # Create a new set of timed tasks.
     #
-    # @!macro [attach] executor_options
+    # @!macro executor_options
     #
     #   @param [Hash] opts the options used to specify the executor on which to perform actions
     #   @option opts [Executor] :executor when set use the given `Executor` instance.

data/lib/concurrent/future.rb

@@ -6,9 +6,12 @@ require 'concurrent/executor/safe_task_executor'
 
 require 'concurrent/options'
 
+# TODO (pitr-ch 14-Mar-2017): deprecate, Future, Promise, etc.
+
+
 module Concurrent
 
-  # {include:file:doc/future.md}
+  # {include:file:docs-source/future.md}
   #
   # @!macro copy_options
   #

data/lib/concurrent/hash.rb

@@ -2,35 +2,58 @@ require 'concurrent/utility/engine'
 require 'concurrent/thread_safe/util'
 
 module Concurrent
-  if Concurrent.on_cruby?
-
-    # @!macro [attach] concurrent_hash
-    #
-    #   A thread-safe subclass of Hash. This version locks against the object
-    #   itself for every method call, ensuring only one thread can be reading
-    #   or writing at a time. This includes iteration methods like `#each`,
-    #   which takes the lock repeatedly when reading an item.
-    #
-    #   @see http://ruby-doc.org/core-2.2.0/Hash.html Ruby standard library `Hash`
-    class Hash < ::Hash;
-    end
-
-  elsif Concurrent.on_jruby?
-    require 'jruby/synchronized'
-
-    # @!macro concurrent_hash
-    class Hash < ::Hash
-      include JRuby::Synchronized
-    end
-
-  elsif Concurrent.on_rbx? || Concurrent.on_truffle?
-    require 'monitor'
-    require 'concurrent/thread_safe/util/array_hash_rbx'
-
-    # @!macro concurrent_hash
-    class Hash < ::Hash
-    end
-
-    ThreadSafe::Util.make_synchronized_on_rbx Hash
+
+  # @!macro concurrent_hash
+  #
+  #   A thread-safe subclass of Hash. This version locks against the object
+  #   itself for every method call, ensuring only one thread can be reading
+  #   or writing at a time. This includes iteration methods like `#each`,
+  #   which takes the lock repeatedly when reading an item.
+  #
+  #   @see http://ruby-doc.org/core-2.2.0/Hash.html Ruby standard library `Hash`
+
+  # @!macro internal_implementation_note
+  HashImplementation = case
+                       when Concurrent.on_cruby?
+                         # Because MRI never runs code in parallel, the existing
+                         # non-thread-safe structures should usually work fine.
+                         ::Hash
+
+                       when Concurrent.on_jruby?
+                         require 'jruby/synchronized'
+
+                         class JRubyHash < ::Hash
+                           include JRuby::Synchronized
+                         end
+                         JRubyHash
+
+                       when Concurrent.on_rbx?
+                         require 'monitor'
+                         require 'concurrent/thread_safe/util/data_structures'
+
+                         class RbxHash < ::Hash
+                         end
+                         ThreadSafe::Util.make_synchronized_on_rbx RbxHash
+                         RbxHash
+
+                       when Concurrent.on_truffleruby?
+                         require 'concurrent/thread_safe/util/data_structures'
+
+                         class TruffleRubyHash < ::Hash
+                         end
+
+                         ThreadSafe::Util.make_synchronized_on_truffleruby TruffleRubyHash
+                         TruffleRubyHash
+
+                       else
+                         warn 'Possibly unsupported Ruby implementation'
+                         ::Hash
+                       end
+  private_constant :HashImplementation
+
+  # @!macro concurrent_hash
+  class Hash < HashImplementation
   end
+
 end
+

data/lib/concurrent/ivar.rb

@@ -98,10 +98,10 @@ module Concurrent
       observer
     end
 
-    # @!macro [attach] ivar_set_method
+    # @!macro ivar_set_method
     #   Set the `IVar` to a value and wake or notify all threads waiting on it.
     #
-    #   @!macro [attach] ivar_set_parameters_and_exceptions
+    #   @!macro ivar_set_parameters_and_exceptions
     #     @param [Object] value the value to store in the `IVar`
     #     @yield A block operation to use for setting the value
     #     @raise [ArgumentError] if both a value and a block are given
@@ -124,7 +124,7 @@ module Concurrent
       self
     end
 
-    # @!macro [attach] ivar_fail_method
+    # @!macro ivar_fail_method
     #   Set the `IVar` to failed due to some error and wake or notify all threads waiting on it.
     #
     #   @param [Object] reason for the failure
@@ -157,9 +157,8 @@ module Concurrent
       self.observers = Collection::CopyOnWriteObserverSet.new
       set_deref_options(opts)
 
-      if value == NULL
-        @state = :pending
-      else
+      @state = :pending
+      if value != NULL
         ns_complete_without_notification(true, value, nil)
       end
     end

data/lib/concurrent/map.rb

@@ -1,33 +1,27 @@
 require 'thread'
 require 'concurrent/constants'
 require 'concurrent/synchronization'
+require 'concurrent/utility/engine'
 
 module Concurrent
   # @!visibility private
   module Collection
 
     # @!visibility private
-    MapImplementation = if Concurrent.java_extensions_loaded?
+    MapImplementation = case
+                        when Concurrent.on_jruby?
                           # noinspection RubyResolve
                           JRubyMapBackend
-                        elsif defined?(RUBY_ENGINE)
-                          case RUBY_ENGINE
-                          when 'ruby'
-                            require 'concurrent/collection/map/mri_map_backend'
-                            MriMapBackend
-                          when 'rbx'
-                            require 'concurrent/collection/map/atomic_reference_map_backend'
-                            AtomicReferenceMapBackend
-                          when 'jruby+truffle'
-                            require 'concurrent/collection/map/atomic_reference_map_backend'
-                            AtomicReferenceMapBackend
-                          else
-                            warn 'Concurrent::Map: unsupported Ruby engine, using a fully synchronized Concurrent::Map implementation' if $VERBOSE
-                            require 'concurrent/collection/map/synchronized_map_backend'
-                            SynchronizedMapBackend
-                          end
-                        else
+                        when Concurrent.on_cruby?
+                          require 'concurrent/collection/map/mri_map_backend'
                           MriMapBackend
+                        when Concurrent.on_rbx? || Concurrent.on_truffleruby?
+                          require 'concurrent/collection/map/atomic_reference_map_backend'
+                          AtomicReferenceMapBackend
+                        else
+                          warn 'Concurrent::Map: unsupported Ruby engine, using a fully synchronized Concurrent::Map implementation'
+                          require 'concurrent/collection/map/synchronized_map_backend'
+                          SynchronizedMapBackend
                         end
   end
 
@@ -43,7 +37,7 @@ module Concurrent
   # > map = Concurrent::Map.new
   class Map < Collection::MapImplementation
 
-    # @!macro [new] map_method_is_atomic
+    # @!macro map_method_is_atomic
     #   This method is atomic. Atomic methods of `Map` which accept a block
     #   do not allow the `self` instance to be used within the block. Doing
     #   so will cause a deadlock.
@@ -106,7 +100,7 @@ module Concurrent
     alias_method :get, :[]
     alias_method :put, :[]=
 
-    # @!macro [attach] map_method_not_atomic
+    # @!macro map_method_not_atomic
     #   The "fetch-then-act" methods of `Map` are not atomic. `Map` is intended
     #   to be use as a concurrency primitive with strong happens-before
     #   guarantees. It is not intended to be used as a high-level abstraction
@@ -171,6 +165,11 @@ module Concurrent
       each_pair {|k, v| yield v}
     end unless method_defined?(:each_value)
 
+    def each_pair
+      return enum_for :each_pair unless block_given?
+      super
+    end
+
     alias_method :each, :each_pair unless method_defined?(:each)
 
     def key(value)
@@ -205,12 +204,8 @@ module Concurrent
     undef :freeze
 
     # @!visibility private
-    DEFAULT_OBJ_ID_STR_WIDTH = 0.size == 4 ? 7 : 14 # we want to look "native", 7 for 32-bit, 14 for 64-bit
-    # override default #inspect() method: firstly, we don't want to be spilling our guts (i-vars), secondly, MRI backend's
-    # #inspect() call on its @backend i-var will bump @backend's iter level while possibly yielding GVL
     def inspect
-      id_str = (object_id << 1).to_s(16).rjust(DEFAULT_OBJ_ID_STR_WIDTH, '0')
-      "#<#{self.class.name}:0x#{id_str} entries=#{size} default_proc=#{@default_proc.inspect}>"
+      format '%s entries=%d default_proc=%s>', to_s[0..-2], size.to_s, @default_proc.inspect
     end
 
     private

data/lib/concurrent/maybe.rb

@@ -108,7 +108,7 @@ module Concurrent
     # Indicates that the given attribute has not been set.
     # When `Just` the {#nothing} getter will return `NONE`.
     # When `Nothing` the {#just} getter will return `NONE`.
-    NONE = Object.new.freeze
+    NONE = ::Object.new.freeze
 
     # The value of a `Maybe` when `Just`. Will be `NONE` when `Nothing`.
     attr_reader :just

data/lib/concurrent/mutable_struct.rb

@@ -10,7 +10,7 @@ module Concurrent
   module MutableStruct
     include Synchronization::AbstractStruct
 
-    # @!macro [new] struct_new
+    # @!macro struct_new
     #
     #   Factory for creating new struct classes.
     #
@@ -42,7 +42,7 @@ module Concurrent
     #
     #   @see http://ruby-doc.org/core-2.2.0/Struct.html#method-c-new Ruby standard library `Struct#new`
 
-    # @!macro [attach] struct_values
+    # @!macro struct_values
     #
     #   Returns the values for this struct as an Array.
     #
@@ -53,7 +53,7 @@ module Concurrent
     end
     alias_method :to_a, :values
 
-    # @!macro [attach] struct_values_at
+    # @!macro struct_values_at
     #
     #   Returns the struct member values for each selector as an Array.
     #
@@ -64,7 +64,7 @@ module Concurrent
       synchronize { ns_values_at(indexes) }
     end
 
-    # @!macro [attach] struct_inspect
+    # @!macro struct_inspect
     #
     #   Describe the contents of this struct in a string.
     #
@@ -74,7 +74,7 @@ module Concurrent
     end
     alias_method :to_s, :inspect
 
-    # @!macro [attach] struct_merge
+    # @!macro struct_merge
     #
     #   Returns a new struct containing the contents of `other` and the contents
     #   of `self`. If no block is specified, the value for entries with duplicate
@@ -95,7 +95,7 @@ module Concurrent
       synchronize { ns_merge(other, &block) }
     end
 
-    # @!macro [attach] struct_to_h
+    # @!macro struct_to_h
     #
     #   Returns a hash containing the names and values for the struct’s members.
     #
@@ -104,11 +104,11 @@ module Concurrent
       synchronize { ns_to_h }
     end
 
-    # @!macro [attach] struct_get
+    # @!macro struct_get
     #
     #   Attribute Reference
     #
-    #   @param [Symbol, String, Integer] member the string or symbol name of the memeber
+    #   @param [Symbol, String, Integer] member the string or symbol name of the member
     #     for which to obtain the value or the member's index
     #
     #   @return [Object] the value of the given struct member or the member at the given index.
@@ -119,7 +119,7 @@ module Concurrent
       synchronize { ns_get(member) }
     end
 
-    # @!macro [attach] struct_equality
+    # @!macro struct_equality
     #
     #   Equality
     #
@@ -129,7 +129,7 @@ module Concurrent
       synchronize { ns_equality(other) }
     end
 
-    # @!macro [attach] struct_each
+    # @!macro struct_each
     #
     #   Yields the value of each struct member in order. If no block is given
     #   an enumerator is returned.
@@ -141,7 +141,7 @@ module Concurrent
       synchronize { ns_each(&block) }
     end
 
-    # @!macro [attach] struct_each_pair
+    # @!macro struct_each_pair
     #
     #   Yields the name and value of each struct member in order. If no block is
     #   given an enumerator is returned.
@@ -154,7 +154,7 @@ module Concurrent
       synchronize { ns_each_pair(&block) }
     end
 
-    # @!macro [attach] struct_select
+    # @!macro struct_select
     #
     #   Yields each member value from the struct to the block and returns an Array
     #   containing the member values from the struct for which the given block
@@ -169,13 +169,13 @@ module Concurrent
       synchronize { ns_select(&block) }
     end
 
-    # @!macro [new] struct_set
+    # @!macro struct_set
     #
     #   Attribute Assignment
     #
     #   Sets the value of the given struct member or the member at the given index.
     #
-    #   @param [Symbol, String, Integer] member the string or symbol name of the memeber
+    #   @param [Symbol, String, Integer] member the string or symbol name of the member
     #     for which to obtain the value or the member's index
     #
     #   @return [Object] the value of the given struct member or the member at the given index.
@@ -212,6 +212,7 @@ module Concurrent
         synchronize do
           clazz = Synchronization::AbstractStruct.define_struct_class(MutableStruct, Synchronization::LockableObject, name, members, &block)
           members.each_with_index do |member, index|
+            clazz.send :remove_method, member
             clazz.send(:define_method, member) do
               synchronize { @values[index] }
             end