u-service 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e760358632fb06d0fb235f3b01723b1de144c21be568f7db9bca62b7e9b1910b
-  data.tar.gz: 7601fde72507d36673a6868a29b2ce382c8e1ce910514530c275ffb8bb6ec1b5
+  metadata.gz: 020c6ab3c508004af1b58aa443ed52b67ec587fbc23ce11c4c410dd2806af3cc
+  data.tar.gz: 4b528fe880ce14dadf398a1491cd9ae7b36a6a08a1d4a8cf0e8d9de48f6a0bf8
 SHA512:
-  metadata.gz: bd4ea2da734b495a14fcfdf2c42513eb80d5cd677910c8b84eb0e093effaee151c124393f25a08bc2e41c249d50aa0022b15a734e55aa6fccd24755d9b4be236
-  data.tar.gz: 81981c5a33bb3558f40a233cc0e5112cda17c2b2938ee3106cda1ec2dce7b98eddd384b58dbd2e6a4ae29e9c2e86ac4fb23c2d3b61b64cf485669ac6d0779845
+  metadata.gz: 1ece16f4c64119f8485ebbf1dbfe23f82c3a7cda4bd4e60da2f92fb0992d192ecf59383a5d8624f8d0fd125dd4c7e88f37ffebab51182c366bc29fac6e85f40f
+  data.tar.gz: 16abd91aa04f7db43b9ff21e2f0ed8d2cb6fdeb6605d6356cd24cadc4feba78090f7236533b5572923e2ae5b186827216f496bdeda7353edc68554aed4bae82a

data/README.md

@@ -23,6 +23,8 @@ The main goals of this project are:
     - [What is a strict Service Object?](#what-is-a-strict-service-object)
     - [How to validate Service Object attributes?](#how-to-validate-service-object-attributes)
     - [It's possible to compose pipelines with other pipelines?](#its-possible-to-compose-pipelines-with-other-pipelines)
+  - [Comparisons](#comparisons)
+  - [Benchmarks](#benchmarks)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -345,6 +347,20 @@ SquareAllNumbersAndDoubleThem
 
 Note: You can blend any of the [syntaxes/approaches to create the pipelines](#how-to-create-a-pipeline-of-service-objects)) - [examples](https://github.com/serradura/u-service/blob/master/test/micro/service/pipeline/blend_test.rb#L7-L34).
 
+## Comparisons
+
+Check it out implementations of the same use case with different libs (abstractions).
+
+* [interactor](https://github.com/serradura/u-service/blob/master/comparisons/interactor.rb)
+* [u-service](https://github.com/serradura/u-service/blob/master/comparisons/u-service.rb)
+
+## Benchmarks
+
+**[interactor](https://github.com/collectiveidea/interactor)** VS **[u-service](https://github.com/serradura/u-service)**
+
+https://github.com/serradura/u-service/tree/master/benchmarks/interactor
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `./test.sh` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/benchmarks/interactor/pipeline_failure.rb

@@ -0,0 +1,134 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+  gem 'interactor', '~> 3.1', '>= 3.1.1'
+  gem 'u-service', '~> 0.11.0'
+end
+
+require 'benchmark/ips'
+
+module MSB
+  class ConvertToNumbers < Micro::Service::Base
+    attribute :numbers
+
+    def call!
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        Success(numbers: numbers.map(&:to_i))
+      else
+        Failure(numbers: 'must contain only numeric types')
+      end
+    end
+  end
+
+  class Add2 < Micro::Service::Base
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number + 2 })
+    end
+  end
+
+  Add2ToAllNumbers = ConvertToNumbers >> Add2
+end
+
+module MSS
+  class ConvertToNumbers < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        Success(numbers: numbers.map(&:to_i))
+      else
+        Failure(numbers: 'must contain only numeric types')
+      end
+    end
+  end
+
+  class Add2 < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number + 2 })
+    end
+  end
+
+  Add2ToAllNumbers = ConvertToNumbers >> Add2
+end
+
+module IT
+  class ConvertToNumbers
+    include Interactor
+
+    def call
+      numbers = context.numbers
+
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        context.numbers = numbers.map(&:to_i)
+      else
+        context.fail! numbers: 'must contain only numeric types'
+      end
+    end
+  end
+
+  class Add2
+    include Interactor
+
+    def call
+      numbers = context.numbers
+
+      context.numbers = numbers.map { |number| number + 2 }
+    end
+  end
+
+  class Add2ToAllNumbers
+    include Interactor::Organizer
+
+    organize ConvertToNumbers, Add2
+  end
+end
+
+NUMBERS = {numbers: %w[1 1 2 2 c 4]}
+
+Benchmark.ips do |x|
+  x.config(:time => 5, :warmup => 2)
+
+  x.time = 5
+  x.warmup = 2
+
+  x.report('Pipeline of Micro::Service::Base') do
+    MSB::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.report('Pipeline of Micro::Service::Strict') do
+    MSS::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.report('Interactor::Organizer') do
+    IT::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.compare!
+end
+
+# Warming up --------------------------------------
+# Pipeline of Micro::Service::Base
+#                          5.437k i/100ms
+# Pipeline of Micro::Service::Strict
+#                          5.192k i/100ms
+# Interactor::Organizer
+#                          2.236k i/100ms
+# Calculating -------------------------------------
+# Pipeline of Micro::Service::Base
+#                          56.665k (± 1.9%) i/s -    288.161k in   5.087185s
+# Pipeline of Micro::Service::Strict
+#                          52.914k (± 2.0%) i/s -    264.792k in   5.006157s
+# Interactor::Organizer
+#                          22.940k (± 2.9%) i/s -    116.272k in   5.072931s
+
+# Comparison:
+# Pipeline of Micro::Service::Base:   56665.3 i/s
+# Pipeline of Micro::Service::Strict: 52914.3 i/s - 1.07x  slower
+# Interactor::Organizer:              22940.3 i/s - 2.47x  slower

data/benchmarks/interactor/pipeline_success.rb

@@ -0,0 +1,134 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+  gem 'interactor', '~> 3.1', '>= 3.1.1'
+  gem 'u-service', '~> 0.11.0'
+end
+
+require 'benchmark/ips'
+
+module MSB
+  class ConvertToNumbers < Micro::Service::Base
+    attribute :numbers
+
+    def call!
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        Success(numbers: numbers.map(&:to_i))
+      else
+        Failure(numbers: 'must contain only numeric types')
+      end
+    end
+  end
+
+  class Add2 < Micro::Service::Base
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number + 2 })
+    end
+  end
+
+  Add2ToAllNumbers = ConvertToNumbers >> Add2
+end
+
+module MSS
+  class ConvertToNumbers < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        Success(numbers: numbers.map(&:to_i))
+      else
+        Failure(numbers: 'must contain only numeric types')
+      end
+    end
+  end
+
+  class Add2 < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number + 2 })
+    end
+  end
+
+  Add2ToAllNumbers = ConvertToNumbers >> Add2
+end
+
+module IT
+  class ConvertToNumbers
+    include Interactor
+
+    def call
+      numbers = context.numbers
+
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        context.numbers = numbers.map(&:to_i)
+      else
+        context.fail! numbers: 'must contain only numeric types'
+      end
+    end
+  end
+
+  class Add2
+    include Interactor
+
+    def call
+      numbers = context.numbers
+
+      context.numbers = numbers.map { |number| number + 2 }
+    end
+  end
+
+  class Add2ToAllNumbers
+    include Interactor::Organizer
+
+    organize ConvertToNumbers, Add2
+  end
+end
+
+NUMBERS = {numbers: %w[1 1 2 2 3 4]}
+
+Benchmark.ips do |x|
+  x.config(:time => 5, :warmup => 2)
+
+  x.time = 5
+  x.warmup = 2
+
+  x.report('Pipeline of Micro::Service::Base') do
+    MSB::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.report('Pipeline of Micro::Service::Strict') do
+    MSS::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.report('Interactor::Organizer') do
+    IT::Add2ToAllNumbers.call(NUMBERS)
+  end
+
+  x.compare!
+end
+
+# Warming up --------------------------------------
+# Pipeline of Micro::Service::Base
+#                          3.578k i/100ms
+# Pipeline of Micro::Service::Strict
+#                          3.177k i/100ms
+# Interactor::Organizer
+#                          4.695k i/100ms
+# Calculating -------------------------------------
+# Pipeline of Micro::Service::Base
+#                          36.087k (± 6.9%) i/s -    182.478k in   5.084835s
+# Pipeline of Micro::Service::Strict
+#                          31.329k (± 6.7%) i/s -    158.850k in   5.094012s
+# Interactor::Organizer
+#                          46.294k (± 6.6%) i/s -    234.750k in   5.093117s
+
+# Comparison:
+# Interactor::Organizer:              46293.6 i/s
+# Pipeline of Micro::Service::Base:   36086.5 i/s - 1.28x  slower
+# Pipeline of Micro::Service::Strict: 31328.5 i/s - 1.48x  slower

data/benchmarks/interactor/service_failure.rb

@@ -0,0 +1,93 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+  gem 'interactor', '~> 3.1', '>= 3.1.1'
+  gem 'u-service', '~> 0.11.0'
+end
+
+require 'benchmark/ips'
+
+class MSB_Multiply < Micro::Service::Base
+  attributes :a, :b
+
+  def call!
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      Success(a * b)
+    else
+      Failure(:invalid_data)
+    end
+  end
+end
+
+class MSS_Multiply < Micro::Service::Strict
+  attributes :a, :b
+
+  def call!
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      Success(a * b)
+    else
+      Failure(:invalid_data)
+    end
+  end
+end
+
+class IT_Multiply
+  include Interactor
+
+  def call
+    a = context.a
+    b = context.b
+
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      context.number = a * b
+    else
+      context.fail!(type: :invalid_data)
+    end
+  end
+end
+
+SYMBOL_KEYS = { a: nil, b: 2 }
+STRING_KEYS = { 'a' => 1, 'b' => '' }
+
+Benchmark.ips do |x|
+  x.config(:time => 5, :warmup => 2)
+
+  x.time = 5
+  x.warmup = 2
+
+  x.report('Micro::Service::Base') do
+    MSB_Multiply.call(SYMBOL_KEYS)
+    MSB_Multiply.call(STRING_KEYS)
+  end
+
+  x.report('Micro::Service::Strict') do
+    MSS_Multiply.call(SYMBOL_KEYS)
+    MSS_Multiply.call(STRING_KEYS)
+  end
+
+  x.report('Interactor') do
+    IT_Multiply.call(SYMBOL_KEYS)
+    IT_Multiply.call(STRING_KEYS)
+  end
+
+  x.compare!
+end
+
+# Warming up --------------------------------------
+# Micro::Service::Base     5.304k i/100ms
+# Micro::Service::Strict
+#                          4.516k i/100ms
+#           Interactor     1.507k i/100ms
+# Calculating -------------------------------------
+# Micro::Service::Base     54.444k (± 2.8%) i/s -    275.808k in   5.070215s
+# Micro::Service::Strict
+#                          45.996k (± 1.8%) i/s -    230.316k in   5.008931s
+#           Interactor     15.363k (± 2.2%) i/s -     76.857k in   5.005209s
+
+# Comparison:
+# Micro::Service::Base:    54444.5 i/s
+# Micro::Service::Strict:  45995.8 i/s - 1.18x  slower
+#             Interactor:  15363.0 i/s - 3.54x  slower

data/benchmarks/interactor/service_success.rb

@@ -0,0 +1,93 @@
+require 'bundler/inline'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'benchmark-ips', '~> 2.7', '>= 2.7.2'
+  gem 'interactor', '~> 3.1', '>= 3.1.1'
+  gem 'u-service', '~> 0.11.0'
+end
+
+require 'benchmark/ips'
+
+class MSB_Multiply < Micro::Service::Base
+  attributes :a, :b
+
+  def call!
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      Success(a * b)
+    else
+      Failure(:invalid_data)
+    end
+  end
+end
+
+class MSS_Multiply < Micro::Service::Strict
+  attributes :a, :b
+
+  def call!
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      Success(a * b)
+    else
+      Failure(:invalid_data)
+    end
+  end
+end
+
+class IT_Multiply
+  include Interactor
+
+  def call
+    a = context.a
+    b = context.b
+
+    if a.is_a?(Numeric) && b.is_a?(Numeric)
+      context.number = a * b
+    else
+      context.fail!(:invalid_data)
+    end
+  end
+end
+
+SYMBOL_KEYS = { a: 2, b: 2 }
+STRING_KEYS = { 'a' => 1, 'b' => 1 }
+
+Benchmark.ips do |x|
+  x.config(:time => 5, :warmup => 2)
+
+  x.time = 5
+  x.warmup = 2
+
+  x.report('Micro::Service::Base') do
+    MSB_Multiply.call(SYMBOL_KEYS)
+    MSB_Multiply.call(STRING_KEYS)
+  end
+
+  x.report('Micro::Service::Strict') do
+    MSS_Multiply.call(SYMBOL_KEYS)
+    MSS_Multiply.call(STRING_KEYS)
+  end
+
+  x.report('Interactor') do
+    IT_Multiply.call(SYMBOL_KEYS)
+    IT_Multiply.call(STRING_KEYS)
+  end
+
+  x.compare!
+end
+
+# Warming up --------------------------------------
+# Micro::Service::Base     5.365k i/100ms
+# Micro::Service::Strict
+#                          4.535k i/100ms
+#           Interactor     2.620k i/100ms
+# Calculating -------------------------------------
+# Micro::Service::Base     51.795k (± 4.7%) i/s -    262.885k in   5.086671s
+# Micro::Service::Strict
+#                          46.253k (± 1.6%) i/s -    231.285k in   5.001748s
+#           Interactor     29.561k (± 3.3%) i/s -    149.340k in   5.057720s
+
+# Comparison:
+# Micro::Service::Base:    51794.5 i/s
+# Micro::Service::Strict:  46253.0 i/s - 1.12x  slower
+#             Interactor:  29561.5 i/s - 1.75x  slower

data/lib/micro/service.rb

@@ -5,10 +5,6 @@ require 'micro/attributes'
 require 'micro/service/version'
 
 require 'micro/service/result'
-require 'micro/service/result/success'
-require 'micro/service/result/failure'
-require 'micro/service/result/helpers'
-
 require 'micro/service/base'
 require 'micro/service/strict'
 require 'micro/service/pipeline'

data/lib/micro/service/base.rb

@@ -4,10 +4,13 @@ module Micro
   module Service
     class Base
       include Micro::Attributes.without(:strict_initialize)
-      include Result::Helpers
 
       INVALID_RESULT = '#call! must return a Micro::Service::Result instance'.freeze
 
+      ResultIsAlreadyDefined = ArgumentError.new('result is already defined'.freeze)
+
+      private_constant :INVALID_RESULT, :ResultIsAlreadyDefined
+
       def self.>>(service)
         Micro::Service::Pipeline[self, service]
       end
@@ -16,6 +19,13 @@ module Micro
         new(options).call
       end
 
+      def self.__new__(result, arg)
+        instance = allocate
+        instance.__set_result__(result)
+        instance.send(:initialize, arg)
+        instance
+      end
+
       def call!
         raise NotImplementedError
       end
@@ -25,6 +35,27 @@ module Micro
         return result if result.is_a?(Service::Result)
         raise TypeError, self.class.name + INVALID_RESULT
       end
+
+      def __set_result__(result)
+        raise ResultIsAlreadyDefined if @__result
+        @__result = result
+      end
+
+      private
+
+        def __get_result__
+          @__result ||= Result.new
+        end
+
+        def Success(arg=nil)
+          value, type = block_given? ? [yield, arg] : [arg, nil]
+          __get_result__.__set__(true, value, type)
+        end
+
+        def Failure(arg=nil)
+          value, type = block_given? ? [yield, arg] : [arg, nil]
+          __get_result__.__set__(false, value, type)
+        end
     end
   end
 end

data/lib/micro/service/pipeline.rb

@@ -6,8 +6,9 @@ module Micro
       class Reducer
         attr_reader :services
 
-        INVALID_SERVICES =
-          'argument must be a collection of `Micro::Service::Base` classes'.freeze
+        InvalidServices = ArgumentError.new('argument must be a collection of `Micro::Service::Base` classes'.freeze)
+
+        private_constant :InvalidServices
 
         def self.map_services(arg)
           return arg.services if arg.is_a?(Reducer)
@@ -18,7 +19,7 @@ module Micro
         def self.build(args)
           services = Array(args).flat_map { |arg| map_services(arg) }
 
-          raise ArgumentError, INVALID_SERVICES if services.any? { |klass| !(klass < ::Micro::Service::Base) }
+          raise InvalidServices if services.any? { |klass| !(klass < ::Micro::Service::Base) }
 
           new(services)
         end
@@ -30,7 +31,7 @@ module Micro
         def call(arg={})
           @services.reduce(initial_result(arg)) do |result, service|
             break result if result.failure?
-            service.call(result.value)
+            service.__new__(result, result.value).call
           end
         end
 
@@ -43,8 +44,8 @@ module Micro
           def initial_result(arg)
             return arg.call if arg_to_call?(arg)
             return arg if arg.is_a?(Micro::Service::Result)
-
-            Micro::Service::Result::Success[value: arg]
+            result = Micro::Service::Result.new
+            result.__set__(true, arg, nil)
           end
 
           def arg_to_call?(arg)
@@ -74,9 +75,9 @@ module Micro
         Reducer.build(args)
       end
 
-      UNDEFINED_PIPELINE = "This class hasn't declared its pipeline. Please, use the `pipeline()` macro to define one.".freeze
+      UndefinedPipeline = ArgumentError.new("This class hasn't declared its pipeline. Please, use the `pipeline()` macro to define one.".freeze)
 
-      private_constant :UNDEFINED_PIPELINE
+      private_constant :UndefinedPipeline
 
       def self.included(base)
         base.extend(ClassMethods)
@@ -84,7 +85,7 @@ module Micro
         def initialize(options)
           @options = options
           pipeline = self.class.__pipeline__
-          raise ArgumentError, UNDEFINED_PIPELINE unless pipeline
+          raise UndefinedPipeline unless pipeline
         end
         RUBY
       end

data/lib/micro/service/result.rb

@@ -3,27 +3,20 @@
 module Micro
   module Service
     class Result
-      module Type
-        INVALID = 'type must be nil or a symbol'.freeze
+      InvalidType = TypeError.new('type must be nil or a symbol'.freeze)
 
-        def self.[](arg)
-          return arg if arg.nil? || arg.is_a?(Symbol)
-          raise TypeError, INVALID
-        end
-      end
+      attr_reader :value, :type
 
-      private_constant :Type
+      def __set__(is_success, value, type)
+        raise InvalidType unless type.nil? || type.is_a?(Symbol)
 
-      include Micro::Attributes.with(:strict_initialize)
+        @success, @value, @type = is_success, value, type
 
-      def self.[](value:, type: nil)
-        new(value: value, type: Type[type])
+        self
       end
 
-      attributes :type, :value
-
       def success?
-        raise NotImplementedError
+        @success
       end
 
       def failure?

data/lib/micro/service/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Service
-    VERSION = '0.11.0'.freeze
+    VERSION = '0.12.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-service
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: u-attributes
@@ -68,6 +68,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/interactor/pipeline_failure.rb
+- benchmarks/interactor/pipeline_success.rb
+- benchmarks/interactor/service_failure.rb
+- benchmarks/interactor/service_success.rb
 - bin/console
 - bin/setup
 - comparisons/interactor.rb
@@ -76,9 +80,6 @@ files:
 - lib/micro/service/base.rb
 - lib/micro/service/pipeline.rb
 - lib/micro/service/result.rb
-- lib/micro/service/result/failure.rb
-- lib/micro/service/result/helpers.rb
-- lib/micro/service/result/success.rb
 - lib/micro/service/strict.rb
 - lib/micro/service/version.rb
 - lib/micro/service/with_validation.rb

data/lib/micro/service/result/failure.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Micro
-  module Service
-    class Result
-      class Failure < Micro::Service::Result
-        def success?; false; end
-      end
-    end
-  end
-end

data/lib/micro/service/result/helpers.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Micro
-  module Service
-    class Result
-      module Helpers
-        private def Success(arg=nil)
-          value, type = block_given? ? [yield, arg] : [arg, nil]
-          Result::Success[value: value, type: type]
-        end
-
-        private def Failure(arg=nil)
-          value, type = block_given? ? [yield, arg] : [arg, nil]
-          Result::Failure[value: value, type: type]
-        end
-      end
-    end
-  end
-end

data/lib/micro/service/result/success.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Micro
-  module Service
-    class Result
-      class Success < Micro::Service::Result
-        def success?; true; end
-      end
-    end
-  end
-end