u-service 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03877b6389a946be9418d0d4f41d8efe5a67811920bcdaacbb7467cc31d86275'
-  data.tar.gz: d560985874aa56cfb429fcca22520c37ff6acc5ae74a5a1b8f6aa682e84c2084
+  metadata.gz: b9aa9c4a076ce6c0f78c14a4084200eef94d7e04feda739ae80a715d83b17d29
+  data.tar.gz: 4d52dc751a9c0da7dfbca46bae74b00286422835c201e1ee27dbfb7b467fa010
 SHA512:
-  metadata.gz: 40681884ea919c82a08cf7e454582f5f0135567efd2d80f63bff464b7d11aab9ae523a25432dd557433d8b58c6a4e9f3493e47e8d1f791d0849976060b3cc438
-  data.tar.gz: 79a7ed2f656c80a39d554a09777c2affba64e3897b606cf666e5a607912113464bd95d3b94cc516c450f03f1bf02868363a4f9b4f9332127b9b329b8b4995dc2
+  metadata.gz: 207f7141d5e7dcc5063d0ddbad53f51bb3c6991e287b2dac25de21c77e8c2386b6200b62f0eea819a22dd42b3fd86e0f7f37c62f8cf99e93080f9223451c566f
+  data.tar.gz: e8a887fd59c3663aeea410b8ca840aa1d507a3ff239edb0ac8909932c7776e68a13e705ab9b8262b84a5c812fdf0e1e97c016c30ae19e47f1e009476a41ca6ae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    u-service (0.9.0)
+    u-service (0.10.0)
       u-attributes (~> 1.1)
 
 GEM

data/README.md

@@ -13,10 +13,11 @@ Create simple and powerful service objects.
   - [Installation](#installation)
   - [Usage](#usage)
     - [How to create a Service Object?](#how-to-create-a-service-object)
-    - [How to use the Service Object result hooks?](#how-to-use-the-service-object-result-hooks)
+    - [How to use the result hooks?](#how-to-use-the-result-hooks)
     - [How to create a pipeline of Service Objects?](#how-to-create-a-pipeline-of-service-objects)
     - [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)
   - [Development](#development)
   - [Contributing](#contributing)
   - [License](#license)
@@ -64,6 +65,7 @@ end
 #====================#
 
 result = Multiply.call(a: 2, b: 2)
+
 p result.success? # true
 p result.value    # 4
 
@@ -76,6 +78,7 @@ p result.value    # 4
 #----------------------------#
 
 result = Multiply.new(a: 2, b: 3).call
+
 p result.success? # true
 p result.value    # 6
 
@@ -84,12 +87,13 @@ p result.value    # 6
 #===========================#
 
 result = Multiply.call(a: '2', b: 2)
+
 p result.success? # false
 p result.failure? # true
 p result.value    # :invalid_data
 ```
 
-### How to use the Service Object result hooks?
+### How to use the result hooks?
 
 ```ruby
 class Double < Micro::Service::Base
@@ -135,13 +139,13 @@ Double
 ```ruby
 module Steps
   class ConvertToNumbers < Micro::Service::Base
-    attribute :relation
+    attribute :numbers
 
     def call!
-      if relation.all? { |value| String(value) =~ /\d+/ }
-        Success(numbers: relation.map(&:to_i))
+      if numbers.all? { |value| String(value) =~ /\d+/ }
+        Success(numbers: numbers.map(&:to_i))
       else
-        Failure('relation must contain only numbers')
+        Failure('numbers must contain only numeric types')
       end
     end
   end
@@ -150,7 +154,7 @@ module Steps
     attribute :numbers
 
     def call!
-      Success(numbers.map { |number| number + 2 })
+      Success(numbers: numbers.map { |number| number + 2 })
     end
   end
 
@@ -158,17 +162,36 @@ module Steps
     attribute :numbers
 
     def call!
-      Success(numbers.map { |number| number * 2 })
+      Success(numbers: numbers.map { |number| number * 2 })
+    end
+  end
+
+  class Square < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number * number })
     end
   end
 end
 
+#=================================================#
+# Creating a pipeline using the collection syntax #
+#=================================================#
+
 Add2ToAllNumbers = Micro::Service::Pipeline[
   Steps::ConvertToNumbers,
   Steps::Add2
 ]
 
-# An alternative way to declare pipelines within classes.
+result = Add2ToAllNumbers.call(numbers: %w[1 1 2 2 3 4])
+
+p result.success? # true
+p result.value    # {:numbers => [3, 3, 4, 4, 5, 6]}
+
+#=======================================================#
+# An alternative way to create a pipeline using classes #
+#=======================================================#
 
 class DoubleAllNumbers
   include Micro::Service::Pipeline
@@ -176,14 +199,20 @@ class DoubleAllNumbers
   pipeline Steps::ConvertToNumbers, Steps::Double
 end
 
-result = Add2ToAllNumbers.call(relation: %w[1 1 2 2 3 4])
+DoubleAllNumbers
+  .call(numbers: %w[1 1 b 2 3 4])
+  .on_failure { |message| p message } # "numbers must contain only numeric types"
 
-p result.success? # true
-p result.value    # [3, 3, 4, 4, 5, 6]
+#=================================================================#
+# Another way to create a pipeline using the composition operator #
+#=================================================================#
 
-DoubleAllNumbers
-  .call(relation: %w[1 1 b 2 3 4])
-  .on_failure { |message| p message } # "relation must contain only numbers"
+SquareAllNumbers =
+  Steps::ConvertToNumbers >> Steps::Square
+
+SquareAllNumbers
+  .call(numbers: %w[1 1 2 2 3 4])
+  .on_success { |value| p value[:numbers] } # [1, 1, 4, 4, 9, 16]
 ```
 
 ### What is a strict Service Object?
@@ -249,6 +278,68 @@ end
 # Use Micro::Service::Strict::Validation if do you want this behavior.
 ```
 
+### It's possible to compose pipelines with other pipelines?
+
+Answer: Yes
+
+```ruby
+module Steps
+  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::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number + 2 })
+    end
+  end
+
+  class Double < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number * 2 })
+    end
+  end
+
+  class Square < Micro::Service::Strict
+    attribute :numbers
+
+    def call!
+      Success(numbers: numbers.map { |number| number * number })
+    end
+  end
+end
+
+Add2ToAllNumbers = Steps::ConvertToNumbers >> Steps::Add2
+DoubleAllNumbers = Steps::ConvertToNumbers >> Steps::Double
+SquareAllNumbers = Steps::ConvertToNumbers >> Steps::Square
+DoubleAllNumbersAndAdd2 = DoubleAllNumbers >> Steps::Add2
+SquareAllNumbersAndAdd2 = SquareAllNumbers >> Steps::Add2
+DoubleAllNumbersAndSquareThem = DoubleAllNumbers >> SquareAllNumbersAndAdd2
+SquareAllNumbersAndDoubleThem = SquareAllNumbersAndAdd2 >> DoubleAllNumbers
+
+DoubleAllNumbersAndSquareThem
+  .call(numbers: %w[1 1 2 2 3 4])
+  .on_success { |value| p value[:numbers] } # [6, 6, 18, 18, 38, 66]
+
+SquareAllNumbersAndDoubleThem
+  .call(numbers: %w[1 1 2 2 3 4])
+  .on_success { |value| p value[:numbers] } # [6, 6, 12, 12, 22, 36]
+```
+
+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).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/micro/service/base.rb

@@ -8,6 +8,10 @@ module Micro
 
       INVALID_RESULT = '#call! must return a Micro::Service::Result instance'.freeze
 
+      def self.>>(service)
+        Micro::Service::Pipeline[self, service]
+      end
+
       def self.call(options = {})
         new(options).call
       end

data/lib/micro/service/pipeline.rb

@@ -4,11 +4,19 @@ module Micro
   module Service
     module Pipeline
       class Reducer
+        attr_reader :services
+
         INVALID_SERVICES =
           'argument must be a collection of `Micro::Service::Base` classes'.freeze
 
+        def self.map_services(arg)
+          return arg.services if arg.is_a?(Reducer)
+          return arg.__pipeline__.services if arg.is_a?(Class) && arg < Micro::Service::Pipeline
+          Array(arg)
+        end
+
         def self.build(args)
-          services = Array(args)
+          services = Array(args).flat_map { |arg| map_services(arg) }
 
           raise ArgumentError, INVALID_SERVICES if services.any? { |klass| !(klass < ::Micro::Service::Base) }
 
@@ -26,23 +34,26 @@ module Micro
           end
         end
 
+        def >>(arg)
+          Reducer.build(services + self.class.map_services(arg))
+        end
+
         private
 
           def initial_result(arg)
             return arg if arg.is_a?(Micro::Service::Result)
+
             Micro::Service::Result::Success[value: arg]
           end
       end
 
-      private_constant :Reducer
-
-      module Macros
-        def pipeline(*args)
-          @pipeline = Reducer.build(args)
+      module ClassMethods
+        def __pipeline__
+          @__pipeline
         end
 
-        def pipeline_call(options)
-          @pipeline.call(options)
+        def pipeline(*args)
+          @__pipeline = Reducer.build(args)
         end
 
         def call(options={})
@@ -50,19 +61,19 @@ module Micro
         end
       end
 
-      private_constant :Macros
+      private_constant :ClassMethods
 
       def self.[](*args)
         Reducer.build(args)
       end
 
       def self.included(base)
-        base.extend(Macros)
+        base.extend(ClassMethods)
         base.class_eval('def initialize(options); @options = options; end')
       end
 
       def call
-        self.class.pipeline_call(@options)
+        self.class.__pipeline__.call(@options)
       end
     end
   end

data/lib/micro/service/version.rb

@@ -2,6 +2,6 @@
 
 module Micro
   module Service
-    VERSION = '0.9.0'.freeze
+    VERSION = '0.10.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-service
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: u-attributes