roar-rails 0.1.0 → 0.1.1

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
   - 1.9.3
+  - 2.0.0
 gemfile:
   - Gemfile
   - gemfiles/Gemfile.rails3-0

data/CHANGES.markdown

@@ -1,3 +1,7 @@
+h2. 0.1.1
+
+* Added the `represented_formats: [...]` option to be passed to `#respond_with` for either suppressing roar-rails from extending/decorating models when rendering or to fine-tune so this will only happen on white-listed formats as `:hal`. This can also be set globally using `config.representer.represented_formats`.
+
 h2. 0.1.0
 
 * `ActiveRecord::Relation` is now detected as a collection and the appropriate representer should be found.

data/Gemfile

@@ -4,5 +4,7 @@ source "http://rubygems.org"
 gemspec
 
 group :test do
-  gem 'roar', ">= 0.11.17"
+  #gem 'roar', path: "../roar" #">= 0.11.17"
+  #gem 'representable', path: "../representable"
+  gem 'rake', '10.1.0'
 end

data/README.markdown

@@ -145,6 +145,16 @@ Same goes with `#consume!`, passing options to `from_json`.
 consume! Singer.new, :current_user => current_user
 ```
 
+Note: If you pass in options to a representer, you must process them youself.  For rendering, use `:getter` in the representer.
+
+```ruby
+property :username, getter: lambda { |args| args[:current_user].name }
+```
+
+That'll render the `current_user`'s name as the `username` property.
+
+More docs about passing and processing option can be found [here](https://github.com/apotonick/representable/#passing-options).
+
 
 ## URL Helpers
 
@@ -168,6 +178,39 @@ config.representer.default_url_options = {:host => "127.0.0.1:3000"}
 
 Attention: If you are using representers from a gem your Rails URL helpers might not work in these modules. This is due to a [loading order problem](https://groups.google.com/forum/?fromgroups#!topic/rubyonrails-core/5tG5unZ8jDQ) in Rails. As a workaround, don't require the representers in the gem but load them as lately as possible, usually it works when you require in the controller. We are working on fixing that problem.
 
+## Representing Formats Exclusively
+
+By default, roar-rails will extend/decorate any model passed to `respond_with` for any request format. When adding roar-rails to a legacy project, you might want to restrict roar-rails' representing and fall back to the old behavior for certain formats. This can be configured both globally and on a per action basis.
+
+To restrict representing globally to a particular format you can set the `config.representer.represented_formats` in your environment's configuration to an array of formats.  For example the following will only represent hal and json requests.
+
+```ruby
+config.representer.represented_formats = [:hal, :json]
+```
+
+The global configuration (or lack thereof) can be overridden by supplying the `:represented_formats` array when calling `respond_with`.  The following will only represent `@resource` for the hal format in the `show` action. For any other format, it will expose the resource using Rails' old behavior.
+
+
+```ruby
+class MyController < ApplicationController
+  def show
+    ...
+    respond_with @resource, :represented_formats => [:hal]
+  end
+end
+```
+
+You can entirely suppress roar-rails in `respond_with` by passing in an empty array.
+
+```ruby
+class MyController < ApplicationController
+  def show
+    ...
+    respond_with @resource, :represented_formats => []
+  end
+end
+```
+
 ## Testing
 
 ## Autoloading
@@ -183,4 +226,4 @@ Put your representers in `app/representers` and they will be autoloaded by Rails
 
 ## License
 
-Roar-rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+Roar-rails is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/gemfiles/Gemfile.rails3-2

@@ -3,5 +3,8 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in roar-rails.gemspec
 gemspec :path => '../'
 
-gem 'railties', '~> 3.2.0'
+
+gem 'railties', '~> 3.2.13'
+gem 'activerecord', '~> 3.2.13'
+
 gem 'roar', 	">= 0.11.17"

data/gemfiles/Gemfile.rails4-0

@@ -3,10 +3,10 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in roar-rails.gemspec
 gemspec :path => '../'
 
-gem 'railties', '~> 4.0.0.beta1'
-gem 'actionpack', '~> 4.0.0.beta1'
+gem 'railties', '~> 4.0.0'
+gem 'actionpack', '~> 4.0.0'
 
-gem 'activemodel', '~> 4.0.0.beta1'
-gem 'activerecord', '~> 4.0.0.beta1'
+gem 'activemodel', '~> 4.0.0'
+gem 'activerecord', '~> 4.0.0'
 
 gem 'roar', ">= 0.11.17"

data/lib/roar-rails.rb

@@ -8,7 +8,7 @@ module Roar::Representer
   autoload("JSON", "roar/representer/json")
 
   module JSON
-    autoload("HAL", "roar/representer/json/hal")
+    autoload("HAL", "roar/rails/hal")
   end
 
   module Feature

data/lib/roar/rails/controller_additions.rb

@@ -51,6 +51,15 @@ module Roar::Rails
       request.body.read
     end
 
+    def render_to_body(options)
+      if res = options[formats.first] and res.is_a?(Roar::Rails::Responder::Response)
+        response.content_type = res.content_type
+        return res.body
+      end
+
+      super
+    end
+
 
     class RepresenterComputer < Hash
       def add(format, opts)

data/lib/roar/rails/hal.rb

@@ -0,0 +1,6 @@
+require 'roar/representer/json/hal'
+
+Roar::Representer::JSON::HAL.class_eval do
+  def to_hal(*args);   to_json(*args);   end
+  def from_hal(*args); from_json(*args); end
+end

data/lib/roar/rails/responder.rb

@@ -1,23 +1,54 @@
 module Roar::Rails
   module Responder
     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
+      if represent_format?
+        handle_lonely_collection!(model) and return super # :represent_items_with
 
-      model = prepare_model_for(format, model, options)
+        model = prepare_model_for(format, model, options)
+      end
 
-      super
+      super(create_response(model), *args) # AC::Responder: this calls controller.render which calls render_to_body which calls renderer[:json] which calls model.to_json.
     end
 
   private
-    def render_items_with(collection, representer)
+
+    def default_represented_formats
+      Rails.application.config.representer.represented_formats
+    end
+
+    # First check for user option overrides, then check for defaults, then trigger
+    # previous behavior and always represent for the requested format.
+    def represent_format?
+      formats = Array((options[:represented_formats] || default_represented_formats || [format]))
+      formats.include?(format)
+    end
+
+    def resourceful?
+      # FIXME: find out if we have a representer? what about old behaviour?
+      #resource.respond_to?("to_#{format}")
+      true
+    end
+
+    def create_response(model)
+      render_method = "to_#{format}"
+      media_format  = Mime[format]
+      Response.new(model.send(render_method, options), media_format)
+    end
+
+    def handle_lonely_collection!(collection)
+      return false unless representer = options.delete(:represent_items_with)
+
+      setup_items_with(collection, representer) # convenience API, not recommended since it's missing hypermedia.
+      true
+    end
+
+    def setup_items_with(collection, representer)
       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)
@@ -25,5 +56,15 @@ module Roar::Rails
     end
     include PrepareModel
     include VersionStrategy
+
+
+    class Response
+      attr_reader :content_type, :body # DISCUSS: how to add more header fields? #headers?
+
+      def initialize(body, content_type)
+        @body         = body
+        @content_type = content_type
+      end
+    end
   end
 end

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/roar-rails.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "roar",          "~> 0.11.13"
-  s.add_runtime_dependency "representable", "~> 1.4"
   s.add_runtime_dependency "test_xml",      ">= 0.1.6"  # TODO: remove dependency as most people don't use XML.
   s.add_runtime_dependency "actionpack"
   s.add_runtime_dependency "railties",      ">= 3.0.0"

data/test/json_hal_renderer_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+Mime::Type.register 'application/json+hal', :hal
+class HalRendererTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  class SingersController < ActionController::Base
+    module HalSingerRepresenter
+      include Roar::Representer::JSON::HAL
+
+      property :name
+      link(:self) { "http://#{name}" }
+    end
+
+    include Roar::Rails::ControllerAdditions
+    represents :hal, :entity => HalSingerRepresenter
+
+    def show
+      singer = Musician.new("Bumi")
+      respond_with singer
+    end
+  end
+
+  tests SingersController
+
+  test "should render correctly in response to a application/json+hal request" do
+    get :show, :id => "bumi", :format => :hal
+    assert_body '{"name":"Bumi","_links":{"self":{"href":"http://Bumi"}}}'
+  end
+
+  test "should have a content_type of application/json+hal" do
+    get :show, :id => "bumi", :format => :hal
+    assert_equal response.content_type, 'application/json+hal'
+  end
+end

data/test/responder_test.rb

@@ -45,6 +45,117 @@ class ResponderTest < ActionController::TestCase
     end
   end
 
+  class JsonResponseTest < ResponderTest
+    SingerRepresenter  = ::SingerRepresenter
+    class SingersController < BaseController
+    end
+    tests SingersController
+
+    test "set Content-type to json" do
+      get do
+        singer = Singer.new("Bumi")
+        respond_with singer
+      end
+
+      @response.body.must_equal "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/singers/Bumi\"}]}"
+      @response.headers["Content-Type"].must_match "application/json"
+    end
+  end
+
+  class SuppressingRepresenterForFormatTest < ResponderTest
+    class SingersController < BaseController
+    end
+    tests SingersController
+
+    test "returns non-represented json of model by falling back to Rails default responding when supressed in respond_with" do
+      singer = Singer.new('Bumi')
+
+      get do
+        respond_with singer, :represented_formats => []
+      end
+
+      assert_equal bumi_json, @response.body
+    end
+  end
+
+  class ProvidingRepresenterForFormatTest < ResponderTest
+    SingerRepresenter  = ::SingerRepresenter
+    class SingersController < BaseController
+      represents :json, :entity => SingerRepresenter
+    end
+    tests SingersController
+
+    test "returns represented json of model when set in respond_with" do
+      singer = Singer.new('Bumi')
+
+      get do
+        respond_with singer, :represented_formats => [:json]
+      end
+
+      assert_equal %{{"name":"Bumi","links":[{"rel":"self","href":"http://roar.apotomo.de/singers/Bumi"}]}}, @response.body
+    end
+
+    test "return represented json model by using configured default" do
+      singer = Singer.new('Bumi')
+
+      Rails.application.config.representer.represented_formats = [:json]
+      get do
+        respond_with singer
+      end
+      Rails.application.config.representer.represented_formats = nil
+
+      assert_equal %{{"name":"Bumi","links":[{"rel":"self","href":"http://roar.apotomo.de/singers/Bumi"}]}}, @response.body
+    end
+
+    test "return non-represented json model by falling back to Rails default responding when supressed in the configuration" do
+      singer = Singer.new('Bumi')
+
+      Rails.application.config.representer.represented_formats = []
+      get do
+        respond_with singer
+      end
+      Rails.application.config.representer.represented_formats = nil
+
+      assert_equal bumi_json, @response.body
+    end
+
+    test "represented_formats passed to respond_with override global directive" do
+      singer = Singer.new('Bumi')
+
+      Rails.application.config.representer.represented_formats = [:hal]
+      get do
+        respond_with singer, :represented_formats => [:json]
+      end
+      Rails.application.config.representer.represented_formats = nil
+
+      assert_equal %{{"name":"Bumi","links":[{"rel":"self","href":"http://roar.apotomo.de/singers/Bumi"}]}}, @response.body
+    end
+  end
+
+  class XmlResponseTest < ResponderTest
+    module SingerRepresenter
+      include Roar::Representer::XML
+
+      property :name
+      self.representation_wrap = :singer
+    end
+
+    class SingersController < BaseController
+      respond_to :xml
+    end
+    tests SingersController
+
+    test "set Content-type to xml" do
+      get :xml do
+        singer = Singer.new("Bumi")
+        respond_with singer
+      end
+
+      @response.body.must_equal_xml '<singer><name>Bumi</name></singer>'
+      @response.headers["Content-Type"].must_match "application/xml"
+    end
+  end
+
   class UnconfiguredControllerTest < ResponderTest
     SingersRepresenter = ::SingersRepresenter
     SingerRepresenter  = ::SingerRepresenter
@@ -60,7 +171,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer
       end
 
-      @response.body.must_equal singer.to_json
+      @response.body.must_equal "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/singers/Bumi\"}]}"
     end
 
     test "responder finds SingersRepresenter for collections by convention" do
@@ -95,7 +206,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer, :represent_with => SingerRepresenter
       end
 
-      assert_equal singer.to_json, @response.body
+      @response.body.must_equal "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/singers/Bumi\"}]}"
     end
 
     test "responder uses passed representer for collection" do
@@ -130,7 +241,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer
       end
 
-      @response.body.must_equal singer.to_json
+      @response.body.must_equal "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/singers/Bumi\"}]}"
     end
 
     test "responder uses configured representer for collection" do
@@ -224,21 +335,37 @@ class ResponderTest < ActionController::TestCase
     end
   end
 
+  class FallbackTest < ResponderTest
+    class MusicianController < BaseController
+      represents :json, Object
+    end
 
+    tests MusicianController
 
-  def get(&block)
+    test "passes options to entity representer" do
+      get do
+        render :text => "Rendered template"
+      end
+
+      @response.body.must_equal("Rendered template")
+    end
+  end
+
+
+
+  def get(format=:json, &block)
     @controller.instance_eval do
       @block = block
     end
 
-    super :execute, :format => 'json'
+    super :execute, :format => format
   end
 
-  def put(body="", &block)
+  def put(body="", format=:json, &block)
     @controller.instance_eval do
       @block = block
     end
-    super :execute, body, :format => 'json'
+    super :execute, body, :format => format
   end
 
   def singer(name="Bumi")
@@ -249,4 +376,9 @@ class ResponderTest < ActionController::TestCase
   def singers
     [singer("Bumi"), singer("Bjork"), singer("Sinead")]
   end
+
+  def bumi_json
+    return "[\"Bumi\"]" if Roar::Rails.rails3_0?
+    "{\"name\":\"Bumi\"}"
+  end
 end

data/test/test_helper.rb

@@ -1,8 +1,6 @@
-require 'bundler'
-Bundler.setup
-
 require 'test/unit'
 require 'minitest/spec'
+require 'test_xml/mini_test'
 
 ENV['RAILS_ENV'] = 'test'
 require "dummy/config/environment"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -27,22 +27,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.11.13
-- !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
@@ -206,6 +190,7 @@ files:
 - gemfiles/Gemfile.rails4-0
 - lib/roar-rails.rb
 - lib/roar/rails/controller_additions.rb
+- lib/roar/rails/hal.rb
 - lib/roar/rails/rails3_0_strategy.rb
 - lib/roar/rails/rails3_1_strategy.rb
 - lib/roar/rails/railtie.rb
@@ -254,6 +239,7 @@ files:
 - test/dummy/script/rails
 - test/dummy/tmp/app/cells/blog/post/latest.html.erb
 - test/dummy/tmp/app/cells/blog/post_cell.rb
+- test/json_hal_renderer_test.rb
 - test/representer_computer_test.rb
 - test/representer_test.rb
 - test/responder_test.rb