teckel 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55dd7fb782cfdcb3cc960423e46ab2ce8b49c9396273f10749105883d55ed6f
-  data.tar.gz: e3b7428d98daeb42cc086b4a5cd5081b5c3b4ca90c14b0cf3f4cd9576243d0e3
+  metadata.gz: df9c73577c9c93fbaaf2e7661a07bdc3b1b0397832a62a8edbe4eea846c4c029
+  data.tar.gz: 037041bf0eb6ae8bc41e354772d3ce1d04002a35ecccc0b1ecefa33a85845c3b
 SHA512:
-  metadata.gz: '0148d426e8e7124a08a3a7dd3c42487cac5944d17ba9cabb98a8c378a86a5d9813b7b62c483d2203809644528d2e6b6cc4de51476aa67261b1405f3f41576613'
-  data.tar.gz: 6792ad4806b977d21d0ea621e311306cb13c239d8604e35e61937e79ce4f5488cbb410aa6ae22e9e12e48b61529f97e924aab22e100717808885c0b0c76980fd
+  metadata.gz: 2f6f601e816c972aed8e511b05fdbc418a48aab10c2ca246d108661cc25a8d514a41944b2e01b9294757a2a717696491f20f601f5f60e53faa45651aec48bc7f
+  data.tar.gz: 68bc46e5ed21cf5e639ee1fc00265b278f9062f42de9d179a07559862990a078df9dcb2ef26956eb629cf08e71409b9b05bd363a11930cb64ecdee533d63d2ea

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changes
 
+## 0.7.0
+
+- Breaking: `Teckel::Chain` will not be required by default. require manually if needed `require "teckel/chain"` [GH-24]
+- Breaking: Internally, `Teckel::Operation::Runner` instead of `:success` and `:failure` now only uses `:halt` as it's throw-catch symbol. [GH-26]
+- Add: Using the default `Teckel::Operation::Runner`, `input_constructor` and `result_constructor` will be executed
+  within the context of the operation instance. This allows for `input_constructor` to call `fail!` and `success!` 
+  without ever `call`ing the operation. [GH-26]
+
+
 ## 0.6.0
 
 - Breaking: Operations return values will be ignored. [GH-21]

data/lib/teckel.rb

@@ -19,4 +19,3 @@ require_relative "teckel/config"
 require_relative "teckel/contracts"
 require_relative "teckel/result"
 require_relative "teckel/operation"
-require_relative "teckel/chain"

data/lib/teckel/chain/config.rb

@@ -103,13 +103,42 @@ module Teckel
       #  @example
       #    class MyOperation
       #      include Teckel::Operation
+      #      result!
+      #
+      #      settings Struct.new(:say, :other)
+      #      settings_constructor ->(data) { settings.new(*data.values_at(*settings.members)) }
+      #
+      #      input none
+      #      output Hash
+      #      error none
+      #
+      #      def call(_)
+      #        success!(settings.to_h)
+      #      end
+      #    end
+      #
+      #    class Chain
+      #      include Teckel::Chain
       #
       #      class Result < Teckel::Operation::Result
-      #        def initialize(value, success, step, options = {}); end
+      #        def initialize(value, success, step, opts = {})
+      #          super(value, success)
+      #          @step = step
+      #          @opts = opts
+      #        end
+      #
+      #        class << self
+      #          alias :[] :new # Alias the default constructor to :new
+      #        end
+      #
+      #        attr_reader :opts, :step
       #      end
       #
-      #      # If you need more control over how to build a new +Settings+ instance
-      #      result_constructor ->(value, success, step) { result.new(value, success, step, {foo: :bar}) }
+      #      result_constructor ->(value, success, step) {
+      #        result.new(value, success, step, time: Time.now.to_i)
+      #      }
+      #
+      #      step :a, MyOperation
       #    end
       def result_constructor(sym_or_proc = nil)
         constructor = build_constructor(result, sym_or_proc) unless sym_or_proc.nil?

data/lib/teckel/operation/runner.rb

@@ -16,16 +16,24 @@ module Teckel
       attr_reader :operation, :settings
 
       def call(input = nil)
-        catch(:failure) do
-          out = catch(:success) do
-            run operation.input_constructor.call(input)
-            return nil # :sic!: return values need to go through +success!+
-          end
-
-          return out
+        catch(:halt) do
+          op = instance
+          op_input = op.instance_exec(input, &operation.input_constructor)
+          op.call(op_input)
+          nil # return values need to go through +success!+ or +fail!+
         end
       end
 
+      def instance
+        return @instance if instance_variable_defined?(:@instance)
+
+        op = operation.new
+        op.runner = self
+        op.settings = settings if settings != UNDEFINED
+
+        @instance = op
+      end
+
       # This is just here to raise a meaningful error.
       # @!visibility private
       def with(*)
@@ -44,7 +52,7 @@ module Teckel
             operation.output_constructor.call(*args)
           end
 
-        throw :success, operation.result_constructor.call(value, true)
+        throw :halt, instance.instance_exec(value, true, &operation.result_constructor)
       end
 
       # Halt any further execution with an error value
@@ -59,16 +67,7 @@ module Teckel
             operation.error_constructor.call(*args)
           end
 
-        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)
+        throw :halt, instance.instance_exec(value, false, &operation.result_constructor)
       end
     end
   end

data/lib/teckel/version.rb

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

data/spec/doctest_helper.rb

@@ -5,3 +5,4 @@ require_relative 'support/fake_db'
 require_relative 'support/fake_models'
 
 require "teckel"
+require "teckel/chain"

data/spec/operation/fail_on_input_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require "dry/validation"
+require 'support/dry_base'
+require 'support/fake_models'
+
+module TeckelOperationFailOnOInput
+  class NewUserContract < Dry::Validation::Contract
+    schema do
+      required(:name).filled(:string)
+      required(:age).value(:integer)
+    end
+  end
+
+  class CreateUser
+    include Teckel::Operation
+
+    result!
+
+    input(NewUserContract.new)
+    input_constructor(->(input){
+      result = self.class.input.call(input)
+      if result.success?
+        result.to_h
+      else
+        fail!(message: "Input data validation failed", errors: [result.errors.to_h])
+      end
+    })
+
+    output Types.Instance(User)
+    error  Types::Hash.schema(message: Types::String, errors: Types::Array.of(Types::Hash))
+
+    def call(input)
+      user = User.new(name: input[:name], age: input[:age])
+      if user.save
+        success! user
+      else
+        fail!(message: "Could not save User", errors: user.errors)
+      end
+    end
+
+    finalize!
+  end
+
+  class CreateUserIncorrectFailure
+    include Teckel::Operation
+
+    result!
+
+    input(->(input) { input }) # NoOp
+    input_constructor(->(_input) {
+      fail!("Input data validation failed")
+    })
+
+    output none
+    error  Types::Hash.schema(message: Types::String, errors: Types::Array.of(Types::Hash))
+
+    def call(_); end
+    finalize!
+  end
+end
+
+RSpec.describe Teckel::Operation do
+  specify "successs" do
+    result = TeckelOperationFailOnOInput::CreateUser.call(name: "Bob", age: 23)
+    expect(result).to be_successful
+    expect(result.success).to be_a(User)
+  end
+
+  describe "failing in input_constructor" do
+    let(:failure_input) do
+      { name: "", age: "incorrect type" }
+    end
+
+    it "returns the failure thrown in input_constructor" do
+      result = TeckelOperationFailOnOInput::CreateUser.call(failure_input)
+      expect(result).to be_a(Teckel::Operation::Result)
+      expect(result).to be_failure
+      expect(result.failure).to eq(
+        message: "Input data validation failed",
+        errors: [
+          { name: ["must be filled"], age: ["must be an integer"] }
+        ]
+      )
+    end
+
+    it "does not run .call" do
+      expect(TeckelOperationFailOnOInput::CreateUser).to receive(:new).and_wrap_original do |m, *args|
+        op_instance = m.call(*args)
+        expect(op_instance).to_not receive(:call)
+        op_instance
+      end
+
+      TeckelOperationFailOnOInput::CreateUser.call(failure_input)
+    end
+  end
+
+  specify "thrown failure needs to conform to :error" do
+    expect {
+      TeckelOperationFailOnOInput::CreateUserIncorrectFailure.call(name: "Bob", age: 23)
+    }.to raise_error(Dry::Types::ConstraintError, /violates constraints/)
+  end
+end

data/spec/operation/result_spec.rb

@@ -3,25 +3,46 @@
 RSpec.describe Teckel::Operation::Result do
   let(:failure_value) { "some error" }
   let(:failed_result) { Teckel::Operation::Result.new(failure_value, false) }
+  let(:failed_nil_result) { Teckel::Operation::Result.new(failure_value, nil) }
 
-  let(:success_value) { "some error" }
-  let(:successful_result) { Teckel::Operation::Result.new(failure_value, true) }
+  let(:success_value) { "some success" }
+  let(:successful_result) { Teckel::Operation::Result.new(success_value, true) }
+  let(:successful_1_result) { Teckel::Operation::Result.new(success_value, 1) }
 
-  it { expect(successful_result.successful?).to be(true) }
-  it { expect(failed_result.successful?).to be(false) }
+  it { expect(successful_result.successful?).to eq(true) }
+  it { expect(successful_1_result.successful?).to eq(true) }
+  it { expect(failed_result.successful?).to eq(false) }
+  it { expect(failed_nil_result.successful?).to eq(false) }
 
-  it { expect(successful_result.failure?).to be(false) }
-  it { expect(failed_result.failure?).to be(true) }
+  it { expect(successful_result.failure?).to eq(false) }
+  it { expect(successful_1_result.failure?).to eq(false) }
+  it { expect(failed_result.failure?).to eq(true) }
+  it { expect(failed_nil_result.failure?).to eq(true) }
 
   it { expect(successful_result.value).to eq(success_value) }
   it { expect(failed_result.value).to eq(failure_value) }
 
   describe "#success" do
-    it { expect(successful_result.success).to eq(success_value) }
-
-    it { expect(failed_result.success).to eq(nil) }
-    it { expect(failed_result.success("other")).to eq("other") }
-    it { expect(failed_result.success { |value| "Failed: #{value}" } ).to eq("Failed: some error") }
+    it("on successful result, returns value") {
+      expect(successful_result.success).to eq(success_value)
+    }
+
+    describe "on failed result" do
+      it("with no fallbacks, returns nil") {
+        expect(failed_result.success).to eq(nil)
+      }
+      it("with default-argument, returns default-argument") {
+        expect(failed_result.success("other")).to eq("other")
+      }
+      it("with block, returns block return value") {
+        expect(failed_result.success { |value| "Failed: #{value}" } ).to eq("Failed: some error")
+      }
+      it("with default-argument and block given, returns default-argument, skips block") {
+        expect { |blk|
+          expect(failed_result.success("default", &blk)).to_not eq("default")
+        }.to(yield_control)
+      }
+    end
   end
 
   describe "#failure" do
@@ -29,6 +50,6 @@ RSpec.describe Teckel::Operation::Result do
 
     it { expect(successful_result.failure).to eq(nil) }
     it { expect(successful_result.failure("other")).to eq("other") }
-    it { expect(successful_result.failure { |value| "Failed: #{value}" } ).to eq("Failed: some error") }
+    it { expect(successful_result.failure { |value| "Failed: #{value}" } ).to eq("Failed: some success") }
   end
 end

data/spec/operation/results_spec.rb

@@ -44,7 +44,7 @@ class CreateUserCustomResult
   end
 
   result MyResult
-  result_constructor ->(value, success) { result.new(value, success, time: Time.now.to_i) }
+  result_constructor ->(value, success) { MyResult.new(value, success, time: Time.now.to_i) }
 
   input  Types::Hash.schema(name: Types::String, age: Types::Coercible::Integer)
   output Types.Instance(User)

data/spec/operation_spec.rb

@@ -101,7 +101,7 @@ module TeckelOperationKeywordContracts
       attr_reader :name, :age
     end
 
-    input_constructor ->(data) { input.new(**data) }
+    input_constructor ->(data) { Input.new(**data) }
 
     Output = ::User
 
@@ -129,7 +129,7 @@ module TeckelOperationCreateUserSplatInit
     include Teckel::Operation
 
     input Struct.new(:name, :age)
-    input_constructor ->(data) { input.new(*data) }
+    input_constructor ->(data) { self.class.input.new(*data) }
 
     Output = ::User
 
@@ -346,7 +346,7 @@ RSpec.describe Teckel::Operation do
 
       expect {
         op.with(more: :stuff_2)
-      }.to raise_error(Teckel::Error)
+      }.to raise_error(Teckel::Error, "Operation already has settings assigned.")
     end
   end
 

data/spec/result_spec.rb

@@ -12,11 +12,11 @@ end
 
 RSpec.describe Teckel::Result do
   describe "missing initialize" do
-    specify do
+    specify "raises NotImplementedError" do
       result = TeckelResultTest::MissingResultImplementation["value", true]
-      expect { result.successful? }.to raise_error(NotImplementedError)
-      expect { result.failure? }.to raise_error(NotImplementedError)
-      expect { result.value }.to raise_error(NotImplementedError)
+      expect { result.successful? }.to raise_error(NotImplementedError, "Result object does not implement `successful?`")
+      expect { result.failure? }.to raise_error(NotImplementedError, "Result object does not implement `successful?`")
+      expect { result.value }.to raise_error(NotImplementedError, "Result object does not implement `value`")
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,12 +3,15 @@
 require "bundler/setup"
 if ENV['COVERAGE'] == 'true'
   require 'simplecov'
+  require 'simplecov_json_formatter'
+  SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
   SimpleCov.start do
     add_filter %r{^/spec/}
   end
 end
 
 require "teckel"
+require "teckel/chain"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Robert Schulze
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,16 +107,17 @@ files:
 - lib/teckel/operation/runner.rb
 - lib/teckel/result.rb
 - lib/teckel/version.rb
+- spec/chain/around_hook_spec.rb
 - spec/chain/default_settings_spec.rb
 - spec/chain/inheritance_spec.rb
 - spec/chain/none_input_spec.rb
 - spec/chain/results_spec.rb
-- spec/chain_around_hook_spec.rb
 - spec/chain_spec.rb
 - spec/config_spec.rb
 - spec/doctest_helper.rb
 - spec/operation/contract_trace_spec.rb
 - spec/operation/default_settings_spec.rb
+- spec/operation/fail_on_input_spec.rb
 - spec/operation/inheritance_spec.rb
 - spec/operation/result_spec.rb
 - spec/operation/results_spec.rb
@@ -132,10 +133,11 @@ homepage: https://github.com/fnordfish/teckel
 licenses:
 - Apache-2.0
 metadata:
-  changelog_uri: https://github.com/github.com/fnordfish/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/github.com/fnordfish
-  bug_tracker_uri: https://github.com/github.com/fnordfish/issues
-  documentation_uri: https://www.rubydoc.info/gems/teckel/0.6.0
+  changelog_uri: https://github.com/fnordfish/teckel/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/fnordfish/teckel
+  bug_tracker_uri: https://github.com/fnordfish/teckel/issues
+  documentation_uri: https://www.rubydoc.info/gems/teckel/0.7.0
+  user_docs_uri: https://fnordfish.github.io/teckel/
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -151,21 +153,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Operations with enforced in/out/err data structures
 test_files:
+- spec/chain/around_hook_spec.rb
 - spec/chain/default_settings_spec.rb
 - spec/chain/inheritance_spec.rb
 - spec/chain/none_input_spec.rb
 - spec/chain/results_spec.rb
-- spec/chain_around_hook_spec.rb
 - spec/chain_spec.rb
 - spec/config_spec.rb
 - spec/doctest_helper.rb
 - spec/operation/contract_trace_spec.rb
 - spec/operation/default_settings_spec.rb
+- spec/operation/fail_on_input_spec.rb
 - spec/operation/inheritance_spec.rb
 - spec/operation/result_spec.rb
 - spec/operation/results_spec.rb