objectify 0.1.1 → 0.2.0

data/README.md

@@ -37,10 +37,8 @@ Objectify has two primary components:
 
       ```ruby
         class UnauthenticatedResponder
-          # yes, at some point we probably need a better interface
-          # for handling responses, but this'll do for now.
-          def call(controller, renderer)
-            renderer.redirect_to controller.login_url
+          def call(format, routes)
+            format.any { redirect_to routes.login_url }
           end
         end
       ```
@@ -73,14 +71,14 @@ Objectify has two primary components:
       ```ruby
         class PicturesCreateResponder
           # service_result is exactly what it sounds like
-          def call(service_result, controller, renderer)
+          def call(service_result, format)
             if service_result.persisted?
-              renderer.redirect_to service_result
+              format.any { redirect_to service_result }
             else
-              # this is the only way that you can pass data to the view layer
-              # and you can only pass one thing. Hint: use a presenter.
-              renderer.data(service_result)
-              renderer.render :template => "pictures/edit.html.erb"
+              # the service_result is always the only thing passed to the view
+              # (hint: use a presenter)
+              # you can access it with the `objectify_data` helper.
+              format.any { render :template => "pictures/new.html.erb" }
             end
           end
         end
@@ -229,6 +227,61 @@ describe "CurrentUserResolver" do
 end
 ```
 
+### Decorators
+
+Decorators are a great way to create truly modular and composable software. Here's a great example.
+
+In objectify\_auth, there's a SessionsCreateService that you can use as the basis for the creat action in your /sessions resource. By default, it does very little:
+
+```ruby
+class SessionsCreateService
+  def initialize(authenticator, session_creator)
+    @authenticator = authenticator
+    @session_creator = session_creator
+  end
+
+  def call(params, session)
+    @authenticator.call(params[:email], params[:password]).tap do |user|
+      @session_creator.call(session) if user
+    end
+  end
+end
+```
+
+Let's say we wanted to add remember token issuance. We could rewrite the entire SessionsCreationService or extend (with inheritance) it to do that, but then we'd have to retest the whole unit again. A decorator allows us to avoid that:
+
+```ruby
+class SessionsCreateServiceWithRememberToken
+  def initialize(sessions_create_service, remember_token_generator)
+    @sessions_create_service = sessions_create_service
+    @remember_token_generator = remember_token_generator
+  end
+
+  def call(params, session, cookies)
+    @sessions_create_service.call(params, session).tap do |user|
+      if user
+        token = @remember_token_generator.call(user)
+        cookies[:remember_token] = { ... }
+      end
+    end
+  end
+end
+```
+
+This makes for a very simple and easy to test extension to our SessionsCreateService. We can tell objectify to use this decorator like this:
+
+```ruby
+# config/routes.rb
+objectify.decorators :sessions_create_service => :sessions_create_service_with_remember_token
+```
+
+If we wanted to specify additional decorators, it'd look like this:
+
+```ruby
+# config/routes.rb
+objectify.decorators :sessions_create_service => [:sessions_create_service_with_remember_token, :sessions_create_service_with_captcha_verification]
+```
+
 ## Views
 
 Objectify has two major impacts on your views.

data/lib/objectify/config/action.rb

@@ -6,9 +6,10 @@ module Objectify
     class Action
       attr_reader :resource_name, :name, :route, :policies, :service, :responder
 
-      def initialize(resource_name, name, options, default_policies,
+      def initialize(routing_opts,
+                     resource_name, name, options, default_policies,
                      route_factory = Route)
-        @route = route_factory.new(resource_name, name)
+        @route = route_factory.new(routing_opts)
         @resource_name = resource_name
         @name = name
         @policies = default_policies.merge(options, options[name])

data/lib/objectify/config/context.rb

@@ -57,7 +57,7 @@ module Objectify
 
       def legacy_action(route)
         actions[route] ||
-          @action_factory.new(route.resource, route.action, {}, policies)
+          @action_factory.new(route.opts, route.opts[:controller], route.opts[:action], {}, policies)
       end
 
       def injector
@@ -86,6 +86,12 @@ module Objectify
         end
       end
 
+      def append_decorators(opts)
+        opts.each do |k,v|
+          injectables.add_decorators(k, v)
+        end
+      end
+
       def instantiator
         @instantiator ||= Instantiator.new(injector)
       end

data/lib/objectify/config/injectables.rb

@@ -6,6 +6,7 @@ module Objectify
 
       def initialize(config = {})
         @config = config
+        @decorators = {}
       end
 
       def add_resolver(name, value)
@@ -24,6 +25,14 @@ module Objectify
         @config[name] || context[name] || [:unknown, name]
       end
 
+      def add_decorators(name, value)
+        @decorators[name] = value
+      end
+
+      def decorators(name)
+        [*@decorators[name]].compact
+      end
+
       def context
         @context && @context.config || {}
       end

data/lib/objectify/injector.rb

@@ -8,6 +8,7 @@ module Objectify
 
     def initialize(config)
       @config = config
+      @decoration_context = {}
     end
 
     def call(object, method)
@@ -15,7 +16,7 @@ module Objectify
       instrument("inject.objectify", payload) do |payload|
         method_obj           = method_object(object, method)
         injectables          = method_obj.parameters.map do |reqd, name|
-          @config.get(name) if reqd == :req
+          @decoration_context[name] || @config.get(name) if reqd == :req
         end.compact
         arguments            = injectables.map do |type, value|
           if type == :unknown
@@ -39,7 +40,19 @@ module Objectify
         payload[:injectables] = injectables
         payload[:arguments]   = arguments
 
-        object.send(method, *arguments)
+        result = object.send(method, *arguments)
+        if method == :new
+          base_name = object.name.underscore.to_sym
+          add_decoration_context(base_name, result)
+          result = @config.decorators(base_name).inject(result) do |memo, decorator|
+            call(decorator.to_s.classify.constantize, :new).tap do |decorated|
+              add_decoration_context(base_name, decorated)
+            end
+          end
+          clear_decoration_context
+        end
+
+        result
       end
     end
 
@@ -63,5 +76,13 @@ module Objectify
 
         raise ArgumentError, "Can't figure out how to inject #{value}."
       end
+
+      def add_decoration_context(name, object)
+        @decoration_context[name] = [:value, object]
+      end
+
+      def clear_decoration_context
+        @decoration_context.clear
+      end
   end
 end

data/lib/objectify/rails/controller.rb

@@ -3,6 +3,7 @@ require "objectify/executor"
 require "objectify/policy_chain_executor"
 require "objectify/instrumentation"
 require "objectify/rails/renderer"
+require "objectify/rails/routes"
 
 module Objectify
   module Rails
@@ -20,6 +21,12 @@ module Objectify
           objectify.injector
         end
 
+        def objectify_routes
+          @objectify_routes ||= Routes.new.tap do |routes|
+            routes.default_url_options = url_options
+          end
+        end
+
         def request_injectables_context
           klass = Objectify::Config::Injectables
           @request_injectables_context ||= klass.new.tap do |injectables_context|
@@ -31,8 +38,14 @@ module Objectify
             injectables_context.add_value(:response, response)
             injectables_context.add_value(:flash, flash)
             injectables_context.add_value(:renderer, Renderer.new(self))
+            injectables_context.add_value(:format, objectify_response_collector)
+            injectables_context.add_value(:routes, objectify_routes)
           end
         end
+
+        def objectify_response_collector
+          @objectify_response_collector ||= ActionController::MimeResponds::Collector.new { default_response }
+        end
         
         def objectify_executor
           objectify.executor
@@ -43,8 +56,9 @@ module Objectify
         end
 
         def objectify_route
-          resource_name = params[:objectify] ? params[:objectify][:resource] : params[:controller]
-          @objectify_route ||= Objectify::Route.new(resource_name.to_sym, params[:action].to_sym)
+          routing_options = params[:objectify] ? params[:objectify] : {:controller => params[:controller].to_sym, :action => params[:action].to_sym}
+          routing_options.merge!(:action => params[:action]) if routing_options.delete(:append_action)
+          @objectify_route ||= Objectify::Route.new(routing_options)
         end
 
         def action
@@ -57,6 +71,7 @@ module Objectify
 
         def execute_policy_chain
           policy_chain_executor.call(action)
+          objectify_respond_if_response
         end
 
         def objectify_around_filter
@@ -66,10 +81,19 @@ module Objectify
         end
 
         def execute_objectify_action
-          service_result = objectify_executor.call(action.service, :service)
-          request_injectables_context.add_value(:service_result, service_result)
+          @objectify_service_result = objectify_executor.call(action.service, :service)
+          request_injectables_context.add_value(:service_result, @objectify_service_result)
 
           objectify_executor.call(action.responder, :responder)
+          objectify_respond_if_response
+        end
+
+        def objectify_respond_if_response
+          if format = request.negotiate_mime(objectify_response_collector.order)
+            self.content_type ||= format.to_s
+            lookup_context.freeze_formats([format.to_sym])
+            instance_eval &objectify_response_collector.response_for(format)
+          end
         end
     end
 
@@ -81,11 +105,24 @@ module Objectify
         klass.helper_method(:objectify_executor) if klass.respond_to?(:helper_method)
       end
 
-      def method_missing(name, *args, &block)
+      def action_missing(name, *args, &block)
         instrument("start_processing.objectify", :route => objectify_route)
 
         execute_objectify_action
       end
+
+      def controller_path
+        action.resource_name
+      end
+
+      def action_name
+        action.name
+      end
+
+      private
+        def view_assigns
+          {:_objectify_data => @objectify_service_result}
+        end
     end
 
     module ControllerBehaviour
@@ -96,16 +133,30 @@ module Objectify
         klass.helper_method(:objectify_executor) if klass.respond_to?(:helper_method)
       end
 
-      def method_missing(name, *args, &block)
+      def action_missing(name, *args, &block)
         instrument("start_processing.objectify", :route => objectify_route)
 
         if execute_policy_chain
           execute_objectify_action
         end
       end
+
+      def controller_path
+        action.resource_name
+      end
+
+      def action_name
+        action.name
+      end
+
+      private
+        def view_assigns
+          {:_objectify_data => @objectify_service_result}
+        end
     end
 
     class ObjectifyController < ActionController::Base
+      around_filter :objectify_around_filter
       include ControllerBehaviour
     end
   end

data/lib/objectify/rails/routes.rb

@@ -0,0 +1,7 @@
+module Objectify
+  module Rails
+    class Routes
+      include ::Rails.application.routes.url_helpers
+    end
+  end
+end

data/lib/objectify/rails/routing.rb

@@ -6,7 +6,7 @@ module Objectify
     module Routing
       RESOURCE_ACTIONS = [:index, :show, :new, :create,
                           :edit, :update, :destroy].freeze
-      OBJECTIFY_OPTIONS = [:policies].freeze
+      OBJECTIFY_OPTIONS = [:policies, :service, :skip_policies].freeze
 
       class ObjectifyMapper
         def initialize(rails_mapper,
@@ -24,12 +24,31 @@ module Objectify
           rails_options     = options.merge(:controller => controller)
 
           args.each do |resource_name|
-            merged_defaults = objectify_defaults(resource_name, rails_options)
+            objectify_defaults = {:resource => resource_name}
+            merged_defaults = merge_defaults(objectify_defaults.merge(:append_action => true),
+                                             rails_options)
             @rails_mapper.resources(resource_name, merged_defaults)
-            RESOURCE_ACTIONS.each { |action_name| append_action(resource_name, action_name, objectify_options) }
+            RESOURCE_ACTIONS.each do |action_name|
+              append_action(objectify_defaults.merge(:action => action_name),
+                            resource_name,
+                            action_name,
+                            objectify_options)
+            end
           end
         end
 
+        def match(options)
+          from,to = options.detect { |k,v| k.is_a?(String) }
+          resource,action = to.split("#").map(&:to_sym)
+          controller = @application.objectify.objectify_controller
+          objectify_options = extract_objectify_options(options)
+          objectify_defaults = {"path" => from.dup}
+          rails_options = merge_defaults(objectify_defaults, options)
+          @rails_mapper.match rails_options.merge(from => "#{controller}#action")
+
+          append_action(objectify_defaults, resource, action, objectify_options)
+        end
+
         def defaults(options)
           @application.objectify.append_defaults(options)
         end
@@ -50,8 +69,16 @@ module Objectify
           @application.objectify.append_values(options)
         end
 
+        def decorators(options)
+          @application.objectify.append_decorators(options)
+        end
+
         def legacy_action(controller, actions, options)
-          [*actions].each { |action_name| append_action(controller, action_name, options) }
+          [*actions].each do |action_name|
+            routing_opts = {:controller => controller,
+                            :action     => action_name}
+            append_action(routing_opts, controller, action_name, options)
+          end
         end
 
         private
@@ -61,14 +88,15 @@ module Objectify
             end.compact.flatten]
           end
 
-          def objectify_defaults(resource_name, rails_options)
-            defaults = {:objectify => {:resource => resource_name}}
+          def merge_defaults(objectify_defaults, rails_options)
+            defaults = {:objectify => objectify_defaults}
             defaults = (rails_options[:defaults] || {}).merge(defaults)
             defaults = rails_options.merge(:defaults => defaults)
           end
 
-          def append_action(resource_name, action_name, options)
-            action = @action_factory.new(resource_name,
+          def append_action(routing_opts, resource_name, action_name, options)
+            action = @action_factory.new(routing_opts,
+                                         resource_name,
                                          action_name,
                                          options,
                                          @application.objectify.policies)

data/lib/objectify/route.rb

@@ -1,4 +1,4 @@
 module Objectify
-  class Route < Struct.new(:resource, :action)
+  class Route < Struct.new(:opts)
   end
 end

data/lib/objectify/version.rb

@@ -1,3 +1,3 @@
 module Objectify
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/config/action_spec.rb

@@ -8,6 +8,8 @@ describe "Objectify::Config::Action" do
 
     @route            = stub("Route")
     @route_factory    = stub("RouteFactory", :new => @route)
+
+    @routing_opts = {:some => :route}
   end
 
   context "when everything is specified" do
@@ -23,7 +25,8 @@ describe "Objectify::Config::Action" do
         :index => @index_options
       }
 
-      @action = Objectify::Config::Action.new(:pictures,
+      @action = Objectify::Config::Action.new(@routing_opts,
+                                              :pictures,
                                               :index,
                                               @options,
                                               @default_policies,
@@ -31,7 +34,7 @@ describe "Objectify::Config::Action" do
     end
 
     it "creates and stores a route from the route factory" do
-      @route_factory.should have_received(:new).with(:pictures, :index)
+      @route_factory.should have_received(:new).with(@routing_opts)
       @action.route.should == @route
     end
 
@@ -61,7 +64,8 @@ describe "Objectify::Config::Action" do
   context "when nothing is specified" do
     before do
       @options = {}
-      @action = Objectify::Config::Action.new(:pictures,
+      @action = Objectify::Config::Action.new(@routing_opts,
+                                              :pictures,
                                               :index,
                                               @options,
                                               @default_policies,

data/spec/config/context_spec.rb

@@ -76,7 +76,8 @@ describe "Objectify::Config::Context" do
       @action_factory = stub("ActionFactory", :new => @action)
       @policies = stub("Policies")
       @policies_factory = stub("PoliciesFactory", :new => @policies)
-      @route = stub("Route", :resource => :controller, :action => :action)
+      @route_opts = {:controller => :controller, :action => :action}
+      @route = stub("Route", :opts => @route_opts)
 
       @context = Objectify::Config::Context.new(@policies_factory, @action_factory)
     end
@@ -88,7 +89,9 @@ describe "Objectify::Config::Context" do
 
       it "creates a new action with the controller and action name and its policies" do
         @action_factory.should have_received(:new).
-                                with(:controller, :action, {}, @policies)
+                                with(@route_opts,
+                                     :controller,
+                                     :action, {}, @policies)
       end
     end
 

data/spec/config/injectables_spec.rb

@@ -37,4 +37,12 @@ describe "Objectify::Config::Injectables" do
     @injectables.context = @context
     @injectables.get(:controller).should == [:value, :something]
   end
+
+  it "accepts decorators" do
+    @injectables.add_decorators(:base, :decorator1)
+    @injectables.decorators(:base).should == [:decorator1]
+    @injectables.add_decorators(:base, [:decorator1, :decorator2])
+    @injectables.decorators(:base).should == [:decorator1, :decorator2]
+    @injectables.decorators(:nonexistent).should == []
+  end
 end

data/spec/injector_spec.rb

@@ -40,7 +40,7 @@ describe "Objectify::Injector" do
   end
 
   before do
-    @config = stub("Config", :get => nil)
+    @config = stub("Config", :get => nil, :decorators => [])
     @injector = Objectify::Injector.new(@config)
   end
 
@@ -99,4 +99,40 @@ describe "Objectify::Injector" do
       @injector.call(obj, :requires_params).call.should == :SOMETHING
     end
   end
+
+  class ToBeDecorated
+  end
+
+  class Decorator1
+    attr_reader :to_be_decorated
+
+    def initialize(to_be_decorated)
+      @to_be_decorated = to_be_decorated
+    end
+  end
+
+  class Decorator2
+    attr_reader :to_be_decorated
+
+    def initialize(to_be_decorated)
+      @to_be_decorated = to_be_decorated
+    end
+  end
+
+  context "decorating an object" do
+    before do
+      decorators = [:decorator1, :decorator2]
+      @config.stubs(:decorators).with(:to_be_decorated).returns(decorators)
+      @result = @injector.call(ToBeDecorated, :new)
+    end
+
+    it "decorates left to right" do
+      @result.should be_instance_of(Decorator2)
+      @result.to_be_decorated.should be_instance_of(Decorator1)
+      @result.to_be_decorated.to_be_decorated.should be_instance_of(ToBeDecorated)
+
+      @config.stubs(:decorators).with(:to_be_decorated).returns([])
+      @injector.call(ToBeDecorated, :new).should be_instance_of(ToBeDecorated)
+    end
+  end
 end

data/spec/rails/routing_spec.rb

@@ -11,6 +11,7 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
                                           :append_implementations   => nil,
                                           :append_resolvers         => nil,
                                           :append_values            => nil,
+                                          :append_decorators        => nil,
                                           :objectify_controller => "some_controller")
     @rails_mapper   = stub("RailsMapper", :resources => nil,
                                           :match     => nil)
@@ -25,6 +26,9 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
 
   context "adding a resource" do
     before do
+      @rails_routing_info = {:resource => :pictures,
+                             :append_action => true}
+      @objectify_routing_info = {:resource => :pictures}
       @mapper.resources(:pictures, :policies => :some_policy,
                                    :create   => {
                                       :policies => :blocked_user,
@@ -34,7 +38,7 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
 
     it "correctly adds the resource to the rails mapper" do
       opts = { :controller => @objectify.objectify_controller,
-               :defaults   => {:objectify => {:resource => :pictures}}}
+               :defaults   => {:objectify => @rails_routing_info}}
       @rails_mapper.should have_received(:resources).
                             with(:pictures, opts)
     end
@@ -48,8 +52,13 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
         :policies => :some_policy
       }
       Objectify::Rails::Routing::RESOURCE_ACTIONS.each do |action|
+        routing_info = @objectify_routing_info.merge(:action => action)
         @action_factory.should have_received(:new).
-                                with(:pictures, action, opts, @policies)
+                                with(routing_info,
+                                     :pictures,
+                                     action,
+                                     opts,
+                                     @policies)
       end
     end
 
@@ -61,6 +70,9 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
 
   context "adding a resource with its own defaults" do
     before do
+      @rails_routing_info = {:resource => :pictures,
+                             :append_action => true}
+      @objectify_routing_info = {:resource => :pictures}
       @mapper.resources(:pictures, :policies => :some_policy,
                                    :create   => {
                                       :policies => :blocked_user,
@@ -71,7 +83,7 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
 
     it "correctly adds the resource to the rails mapper" do
       opts = { :controller => @objectify.objectify_controller,
-               :defaults   => {:objectify => {:resource => :pictures},
+               :defaults   => {:objectify => @rails_routing_info,
                                :some      => :bullshit}}
       @rails_mapper.should have_received(:resources).
                             with(:pictures, opts)
@@ -86,8 +98,10 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
         :policies => :some_policy
       }
       Objectify::Rails::Routing::RESOURCE_ACTIONS.each do |action|
+        routing_info = @objectify_routing_info.merge(:action => action)
         @action_factory.should have_received(:new).
-                                with(:pictures, action, opts, @policies)
+                                with(routing_info,
+                                     :pictures, action, opts, @policies)
       end
     end
 
@@ -97,6 +111,58 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
     end
   end
 
+  context "#match" do
+    before do
+      @routing_info = {"path" => "/pictures"}
+      @opts = { "/pictures" => "pictures#create" }
+      @mapper.match @opts
+    end
+
+    it "correctly adds the resource to the rails mapper" do
+      opts = { "/pictures" => "#{@objectify.objectify_controller}#action",
+               :defaults   => {:objectify => @routing_info}}
+      @rails_mapper.should have_received(:match).with(opts)
+    end
+
+    it "creates an action" do
+      @action_factory.should have_received(:new).
+              with(@routing_info, :pictures, :create, {}, @policies)
+    end
+
+    it "appends each of the actions to the objectify object" do
+      @objectify.should have_received(:append_action).
+                          with(@action).times(1)
+    end
+  end
+
+  context "#match with overrides" do
+    before do
+      @routing_info = {"path" => "/pictures"}
+      @opts = { "/pictures" => "pictures#create" }
+      @objectify_opts = {:service => :pics, :skip_policies => :an}
+      @opts.merge!(@objectify_opts)
+
+      @mapper.match @opts
+    end
+
+    it "correctly adds the resource to the rails mapper" do
+      opts = { "/pictures" => "#{@objectify.objectify_controller}#action",
+               :defaults   => {:objectify => @routing_info}}
+      @rails_mapper.should have_received(:match).with(opts)
+    end
+
+    it "creates an action" do
+      @action_factory.should have_received(:new).
+              with(@routing_info, :pictures, :create,
+                   @objectify_opts, @policies)
+    end
+
+    it "appends each of the actions to the objectify object" do
+      @objectify.should have_received(:append_action).
+                          with(@action).times(1)
+    end
+  end
+
   context "adding a resource with an alternative objectify_controller" do
     before do
       @objectify.stubs(:objectify_controller).returns("asdfbsdf")
@@ -110,7 +176,8 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
 
     it "correctly adds the resource to the rails mapper" do
       opts = { :controller => @objectify.objectify_controller,
-               :defaults   => {:objectify => {:resource => :pictures},
+               :defaults   => {:objectify => {:resource => :pictures,
+                                              :append_action => true},
                                :some      => :bullshit}}
       @rails_mapper.should have_received(:resources).
                             with(:pictures, opts)
@@ -161,6 +228,13 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
       @objectify.should have_received(:append_values).
                           with(@opts)
     end
+
+    it "hands decorators to the context" do
+      @opts = { :base => :decorator }
+      @mapper.decorators @opts
+      @objectify.should have_received(:append_decorators).
+                          with(@opts)
+    end
   end
 
   context "adding a legacy action" do
@@ -170,11 +244,20 @@ describe "Objectify::Rails::Routing::ObjectifyMapper" do
     end
 
     it "creates actions for each of the specified actions" do
+      routing_opts = {:controller => :controller}
       @action_factory.should have_received(:new).
-                              with(:controller, :action1, @opts, @policies)
+                              with(routing_opts.merge(:action => :action1),
+                                   :controller,
+                                   :action1,
+                                   @opts,
+                                   @policies)
 
       @action_factory.should have_received(:new).
-                              with(:controller, :action2, @opts, @policies)
+                              with(routing_opts.merge(:action => :action2),
+                                   :controller,
+                                   :action2,
+                                   @opts,
+                                   @policies)
     end
 
     it "passes the actions to the objectify objects" do

data/spec/route_spec.rb

@@ -4,8 +4,8 @@ require "objectify/route"
 describe "Objectify::Route" do
   context "two routes with the same path" do
     it "have the same #hash value" do
-      Objectify::Route.new(:pictures, :index).should ==
-        Objectify::Route.new(:pictures, :index)
+      Objectify::Route.new(:controller => :pictures, :action => :index).should ==
+        Objectify::Route.new(:controller => :pictures, :action => :index)
     end
   end
 end

data/thoughts/responders.md

@@ -0,0 +1,156 @@
+# responders
+
+Currently responders collaborate with other objects to actually initiate the response. They're by far the weakest abstraction in objectify. This document contains some thoughts on how to fix that.
+
+## Value objects approach
+
+Bryan Helmkamp's proposal on the mailing list was to have responders return value objects that describe the response, and then objectify could use those descriptors to actually fire the response using rails' APIs.
+
+An example:
+
+```ruby
+class SessionNewResponder
+  def call
+    Objectify::Render::Template.new(:name => "new.html.erb")
+  end
+end
+```
+
+There are two problems with this. First of all, typing out the whole namespace is cumbersome. Though, that can be solved with one `include`.
+
+```ruby
+class SessionNewResponder
+  include Objectify::Render
+
+  def call
+    Template.new(:name => "new.html.erb")
+  end
+end
+```
+
+The second problem is how to handle multiple formats. One idea is to use the rails block syntax:
+
+```ruby
+class SessionNewResponder
+  include Objectify::Render
+
+  def call(service_result)
+    FormattedResponse.new(:data => service_result) do |format|
+      format.html
+      format.js
+    end
+  end
+end
+```
+
+Or something like that. I'm not a huge fan of that syntax because it seems difficult to test, although maybe that's solved by making the result of the little DSL very simple.
+
+```ruby
+class SessionNewResponder
+  include Objectify::Render
+
+  def call(service_result)
+    FormattedResponse.new(:data => service_result) do |format|
+      format.html Template.new("somewhere.html.erb")
+      format.js
+    end
+  end
+end
+```
+
+After writing this, I'm starting to think it's the right approach.
+
+## Rename to "Responses"?
+
+One idea I had this weekend, was to rename responders to responses. That way, conceptually, you're defining a type of response. I think that might be easier for people to think about.
+
+Also, I think we should use methods to respond to different content types. Can't believe it took me this long to think of this.
+
+```ruby
+class UnauthorizedResponse
+  include Objectify::Response
+
+  respond_with :html, :js
+  status 403
+
+  def js
+    :default
+  end
+
+  def any(service_result, renderer)
+    renderer.template :name => "unauthorized.html.erb", :data => service_result
+  end
+end
+```
+
+```ruby
+class PicturesCreateSuccessfulResponse
+  include Objectify::Response
+
+  when_policy :create_successful
+  respond_with :html, :js, :json
+
+  def html(service_result, renderer)
+    responder.redirect_to service_result
+  end
+
+  def js(service_result, renderer)
+    responder.redirect_to "xyz"
+  end
+end
+
+class PicturesCreateUnsuccessfulResponse
+  include Objectify::Response
+
+  when_not_policy :create_successful
+  respond_with :html, :js, :json
+
+  def html(service_result, renderer)
+    responder.redirect_to service_result
+  end
+
+  def js(service_result, renderer)
+    responder.redirect_to "xyz"
+  end
+end
+
+class PicturesCreateResponse < Objectify::Response
+  respond do |service_result, format|
+    if service_result.persisted?
+      format.html { redirect_to service_result }
+      format.js   { render :template => "pictures/show.json.json_builder" }
+      format.json { render :template => "pictures/show.json.json_builder" }
+    else
+      format.html { render :template => "pictures/new.html.erb" }
+      format.js   { render :json => { :errors => service_result.errors, :status => :unprocessable_entity } }
+      format.json { render :template => "pictures/show.json.json_builder" }
+    end
+  end
+end
+```
+
+Tests?
+
+```ruby
+describe "PicturesCreateResponse" do
+  before do
+    @format   = Objectify::FakeFormat.new
+    @response = PicturesCreateResponse.new
+  end
+
+  context "when create is successful" do
+    before do
+      @service_result = stub("Result", :persisted? => true)
+      @response.respond(@service_result, @format)
+    end
+
+    it "renders a template called 'pictures/new.html.erb' for html" do
+      @response.should render_template("pictures/new.html.erb")
+    end
+  end
+end
+```
+
+## Other approaches?
+
+* Something that can be tested mockist-style, perhaps? I have no idea what this would look like, though, really.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: objectify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70203413321160 !ruby/object:Gem::Requirement
+  requirement: &70262082543760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.4.0
   type: :development
   prerelease: false
-  version_requirements: *70203413321160
+  version_requirements: *70262082543760
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70203413318700 !ruby/object:Gem::Requirement
+  requirement: &70262082559640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70203413318700
+  version_requirements: *70262082559640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70203413317340 !ruby/object:Gem::Requirement
+  requirement: &70262082559180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70203413317340
+  version_requirements: *70262082559180
 - !ruby/object:Gem::Dependency
   name: bourne
-  requirement: &70203413316500 !ruby/object:Gem::Requirement
+  requirement: &70262082558700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70203413316500
+  version_requirements: *70262082558700
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70203419213280 !ruby/object:Gem::Requirement
+  requirement: &70262082558160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.8
   type: :development
   prerelease: false
-  version_requirements: *70203419213280
+  version_requirements: *70262082558160
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70203419212740 !ruby/object:Gem::Requirement
+  requirement: &70262082557540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70203419212740
+  version_requirements: *70262082557540
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70203419212340 !ruby/object:Gem::Requirement
+  requirement: &70262082557000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70203419212340
+  version_requirements: *70262082557000
 description: Objects on rails.
 email:
 - jamesgolick@gmail.com
@@ -118,6 +118,7 @@ files:
 - lib/objectify/rails/log_subscriber.rb
 - lib/objectify/rails/railtie.rb
 - lib/objectify/rails/renderer.rb
+- lib/objectify/rails/routes.rb
 - lib/objectify/rails/routing.rb
 - lib/objectify/route.rb
 - lib/objectify/version.rb
@@ -135,6 +136,7 @@ files:
 - spec/route_spec.rb
 - spec/spec_helper.rb
 - thoughts/injector.md
+- thoughts/responders.md
 homepage: https://github.com/bitlove/objectify
 licenses: []
 post_install_message: