light-service 0.0.9 → 0.0.10

data/README.md

@@ -1,7 +1,9 @@
-![Light Service](https://raw.github.com/adomokos/light-service/master/light-service.png)
+![Light Service](https://raw.github.com/adomokos/light-service/master/resources/light-service.png)
 
 [![Build Status](https://secure.travis-ci.org/adomokos/light-service.png)](http://travis-ci.org/adomokos/light-service)
 
+[![Code Climate](https://codeclimate.com/github/adomokos/light-service.png)](https://codeclimate.com/github/adomokos/light-service)
+
 What do you think of this code?
 
 ```ruby
@@ -58,9 +60,13 @@ This block of code should tell you the "story" of what's going on in this workfl
 With the help of LightService you can write code this way. First you need an organizer object that sets up the actions in order
 and executes them one-by-one. Then you need to create the actions which will only have one method and will do only one thing.
 
+This is how the organizer and actions interact with eachother:
+
+![Light Service](https://raw.github.com/adomokos/light-service/master/resources/organizer_and_actions.png)
+
 ```ruby
 class CalculatesTax
-  extend LightService::Organizer
+  include LightService::Organizer
 
   def self.for_order(order)
     with(order: order).reduce \
@@ -143,12 +149,18 @@ class TaxController < ApplicationContoller
   end
 end
 ```
+I gave a [talk at RailsConf 2013](http://www.adomokos.com/2013/06/simple-and-elegant-rails-code-with.html) on
+simple and elegant Rails code where I told the story of how Light Service was extracted from the projects I had worked on.
+
+## Requirements
+
+This gem requires ruby 1.9.x
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'light_service'
+    gem 'light-service'
 
 And then execute:
 
@@ -156,13 +168,71 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install light_service
+    $ gem install light-service
 
 ## Usage
 
 Based on the refactoring example above, just create an organizer object that calls the 
 actions in order and write code for the actions. That's it.
 
+Here's how to use a `LightService::Action` as a `LightService::Organizer`:
+
+```ruby
+require 'light-service'
+ 
+module Yoyo
+  class PushesLead
+    include LightService::Action
+    include LightService::Organizer
+ 
+    executed do |context|
+      lead = context.fetch(:lead)
+      fail ArgumentError if lead.nil?
+ 
+      integration = context.fetch(:integration)
+      fail ArgumentError if integration.nil?
+ 
+      with(context).reduce([
+        PreparesLeadForImport,
+        RemoteClient::ImportsGuestCard
+      ])
+    end
+  end
+end
+```
+
+Calling `set_failure!` on the context will stop execution of the remaining actions, in some cases you may want the same behaviour but not due to failure, in that case use `skip_all!`. `skip_all!` optionally takes a message argument.
+
+```ruby
+# organizer class registered to execute 2 actions
+class AddComment
+  extend LightService::Organizer
+
+  def self.to_post(args = {})
+    with(args).reduce [
+      SaveCommentAction,
+      PublishCommentAction
+    ]
+  end
+end
+
+# action to save comment data, conditionally will bypass the remaining actions
+class SaveCommentAction
+  include LightService::Action
+
+  executed do |context|
+    comment = context.fetch(:comment)
+    post = context.fetch(:post)
+    post.comments << comment
+    
+    unless comment.commenter.can_auto_approve_own_comment
+      # calling skip_all! will bypass PublishCommentAction execution
+      context.skip_all!
+    end
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -170,3 +240,7 @@ actions in order and write code for the actions. That's it.
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Light Service is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/light-service/action.rb

@@ -8,7 +8,7 @@ module LightService
     module Macros
       def executed
         define_singleton_method "execute" do |context|
-          return context if context.failure?
+          return context if context.failure? || context.skip_all?
 
           yield(context)
 

data/lib/light-service/context.rb

@@ -44,6 +44,10 @@ module LightService
       success? == false
     end
 
+    def skip_all?
+      @skip_all
+    end
+
     def set_success!(message)
       @message = message
       @outcome = ::LightService::Outcomes::SUCCESS
@@ -54,5 +58,10 @@ module LightService
       @outcome = ::LightService::Outcomes::FAILURE
     end
 
+    def skip_all!(message = nil)
+      @message = message
+      @skip_all = true
+    end
+
   end
 end

data/lib/light-service/organizer.rb

@@ -1,15 +1,28 @@
 module LightService
   module Organizer
-    protected
-      def with(data = {})
-        @context = data.kind_of?(::LightService::Context) ?
-                     data :
-                     LightService::Context.make(data)
-        self
+    def self.included(base_class)
+      base_class.extend ClassMethods
+    end
+
+    module ClassMethods
+      def with(data)
+        new.with(data)
       end
 
-      def reduce(actions=[])
-        actions.reduce(@context) { |context, action| action.execute(context) }
+      def reduce(actions)
+        new.reduce(actions)
       end
+    end
+
+    def with(data = {})
+      @context = data.kind_of?(::LightService::Context) ?
+                 data :
+                 LightService::Context.make(data)
+      self
+    end
+
+    def reduce(actions=[])
+      actions.reduce(@context) { |context, action| action.execute(context) }
+    end
   end
 end

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/spec/acceptance/add_numbers_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class Organizer
-  extend LightService::Organizer
+  include LightService::Organizer
 
   def self.add_number(number)
     with(number: number).reduce \

data/spec/action_base_spec.rb

@@ -10,6 +10,14 @@ module LightService
       end
     end
 
+    class SkippedAction
+      include LightService::Action
+
+      executed do |context|
+        context[:test_key] = "set_by_skipped_action"
+      end
+    end
+
     let(:context) { ::LightService::Context.new }
 
     context "when the action context has failure" do
@@ -30,6 +38,26 @@ module LightService
       end
     end
 
+    context "when the action context skips all" do
+      it "returns immediately" do
+        context.skip_all!
+
+        DummyAction.execute(context)
+
+        context.context_hash.keys.should be_empty
+      end
+
+      it "does not execute skipped actions" do
+        DummyAction.execute(context)
+
+        context.skip_all!
+
+        SkippedAction.execute(context)
+
+        context.context_hash.should eq ({:test_key => "test_value"})
+      end
+    end
+
     it "returns the context" do
       result = DummyAction.execute(context)
 

data/spec/organizer_spec.rb

@@ -4,7 +4,7 @@ describe LightService::Organizer do
   class AnAction; end
 
   class AnOrganizer
-    extend LightService::Organizer
+    include LightService::Organizer
 
     def self.some_method(user)
       with(user: user).reduce [AnAction]
@@ -16,7 +16,7 @@ describe LightService::Organizer do
     end
   end
 
-  let(:context) { ::LightService::Context.make(user: user) }
+  let!(:context) { ::LightService::Context.new(user: user) }
   let(:user) { double(:user) }
 
   context "when #with is called with hash" do
@@ -34,12 +34,13 @@ describe LightService::Organizer do
 
   context "when #with is called with Context" do
     it "does not create a context" do
-      LightService::Context.stub(:new).and_return context
+      LightService::Context.stub(:new).with(user: user).and_return(context)
+      LightService::Context.should_not_receive(:make)
 
       AnAction.should_receive(:execute) \
               .with(context) \
               .and_return context
-      AnOrganizer.some_method_with(context)
+      AnOrganizer.some_method_with(user)
     end
   end
 

data/spec/sample/tax/calculates_tax.rb

@@ -1,5 +1,5 @@
 class CalculatesTax
-  extend LightService::Organizer
+  include LightService::Organizer
 
   def self.for_order(order)
     with(order: order).reduce \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,7 +63,8 @@ files:
 - lib/light-service/organizer.rb
 - lib/light-service/version.rb
 - light-service.gemspec
-- light-service.png
+- resources/light-service.png
+- resources/organizer_and_actions.png
 - spec/acceptance/add_numbers_spec.rb
 - spec/action_base_spec.rb
 - spec/context_spec.rb