roar-rails 0.0.14 → 0.0.15

data/CHANGES.markdown

@@ -1,3 +1,9 @@
+h2. 0.0.14
+
+* Moved logic to infer representer names from `ControllerAdditions` to `RepresenterComputer` class.
+* Representer names passed to `::represents` are now constantized at runtime where they are actually needed, only. This fixes a bug where you were required to provide a `SingersRepresenter` (for collections) everywhere even when you just want to represent singular resources.
+* You can now pass strings to `::represents` as representer names.
+
 h2. 0.0.13
 
 * Allow passing user options to both `#respond_with` and `#consume!`.

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in roar-rails.gemspec
 gemspec
+
+group :test do
+  gem 'roar', ">= 0.11.17"
+end

data/README.markdown

@@ -45,7 +45,7 @@ end
 
 ### Represents Configuration
 
-If you don't want to use conventions or pass representers you can configure them on the class level using `#represents`. This will also call `respond_to` for you.
+If you don't want to use conventions or pass representers you can configure them on the class level using `::represents`. This will also call `respond_to` for you.
 
 ```ruby
 class SingersController < ApplicationController
@@ -53,13 +53,16 @@ class SingersController < ApplicationController
 ```
 This will use the `MusicianRepresenter` for models and `MusiciansRepresenter` for representing collections.
 
-Note that `#represents` also allows fine-tuning.
+Note that `::represents` also allows fine-tuning.
 
 ```ruby
 class SingersController < ApplicationController
   represents :json, :entity => MusicianRepresenter, :collection => MusicianCollectionRepresenter
 ```
 
+You might pass strings as representer names to `::represents`, they will be constantized at run-time when needed.
+
+
 ### Old API Support
 
 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.
@@ -110,16 +113,22 @@ 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.
+If you prefer roar's decorator approach over extend, just go for it. roar-rails will figure out automatically which represent strategy to use. Be sure to use roar >= 0.11.17.
 
 ```ruby
 class SingerRepresenter < Roar::Decorator
   include Roar::Representer::JSON
 
   property :name
+
+  link :self do
+    singer_url(represented)
+  end
 end
 ```
 
+In decorators' link blocks you currently have to use `represented` to get the actual represented model (this is `self` in module representers).
+
 ## Passing Options
 
 Both rendering and consuming support passing user options to the representer.

data/gemfiles/Gemfile.rails3-0

@@ -4,3 +4,4 @@ source "http://rubygems.org"
 gemspec :path => '../'
 
 gem 'railties', '~> 3.0.11'
+gem 'roar', 	">= 0.11.17"

data/gemfiles/Gemfile.rails3-2

@@ -4,3 +4,4 @@ source "http://rubygems.org"
 gemspec :path => '../'
 
 gem 'railties', '~> 3.2.0'
+gem 'roar', 	">= 0.11.17"

data/gemfiles/Gemfile.rails4-0

@@ -7,3 +7,4 @@ gem 'railties', '~> 4.0.0.beta1'
 gem 'actionpack', '~> 4.0.0.beta1'
 
 gem 'activemodel', '~> 4.0.0.beta1'
+gem 'roar', ">= 0.11.17"

data/lib/roar-rails.rb

@@ -1,5 +1,6 @@
 require "roar/rails/version"
 require "roar/representer"
+require "roar/decorator"
 require "roar/rails/railtie"
 
 module Roar::Representer
@@ -10,7 +11,6 @@ module Roar::Representer
     autoload("HAL", "roar/representer/json/hal")
   end
 
-
   module Feature
     autoload("Hypermedia", "roar/representer/feature/hypermedia")
   end

data/lib/roar/rails/controller_additions.rb

@@ -8,7 +8,7 @@ module Roar::Rails
     included do
       extend Hooks::InheritableAttribute
       inheritable_attr :represents_options
-      self.represents_options ||= {}
+      self.represents_options ||= RepresenterComputer.new
     end
 
 
@@ -17,20 +17,8 @@ module Roar::Rails
         Class.new(super).send :include, Roar::Rails::Responder
       end
 
-      def add_representer_suffix(prefix)
-        "#{prefix}Representer"
-      end
-
       def represents(format, options)
-        unless options.is_a?(Hash)
-          model = options
-          options = {
-            :entity     => add_representer_suffix(model.name).constantize,
-            :collection => add_representer_suffix(model.name.pluralize).constantize
-          }
-        end
-
-        represents_options[format] = options
+        represents_options.add(format,options)
         respond_to format
       end
     end
@@ -51,7 +39,7 @@ module Roar::Rails
 
     # Central entry-point for finding the appropriate representer.
     def representer_for(format, model, options={})
-      options.delete(:represent_with) || representer_name_for(format, model)
+      options.delete(:represent_with) || self.class.represents_options.for(format, model, controller_path)
     end
 
   private
@@ -63,15 +51,44 @@ module Roar::Rails
       request.body.read
     end
 
-    def representer_name_for(format, model)  # DISCUSS: should we pass and process options here?
-      if self.class.represents_options[format.to_sym].blank?  # TODO: test to_sym?
-        model_name = model.class.name
-        model_name = controller_path.camelize if model.kind_of?(Array)
-        return self.class.add_representer_suffix(model_name).constantize
+
+    class RepresenterComputer < Hash
+      def add(format, opts)
+        # FIXME: use controller_path here as well!
+        # by pre-computing the representer name we allow "one-step inheritance": if B doesn't call ::represents it "inherits" A's settings.
+        unless opts.is_a?(Hash)
+          model = opts
+          opts = {
+            :entity     => add_representer_suffix(model.name),
+            :collection => add_representer_suffix(model.name.pluralize)
+          }
+        end
+
+        self[format] = opts
       end
 
-      return self.class.represents_options[format][:collection] if model.kind_of?(Array)
-      self.class.represents_options[format][:entity]
+      def for(*args)
+        name = name_for(*args) or return
+
+        return name if name.is_a?(Module) # i hate is_a? but this is really handy here.
+        name.constantize
+      end
+
+    private
+      def name_for(format, model, controller_path)  # DISCUSS: should we pass and process options here?
+        if self[format.to_sym].blank?  # TODO: test to_sym?
+          model_name = model.class.name
+          model_name = controller_path.camelize if model.kind_of?(Array)
+          return add_representer_suffix(model_name).constantize
+        end
+
+        return self[format][:collection] if model.kind_of?(Array)
+        self[format][:entity]
+      end
+
+      def add_representer_suffix(prefix)
+        "#{prefix}Representer"
+      end
     end
   end
 end

data/lib/roar/rails/version.rb

@@ -1,5 +1,5 @@
 module Roar
   module Rails
-    VERSION = "0.0.14"
+    VERSION = "0.0.15"
   end
 end

data/test/dummy/app/controllers/bands_controller.rb

@@ -0,0 +1,10 @@
+Band = Struct.new(:name)
+
+class BandsController < ActionController::Base
+  include Roar::Rails::ControllerAdditions
+  represents :json, Band
+
+  def show
+    respond_with Band.new("Bodyjar")
+  end
+end

data/test/dummy/app/representers/band_representer.rb

@@ -0,0 +1,10 @@
+class BandRepresenter < Roar::Decorator
+  include Roar::Representer::JSON
+  include Roar::Representer::Feature::Hypermedia
+
+  property :name
+
+  link :self do
+    band_url(represented.name)
+  end
+end

data/test/dummy/config/environments/test.rb

@@ -29,6 +29,6 @@ Dummy::Application.configure do
   # This is necessary if your schema can't be completely dumped by the schema dumper,
   # like if you have constraints or database-specific column types
   # config.active_record.schema_format = :sql
-  
-  config.representer.default_url_options = {:host => "http://roar.apotomo.de"}
+
+  config.representer.default_url_options = {:host => "roar.apotomo.de"}
 end

data/test/dummy/config/routes.rb

@@ -4,4 +4,5 @@ Dummy::Application.routes.draw do
   put ':controller(/:action(/:id(.:format)))'
   delete ':controller(/:action(/:id(.:format)))'
   resources :singers
+  resources :bands
 end

data/test/representer_computer_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+module ObjectRepresenter
+end
+module ObjectsRepresenter
+end
+
+class RepresenterComputerTest < MiniTest::Spec
+  let (:subject) { Roar::Rails::ControllerAdditions::RepresenterComputer.new }
+
+  describe "nothing configured" do
+
+
+    it "uses model class" do
+      subject.for(:json, Singer.new, "bands").must_equal SingerRepresenter
+    end
+
+    it "uses plural controller name when collection" do
+      subject.for(:json, [Singer.new], "objects").must_equal ObjectsRepresenter
+    end
+  end
+
+  describe "represents :json, Singer" do
+    before { subject.add(:json, Object) }
+
+    it "uses defined class for item" do
+      subject.for(:json, Singer.new, "bands").must_equal ObjectRepresenter
+    end
+
+    it "uses plural name when collection" do
+      subject.for(:json, [], "bands").must_equal ObjectsRepresenter
+    end
+  end
+
+  describe "represents :json, :entity => SingerRepresenter" do
+    before { subject.add(:json, :entity => ObjectRepresenter) }
+
+    it "returns :entity representer constant" do
+      subject.for(:json, Singer.new, "bands").must_equal ObjectRepresenter
+    end
+
+    it "doesn't infer collection representer" do
+      subject.for(:json, [], "bands").must_equal nil
+    end
+  end
+
+  describe "represents :json, :entity => SingerRepresenter, :collection => SingersRepresenter" do
+    before { subject.add(:json, :entity     => ObjectRepresenter,
+                                :collection => SingersRepresenter) }
+
+    it "returns :entity representer constant" do
+      subject.for(:json, Singer.new, "bands").must_equal ObjectRepresenter
+    end
+
+    it "doesn't infer collection representer" do
+      subject.for(:json, [], "bands").must_equal SingersRepresenter
+    end
+  end
+
+  describe "#add" do
+    it "doesn't constantize" do
+      subject.add(:json, :entity => "ObjectRepresenter")
+      subject.send(:name_for, :json, Object.new, "bands").must_equal "ObjectRepresenter"
+    end
+  end
+
+  describe "#for" do
+    it "constantizes strings" do
+      subject.add(:json, :entity => "ObjectRepresenter")
+      subject.for(:json, Object.new, "bands").must_equal ObjectRepresenter
+    end
+  end
+end

data/test/representer_test.rb

@@ -7,12 +7,12 @@ class RepresenterTest < ActionController::TestCase
 
   test "representers can use URL helpers" do
     get :show, :id => "bumi"
-    assert_body "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://http://roar.apotomo.de/singers/Bumi\"}]}"
+    assert_body "{\"name\":\"Bumi\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/singers/Bumi\"}]}"
   end
 
   test "it works with uninitialized config.representer.default_url_options" do
     url_options = Rails.application.config.representer.default_url_options
-    
+
     begin
       Rails.application.config.representer.default_url_options = nil
       assert_raises RuntimeError, ArgumentError do
@@ -21,7 +21,19 @@ class RepresenterTest < ActionController::TestCase
       assert $!.message =~ /Missing host to link to/
     rescue
     ensure
-      Rails.application.config.representer.default_url_options = url_options    
+      Rails.application.config.representer.default_url_options = url_options
     end
   end
 end
+
+
+class DecoratorTest < ActionController::TestCase
+  include Roar::Rails::TestCase
+
+  tests BandsController
+
+  test "it renders URLs using the decorator" do
+    get :show, :id => 1, :format => :json
+    assert_body "{\"name\":\"Bodyjar\",\"links\":[{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de/bands/Bodyjar\"}]}"
+  end
+end

data/test/responder_test.rb

@@ -11,96 +11,6 @@ module SingersRepresenter
   end
 end
 
-module ObjectRepresenter
-end
-module ObjectsRepresenter
-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
-        @controller = class ::SingersController
-          include Roar::Rails::ControllerAdditions
-          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
-          include Roar::Rails::ControllerAdditions
-          represents :json, Object
-          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
-          include Roar::Rails::ControllerAdditions
-          represents :json, :entity => "ObjectRepresenter"
-          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
-          include Roar::Rails::ControllerAdditions
-          represents :json, :entity => "ObjectRepresenter", :collection => "SingersRepresenter"
-          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
-    end
-  end
-end
-
 
 class ResponderTest < ActionController::TestCase
   include Roar::Rails::TestCase
@@ -114,15 +24,26 @@ class ResponderTest < ActionController::TestCase
     end
   end
 
-  class UniqueRepresentsOptionsTest < ResponderTest
+  class UniqueRepresentsOptionsTest < MiniTest::Spec
     class One < BaseController
       represents :json, Object
     end
     class Two < BaseController
       represents :json, Singer
     end
-    test "each subclass of a roar-augmented controller can represent different things" do
-      assert_not_equal One.represents_options, Two.represents_options
+
+    it "each subclass of a roar-augmented controller can represent different things" do
+      One.represents_options.wont_equal Two.represents_options
+    end
+
+    it "does not share RepresenterComputer instances when inheriting" do
+      Class.new(One) do
+        represents :json, Singer
+      end.represents_options.wont_equal One.represents_options
+    end
+
+    it "inherits when subclass doesn't call ::represents" do
+      Class.new(One).represents_options.must_equal One.represents_options
     end
   end
 
@@ -139,7 +60,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer
       end
 
-      assert_equal singer.to_json, @response.body
+      @response.body.must_equal singer.to_json
     end
 
     test "responder finds SingersRepresenter for collections by convention" do
@@ -209,7 +130,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer
       end
 
-      assert_equal singer.to_json, @response.body
+      @response.body.must_equal singer.to_json
     end
 
     test "responder uses configured representer for collection" do
@@ -259,13 +180,13 @@ class ResponderTest < ActionController::TestCase
 
   class PassingUserOptionsTest < ResponderTest
     # FIXME: should be in generic roar-rails test.
-    module SingerRepresenter
+    module DynamicSingerRepresenter
       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
+      represents :json, :entity => DynamicSingerRepresenter, :collection => SingersRepresenter
     end
 
     tests MusicianController
@@ -281,7 +202,7 @@ class ResponderTest < ActionController::TestCase
 
     test "passes options to explicit collection representer" do
       get do
-        respond_with [Singer.new("Bumi"), Singer.new("Iggy")], :title => "Mr.", :represent_items_with => SingerRepresenter
+        respond_with [Singer.new("Bumi"), Singer.new("Iggy")], :title => "Mr.", :represent_items_with => DynamicSingerRepresenter
       end
 
       @response.body.must_equal("[{\"name\":\"Mr. Bumi\"},{\"name\":\"Mr. Iggy\"}]")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -186,8 +186,10 @@ files:
 - test/consume_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/bands_controller.rb
 - test/dummy/app/controllers/singers_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/representers/band_representer.rb
 - test/dummy/app/representers/singer_alias_representer.rb
 - test/dummy/app/representers/singer_representer.rb
 - test/dummy/app/views/layouts/application.html.erb
@@ -219,6 +221,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/representer_computer_test.rb
 - test/representer_test.rb
 - test/responder_test.rb
 - test/test_case_test.rb