light-service 0.0.10 → 0.0.11

data/README.md

@@ -1,4 +1,4 @@
-![Light Service](https://raw.github.com/adomokos/light-service/master/resources/light-service.png)
+![LightService](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)
 
@@ -7,7 +7,7 @@
 What do you think of this code?
 
 ```ruby
-class TaxController < ApplicationContoller
+class TaxController < ApplicationController
   def update
     @order = Order.find(params[:id])
     tax_ranges = TaxRange.for_region(order.region)
@@ -36,7 +36,7 @@ end
 ```
 
 This controller violates [SRP](http://en.wikipedia.org/wiki/Single_responsibility_principle) all over.
-Also, imagine what it takes to test this beast.
+Also, imagine what would it take to test this beast.
 You could move the tax_percentage finders and calculations into the tax model,
 but then you'll make your model logic heavy.
 
@@ -62,7 +62,7 @@ and executes them one-by-one. Then you need to create the actions which will onl
 
 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)
+![LightService](https://raw.github.com/adomokos/light-service/master/resources/organizer_and_actions.png)
 
 ```ruby
 class CalculatesTax
@@ -150,7 +150,7 @@ class TaxController < ApplicationContoller
 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.
+simple and elegant Rails code where I told the story of how LightService was extracted from the projects I had worked on.
 
 ## Requirements
 
@@ -175,63 +175,7 @@ Or install it yourself as:
 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
-```
+For further examples, please visit the project's [Wiki](https://github.com/adomokos/light-service/wiki).
 
 ## Contributing
 
@@ -243,4 +187,4 @@ end
 
 ## License
 
-Light Service is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+LightService is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/light-service/action.rb

@@ -8,13 +8,24 @@ module LightService
     module Macros
       def executed
         define_singleton_method "execute" do |context|
-          return context if context.failure? || context.skip_all?
+          action_context = create_action_context(context)
+          return action_context if action_context.failure? || action_context.skip_all?
 
-          yield(context)
+          yield(action_context)
 
-          context
+          action_context
         end
       end
+
+      private
+
+      def create_action_context(context)
+        if context.respond_to? :failure?
+          return context
+        end
+
+        LightService::Context.make(context)
+      end
     end
 
   end

data/lib/light-service/context.rb

@@ -4,36 +4,27 @@ module LightService
     FAILURE = 1
   end
 
-  class Context
+  class Context < Hash
     attr_accessor :outcome, :message
 
-    def initialize(outcome=::LightService::Outcomes::SUCCESS, message='', context={})
-      @outcome, @message, @context = outcome, message, context
+    def initialize(context={}, outcome=::LightService::Outcomes::SUCCESS, message='')
+      @outcome, @message = outcome, message
+      context.to_hash.each {|k,v| self[k] = v}
     end
 
     def self.make(context={})
-      Context.new(::LightService::Outcomes::SUCCESS, '', context)
+      Context.new(context, ::LightService::Outcomes::SUCCESS, '')
     end
 
     def add_to_context(values)
-      @context.merge! values
-    end
-
-    def [](index)
-      @context[index]
-    end
-
-    def []=(index, value)
-      @context[index] = value
-    end
-
-    def fetch(index)
-      @context.fetch(index)
+      self.merge! values
     end
 
     # It's really there for testing and debugging
+    # Deprecated: Please use `to_hash` instead
     def context_hash
-      @context.dup
+      warn 'DEPRECATED: Please use `to_hash` instead'
+      self.dup
     end
 
     def success?
@@ -62,6 +53,5 @@ module LightService
       @message = message
       @skip_all = true
     end
-
   end
 end

data/lib/light-service/organizer.rb

@@ -8,16 +8,10 @@ module LightService
       def with(data)
         new.with(data)
       end
-
-      def reduce(actions)
-        new.reduce(actions)
-      end
     end
 
     def with(data = {})
-      @context = data.kind_of?(::LightService::Context) ?
-                 data :
-                 LightService::Context.make(data)
+      @context = LightService::Context.make(data)
       self
     end
 

data/lib/light-service/version.rb

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

data/light-service.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency("rspec", "~> 2.0")
   gem.add_development_dependency("simplecov", "~> 0.7.1")
+  gem.add_development_dependency("pry", "0.9.12.2")
 end

data/spec/{action_base_spec.rb → action_spec.rb}

@@ -26,7 +26,7 @@ module LightService
 
         DummyAction.execute(context)
 
-        context.context_hash.keys.should be_empty
+        context.to_hash.keys.should be_empty
       end
     end
 
@@ -34,7 +34,7 @@ module LightService
       it "executes the block" do
         DummyAction.execute(context)
 
-        context.context_hash.keys.should eq [:test_key]
+        context.to_hash.keys.should eq [:test_key]
       end
     end
 
@@ -44,7 +44,7 @@ module LightService
 
         DummyAction.execute(context)
 
-        context.context_hash.keys.should be_empty
+        context.to_hash.keys.should be_empty
       end
 
       it "does not execute skipped actions" do
@@ -54,14 +54,23 @@ module LightService
 
         SkippedAction.execute(context)
 
-        context.context_hash.should eq ({:test_key => "test_value"})
+        context.to_hash.should eq ({:test_key => "test_value"})
       end
     end
 
     it "returns the context" do
       result = DummyAction.execute(context)
 
-      result.context_hash.should eq ({:test_key => "test_value"})
+      result.to_hash.should eq ({:test_key => "test_value"})
+    end
+
+    context "can take hash as an argument" do
+      it "creates LightService::Context implicitly" do
+        result = DummyAction.execute(some_key: "some value")
+
+        expect(result).to be_success
+        expect(result.keys).to eq([:some_key, :test_key])
+      end
     end
   end
 end

data/spec/context_spec.rb

@@ -2,11 +2,13 @@ require "spec_helper"
 
 module LightService
   describe Context do
-    subject { Context.new(Outcomes::SUCCESS, "some_message", {:test => 1}) }
+    subject { Context.new({:test => 1}, Outcomes::SUCCESS, "some_message") }
 
     it "initializes the object with default arguments" do
-      service_result = Context.new
+      service_result = Context.new({test: 1})
       service_result.should be_success
+      service_result.message.should eq ""
+      service_result[:test].should eq 1
     end
 
     it "initializes the object with the context" do
@@ -16,11 +18,40 @@ module LightService
       service_result[:test].should eq 1
     end
 
-    it "initializes the object with make" do
-      service_result = Context.make({:test => 1})
-      service_result.should be_success
-      service_result.message.should eq ""
-      service_result[:test].should eq 1
+    describe ".make" do
+      it "initializes the object with make" do
+        service_result = Context.make({:test => 1})
+        service_result.should be_success
+        service_result.message.should eq ""
+        service_result[:test].should eq 1
+      end
+
+      context "when passing valid parameters" do
+        subject { Context.make(params).to_hash }
+
+        let(:params) { {test: 1} }
+        it { should eq({test: 1}) }
+
+        let(:params) { Context.make(test: 1) }
+        it { should eq({test: 1}) }
+      end
+
+      context "when passing invalid parameters" do
+        subject { lambda {Context.make(invalid_params)} }
+
+        let(:invalid_params) { nil }
+        it { should raise_error(NoMethodError) }
+
+        let(:invalid_params) { [] }
+        it { should raise_error(NoMethodError) }
+      end
+    end
+
+    describe "#to_hash" do
+      it "converts context into a hash" do
+        Context.make(test: 1).to_hash.should == {test: 1}
+        Context.make({}).to_hash.should == {}
+      end
     end
 
     context "when created" do
@@ -45,14 +76,14 @@ module LightService
     end
 
     it "lets setting a group of context values" do
-      subject.context_hash.should include(:test => 1)
-      subject.context_hash.keys.length.should == 1
+      subject.to_hash.should include(:test => 1)
+      subject.to_hash.keys.length.should == 1
 
       subject.add_to_context(:test => 1, :two => 2)
 
-      subject.context_hash.keys.length.should == 2
-      subject.context_hash.should include(:test => 1)
-      subject.context_hash.should include(:two => 2)
+      subject.to_hash.keys.length.should == 2
+      subject.to_hash.should include(:test => 1)
+      subject.to_hash.should include(:two => 2)
     end
   end
 

data/spec/organizer_spec.rb

@@ -31,17 +31,4 @@ describe LightService::Organizer do
       AnOrganizer.some_method(user)
     end
   end
-
-  context "when #with is called with Context" do
-    it "does not create a context" do
-      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(user)
-    end
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12.2
 description: A service skeleton with an emphasis on simplicity
 email:
 - adomokos@gmail.com
@@ -66,7 +82,7 @@ files:
 - resources/light-service.png
 - resources/organizer_and_actions.png
 - spec/acceptance/add_numbers_spec.rb
-- spec/action_base_spec.rb
+- spec/action_spec.rb
 - spec/context_spec.rb
 - spec/organizer_spec.rb
 - spec/sample/calculates_order_tax_action_spec.rb
@@ -90,12 +106,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -863764600829619710
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -863764600829619710
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -104,7 +126,7 @@ specification_version: 3
 summary: A service skeleton with an emphasis on simplicity
 test_files:
 - spec/acceptance/add_numbers_spec.rb
-- spec/action_base_spec.rb
+- spec/action_spec.rb
 - spec/context_spec.rb
 - spec/organizer_spec.rb
 - spec/sample/calculates_order_tax_action_spec.rb