substation 0.0.4 → 0.0.5

data/Changelog.md

@@ -1,3 +1,19 @@
+# v0.0.5 2013-05-17
+
+* [feature] Shorter action config when no observers are needed (snusnu)
+
+```ruby
+dispatcher = Substation::Dispatcher.coerce({
+  :some_use_case => App::SomeUseCase
+}, env)
+
+dispatcher = Substation::Dispatcher.coerce({
+  :some_use_case => Proc.new { |request| request.success(:data) }
+}, env)
+```
+
+[Compare v0.0.4..v0.0.5](https://github.com/snusnu/substation/compare/v0.0.4...v0.0.5)
+
 # v0.0.4 2013-05-15
 
 * [changed] Bump concord dependency to ~> 0.1.0 (snusnu)

data/README.md

@@ -200,6 +200,12 @@ be found in the next paragraph.
 An example configuration for an action without any observers:
 
 ```ruby
+# short form
+dispatcher = Substation::Dispatcher.coerce({
+  'some_use_case' => 'App::SomeUseCase'
+}, env)
+
+# long form
 dispatcher = Substation::Dispatcher.coerce({
   'some_use_case' => { 'action' => 'App::SomeUseCase' }
 }, env)
@@ -232,13 +238,19 @@ dispatcher = Substation::Dispatcher.coerce({
 
 The above configuration examples are tailored towards being read from a
 (yaml) config file and therefore accept strings as keys and values. It's
-also possible to use symbols as keys and values. Values correspond to
-action or observer "handlers" and can also be given as either constants
-or procs. In any case, handlers must respond to `call(object)`.
+also possible to use symbols as keys (and values). Values correspond to
+action or observer "handlers" and can also be given as either constants,
+symbols, or procs. In any case, handlers must respond to `call(object)`.
 
 An example configuration using symbol keys and constants for handlers:
 
 ```ruby
+# short form (without observers)
+dispatcher = Substation::Dispatcher.coerce({
+  :some_use_case => App::SomeUseCase
+}, env)
+
+# long form
 dispatcher = Substation::Dispatcher.coerce({
   :some_use_case => {
     :action   => App::SomeUseCase,
@@ -250,6 +262,11 @@ dispatcher = Substation::Dispatcher.coerce({
 An example configuration using symbol keys and procs for handlers:
 
 ```ruby
+# short form (without observers)
+dispatcher = Substation::Dispatcher.coerce({
+  :some_use_case => Proc.new { |request| request.success(:data) }
+}, env)
+
 dispatcher = Substation::Dispatcher.coerce({
   :some_use_case => {
     :action   => Proc.new { |request| request.success(:foo) },
@@ -258,7 +275,6 @@ dispatcher = Substation::Dispatcher.coerce({
 }, env)
 ```
 
-
 ## Application environments
 
 In order to provide your actions with objects typically needed during

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 6
-total_score: 61
+total_score: 62

data/config/reek.yml

@@ -62,6 +62,7 @@ TooManyStatements:
   exclude:
   - Substation::Utils#self.const_get
   - Substation::Utils#self.symbolize_keys
+  - Substation::Dispatcher::Action#self.coerce
   max_statements: 3
 UncommunicativeMethodName:
   enabled: true

data/lib/substation/dispatcher.rb

@@ -15,8 +15,8 @@ module Substation
 
       # Coerce the given +name+ and +config+ to an {Action} instance
       #
-      # @param [Hash<Symbol, Object>] config
-      #   the configuration hash
+      # @param [#call, Hash<Symbol, Object>] config
+      #   the action configuration object
       #
       # @return [Action]
       #   the coerced instance
@@ -29,10 +29,17 @@ module Substation
       #
       # @api private
       def self.coerce(config)
-        handler  = config.fetch(:action) { raise(MissingHandlerError) }
-        observer = Observer.coerce(config[:observer])
+        if config.respond_to?(:fetch)
+          action   = config.fetch(:action) { raise(MissingHandlerError) }
+          observer = config[:observer]
+        else
+          action = config
+        end
 
-        new(Utils.coerce_callable(handler), observer)
+        action_handler   = Utils.coerce_callable(action)
+        observer_handler = Observer.coerce(observer)
+
+        new(action_handler, observer_handler)
       end
 
       include Concord.new(:handler, :observer)
@@ -81,12 +88,36 @@ module Substation
     #         # do something
     #       end
     #     end
+    #
+    #     class AnotherObserver
+    #       def self.call(response)
+    #         # do something
+    #       end
+    #     end
     #   end
     #
     #   storage = SomeStorageAbstraction.new
     #   env     = App::Environment.new(storage, Logger.new($stdout))
     #
-    # @example without observers
+    # @example without observers (short form, symbol keys)
+    #
+    #   dispatcher = Substation::Dispatcher.coerce({
+    #     :some_use_case => App::SomeUseCase
+    #   }, env)
+    #
+    #   dispatcher = Substation::Dispatcher.coerce({
+    #     :some_use_case => 'App::SomeUseCase'
+    #   }, env)
+    #
+    #   dispatcher = Substation::Dispatcher.coerce({
+    #     :some_use_case => :App::SomeUseCase
+    #   }, env)
+    #
+    #   dispatcher = Substation::Dispatcher.coerce({
+    #     :some_use_case => Proc.new { |request| request.success(:data) }
+    #   }, env)
+    #
+    # @example without observers (long form, string keys)
     #
     #   dispatcher = Substation::Dispatcher.coerce({
     #     'some_use_case' => { 'action' => 'SomeUseCase' }
@@ -96,8 +127,8 @@ module Substation
     #
     #   dispatcher = Substation::Dispatcher.coerce({
     #     'some_use_case' => {
-    #       'action' => 'SomeUseCase',
-    #       'observer' => 'SomeObserver'
+    #       'action' => 'App::SomeUseCase',
+    #       'observer' => 'App::SomeObserver'
     #     }
     #   }, env)
     #
@@ -105,10 +136,10 @@ module Substation
     #
     #   dispatcher = Substation::Dispatcher.coerce({
     #     'some_use_case' => {
-    #       'action' => 'SomeUseCase',
+    #       'action' => 'App::SomeUseCase',
     #       'observer' => [
-    #         'SomeObserver',
-    #         'AnotherObserver'
+    #         'App::SomeObserver',
+    #         'App::AnotherObserver'
     #       ]
     #     }
     #   }, env)
@@ -167,8 +198,8 @@ module Substation
     #
     # @api private
     def self.normalize_config(config)
-      Utils.symbolize_keys(config).each_with_object({}) { |(name, hash), actions|
-        actions[name] = Action.coerce(hash)
+      Utils.symbolize_keys(config).each_with_object({}) { |(name, action), actions|
+        actions[name] = Action.coerce(action)
       }
     end
 

data/lib/substation/version.rb

@@ -1,4 +1,4 @@
 module Substation
   # Gem version
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.0.5'.freeze
 end

data/spec/unit/substation/dispatcher/action/class_methods/coerce_spec.rb

@@ -9,38 +9,53 @@ describe Dispatcher::Action, '.coerce' do
   let(:action)  { Spec::Action::Success }
   let(:coerced) { Dispatcher::Action.new(action, observer) }
 
-  context "when coercion is possible" do
+  context "when config is a hash" do
+    context "and coercion is possible" do
 
-    let(:config) {{
-        :action   => action,
-        :observer => observer_value
-    }}
+      let(:config) {{
+          :action   => action,
+          :observer => observer_value
+      }}
 
-    before do
-      Observer.should_receive(:coerce).with(observer_value).and_return(observer)
-      Utils.should_receive(:coerce_callable).with(action).and_return(action)
-    end
+      before do
+        Observer.should_receive(:coerce).with(observer_value).and_return(observer)
+        Utils.should_receive(:coerce_callable).with(action).and_return(action)
+      end
+
+      context 'with an action and an observer' do
+        let(:observer_value) { observer }
+        let(:observer)       { Spec::Observer }
+
+        it { should eql(coerced) }
+      end
 
-    context 'with an action and an observer' do
-      let(:observer_value) { observer }
-      let(:observer)       { Spec::Observer }
+      context 'with an action and no observer' do
+        let(:observer_value) { nil }
+        let(:observer)       { Observer::NULL }
 
-      it { should eql(coerced) }
+        it { should eql(coerced) }
+      end
     end
 
-    context 'with an action and no observer' do
-      let(:observer_value) { nil }
-      let(:observer)       { Observer::NULL }
+    context 'with no action' do
+      let(:config) { {} }
 
-      it { should eql(coerced) }
+      specify {
+        expect { subject }.to raise_error(described_class::MissingHandlerError)
+      }
     end
   end
 
-  context 'with no action' do
-    let(:config) { {} }
+  context "when config is no hash" do
+    let(:config)         { action }
+    let(:observer_value) { nil }
+    let(:observer)       { Observer::NULL }
+
+    before do
+      Observer.should_receive(:coerce).with(observer_value).and_return(observer)
+      Utils.should_receive(:coerce_callable).with(config).and_return(action)
+    end
 
-    specify {
-      expect { subject }.to raise_error(described_class::MissingHandlerError)
-    }
+    it { should eql(coerced) }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: substation
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adamantium