roar-rails 0.0.11 → 0.0.12

data/.gitignore

@@ -3,7 +3,7 @@
 *.swo
 bin
 .bundle
-Gemfile.lock
+Gemfile*.lock
 pkg/*
 test/dummy/log/*
 .rvmrc

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+h2. 0.0.12
+
+* Bumping representable to 1.4 which allows us using both extend and decorating representers.
+
 h2. 0.0.11
 
 * Back to `request.body.read` in `#consume!` (again). If anyone is having problems with empty incoming strings this is a Rails issue - update ;-)

data/README.markdown

@@ -100,7 +100,7 @@ class SingersController < ApplicationController
   def create
     singer = Singer.new
     consume!(singer)
-    
+
     respond_with singer
   end
 end
@@ -122,6 +122,18 @@ Note that it respects settings from `#represents`. It uses the same mechanics kn
 consume!(singer, :represent_with => MusicianRepresenter)
 ```
 
+## Using Decorators
+
+If you prefer roar's decorator approach over extend, just go for it. roar-rails will figure out automatically which represent strategy to use.
+
+```ruby
+class SingerRepresenter < Roar::Decorator
+  include Roar::Representer::JSON
+
+  property :name
+end
+```
+
 ## URL Helpers
 
 Any URL helpers from the Rails app are automatically available in representers.

data/gemfiles/Gemfile.rails3-0

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in roar-rails.gemspec
-gemspec path: '../'
+gemspec :path => '../'
 
 gem 'railties', '~> 3.0.11'

data/gemfiles/Gemfile.rails3-2

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in roar-rails.gemspec
-gemspec path: '../'
+gemspec :path => '../'
 
 gem 'railties', '~> 3.2.0'

data/lib/roar/rails/controller_additions.rb

@@ -37,10 +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 (?)
+      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)
+
+      model.send(compute_parsing_method(format), incoming_string) # e.g. from_json("...")
+      model
+    end
+
+    def prepare_model_for(format, model, options)
       representer = representer_for(format, model, options)
       extend_with!(model, representer)
-      model.send(compute_parsing_method(format), incoming_string) # e.g. from_json("...")
       model
     end
 

data/lib/roar/rails/rails3_0_strategy.rb

@@ -4,7 +4,7 @@ module Roar::Rails
       def prepare_model!(model)
         # 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 if respond_to?("empty_#{format}_resource") && model == empty_resource
+        return model if respond_to?("empty_#{format}_resource") && model == empty_resource
         super
       end
     end

data/lib/roar/rails/responder.rb

@@ -2,31 +2,30 @@ 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)
-      model.extend(representer)
+    def extend_with!(model, representer)  # TODO: rename to #prepare_model.
+      representer.prepare(model)
     end
-  
+
     def prepare_model!(model)
-      representer = controller.representer_for(format, model, options)
-      extend_with!(model, representer)
+      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
-      
-      prepare_model!(model)
-      
+
+      model = prepare_model!(model)
+
       super
     end
-    
+
   private
     def render_items_with(collection, representer)
       collection.map! do |m|  # DISCUSS: i don't like changing the method argument here.
@@ -34,7 +33,7 @@ module Roar::Rails
         m.to_hash # FIXME: huh? and what about XML?
       end
     end
-    
+
     include VersionStrategy
   end
 end

data/lib/roar/rails/version.rb

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

data/roar-rails.gemspec

@@ -17,13 +17,14 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_runtime_dependency "roar", "~> 0.10"
+  s.add_runtime_dependency "representable", "~> 1.4"
   s.add_runtime_dependency "test_xml"
   s.add_runtime_dependency "actionpack",    "~> 3.0"
   s.add_runtime_dependency "railties",    "~> 3.0"
   s.add_runtime_dependency "hooks"
-  
+
   s.add_development_dependency "minitest",	">= 2.8.1"
   s.add_development_dependency "tzinfo" # FIXME: why the hell do we need this for 3.1?
 end

data/test/responder_test.rb

@@ -4,7 +4,7 @@ Singer = Struct.new(:name)
 
 module SingersRepresenter
   include Roar::Representer::JSON
-  
+
   collection :singers, :extend => SingerRepresenter
   def singers
     each
@@ -19,13 +19,13 @@ end
 class RepresentsTest < MiniTest::Spec
   class SingersController
   end
-  
+
   before do
     @controller = Class.new do
       include Roar::Rails::ControllerAdditions
     end.new
   end
-  
+
   describe "representer_for" do
     describe "nothing configured" do
       before do
@@ -34,16 +34,16 @@ class RepresentsTest < MiniTest::Spec
           self
         end.new
       end
-      
+
       it "uses model class" do
         assert_equal SingerRepresenter, @controller.representer_for(:json, Singer.new)
       end
-      
+
       it "uses plural controller name when collection" do
         assert_equal SingersRepresenter, @controller.representer_for(:json, [])
       end
     end
-    
+
     describe "represents :json, Singer" do
       before do
         @controller = class ::WhateverController < ActionController::Base
@@ -52,17 +52,17 @@ class RepresentsTest < MiniTest::Spec
           self
         end.new
       end
-      
+
       it "uses defined class for item" do
         assert_equal ObjectRepresenter, @controller.representer_for(:json, Singer.new)
       end
-      
+
       it "uses plural name when collection" do
         assert_equal ObjectsRepresenter, @controller.representer_for(:json, [])
       end
     end
-    
-    
+
+
     describe "represents :json, :entity => SingerRepresenter" do
       before do
         @controller = class ::FooController < ActionController::Base
@@ -71,16 +71,16 @@ class RepresentsTest < MiniTest::Spec
           self
         end.new
       end
-      
+
       it "returns :entity representer name" do
         assert_equal "ObjectRepresenter", @controller.representer_for(:json, Singer.new)
       end
-      
+
       it "doesn't infer collection representer" do
         assert_equal nil, @controller.representer_for(:json, [])
       end
     end
-    
+
     describe "represents :json, :entity => SingerRepresenter, :collection => SingersRepresenter" do
       before do
         @controller = class ::BooController < ActionController::Base
@@ -89,11 +89,11 @@ class RepresentsTest < MiniTest::Spec
           self
         end.new
       end
-      
+
       it "uses defined class for item" do
         assert_equal "ObjectRepresenter", @controller.representer_for(:json, Singer.new)
       end
-      
+
       it "uses defined class when collection" do
         assert_equal "SingersRepresenter", @controller.representer_for(:json, [])
       end
@@ -104,11 +104,11 @@ end
 
 class ResponderTest < ActionController::TestCase
   include Roar::Rails::TestCase
-  
+
   class BaseController < ActionController::Base
     include Roar::Rails::ControllerAdditions
     respond_to :json
-    
+
     def execute
       instance_exec &@block
     end
@@ -138,16 +138,16 @@ class ResponderTest < ActionController::TestCase
         singer = Singer.new("Bumi")
         respond_with singer
       end
-      
+
       assert_equal singer.to_json, @response.body
     end
-    
+
     test "responder finds SingersRepresenter for collections by convention" do
       get do
         singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
         respond_with singers
       end
-      
+
       assert_equal({:singers => singers.collect {|s| s.extend(SingerRepresenter).to_hash }}.to_json, @response.body)
     end
 
@@ -165,68 +165,90 @@ class ResponderTest < ActionController::TestCase
     class SingersController < BaseController
       represents :json, Object
     end
-    
+
     tests SingersController
-    
+
     test "responder uses passed representer" do
       get do
         singer = Singer.new("Bumi")
         respond_with singer, :represent_with => SingerRepresenter
       end
-      
+
       assert_equal singer.to_json, @response.body
     end
-    
+
     test "responder uses passed 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 "responder uses passed representer for collection items when :represent_items_with set" 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
   end
-  
+
   class ConfiguredControllerTest < ResponderTest
     class MusicianController < BaseController
       represents :json, :entity => SingerRepresenter, :collection => SingersRepresenter
     end
-    
+
     tests MusicianController
-    
+
     test "responder uses configured representer" do
       get do
         singer = Singer.new("Bumi")
         respond_with singer
       end
-      
+
       assert_equal singer.to_json, @response.body
     end
-    
+
     test "responder uses configured representer for collection" do
       get do
         singers = [Singer.new("Bumi"), Singer.new("Bjork"), Singer.new("Sinead")]
         respond_with singers
       end
-      
+
       assert_equal({:singers => singers.collect {|s| s.extend(SingerRepresenter).to_hash }}.to_json, @response.body)
     end
   end
-  
+
+  class ControllerWithDecoratorTest < ResponderTest
+    class SingerRepresentation < Representable::Decorator
+      include Roar::Representer::JSON
+      include ::SingerRepresenter
+    end
+    class MusicianController < BaseController
+      represents :json, :entity => SingerRepresentation
+    end
+
+    tests MusicianController
+
+    test "responder uses configured decorating representer" do
+      get do
+        singer = Singer.new("Bumi")
+        respond_with singer
+      end
+
+      assert_equal "{\"name\":\"Bumi\"}", @response.body
+    end
+  end
+
+
   def get(&block)
     @controller.instance_eval do
       @block = block
     end
-    
+
     super :execute, :format => 'json'
   end
 
@@ -236,7 +258,7 @@ class ResponderTest < ActionController::TestCase
     end
     super :execute, :format => 'json'
   end
-  
+
   def singer(name="Bumi")
     singer = Musician.new(name)
     singer.extend SingerRepresenter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: test_xml
   requirement: !ruby/object:Gem::Requirement