response_state 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49640a1d8e13c04e6904e1672de5233b74e10577
-  data.tar.gz: 5ecc66ed44412cedb76b30afc5b8021d1d2ef96d
+  metadata.gz: bf386174f6638df5e17ded37f76a1cef1cf87eec
+  data.tar.gz: 76903168615aafedf6697076a572478c2dc447eb
 SHA512:
-  metadata.gz: 5104ca4e50e10cf325155e4c6e5108f353a8dd91a7a2dfd0e7775b7054def88814ec3b9dd27dac8fbdbeef61a2fdb6392fa1b01d0bb58a47f8adab96b8892bab
-  data.tar.gz: dfcc5f13dd9c9b6d8fa60ce39363d2a4f7fece15c17888ea2bcdca0f9158dcda349e2786e4e473a3405ed276003240d69bb26069fd93f87438696d5ed6c6a4f5
+  metadata.gz: d5cc91bc3692bc86448069d4e888be54d6b2452a8cbcadaa7706430d9d2b9dbdecfc060aedc910bf18e0b6021937b392ebd29ce1d51c50c1f7863b7e2291c217
+  data.tar.gz: d884192fe765cd69f93ac6583027d1afa65a77b75e48273dc2fba90be77d2f109fe71019a0c333a2a9a7200d686297d2fb70531c976e1451709c164d5db690c1

data/README.md

@@ -24,8 +24,6 @@ Create a service class and subclass ResponseState::Service.
 
 ```ruby
 class MyService < ResponseState::Service
-  response_states :success, :failure
-
   def initialize(param)
     @param = param
   end
@@ -37,8 +35,7 @@ class MyService < ResponseState::Service
 end
 ```
 
-You must implement a `call` method. You must also indicated the valid response states
-using the `response_states` class macro method.
+You must implement a `call` method.
 
 Your call method should yield with a call to `send_state` which will create a `ResponseState::Response`.
 
@@ -47,6 +44,16 @@ take a message and a context. The message by convention should be a string but t
 The context can be any object. An error will be raised if a state is specified that is not in the list
 of valid response states.
 
+The valid response states default to `[:success, :failure]`.
+You can override the valid response states for a class using the `response_states` class macro method.
+
+```ruby
+class MyOtherService < ResponseState::Service
+  response_states :done, :error
+  # ...
+end
+```
+
 ### Your service API
 
 Your service can now be used as such:

data/lib/response_state/service.rb

@@ -6,7 +6,7 @@ module ResponseState
     end
 
     def self.valid_states
-      @valid_states || []
+      @valid_states || [:success, :failure]
     end
 
     def self.call(*args, &block)
@@ -17,9 +17,8 @@ module ResponseState
       fail NotImplementedError, "A ResponseState::Service should implement the call method.\nThe call method should perform the relevant work of the service and yield a ResponseState::Response object.\n"
     end
 
-    def send_state(state, message=nil, context=nil, valid_states=nil)
-      valid_states ||= self.class.valid_states
-      ResponseState::Response.new(state, message, context, valid_states)
+    def send_state(state, message=nil, context=nil)
+      ResponseState::Response.new(state, message, context, self.class.valid_states)
     end
   end
 end

data/lib/response_state/version.rb

@@ -1,3 +1,3 @@
 module ResponseState
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/features/full_example_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 require 'ostruct'
 
 class MyService < ResponseState::Service
-  response_states :success, :failure
   attr_reader :object, :pass
 
   def initialize(object, pass)

data/spec/lib/response_state/service_spec.rb

@@ -15,16 +15,16 @@ module ResponseState
       end
     end
 
-    describe '.response_states' do
-      it 'sets the valid response states' do
-        Service.response_states :success, :failure
+    describe '.valid_states' do
+      it 'defaults to [:success, :failure]' do
         expect(Service.valid_states).to eq [:success, :failure]
       end
     end
 
-    describe '.valid_states' do
-      it 'defaults to []' do
-        expect(Service.valid_states).to eq []
+    describe '.response_states' do
+      it 'sets the valid response states' do
+        Service.response_states :success, :error
+        expect(Service.valid_states).to eq [:success, :error]
       end
     end
 
@@ -35,29 +35,8 @@ module ResponseState
     end
 
     describe '#send_state' do
-      context 'given :success, "a message", {}, [:success, :failure]' do
-        let(:response) { service.send_state(:success, 'a message', {}, [:success, :failure]) }
-
-        it 'has a success state' do
-          expect(response.state).to eq :success
-        end
-
-        it 'has the message "a message"' do
-          expect(response.message).to eq 'a message'
-        end
-
-        it 'has the context {}' do
-          expect(response.context).to eq Hash.new
-        end
-
-        it 'has valid_states [:success, :failure]' do
-          expect(response.valid_states).to eq [:success, :failure]
-        end
-      end
-
       context 'given :success, "a message", {}' do
         let(:response) { service.send_state(:success, 'a message', {}) }
-        before { Service.response_states :success, :failure }
 
         it 'has a success state' do
           expect(response.state).to eq :success
@@ -78,7 +57,6 @@ module ResponseState
 
       context 'given :success, "a message"' do
         let(:response) { service.send_state(:success, 'a message') }
-        before { Service.response_states :success, :failure }
 
         it 'has a success state' do
           expect(response.state).to eq :success
@@ -99,7 +77,6 @@ module ResponseState
 
       context 'given :success' do
         let(:response) { service.send_state(:success) }
-        before { Service.response_states :success, :failure }
 
         it 'has a success state' do
           expect(response.state).to eq :success

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: response_state
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler