u-service 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9aa9c4a076ce6c0f78c14a4084200eef94d7e04feda739ae80a715d83b17d29
-  data.tar.gz: 4d52dc751a9c0da7dfbca46bae74b00286422835c201e1ee27dbfb7b467fa010
+  metadata.gz: e760358632fb06d0fb235f3b01723b1de144c21be568f7db9bca62b7e9b1910b
+  data.tar.gz: 7601fde72507d36673a6868a29b2ce382c8e1ce910514530c275ffb8bb6ec1b5
 SHA512:
-  metadata.gz: 207f7141d5e7dcc5063d0ddbad53f51bb3c6991e287b2dac25de21c77e8c2386b6200b62f0eea819a22dd42b3fd86e0f7f37c62f8cf99e93080f9223451c566f
-  data.tar.gz: e8a887fd59c3663aeea410b8ca840aa1d507a3ff239edb0ac8909932c7776e68a13e705ab9b8262b84a5c812fdf0e1e97c016c30ae19e47f1e009476a41ca6ae
+  metadata.gz: bd4ea2da734b495a14fcfdf2c42513eb80d5cd677910c8b84eb0e093effaee151c124393f25a08bc2e41c249d50aa0022b15a734e55aa6fccd24755d9b4be236
+  data.tar.gz: 81981c5a33bb3558f40a233cc0e5112cda17c2b2938ee3106cda1ec2dce7b98eddd384b58dbd2e6a4ae29e9c2e86ac4fb23c2d3b61b64cf485669ac6d0779845

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
+tags

data/README.md

@@ -8,6 +8,11 @@
 
 Create simple and powerful service objects.
 
+The main goals of this project are:
+1. The smallest possible learning curve.
+2. Referential transparency and data integrity.
+3. No callbacks, compose a pipeline of service objects to represents complex business logic. (input >> process/transform >> output)
+
 - [μ-service (Micro::Service)](#%ce%bc-service-microservice)
   - [Required Ruby version](#required-ruby-version)
   - [Installation](#installation)
@@ -342,7 +347,7 @@ Note: You can blend any of the [syntaxes/approaches to create the pipelines](#ho
 
 ## 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.
+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.
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/comparisons/interactor.rb

@@ -0,0 +1,57 @@
+class CreateResponse
+  include Interactor
+
+  def call
+    responder = context.responder
+
+    survey_response = responder.survey_responses.build(
+      response_text: context.answers[:text],
+      rating: answers[:rating]
+      survey: context.survey
+    )
+
+    if survey_response.save
+      context.survey_response = survey_response
+    else
+      context.fail!(errors: survey_response.errors)
+    end
+  end
+end
+
+class AddRewardPoints
+  include Interactor
+
+  def call
+    reward_account = context.responder.reward_account
+
+    reward_account.balance += context.survey.reward_points
+
+    unless reward_account.save
+      context.fail!(errors: reward_account.errors)
+    end
+  end
+end
+
+class SendNotifications
+  include Interactor
+
+  def call
+    sender = context.survey.sender
+
+    SurveyMailer.delay.notify_responder(context.responder.id)
+    SurveyMailer.delay.notify_sender(sender.id)
+
+    unless sender.add_survey_response_notification
+      context.fail!(errors: sender.errors)
+    end
+  end
+end
+
+class ReplyToSurvey
+  include Interactor::Organizer
+
+  organize CreateResponse, AddRewardPoints, SendNotifications
+end
+
+# https://gist.githubusercontent.com/raderj89/cbb84b1f75e67087388bc4cdbe617138/raw/a39c3ba6b416ac3919cc7d32bfa58e82211f24ef/interactor_example.rb
+# https://medium.com/reflektive-engineering/from-service-objects-to-interactors-db7d2bb7dfd9

data/comparisons/u-service.rb

@@ -0,0 +1,61 @@
+class CreateResponse < Micro::Service::Strict
+  attributes :responder, :answers, :survey
+
+  def call!
+    survey_response = responder.survey_responses.build(
+      response_text: answers[:text],
+      rating: answers[:rating]
+      survey: survey
+    )
+
+    return Success { attributes(:responder, :survey) } if survey_response.save
+
+    Failure(:survey_response) { survey_response.errors }
+  end
+end
+
+class AddRewardPoints < Micro::Service::Strict
+  attributes :responder, :survey
+
+  def call!
+    reward_account = responder.reward_account
+    reward_account.balance += survey.reward_points
+
+    return Success { attributes(:responder, :survey) } if reward_account.save
+
+    Failure(:reward_account) { reward_account.errors }
+  end
+end
+
+class SendNotifications < Micro::Service::Strict
+  attributes :responder, :survey
+
+  def call!
+    sender = survey.sender
+
+    SurveyMailer.delay.notify_responder(responder.id)
+    SurveyMailer.delay.notify_sender(sender.id)
+
+    return Success { attributes(:survey) } if sender.add_survey_response_notification
+
+    Failure(:sender) { sender.errors }
+  end
+end
+
+ReplyToSurvey = CreateResponse >> AddRewardPoints >> SendNotifications
+
+# or
+
+ReplyToSurvey = Micro::Service::Pipeline[
+  CreateResponse,
+  AddRewardPoints,
+  SendNotifications
+]
+
+# or
+
+class ReplyToSurvey
+  include Micro::Service::Pipeline
+
+  pipeline CreateResponse, AddRewardPoints, SendNotifications
+end

data/lib/micro/service/pipeline.rb

@@ -41,10 +41,17 @@ module Micro
         private
 
           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]
           end
+
+          def arg_to_call?(arg)
+            return true if arg.is_a?(Micro::Service::Base) || arg.is_a?(Reducer)
+            return true if arg.is_a?(Class) && (arg < Micro::Service::Base || arg < Micro::Service::Pipeline)
+            return false
+          end
       end
 
       module ClassMethods
@@ -67,9 +74,19 @@ module Micro
         Reducer.build(args)
       end
 
+      UNDEFINED_PIPELINE = "This class hasn't declared its pipeline. Please, use the `pipeline()` macro to define one.".freeze
+
+      private_constant :UNDEFINED_PIPELINE
+
       def self.included(base)
         base.extend(ClassMethods)
-        base.class_eval('def initialize(options); @options = options; end')
+        base.class_eval(<<-RUBY)
+        def initialize(options)
+          @options = options
+          pipeline = self.class.__pipeline__
+          raise ArgumentError, UNDEFINED_PIPELINE unless pipeline
+        end
+        RUBY
       end
 
       def call

data/lib/micro/service/version.rb

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

data/test.sh

@@ -1,7 +1,11 @@
 #!/bin/bash
 
-git checkout -- Gemfile.lock
+bundle
+
+rm Gemfile.lock
 
 source $(dirname $0)/.travis.sh
 
-git checkout -- Gemfile.lock
+rm Gemfile.lock
+
+bundle

data/u-service.gemspec

@@ -39,7 +39,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'u-attributes', '~> 1.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'minitest', '~> 5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: u-service
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rodrigo Serradura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-10 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: u-attributes
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 description: Create simple and powerful service objects.
 email:
 - rodrigo.serradura@gmail.com
@@ -79,12 +65,13 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- comparisons/interactor.rb
+- comparisons/u-service.rb
 - lib/micro/service.rb
 - lib/micro/service/base.rb
 - lib/micro/service/pipeline.rb

data/Gemfile.lock

@@ -1,32 +0,0 @@
-PATH
-  remote: .
-  specs:
-    u-service (0.10.0)
-      u-attributes (~> 1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    docile (1.3.2)
-    json (2.2.0)
-    minitest (5.11.3)
-    rake (10.5.0)
-    simplecov (0.17.0)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    u-attributes (1.2.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  simplecov
-  u-service!
-
-BUNDLED WITH
-   1.17.3