teckel 0.8.0 → 0.9.0

data/lib/teckel/operation/result.rb

@@ -51,13 +51,13 @@ module Teckel
       end
 
       # @!attribute [r] value
-      # @return [Mixed] the value/payload
+      # @return [Object] the value/payload
       attr_reader :value
 
       # Get the error/failure value
-      # @yield [Mixed] If a block is given and this is not a failure result, the value is yielded to the block
-      # @param  default [Mixed] return this default value if it's not a failure result
-      # @return [Mixed] the value/payload
+      # @yield [Object] If a block is given and this is not a failure result, the value is yielded to the block
+      # @param  default [Object] return this default value if it's not a failure result
+      # @return [Object] the value/payload
       def failure(default = nil, &block)
         return value unless @successful
         return yield(value) if block
@@ -66,9 +66,9 @@ module Teckel
       end
 
       # Get the success value
-      # @yield [Mixed] If a block is given and this is not a success result, the value is yielded to the block
-      # @param  default [Mixed] return this default value if it's not a success result
-      # @return [Mixed] the value/payload
+      # @yield [Object] If a block is given and this is not a success result, the value is yielded to the block
+      # @param  default [Object] return this default value if it's not a success result
+      # @return [Object] the value/payload
       def success(default = nil, &block)
         return value if @successful
         return yield(value) if block
@@ -85,7 +85,7 @@ module Teckel
           value
         end
 
-        alias :new :[]
+        alias_method :new, :[]
       end
     end
   end

data/lib/teckel/operation/runner.rb

@@ -8,7 +8,7 @@ module Teckel
     # @!visibility protected
     class Runner
       # @!visibility private
-      UNDEFINED = Object.new.freeze
+      UNDEFINED = Teckel::UNDEFINED
 
       def initialize(operation, settings = UNDEFINED)
         @operation, @settings = operation, settings

data/lib/teckel/operation.rb

@@ -59,11 +59,11 @@ module Teckel
   module Operation
     module ClassMethods
       # @!visibility private
-      UNDEFINED = Object.new
+      UNDEFINED = Teckel::UNDEFINED
 
       # Invoke the Operation
       #
-      # @param input Any form of input your {Teckel::Operation::Config#input input} class can handle via the given
+      # @param input [Object,nil] Any form of input your {Teckel::Operation::Config#input input} class can handle via the given
       #   {Teckel::Operation::Config#input_constructor input_constructor}
       # @return Either An instance of your defined {Teckel::Operation::Config#error error} class or
       #   {Teckel::Operation::Config#output output} class
@@ -111,7 +111,7 @@ module Teckel
       def with(settings)
         runable(settings_constructor.call(settings))
       end
-      alias :set :with
+      alias_method :set, :with
 
       # Constructs a Runner instance for {call} and {with}.
       #
@@ -205,8 +205,8 @@ module Teckel
 
     def self.included(receiver)
       receiver.class_eval do
-        extend  Config
-        extend  ClassMethods
+        extend Config
+        extend ClassMethods
         include InstanceMethods
       end
     end

data/lib/teckel/result.rb

@@ -37,7 +37,7 @@ module Teckel
       end
 
       # @!attribute [r] value
-      # @return [Mixed] the value/payload
+      # @return [Object] the value/payload
       def value
         raise NotImplementedError, "Result object does not implement `value`"
       end
@@ -56,7 +56,7 @@ module Teckel
 
     def self.included(receiver)
       receiver.class_eval do
-        extend  ClassMethods
+        extend ClassMethods
         include InstanceMethods
       end
     end

data/lib/teckel/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Teckel
-  VERSION = "0.8.0"
+  # @return [String]
+  VERSION = "0.9.0"
 end

data/lib/teckel.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "teckel/version"
+require_relative "teckel/version"
 
 module Teckel
   # Base error class for this lib
@@ -13,6 +13,9 @@ module Teckel
   class MissingConfigError < Teckel::Error; end
 
   DEFAULT_CONSTRUCTOR = :[]
+
+  # @!visibility private
+  UNDEFINED = Object.new.freeze
 end
 
 require_relative "teckel/config"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Robert Schulze
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -121,29 +134,6 @@ 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_spec.rb
-- spec/config_spec.rb
-- spec/doctest_helper.rb
-- spec/operation/config_spec.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
-- spec/operation_spec.rb
-- spec/rb27/pattern_matching_spec.rb
-- spec/result_spec.rb
-- spec/spec_helper.rb
-- spec/support/dry_base.rb
-- spec/support/fake_db.rb
-- spec/support/fake_models.rb
-- spec/teckel_spec.rb
 homepage: https://github.com/fnordfish/teckel
 licenses:
 - Apache-2.0
@@ -151,9 +141,8 @@ metadata:
   changelog_uri: https://github.com/fnordfish/teckel/blob/main/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.8.0
+  documentation_uri: https://www.rubydoc.info/gems/teckel/0.9.0
   user_docs_uri: https://fnordfish.github.io/teckel/
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,31 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.6.9
 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_spec.rb
-- spec/config_spec.rb
-- spec/doctest_helper.rb
-- spec/operation/config_spec.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
-- spec/operation_spec.rb
-- spec/rb27/pattern_matching_spec.rb
-- spec/result_spec.rb
-- spec/spec_helper.rb
-- spec/support/dry_base.rb
-- spec/support/fake_db.rb
-- spec/support/fake_models.rb
-- spec/teckel_spec.rb
+test_files: []

data/spec/chain/around_hook_spec.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-require 'support/dry_base'
-require 'support/fake_db'
-require 'support/fake_models'
-
-module TeckelChainAroundHookTest
-  class CreateUser
-    include ::Teckel::Operation
-
-    result!
-
-    input  Types::Hash.schema(name: Types::String, age: Types::Coercible::Integer.optional)
-    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 safe User", errors: user.errors)
-      end
-    end
-  end
-
-  class AddFriend
-    include ::Teckel::Operation
-
-    result!
-
-    settings Struct.new(:fail_befriend)
-
-    input Types.Instance(User)
-    output Types::Hash.schema(user: Types.Instance(User), friend: Types.Instance(User))
-    error  Types::Hash.schema(message: Types::String)
-
-    def call(user)
-      if settings&.fail_befriend
-        fail!(message: "Did not find a friend.")
-      else
-        success! user: user, friend: User.new(name: "A friend", age: 42)
-      end
-    end
-  end
-
-  @stack = []
-  def self.stack
-    @stack
-  end
-
-  class Chain
-    include Teckel::Chain
-
-    around ->(chain, input) {
-      result = nil
-      begin
-        TeckelChainAroundHookTest.stack << :before
-
-        FakeDB.transaction do
-          result = chain.call(input)
-          raise FakeDB::Rollback if result.failure?
-        end
-
-        TeckelChainAroundHookTest.stack << :after
-        result
-      rescue FakeDB::Rollback
-        result
-      end
-    }
-
-    step :create, CreateUser
-    step :befriend, AddFriend
-  end
-end
-
-RSpec.describe Teckel::Chain do
-  before { TeckelChainAroundHookTest.stack.clear }
-
-  context "success" do
-    it "result matches" do
-      result = TeckelChainAroundHookTest::Chain.call(name: "Bob", age: 23)
-      expect(result.success).to include(user: kind_of(User), friend: kind_of(User))
-    end
-
-    it "runs around hook" do
-      TeckelChainAroundHookTest::Chain.call(name: "Bob", age: 23)
-      expect(TeckelChainAroundHookTest.stack).to eq([:before, :after])
-    end
-  end
-
-  context "failure" do
-    it "runs around hook" do
-      TeckelChainAroundHookTest::Chain.
-        with(befriend: :fail).
-        call(name: "Bob", age: 23)
-      expect(TeckelChainAroundHookTest.stack).to eq([:before])
-    end
-  end
-end

data/spec/chain/default_settings_spec.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-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`
-
-    input none
-    output Hash
-    error none
-
-    def call(_)
-      success! settings.to_h
-    end
-  end
-
-  class Chain
-    include Teckel::Chain
-
-    default_settings!(a: { say: "Chain Default" })
-
-    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)
-  end
-
-  specify "call chain with explicit settings, overwrites defaults" do
-    result = TeckelChainDefaultSettingsTest::Chain.with(a: { other: "What" }).call
-    expect(result.success).to eq(say: nil, other: "What")
-  end
-end

data/spec/chain/inheritance_spec.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require 'support/dry_base'
-require 'support/fake_models'
-
-module TeckelChainDefaultsViaBaseClass
-  LOG = [] # rubocop:disable Style/MutableConstant
-
-  class LoggingChain
-    include Teckel::Chain
-
-    around do |chain, input|
-      require 'benchmark'
-      result = nil
-      LOG << Benchmark.measure { result = chain.call(input) }
-      result
-    end
-
-    freeze
-  end
-
-  class OperationA
-    include Teckel::Operation
-
-    result!
-
-    input none
-    output Types::Integer
-    error none
-
-    def call(_)
-      success! rand(1000)
-    end
-
-    finalize!
-  end
-
-  class OperationB
-    include Teckel::Operation
-
-    result!
-
-    input none
-    output Types::String
-    error none
-
-    def call(_)
-      success! ("a".."z").to_a.sample
-    end
-
-    finalize!
-  end
-
-  class ChainA < LoggingChain
-    step :roll, OperationA
-
-    finalize!
-  end
-
-  class ChainB < LoggingChain
-    step :say, OperationB
-
-    finalize!
-  end
-
-  class ChainC < ChainB
-    finalize!
-  end
-end
-
-RSpec.describe Teckel::Chain do
-  before do
-    TeckelChainDefaultsViaBaseClass::LOG.clear
-  end
-
-  let(:base_chain) { TeckelChainDefaultsViaBaseClass::LoggingChain }
-  let(:chain_a) { TeckelChainDefaultsViaBaseClass::ChainA }
-  let(:chain_b) { TeckelChainDefaultsViaBaseClass::ChainB }
-  let(:chain_c) { TeckelChainDefaultsViaBaseClass::ChainC }
-
-  it "inherits config" do
-    expect(chain_a.around)
-    expect(chain_b.around)
-
-    expect(base_chain.steps).to eq([])
-    expect(chain_a.steps.size).to eq(1)
-    expect(chain_b.steps.size).to eq(1)
-  end
-
-  it "runs chain a" do
-    expect {
-      result = chain_a.call
-      expect(result.success).to be_a(Integer)
-    }.to change {
-      TeckelChainDefaultsViaBaseClass::LOG.size
-    }.from(0).to(1)
-  end
-
-  it "runs chain b" do
-    expect {
-      result = chain_b.call
-      expect(result.success).to be_a(String)
-    }.to change {
-      TeckelChainDefaultsViaBaseClass::LOG.size
-    }.from(0).to(1)
-  end
-
-  it "inherits steps" do
-    expect {
-      result = chain_c.call
-      expect(result.success).to be_a(String)
-    }.to change {
-      TeckelChainDefaultsViaBaseClass::LOG.size
-    }.from(0).to(1)
-  end
-end

data/spec/chain/none_input_spec.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module TeckelChainNoneInputTest
-  class MyOperation
-    include Teckel::Operation
-    result!
-
-    settings Struct.new(:say)
-
-    input none
-    output String
-    error none
-
-    def call(_)
-      success!(settings&.say || "Called")
-    end
-  end
-
-  class Chain
-    include Teckel::Chain
-
-    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")
-  end
-
-  specify "call chain runner without input value" do
-    result = TeckelChainNoneInputTest::Chain.with(a: "What").call
-    expect(result.success).to eq("What")
-  end
-end

data/spec/chain/results_spec.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'support/dry_base'
-require 'support/fake_models'
-
-module TeckelChainResultTest
-  class Message
-    include ::Teckel::Operation
-
-    result!
-
-    input Types::Hash.schema(message: Types::String)
-    error none
-    output Types::String
-
-    def call(input)
-      success! input[:message].upcase
-    end
-  end
-
-  class Chain
-    include Teckel::Chain
-
-    step :message, Message
-
-    class Result < Teckel::Operation::Result
-      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
-
-    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
-    expect(result.success).to eq("HELLO WORLD!")
-    expect(result.opts).to include(time: kind_of(Integer))
-  end
-end