light-service 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713b37be5e541d42ebed24537f656289ed6d5ab6
-  data.tar.gz: dbf4a703cbfa397562d59a1f61ca8c08136a7111
+  metadata.gz: 5dbadd45523f6245d302d195937328fe1819f9b7
+  data.tar.gz: fa3836bd03de541b3d24cc38e9a13800b3c35381
 SHA512:
-  metadata.gz: 5040578df5d4f0bbce8f530a31f67fe1baacdd12658d3c20b4e936dc0f53511efe666858a491134d604ed246ff76d119c09cebfbbf802bb4ce95aeaad69dff0f
-  data.tar.gz: aa4adc93839de21f98b0e275da0d28e0dfbc5fe1f1114ac2bdb14b267bbff6208a19754357ed5c713861cba542229ad0ce0ac9033469b5f41c14ee887f49bdfe
+  metadata.gz: c8356b2a0cd6a0ea403f470352c6c686473340752ac6d35f7bd87893e06167032b51177c4ca4d261da819e4609106034838fbbd0a56d5ec5bddaf8731639959c
+  data.tar.gz: 23696cd73809aaa2ddd2e76c5d2f3d3fb3b2e34640210c830b2404b4132fad2badc816531e54322a3b7d673b1767586e10d0f331ef7d1e0a2bc218ef1c1c3b2a

data/.travis.yml

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

data/README.md

@@ -200,6 +200,43 @@ end
 
 Take a look at [this spec](spec/action_expects_and_promises_spec.rb) to see the refactoring in action.
 
+## Error Codes
+
+You can do a more structured error handling by using error codes in the context.
+If something goes wrong in your actions, you can fail the process by setting the context to failure:
+
+```ruby
+class FooAction
+  include LightService::Action
+
+  executed do |context|
+    context.fail!("I don't like what happened here.")
+  end
+end
+```
+
+However, you might need to handle the errors coming from your action pipeline differently.
+Using an error code can help you check what type of expected error occurred from the organizer 
+or action invocation point.
+
+```ruby
+class FooAction
+  include LightService::Action
+
+  executed do |context|
+    unless (service_call.success?)
+      context.fail!("Service call failed", 1001)
+    end
+
+    # Do something else
+
+    unless (entity.save)
+      context.fail!("Saving the entity failed", 2001)
+    end
+  end
+end
+```
+
 ## Requirements
 
 This gem requires ruby 1.9.x
@@ -236,6 +273,9 @@ For further examples, please visit the project's [Wiki](https://github.com/adomo
 Huge thanks to the [contributors](https://github.com/adomokos/light-service/graphs/contributors)!
 
 ## Release Notes
+### 0.3.1
+* Adding [error codes](https://github.com/adomokos/light-service#error-codes) to the context
+
 ### 0.3.0
 * Adding the `expects` and `promises` macros - Read more about it in [this blog post](http://www.adomokos.com/2014/05/expects-and-promises-in-lightservice.html)
 

data/lib/light-service/context.rb

@@ -5,10 +5,10 @@ module LightService
   end
 
   class Context < Hash
-    attr_accessor :outcome, :message
+    attr_accessor :outcome, :message, :error_code
 
-    def initialize(context={}, outcome=::LightService::Outcomes::SUCCESS, message='')
-      @outcome, @message = outcome, message
+    def initialize(context={}, outcome=::LightService::Outcomes::SUCCESS, message='', error_code=nil)
+      @outcome, @message, @error_code = outcome, message, error_code
       context.to_hash.each {|k,v| self[k] = v}
       self
     end
@@ -19,7 +19,7 @@ module LightService
       end
 
       return context if context.is_a?(Context)
-      self.new(context, ::LightService::Outcomes::SUCCESS, '')
+      self.new(context)
     end
 
     def add_to_context(values)
@@ -60,8 +60,13 @@ module LightService
       fail!(message)
     end
 
-    def fail!(message=nil)
-      @message = message
+    def fail!(options=nil)
+      if options.is_a? Hash
+        @message = options[:message]
+        @error_code = options[:error_code]
+      else
+        @message = options
+      end
       @outcome = ::LightService::Outcomes::FAILURE
     end
 

data/lib/light-service/context_key_verifier.rb

@@ -30,7 +30,7 @@ module LightService
       end
 
       def format_keys(keys)
-        keys.map{|k| ":#{k}"}.join(', ')
+        keys.map { |k| ":#{k}"}.join(', ')
       end
     end
   end

data/lib/light-service/version.rb

@@ -1,3 +1,3 @@
 module LightService
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/context_spec.rb

@@ -13,6 +13,7 @@ module LightService
       context "with a hash" do
         it "has the hash values" do
           context = Context.make(:one => 1)
+
           expect(context[:one]).to eq(1)
         end
       end
@@ -20,6 +21,7 @@ module LightService
       context "with FAILURE" do
         it "is failed" do
           context = Context.new({}, ::LightService::Outcomes::FAILURE, '')
+
           expect(context).to be_failure
         end
       end
@@ -33,49 +35,73 @@ module LightService
 
     it "can be asked for success?" do
       context = Context.new({}, ::LightService::Outcomes::SUCCESS)
-      expect(context.success?).to be_true
+
+      expect(context).to be_success
     end
 
     it "can be asked for failure?" do
       context = Context.new({}, ::LightService::Outcomes::FAILURE)
-      expect(context.failure?).to be_true
+
+      expect(context).to be_failure
     end
 
     it "can be asked for skip_all?" do
       context = Context.make
       context.skip_all!
+
       expect(context.skip_all?).to be_true
     end
 
     it "can be pushed into a SUCCESS state" do
       context = Context.make
       context.succeed!("a happy end")
+
       expect(context).to be_success
     end
 
     it "can be pushed into a SUCCESS state without a message" do
       context = Context.make
       context.succeed!
+
       expect(context).to be_success
       expect(context.message).to be_nil
     end
 
-    it "can be pushed into a FAILURE state" do
+    it "can be pushed into a FAILURE state without a message" do
+      context = Context.make
+      context.fail!
+
+      expect(context).to be_failure
+      expect(context.message).to be_nil
+    end
+
+    it "can be pushed into a FAILURE state with a message" do
       context = Context.make
       context.fail!("a sad end")
+
       expect(context).to be_failure
     end
 
-    it "can be pushed into a FAILURE state without a message" do
+    it "can be pushed into a FAILURE state with a message in an options hash" do
       context = Context.make
-      context.fail!
+      context.fail!(:message => "a sad end")
+
       expect(context).to be_failure
-      expect(context.message).to be_nil
+      expect(context.error_code).to be_nil
+    end
+
+    it "can be pushed into a FAILURE state with an error code in an options hash" do
+      context = Context.make
+      context.fail!(:error_code => 10005)
+
+      expect(context).to be_failure
+      expect(context.error_code).to eq(10005)
     end
 
     it "can set a flag to skip all subsequent actions" do
       context = Context.make
       context.skip_all!
+
       expect(context).to be_skip_all
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-service
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Attila Domokos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-15 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec