roar-rails 0.0.12 → 0.0.13

data/CHANGES.markdown

@@ -1,3 +1,8 @@
+h2. 0.0.13
+
+* Allow passing user options to both `#respond_with` and `#consume!`.
+* Fixing `#consume!` with decorators.
+
 h2. 0.0.12
 
 * Bumping representable to 1.4 which allows us using both extend and decorating representers.

data/README.markdown

@@ -72,22 +72,6 @@ class SingersController < ApplicationController
 end
 ```
 
-Goes great with [Jose Valim's responders gem][responders]!
-
-```ruby
-class SingersController < ApplicationController
-  respond_to :json
-
-  responders Roar::Rails::Responder
-
-  def show
-    singer = Singer.find_by_id(params[:id])
-    respond_with singer
-  end
-
-end
-```
-
 
 ## Parsing incoming documents
 
@@ -134,6 +118,23 @@ class SingerRepresenter < Roar::Decorator
 end
 ```
 
+## Passing Options
+
+Both rendering and consuming support passing user options to the representer.
+
+With `#respond_with`, any additional options will be passed to `to_json` (or whatever format you're using).
+
+```ruby
+respond_with @singer, :current_user => current_user
+```
+
+Same goes with `#consume!`, passing options to `from_json`.
+
+```ruby
+consume! Singer.new, :current_user => current_user
+```
+
+
 ## URL Helpers
 
 Any URL helpers from the Rails app are automatically available in representers.

data/lib/roar-rails.rb

@@ -5,12 +5,12 @@ require "roar/rails/railtie"
 module Roar::Representer
   autoload("XML", "roar/representer/xml")
   autoload("JSON", "roar/representer/json")
-  
+
   module JSON
     autoload("HAL", "roar/representer/json/hal")
   end
-  
-  
+
+
   module Feature
     autoload("Hypermedia", "roar/representer/feature/hypermedia")
   end
@@ -23,17 +23,15 @@ module Roar
     def self.rails3_0?
       ::Rails::VERSION::MINOR == 0
     end
-    
+
     if rails3_0?
       require 'roar/rails/rails3_0_strategy'
     else
       require 'roar/rails/rails3_1_strategy'
     end
-    
+
     autoload("TestCase", "roar/rails/test_case")
     autoload("ControllerAdditions", "roar/rails/controller_additions")
-    autoload("Responder", "roar/rails/responder")
-    autoload("ModelMethods", "roar/rails/responder")
   end
 end
 

data/lib/roar/rails/controller_additions.rb

@@ -1,9 +1,9 @@
 require 'hooks/inheritable_attribute'
+require 'roar/rails/responder'
 
 module Roar::Rails
   module ControllerAdditions
     extend ActiveSupport::Concern
-    include ModelMethods
 
     included do
       extend Hooks::InheritableAttribute
@@ -37,17 +37,16 @@ module Roar::Rails
 
 
     def consume!(model, options={})
-      format  = formats.first  # FIXME: i expected request.content_mime_type to do the job. copied from responder.rb. this will return the wrong format when the controller responds to :json and :xml and the Content-type is :xml (?)
-      model   = prepare_model_for(format, model, options)
+      format      = formats.first  # FIXME: i expected request.content_mime_type to do the job. copied from responder.rb. this will return the wrong format when the controller responds to :json and :xml and the Content-type is :xml (?)
+      representer = prepare_model_for(format, model, options)
 
-      model.send(compute_parsing_method(format), incoming_string) # e.g. from_json("...")
+      representer.send(compute_parsing_method(format), incoming_string, options) # e.g. from_json("...")
       model
     end
 
     def prepare_model_for(format, model, options)
       representer = representer_for(format, model, options)
-      extend_with!(model, representer)
-      model
+      representer.prepare(model)
     end
 
     # Central entry-point for finding the appropriate representer.
@@ -75,4 +74,4 @@ module Roar::Rails
       self.class.represents_options[format][:entity]
     end
   end
-end
+end

data/lib/roar/rails/rails3_0_strategy.rb

@@ -1,7 +1,7 @@
 module Roar::Rails
   module Responder
     module VersionStrategy
-      def prepare_model!(model)
+      def prepare_model_for(format, model, *args)
         # rails <= 3.1 compatibility. #display gets called for empty responses
         # >= 3.2 fixes by calling #head, not #display for all empty bodies (PUT, DELETE)
         return model if respond_to?("empty_#{format}_resource") && model == empty_resource

data/lib/roar/rails/responder.rb

@@ -1,39 +1,29 @@
 module Roar::Rails
-  module ModelMethods
-  private
-    # DISCUSS: move this into a generic namespace as we could need that in Sinatra as well.
-    def extend_with!(model, representer)  # TODO: rename to #prepare_model.
-      representer.prepare(model)
-    end
-
-    def prepare_model!(model)
-      controller.prepare_model_for(format, model, options)
-    end
-  end
-
   module Responder
-    include ModelMethods
-
-    # DISCUSS: why THE FUCK is options not passed as a method argument but kept as an internal instance variable in the responder? this is something i will never understand about Rails.
     def display(model, *args)
       if representer = options.delete(:represent_items_with)
         render_items_with(model, representer) # convenience API, not recommended since it's missing hypermedia.
         return super
       end
 
-      model = prepare_model!(model)
+      model = prepare_model_for(format, model, options)
 
       super
     end
 
   private
     def render_items_with(collection, representer)
-      collection.map! do |m|  # DISCUSS: i don't like changing the method argument here.
-        extend_with!(m, representer)
-        m.to_hash # FIXME: huh? and what about XML?
+      collection.map! do |mdl|  # DISCUSS: i don't like changing the method argument here.
+        representer.prepare(mdl).to_hash(options) # FIXME: huh? and what about XML?
       end
     end
 
+    module PrepareModel
+      def prepare_model_for(format, model, options) # overwritten in VersionStrategy/3.0.
+        controller.prepare_model_for(format, model, options)
+      end
+    end
+    include PrepareModel
     include VersionStrategy
   end
 end

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.0.12"
+    VERSION = "0.0.13"
   end
 end

data/test/responder_test.rb

@@ -225,15 +225,17 @@ class ResponderTest < ActionController::TestCase
   class ControllerWithDecoratorTest < ResponderTest
     class SingerRepresentation < Representable::Decorator
       include Roar::Representer::JSON
-      include ::SingerRepresenter
+
+      property :name
     end
+
     class MusicianController < BaseController
       represents :json, :entity => SingerRepresentation
     end
 
     tests MusicianController
 
-    test "responder uses configured decorating representer" do
+    test "rendering uses decorating representer" do
       get do
         singer = Singer.new("Bumi")
         respond_with singer
@@ -241,9 +243,65 @@ class ResponderTest < ActionController::TestCase
 
       assert_equal "{\"name\":\"Bumi\"}", @response.body
     end
+
+    test "parsing uses decorating representer" do # FIXME: move to controller_test.
+      created_singer = nil
+
+      put singer.to_json do
+        created_singer = consume!(Singer.new)
+        respond_with created_singer
+      end
+
+      created_singer.must_be_kind_of(Singer)
+      created_singer.name.must_equal "Bumi"
+    end
+  end
+
+  class PassingUserOptionsTest < ResponderTest
+    # FIXME: should be in generic roar-rails test.
+    module SingerRepresenter
+      include Roar::Representer::JSON
+      property :name, :setter => lambda { |val, opts| self.name = "#{opts[:title]} #{val}" },
+                      :getter => lambda { |opts| "#{opts[:title]} #{name}" }
+    end
+    class MusicianController < BaseController
+      represents :json, :entity => SingerRepresenter, :collection => SingersRepresenter
+    end
+
+    tests MusicianController
+
+    test "passes options to entity representer" do
+      get do
+        singer = Singer.new("Bumi")
+        respond_with singer, :title => "Mr."
+      end
+
+      @response.body.must_equal("{\"name\":\"Mr. Bumi\"}")
+    end
+
+    test "passes options to explicit collection representer" do
+      get do
+        respond_with [Singer.new("Bumi"), Singer.new("Iggy")], :title => "Mr.", :represent_items_with => SingerRepresenter
+      end
+
+      @response.body.must_equal("[{\"name\":\"Mr. Bumi\"},{\"name\":\"Mr. Iggy\"}]")
+    end
+
+    test "passes options in #consume!" do
+      created_singer = nil
+
+      put singer.to_json do
+        created_singer = consume!(Singer.new, :title => "Mr.")
+        respond_with created_singer
+      end
+
+      created_singer.must_be_kind_of(Singer)
+      created_singer.name.must_equal "Mr. Bumi"
+    end
   end
 
 
+
   def get(&block)
     @controller.instance_eval do
       @block = block
@@ -252,11 +310,11 @@ class ResponderTest < ActionController::TestCase
     super :execute, :format => 'json'
   end
 
-  def put(&block)
+  def put(body="", &block)
     @controller.instance_eval do
       @block = block
     end
-    super :execute, :format => 'json'
+    super :execute, body, :format => 'json'
   end
 
   def singer(name="Bumi")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar