response_state 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e0cea61825ed6f590a0b2510a4a6a0f368e4b93
-  data.tar.gz: d7e616a314b7073920d2be12b22724a4166f75cf
+  metadata.gz: 582d7c3101becc563d9c0696000bc50ab4d3646c
+  data.tar.gz: 67cb929a24c3261d6e3c1bc9adf5677d2ae5785e
 SHA512:
-  metadata.gz: d530ace92af0e4e98345fbacaf69cb02047dfe6c6f11a2352794796d14b25a55b2badd9cb36cf345c9328c7d58866eb51c8b1b1d37427a44f1e587c14d690944
-  data.tar.gz: 3cfc434592e2ab21ba32d25f5374cb1cbcaa604f9a8c73cae9597560fe9d7468f7633b3553d860c3ee56ab524050ca55112d871ffcab955128b943e1eef622e6
+  metadata.gz: 1bfae51a4b1628e3726a16217cb254abbe0cafcebb142f09920d0b8d2b3ddc8f2e9df2e3607ff22550137f735cf910454d7bc64693a06e3e4a6f80a96ec26939
+  data.tar.gz: 97eb8d8a09ea753479fb470ca659e50a64872f0a5b01e86c8749d2480f116cd921ea33ecdf686a67f7a5c2270698d6ddd59bec8ebd87d2cc8b060b1235b10a04

data/README.md

@@ -39,6 +39,21 @@ You must implement a `call` method.
 Your call method should yield with a `ResponseState::Response`.
 The response can be generated with a helper method `send_state` in your service class.
 
+You can optionally declare and restrict the set of valid states for your service's responses.
+The service will use this set of states when generating the response with the `send_state` method.
+
+```ruby
+class MyService < ResponseState::Service
+  response_states :success, :failure
+
+  def call(&block)
+    # do some work
+    yield send_state(:success)
+  end
+end
+```
+
+
 ### Response
 
 A `ResponseState::Response` can take up to 4 arguments but must at least have the first argument which is the state of the response. In addition it can take a message, a context, and a set of valid states. The message by convention should
@@ -89,6 +104,19 @@ MyService.('Some param') do |response|
 end
 ```
 
+If your service or the response itself restrict the response to a specific set
+of states, you can ensure all states have been handled by placing a call
+to `unhandled_states` at the end of your response block. This will yield an array of
+unhandled states to the given block if there are any unhandled states.
+
+```ruby
+MyService.('Some param') do |response|
+  response.success { puts 'I was successful.' }
+  response.failure { puts 'I failed.' }
+  response.unhandled_states { |states| raise "You didn't handle #{states.join(', ')}" }
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/response_state/response.rb

@@ -1,6 +1,6 @@
 module ResponseState
   class Response
-    attr_reader :state, :message, :context, :valid_states
+    attr_reader :state, :message, :context, :valid_states, :called_states
 
     def initialize(state, message=nil, context=nil, valid_states=nil)
       @valid_states = Array(valid_states || self.class.class_valid_states)
@@ -8,6 +8,7 @@ module ResponseState
       @state = state
       @context = context
       @message = message
+      @called_states = []
     end
 
     def self.valid_states(*args)
@@ -18,9 +19,21 @@ module ResponseState
       @class_valid_states
     end
 
+    def unhandled_states
+      return if valid_states.empty?
+      yield uncalled_states unless uncalled_states.empty?
+      nil
+    end
+
+    def uncalled_states
+      valid_states - called_states
+    end
+
     def method_missing(method, *args, &block)
-      if validate_state?(method)
+      if valid_state? method
+        called_states << method unless called_states.include? method
         yield if method == state
+        nil
       else
         super
       end
@@ -28,9 +41,9 @@ module ResponseState
 
     private
 
-    def validate_state?(call_state)
+    def valid_state?(call_state)
       return true if valid_states.empty?
-      return true if valid_states.include?(call_state)
+      return true if valid_states.include? call_state
       raise "Invalid state: #{call_state}"
     end
   end

data/lib/response_state/service.rb

@@ -1,6 +1,14 @@
 module ResponseState
   class Service
 
+    def self.response_states(*states)
+      @valid_states = Array(states)
+    end
+
+    def self.valid_states
+      @valid_states || []
+    end
+
     def self.call(*args, &block)
       self.new(*args).call(&block)
     end
@@ -10,6 +18,7 @@ module ResponseState
     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)
     end
   end

data/lib/response_state/version.rb

@@ -1,3 +1,3 @@
 module ResponseState
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/lib/response_state/response_spec.rb

@@ -48,7 +48,7 @@ module ResponseState
 
           context 'when initialized with an invalid state' do
             let(:state) { :foo }
-            
+
             it 'raises an exception' do
               expect { response }.to raise_exception('Invalid state of response: foo')
             end
@@ -79,7 +79,7 @@ module ResponseState
 
         context 'when initialized with an invalid state' do
           subject(:response) { Response.new(:foo) }
-          
+
           it 'raises an exception' do
             expect { response }.to raise_exception('Invalid state of response: foo')
           end
@@ -92,7 +92,30 @@ module ResponseState
             expect(response.valid_states).to eq [:success, :failure]
           end
         end
+
+        describe '#unhandled_states' do
+          subject(:response) { Response.new(:success) }
+
+          context 'when only one state is called' do
+            before { response.success {} }
+
+            it 'yields' do
+              expect { |b| response.unhandled_states(&b) }.to yield_with_args([:failure])
+            end
+          end
+
+          context 'when all states are called' do
+            before do
+              response.success {}
+              response.failure {}
+            end
+
+            it 'does not yield' do
+              expect { |b| response.unhandled_states(&b) }.not_to yield_control
+            end
+          end
+        end
       end
     end
   end
-end
+end

data/spec/lib/response_state/service_spec.rb

@@ -4,7 +4,10 @@ require 'ostruct'
 module ResponseState
   describe Service do
     subject(:service) { Service.new }
-    before { Response.instance_variable_set :@class_valid_states, nil }
+    before do
+      Response.instance_variable_set :@class_valid_states, nil
+      Service.instance_variable_set :@valid_states, nil
+    end
 
     describe '.call' do
       it 'news up an instance and passes the block on to #call' do
@@ -12,6 +15,19 @@ module ResponseState
       end
     end
 
+    describe '.response_states' do
+      it 'sets the valid response states' do
+        Service.response_states :success, :failure
+        expect(Service.valid_states).to eq [:success, :failure]
+      end
+    end
+
+    describe '.valid_states' do
+      it 'defaults to []' do
+        expect(Service.valid_states).to eq []
+      end
+    end
+
     describe '#call' do
       let(:yielded) { OpenStruct.new(response: nil) }
       let(:response) { yielded.response }
@@ -65,6 +81,14 @@ module ResponseState
         it 'has valid_states nil' do
           expect(response.valid_states).to eq []
         end
+
+        context 'and the service has valid states set' do
+          before { Service.response_states :success, :failure }
+
+          it 'has valid_states [:success, :failure]' do
+            expect(response.valid_states).to eq [:success, :failure]
+          end
+        end
       end
 
       context 'given :success, "a message"' do
@@ -108,4 +132,4 @@ module ResponseState
       end
     end
   end
-end
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: response_state
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - alexpeachey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Easy to use response state pattern
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,12 +98,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []