roar-rails 0.0.6 → 0.0.7

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+h2. 0.0.7
+
+* Introduce `:represent_with` and `:represent_items_with` for `#respond_with`. In turn, deprecate the old behaviour since it will change in 1.0.
+
 h2. 0.0.6
 
 * Make roar-rails rely on roar 0.10 and bigger.

data/README.markdown

@@ -26,7 +26,7 @@ class SingersController < ApplicationController
 end
 ```
 
-Need to use a representer with a different name than your model? Pass it in using the `:with_representer` option:
+Need to use a representer with a different name than your model? Pass it in using the `:represent_with` option:
 
 ```ruby
 class SingersController < ApplicationController
@@ -35,7 +35,19 @@ class SingersController < ApplicationController
 
   def show
     singer = Musician.find_by_id(params[:id])
-    respond_with singer, :with_representer => SingerRepresenter
+    respond_with singer, :represent_with => SingerRepresenter
+  end
+end
+```
+
+If you don't want to write a dedicated representer for a collection of items (highly recommended, thou) but rather use a representer for each item, use the `+represent_items_with+` option.
+
+```ruby
+class SingersController < ApplicationController
+
+  def index
+    singers = Musician.find(:all)
+    respond_with singers, :represent_items_with => SingerRepresenter
   end
 end
 ```

data/lib/roar/rails/responder.rb

@@ -8,18 +8,29 @@ module Roar::Rails
     
   private
     def representer_for_model(model)
-      (model.class.name + "Representer").constantize
+      class_name = model.class.name
+      "#{class_name}Representer".constantize
     end
   end
   
   module Responder
     include ModelMethods
     
-    def display(model, given_options={})
-      # TODO: remove the [] semantics, this should be done with a Collection representer.
-      representer = options.delete(:with_representer)
+    # 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_with)
+        # this is the new behaviour.
+        model.extend(representer) # FIXME: move to method.
+        return super
+      end
+      
+      
+      representer = options.delete(:with_representer) and ActiveSupport::Deprecation.warn(":with_representer is deprecated and will be removed in roar-rails 1.0. Use :represent_with or :represent_items_with.")
+      representer ||= options.delete(:represent_items_with) # new API.
       
       if model.respond_to?(:map!)
+        ActiveSupport::Deprecation.warn("Calling #respond_with with a collection will misbehave in future versions of roar-rails. Use :represent_items_with to get the old behaviour.")
+        
         model.map! do |m|
           extend_with_representer!(m, representer)
           m.to_hash
@@ -27,6 +38,7 @@ module Roar::Rails
       else
         extend_with_representer!(model, representer)
       end
+      
       super
     end
   end

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.0.6"
+    VERSION = "0.0.7"
   end
 end

data/test/responder_test.rb

@@ -2,6 +2,16 @@ require 'test_helper'
 
 Singer = Struct.new(:name)
 
+module SingersRepresenter
+  include Roar::Representer::JSON
+  
+  collection :singers, :extend => SingerRepresenter
+  def singers
+    each
+  end
+end
+
+
 class ResponderTest < ActionController::TestCase
   include Roar::Rails::TestCase
   
@@ -9,48 +19,103 @@ class ResponderTest < ActionController::TestCase
     include Roar::Rails::ControllerAdditions
     respond_to :json
 
-    def explicit_representer
+    def execute
+      instance_exec &@block
+    end
+  end
+  
+  def get(&block)
+    @controller.instance_eval do
+      @block = block
+    end
+    
+    super :execute, :format => 'json'
+  end
+  
+  
+  tests SingersController
+  
+  test ":with_representer is deprecated" do
+    assert_deprecated do
+      get do
+        singer = Musician.new("Bumi")
+        respond_with singer, :with_representer => SingerRepresenter
+      end
+    end
+  end
+  
+  
+  test "responder allows specifying representer" do # TODO: remove in 1.0.
+    get do
       singer = Musician.new("Bumi")
       respond_with singer, :with_representer => SingerRepresenter
     end
+    
+    assert_equal singer.to_json, @response.body
+  end
 
-    def implicit_representer
+  test "responder finds representer by convention" do
+    get do
       singer = Singer.new("Bumi")
       respond_with singer
     end
+    
+    assert_equal singer.to_json, @response.body
+  end
+  
+  
 
-    def collection_of_representers
-      singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
-      respond_with singers
+  test "responder works with collections" do # TODO: remove in 1.0.
+    assert_deprecated do
+      get do
+        singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
+        respond_with singers
+      end
     end
+    
+    assert_equal singers.map(&:to_hash).to_json, @response.body
+  end
 
-    def collection_of_custom_representers
+  test "custom responder works with collections" do  # TODO: remove in 1.0.
+    get do
       singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
       respond_with singers, :with_representer => SingerAliasRepresenter
     end
+    
+    assert_equal singers.map {|s| s.extend(SingerAliasRepresenter).to_hash }.to_json, @response.body
   end
-
-  tests SingersController
-
-  test "responder allows specifying representer" do
-    get :explicit_representer, :format => 'json'
-    assert_equal singer.to_json, @response.body
-  end
-
-  test "responder finds representer by convention" do
-    get :implicit_representer, :format => 'json'
-    assert_equal singer.to_json, @response.body
+  
+  
+  
+  test "use passed :represent_with representer for single model" do
+    get do
+      singer = Musician.new("Bumi")
+      respond_with singer, :with_representer => SingerRepresenter
+    end
+    
+    assert_equal singer.extend(SingerRepresenter).to_json, @response.body
   end
-
-  test "responder works with collections" do
-    get :collection_of_representers, :format => 'json'
-    assert_equal singers.map(&:to_hash).to_json, @response.body
+  
+  test "use passed :represent_with representer for collection" do
+    get do
+      singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
+      respond_with singers, :represent_with => SingersRepresenter
+    end
+    
+    assert_equal({:singers => singers.collect {|s| s.extend(SingerRepresenter).to_hash }}.to_json, @response.body)
   end
-
-  test "custom responder works with collections" do
-    get :collection_of_custom_representers, :format => 'json'
-    assert_equal singers.map {|s| s.extend(SingerAliasRepresenter).to_hash }.to_json, @response.body
+  
+  test "use passed :represent_items_with for collection items" do
+    get do
+      singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
+      respond_with singers, :represent_items_with => SingerRepresenter
+    end
+    
+    assert_equal(singers.collect {|s| s.extend(SingerRepresenter).to_hash }.to_json, @response.body)
   end
+  
+  
+  
 
   def singer(name="Bumi")
     singer = Musician.new(name)
@@ -60,5 +125,4 @@ class ResponderTest < ActionController::TestCase
   def singers
     [singer("Bumi"), singer("Bjork"), singer("Sinead")]
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar