linearly 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2fe555b7d9c61204c18afbed62318e77460a1fbb
-  data.tar.gz: 303030554164e3f5899b5b0f8c0ca9871364516d
+SHA256:
+  metadata.gz: 2528725570ecfd8cced2b0718a9859be207fa15ffd6cb265bdd5976f5eb626e4
+  data.tar.gz: 478800acf301111d2f714ccd236fa9d9cecbb0d9ffc2b09c0dddf093dd382986
 SHA512:
-  metadata.gz: 8b9ec5dbf004c950cb07a8132c82bcef3c1ee9db79bdde6e457f9790aa5612d40eef1cf0c18303b6469b8a0350d1da7d7f546f271501d34e43af854ab202fa82
-  data.tar.gz: b779d10a8578f69495451ca9af23489639818d4309621c12016fc4c8dd8344653980d5af119ab49c220585e2669dd6583ffb3c43e6f965c05071dee1c5c063ef
+  metadata.gz: 4cab82060fe000080f29ba4a01b90cbf8081af67879bc8119da01f0ea6c16fd42a6677b7490cc3135b5e004517c6521cdbc33c0d9af1fbe024f8c45c6947a97d
+  data.tar.gz: a4e40ef75656a065a48dee68662b141150dacbca4c2e1e950385fa3359bca844cf1b32bc7dac71d83dbd1d8b2493edccb472d0f4b23b62453fbb10249e700e6e

data/lib/linearly/errors/state_not_returned.rb

@@ -9,20 +9,37 @@ module Linearly
       # @return [Object]
       # @api public
       # @example
-      #   Linearly::Errors::StateNotReturned.new('surprise').value
+      #   Linearly::Errors::StateNotReturned
+      #     .new(output: 'surprise', step: 'step')
+      #     .output
       #   => "surprise"
-      attr_reader :value
+      attr_reader :output
+
+      # Name of the step that caused the error
+      #
+      # @return String
+      # @api public
+      # @example
+      #   Linearly::Errors::StateNotReturned
+      #     .new(output: 'surprise', step: 'step')
+      #     .step
+      #   => "step"
+      attr_reader :step
 
       # Constructor for the {StateNotReturned} class
       #
-      # @param value [Object]
+      # @param output: [Object]
+      # @param step: [String]
       #
       # @api public
       # @example
-      #   Linearly::Errors::StateNotReturned.new('surprise')
-      def initialize(value)
-        super("#{value.class.name} is not a Statefully::State")
-        @value = value
+      #   Linearly::Errors::StateNotReturned
+      #     .new(output: 'surprise', step: 'step')
+      def initialize(output:, step:)
+        str = output.inspect
+        super("#{str}, returned from #{step}, is not a Statefully::State")
+        @output = output
+        @step = step
       end
     end
   end

data/lib/linearly/flow.rb

@@ -3,7 +3,7 @@ require 'forwardable'
 module Linearly
   class Flow
     extend Forwardable
-    include Mixins::Reducer
+    include Mixins::StepCollection
 
     # @!method call(state)
     #   Validate the input state and run steps as long as it's a +Success+

data/lib/linearly/mixins/step_collection.rb

@@ -0,0 +1,108 @@
+require 'statefully'
+
+module Linearly
+  module Mixins
+    # {StepCollection} is a mixin to include in all classes which need to run
+    # more than one step.
+    #
+    # @api private
+    module StepCollection
+      # Keep calling steps as long as long as the state is successful
+      #
+      # This method reeks of :reek:TooManyStatements and :reek:FeatureEnvy.
+      #
+      # @param state [Statefully::State]
+      #
+      # @return [Statefully::State]
+      # @api private
+      def call(state)
+        steps.reduce(state, &Reducer.method(:reduce))
+      end
+
+      # {Reducer} encapsulates the logic required to process a single Step in
+      # a larger collection.
+      #
+      # @api private
+      class Reducer
+        # Public interface for the {Reducer}
+        #
+        # @param input [Statefully::State]
+        # @param step [Step]
+        #
+        # @return [Statefully::State]
+        # @api private
+        def self.reduce(input, step)
+          new(input: input, step: step).reduce
+        end
+
+        # Internal Reducer method to create {Step} output
+        #
+        # @return [Statefully::State]
+        # @api private
+        def reduce
+          return input if input.failed? || input.finished?
+          return input.fail(bad_output_error) unless state_returned?
+          output
+        end
+
+        private
+
+        # Return the original {Statefully::State}
+        #
+        # @return [Statefully::State]
+        # @api private
+        attr_reader :input
+
+        # Return the {Step} to run
+        #
+        # @return [Step]
+        # @api private
+        attr_reader :step
+
+        # Private constructor for the {Reducer}
+        #
+        # @param input [Statefully::State]
+        # @param step [Step]
+        #
+        # @api private
+        def initialize(input:, step:)
+          @input = input
+          @step = step
+        end
+        private_class_method :new
+
+        # Construct an {Errors::StateNotReturned} error from internal state
+        #
+        # @return [Errors::StateNotReturned]
+        # @api private
+        def bad_output_error
+          Errors::StateNotReturned.new(
+            output: output,
+            step: step.class.name,
+          )
+        end
+
+        # Create output and memoize for reuse
+        #
+        # @return [Statefully::State]
+        # @api private
+        def output
+          @output ||= begin
+            step.call(input)
+          rescue StandardError => error
+            input.fail(error)
+          end
+        end
+
+        # Check if output is an instance of {Statefully::State}
+        #
+        # @return [Boolean]
+        # @api private
+        def state_returned?
+          output.is_a?(Statefully::State)
+        end
+      end
+    end
+  end
+  private_constant :Mixins
+end

data/lib/linearly/runner.rb

@@ -3,7 +3,7 @@ module Linearly
   # validates the inputs, runs the step, and validates the outputs.
   # @api private
   class Runner
-    include Mixins::Reducer
+    include Mixins::StepCollection
 
     # Constructor for the {Runner} object
     # @param step [Step] anything that implements the +Step+ interface

data/lib/linearly/version.rb

@@ -1,3 +1,3 @@
 module Linearly
-  VERSION = '0.1.2'.freeze
+  VERSION = '0.1.3'.freeze
 end

data/lib/linearly.rb

@@ -1,5 +1,5 @@
 require 'linearly/mixins/flow_builder'
-require 'linearly/mixins/reducer'
+require 'linearly/mixins/step_collection'
 require 'linearly/errors/broken_contract'
 require 'linearly/errors/state_not_returned'
 require 'linearly/flow'

data/spec/errors/state_not_returned_spec.rb

@@ -3,11 +3,17 @@ require 'spec_helper'
 module Linearly
   module Errors
     describe StateNotReturned do
-      let(:value) { 'surprise!' }
-      let(:error) { described_class.new(value) }
+      let(:output) { 'output' }
+      let(:step) { 'step' }
+      let(:error) { described_class.new(output: output, step: step) }
 
-      it { expect(error.message).to eq 'String is not a Statefully::State' }
-      it { expect(error.value).to eq value }
+      it 'reports the right message' do
+        expect(error.message)
+          .to eq '"output", returned from step, is not a Statefully::State'
+      end
+
+      it { expect(error.output).to eq output }
+      it { expect(error.step).to eq step }
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: linearly
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Marcin Wyszynski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: statefully
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -203,7 +203,7 @@ files:
 - lib/linearly/errors/state_not_returned.rb
 - lib/linearly/flow.rb
 - lib/linearly/mixins/flow_builder.rb
-- lib/linearly/mixins/reducer.rb
+- lib/linearly/mixins/step_collection.rb
 - lib/linearly/runner.rb
 - lib/linearly/step/dynamic.rb
 - lib/linearly/step/static.rb
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Linear workflow framework based on immutable state

data/lib/linearly/mixins/reducer.rb

@@ -1,32 +0,0 @@
-require 'statefully'
-
-module Linearly
-  module Mixins
-    # {Reducer} is a mixin to include in all classes which need to run more than
-    # one step.
-    # @api private
-    module Reducer
-      # Keep calling steps as long as the state is successful
-      #
-      # This method reeks of :reek:TooManyStatements and :reek:FeatureEnvy.
-      #
-      # @param state [Statefully::State]
-      #
-      # @return [Statefully::State]
-      # @api private
-      def call(state)
-        steps.reduce(state) do |current, step|
-          break current if current.failed? || current.finished?
-          begin
-            next_state = step.call(current)
-          rescue StandardError => err
-            break current.fail(err)
-          end
-          next next_state if next_state.is_a?(Statefully::State)
-          current.fail(Errors::StateNotReturned.new(step))
-        end
-      end
-    end
-  end
-  private_constant :Mixins
-end