roar-rails 0.0.15 → 0.1.0

data/CHANGES.markdown

@@ -1,3 +1,9 @@
+h2. 0.1.0
+
+* `ActiveRecord::Relation` is now detected as a collection and the appropriate representer should be found.
+* Entity (singular) representers are now correctly infered even if you only specified `collection:` in `::represents`. That works by querying the model.
+* Entity representers are now *namespaced* when guessed (i.e., when you didn't specify them explicitly in `::represents`) as it works with collection representers already. If you have a namespaced controller and it suddenly doesn't find its entity representer anymore, either namespace the representer or specify its name in `::represents`.
+
 h2. 0.0.14
 
 * Moved logic to infer representer names from `ControllerAdditions` to `RepresenterComputer` class.

data/gemfiles/Gemfile.rails3-0

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

data/gemfiles/Gemfile.rails4-0

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

data/lib/roar-rails.rb

@@ -21,7 +21,7 @@ end
 module Roar
   module Rails
     def self.rails3_0?
-      ::Rails::VERSION::MINOR == 0
+      ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR == 0
     end
 
     if rails3_0?

data/lib/roar/rails/controller_additions.rb

@@ -57,10 +57,10 @@ module Roar::Rails
         # 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
+          model_name = opts.name.underscore
           opts = {
-            :entity     => add_representer_suffix(model.name),
-            :collection => add_representer_suffix(model.name.pluralize)
+            :entity     => add_representer_suffix(model_name),
+            :collection => add_representer_suffix(model_name.pluralize)
           }
         end
 
@@ -71,23 +71,57 @@ module Roar::Rails
         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
+        name.camelize.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
+      def [](format)
+        super(format.to_sym) or {}
+      end
+
+      def name_for(format, model, controller_path) # DISCUSS: should we pass and process options here?
+        controller_path = Path.new(controller_path) # DISCUSS: could that be done in the initialization, maybe?
+        options         = self[format]
+
+        if detect_collection(model)
+          options[:collection] or collection_representer(format, model, controller_path)
+        else
+          options[:entity] or entity_representer(format, model, controller_path)
+        end
+      end
+
+      def collection_representer(format, model, controller_path)
+        infer_representer(controller_path)
+      end
+
+      def entity_representer(format, model, controller_path)
+        model_name = model.class.name.underscore
+
+        if namespace = controller_path.namespace
+          model_name = "#{namespace}/#{model_name}"
         end
 
-        return self[format][:collection] if model.kind_of?(Array)
-        self[format][:entity]
+        infer_representer(model_name)
+      end
+
+      def infer_representer(model_name)
+        add_representer_suffix(model_name).camelize.constantize
       end
 
       def add_representer_suffix(prefix)
-        "#{prefix}Representer"
+        "#{prefix}_representer"
+      end
+
+      def detect_collection(model)
+        return true if model.kind_of?(Array)
+        return true if Object.const_defined?("ActiveRecord") and model.kind_of?(ActiveRecord::Relation)
+      end
+
+      class Path < String
+        def namespace
+          return unless ns = self.match(/(.+)\/\w+$/)
+          ns[1]
+        end
       end
     end
   end

data/lib/roar/rails/railtie.rb

@@ -9,7 +9,7 @@ module Roar
       initializer "roar.set_configs" do |app|
         ::Roar::Representer.module_eval do
           include app.routes.url_helpers
-          include app.routes.mounted_helpers unless ::Rails::VERSION::MINOR == 0
+          include app.routes.mounted_helpers unless Roar::Rails.rails3_0?
           
           include UrlMethods  # provide an initial #default_url_options.
         end

data/lib/roar/rails/test_case.rb

@@ -1,6 +1,14 @@
+if ::ActionPack::VERSION::MAJOR == 4
+  require 'test_xml/mini_test'
+else
+  require 'test_xml/test_unit'
+end
+
 module Roar
   module Rails
     module TestCase
+      include TestXml::Assertions # FIXME: including from test_xml in MiniTest::Test doesn't work with rails 4.
+
       def get(action, *args)
         process(action, "GET", *args)
       end
@@ -29,12 +37,6 @@ module Roar
       end
 
       module Assertions
-        if ::ActionPack::VERSION::MAJOR == 4
-          require 'test_xml/mini_test'
-        else
-          require 'test_xml/test_unit'
-        end
-
         def assert_body(body, options={})
           return assert_xml_equal body, response.body if options[:xml]
           assert_equal body, response.body

data/lib/roar/rails/version.rb

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

data/roar-rails.gemspec

@@ -18,14 +18,16 @@ Gem::Specification.new do |s|
   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 "roar",          "~> 0.11.13"
   s.add_runtime_dependency "representable", "~> 1.4"
-  s.add_runtime_dependency "test_xml"
+  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"
   s.add_runtime_dependency "hooks"
 
-  s.add_development_dependency "minitest",	">= 2.8.1"
+  s.add_development_dependency "minitest",	"~> 4.0"
   s.add_development_dependency "activemodel"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "sqlite3"
   s.add_development_dependency "tzinfo" # FIXME: why the hell do we need this for 3.1?
 end

data/test/consume_test.rb

@@ -1,77 +1,72 @@
 require 'test_helper'
 
+class UnnamespaceSingersController < ActionController::Base
+  include Roar::Rails::ControllerAdditions
+  respond_to :json, :xml
+
+  def consume_json
+    singer = consume!(Singer.new)
+    render :text => singer.inspect
+  end
+end
+
 class ConsumeTest < ActionController::TestCase
   include Roar::Rails::TestCase
-  
-  class SingersController < ActionController::Base
-    include Roar::Rails::ControllerAdditions
-    respond_to :json, :xml
 
-    def consume_json
-      singer = consume!(Singer.new)
-      render :text => singer.to_json
-    end
-  end
+  tests UnnamespaceSingersController
 
-  tests SingersController
-  
   test "#consume parses incoming document and updates the model" do
     post :consume_json, "{\"name\": \"Bumi\"}", :format => 'json'
-    assert_equal singer.to_json, @response.body
-  end
-  
-  def singer(name="Bumi")
-    singer = Musician.new(name)
-    singer.extend SingerRepresenter
+    assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
 end
 
-class ConsumeWithConfigurationTest < ConsumeTest
+class ConsumeWithConfigurationTest < ActionController::TestCase
   include Roar::Rails::TestCase
-  
+
   module MusicianRepresenter
     include Roar::Representer::JSON
     property :name, :from => :called
   end
-  
-  
+
+
   class SingersController < ActionController::Base
     include Roar::Rails::ControllerAdditions
     respond_to :json
-    represents "json", :entity => MusicianRepresenter
+    represents :json, :entity => MusicianRepresenter
 
     def consume_json
       singer = consume!(Singer.new)
-      render :text => singer.to_json
+      render :text => singer.inspect
     end
   end
 
   tests SingersController
-  
-  test "#consume uses #represents config to parse incoming document" do
-    post :consume_json, "{\"name\": \"Bumi\"}", :format => :json
-    assert_equal singer.to_json, @response.body
+
+  test "#consume uses ConsumeWithConfigurationTest::MusicianRepresenter to parse incoming document" do
+    post :consume_json, %{{"called":"Bumi"}}, :format => :json
+    assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
 end
 
-class ConsumeWithOptionsOverridingConfigurationTest < ConsumeTest
+class ConsumeWithOptionsOverridingConfigurationTest < ActionController::TestCase
   include Roar::Rails::TestCase
-  
+
+
   class SingersController < ActionController::Base
     include Roar::Rails::ControllerAdditions
-    respond_to :json
     represents :json, :entity => Object
 
     def consume_json
-      singer = consume!(Singer.new, :represent_with => SingerRepresenter)
-      render :text => singer.to_json
+      singer = consume!(Singer.new, :represent_with => ::ConsumeWithConfigurationTest::MusicianRepresenter)
+      render :text => singer.inspect
     end
   end
 
   tests SingersController
-  
+
   test "#consume uses #represents config to parse incoming document" do
-    post :consume_json, "{\"name\": \"Bumi\"}", :format => :json
-    assert_equal singer.to_json, @response.body
+    post :consume_json, %{{"called":"Bumi"}}, :format => :json
+    assert_equal %{#<struct Singer name="Bumi">}, @response.body
   end
 end

data/test/dummy/app/models/artist.rb

@@ -0,0 +1,2 @@
+class Artist < ActiveRecord::Base
+end

data/test/dummy/config/application.rb

@@ -2,6 +2,7 @@ require File.expand_path('../boot', __FILE__)
 
 require "action_controller/railtie"
 require "action_view/railtie"
+require "active_record/railtie"
 
 Bundler.require
 

data/test/representer_computer_test.rb

@@ -5,12 +5,22 @@ end
 module ObjectsRepresenter
 end
 
+module V1
+  module SingerRepresenter
+  end
+  module BassistRepresenter
+  end
+  module SingersRepresenter
+  end
+end
+
+class Bassist
+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
@@ -39,8 +49,20 @@ class RepresenterComputerTest < MiniTest::Spec
       subject.for(:json, Singer.new, "bands").must_equal ObjectRepresenter
     end
 
-    it "doesn't infer collection representer" do
-      subject.for(:json, [], "bands").must_equal nil
+    it "infer collection representer" do
+      subject.for(:json, [], "singers").must_equal SingersRepresenter
+    end
+  end
+
+  describe "represents :json, :collection => SingersRepresenter only" do
+    before { subject.add(:json, :collection => SingersRepresenter) }
+
+    it "infers entity representer" do
+      subject.for(:json, Singer.new, "bands").must_equal SingerRepresenter
+    end
+
+    it "returns :collection representer" do
+      subject.for(:json, [Singer.new], "singers").must_equal SingersRepresenter
     end
   end
 
@@ -57,6 +79,31 @@ class RepresenterComputerTest < MiniTest::Spec
     end
   end
 
+  describe "namespaces" do
+    describe "unconfigured" do
+      it "returns namespaced entity" do
+        subject.for(:json, Singer.new, "v1/singers").must_equal V1::SingerRepresenter
+      end
+
+      it "returns polymorphic namespaced entity" do
+        subject.for(:json, Bassist.new, "v1/singers").must_equal V1::BassistRepresenter
+      end
+
+      it "returns namespaced collection" do
+        subject.for(:json, [Object.new], "v1/singers").must_equal V1::SingersRepresenter
+      end
+    end
+  end
+
+  describe "with ActiveRecord::Relation" do
+    before { subject.add(:json, :entity     => ObjectRepresenter,
+                                :collection => SingersRepresenter) }
+
+    it "detects collection in form of ActiveRecord::Relation" do
+      subject.for(:json, Artist.find(:all), "artists").must_equal SingersRepresenter
+    end
+  end
+
   describe "#add" do
     it "doesn't constantize" do
       subject.add(:json, :entity => "ObjectRepresenter")
@@ -65,9 +112,27 @@ class RepresenterComputerTest < MiniTest::Spec
   end
 
   describe "#for" do
+    before { subject.add(:json, :entity => "ObjectRepresenter") }
+
     it "constantizes strings" do
-      subject.add(:json, :entity => "ObjectRepresenter")
       subject.for(:json, Object.new, "bands").must_equal ObjectRepresenter
     end
+
+    it "accepts string format" do
+      subject.for("json", Object.new, "bands").must_equal ObjectRepresenter
+    end
+
+    it "returns nil when not present" do
+      skip "not sure what to do when format is unknown"
+      subject.for(:xml, Class.new.new, "bands").must_equal nil
+    end
   end
+end
+
+class PathTest < MiniTest::Spec
+  let (:path) { Roar::Rails::ControllerAdditions::RepresenterComputer::Path }
+
+  it { path.new("bands").namespace.must_equal nil }
+  it { path.new("v1/bands").namespace.must_equal "v1" }
+  it { path.new("api/v1/bands").namespace.must_equal "api/v1" }
 end

data/test/responder_test.rb

@@ -1,7 +1,5 @@
 require 'test_helper'
 
-Singer = Struct.new(:name)
-
 module SingersRepresenter
   include Roar::Representer::JSON
 
@@ -49,6 +47,8 @@ class ResponderTest < ActionController::TestCase
 
   class UnconfiguredControllerTest < ResponderTest
     SingersRepresenter = ::SingersRepresenter
+    SingerRepresenter  = ::SingerRepresenter
+
     class SingersController < BaseController
     end
 
@@ -69,7 +69,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singers
       end
 
-      assert_equal({:singers => singers.collect {|s| s.extend(SingerRepresenter).to_hash }}.to_json, @response.body)
+      @response.body.must_equal({:singers => singers.collect {|s| s.extend(SingerRepresenter).to_hash }}.to_json)
     end
 
     test "responder allows empty response bodies to pass through" do
@@ -146,8 +146,11 @@ class ResponderTest < ActionController::TestCase
   class ControllerWithDecoratorTest < ResponderTest
     class SingerRepresentation < Representable::Decorator
       include Roar::Representer::JSON
+      include Roar::Representer::JSON::HAL
 
       property :name
+
+      link(:self) { "http://singers/#{represented.name}" }
     end
 
     class MusicianController < BaseController
@@ -162,7 +165,7 @@ class ResponderTest < ActionController::TestCase
         respond_with singer
       end
 
-      assert_equal "{\"name\":\"Bumi\"}", @response.body
+      assert_equal %{{"name":"Bumi","_links":{"self":{"href":"http://singers/Bumi"}}}}, @response.body
     end
 
     test "parsing uses decorating representer" do # FIXME: move to controller_test.

data/test/test_case_test.rb

@@ -2,68 +2,68 @@ require 'test_helper'
 
 class TestCaseTest < ActionController::TestCase
   include Roar::Rails::TestCase
-  
+
   class BandController < ActionController::Base
     def show
       render :text => "#{request.body.string}#{params[:id]}"
     end
-    
+
   end
-  
+
   tests BandController
-  
+
   test "allows POST without body" do
     post :show
     assert_equal "", response.body
   end
-  
+
   test "allows POST with options, only" do
     post :show, :id => 1
     assert_equal "1", response.body
   end
-  
+
   test "allows POST with document" do
     post :show, "{}"
     assert_equal "{}", response.body
   end
-  
+
   test "allows POST with document and options" do
     post :show, "{}", :id => 1
     assert_equal "{}1", response.body
   end
-  
+
   test "allows GET" do
     get :show, :id => 1
     assert_equal "1", response.body
   end
-  
+
   test "allows PUT" do
     put :show, "{}", :id => 1
     assert_equal "{}1", response.body
   end
-  
+
   test "allows DELETE" do
     delete :show, "{}", :id => 1
     assert_equal "{}1", response.body
   end
-  
+
   test "#assert_body" do
     get :show, :id => 1
     assert_body "1"
-    
+
     # TODO: check message.
     assert_raises MiniTest::Assertion do
       assert_body "3"
     end
   end
-  
+
   test "#assert_body with xml" do
     @controller.instance_eval do
       def show
         render :text => "<order/>"
       end
     end
-    
+
     get :show
     assert_body "<order></order>", :xml => true
   end

data/test/test_helper.rb

@@ -8,3 +8,5 @@ ENV['RAILS_ENV'] = 'test'
 require "dummy/config/environment"
 require "rails/test_help" # adds stuff like @routes, etc.
 require "roar/rails/test_case"
+
+Singer = Struct.new(:name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.11.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.11.13
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -109,12 +109,44 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,9 +154,9 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -189,6 +221,7 @@ files:
 - test/dummy/app/controllers/bands_controller.rb
 - test/dummy/app/controllers/singers_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/artist.rb
 - test/dummy/app/representers/band_representer.rb
 - test/dummy/app/representers/singer_alias_representer.rb
 - test/dummy/app/representers/singer_representer.rb