concurrent-ruby-edge 0.2.0.pre2 → 0.2.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c02c328ebe5aaf45aaf86106223e979107a4ea99
-  data.tar.gz: 425af0cce7f688a07e0546922c916877c2b4277a
+  metadata.gz: a4d13aad3839f1bfa159af7cc02464800dd062fb
+  data.tar.gz: 936d530a0a9368d1947339a2d83a6d9f36c979fd
 SHA512:
-  metadata.gz: 877ef401c5cb31943832dd1a27f592e65b261608744b1d1b00e0210f82d9ae7d246fd3d224a78cbe64aa1533cf88b5c77338985bcaf7a29a8ceb7f29174bbb32
-  data.tar.gz: d3aa66b036246d9af5f5ba0fff8ec7b46943a7c5d8fcbfcf52e4166c40a9b3fd1a80e335aaea539a756f21210a12ccd981243409d94a99fb9c4c874fe31d74bb
+  metadata.gz: f0fd846fc8ab69642ac313f12e298547ec1958d98c50466ceae1df09df7d047eccea65426fb3c04cb5d4433c933cc73f2ffb60ad81bd4f36a97418c11e58b37d
+  data.tar.gz: d3a92fbc3ebfb09256ba159b4016c0b0caaa371c762ccfb47d01789a09cd8d906f7052f6fa37f2b5c6d7057aff1561f384fe5e032cf25347663a3e93885b0c41

data/README.md

@@ -130,8 +130,10 @@ be obeyed though. Features developed in `concurrent-ruby-edge` are expected to m
   `Promise`, `IVar`, `Event`, `dataflow`, `Delay`, and `TimerTask` into a single framework. It extensively uses the
   new synchronization layer to make all the features **non-blocking** and **lock-free**, with the exception of obviously blocking
   operations like `#wait`, `#value`. It also offers better performance.
-* [Channel](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Channel.html):
-  Communicating Sequential Processes (CSP).
+* [Channel](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Edge/Channel.html):
+  Communicating Sequential Processes ([CSP](https://en.wikipedia.org/wiki/Communicating_sequential_processes)).
+  Functionally equivalent to Go [channels](https://tour.golang.org/concurrency/2) with additional
+  inspiration from Clojure [core.async](https://clojure.github.io/core.async/).
 * [LazyRegister](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/LazyRegister.html)
 * [AtomicMarkableReference](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Edge/AtomicMarkableReference.html)
 * [LockFreeLinkedSet](http://ruby-concurrency.github.io/concurrent-ruby/Concurrent/Edge/LockFreeLinkedSet.html)
@@ -142,10 +144,10 @@ be obeyed though. Features developed in `concurrent-ruby-edge` are expected to m
 *Why are these not in core?*
 
 - **Actor** - Partial documentation and tests; depends on new future/promise framework; stability is good.
-- **Future/Promise Framework** - API changes; partial documentation and tests; stability good.
-- **Channel** - Missing documentation; limited features; stability good.
+- **Channel** - Brand new implementation; partial documentation and tests; stability is good.
+- **Future/Promise Framework** - API changes; partial documentation and tests; stability is good.
 - **LazyRegister** - Missing documentation and tests.
-- **AtomicMarkableReference, LockFreeLinkedSet, LockFreeStack** - Need real world battle testing
+- **AtomicMarkableReference, LockFreeLinkedSet, LockFreeStack** - Need real world battle testing.
 
 ## Usage
 

data/lib/concurrent/channel.rb

@@ -1,6 +1,272 @@
-require 'concurrent/channel/blocking_ring_buffer'
-require 'concurrent/channel/buffered_channel'
-require 'concurrent/channel/channel'
-require 'concurrent/channel/ring_buffer'
-require 'concurrent/channel/unbuffered_channel'
-require 'concurrent/channel/waitable_list'
+require 'concurrent/channel/buffer'
+require 'concurrent/channel/selector'
+
+require 'concurrent/maybe'
+require 'concurrent/executor/cached_thread_pool'
+
+module Concurrent
+
+  # {include:file:doc/channel.md}
+  class Channel
+    include Enumerable
+
+    GOROUTINES = Concurrent::CachedThreadPool.new
+    private_constant :GOROUTINES
+
+    BUFFER_TYPES = {
+      unbuffered: Buffer::Unbuffered,
+      buffered: Buffer::Buffered,
+      dropping: Buffer::Dropping,
+      sliding: Buffer::Sliding
+    }.freeze
+    private_constant :BUFFER_TYPES
+
+    DEFAULT_VALIDATOR = ->(value){ true }
+    private_constant :DEFAULT_VALIDATOR
+
+    Error = Class.new(StandardError)
+
+    class ValidationError < Error
+      def initialize(message = nil)
+        message ||= 'invalid value'
+      end
+    end
+
+    def initialize(opts = {})
+      # undocumented -- for internal use only
+      if opts.is_a? Buffer::Base
+        @buffer = opts
+        return
+      end
+
+      size = opts[:size]
+      buffer = opts[:buffer]
+
+      if size && buffer == :unbuffered
+        raise ArgumentError.new('unbuffered channels cannot have a size')
+      elsif size.nil? && buffer.nil?
+        @buffer = BUFFER_TYPES[:unbuffered].new
+      elsif size == 0 && buffer == :buffered
+        @buffer = BUFFER_TYPES[:unbuffered].new
+      elsif buffer == :unbuffered
+        @buffer = BUFFER_TYPES[:unbuffered].new
+      elsif size.nil? || size < 1
+        raise ArgumentError.new('size must be at least 1 for this buffer type')
+      else
+        buffer ||= :buffered
+        @buffer = BUFFER_TYPES[buffer].new(size)
+      end
+
+      @validator = opts.fetch(:validator, DEFAULT_VALIDATOR)
+    end
+
+    def size
+      @buffer.size
+    end
+    alias_method :capacity, :size
+
+    def put(item)
+      return false unless validate(item, false, false)
+      do_put(item)
+    end
+    alias_method :send, :put
+    alias_method :<<, :put
+
+    def put!(item)
+      validate(item, false, true)
+      ok = do_put(item)
+      raise Error if !ok
+      ok
+    end
+
+    def put?(item)
+      if !validate(item, true, false)
+        Concurrent::Maybe.nothing('invalid value')
+      elsif do_put(item)
+        Concurrent::Maybe.just(true)
+      else
+        Concurrent::Maybe.nothing
+      end
+    end
+
+    def offer(item)
+      return false unless validate(item, false, false)
+      do_offer(item)
+    end
+
+    def offer!(item)
+      validate(item, false, true)
+      ok = do_offer(item)
+      raise Error if !ok
+      ok
+    end
+
+    def offer?(item)
+      if !validate(item, true, false)
+        Concurrent::Maybe.nothing('invalid value')
+      elsif do_offer(item)
+        Concurrent::Maybe.just(true)
+      else
+        Concurrent::Maybe.nothing
+      end
+    end
+
+    def take
+      item, _ = self.next
+      item
+    end
+    alias_method :receive, :take
+    alias_method :~, :take
+
+    def take!
+      item, _ = do_next
+      raise Error if item == Buffer::NO_VALUE
+      item
+    end
+
+    def take?
+      item, _ = self.next?
+      item
+    end
+
+    #
+    #   @example
+    #
+    #     jobs = Channel.new
+    #
+    #     Channel.go do
+    #       loop do
+    #         j, more = jobs.next
+    #         if more
+    #           print "received job #{j}\n"
+    #         else
+    #           print "received all jobs\n"
+    #           break
+    #         end
+    #       end
+    #     end
+    def next
+      item, more = do_next
+      item = nil if item == Buffer::NO_VALUE
+      return item, more
+    end
+
+    def next?
+      item, more = do_next
+      item = if item == Buffer::NO_VALUE
+               Concurrent::Maybe.nothing
+             else
+               Concurrent::Maybe.just(item)
+             end
+      return item, more
+    end
+
+    def poll
+      (item = do_poll) == Buffer::NO_VALUE ? nil : item
+    end
+
+    def poll!
+      item = do_poll
+      raise Error if item == Buffer::NO_VALUE
+      item
+    end
+
+    def poll?
+      if (item = do_poll) == Buffer::NO_VALUE
+        Concurrent::Maybe.nothing
+      else
+        Concurrent::Maybe.just(item)
+      end
+    end
+
+    def each
+      raise ArgumentError.new('no block given') unless block_given?
+      loop do
+        item, more = do_next
+        if item != Buffer::NO_VALUE
+          yield(item)
+        elsif !more
+          break
+        end
+      end
+    end
+
+    def close
+      @buffer.close
+    end
+    alias_method :stop, :close
+
+    class << self
+      def timer(seconds)
+        Channel.new(Buffer::Timer.new(seconds))
+      end
+      alias_method :after, :timer
+
+      def ticker(interval)
+        Channel.new(Buffer::Ticker.new(interval))
+      end
+      alias_method :tick, :ticker
+
+      def select(*args)
+        raise ArgumentError.new('no block given') unless block_given?
+        selector = Selector.new
+        yield(selector, *args)
+        selector.execute
+      end
+      alias_method :alt, :select
+
+      def go(*args, &block)
+        go_via(GOROUTINES, *args, &block)
+      end
+
+      def go_via(executor, *args, &block)
+        raise ArgumentError.new('no block given') unless block_given?
+        executor.post(*args, &block)
+      end
+
+      def go_loop(*args, &block)
+        go_loop_via(GOROUTINES, *args, &block)
+      end
+
+      def go_loop_via(executor, *args, &block)
+        raise ArgumentError.new('no block given') unless block_given?
+        executor.post(block, *args) do
+          loop do
+            break unless block.call(*args)
+          end
+        end
+      end
+    end
+
+    private
+
+    def validate(value, allow_nil, raise_error)
+      if !allow_nil && value.nil?
+        raise_error ? raise(ValidationError.new('nil is not a valid value')) : false
+      elsif !@validator.call(value)
+        raise_error ? raise(ValidationError) : false
+      else
+        true
+      end
+    rescue => ex
+      # the validator raised an exception
+      return raise_error ? raise(ex) : false
+    end
+
+    def do_put(item)
+      @buffer.put(item)
+    end
+
+    def do_offer(item)
+      @buffer.offer(item)
+    end
+
+    def do_next
+      @buffer.next
+    end
+
+    def do_poll
+      @buffer.poll
+    end
+  end
+end

data/lib/concurrent/channel/buffer.rb

@@ -0,0 +1,9 @@
+require 'concurrent/channel/buffer/base'
+
+require 'concurrent/channel/buffer/buffered'
+require 'concurrent/channel/buffer/dropping'
+require 'concurrent/channel/buffer/sliding'
+require 'concurrent/channel/buffer/unbuffered'
+
+require 'concurrent/channel/buffer/ticker'
+require 'concurrent/channel/buffer/timer'

data/lib/concurrent/channel/buffer/base.rb

@@ -0,0 +1,197 @@
+require 'concurrent/synchronization/lockable_object'
+
+module Concurrent
+  class Channel
+    module Buffer
+
+      # Placeholder for when a buffer slot contains no value.
+      NO_VALUE = Object.new
+
+      # Abstract base class for all Channel buffers.
+      #
+      # {Concurrent::Channel} objects maintain an internal, queue-like
+      # object called a buffer. It's the storage bin for values put onto or
+      # taken from the channel. Different buffer types have different
+      # characteristics. Subsequently, the behavior of any given channel is
+      # highly dependent uping the type of its buffer. This is the base class
+      # which defines the common buffer interface. Any class intended to be
+      # used as a channel buffer should extend this class.
+      class Base < Synchronization::LockableObject
+
+        # @!macro [attach] channel_buffer_size_reader
+        #
+        #   The maximum number of values which can be {#put} onto the buffer
+        #   it becomes full.
+        attr_reader :size
+        alias_method :capacity, :size
+
+        # @!macro [attach] channel_buffer_initialize
+        #
+        #   Creates a new buffer.
+        def initialize
+          super()
+          synchronize do
+            @closed = false
+            @size = 0
+          end
+        end
+
+        # @!macro [attach] channel_buffer_blocking_question
+        #
+        #   Predicate indicating if this buffer will block {#put} operations
+        #   once it reaches its maximum capacity.
+        #
+        #   @return [Boolean] true if this buffer blocks else false
+        def blocking?
+          true
+        end
+
+        # @!macro [attach] channel_buffer_empty_question
+        #
+        #   Predicate indicating if the buffer is empty.
+        #
+        #   @return [Boolean] true if this buffer is empty else false
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def empty?
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_full_question
+        #
+        #   Predicate indicating if the buffer is full.
+        #
+        #   @return [Boolean] true if this buffer is full else false
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def full?
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_put
+        #
+        #   Put an item onto the buffer if possible. If the buffer is open
+        #   but not able to accept the item the calling thread will block
+        #   until the item can be put onto the buffer.
+        #
+        #   @param [Object] item the item/value to put onto the buffer.
+        #   @return [Boolean] true if the item was added to the buffer else
+        #     false (always false when closed).
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def put(item)
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_offer
+        #
+        #   Put an item onto the buffer is possible. If the buffer is open but
+        #   unable to add an item, probably due to being full, the method will
+        #   return immediately. Similarly, the method will return immediately
+        #   when the buffer is closed. A return value of `false` does not
+        #   necessarily indicate that the buffer is closed, just that the item
+        #   could not be added.
+        #
+        #   @param [Object] item the item/value to put onto the buffer.
+        #   @return [Boolean] true if the item was added to the buffer else
+        #     false (always false when closed).
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def offer(item)
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_take
+        #
+        #   Take an item from the buffer if one is available. If the buffer
+        #   is open and no item is available the calling thread will block
+        #   until an item is available. If the buffer is closed but items
+        #   are available the remaining items can still be taken. Once the
+        #   buffer closes, no remaining items can be taken.
+        #
+        #   @return [Object] the item removed from the buffer; `NO_VALUE` once
+        #     the buffer has closed.
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def take
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_next
+        #
+        #   Take the next item from the buffer and also return a boolean
+        #   indicating if subsequent items can be taken. Used for iterating
+        #   over a buffer until it is closed and empty.
+        #
+        #   If the buffer is open but no items remain the calling thread will
+        #   block until an item is available. The second of the two return
+        #   values, a boolean, will always be `true` when the buffer is open.
+        #   When the buffer is closed but more items remain the second return
+        #   value will also be `true`. When the buffer is closed and the last
+        #   item is taken the second return value will be `false`. When the
+        #   buffer is both closed and empty the first return value will be
+        #   `NO_VALUE` and the second return value will be `false`.
+        #   be `false` when the buffer is both closed and empty.
+        #
+        #   Note that when multiple threads access the same channel a race
+        #   condition can occur when using this method. A call to `next` from
+        #   one thread may return `true` for the second return value, but
+        #   another thread may `take` the last value before the original
+        #   thread makes another call. Code which iterates over a channel
+        #   must be programmed to properly handle these race conditions.
+        #
+        #   @return [Object, Boolean] the first return value will be the item
+        #     taken from the buffer and the second return value will be a
+        #     boolean indicating whether or not more items remain.
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def next
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_poll
+        #
+        #   Take the next item from the buffer if one is available else return
+        #   immediately. Failing to return a value does not necessarily
+        #   indicate that the buffer is closed, just that it is empty.
+        #
+        #   @return [Object] the next item from the buffer or `NO_VALUE` if
+        #     the buffer is empty.
+        #
+        # @raise [NotImplementedError] until overridden in a subclass.
+        def poll
+          raise NotImplementedError
+        end
+
+        # @!macro [attach] channel_buffer_close
+        #
+        #   Close the buffer, preventing new items from being added. Once a
+        #   buffer is closed it cannot be opened again.
+        #
+        #   @return [Boolean] true if the buffer was open and successfully
+        #     closed else false.
+        def close
+          synchronize do
+            @closed ? false : @closed = true
+          end
+        end
+
+        # @!macro [attach] channel_buffer_closed_question
+        #
+        #   Predicate indicating is this buffer closed.
+        #
+        #   @return [Boolea] true when closed else false.
+        def closed?
+          synchronize { ns_closed? }
+        end
+
+        private
+
+        # @!macro channel_buffer_closed_question
+        def ns_closed?
+          @closed
+        end
+      end
+    end
+  end
+end