substation 0.0.3 → 0.0.4

data/Changelog.md

@@ -1,3 +1,11 @@
+# v0.0.4 2013-05-15
+
+* [changed] Bump concord dependency to ~> 0.1.0 (snusnu)
+
+  * concord generated attribute readers are now `protected` by default
+
+[Compare v0.0.3..v0.0.4](https://github.com/snusnu/substation/compare/v0.0.3...v0.0.4)
+
 # v0.0.3 2013-05-15
 
 * [changed] Stop (deep) freezing objects coming from client code (snusnu)

data/lib/substation/dispatcher.rb

@@ -201,7 +201,7 @@ module Substation
     #   config     = { :some_use_case => { :action => App::SomeUseCase } }
     #   dispatcher = Substation::Dispatcher.coerce(config, env)
     #
-    #   response = dispatcher.call(:some_use_case, :some_input, env)
+    #   response = dispatcher.call(:some_use_case, :some_input)
     #   response.success? # => true
     #
     # @param [Symbol] name

data/lib/substation/request.rb

@@ -6,6 +6,36 @@ module Substation
     include Concord.new(:env, :input)
     include Adamantium::Flat
 
+    # The application environment
+    #
+    # @example
+    #
+    #   class SomeUseCase
+    #     def self.call(request)
+    #       request.env
+    #     end
+    #   end
+    #
+    # @return [Object]
+    #
+    # @api public
+    attr_reader :env
+
+    # The input passed to an action
+    #
+    # @example
+    #
+    #   class SomeUseCase
+    #     def self.call(request)
+    #       request.input
+    #     end
+    #   end
+    #
+    # @return [Object]
+    #
+    # @api public
+    attr_reader :input
+
     # Create a new successful response
     #
     # @example

data/lib/substation/response.rb

@@ -2,6 +2,38 @@ module Substation
 
   # Base class for action responses
   #
+  # The following code illustrates context and serves as setup for all
+  # instance method doc examples
+  #
+  #   module App
+  #     class Environment
+  #       def initialize(storage, logger)
+  #         @storage, @logger = storage, logger
+  #       end
+  #     end
+  #
+  #     class SuccessfulAction
+  #       def self.call(request)
+  #         data = perform_work
+  #         request.success(data)
+  #       end
+  #     end
+  #
+  #     class FailingAction
+  #       def self.call(request)
+  #         error = perform_work
+  #         request.error(error)
+  #       end
+  #     end
+  #   end
+  #
+  #   storage    = SomeStorageAbstraction.new
+  #   env        = App::Environment.new(storage, Logger.new($stdout))
+  #   dispatcher = Substation::Dispatcher.coerce({
+  #     :successful_action => { :action => App::SuccessfulAction },
+  #     :failing_action    => { :action => App::FailingAction }
+  #   }, env)
+  #
   # @abstract
   class Response
 
@@ -9,30 +41,24 @@ module Substation
     include Equalizer.new(:request, :output)
     include Adamantium::Flat
 
-    # The environment used to return this response
+    # The application environment used within an action
     #
-    # @return [Environment]
+    # @example
     #
-    # @api private
+    #   response = dispatcher.call(:successful_action, :some_input)
+    #   response.env # => env passed to Substation::Dispatcher.coerce(config, env)
+    #
+    # @return [Object]
+    #
+    # @api public
     attr_reader :env
 
     # The request model instance passed into an action
     #
     # @example
     #
-    #   class SomeUseCase
-    #     def self.call(request)
-    #       data = perform_work
-    #       request.success(data)
-    #     end
-    #   end
-    #
-    #   env = Substation::Environment.coerce({
-    #     'some_use_case' => { 'action' => 'SomeUseCase' }
-    #   })
-    #
-    #   response = env.dispatch(:some_use_case, :input)
-    #   response.input # => :input
+    #   response = dispatcher.call(:successful_action, :some_input)
+    #   response.input # => :some_input
     #
     # @see Request#input
     #
@@ -45,18 +71,8 @@ module Substation
     #
     # @example
     #
-    #   class SomeUseCase
-    #     def self.call(request)
-    #       request.success(:output)
-    #     end
-    #   end
-    #
-    #   env = Substation::Environment.coerce({
-    #     'some_use_case' => { 'action' => 'SomeUseCase' }
-    #   })
-    #
-    #   response = env.dispatch(:some_use_case, :input)
-    #   response.output # => :output
+    #   response = dispatcher.call(:successful_action, :some_input)
+    #   response.output # => data passed to request.success(data)
     #
     # @return [Object]
     #
@@ -90,18 +106,7 @@ module Substation
     #
     # @example
     #
-    #   class SomeUseCase
-    #     def self.call(request)
-    #       request.success(:data)
-    #     end
-    #   end
-    #
-    #   env = Substation::Environment.coerce({
-    #     'some_use_case' => { 'action' => 'SomeUseCase' }
-    #   })
-    #
-    #   response = env.dispatch(:some_use_case, :input)
-    #   response.class    # Substation::Response::Success
+    #   response = dispatcher.call(:successful_action, :some_input)
     #   response.success? # => true
     #
     # @return [Boolean]
@@ -126,17 +131,7 @@ module Substation
       #
       # @example
       #
-      #   class SomeUseCase
-      #     def self.call(request)
-      #       request.error(:output)
-      #     end
-      #   end
-      #
-      #   env = Substation::Environment.coerce({
-      #     'some_use_case' => { 'action' => 'SomeUseCase' }
-      #   })
-      #
-      #   response = env.dispatch(:some_use_case, :input)
+      #   response = dispatcher.call(:failing_action, :some_input)
       #   response.success? # => false
       #
       # @return [false]
@@ -154,17 +149,7 @@ module Substation
       #
       # @example
       #
-      #   class SomeUseCase
-      #     def self.call(request)
-      #       request.success(:data)
-      #     end
-      #   end
-      #
-      #   env = Substation::Environment.coerce({
-      #     'some_use_case' => { 'action' => 'SomeUseCase' }
-      #   })
-      #
-      #   response = env.dispatch(:some_use_case, :input)
+      #   response = dispatcher.call(:successful_action, :some_input)
       #   response.success? # => true
       #
       # @return [true]

data/lib/substation/version.rb

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

data/substation.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'adamantium',          '~> 0.0.7'
   gem.add_dependency 'equalizer',           '~> 0.0.5'
   gem.add_dependency 'abstract_type',       '~> 0.0.5'
-  gem.add_dependency 'concord',             '~> 0.0.3'
+  gem.add_dependency 'concord',             '~> 0.1.0'
 
   gem.add_development_dependency 'bundler', '~> 1.3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: substation
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -66,7 +66,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,7 +74,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement