light-service 0.0.7

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle
+bin

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.2"
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in light_service.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Attila Domokos
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,173 @@
+![Light Service](https://raw.github.com/adomokos/light-service/master/light-service.png)
+
+[![Build Status](https://secure.travis-ci.org/adomokos/light-service.png)](http://travis-ci.org/adomokos/light-service)
+
+What do you think of this code?
+
+```ruby
+class TaxController < ApplicationContoller
+  def update
+    @order = Order.find(params[:id])
+    tax_ranges = TaxRange.for_region(order.region)
+
+    if tax_ranges.nil?
+      render :action => :edit, :error => "The tax ranges were not found"
+      return # Avoiding the double render error
+    end
+
+    tax_percentage = tax_ranges.for_total(@order.total)
+
+    if tax_percentage.nil?
+      render :action => :edit, :error => "The tax percentage  was not found"
+      return # Avoiding the double render error
+    end
+
+    @order.tax = (@order.total * (tax_percentage/100)).round(2)
+
+    if @order.total_with_tax > 200
+      @order.provide_free_shipping!
+    end
+
+    redirect_to checkout_shipping_path(@order), :notice => "Tax was calculated successfully"
+  end
+end
+```
+
+This controller violates [SRP](http://en.wikipedia.org/wiki/Single_responsibility_principle) all over.
+Also, imagine what it takes 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.
+
+This controller does 3 things in order:
+* Looks up the tax percentage based on order total
+* Calculates the order tax
+* Provides free shipping if the total with tax is greater than $200
+
+The order of these tasks matters: you can't calculate the order tax without the percentage.
+Wouldn't it be nice to see this instead?
+
+```ruby
+[
+  LooksUpTaxPercentage,
+  CalculatesOrderTax,
+  ChecksFreeShipping
+]
+```
+
+This block of code should tell you the "story" of what's going on in this workflow.
+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.
+
+```ruby
+class CalculatesTax
+  def self.for_order(order)
+    context = LightService::Context.make(:order => order)
+
+    [
+      LooksUpTaxPercentageAction,
+      CalculatesOrderTaxAction,
+      ProvidesFreeShippingAction
+    ].each{ |action| action.execute(context) }
+
+    context
+  end
+end
+
+class LooksUpTaxPercentageAction
+  include LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+    tax_ranges = TaxRange.for_region(order.region)
+
+    next context if object_is_nil?(tax_ranges, context, 'The tax ranges were not found')
+
+    order = context.fetch(:order)
+    tax_percentage = tax_ranges.for_total(order.total)
+
+    next context if object_is_nil?(tax_percentage, context, 'The tax percentage was not found')
+
+    context[:tax_percentage] = tax_percentage
+  end
+
+  def self.object_is_nil?(object, context, message)
+    if object.nil?
+      context.set_failure!(message)
+      return true
+    end
+
+    false
+  end
+
+end
+
+class CalculatesOrderTaxAction
+  include ::LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+    tax_percentage = context.fetch(:tax_percentage)
+
+    order.tax = (order.total * (tax_percentage/100)).round(2)
+  end
+
+end
+
+class ProvidesFreeShippingAction
+  include LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+
+    if order.total_with_tax > 200
+      order.provide_free_shipping!
+    end
+  end
+end
+```
+
+And with all that, your controller should be super simple:
+
+```ruby
+class TaxController < ApplicationContoller
+  def update
+    @order = Order.find(params[:id])
+
+    service_result = CalculatesTax.for_order(@order)
+
+    if service_result.failure?
+      render :action => :edit, :error => service_result.message
+    else
+      redirect_to checkout_shipping_path(@order), :notice => "Tax was calculated successfully"
+    end
+
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'light_service'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ 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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/light-service/action.rb

@@ -0,0 +1,21 @@
+module LightService
+  module Action
+
+    def self.included(base_class)
+      base_class.extend Macros
+    end
+
+    module Macros
+      def executed
+        define_singleton_method "execute" do |context|
+          return context if context.failure?
+
+          yield(context)
+
+          context
+        end
+      end
+    end
+
+  end
+end

data/lib/light-service/context.rb

@@ -0,0 +1,58 @@
+module LightService
+  module Outcomes
+    SUCCESS = 0
+    FAILURE = 1
+  end
+
+  class Context
+    attr_accessor :outcome, :message
+
+    def initialize(outcome=::LightService::Outcomes::SUCCESS, message='', context={})
+      @outcome, @message, @context = outcome, message, context
+    end
+
+    def self.make(context={})
+      Context.new(::LightService::Outcomes::SUCCESS, '', context)
+    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)
+    end
+
+    # It's really there for testing and debugging
+    def context_hash
+      @context.dup
+    end
+
+    def success?
+      @outcome == ::LightService::Outcomes::SUCCESS
+    end
+
+    def failure?
+      success? == false
+    end
+
+    def set_success!(message)
+      @message = message
+      @outcome = ::LightService::Outcomes::SUCCESS
+    end
+
+    def set_failure!(message)
+      @message = message
+      @outcome = ::LightService::Outcomes::FAILURE
+    end
+
+  end
+end

data/lib/light-service/version.rb

@@ -0,0 +1,3 @@
+module LightService
+  VERSION = "0.0.7"
+end

data/lib/light-service.rb

@@ -0,0 +1,4 @@
+require "light-service/version"
+
+require 'light-service/context'
+require 'light-service/action'

data/light-service.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/light-service/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Attila Domokos"]
+  gem.email         = ["adomokos@gmail.com"]
+  gem.description   = %q{A service skeleton with an emphasis on simplicity}
+  gem.summary       = %q{A service skeleton with an emphasis on simplicity}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "light-service"
+  gem.require_paths = ["lib"]
+  gem.version       = LightService::VERSION
+
+  gem.add_development_dependency("rspec", "~> 2.0")
+  gem.add_development_dependency("simplecov", "~> 0.7.1")
+end

data/spec/acceptance/calculates_order_tax_action_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require_relative 'sample/calculates_order_tax_action'
+
+describe CalculatesOrderTaxAction do
+  let(:order) { double('order') }
+  let(:context) do
+    data = { :order => order, :tax_percentage => 7.2 }
+    ::LightService::Context.make(data)
+  end
+
+  it "calculates the tax based on the tax percentage" do
+    order.stub(:total => 100)
+    order.should_receive(:tax=).with 7.2
+    CalculatesOrderTaxAction.execute(context)
+  end
+end

data/spec/acceptance/calculates_tax_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require_relative 'sample/calculates_tax'
+require_relative 'sample/looks_up_tax_percentage_action'
+require_relative 'sample/calculates_order_tax_action'
+require_relative 'sample/provides_free_shipping_action'
+
+describe CalculatesTax do
+  let(:order) { double('order') }
+  let(:context) { double('context') }
+
+  it "calls the actions in order" do
+    ::LightService::Context.stub(:make) \
+                            .with(:order => order) \
+                            .and_return context
+
+    LooksUpTaxPercentageAction.stub(:execute).with(context)
+    CalculatesOrderTaxAction.stub(:execute).with(context)
+    ProvidesFreeShippingAction.stub(:execute).with(context)
+
+    result = CalculatesTax.for_order(order)
+    result.should eq context
+  end
+end

data/spec/acceptance/looks_up_tax_percentage_action.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require_relative 'sample/looks_up_tax_percentage_action'
+
+class TaxRange; end
+
+describe LooksUpTaxPercentageAction do
+  let(:region) { double('region') }
+  let(:order) do
+    order = double('order')
+    order.stub(:region => region)
+    order.stub(:total => 200)
+    order
+  end
+  let(:context) do
+    ::LightService::Context.make(:order => order)
+  end
+  let(:tax_percentage) { double('tax_percentage') }
+  let(:tax_ranges) { double('tax_ranges') }
+
+  context "when the tax_ranges were not found" do
+    it "sets the context to failure" do
+      TaxRange.stub(:for_region).with(region).and_return nil
+      LooksUpTaxPercentageAction.execute(context)
+
+      context.should be_failure
+      context.message.should eq "The tax ranges were not found"
+    end
+  end
+
+  context "when the tax_percentage is not found" do
+    it "sets the context to failure" do
+      TaxRange.stub(:for_region).with(region).and_return tax_ranges
+      tax_ranges.stub(:for_total => nil)
+
+      LooksUpTaxPercentageAction.execute(context)
+
+      context.should be_failure
+      context.message.should eq "The tax percentage was not found"
+    end
+  end
+
+  context "when the tax_percentage is found" do
+    it "sets the tax_percentage in context" do
+      TaxRange.stub(:for_region).with(region).and_return tax_ranges
+      tax_ranges.stub(:for_total => 25)
+
+      LooksUpTaxPercentageAction.execute(context)
+
+      context.should be_success
+      context.fetch(:tax_percentage).should eq 25
+    end
+  end
+end

data/spec/acceptance/provides_free_shipping_action_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require_relative 'sample/provides_free_shipping_action'
+
+describe ProvidesFreeShippingAction do
+  let(:order) { double('order') }
+  let(:context) do
+    data = { :order => order }
+    ::LightService::Context.make(data)
+  end
+
+  context "when the order total with tax is > 200" do
+    specify "order gets free shipping" do
+      order.stub(:total_with_tax => 201)
+      order.should_receive(:provide_free_shipping!)
+
+      ProvidesFreeShippingAction.execute(context)
+    end
+  end
+
+  context "when the order total with tax is <= 200" do
+    specify "order gets free shipping" do
+      order.stub(:total_with_tax => 200)
+      order.should_not_receive(:provide_free_shipping!)
+
+      ProvidesFreeShippingAction.execute(context)
+    end
+  end
+
+end

data/spec/acceptance/sample/calculates_order_tax_action.rb

@@ -0,0 +1,11 @@
+class CalculatesOrderTaxAction
+  include ::LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+    tax_percentage = context.fetch(:tax_percentage)
+
+    order.tax = (order.total * (tax_percentage/100)).round(2)
+  end
+
+end

data/spec/acceptance/sample/calculates_tax.rb

@@ -0,0 +1,13 @@
+class CalculatesTax
+  def self.for_order(order)
+    context = ::LightService::Context.make(:order => order)
+
+    [
+      LooksUpTaxPercentageAction,
+      CalculatesOrderTaxAction,
+      ProvidesFreeShippingAction
+    ].each{ |action| action.execute(context) }
+
+    context
+  end
+end

data/spec/acceptance/sample/looks_up_tax_percentage_action.rb

@@ -0,0 +1,27 @@
+class LooksUpTaxPercentageAction
+  include LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+    tax_ranges = TaxRange.for_region(order.region)
+
+    next context if object_is_nil?(tax_ranges, context, 'The tax ranges were not found')
+
+    order = context.fetch(:order)
+    tax_percentage = tax_ranges.for_total(order.total)
+
+    next context if object_is_nil?(tax_percentage, context, 'The tax percentage was not found')
+
+    context[:tax_percentage] = tax_percentage
+  end
+
+  def self.object_is_nil?(object, context, message)
+    if object.nil?
+      context.set_failure!(message)
+      return true
+    end
+
+    false
+  end
+
+end

data/spec/acceptance/sample/provides_free_shipping_action.rb

@@ -0,0 +1,12 @@
+class ProvidesFreeShippingAction
+  include LightService::Action
+
+  executed do |context|
+    order = context.fetch(:order)
+
+    if order.total_with_tax > 200
+      order.provide_free_shipping!
+    end
+  end
+
+end

data/spec/action_base_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+module LightService
+  describe Action do
+    class DummyAction
+      include LightService::Action
+
+      executed do |context|
+        context[:test_key] = "test_value"
+      end
+    end
+
+    let(:context) { ::LightService::Context.new }
+
+    context "when the action context has failure" do
+      it "returns immediately" do
+        context.set_failure!("an error")
+
+        DummyAction.execute(context)
+
+        context.context_hash.keys.should be_empty
+      end
+    end
+
+    context "when the action context does not have failure" do
+      it "executes the block" do
+        DummyAction.execute(context)
+
+        context.context_hash.keys.should eq [:test_key]
+      end
+    end
+
+    it "returns the context" do
+      result = DummyAction.execute(context)
+
+      result.context_hash.should eq ({:test_key => "test_value"})
+    end
+  end
+end

data/spec/context_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+module LightService
+  describe Context do
+    subject { Context.new(Outcomes::SUCCESS, "some_message", {:test => 1}) }
+
+    it "initializes the object with default arguments" do
+      service_result = Context.new
+      service_result.should be_success
+    end
+
+    it "initializes the object with the context" do
+      service_result = Context.new.tap { |o| o.add_to_context({:test => 1})}
+      service_result.should be_success
+      service_result.message.should eq ""
+      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
+    end
+
+    context "when created" do
+      it { should be_success }
+    end
+
+    it "allows to set success" do
+      subject.set_success!("the success")
+      subject.should be_success
+      subject.message.should == "the success"
+    end
+
+    specify "evaluates failure?" do
+      subject.set_success!("the success")
+      subject.should_not be_failure
+    end
+
+    it "allows to set failure" do
+      subject.set_failure!("the failure")
+      subject.should_not be_success
+      subject.message.should == "the failure"
+    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.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)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'light-service'
+require 'ostruct'

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: light-service
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+  prerelease: 
+platform: ruby
+authors:
+- Attila Domokos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+description: A service skeleton with an emphasis on simplicity
+email:
+- adomokos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/light-service.rb
+- lib/light-service/action.rb
+- lib/light-service/context.rb
+- lib/light-service/version.rb
+- light-service.gemspec
+- light-service.png
+- spec/acceptance/calculates_order_tax_action_spec.rb
+- spec/acceptance/calculates_tax_spec.rb
+- spec/acceptance/looks_up_tax_percentage_action.rb
+- spec/acceptance/provides_free_shipping_action_spec.rb
+- spec/acceptance/sample/calculates_order_tax_action.rb
+- spec/acceptance/sample/calculates_tax.rb
+- spec/acceptance/sample/looks_up_tax_percentage_action.rb
+- spec/acceptance/sample/provides_free_shipping_action.rb
+- spec/action_base_spec.rb
+- spec/context_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A service skeleton with an emphasis on simplicity
+test_files:
+- spec/acceptance/calculates_order_tax_action_spec.rb
+- spec/acceptance/calculates_tax_spec.rb
+- spec/acceptance/looks_up_tax_percentage_action.rb
+- spec/acceptance/provides_free_shipping_action_spec.rb
+- spec/acceptance/sample/calculates_order_tax_action.rb
+- spec/acceptance/sample/calculates_tax.rb
+- spec/acceptance/sample/looks_up_tax_percentage_action.rb
+- spec/acceptance/sample/provides_free_shipping_action.rb
+- spec/action_base_spec.rb
+- spec/context_spec.rb
+- spec/spec_helper.rb