Ensure each file can be required separately

eregon · eregon · commit 45bcb660d661 · 2023-01-21T13:52:51.000+01:00
diff --git a/README.md b/README.md
@@ -271,7 +271,12 @@ Everything within this gem can be loaded simply by requiring it:
 require 'concurrent'
 ```
 
-*Requiring only specific abstractions from Concurrent Ruby is not yet supported.*
+You can also require a specific abstraction [part of the public documentation](https://ruby-concurrency.github.io/concurrent-ruby/master/index.html) since concurrent-ruby 1.2.0, for example:
+```ruby
+require 'concurrent/map'
+require 'concurrent/atomic/atomic_reference'
+require 'concurrent/executor/fixed_thread_pool'
+```
 
 To use the tools in the Edge gem it must be required separately:
 
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/abstract.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/abstract.rb
@@ -1,4 +1,6 @@
 require 'concurrent/concern/logging'
+require 'concurrent/actor/type_check'
+require 'concurrent/actor/internal_delegations'
 
 module Concurrent
   module Actor
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/awaits.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/awaits.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/buffer.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/buffer.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/errors_on_unknown_message.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/errors_on_unknown_message.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/executes_context.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/executes_context.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/linking.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/linking.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/pausing.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/pausing.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/removes_child.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/removes_child.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/sets_results.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/sets_results.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/supervising.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/supervising.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/behaviour/termination.rb b/lib/concurrent-ruby-edge/concurrent/actor/behaviour/termination.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/behaviour/abstract'
+
 module Concurrent
   module Actor
     module Behaviour
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/context.rb b/lib/concurrent-ruby-edge/concurrent/actor/context.rb
@@ -1,4 +1,6 @@
 require 'concurrent/concern/logging'
+require 'concurrent/actor/type_check'
+require 'concurrent/actor/internal_delegations'
 
 module Concurrent
   module Actor
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/core.rb b/lib/concurrent-ruby-edge/concurrent/actor/core.rb
@@ -1,11 +1,11 @@
+require 'set'
+require 'concurrent/actor/type_check'
 require 'concurrent/concern/logging'
 require 'concurrent/executors'
+require 'concurrent/synchronization/lockable_object'
 
 module Concurrent
   module Actor
-
-    require 'set'
-
     # Core of the actor.
     # @note Whole class should be considered private. An user should use {Context}s and {Reference}s only.
     # @note devel: core should not block on anything, e.g. it cannot wait on children to terminate
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/default_dead_letter_handler.rb b/lib/concurrent-ruby-edge/concurrent/actor/default_dead_letter_handler.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/context'
+
 module Concurrent
   module Actor
     class DefaultDeadLetterHandler < RestartingContext
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/envelope.rb b/lib/concurrent-ruby-edge/concurrent/actor/envelope.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/type_check'
+
 module Concurrent
   module Actor
     class Envelope
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/errors.rb b/lib/concurrent-ruby-edge/concurrent/actor/errors.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/type_check'
+
 module Concurrent
   module Actor
     Error = Class.new(StandardError)
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/internal_delegations.rb b/lib/concurrent-ruby-edge/concurrent/actor/internal_delegations.rb
@@ -1,3 +1,6 @@
+require 'logger'
+require 'concurrent/actor/public_delegations'
+
 module Concurrent
   module Actor
     module InternalDelegations
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/reference.rb b/lib/concurrent-ruby-edge/concurrent/actor/reference.rb
@@ -1,3 +1,6 @@
+require 'concurrent/actor/type_check'
+require 'concurrent/actor/public_delegations'
+
 module Concurrent
   module Actor
 
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/root.rb b/lib/concurrent-ruby-edge/concurrent/actor/root.rb
@@ -1,3 +1,6 @@
+require 'concurrent/actor/context'
+require 'concurrent/actor/core'
+
 module Concurrent
   module Actor
     # implements the root actor
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/utils/ad_hoc.rb b/lib/concurrent-ruby-edge/concurrent/actor/utils/ad_hoc.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/context'
+
 module Concurrent
   module Actor
     module Utils
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/utils/balancer.rb b/lib/concurrent-ruby-edge/concurrent/actor/utils/balancer.rb
@@ -1,3 +1,5 @@
+require 'concurrent/actor/context'
+
 module Concurrent
   module Actor
     module Utils
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/utils/broadcast.rb b/lib/concurrent-ruby-edge/concurrent/actor/utils/broadcast.rb
@@ -1,4 +1,5 @@
 require 'set'
+require 'concurrent/actor/context'
 
 module Concurrent
   module Actor
diff --git a/lib/concurrent-ruby-edge/concurrent/actor/utils/pool.rb b/lib/concurrent-ruby-edge/concurrent/actor/utils/pool.rb
@@ -1,4 +1,5 @@
 require 'concurrent/actor/utils/balancer'
+require 'concurrent/actor/context'
 
 module Concurrent
   module Actor
diff --git a/lib/concurrent-ruby-edge/concurrent/channel/buffer/dropping.rb b/lib/concurrent-ruby-edge/concurrent/channel/buffer/dropping.rb
@@ -1,4 +1,5 @@
 require 'concurrent/channel/buffer/base'
+require 'concurrent/channel/buffer/buffered'
 
 module Concurrent
   class Channel
diff --git a/lib/concurrent-ruby-edge/concurrent/channel/buffer/sliding.rb b/lib/concurrent-ruby-edge/concurrent/channel/buffer/sliding.rb
@@ -1,4 +1,5 @@
 require 'concurrent/channel/buffer/base'
+require 'concurrent/channel/buffer/buffered'
 
 module Concurrent
   class Channel
diff --git a/lib/concurrent-ruby-edge/concurrent/edge/old_channel_integration.rb b/lib/concurrent-ruby-edge/concurrent/edge/old_channel_integration.rb
@@ -1,3 +1,5 @@
+require 'concurrent/promises'
+
 module Concurrent
   module Promises
     module FactoryMethods
diff --git a/lib/concurrent-ruby/concurrent/atomic/atomic_markable_reference.rb b/lib/concurrent-ruby/concurrent/atomic/atomic_markable_reference.rb
@@ -1,3 +1,4 @@
+require 'concurrent/errors'
 require 'concurrent/synchronization/object'
 
 module Concurrent
diff --git a/lib/concurrent-ruby/concurrent/atomic/atomic_reference.rb b/lib/concurrent-ruby/concurrent/atomic/atomic_reference.rb
@@ -1,6 +1,8 @@
 require 'concurrent/utility/native_extension_loader' # load native parts first
 
+require 'concurrent/atomic_reference/atomic_direct_update'
 require 'concurrent/atomic_reference/numeric_cas_wrapper'
+require 'concurrent/atomic_reference/mutex_atomic'
 
 # Shim for TruffleRuby::AtomicReference
 if Concurrent.on_truffleruby? && !defined?(TruffleRuby::AtomicReference)
@@ -12,79 +14,6 @@ module TruffleRuby
 
 module Concurrent
 
-  # Define update methods that use direct paths
-  #
-  # @!visibility private
-  # @!macro internal_implementation_note
-  module AtomicDirectUpdate
-
-    # @!macro atomic_reference_method_update
-    #
-    #   Pass the current value to the given block, replacing it
-    #   with the block's result. May retry if the value changes
-    #   during the block's execution.
-    #
-    #   @yield [Object] Calculate a new value for the atomic reference using
-    #     given (old) value
-    #   @yieldparam [Object] old_value the starting value of the atomic reference
-    #   @return [Object] the new value
-    def update
-      true until compare_and_set(old_value = get, new_value = yield(old_value))
-      new_value
-    end
-
-    # @!macro atomic_reference_method_try_update
-    #
-    #   Pass the current value to the given block, replacing it
-    #   with the block's result. Return nil if the update fails.
-    #
-    #   @yield [Object] Calculate a new value for the atomic reference using
-    #     given (old) value
-    #   @yieldparam [Object] old_value the starting value of the atomic reference
-    #   @note This method was altered to avoid raising an exception by default.
-    #     Instead, this method now returns `nil` in case of failure. For more info,
-    #     please see: https://github.com/ruby-concurrency/concurrent-ruby/pull/336
-    #   @return [Object] the new value, or nil if update failed
-    def try_update
-      old_value = get
-      new_value = yield old_value
-
-      return unless compare_and_set old_value, new_value
-
-      new_value
-    end
-
-    # @!macro atomic_reference_method_try_update!
-    #
-    #   Pass the current value to the given block, replacing it
-    #   with the block's result. Raise an exception if the update
-    #   fails.
-    #
-    #   @yield [Object] Calculate a new value for the atomic reference using
-    #     given (old) value
-    #   @yieldparam [Object] old_value the starting value of the atomic reference
-    #   @note This behavior mimics the behavior of the original
-    #     `AtomicReference#try_update` API. The reason this was changed was to
-    #     avoid raising exceptions (which are inherently slow) by default. For more
-    #     info: https://github.com/ruby-concurrency/concurrent-ruby/pull/336
-    #   @return [Object] the new value
-    #   @raise [Concurrent::ConcurrentUpdateError] if the update fails
-    def try_update!
-      old_value = get
-      new_value = yield old_value
-      unless compare_and_set(old_value, new_value)
-        if $VERBOSE
-          raise ConcurrentUpdateError, "Update failed"
-        else
-          raise ConcurrentUpdateError, "Update failed", ConcurrentUpdateError::CONC_UP_ERR_BACKTRACE
-        end
-      end
-      new_value
-    end
-  end
-
-  require 'concurrent/atomic_reference/mutex_atomic'
-
   # @!macro atomic_reference
   #
   #   An object reference that may be updated atomically. All read and write
@@ -137,13 +66,6 @@ def try_update!
   #   @!method try_update!
   #     @!macro atomic_reference_method_try_update!
 
-
-  # @!macro internal_implementation_note
-  class ConcurrentUpdateError < ThreadError
-    # frozen pre-allocated backtrace to speed ConcurrentUpdateError
-    CONC_UP_ERR_BACKTRACE = ['backtrace elided; set verbose to enable'].freeze
-  end
-
   # @!macro internal_implementation_note
   AtomicReferenceImplementation = case
                                   when Concurrent.on_cruby? && Concurrent.c_extensions_loaded?
diff --git a/lib/concurrent-ruby/concurrent/atomic_reference/atomic_direct_update.rb b/lib/concurrent-ruby/concurrent/atomic_reference/atomic_direct_update.rb
@@ -0,0 +1,75 @@
+require 'concurrent/errors'
+
+module Concurrent
+
+  # Define update methods that use direct paths
+  #
+  # @!visibility private
+  # @!macro internal_implementation_note
+  module AtomicDirectUpdate
+
+    # @!macro atomic_reference_method_update
+    #
+    #   Pass the current value to the given block, replacing it
+    #   with the block's result. May retry if the value changes
+    #   during the block's execution.
+    #
+    #   @yield [Object] Calculate a new value for the atomic reference using
+    #     given (old) value
+    #   @yieldparam [Object] old_value the starting value of the atomic reference
+    #   @return [Object] the new value
+    def update
+      true until compare_and_set(old_value = get, new_value = yield(old_value))
+      new_value
+    end
+
+    # @!macro atomic_reference_method_try_update
+    #
+    #   Pass the current value to the given block, replacing it
+    #   with the block's result. Return nil if the update fails.
+    #
+    #   @yield [Object] Calculate a new value for the atomic reference using
+    #     given (old) value
+    #   @yieldparam [Object] old_value the starting value of the atomic reference
+    #   @note This method was altered to avoid raising an exception by default.
+    #     Instead, this method now returns `nil` in case of failure. For more info,
+    #     please see: https://github.com/ruby-concurrency/concurrent-ruby/pull/336
+    #   @return [Object] the new value, or nil if update failed
+    def try_update
+      old_value = get
+      new_value = yield old_value
+
+      return unless compare_and_set old_value, new_value
+
+      new_value
+    end
+
+    # @!macro atomic_reference_method_try_update!
+    #
+    #   Pass the current value to the given block, replacing it
+    #   with the block's result. Raise an exception if the update
+    #   fails.
+    #
+    #   @yield [Object] Calculate a new value for the atomic reference using
+    #     given (old) value
+    #   @yieldparam [Object] old_value the starting value of the atomic reference
+    #   @note This behavior mimics the behavior of the original
+    #     `AtomicReference#try_update` API. The reason this was changed was to
+    #     avoid raising exceptions (which are inherently slow) by default. For more
+    #     info: https://github.com/ruby-concurrency/concurrent-ruby/pull/336
+    #   @return [Object] the new value
+    #   @raise [Concurrent::ConcurrentUpdateError] if the update fails
+    def try_update!
+      old_value = get
+      new_value = yield old_value
+      unless compare_and_set(old_value, new_value)
+        if $VERBOSE
+          raise ConcurrentUpdateError, "Update failed"
+        else
+          raise ConcurrentUpdateError, "Update failed", ConcurrentUpdateError::CONC_UP_ERR_BACKTRACE
+        end
+      end
+      new_value
+    end
+  end
+end
diff --git a/lib/concurrent-ruby/concurrent/atomic_reference/mutex_atomic.rb b/lib/concurrent-ruby/concurrent/atomic_reference/mutex_atomic.rb
@@ -1,3 +1,5 @@
+require 'concurrent/atomic_reference/atomic_direct_update'
+require 'concurrent/atomic_reference/numeric_cas_wrapper'
 require 'concurrent/synchronization/safe_initialization'
 
 module Concurrent
diff --git a/lib/concurrent-ruby/concurrent/collection/lock_free_stack.rb b/lib/concurrent-ruby/concurrent/collection/lock_free_stack.rb
@@ -1,3 +1,5 @@
+require 'concurrent/synchronization/object'
+
 module Concurrent
 
   # @!macro warn.edge
diff --git a/lib/concurrent-ruby/concurrent/errors.rb b/lib/concurrent-ruby/concurrent/errors.rb
@@ -66,4 +66,9 @@ def initialize(errors, message = "#{errors.size} errors")
     end
   end
 
+  # @!macro internal_implementation_note
+  class ConcurrentUpdateError < ThreadError
+    # frozen pre-allocated backtrace to speed ConcurrentUpdateError
+    CONC_UP_ERR_BACKTRACE = ['backtrace elided; set verbose to enable'].freeze
+  end
 end
diff --git a/lib/concurrent-ruby/concurrent/synchronization/mutex_lockable_object.rb b/lib/concurrent-ruby/concurrent/synchronization/mutex_lockable_object.rb
@@ -1,3 +1,5 @@
+require 'concurrent/synchronization/abstract_lockable_object'
+
 module Concurrent
   # noinspection RubyInstanceVariableNamingConvention
   module Synchronization
diff --git a/lib/concurrent-ruby/concurrent/thread_safe/util/cheap_lockable.rb b/lib/concurrent-ruby/concurrent/thread_safe/util/cheap_lockable.rb
diff --git a/lib/concurrent-ruby/concurrent/thread_safe/util/data_structures.rb b/lib/concurrent-ruby/concurrent/thread_safe/util/data_structures.rb
diff --git a/spec/concurrent/require_all_files_separately.rb b/spec/concurrent/require_all_files_separately.rb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+require 'concurrent/actor/behaviour/abstract'`
	`2`	`+`
`1`	`3`	`module Concurrent`
`2`	`4`	`module Actor`
`3`	`5`	`module Behaviour`