concurrent-ruby-edge 0.3.1 → 0.7.0

data/lib/concurrent-ruby-edge/concurrent/edge.rb

@@ -0,0 +1,21 @@
+module Concurrent
+
+  # A submodule for unstable, highly experimental features that are likely to
+  # change often and which may never become part of the core gem. Also for
+  # new, experimental version of abstractions already in the core gem.
+  #
+  # Most new features should start in this module, clearly indicating the
+  # experimental and unstable nature of the feature. Once a feature becomes
+  # more stable and is a candidate for inclusion in the core gem it should
+  # be moved up to the `Concurrent` module, where it would reside once merged
+  # into the core gem.
+  #
+  # The only exception to this is for features which *replace* features from
+  # the core gem in ways that are breaking and not backward compatible. These
+  # features should remain in this module until merged into the core gem. This
+  # will prevent namespace collisions.
+  #
+  # @!macro warn.edge
+  module Edge
+  end
+end

data/lib/concurrent-ruby-edge/concurrent/executor/wrapping_executor.rb

@@ -0,0 +1,50 @@
+require 'concurrent/synchronization/object'
+require 'concurrent/executor/executor_service'
+
+module Concurrent
+
+  # A delegating executor which modifies each task with arguments
+  # before the task is given to the target executor it delegates to.
+  # @example Count task executions
+  #   counter          = AtomicFixnum.new
+  #   count_executions = WrappingExecutor.new Concurrent.global_io_executor do |*args, &task|
+  #     [*args, -> *args { counter.increment; task.call *args }]
+  #   end
+  #   10.times { count_executions.post { :do_something } }
+  #   sleep 0.01
+  #   counter.value #=> 10
+  class WrappingExecutor < Synchronization::Object
+    safe_initialization!
+
+    include ExecutorService
+
+    # @param [Executor] executor an executor to delegate the tasks to
+    # @yield [*args, &task] A function which can modify the task with arguments
+    # @yieldparam [Array<Object>] *args the arguments submitted with the tasks
+    # @yieldparam [block] &task the task submitted to the executor to be modified
+    # @yieldreturn [Array<Object>] a new arguments and task `[*args, task]` which are submitted to the target executor
+    def initialize(executor, &wrapper)
+      super()
+      @Wrapper  = wrapper
+      @Executor = executor
+    end
+
+    # @!macro executor_service_method_post
+    #
+    # @see #initialize how the tasks can be modified
+    def post(*args, &task)
+      *args, task = @Wrapper.call(*args, &task)
+      @Executor.post(*args, &task)
+    end
+
+    # @!macro executor_service_method_can_overflow_question
+    def can_overflow?
+      @Executor.can_overflow?
+    end
+
+    # @!macro executor_service_method_serialized_question
+    def serialized?
+      @Executor.serialized?
+    end
+  end
+end

data/lib/concurrent-ruby-edge/concurrent/lazy_register.rb

@@ -0,0 +1,83 @@
+require 'concurrent/atomic/atomic_reference'
+require 'concurrent/delay'
+
+module Concurrent
+
+  # Hash-like collection that store lazy evaluated values.
+  #
+  # @!macro warn.edge
+  #
+  # @example
+  #   register = Concurrent::LazyRegister.new
+  #   #=> #<Concurrent::LazyRegister:0x007fd7ecd5e230 @Data=#<Concurrent::AtomicReference:0x007fd7ecd5e1e0>>
+  #   register[:key]
+  #   #=> nil
+  #   register.add(:key) { Concurrent::Actor.spawn!(Actor::AdHoc, :ping) { -> message { message } } }
+  #   #=> #<Concurrent::LazyRegister:0x007fd7ecd5e230 @Data=#<Concurrent::AtomicReference:0x007fd7ecd5e1e0>>
+  #   register[:key]
+  #   #=> #<Concurrent::Actor::Reference /ping (Concurrent::Actor::AdHoc)>
+  #
+  class LazyRegister < Synchronization::Object
+
+    attr_atomic(:data)
+    private :data, :data=, :swap_data, :compare_and_set_data, :update_data
+
+    def initialize
+      super
+      self.data = {}
+    end
+
+    # Element reference. Retrieves the value object corresponding to the
+    # key object. Returns nil if the key is not found. Raises an exception
+    # if the stored item raised an exception when the block was evaluated.
+    #
+    # @param [Object] key
+    # @return [Object] value stored for the key or nil if the key is not found
+    #
+    # @raise Exception when the initialization block fails
+    def [](key)
+      delay = data[key]
+      delay ? delay.value! : nil
+    end
+
+    # Returns true if the given key is present.
+    #
+    # @param [Object] key
+    # @return [true, false] if the key is registered
+    def registered?(key)
+      data.key?(key)
+    end
+
+    alias_method :key?, :registered?
+    alias_method :has_key?, :registered?
+
+    # Element assignment. Associates the value given by value with the
+    # key given by key.
+    #
+    # @param [Object] key
+    # @yield the object to store under the key
+    #
+    # @return [LazyRegister] self
+    def register(key, &block)
+      delay = Delay.new(executor: :immediate, &block)
+      update_data { |h| h.merge(key => delay) }
+      self
+    end
+
+    alias_method :add, :register
+    alias_method :store, :register
+
+    # Un-registers the object under key, realized or not.
+    #
+    # @param [Object] key
+    #
+    # @return [LazyRegister] self
+    def unregister(key)
+      update_data { |h| h.dup.tap { |j| j.delete(key) } }
+      self
+    end
+
+    alias_method :remove, :unregister
+    alias_method :delete, :unregister
+  end
+end

data/lib/{concurrent-edge.rb → concurrent-ruby-edge/concurrent-edge.rb}

@@ -1,18 +1,19 @@
 require 'concurrent'
 
+require 'concurrent/edge/version'
+
 require 'concurrent/actor'
 require 'concurrent/agent'
 require 'concurrent/channel'
-require 'concurrent/exchanger'
 require 'concurrent/lazy_register'
+require 'concurrent/executor/wrapping_executor'
 
-require 'concurrent/edge/atomic_markable_reference'
 require 'concurrent/edge/lock_free_linked_set'
 require 'concurrent/edge/lock_free_queue'
-require 'concurrent/edge/lock_free_stack'
 
-require 'concurrent/edge/promises'
 require 'concurrent/edge/cancellation'
 require 'concurrent/edge/throttle'
+require 'concurrent/edge/channel'
 
 require 'concurrent/edge/processing_actor'
+require 'concurrent/edge/erlang_actor'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: concurrent-ruby-edge
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jerry D'Antonio
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.2.0
 description: |
   These features are under active development and may change frequently. They are expected not to
   keep backward compatibility (there may also lack tests and documentation). Semantic versions will
@@ -37,65 +37,71 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - LICENSE.txt
+- CHANGELOG.md
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- lib/concurrent-edge.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/supervising.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/channel.rb
-- lib/concurrent/channel/buffer.rb
-- lib/concurrent/channel/buffer/base.rb
-- lib/concurrent/channel/buffer/buffered.rb
-- lib/concurrent/channel/buffer/dropping.rb
-- lib/concurrent/channel/buffer/sliding.rb
-- lib/concurrent/channel/buffer/ticker.rb
-- lib/concurrent/channel/buffer/timer.rb
-- lib/concurrent/channel/buffer/unbuffered.rb
-- lib/concurrent/channel/selector.rb
-- lib/concurrent/channel/selector/after_clause.rb
-- lib/concurrent/channel/selector/default_clause.rb
-- lib/concurrent/channel/selector/error_clause.rb
-- lib/concurrent/channel/selector/put_clause.rb
-- lib/concurrent/channel/selector/take_clause.rb
-- lib/concurrent/channel/tick.rb
-- lib/concurrent/edge/atomic_markable_reference.rb
-- lib/concurrent/edge/cancellation.rb
-- lib/concurrent/edge/lock_free_linked_set.rb
-- lib/concurrent/edge/lock_free_linked_set/node.rb
-- lib/concurrent/edge/lock_free_linked_set/window.rb
-- lib/concurrent/edge/lock_free_queue.rb
-- lib/concurrent/edge/lock_free_stack.rb
-- lib/concurrent/edge/old_channel_integration.rb
-- lib/concurrent/edge/processing_actor.rb
-- lib/concurrent/edge/promises.rb
-- lib/concurrent/edge/throttle.rb
+- lib/concurrent-ruby-edge/concurrent-edge.rb
+- lib/concurrent-ruby-edge/concurrent/actor.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/abstract.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/awaits.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/buffer.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/errors_on_unknown_message.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/executes_context.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/linking.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/pausing.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/removes_child.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/sets_results.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/supervising.rb
+- lib/concurrent-ruby-edge/concurrent/actor/behaviour/termination.rb
+- lib/concurrent-ruby-edge/concurrent/actor/context.rb
+- lib/concurrent-ruby-edge/concurrent/actor/core.rb
+- lib/concurrent-ruby-edge/concurrent/actor/default_dead_letter_handler.rb
+- lib/concurrent-ruby-edge/concurrent/actor/envelope.rb
+- lib/concurrent-ruby-edge/concurrent/actor/errors.rb
+- lib/concurrent-ruby-edge/concurrent/actor/internal_delegations.rb
+- lib/concurrent-ruby-edge/concurrent/actor/public_delegations.rb
+- lib/concurrent-ruby-edge/concurrent/actor/reference.rb
+- lib/concurrent-ruby-edge/concurrent/actor/root.rb
+- lib/concurrent-ruby-edge/concurrent/actor/type_check.rb
+- lib/concurrent-ruby-edge/concurrent/actor/utils.rb
+- lib/concurrent-ruby-edge/concurrent/actor/utils/ad_hoc.rb
+- lib/concurrent-ruby-edge/concurrent/actor/utils/balancer.rb
+- lib/concurrent-ruby-edge/concurrent/actor/utils/broadcast.rb
+- lib/concurrent-ruby-edge/concurrent/actor/utils/pool.rb
+- lib/concurrent-ruby-edge/concurrent/channel.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/base.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/buffered.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/dropping.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/sliding.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/ticker.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/timer.rb
+- lib/concurrent-ruby-edge/concurrent/channel/buffer/unbuffered.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector/after_clause.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector/default_clause.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector/error_clause.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector/put_clause.rb
+- lib/concurrent-ruby-edge/concurrent/channel/selector/take_clause.rb
+- lib/concurrent-ruby-edge/concurrent/channel/tick.rb
+- lib/concurrent-ruby-edge/concurrent/edge.rb
+- lib/concurrent-ruby-edge/concurrent/edge/cancellation.rb
+- lib/concurrent-ruby-edge/concurrent/edge/channel.rb
+- lib/concurrent-ruby-edge/concurrent/edge/erlang_actor.rb
+- lib/concurrent-ruby-edge/concurrent/edge/lock_free_linked_set.rb
+- lib/concurrent-ruby-edge/concurrent/edge/lock_free_linked_set/node.rb
+- lib/concurrent-ruby-edge/concurrent/edge/lock_free_linked_set/window.rb
+- lib/concurrent-ruby-edge/concurrent/edge/lock_free_queue.rb
+- lib/concurrent-ruby-edge/concurrent/edge/old_channel_integration.rb
+- lib/concurrent-ruby-edge/concurrent/edge/processing_actor.rb
+- lib/concurrent-ruby-edge/concurrent/edge/promises.rb
+- lib/concurrent-ruby-edge/concurrent/edge/throttle.rb
+- lib/concurrent-ruby-edge/concurrent/edge/version.rb
+- lib/concurrent-ruby-edge/concurrent/executor/wrapping_executor.rb
+- lib/concurrent-ruby-edge/concurrent/lazy_register.rb
 homepage: http://www.concurrent-ruby.com
 licenses:
 - MIT
@@ -103,22 +109,20 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib
+- lib/concurrent-ruby-edge
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Edge features and additions to the concurrent-ruby gem.
 test_files: []
-has_rdoc: 

data/lib/concurrent/edge/atomic_markable_reference.rb

@@ -1,184 +0,0 @@
-module Concurrent
-  module Edge
-
-    # @!macro [attach] atomic_markable_reference
-    #
-    #   An atomic reference which maintains an object reference along with a mark bit
-    #   that can be updated atomically.
-    #
-    #   @see http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/atomic/AtomicMarkableReference.html
-    #     java.util.concurrent.atomic.AtomicMarkableReference
-    class AtomicMarkableReference < ::Concurrent::Synchronization::Object
-
-      private(*attr_atomic(:reference))
-
-      # @!macro [attach] atomic_markable_reference_method_initialize
-      def initialize(value = nil, mark = false)
-        super()
-        self.reference = ImmutableArray[value, mark]
-      end
-
-      # @!macro [attach] atomic_markable_reference_method_compare_and_set
-      #
-      #   Atomically sets the value and mark to the given updated value and
-      #   mark given both:
-      #     - the current value == the expected value &&
-      #     - the current mark == the expected mark
-      #
-      #   @param [Object] expected_val the expected value
-      #   @param [Object] new_val the new value
-      #   @param [Boolean] expected_mark the expected mark
-      #   @param [Boolean] new_mark the new mark
-      #
-      #   @return [Boolean] `true` if successful. A `false` return indicates
-      #   that the actual value was not equal to the expected value or the
-      #   actual mark was not equal to the expected mark
-      def compare_and_set(expected_val, new_val, expected_mark, new_mark)
-        # Memoize a valid reference to the current AtomicReference for
-        # later comparison.
-        current = reference
-        curr_val, curr_mark = current
-
-        # Ensure that that the expected marks match.
-        return false unless expected_mark == curr_mark
-
-        if expected_val.is_a? Numeric
-          # If the object is a numeric, we need to ensure we are comparing
-          # the numerical values
-          return false unless expected_val == curr_val
-        else
-          # Otherwise, we need to ensure we are comparing the object identity.
-          # Theoretically, this could be incorrect if a user monkey-patched
-          # `Object#equal?`, but they should know that they are playing with
-          # fire at that point.
-          return false unless expected_val.equal? curr_val
-        end
-
-        prospect = ImmutableArray[new_val, new_mark]
-
-        compare_and_set_reference current, prospect
-      end
-      alias_method :compare_and_swap, :compare_and_set
-
-      # @!macro [attach] atomic_markable_reference_method_get
-      #
-      #   Gets the current reference and marked values.
-      #
-      #   @return [ImmutableArray] the current reference and marked values
-      def get
-        reference
-      end
-
-      # @!macro [attach] atomic_markable_reference_method_value
-      #
-      #   Gets the current value of the reference
-      #
-      #   @return [Object] the current value of the reference
-      def value
-        reference[0]
-      end
-
-      # @!macro [attach] atomic_markable_reference_method_mark
-      #
-      #   Gets the current marked value
-      #
-      #   @return [Boolean] the current marked value
-      def mark
-        reference[1]
-      end
-      alias_method :marked?, :mark
-
-      # @!macro [attach] atomic_markable_reference_method_set
-      #
-      #   _Unconditionally_ sets to the given value of both the reference and
-      #   the mark.
-      #
-      #   @param [Object] new_val the new value
-      #   @param [Boolean] new_mark the new mark
-      #
-      #   @return [ImmutableArray] both the new value and the new mark
-      def set(new_val, new_mark)
-        self.reference = ImmutableArray[new_val, new_mark]
-      end
-
-      # @!macro [attach] atomic_markable_reference_method_update
-      #
-      # Pass the current value and marked state to the given block, replacing it
-      # with the block's results. May retry if the value changes during the
-      # block's execution.
-      #
-      # @yield [Object] Calculate a new value and marked state for the atomic
-      #   reference using given (old) value and (old) marked
-      # @yieldparam [Object] old_val the starting value of the atomic reference
-      # @yieldparam [Boolean] old_mark the starting state of marked
-      #
-      # @return [ImmutableArray] the new value and new mark
-      def update
-        loop do
-          old_val, old_mark = reference
-          new_val, new_mark = yield old_val, old_mark
-
-          if compare_and_set old_val, new_val, old_mark, new_mark
-            return ImmutableArray[new_val, new_mark]
-          end
-        end
-      end
-
-      # @!macro [attach] atomic_markable_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 and marked state for the atomic
-      #   reference using given (old) value and (old) marked
-      # @yieldparam [Object] old_val the starting value of the atomic reference
-      # @yieldparam [Boolean] old_mark the starting state of marked
-      #
-      # @return [ImmutableArray] the new value and marked state
-      #
-      # @raise [Concurrent::ConcurrentUpdateError] if the update fails
-      def try_update!
-        old_val, old_mark = reference
-        new_val, new_mark = yield old_val, old_mark
-
-        unless compare_and_set old_val, new_val, old_mark, new_mark
-          fail ::Concurrent::ConcurrentUpdateError,
-               'AtomicMarkableReference: Update failed due to race condition.',
-               'Note: If you would like to guarantee an update, please use ' \
-               'the `AtomicMarkableReference#update` method.'
-        end
-
-        ImmutableArray[new_val, new_mark]
-      end
-
-      # @!macro [attach] atomic_markable_reference_method_try_update
-      #
-      # Pass the current value to the given block, replacing it with the
-      # block's result. Simply return nil if update fails.
-      #
-      # @yield [Object] Calculate a new value and marked state for the atomic
-      #   reference using given (old) value and (old) marked
-      # @yieldparam [Object] old_val the starting value of the atomic reference
-      # @yieldparam [Boolean] old_mark the starting state of marked
-      #
-      # @return [ImmutableArray] the new value and marked state, or nil if
-      # the update failed
-      def try_update
-        old_val, old_mark = reference
-        new_val, new_mark = yield old_val, old_mark
-
-        return unless compare_and_set old_val, new_val, old_mark, new_mark
-
-        ImmutableArray[new_val, new_mark]
-      end
-
-      # Internal/private ImmutableArray for representing pairs
-      class ImmutableArray < ::Array
-        def self.new(*args)
-          super(*args).freeze
-        end
-      end
-    end
-  end
-end