teckel 0.7.0 → 0.9.0

data/lib/teckel/operation/config.rb

@@ -11,8 +11,8 @@ 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) } ||
-          raise(Teckel::MissingConfigError, "Missing input config for #{self}")
+        @config.get_or_set(:input, klass) { self::Input if const_defined?(:Input) } ||
+          raise(MissingConfigError, "Missing input config for #{self}")
       end
 
       # @overload input_constructor()
@@ -57,8 +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) ||
-          raise(MissingConfigError, "Missing input_constructor config for #{self}")
+        get_or_set_constructor(:input_constructor, input, sym_or_proc)
       end
 
       # @overload output()
@@ -71,8 +70,8 @@ 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) } ||
-          raise(Teckel::MissingConfigError, "Missing output config for #{self}")
+        @config.get_or_set(:output, klass) { self::Output if const_defined?(:Output) } ||
+          raise(MissingConfigError, "Missing output config for #{self}")
       end
 
       # @overload output_constructor()
@@ -103,8 +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) ||
-          raise(MissingConfigError, "Missing output_constructor config for #{self}")
+        get_or_set_constructor(:output_constructor, output, sym_or_proc)
       end
 
       # @overload error()
@@ -116,8 +114,8 @@ 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) } ||
-          raise(Teckel::MissingConfigError, "Missing error config for #{self}")
+        @config.get_or_set(:error, klass) { self::Error if const_defined?(:Error) } ||
+          raise(MissingConfigError, "Missing error config for #{self}")
       end
 
       # @overload error_constructor()
@@ -148,8 +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) ||
-          raise(MissingConfigError, "Missing error_constructor config for #{self}")
+        get_or_set_constructor(:error_constructor, error, sym_or_proc)
       end
 
       # @!endgroup
@@ -163,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()
@@ -190,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
 
@@ -219,22 +216,20 @@ module Teckel
       #
       #   (Like calling +MyOperation.with(arg1, arg2, ...)+)
       def default_settings!(*args)
-        callable =
-          if args.empty?
-            -> { settings_constructor.call }
-          elsif args.length == 1
-            build_constructor(settings, args.first)
-          end
+        callable = if args.size.equal?(1)
+          build_constructor(settings, args.first)
+        end
 
         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()
@@ -246,12 +241,12 @@ module Teckel
       #   @param klass [Class] A class like the {Runner}
       #   @!visibility protected
       def runner(klass = nil)
-        @config.for(:runner, klass) { Teckel::Operation::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
       #
@@ -260,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}
@@ -288,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
 
@@ -299,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, Teckel::Operation::Result)
-        @config.for(:result_constructor, Teckel::Operation::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
@@ -340,9 +339,7 @@ module Teckel
       # @return [self]
       # @!visibility public
       def dup
-        super.tap do |copy|
-          copy.instance_variable_set(:@config, @config.dup)
-        end
+        dup_config(super()) # standard:disable Style/SuperArguments
       end
 
       # Produces a clone of this operation and all it's configuration
@@ -351,18 +348,24 @@ module Teckel
       # @!visibility public
       def clone
         if frozen?
-          super
+          super() # standard:disable Style/SuperArguments
         else
-          super.tap do |copy|
-            copy.instance_variable_set(:@config, @config.dup)
-          end
+          dup_config(super()) # standard:disable Style/SuperArguments
         end
       end
 
+      # Prevents further modifications to this operation and its config
+      #
+      # @return [self]
+      # @!visibility public
+      def freeze
+        @config.freeze
+        super() # standard:disable Style/SuperArguments
+      end
+
       # @!visibility private
       def inherited(subclass)
-        subclass.instance_variable_set(:@config, @config.dup)
-        super subclass
+        super(dup_config(subclass))
       end
 
       # @!visibility private
@@ -374,21 +377,25 @@ module Teckel
         end
       end
 
-      private
+      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)
-        constructor = build_constructor(on, sym_or_proc) unless sym_or_proc.nil?
+      private def get_or_set_constructor(name, on, sym_or_proc)
+        constructor = build_constructor(on, sym_or_proc)
 
-        @config.for(name, constructor) {
-          build_constructor(on, Teckel::DEFAULT_CONSTRUCTOR)
+        @config.get_or_set(name, constructor) {
+          build_constructor(on, DEFAULT_CONSTRUCTOR)
         }
       end
 
-      def build_constructor(on, sym_or_proc)
-        if sym_or_proc.is_a?(Symbol) && on.respond_to?(sym_or_proc)
-          on.public_method(sym_or_proc)
-        elsif sym_or_proc.respond_to?(:call)
+      private def build_constructor(on, sym_or_proc)
+        case sym_or_proc
+        when Proc
           sym_or_proc
+        when Symbol
+          on.public_method(sym_or_proc) if on.respond_to?(sym_or_proc)
         end
       end
     end

data/lib/teckel/operation/result.rb

@@ -38,40 +38,40 @@ module Teckel
       include Teckel::Result
 
       # @param value [Object] The result value
-      # @param success [Boolean] whether this is a successful result
-      def initialize(value, success)
+      # @param successful [Boolean] whether this is a successful result
+      def initialize(value, successful)
         @value = value
-        @success = (!!success).freeze
+        @successful = successful
       end
 
       # Whether this is a success result
       # @return [Boolean]
       def successful?
-        @success
+        @successful
       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 @success
-        return yield(@value) if block
+        return value unless @successful
+        return yield(value) if block
 
         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
+      # @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 @success
-        return yield(@value) if block
+        return value if @successful
+        return yield(value) if block
 
         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
@@ -29,7 +29,7 @@ module Teckel
 
         op = operation.new
         op.runner = self
-        op.settings = settings if settings != UNDEFINED
+        op.settings = settings unless settings.eql?(UNDEFINED)
 
         @instance = op
       end
@@ -37,7 +37,7 @@ module Teckel
       # This is just here to raise a meaningful error.
       # @!visibility private
       def with(*)
-        raise Teckel::Error, "Operation already has settings assigned."
+        raise Error, "Operation already has settings assigned."
       end
 
       # Halt any further execution with a output value
@@ -46,7 +46,7 @@ module Teckel
       # @!visibility protected
       def success!(*args)
         value =
-          if args.size == 1 && operation.output === args.first # rubocop:disable Style/CaseEquality
+          if args.size.equal?(1) && operation.output === args.first # rubocop:disable Style/CaseEquality
             args.first
           else
             operation.output_constructor.call(*args)
@@ -61,7 +61,7 @@ module Teckel
       # @!visibility protected
       def fail!(*args)
         value =
-          if args.size == 1 && operation.error === args.first # rubocop:disable Style/CaseEquality
+          if args.size.equal?(1) && operation.error === args.first # rubocop:disable Style/CaseEquality
             args.first
           else
             operation.error_constructor.call(*args)

data/lib/teckel/operation.rb

@@ -58,29 +58,26 @@ module Teckel
   # @!visibility public
   module Operation
     module ClassMethods
+      # @!visibility private
+      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
       # @!visibility public
       def call(input = nil)
-        default_settings = self.default_settings
-
-        if default_settings
-          runner.new(self, default_settings.call)
-        else
-          runner.new(self)
-        end.call(input)
+        runable.call(input)
       end
 
-      # Provide {InstanceMethods#settings() settings} to the running operation.
+      # Provide {InstanceMethods#settings() settings} to the operation.
       #
       # This method is intended to be called on the operation class outside of
-      # it's definition, prior to running {#call}.
+      # it's definition, prior to invoking {#call}.
       #
-      # @param input Any form of input your {Teckel::Operation::Config#settings settings} class can handle via the given
+      # @param settings Any form of settings your {Teckel::Operation::Config#settings settings} class can handle via the given
       #   {Teckel::Operation::Config#settings_constructor settings_constructor}
       # @return [Class] The configured {Teckel::Operation::Config#runner runner}
       # @!visibility public
@@ -111,10 +108,30 @@ module Teckel
       #   MyOperation.with(false).call
       #   MyOperation.call
       #   LOG #=> []
-      def with(input)
-        runner.new(self, settings_constructor.call(input))
+      def with(settings)
+        runable(settings_constructor.call(settings))
+      end
+      alias_method :set, :with
+
+      # Constructs a Runner instance for {call} and {with}.
+      #
+      # @note This method is public to make testing, stubbing and mocking easier.
+      #   Your normal application code should use {with} and/or {call}
+      #
+      # @param settings Optional. Any form of settings your
+      #   {Teckel::Operation::Config#settings settings} class can handle via the
+      #   given {Teckel::Operation::Config#settings_constructor settings_constructor}
+      # @return [Class] The configured {Teckel::Operation::Config#runner runner}
+      # @!visibility public
+      def runable(settings = UNDEFINED)
+        if settings != UNDEFINED
+          runner.new(self, settings)
+        elsif default_settings
+          runner.new(self, default_settings.call)
+        else
+          runner.new(self)
+        end
       end
-      alias :set :with
 
       # Convenience method for setting {Teckel::Operation::Config#input input},
       # {Teckel::Operation::Config#output output} or
@@ -145,7 +162,7 @@ module Teckel
       #
       #   MyOperation.call #=> nil
       def none
-        Teckel::Contracts::None
+        Contracts::None
       end
     end
 
@@ -187,9 +204,11 @@ module Teckel
     end
 
     def self.included(receiver)
-      receiver.extend         Config
-      receiver.extend         ClassMethods
-      receiver.send :include, InstanceMethods
+      receiver.class_eval do
+        extend Config
+        extend ClassMethods
+        include InstanceMethods
+      end
     end
   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
@@ -55,8 +55,10 @@ module Teckel
     end
 
     def self.included(receiver)
-      receiver.extend         ClassMethods
-      receiver.send :include, InstanceMethods
+      receiver.class_eval do
+        extend ClassMethods
+        include InstanceMethods
+      end
     end
   end
 end

data/lib/teckel/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Teckel
-  VERSION = "0.7.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.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Robert Schulze
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +51,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  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: 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
@@ -107,38 +134,15 @@ 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/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
 metadata:
-  changelog_uri: https://github.com/fnordfish/teckel/blob/master/CHANGELOG.md
+  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.7.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
@@ -153,30 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-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/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: []