teckel 0.8.0 → 0.10.0

data/lib/teckel/operation/config.rb

@@ -11,7 +11,7 @@ module Teckel
       #   @param  klass [Class] The +input+ class
       #   @return [Class] The +input+ class
       def input(klass = nil)
-        @config.for(:input, klass) { self::Input if const_defined?(:Input) } ||
+        @config.get_or_set(:input, klass) { self::Input if const_defined?(:Input) } ||
           raise(MissingConfigError, "Missing input config for #{self}")
       end
 
@@ -57,7 +57,7 @@ module Teckel
       #
       #     MyOperation.input_constructor.is_a?(Proc) #=> true
       def input_constructor(sym_or_proc = nil)
-        get_set_constructor(:input_constructor, input, sym_or_proc)
+        get_or_set_constructor(:input_constructor, input, sym_or_proc)
       end
 
       # @overload output()
@@ -70,7 +70,7 @@ module Teckel
       #   @param  klass [Class] The +output+ class
       #   @return [Class] The +output+ class
       def output(klass = nil)
-        @config.for(:output, klass) { self::Output if const_defined?(:Output) } ||
+        @config.get_or_set(:output, klass) { self::Output if const_defined?(:Output) } ||
           raise(MissingConfigError, "Missing output config for #{self}")
       end
 
@@ -102,7 +102,7 @@ module Teckel
       #       output_constructor ->(name, options) { Output.new(name: name, **options) }
       #     end
       def output_constructor(sym_or_proc = nil)
-        get_set_constructor(:output_constructor, output, sym_or_proc)
+        get_or_set_constructor(:output_constructor, output, sym_or_proc)
       end
 
       # @overload error()
@@ -114,7 +114,7 @@ module Teckel
       #   @param klass [Class] The +error+ class
       #   @return [Class,nil] The +error+ class or +nil+ if it does not error
       def error(klass = nil)
-        @config.for(:error, klass) { self::Error if const_defined?(:Error) } ||
+        @config.get_or_set(:error, klass) { self::Error if const_defined?(:Error) } ||
           raise(MissingConfigError, "Missing error config for #{self}")
       end
 
@@ -146,7 +146,7 @@ module Teckel
       #       error_constructor ->(name, options) { Error.new(name: name, **options) }
       #     end
       def error_constructor(sym_or_proc = nil)
-        get_set_constructor(:error_constructor, error, sym_or_proc)
+        get_or_set_constructor(:error_constructor, error, sym_or_proc)
       end
 
       # @!endgroup
@@ -160,7 +160,7 @@ module Teckel
       #   @param klass [Class] The +settings+ class
       #   @return [Class] The +settings+ class configured
       def settings(klass = nil)
-        @config.for(:settings, klass) { const_defined?(:Settings) ? self::Settings : none }
+        @config.get_or_set(:settings, klass) { const_defined?(:Settings) ? self::Settings : none }
       end
 
       # @overload settings_constructor()
@@ -187,7 +187,7 @@ module Teckel
       #      settings_constructor :new
       #    end
       def settings_constructor(sym_or_proc = nil)
-        get_set_constructor(:settings_constructor, settings, sym_or_proc) ||
+        get_or_set_constructor(:settings_constructor, settings, sym_or_proc) ||
           raise(MissingConfigError, "Missing settings_constructor config for #{self}")
       end
 
@@ -222,13 +222,14 @@ module Teckel
 
         callable ||= -> { settings_constructor.call(*args) }
 
-        @config.for(:default_settings, callable)
+        @config.get_or_set(:default_settings, callable)
       end
 
       # Getter for configured default settings
-      # @return [nil|#call] The callable constructor
+      # @return [NilClass]
+      # @return [#call] The callable constructor
       def default_settings
-        @config.for(:default_settings)
+        @config.get_or_set(:default_settings)
       end
 
       # @overload runner()
@@ -240,12 +241,12 @@ module Teckel
       #   @param klass [Class] A class like the {Runner}
       #   @!visibility protected
       def runner(klass = nil)
-        @config.for(:runner, klass) { Runner }
+        @config.get_or_set(:runner, klass) { Runner }
       end
 
       # @overload result()
       #   Get the configured result object class wrapping {error} or {output}.
-      #   The {ValueResult} default will act as a pass-through and does. Any error
+      #   The {ValueResult} default will act as a pass-through. Any error
       #   or output will just returned as-is.
       #   @return [Class] The +result+ class, or {ValueResult} as default
       #
@@ -254,9 +255,12 @@ module Teckel
       #   @param klass [Class] The +result+ class
       #   @return [Class] The +result+ class configured
       def result(klass = nil)
-        @config.for(:result, klass) { const_defined?(:Result, false) ? self::Result : ValueResult }
+        @config.get_or_set(:result, klass) { const_defined?(:Result, false) ? self::Result : ValueResult }
       end
 
+      # @param sym_or_proc [Symbol,Proc,NilClass]
+      # @return [#call]
+      #
       # @overload result_constructor()
       #   The callable constructor to build an instance of the +result+ class.
       #   Defaults to {Teckel::DEFAULT_CONSTRUCTOR}
@@ -282,7 +286,7 @@ module Teckel
       #      result_constructor ->(value, success) { result.new(value, success, {foo: :bar}) }
       #    end
       def result_constructor(sym_or_proc = nil)
-        get_set_constructor(:result_constructor, result, sym_or_proc) ||
+        get_or_set_constructor(:result_constructor, result, sym_or_proc) ||
           raise(MissingConfigError, "Missing result_constructor config for #{self}")
       end
 
@@ -293,14 +297,15 @@ module Teckel
       #
       # @!visibility protected
       # @note Don't use in conjunction with {result} or {result_constructor}
-      # @return [nil]
+      # @return [void]
       def result!
-        @config.for(:result, Result)
-        @config.for(:result_constructor, Result.method(:new))
+        @config.get_or_set(:result, Result)
+        @config.get_or_set(:result_constructor, Result.method(:new))
         nil
       end
 
       # @!visibility private
+      # @return [Array<Symbol>]
       REQUIRED_CONFIGS = %i[
         input input_constructor
         output output_constructor
@@ -334,7 +339,7 @@ module Teckel
       # @return [self]
       # @!visibility public
       def dup
-        dup_config(super())
+        dup_config(super()) # standard:disable Style/SuperArguments
       end
 
       # Produces a clone of this operation and all it's configuration
@@ -343,9 +348,9 @@ module Teckel
       # @!visibility public
       def clone
         if frozen?
-          super()
+          super() # standard:disable Style/SuperArguments
         else
-          dup_config(super())
+          dup_config(super()) # standard:disable Style/SuperArguments
         end
       end
 
@@ -355,7 +360,7 @@ module Teckel
       # @!visibility public
       def freeze
         @config.freeze
-        super()
+        super() # standard:disable Style/SuperArguments
       end
 
       # @!visibility private
@@ -372,22 +377,20 @@ module Teckel
         end
       end
 
-      private
-
-      def dup_config(other_class)
+      private def dup_config(other_class)
         other_class.instance_variable_set(:@config, @config.dup)
         other_class
       end
 
-      def get_set_constructor(name, on, sym_or_proc)
+      private def get_or_set_constructor(name, on, sym_or_proc)
         constructor = build_constructor(on, sym_or_proc)
 
-        @config.for(name, constructor) {
+        @config.get_or_set(name, constructor) {
           build_constructor(on, DEFAULT_CONSTRUCTOR)
         }
       end
 
-      def build_constructor(on, sym_or_proc)
+      private def build_constructor(on, sym_or_proc)
         case sym_or_proc
         when Proc
           sym_or_proc

data/lib/teckel/operation/result.rb

@@ -51,27 +51,27 @@ 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
-      def failure(default = nil, &block)
+      # @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)
         return value unless @successful
-        return yield(value) if block
+        return yield(value) if block_given?
 
         default
       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
-      def success(default = nil, &block)
+      # @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)
         return value if @successful
-        return yield(value) if block
+        return yield(value) if block_given?
 
         default
       end
@@ -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
@@ -48,15 +48,15 @@ module Teckel
 
       def deconstruct_keys(keys)
         e = {}
-        e[:success] = successful? if keys.include?(:success)
-        e[:value] = value if keys.include?(:value)
+        e[:success] = successful? if keys&.include?(:success)
+        e[:value] = value if keys&.include?(:value)
         e
       end
     end
 
     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.10.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,27 +1,26 @@
 --- !ruby/object:Gem::Specification
 name: teckel
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
@@ -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.10.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: 4.0.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