light-service 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18e898c817a11b13398d6e66dce89c0809ba98d3
-  data.tar.gz: f305ad48b609b5f52bab3ce769276bd5b13eeef6
+  metadata.gz: d6e076aae96c52a5762908422611819327dde2bc
+  data.tar.gz: 97f23597368c33f4e5fca9d829b286ae73db14d6
 SHA512:
-  metadata.gz: fb9721235e2c14b1af534487fb8060d08a1df789a539b178ea609d078e12196019278d1873afeed9d9bf4577341956133e7106254acfbe0186f5674c5d49c059
-  data.tar.gz: db7ac429e532fce47d5f82d507244d96d9d9ea630ad00cc4e27df20d6b0a664ef999f5c89ae8f8819712835b76a3bb27abb73818d4313ac66288fb4f28fba57b
+  metadata.gz: d6aeba0dd3f98960c6e5b13a878018afb5e7f2c6a50b0254dfcadf13b6045c649df51f29c07fd8b023c4f3d075551a6923d63919f3870c2cebc3ce2bf05067ed
+  data.tar.gz: f9cf3c1bff5df5411bee9240de31192d8a63f42175335905fd5c62d5e1b11d99daf7d824cdd1db8f69348982d17cda18a9a6db77fc3b2d3bbab9f5c73a694a09

data/README.md

@@ -97,7 +97,7 @@ class LooksUpTaxPercentageAction
 
   def self.object_is_nil?(object, context, message)
     if object.nil?
-      context.set_failure!(message)
+      context.fail!(message)
       return true
     end
 
@@ -189,9 +189,9 @@ Huge thanks to the [contributors](https://github.com/adomokos/light-service/grap
 
 ## Release Notes
 
-### 0.0.12
-* You can invoke the actions by passing in a [list of actions](https://github.com/adomokos/light-service/blob/c393995a6bc52f1f67535cd242e144350057431c/spec/organizer_spec.rb#L16) or an array of actions.
-* `Context#make` will not create a new Context if it's already a Context. Thanks to [@ramontayag](https://github.com/ramontayag) and [@padi](https://github.com/padi) for their commit.
+### 0.2.0
+* [Renaming](https://github.com/adomokos/light-service/commit/8d40ff7d393a157a8a558f9e4e021b8731550834) the `set_success!` and `set_failure!` methods to `succeed!` and `fail!`.
+* [Throwing](https://github.com/adomokos/light-service/commit/5ef315b8aeeafc99e38676adad3c11df5d93b0e3) an ArgumentError if the `make` method's argument is not Hash or LightService::Context.
 
 ## License
 

data/lib/light-service/context.rb

@@ -14,6 +14,10 @@ module LightService
     end
 
     def self.make(context={})
+      unless context.is_a? Hash or context.is_a? ::LightService::Context
+        raise ArgumentError, 'Argument must be Hash or LightService::Context'
+      end
+
       return context if context.is_a?(Context)
       self.new(context, ::LightService::Outcomes::SUCCESS, '')
     end
@@ -42,11 +46,21 @@ module LightService
     end
 
     def set_success!(message)
+      warn 'DEPRECATED: Please use `succeed!` instead'
+      succeed!(message)
+    end
+
+    def succeed!(message)
       @message = message
       @outcome = ::LightService::Outcomes::SUCCESS
     end
 
     def set_failure!(message)
+      warn 'DEPRECATED: Please use `fail!` instead'
+      fail!(message)
+    end
+
+    def fail!(message)
       @message = message
       @outcome = ::LightService::Outcomes::FAILURE
     end
@@ -55,5 +69,6 @@ module LightService
       @message = message
       @skip_all = true
     end
+
   end
 end

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/acceptance/add_numbers_spec.rb

@@ -3,13 +3,12 @@ require 'spec_helper'
 class Organizer
   include LightService::Organizer
 
-  def self.add_number(number)
-    with(number: number).reduce \
-      [
-        AddsOneAction,
-        AddsTwoAction,
-        AddsThreeAction
-      ]
+  def self.add_numbers(number)
+    with(:number => number).reduce(
+      AddsOneAction,
+      AddsTwoAction,
+      AddsThreeAction
+    )
   end
 end
 
@@ -48,7 +47,9 @@ end
 
 describe Organizer do
   it "Adds 1 2 3 and through to 1" do
-    result = Organizer.add_number 1
-    result.fetch(:number).should == 7
+    result = Organizer.add_numbers 1
+    number = result.fetch(:number)
+
+    expect(number).to eq(7)
   end
 end

data/spec/action_spec.rb

@@ -18,11 +18,11 @@ module LightService
       end
     end
 
-    let(:context) { ::LightService::Context.new }
+    let(:context) { ::LightService::Context.make }
 
     context "when the action context has failure" do
       it "returns immediately" do
-        context.set_failure!("an error")
+        context.fail!("an error")
 
         DummyAction.execute(context)
 

data/spec/context_spec.rb

@@ -2,109 +2,68 @@ require "spec_helper"
 
 module LightService
   describe Context do
-    subject { Context.new({:test => 1}, Outcomes::SUCCESS, "some_message") }
 
-    it "initializes the object with default arguments" do
-      service_result = Context.new({test: 1})
-
-      expect(service_result).to be_success
-      expect(service_result.message).to eq ''
-      expect(service_result[:test]).to eq 1
-    end
-
-    it "initializes the object with the context" do
-      service_result = Context.new.tap { |o| o.add_to_context({test: 1})}
-
-      expect(service_result).to be_success
-      expect(service_result.message).to eq ''
-      expect(service_result[:test]).to eq 1
-    end
-
-    describe ".make" do
-      it "initializes the object with make" do
-        service_result = Context.make({test: 1})
-
-        expect(service_result).to be_success
-        expect(service_result.message).to eq ""
-        expect(service_result[:test]).to 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}) }
+    describe "can be made" do
+      context "with no arguments" do
+        subject { Context.make }
+        it { should be_success }
+        its(:message) { should be_empty }
       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) }
+      context "with a hash" do
+        it "has the hash values" do
+          context = Context.make(:one => 1)
+          expect(context[:one]).to eq(1)
+        end
       end
 
-      context "data is a context" do
-        let(:original_context) { Context.new }
-
-        it "returns the same context object" do
-          new_context = Context.make(original_context)
-          expect(new_context.object_id).to eq(original_context.object_id)
+      context "with FAILURE" do
+        it "is failed" do
+          context = Context.new({}, ::LightService::Outcomes::FAILURE, '')
+          expect(context).to be_failure
         end
       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 == {}
+    describe "can't be made" do
+      specify "with invalid parameters" do
+        expect{Context.make([])}.to raise_error(ArgumentError)
       end
     end
 
-    context "when created" do
-      it { should be_success }
+    it "can be asked for success?" do
+      context = Context.new({}, ::LightService::Outcomes::SUCCESS)
+      expect(context.success?).to be_true
     end
 
-    it "allows to set success" do
-      subject.set_success!('the success')
-
-      expect(subject).to be_success
-      expect(subject).not_to be_failure
-      expect(subject.message) == 'the success'
+    it "can be asked for failure?" do
+      context = Context.new({}, ::LightService::Outcomes::FAILURE)
+      expect(context.failure?).to be_true
     end
 
-    it "allows to set failure" do
-      subject.set_failure!('the failure')
-
-      expect(subject).not_to be_success
-      expect(subject).to be_failure
-      expect(subject.message).to eq('the failure')
+    it "can be asked for skip_all?" do
+      context = Context.make
+      context.skip_all!
+      expect(context.skip_all?).to be_true
     end
 
-    it "allows to set skip_all" do
-      subject.skip_all!('the reason to skip')
-
-      expect(subject).to be_skip_all
-      expect(subject).to be_success
-      expect(subject).not_to be_failure
-      expect(subject.message).to eq('the reason to skip')
+    it "can be pushed into a SUCCESS state" do
+      context = Context.make
+      context.succeed!("a happy end")
+      expect(context).to be_success
     end
 
-    it "lets setting a group of context values" do
-      subject.to_hash.should include(test: 1)
-      subject.to_hash.keys.length.should == 1
-
-      subject.add_to_context(test: 1, two: 2)
+    it "can be pushed into a FAILURE state" do
+      context = Context.make
+      context.fail!("a sad end")
+      expect(context).to be_failure
+    end
 
-      expect(subject.to_hash.keys.length).to eq(2)
-      expect(subject.to_hash).to include(test: 1)
-      expect(subject.to_hash).to include(two: 2)
+    it "can set a flag to skip all subsequent actions" do
+      context = Context.make
+      context.skip_all!
+      expect(context).to be_skip_all
     end
-  end
 
+  end
 end

data/spec/organizer_spec.rb

@@ -7,18 +7,12 @@ describe LightService::Organizer do
   class AnOrganizer
     include LightService::Organizer
 
-    def self.some_method(user)
-      with(user: user).reduce([AnAction, AnotherAction])
+    def self.do_something(action_arguments)
+      with(action_arguments).reduce([AnAction, AnotherAction])
     end
 
-    def self.some_method_with(user)
-      context = LightService::Context.make(user: user)
-      with(context).reduce(AnAction, AnotherAction)
-    end
-
-    def self.some_method_with_no_actions(user)
-      context = LightService::Context.make(user: user)
-      with(context).reduce
+    def self.do_something_with_no_actions(action_arguments)
+      with(action_arguments).reduce
     end
   end
 
@@ -35,8 +29,8 @@ describe LightService::Organizer do
               .and_return context
     end
 
-    it "creates a Context" do
-      result = AnOrganizer.some_method(user)
+    it "implicitly creates a Context" do
+      result = AnOrganizer.do_something(:user => user)
       expect(result).to eq(context)
     end
   end
@@ -51,15 +45,15 @@ describe LightService::Organizer do
               .and_return context
     end
 
-    it "creates a Context" do
-      result = AnOrganizer.some_method_with(user)
+    it "uses that Context without recreating it" do
+      result = AnOrganizer.do_something(context)
       expect(result).to eq(context)
     end
   end
 
   context "when no Actions are specified" do
     it "throws a Runtime error" do
-      expect { AnOrganizer.some_method_with_no_actions(user) }.to \
+      expect { AnOrganizer.do_something_with_no_actions(context) }.to \
               raise_error RuntimeError, "No action(s) were provided"
     end
   end

data/spec/sample/tax/looks_up_tax_percentage_action.rb

@@ -17,7 +17,7 @@ class LooksUpTaxPercentageAction
 
   def self.object_is_nil?(object, context, message)
     if object.nil?
-      context.set_failure!(message)
+      context.fail!(message)
       return true
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec