yaso 1.0.0pre → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b9f4c5896548a6f409962b677761c4be496098d9dea767e3d5cfedfa7b18d96
-  data.tar.gz: ae9a8cb0cd3053da2c8f8255965f56038fc95d7d47e77b276186855d277bd97c
+  metadata.gz: 293839b577b5832d54938e07a07729d49ddd74fd226f0077076fe6f4986340ae
+  data.tar.gz: 72d9d2bde9edbc0050f1473e3efc33a9c81952fe78906eaeb35acbba2ccc80bf
 SHA512:
-  metadata.gz: aec771273ca907c668f9c6153c6d3446b4e8fd80875f3812bebc7590ae1d7be7c7f4b080cc2ff0b9861beaf868a10fa1b4a878fb782658f62bc03d9da231828b
-  data.tar.gz: e1e9f17b4715e3bf6792de67be5562f5c495b61c57e7c20bbb3d2e0f4585290fb803bd6686821e74ad6c5982c0cb7f3c88363947b2981a650394d1023ffcca90
+  metadata.gz: a54b6acc15d5d8e71b25a4273ce87816ae58a1e63bd815e4cf338d671b5b71b3378016c076d9db44122e7612619e69e06c60e63cf7afd388b0de7509ad42ac0f
+  data.tar.gz: 55a031ce994ac21ed04e659d70b2871cae67ed64d088799e26663b1d5e2ac5f76593d0ea4d0e3e181ff72b63fed7aa626abf67b063eed696be4418e74930e9e8

data/.rubocop.yml

@@ -8,6 +8,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - vendor/bundle/**/*
+    - benchmark/vendor/bundle/**/*
 
 Gemspec/RequiredRubyVersion:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    yaso (1.0.0pre)
+    yaso (1.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,9 +1,10 @@
 # Yaso
 [![Ruby](https://github.com/Ar2emis/yaso/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/Ar2emis/yaso/actions/workflows/main.yml) ![gem](https://img.shields.io/gem/v/yaso) [![GitHub license](https://img.shields.io/github/license/Ar2emis/yaso)](https://github.com/Ar2emis/yaso/blob/master/LICENSE.txt)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yaso`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+That's my (Yet Another) ServiceObject pattern implementation. I made it fast ([the fastest actually](https://github.com/Ar2emis/yaso/wiki/Benchmarks)) and simple to use.
+I was inspired by those alternatives and I hope this will encourage them to be even better:
+- [Trailblazer](https://github.com/trailblazer/trailblazer)
+- [Decouplio](https://github.com/differencialx/decouplio)
 
 ## Installation
 
@@ -23,17 +24,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+All the information you can find in the gem [wiki](https://github.com/Ar2emis/yaso/wiki).
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+I don't think that someone would like to help me developing the gem but if so just fork a new branch from the master, do your dark business, open a pull request and assign me as a reviewer. 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/yaso.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ar2emis/yaso.
 
 ## License
 

data/benchmark/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 gem 'benchmark-ips', '~> 2.10.0'
 gem 'interactor', '~> 3.1.2'
 gem 'kalibera', '~> 0.1.2'
+gem 'simple_command', RUBY_VERSION.include?('2.5') ? '~> 0.2.0' : '~> 1.0.1'
 gem 'trailblazer', '~> 2.1.0'
 
 gem 'active_interaction', %w[2.5 2.6].any? { |version| RUBY_VERSION.include?(version) } ? '~> 4.1.0' : '~> 5.1.0'

data/benchmark/index.rb

@@ -9,10 +9,12 @@ RUBY_VERSION.include?('2.5') || require('decouplio')
 require 'interactor'
 require 'active_interaction'
 require 'trailblazer'
+require 'simple_command'
 
 require_relative 'shared/yaso_service'
 RUBY_VERSION.include?('2.5') || require_relative('shared/decouplio_service')
 require_relative 'shared/pure_service'
+require_relative 'shared/simple_command_service'
 require_relative 'shared/interactor_service'
 require_relative 'shared/active_interaction_service'
 require_relative 'shared/trailblazer_service'
@@ -21,6 +23,7 @@ require_relative 'shared/callable_step'
 require_relative 'step/yaso'
 RUBY_VERSION.include?('2.5') || require_relative('step/decouplio')
 require_relative 'step/pure'
+require_relative 'step/simple_command'
 require_relative 'step/interactor'
 require_relative 'step/active_interaction'
 require_relative 'step/trailblazer'

data/benchmark/shared/simple_command_service.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class SimpleCommandService
+  prepend SimpleCommand
+
+  attr_reader :ctx
+
+  def initialize(**ctx)
+    @ctx = ctx
+  end
+end

data/benchmark/step/benchmark.rb

@@ -7,11 +7,12 @@ Benchmark.ips do |x|
   x.config(stats: :bootstrap, confidence: 95)
 
   x.report('Pure Service') { PureStepsService.call }
-  x.report('Decouplio Service') { DecouplioStepsService.call } unless RUBY_VERSION.include?('2.5')
-  x.report('Yaso Service') { YasoStepsService.call }
-  x.report('Interactor Service') { InteractorStepsService.call }
-  x.report('ActiveInteraction Service') { ActiveInteractionStepsService.run }
-  x.report('Trailblazer Service') { TrailblazerStepsService.call }
+  x.report('SimpleCommand') { SimpleCommandStepsService.call }
+  x.report('Yaso') { YasoStepsService.call }
+  x.report('Decouplio') { DecouplioStepsService.call } unless RUBY_VERSION.include?('2.5')
+  x.report('Interactor') { InteractorStepsService.call }
+  x.report('ActiveInteraction') { ActiveInteractionStepsService.run }
+  x.report('Trailblazer') { TrailblazerStepsService.call }
 
   x.compare!
 end
@@ -21,11 +22,12 @@ Benchmark.ips do |x|
   x.config(stats: :bootstrap, confidence: 95)
 
   x.report('Pure Service') { PureCallablesService.call }
-  x.report('Decouplio Service') { DecouplioCallablesService.call } unless RUBY_VERSION.include?('2.5')
-  x.report('Yaso Service') { YasoCallablesService.call }
-  x.report('Interactor Service') { InteractorCallablesService.call }
-  x.report('ActiveInteraction Service') { ActiveInteractionCallablesService.run }
-  x.report('Trailblazer Service') { TrailblazerCallablesService.call }
+  x.report('SimpleCommand') { SimpleCommandCallablesService.call }
+  x.report('Yaso') { YasoCallablesService.call }
+  x.report('Decouplio') { DecouplioCallablesService.call } unless RUBY_VERSION.include?('2.5')
+  x.report('Interactor') { InteractorCallablesService.call }
+  x.report('ActiveInteraction') { ActiveInteractionCallablesService.run }
+  x.report('Trailblazer') { TrailblazerCallablesService.call }
 
   x.compare!
 end

data/benchmark/step/simple_command.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+class SimpleCommandStepsService < SimpleCommandService
+  # rubocop:disable Metrics/MethodLength
+  def call
+    one
+    two
+    three
+    four
+    five
+    six
+    seven
+    eight
+    nine
+    ten
+    ctx
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def one
+    ctx[:one] = true
+  end
+
+  def two
+    ctx[:two] = true
+  end
+
+  def three
+    ctx[:three] = true
+  end
+
+  def four
+    ctx[:four] = true
+  end
+
+  def five
+    ctx[:five] = true
+  end
+
+  def six
+    ctx[:six] = true
+  end
+
+  def seven
+    ctx[:seven] = true
+  end
+
+  def eight
+    ctx[:eight] = true
+  end
+
+  def nine
+    ctx[:nine] = true
+  end
+
+  def ten
+    ctx[:ten] = true
+  end
+end
+
+class SimpleCommandCallablesService < SimpleCommandService
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+  def call
+    CallableStep.call(ctx, key: :one, value: true)
+    CallableStep.call(ctx, key: :two, value: true)
+    CallableStep.call(ctx, key: :three, value: true)
+    CallableStep.call(ctx, key: :four, value: true)
+    CallableStep.call(ctx, key: :five, value: true)
+    CallableStep.call(ctx, key: :six, value: true)
+    CallableStep.call(ctx, key: :seven, value: true)
+    CallableStep.call(ctx, key: :eight, value: true)
+    CallableStep.call(ctx, key: :nine, value: true)
+    CallableStep.call(ctx, key: :ten, value: true)
+    ctx
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+end

data/lib/yaso/context.rb

@@ -3,6 +3,7 @@
 module Yaso
   class Context
     attr_writer :success
+    attr_reader :data
 
     def initialize(kwargs)
       @success = true
@@ -21,10 +22,6 @@ module Yaso
       @data.dup
     end
 
-    def to_h!
-      @data
-    end
-
     def success?
       @success
     end

data/lib/yaso/errors.rb

@@ -20,4 +20,10 @@ module Yaso
       super("Unhandled switch case in #{klass}")
     end
   end
+
+  class UnknownFlowError < Error
+    def initialize(klass, name)
+      super("Unknown flow \"#{name}\" is set in #{klass}")
+    end
+  end
 end

data/lib/yaso/invocable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Yaso
+  class Invocable
+    METHOD = :method
+    CALLABLE = :callable
+    YASO = :yaso
+
+    class << self
+      def call(object, options: {}, **)
+        type = object_type(object)
+        invocable = case type
+                    when YASO then proc { |context, _| object.call(context.clone).success? }
+                    when CALLABLE then proc { |context, _, &block| object.call(context, **options, &block) }
+                    else method_invocable(object)
+                    end
+        [type, invocable]
+      end
+
+      private
+
+      def object_type(object)
+        return Invocable::METHOD unless object.is_a?(Class)
+
+        object < ::Yaso::Service ? Invocable::YASO : Invocable::CALLABLE
+      end
+
+      def method_invocable(object)
+        instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          proc { |context, instance, &block|                    # proc { |context, instance, &block|
+            instance.#{object}(context, **context.data, &block) #   instance.<method_name>(context, **context.data, &block)
+          }                                                     # }
+        RUBY
+      end
+    end
+  end
+end

data/lib/yaso/logic/base.rb

@@ -5,9 +5,9 @@ module Yaso
     class Base
       attr_reader :name, :on_success, :on_failure
 
-      def initialize(name:, invokable:, **options)
+      def initialize(name:, invocable:, **options)
         @name = name
-        @invokable = invokable
+        @invocable = invocable
         @fast = options[:fast]
         @on_success = options[:on_success]
         @on_failure = options[:on_failure]

data/lib/yaso/logic/failure.rb

@@ -5,7 +5,7 @@ module Yaso
     class Failure < Base
       def call(context, instance)
         context.success = false
-        @invokable.call(context, instance) ? @next_step : @failure
+        @invocable.call(context, instance) ? @next_step : @failure
       end
     end
   end

data/lib/yaso/logic/pass.rb

@@ -5,7 +5,7 @@ module Yaso
     class Pass < Base
       def call(context, instance)
         context.success = true
-        @invokable.call(context, instance) ? @next_step : @failure
+        @invocable.call(context, instance) ? @next_step : @failure
       end
     end
   end

data/lib/yaso/logic/rollback.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Yaso
+  module Logic
+    class Rollback < Classic
+      def call
+        super
+        logicals.detect { |step| !step.is_a?(Failure) }
+      end
+
+      private
+
+      def link_step(step, index)
+        next_success = step.on_success ? find_step(step.on_success) : next_step(index)
+        next_failure = if step.on_failure then find_step(step.on_failure)
+                       else
+                         step.is_a?(Pass) ? next_success : previous_failure(index)
+                       end
+
+        step.add_next_step(next_success)
+        step.add_failure(next_failure)
+      end
+
+      def link_previous_steps(failure, index)
+        prev_failure = previous_failure(index)
+
+        failure.add_failure(prev_failure) unless failure.on_failure
+        failure.add_next_step(prev_failure) unless failure.on_success
+      end
+
+      def next_step(index)
+        logicals[index.next..-1].detect { |next_node| !next_node.is_a?(Failure) }
+      end
+
+      def previous_failure(index)
+        logicals[0...index].reverse_each.detect { |previous_step| previous_step.is_a?(Failure) }
+      end
+    end
+  end
+end

data/lib/yaso/logic/step.rb

@@ -5,7 +5,7 @@ module Yaso
     class Step < Base
       def call(context, instance)
         context.success = true
-        if @invokable.call(context, instance)
+        if @invocable.call(context, instance)
           @next_step
         else
           context.success = false

data/lib/yaso/logic/step_builder.rb

@@ -16,13 +16,13 @@ module Yaso
       end
 
       def call(object:, category:, block:, **opts)
-        invokable_type, invokable = Invokable.call(object, **opts)
+        invocable_type, invocable = Invocable.call(object, **opts)
         logic_class = CATEGORIES[category]
-        if invokable_type == Invokable::METHOD
+        if invocable_type == Invocable::METHOD
           opts[:name] = logic_class == Switch ? build_switch(object, **opts, &block) : build_method(object, &block)
         end
         opts[:wrapper] = build_wrapper(&block) if logic_class == Wrap
-        logic_class.new(invokable: invokable, **opts)
+        logic_class.new(invocable: invocable, **opts)
       end
 
       private
@@ -37,26 +37,25 @@ module Yaso
       end
 
       def build_method(name, &block)
-        return name if @klass.method_defined?(name) || @klass.private_method_defined?(name)
+        return name if @klass.method_defined?(name)
         raise StepIsNotImplementedError.new(@klass, name) unless block
 
         @klass.define_method(name, &block)
-        @klass.instance_eval { private name }
       end
 
       def build_wrapper(&block)
         wrapper_class = Class.new { extend Stepable }
+        build_wrapper_methods(wrapper_class, @klass)
         wrapper_class.instance_exec(&block)
-        build_wrapper_call(wrapper_class, @klass)
         wrapper_class
       end
 
-      def build_wrapper_call(wrapper_class, service_class)
+      def build_wrapper_methods(wrapper_class, service_class)
+        wrapper_class.define_singleton_method(:flow) do
+          service_class.flow
+        end
         wrapper_class.define_singleton_method(:call) do |context, instance|
-          unless @entry
-            @entry = Logic::Classic.call(service_class, steps)
-            clear_steps!
-          end
+          @entry ||= flow.call(service_class, steps)
           step = @entry
           step = step.call(context, instance) while step
           context

data/lib/yaso/logic/switch.rb

@@ -5,9 +5,9 @@ module Yaso
     class Switch < Base
       def call(context, instance)
         context.success = true
-        switch_case = @invokable.call(context, instance) || raise(UnhandledSwitchCaseError, instance.class)
+        switch_case = @invocable.call(context, instance) || raise(UnhandledSwitchCaseError, instance.class)
 
-        if Invokable.call(switch_case).last.call(context, instance)
+        if Invocable.call(switch_case).last.call(context, instance)
           @next_step
         else
           context.success = false

data/lib/yaso/logic/wrap.rb

@@ -10,7 +10,7 @@ module Yaso
 
       def call(context, instance)
         context.success = true
-        if @invokable.call(context, instance) { @wrapper.call(context, instance).success? }
+        if @invocable.call(context, instance) { @wrapper.call(context, instance).success? }
           @next_step
         else
           context.success = false

data/lib/yaso/logic.rb

@@ -8,7 +8,13 @@ require_relative 'logic/wrap'
 require_relative 'logic/switch'
 require_relative 'logic/step_builder'
 require_relative 'logic/classic'
+require_relative 'logic/rollback'
 
 module Yaso
-  module Logic; end
+  module Logic
+    FLOWS = {
+      classic: Logic::Classic,
+      rollback: Logic::Rollback
+    }.freeze
+  end
 end

data/lib/yaso/service.rb

@@ -4,16 +4,22 @@ module Yaso
   class Service
     extend Stepable
 
-    def self.call(context = {})
-      context = context.is_a?(Context) ? context : Context.new(context)
-      unless @entry
-        @entry = Logic::Classic.call(self, steps)
-        clear_steps!
+    class << self
+      def call(context = {})
+        context = context.is_a?(Context) ? context : Context.new(context)
+        @entry ||= flow.call(self, steps)
+        step = @entry
+        instance = new
+        step = step.call(context, instance) while step
+        context
+      end
+
+      def flow(name = nil)
+        @flow ||= Logic::FLOWS[:classic] if self == Yaso::Service
+        return @flow || Yaso::Service.flow if name.nil?
+
+        @flow = Logic::FLOWS[name] || raise(UnknownFlowError.new(self, name))
       end
-      step = @entry
-      instance = new
-      step = step.call(context, instance) while step
-      context
     end
   end
 end

data/lib/yaso/stepable.rb

@@ -6,19 +6,22 @@ module Yaso
       @steps ||= []
     end
 
-    def clear_steps!
-      remove_instance_variable(:@steps)
-    end
-
-    %i[step pass failure wrap switch].each do |category|
-      define_method(category) do |object, options = {}, &block|
-        raise InvalidFirstStepError, category if category == :failure && steps.empty?
-
+    %i[step pass wrap switch].each do |category|
+      define_method(category) do |object, **options, &block|
         steps << {
           object: object, category: category, fast: options.delete(:fast), on_success: options.delete(:on_success),
           on_failure: options.delete(:on_failure), options: options, block: block, name: options.delete(:name)
         }
       end
     end
+
+    def failure(object, **options, &block)
+      raise InvalidFirstStepError, :failure if flow == Logic::Classic && steps.empty?
+
+      steps << {
+        object: object, category: :failure, fast: options.delete(:fast), on_success: options.delete(:on_success),
+        on_failure: options.delete(:on_failure), options: options, block: block, name: options.delete(:name)
+      }
+    end
   end
 end

data/lib/yaso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yaso
-  VERSION = '1.0.0pre'
+  VERSION = '1.2.0'
 end

data/lib/yaso.rb

@@ -3,7 +3,7 @@
 require_relative 'yaso/version'
 require_relative 'yaso/errors'
 require_relative 'yaso/context'
-require_relative 'yaso/invokable'
+require_relative 'yaso/invocable'
 require_relative 'yaso/stepable'
 require_relative 'yaso/logic'
 require_relative 'yaso/service'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaso
 version: !ruby/object:Gem::Version
-  version: 1.0.0pre
+  version: 1.2.0
 platform: ruby
 authors:
 - Artem Shevchenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffaker
@@ -197,6 +197,7 @@ files:
 - benchmark/shared/decouplio_service.rb
 - benchmark/shared/interactor_service.rb
 - benchmark/shared/pure_service.rb
+- benchmark/shared/simple_command_service.rb
 - benchmark/shared/trailblazer_service.rb
 - benchmark/shared/yaso_service.rb
 - benchmark/step/active_interaction.rb
@@ -204,18 +205,20 @@ files:
 - benchmark/step/decouplio.rb
 - benchmark/step/interactor.rb
 - benchmark/step/pure.rb
+- benchmark/step/simple_command.rb
 - benchmark/step/trailblazer.rb
 - benchmark/step/yaso.rb
 - lefthook.yml
 - lib/yaso.rb
 - lib/yaso/context.rb
 - lib/yaso/errors.rb
-- lib/yaso/invokable.rb
+- lib/yaso/invocable.rb
 - lib/yaso/logic.rb
 - lib/yaso/logic/base.rb
 - lib/yaso/logic/classic.rb
 - lib/yaso/logic/failure.rb
 - lib/yaso/logic/pass.rb
+- lib/yaso/logic/rollback.rb
 - lib/yaso/logic/step.rb
 - lib/yaso/logic/step_builder.rb
 - lib/yaso/logic/switch.rb
@@ -241,9 +244,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

data/lib/yaso/invokable.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Yaso
-  class Invokable
-    METHOD = :method
-    CALLABLE = :callable
-    YASO = :yaso
-
-    class << self
-      def call(object, options: {}, **)
-        type = object_type(object)
-        invokable = case type
-                    when YASO then ->(context, _) { object.call(context.clone).success? }
-                    when CALLABLE then ->(context, _, &block) { object.call(context, **options, &block) }
-                    else ->(context, instance, &block) { instance.send(object, context, **context.to_h!, &block) }
-                    end
-        [type, invokable]
-      end
-
-      private
-
-      def object_type(object)
-        return Invokable::METHOD unless object.is_a?(Class)
-
-        object < ::Yaso::Service ? Invokable::YASO : Invokable::CALLABLE
-      end
-    end
-  end
-end