teckel 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf2c470202a0d90fbc79ed7d6c7e065634f34f6237d01d8d9772489f7ba43e94
-  data.tar.gz: 0b2937e820b2f61bf37d835521c6b981e95e50c3f1ef4d5e968ee38dfea7c5fa
+  metadata.gz: d55dd7fb782cfdcb3cc960423e46ab2ce8b49c9396273f10749105883d55ed6f
+  data.tar.gz: e3b7428d98daeb42cc086b4a5cd5081b5c3b4ca90c14b0cf3f4cd9576243d0e3
 SHA512:
-  metadata.gz: 3cf2096a7827c2547e6c4cc135657d68dcc597d057e202d0c8cda91753eee09648133e3c6728a3ae1ec14f140fe562b2648ae77439cccfa015a5130326557fba
-  data.tar.gz: 5f13605ac5dc726ce964a85225d1e860a22d00b8eabae78616fa998e77c94ec7251f1367f07175868e8724477bc95c27945d93e23bee0da68303a452a1180e09
+  metadata.gz: '0148d426e8e7124a08a3a7dd3c42487cac5944d17ba9cabb98a8c378a86a5d9813b7b62c483d2203809644528d2e6b6cc4de51476aa67261b1405f3f41576613'
+  data.tar.gz: 6792ad4806b977d21d0ea621e311306cb13c239d8604e35e61937e79ce4f5488cbb410aa6ae22e9e12e48b61529f97e924aab22e100717808885c0b0c76980fd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## 0.6.0
+
+- Breaking: Operations return values will be ignored. [GH-21]
+  * You'll need to use `success!` or `failure!` 
+  * `success!` and `failure!` are now implemented on the `Runner`, which makes it easier to change their behavior (including the one above).
+
 ## 0.5.0
 
 - Fix: calling chain with settings and no input [GH-14]

data/lib/teckel/chain/config.rb

@@ -41,7 +41,7 @@ module Teckel
       #     output input
       #
       #     def call(hsh)
-      #       hsh
+      #       success!(hsh)
       #     end
       #   end
       #
@@ -139,7 +139,7 @@ module Teckel
       #     error none
       #
       #     def call(_)
-      #       settings.to_h
+      #       success!(settings.to_h)
       #     end
       #   end
       #
@@ -216,7 +216,7 @@ module Teckel
 
       # @!visibility private
       def inherited(subclass)
-        dup_config(subclass)
+        super dup_config(subclass)
       end
 
       # @!visibility private

data/lib/teckel/operation.rb

@@ -140,9 +140,6 @@ module Teckel
       #
       #       # when using `output none`:
       #       # `success!` works, but `success!("data")` raises an error
-      #       # same thing when using simple return values as success:
-      #       # take care to not return anything
-      #       nil
       #     end
       #   end
       #
@@ -153,26 +150,39 @@ module Teckel
     end
 
     module InstanceMethods
+      # @!method call(input)
+      # @abstract
+      # @see Operation
+      # @see ClassMethods#call
+      #
+      # The entry point for your operation. It needs to always accept an input value, even when
+      # using +input none+.
+      # If your Operation expects to generate success or failure outputs, you need to use either
+      # {.success!} or {.fail!} respectively. Simple return values will get ignored by default. See
+      # {Teckel::Operation::Config#runner} and {Teckel::Operation::Runner} on how to overwrite.
+
       # @!attribute [r] settings()
       # @return [Class,nil] When executed with settings, an instance of the
       #   configured {.settings} class. Otherwise +nil+
       # @see ClassMethods#settings
       # @!visibility public
 
-      # Halt any further execution with a output value
+      # Delegates to the configured Runner.
+      # The default behavior is to halt any further execution with a output value.
       #
-      # @return a thing matching your {Teckel::Operation::Config#output output} definition
+      # @see Teckel::Operation::Runner#success!
       # @!visibility protected
       def success!(*args)
-        throw :success, args
+        runner.success!(*args)
       end
 
-      # Halt any further execution with an error value
+      # Delegates to the configured Runner.
+      # The default behavior is to halt any further execution with an error value.
       #
-      # @return a thing matching your {Teckel::Operation::Config#error error} definition
+      # @see Teckel::Operation::Runner#fail!
       # @!visibility protected
       def fail!(*args)
-        throw :failure, args
+        runner.fail!(*args)
       end
     end
 

data/lib/teckel/operation/config.rb

@@ -362,12 +362,14 @@ module Teckel
       # @!visibility private
       def inherited(subclass)
         subclass.instance_variable_set(:@config, @config.dup)
+        super subclass
       end
 
       # @!visibility private
       def self.extended(base)
         base.instance_exec do
           @config = Teckel::Config.new
+          attr_accessor :runner
           attr_accessor :settings
         end
       end

data/lib/teckel/operation/runner.rb

@@ -16,14 +16,14 @@ module Teckel
       attr_reader :operation, :settings
 
       def call(input = nil)
-        err = catch(:failure) do
-          simple_return = UNDEFINED
+        catch(:failure) do
           out = catch(:success) do
-            simple_return = run(build_input(input))
+            run operation.input_constructor.call(input)
+            return nil # :sic!: return values need to go through +success!+
           end
-          return simple_return == UNDEFINED ? build_output(*out) : build_output(simple_return)
+
+          return out
         end
-        build_error(*err)
       end
 
       # This is just here to raise a meaningful error.
@@ -32,19 +32,11 @@ module Teckel
         raise Teckel::Error, "Operation already has settings assigned."
       end
 
-      private
-
-      def run(input)
-        op = @operation.new
-        op.settings = settings if settings != UNDEFINED
-        op.call(input)
-      end
-
-      def build_input(input)
-        operation.input_constructor.call(input)
-      end
-
-      def build_output(*args)
+      # Halt any further execution with a output value
+      #
+      # @return a thing matching your {Teckel::Operation::Config#output output} definition
+      # @!visibility protected
+      def success!(*args)
         value =
           if args.size == 1 && operation.output === args.first # rubocop:disable Style/CaseEquality
             args.first
@@ -52,10 +44,14 @@ module Teckel
             operation.output_constructor.call(*args)
           end
 
-        operation.result_constructor.call(value, true)
+        throw :success, operation.result_constructor.call(value, true)
       end
 
-      def build_error(*args)
+      # Halt any further execution with an error value
+      #
+      # @return a thing matching your {Teckel::Operation::Config#error error} definition
+      # @!visibility protected
+      def fail!(*args)
         value =
           if args.size == 1 && operation.error === args.first # rubocop:disable Style/CaseEquality
             args.first
@@ -63,7 +59,16 @@ module Teckel
             operation.error_constructor.call(*args)
           end
 
-        operation.result_constructor.call(value, false)
+        throw :failure, operation.result_constructor.call(value, false)
+      end
+
+      private
+
+      def run(input)
+        op = @operation.new
+        op.runner = self
+        op.settings = settings if settings != UNDEFINED
+        op.call(input)
       end
     end
   end

data/lib/teckel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Teckel
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/chain/default_settings_spec.rb

@@ -1,32 +1,32 @@
 # frozen_string_literal: true
 
-RSpec.describe Teckel::Chain do
-  module TeckelChainDefaultSettingsTest
-    class MyOperation
-      include Teckel::Operation
-      result!
+module TeckelChainDefaultSettingsTest
+  class MyOperation
+    include Teckel::Operation
+    result!
 
-      settings Struct.new(:say, :other)
-      settings_constructor ->(data) { settings.new(*data.values_at(*settings.members)) } # ruby 2.4 way for `keyword_init: true`
+    settings Struct.new(:say, :other)
+    settings_constructor ->(data) { settings.new(*data.values_at(*settings.members)) } # ruby 2.4 way for `keyword_init: true`
 
-      input none
-      output Hash
-      error none
+    input none
+    output Hash
+    error none
 
-      def call(_)
-        settings.to_h
-      end
+    def call(_)
+      success! settings.to_h
     end
+  end
 
-    class Chain
-      include Teckel::Chain
+  class Chain
+    include Teckel::Chain
 
-      default_settings!(a: { say: "Chain Default" })
+    default_settings!(a: { say: "Chain Default" })
 
-      step :a, MyOperation
-    end
+    step :a, MyOperation
   end
+end
 
+RSpec.describe Teckel::Chain do
   specify "call chain without settings, uses default settings" do
     result = TeckelChainDefaultSettingsTest::Chain.call
     expect(result.success).to eq(say: "Chain Default", other: nil)

data/spec/chain/inheritance_spec.rb

@@ -3,72 +3,72 @@
 require 'support/dry_base'
 require 'support/fake_models'
 
-RSpec.describe Teckel::Chain do
-  module TeckelChainDefaultsViaBaseClass
-    LOG = [] # rubocop:disable Style/MutableConstant
-
-    class LoggingChain
-      include Teckel::Chain
+module TeckelChainDefaultsViaBaseClass
+  LOG = [] # rubocop:disable Style/MutableConstant
 
-      around do |chain, input|
-        require 'benchmark'
-        result = nil
-        LOG << Benchmark.measure { result = chain.call(input) }
-        result
-      end
+  class LoggingChain
+    include Teckel::Chain
 
-      freeze
+    around do |chain, input|
+      require 'benchmark'
+      result = nil
+      LOG << Benchmark.measure { result = chain.call(input) }
+      result
     end
 
-    class OperationA
-      include Teckel::Operation
+    freeze
+  end
 
-      result!
+  class OperationA
+    include Teckel::Operation
 
-      input none
-      output Types::Integer
-      error none
+    result!
 
-      def call(_)
-        rand(1000)
-      end
+    input none
+    output Types::Integer
+    error none
 
-      finalize!
+    def call(_)
+      success! rand(1000)
     end
 
-    class OperationB
-      include Teckel::Operation
+    finalize!
+  end
 
-      result!
+  class OperationB
+    include Teckel::Operation
 
-      input none
-      output Types::String
-      error none
+    result!
 
-      def call(_)
-        ("a".."z").to_a.sample
-      end
+    input none
+    output Types::String
+    error none
 
-      finalize!
+    def call(_)
+      success! ("a".."z").to_a.sample
     end
 
-    class ChainA < LoggingChain
-      step :roll, OperationA
+    finalize!
+  end
 
-      finalize!
-    end
+  class ChainA < LoggingChain
+    step :roll, OperationA
 
-    class ChainB < LoggingChain
-      step :say, OperationB
+    finalize!
+  end
 
-      finalize!
-    end
+  class ChainB < LoggingChain
+    step :say, OperationB
 
-    class ChainC < ChainB
-      finalize!
-    end
+    finalize!
+  end
+
+  class ChainC < ChainB
+    finalize!
   end
+end
 
+RSpec.describe Teckel::Chain do
   before do
     TeckelChainDefaultsViaBaseClass::LOG.clear
   end

data/spec/chain/none_input_spec.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-RSpec.describe Teckel::Chain do
-  module TeckelChainNoneInputTest
-    class MyOperation
-      include Teckel::Operation
-      result!
+module TeckelChainNoneInputTest
+  class MyOperation
+    include Teckel::Operation
+    result!
 
-      settings Struct.new(:say)
+    settings Struct.new(:say)
 
-      input none
-      output String
-      error none
+    input none
+    output String
+    error none
 
-      def call(_)
-        settings&.say || "Called"
-      end
+    def call(_)
+      success!(settings&.say || "Called")
     end
+  end
 
-    class Chain
-      include Teckel::Chain
+  class Chain
+    include Teckel::Chain
 
-      step :a, MyOperation
-    end
+    step :a, MyOperation
   end
+end
 
+RSpec.describe Teckel::Chain do
   specify "call chain without input value" do
     result = TeckelChainNoneInputTest::Chain.call
     expect(result.success).to eq("Called")

data/spec/chain/results_spec.rb

@@ -3,47 +3,47 @@
 require 'support/dry_base'
 require 'support/fake_models'
 
-RSpec.describe Teckel::Chain do
-  module TeckelChainResultTest
-    class Message
-      include ::Teckel::Operation
+module TeckelChainResultTest
+  class Message
+    include ::Teckel::Operation
 
-      result!
+    result!
 
-      input Types::Hash.schema(message: Types::String)
-      error none
-      output Types::String
+    input Types::Hash.schema(message: Types::String)
+    error none
+    output Types::String
 
-      def call(input)
-        input[:message].upcase
-      end
+    def call(input)
+      success! input[:message].upcase
     end
+  end
 
-    class Chain
-      include Teckel::Chain
-
-      step :message, Message
+  class Chain
+    include Teckel::Chain
 
-      class Result < Teckel::Operation::Result
-        def initialize(value, success, step, opts = {})
-          super(value, success)
-          @step = step
-          @opts = opts
-        end
+    step :message, Message
 
-        class << self
-          alias :[] :new # Alias the default constructor to :new
-        end
+    class Result < Teckel::Operation::Result
+      def initialize(value, success, step, opts = {})
+        super(value, success)
+        @step = step
+        @opts = opts
+      end
 
-        attr_reader :opts, :step
+      class << self
+        alias :[] :new # Alias the default constructor to :new
       end
 
-      result_constructor ->(value, success, step) {
-        result.new(value, success, step, time: Time.now.to_i)
-      }
+      attr_reader :opts, :step
     end
+
+    result_constructor ->(value, success, step) {
+      result.new(value, success, step, time: Time.now.to_i)
+    }
   end
+end
 
+RSpec.describe Teckel::Chain do
   specify do
     result = TeckelChainResultTest::Chain.call(message: "Hello World!")
     expect(result).to be_successful