dry-effects 0.1.0.alpha2 → 0.1.0

data/lib/dry/effects/providers/lock.rb

@@ -78,10 +78,17 @@ module Dry
           backend.meta(key)
         end
 
+        # Locate handler in the stack
+        #
+        # @return [Provider]
+        # @api private
         def locate
           self
         end
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack, backend = Undefined)
           backend_replace = Undefined.default(backend) do
             parent = ::Dry::Effects.yield(Locate) { Undefined }

data/lib/dry/effects/providers/parallel.rb

@@ -15,7 +15,7 @@ module Dry
           stack = self.stack.dup
           proc do |&block|
             ::Concurrent::Promise.execute(executor: executor) do
-              Handler.spawn_fiber(stack, &block)
+              Frame.spawn_fiber(stack, &block)
             end
           end
         end
@@ -24,6 +24,9 @@ module Dry
           xs.map(&:value!)
         end
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack)
           @stack = stack
           super

data/lib/dry/effects/providers/reader.rb

@@ -34,6 +34,9 @@ module Dry
           state
         end
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack, state)
           case state
           when state_type
@@ -44,14 +47,18 @@ module Dry
           end
         end
 
+        # @return [String]
+        # @api public
         def represent
           if Undefined.equal?(state)
-            "#{type}[#{scope} unset]"
+            "#{type}[#{scope} not set]"
           else
             "#{type}[#{scope} set]"
           end
         end
 
+        # @return [Boolean]
+        # @api public
         def provide?(effect)
           effect.type.equal?(:state) && effect.name.equal?(:read) && scope.equal?(effect.scope)
         end

data/lib/dry/effects/providers/resolve.rb

@@ -38,10 +38,17 @@ module Dry
           end
         end
 
+        # Locate handler in the stack
+        #
+        # @return [Provider]
+        # @api private
         def locate
           self
         end
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack, dynamic = EMPTY_HASH, options = EMPTY_HASH)
           @dynamic = dynamic
 
@@ -56,6 +63,9 @@ module Dry
           @dynamic = EMPTY_HASH
         end
 
+        # @param [Effect] effect
+        # @return [Boolean]
+        # @api public
         def provide?(effect)
           if super
             !effect.name.equal?(:resolve) || key?(effect.payload[0])
@@ -64,15 +74,22 @@ module Dry
           end
         end
 
+        # @param [Symbol,String] key Dependency key
+        # @return [Boolean]
+        # @api public
         def key?(key)
           static.key?(key) || dynamic.key?(key) || parent&.key?(key)
         end
 
+        # @return [String]
+        # @api public
         def represent
           containers = [represent_container(static), represent_container(dynamic)].compact.join('+')
           "resolve[#{containers.empty? ? 'empty' : containers}]"
         end
 
+        # @return [String]
+        # @api private
         def represent_container(container)
           if container.is_a?(::Hash)
             container.empty? ? nil : 'hash'

data/lib/dry/effects/providers/retry.rb

@@ -15,6 +15,9 @@ module Dry
 
         attr_reader :limit
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(_, limit)
           @limit = limit
           @attempts = 0
@@ -27,7 +30,7 @@ module Dry
           end
         end
 
-        def repeat
+        def retry
           Instructions.Raise(halt.new)
         end
 
@@ -52,6 +55,8 @@ module Dry
           super && scope.equal?(effect.scope)
         end
 
+        # @return [String]
+        # @api public
         def represent
           "retry[#{scope} #{attempts}/#{limit}]"
         end

data/lib/dry/effects/providers/state.rb

@@ -16,11 +16,17 @@ module Dry
           end
         end
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack, state = Undefined)
           r = super
           [self.state, r]
         end
 
+        # @param [Effect] effect
+        # @return [Boolean]
+        # @api public
         def provide?(effect)
           effect.type.equal?(:state) && scope.equal?(effect.scope)
         end

data/lib/dry/effects/providers/timeout.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'dry/effects/provider'
+
+module Dry
+  module Effects
+    module Providers
+      class Timeout < Provider[:timeout]
+        def self.handle_method(scope, as: Undefined, **)
+          Undefined.default(as) { :with_timeout }
+        end
+
+        param :scope
+
+        def timeout
+          left = @time_out_at - read_clock
+
+          if left <= 0
+            0.0
+          else
+            left
+          end
+        end
+
+        # Yield the block with the handler installed
+        #
+        # @api private
+        def call(stack, timeout)
+          @time_out_at = read_clock + timeout
+
+          super(stack)
+        end
+
+        # @param [Effect] effect
+        # @return [Boolean]
+        # @api public
+        def provide?(effect)
+          effect.type.equal?(:timeout) && scope.equal?(effect.scope)
+        end
+
+        def read_clock
+          ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        end
+      end
+    end
+  end
+end

data/lib/dry/effects/providers/timestamp.rb

@@ -16,11 +16,38 @@ module Dry
 
         attr_reader :generator
 
+        # Yield the block with the handler installed
+        #
+        # @api private
         def call(stack, generator = Undefined, **options)
           @generator = build_generator(generator, **options)
           super(stack)
         end
 
+        def timestamp(round_to: Undefined, **options)
+          time = generator.(**options)
+
+          round = Undefined.coalesce(round_to, self.round)
+
+          if Undefined.equal?(round)
+            time
+          else
+            time.round(round)
+          end
+        end
+
+        # Locate handler in the stack
+        #
+        # @return [Provider]
+        # @api private
+        def locate
+          self
+        end
+
+        private
+
+        # @return [Proc] time generator
+        # @api private
         def build_generator(generator, step: Undefined, initial: Undefined, overridable: false)
           if overridable
             parent = ::Dry::Effects.yield(Locate) { nil }
@@ -38,22 +65,6 @@ module Dry
             RunningTimeGenerator.()
           end
         end
-
-        def timestamp(round_to: Undefined, **options)
-          time = generator.(**options)
-
-          round = Undefined.coalesce(round_to, self.round)
-
-          if Undefined.equal?(round)
-            time
-          else
-            time.round(round)
-          end
-        end
-
-        def locate
-          self
-        end
       end
     end
   end

data/lib/dry/effects/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Effects
-    VERSION = '0.1.0.alpha2'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-effects
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha2
+  version: 0.1.0
 platform: ruby
 authors:
 - Nikita Shilnikov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2019-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -179,16 +179,16 @@ files:
 - README.md
 - Rakefile
 - dry-effects.gemspec
-- examples/amb.rb
+- examples/cmp.rb
 - examples/state.rb
 - lib/dry/effects.rb
 - lib/dry/effects/all.rb
 - lib/dry/effects/constructors.rb
 - lib/dry/effects/container.rb
 - lib/dry/effects/effect.rb
-- lib/dry/effects/effects/amb.rb
 - lib/dry/effects/effects/async.rb
 - lib/dry/effects/effects/cache.rb
+- lib/dry/effects/effects/cmp.rb
 - lib/dry/effects/effects/current_time.rb
 - lib/dry/effects/effects/defer.rb
 - lib/dry/effects/effects/env.rb
@@ -202,11 +202,13 @@ files:
 - lib/dry/effects/effects/resolve.rb
 - lib/dry/effects/effects/retry.rb
 - lib/dry/effects/effects/state.rb
+- lib/dry/effects/effects/timeout.rb
 - lib/dry/effects/effects/timestamp.rb
 - lib/dry/effects/errors.rb
 - lib/dry/effects/extensions.rb
 - lib/dry/effects/extensions/auto_inject.rb
 - lib/dry/effects/extensions/system.rb
+- lib/dry/effects/frame.rb
 - lib/dry/effects/halt.rb
 - lib/dry/effects/handler.rb
 - lib/dry/effects/inflector.rb
@@ -216,9 +218,9 @@ files:
 - lib/dry/effects/instructions/raise.rb
 - lib/dry/effects/provider.rb
 - lib/dry/effects/provider/class_interface.rb
-- lib/dry/effects/providers/amb.rb
 - lib/dry/effects/providers/async.rb
 - lib/dry/effects/providers/cache.rb
+- lib/dry/effects/providers/cmp.rb
 - lib/dry/effects/providers/current_time.rb
 - lib/dry/effects/providers/current_time/time_generators.rb
 - lib/dry/effects/providers/defer.rb
@@ -233,6 +235,7 @@ files:
 - lib/dry/effects/providers/resolve.rb
 - lib/dry/effects/providers/retry.rb
 - lib/dry/effects/providers/state.rb
+- lib/dry/effects/providers/timeout.rb
 - lib/dry/effects/providers/timestamp.rb
 - lib/dry/effects/stack.rb
 - lib/dry/effects/version.rb
@@ -255,11 +258,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Algebraic effects.

data/lib/dry/effects/providers/amb.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'dry/effects/provider'
-
-module Dry
-  module Effects
-    module Providers
-      class Amb < Provider[:amb]
-        include Dry::Equalizer(:id, :value)
-
-        attr_reader :value
-
-        param :id
-
-        def get
-          value
-        end
-
-        def call(_)
-          @value = false
-          first = yield
-          @value = true
-          [first, yield]
-        end
-
-        def provide?(effect)
-          super && id.equal?(effect.id)
-        end
-
-        def represent
-          "amb[#{id}=#{@value}]"
-        end
-      end
-    end
-  end
-end