pathway 1.1.0 → 1.3.0

data/lib/pathway/result.rb

@@ -3,14 +3,15 @@
 module Pathway
   class Result
     extend Forwardable
+
     attr_reader :value, :error
 
     class Success < Result
       def initialize(value) = @value = value
       def success? = true
 
-      def then(bl=nil)
-        result(block_given? ? yield(value): bl.call(value))
+      def then(bl = nil)
+        result(block_given? ? yield(value) : bl.call(value))
       end
 
       def tee(...)
@@ -18,20 +19,16 @@ module Pathway
         follow.failure? ? follow : self
       end
 
-      private
-
-      alias_method :value_for_deconstruct, :value
+      private alias_method :value_for_deconstruct, :value
     end
 
     class Failure < Result
       def initialize(error) = @error = error
       def success? = false
-      def then(_=nil) = self
-      def tee(_=nil) = self
-
-      private
+      def then(_ = nil) = self
+      def tee(_ = nil) = self
 
-      alias_method :value_for_deconstruct, :error
+      private alias_method :value_for_deconstruct, :error
     end
 
     module Mixin
@@ -57,6 +54,6 @@ module Pathway
       end
     end
 
-    delegate :result => 'self.class'
+    delegate result: "self.class"
   end
 end

data/lib/pathway/rspec/matchers/accept_optional_fields.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/form_schema_helpers'
+require "pathway/rspec/matchers/form_schema_helpers"
 
 RSpec::Matchers.define :accept_optional_fields do |*fields|
   match do |form|
@@ -13,7 +13,7 @@ RSpec::Matchers.define :accept_optional_fields do |*fields|
   end
 
   match_when_negated do |form|
-    raise NotImplementedError, 'expect().not_to accept_optional_fields.not_allowing_null_values is not supported.' if @allowing_null_values || @not_allowing_null_values
+    raise NotImplementedError, "expect().not_to accept_optional_fields.not_allowing_null_values is not supported." if @allowing_null_values || @not_allowing_null_values
 
     @form, @fields = form, fields
 
@@ -21,23 +21,23 @@ RSpec::Matchers.define :accept_optional_fields do |*fields|
   end
 
   description do
-    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
-    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    null_value_allowed = @allowing_null_values ? " allowing null values" : ""
+    null_value_disallowed = @not_allowing_null_values ? " not allowing null values" : ""
     "accept #{field_list} as optional #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed}"
   end
 
   failure_message do
-    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
-    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    null_value_allowed = @allowing_null_values ? " allowing null values" : ""
+    null_value_disallowed = @not_allowing_null_values ? " not allowing null values" : ""
 
     "Expected to accept #{field_list} as optional #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed} but " +
       as_sentence([not_optional_list, not_defined_list, accepting_null_list, not_accepting_null_list].compact,
-                  connector: '; ', last_connector: '; and ')
+                  connector: "; ", last_connector: "; and ")
   end
 
   failure_message_when_negated do
     "Did not expect to accept #{field_list} as optional #{pluralize_fields} but " +
-      [optional_list, not_defined_list].compact.join('; and ')
+      [optional_list, not_defined_list].compact.join("; and ")
   end
 
   include Pathway::Rspec::FormSchemaHelpers
@@ -51,13 +51,13 @@ RSpec::Matchers.define :accept_optional_fields do |*fields|
   end
 
   chain :allowing_null_values do
-    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @not_allowing_null_values
+    raise "cannot use allowing_null_values and not_allowing_null_values at the same time" if @not_allowing_null_values
 
     @allowing_null_values = true
   end
 
   chain :not_allowing_null_values do
-    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @allowing_null_values
+    raise "cannot use allowing_null_values and not_allowing_null_values at the same time" if @allowing_null_values
 
     @not_allowing_null_values = true
   end

data/lib/pathway/rspec/matchers/fail_on.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/list_helpers'
+require "pathway/rspec/matchers/list_helpers"
 
 RSpec::Matchers.define :fail_on do |input|
   match do |operation|
@@ -10,9 +10,10 @@ RSpec::Matchers.define :fail_on do |input|
   end
 
   match_when_negated do |operation|
-    raise NotImplementedError, '`expect().not_to fail_on(input).with_type()` is not supported.' if @type
-    raise NotImplementedError, '`expect().not_to fail_on(input).with_message()` is not supported.' if @message
-    raise NotImplementedError, '`expect().not_to fail_on(input).with_details()` is not supported.' if @details
+    raise NotImplementedError, "`expect().not_to fail_on(input).with_type()` is not supported." if @type
+    raise NotImplementedError, "`expect().not_to fail_on(input).with_message()` is not supported." if @message
+    raise NotImplementedError, "`expect().not_to fail_on(input).with_details()` is not supported." if @details
+
     @operation, @input = operation, input
 
     !failure?
@@ -40,20 +41,20 @@ RSpec::Matchers.define :fail_on do |input|
   alias_method :and_details, :details
 
   description do
-    'fail' + (@type ? " with :#@type error" : '')
+    "fail" + (@type ? " with :#{@type} error" : "")
   end
 
   failure_message do
-    if !failure?
-      "Expected operation to fail but it didn't"
+    if failure?
+      "Expected failed operation to " +
+        as_sentence(failure_descriptions, connector: "; ", last_connector: "; and ")
     else
-      'Expected failed operation to ' +
-        as_sentence(failure_descriptions, connector: '; ', last_connector: '; and ')
+      "Expected operation to fail but it didn't"
     end
   end
 
   failure_message_when_negated do
-    'Did not expected operation to fail but it did'
+    "Did not expected operation to fail but it did"
   end
 
   def failure?
@@ -85,7 +86,7 @@ RSpec::Matchers.define :fail_on do |input|
   end
 
   def type_failure_description
-    type_matches? ? nil : "have type :#@type but instead was :#{error.type}"
+    type_matches? ? nil : "have type :#{@type} but instead was :#{error.type}"
   end
 
   def message_failure_description

data/lib/pathway/rspec/matchers/field_list_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/list_helpers'
+require "pathway/rspec/matchers/list_helpers"
 
 module Pathway
   module Rspec
@@ -12,11 +12,11 @@ module Pathway
       end
 
       def were_was(list)
-        list.size > 1 ? 'were' : 'was'
+        list.size > 1 ? "were" : "was"
       end
 
       def pluralize_fields
-        @fields.size > 1 ? 'fields' : 'field'
+        @fields.size > 1 ? "fields" : "field"
       end
     end
   end

data/lib/pathway/rspec/matchers/form_schema_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/field_list_helpers'
+require "pathway/rspec/matchers/field_list_helpers"
 
 module Pathway
   module Rspec

data/lib/pathway/rspec/matchers/list_helpers.rb

@@ -3,14 +3,14 @@
 module Pathway
   module Rspec
     module ListHelpers
-      def as_list(items, **kwargs)
-        as_sentence(items.map(&:inspect), **kwargs)
+      def as_list(items, **)
+        as_sentence(items.map(&:inspect), **)
       end
 
-      def as_sentence(items, connector: ', ', last_connector: ' and ')
+      def as_sentence(items, connector: ", ", last_connector: " and ")
         *rest, last = items
 
-        result = String.new
+        result = +""
         result << rest.join(connector) << last_connector if rest.any?
         result << last
       end

data/lib/pathway/rspec/matchers/require_fields.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/form_schema_helpers'
+require "pathway/rspec/matchers/form_schema_helpers"
 
 RSpec::Matchers.define :require_fields do |*fields|
   match do |form|
@@ -13,7 +13,7 @@ RSpec::Matchers.define :require_fields do |*fields|
   end
 
   match_when_negated do |form|
-    raise NotImplementedError, 'expect().not_to require_fields.not_allowing_null_values is not supported.' if @allowing_null_values || @not_allowing_null_values
+    raise NotImplementedError, "expect().not_to require_fields.not_allowing_null_values is not supported." if @allowing_null_values || @not_allowing_null_values
 
     @form, @fields = form, fields
 
@@ -21,23 +21,23 @@ RSpec::Matchers.define :require_fields do |*fields|
   end
 
   description do
-    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
-    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    null_value_allowed = @allowing_null_values ? " allowing null values" : ""
+    null_value_disallowed = @not_allowing_null_values ? " not allowing null values" : ""
     "require #{field_list} as #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed}"
   end
 
   failure_message do
-    null_value_allowed = @allowing_null_values ? ' allowing null values' : ''
-    null_value_disallowed = @not_allowing_null_values ? ' not allowing null values' : ''
+    null_value_allowed = @allowing_null_values ? " allowing null values" : ""
+    null_value_disallowed = @not_allowing_null_values ? " not allowing null values" : ""
 
     "Expected to require #{field_list} as #{pluralize_fields}#{null_value_allowed}#{null_value_disallowed} but " +
       as_sentence([not_required_list, not_defined_list, accepting_null_list, not_accepting_null_list].compact,
-                  connector: '; ', last_connector: '; and ')
+                  connector: "; ", last_connector: "; and ")
   end
 
   failure_message_when_negated do
     "Did not expect to require #{field_list} as #{pluralize_fields} but " +
-      [required_list, not_defined_list].compact.join('; and ')
+      [required_list, not_defined_list].compact.join("; and ")
   end
 
   include Pathway::Rspec::FormSchemaHelpers
@@ -51,13 +51,13 @@ RSpec::Matchers.define :require_fields do |*fields|
   end
 
   chain :allowing_null_values do
-    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @not_allowing_null_values
+    raise "cannot use allowing_null_values and not_allowing_null_values at the same time" if @not_allowing_null_values
 
     @allowing_null_values = true
   end
 
   chain :not_allowing_null_values do
-    fail 'cannot use allowing_null_values and not_allowing_null_values at the same time' if @allowing_null_values
+    raise "cannot use allowing_null_values and not_allowing_null_values at the same time" if @allowing_null_values
 
     @not_allowing_null_values = true
   end

data/lib/pathway/rspec/matchers/succeed_on.rb

@@ -8,7 +8,8 @@ RSpec::Matchers.define :succeed_on do |input|
   end
 
   match_when_negated do |operation|
-    raise NotImplementedError, '`expect().not_to succeed_on(input).returning()` is not supported.' if @value
+    raise NotImplementedError, "`expect().not_to succeed_on(input).returning()` is not supported." if @value
+
     @operation, @input = operation, input
 
     !success?
@@ -23,15 +24,15 @@ RSpec::Matchers.define :succeed_on do |input|
   end
 
   failure_message do
-    if !success?
-      "Expected operation to be successful but failed with :#{result.error.type} error"
-    else
+    if success?
       "Expected successful operation to return #{description_of(@value)} but instead got #{description_of(result.value)}"
+    else
+      "Expected operation to be successful but failed with :#{result.error.type} error"
     end
   end
 
   failure_message_when_negated do
-    'Did not to expected operation to be successful but it was'
+    "Did not to expected operation to be successful but it was"
   end
 
   def success?

data/lib/pathway/rspec/matchers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers/succeed_on'
-require 'pathway/rspec/matchers/fail_on'
-require 'pathway/rspec/matchers/accept_optional_fields'
-require 'pathway/rspec/matchers/require_fields'
+require "pathway/rspec/matchers/succeed_on"
+require "pathway/rspec/matchers/fail_on"
+require "pathway/rspec/matchers/accept_optional_fields"
+require "pathway/rspec/matchers/require_fields"

data/lib/pathway/rspec.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'pathway/rspec/matchers'
+require "pathway/rspec/matchers"

data/lib/pathway/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pathway
-  VERSION = '1.1.0'
+  VERSION = "1.3.0"
 end

data/lib/pathway.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'dry/inflector'
-require 'contextualizer'
-require 'pathway/version'
-require 'pathway/result'
+require "forwardable"
+require "dry/inflector"
+require "contextualizer"
+require "pathway/version"
+require "pathway/result"
 
 module Pathway
   Inflector = Dry::Inflector.new
   class Operation
     class << self
-      def plugin(name,...)
+      def plugin(name, ...)
         require "pathway/plugins/#{Inflector.underscore(name)}" if name.is_a?(Symbol)
 
         plugin = name.is_a?(Module) ? name : Plugins.const_get(Inflector.camelize(name))
@@ -19,7 +19,7 @@ module Pathway
         self.include plugin::InstanceMethods if plugin.const_defined? :InstanceMethods
         self::DSL.include plugin::DSLMethods if plugin.const_defined? :DSLMethods
 
-        plugin.apply(self,...) if plugin.respond_to?(:apply)
+        plugin.apply(self, ...) if plugin.respond_to?(:apply)
       end
 
       def inherited(subclass)
@@ -34,6 +34,7 @@ module Pathway
 
   class Error
     attr_reader :type, :message, :details
+
     singleton_class.send :attr_accessor, :default_messages
 
     @default_messages = {}
@@ -56,7 +57,8 @@ module Pathway
 
   class State
     extend Forwardable
-    delegate %i([] []= fetch store include? values_at deconstruct_keys) => :@hash
+
+    delegate %i[[] []= fetch store include? values_at deconstruct_keys] => :@hash
 
     def initialize(operation, values = {})
       @hash = operation.context.merge(values)
@@ -72,16 +74,16 @@ module Pathway
     def to_hash = @hash
 
     def use(&bl)
-      raise ArgumentError, 'a block must be provided' if !block_given?
-      if bl.parameters in [*, [:rest|:keyrest,], *]
-        raise ArgumentError, 'rest arguments are not supported'
+      raise ArgumentError, "a block must be provided" unless block_given?
+      if bl.parameters in [*, [:rest | :keyrest,], *]
+        raise ArgumentError, "rest arguments are not supported"
       end
 
-      keys = bl.parameters.select { _1 in :key|:keyreq, }.map(&:last)
-      names = bl.parameters.select { _1 in :req|:opt, }.map(&:last)
+      keys = bl.parameters.select { _1 in :key | :keyreq, }.map(&:last)
+      names = bl.parameters.select { _1 in :req | :opt, }.map(&:last)
 
       if keys.any? && names.any?
-        raise ArgumentError, 'cannot mix positional and keyword arguments'
+        raise ArgumentError, "cannot mix positional and keyword arguments"
       elsif keys.any?
         bl.call(**to_hash.slice(*keys))
       else
@@ -104,12 +106,12 @@ module Pathway
         def process(&steps)
           define_method(:call) do |input|
             _dsl_for(input:)
-               .run(&steps)
-               .then(&:result)
+              .run(&steps)
+              .then(&:result)
           end
         end
 
-        def call(ctx,...) = new(ctx).call(...)
+        def call(ctx, ...) = new(ctx).call(...)
 
         def inherited(subclass)
           super
@@ -120,12 +122,12 @@ module Pathway
       module InstanceMethods
         extend Forwardable
 
-        delegate :result_key => 'self.class'
+        delegate result_key: "self.class"
         delegate %i[result success failure] => Result
 
         alias_method :wrap, :result
 
-        def call(*) = raise 'must implement at subclass'
+        def call(*) = raise "must implement at subclass"
 
         def error(type, message: nil, details: nil)
           failure(Error.new(type:, message:, details:))
@@ -150,33 +152,27 @@ module Pathway
           @result, @operation = wrap(state), operation
         end
 
-        def run(&steps)
-          instance_eval(&steps)
+        def run(&)
+          instance_eval(&)
           @result
         end
 
         # Execute step and preserve the former state
-        def step(callable,...)
+        def step(callable, *, **)
           bl = _callable(callable)
-          @result = @result.tee { |state| bl.call(state,...) }
+          @result = @result.tee { |state| bl.call(state, *, **) }
         end
 
         # Execute step and modify the former state setting the key
-        def set(callable, *args, to: @operation.result_key, **kwargs, &bl)
+        def set(callable, *args, to: @operation.result_key, **kwargs)
           bl = _callable(callable)
 
           @result = @result.then do |state|
-            wrap(bl.call(state, *args, **kwargs, &bl))
+            wrap(bl.call(state, *args, **kwargs))
               .then { |value| state.update(to => value) }
           end
         end
 
-        # Execute step and replace the current state completely
-        def map(callable,...)
-          bl = _callable(callable)
-          @result = @result.then { |state| bl.call(state,...) }
-        end
-
         def around(execution_strategy, &steps)
           @result.then do |state|
             steps_runner = ->(dsl = self) { dsl.run(&steps) }
@@ -185,13 +181,13 @@ module Pathway
           end
         end
 
-        def if_true(cond, &steps)
+        def if_true(cond, &)
           cond = _callable(cond)
-          around(->(runner, state) { runner.call if cond.call(state) }, &steps)
+          around(->(runner, state) { runner.call if cond.call(state) }, &)
         end
 
-        def if_false(cond, &steps)
-          if_true(_callable(cond) >> :!.to_proc, &steps)
+        def if_false(cond, &)
+          if_true(_callable(cond) >> :!.to_proc, &)
         end
 
         alias_method :sequence, :around

data/pathway.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "pathway/version"
 
@@ -10,24 +10,23 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Pablo Herrero"]
   spec.email         = ["pablodherrero@gmail.com"]
 
-  spec.summary       = %q{Define your business logic in simple steps.}
-  spec.description   = %q{Define your business logic in simple steps.}
+  spec.summary       = "Define your business logic in simple steps."
+  spec.description   = "Define your business logic in simple steps."
   spec.homepage      = "https://github.com/pabloh/pathway"
   spec.license       = "MIT"
 
   spec.metadata      = {
-    "bug_tracker_uri" => "https://github.com/pabloh/pathway/issues",
-    "source_code_uri" => "https://github.com/pabloh/pathway",
+    "rubygems_mfa_required" => "true",
+    "bug_tracker_uri"       => "https://github.com/pabloh/pathway/issues",
+    "source_code_uri"       => "https://github.com/pabloh/pathway",
   }
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files         = `git ls-files -z`.split("\x0").grep_v(%r{^(test|spec|features)/})
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 3.2.0"
+  spec.required_ruby_version = ">= 3.3.0"
 
   spec.add_dependency "dry-inflector", ">= 0.1.0"
   spec.add_dependency "contextualizer", "~> 0.1.0"
@@ -37,12 +36,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sequel", "~> 5.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "simplecov-lcov", '~> 0.8.0'
+  spec.add_development_dependency "simplecov-lcov", "~> 0.8.0"
+  spec.add_development_dependency "rubocop", "~> 1.81.0"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "rubocop-rake"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "reline"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "pry-doc"
-  spec.add_development_dependency "pry-stack"
 end