josevalim-inherited_resources 0.1

data/test/belongs_to_base_test.rb

@@ -0,0 +1,268 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+# This test file is instead to test the how controller flow and actions
+# using a belongs_to association. This is done using mocks a la rspec.
+#
+class Post
+end
+
+class Comment
+  def self.human_name; 'Comment'; end
+end
+
+class CommentsController < InheritedResources::Base
+  belongs_to :post
+end
+
+# Create a TestHelper module with some helpers
+module CommentTestHelper
+  def setup
+    @controller          = CommentsController.new
+    @controller.request  = @request  = ActionController::TestRequest.new
+    @controller.response = @response = ActionController::TestResponse.new
+  end
+
+  protected
+    def mock_post(stubs={})
+      @mock_post ||= mock(stubs)
+    end
+
+    def mock_comment(stubs={})
+      @mock_comment ||= mock(stubs)
+    end
+end
+
+class IndexActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_expose_all_comments_as_instance_variable
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with(:all).returns([mock_comment])
+    get :index, :post_id => '37'
+    assert_equal mock_post, assigns(:post)
+    assert_equal [mock_comment], assigns(:comments)
+  end
+
+  def test_controller_should_render_index
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns([mock_comment])
+    get :index
+    assert_response :success
+    assert_equal 'Index HTML', @response.body.strip
+  end
+
+  def test_render_all_comments_as_xml_when_mime_type_is_xml
+    @request.accept = 'application/xml'
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with(:all).returns(mock_comment)
+    mock_comment.expects(:to_xml).returns('Generated XML')
+    get :index, :post_id => '37'
+    assert_response :success
+    assert_equal 'Generated XML', @response.body
+  end
+end
+
+class ShowActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_expose_the_resquested_comment
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with('42').returns(mock_comment)
+    get :show, :id => '42', :post_id => '37'
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+  end
+
+  def test_controller_should_render_show
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment)
+    get :show
+    assert_response :success
+    assert_equal 'Show HTML', @response.body.strip
+  end
+
+  def test_render_exposed_comment_as_xml_when_mime_type_is_xml
+    @request.accept = 'application/xml'
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with('42').returns(mock_comment)
+    mock_comment.expects(:to_xml).returns("Generated XML")
+    get :show, :id => '42', :post_id => '37'
+    assert_response :success
+    assert_equal 'Generated XML', @response.body
+  end
+end
+
+class NewActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_expose_a_new_comment
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:build).returns(mock_comment)
+    get :new, :post_id => '37'
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+  end
+
+  def test_controller_should_render_new
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:build).returns(mock_comment)
+    get :new
+    assert_response :success
+    assert_equal 'New HTML', @response.body.strip
+  end
+
+  def test_render_exposed_a_new_comment_as_xml_when_mime_type_is_xml
+    @request.accept = 'application/xml'
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:build).returns(mock_comment)
+    mock_comment.expects(:to_xml).returns("Generated XML")
+    get :new, :post_id => '37'
+    assert_equal 'Generated XML', @response.body
+    assert_response :success
+  end
+end
+
+class EditActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_expose_the_resquested_comment
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with('42').returns(mock_comment)
+    get :edit, :id => '42', :post_id => '37'
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+    assert_response :success
+  end
+
+  def test_controller_should_render_edit
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment)
+    get :edit
+    assert_response :success
+    assert_equal 'Edit HTML', @response.body.strip
+  end
+end
+
+class CreateActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_expose_a_newly_create_comment_when_saved_with_success
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:build).with({'these' => 'params'}).returns(mock_comment(:save => true))
+    post :create, :post_id => '37', :comment => {:these => 'params'}
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+  end
+
+  def test_redirect_to_the_created_comment
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:build).returns(mock_comment(:save => true))
+    @controller.expects(:resource_url).returns('http://test.host/').times(2)
+    post :create
+    assert_redirected_to 'http://test.host/'
+  end
+
+  def test_show_flash_message_when_success
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:build).returns(mock_comment(:save => true))
+    post :create
+    assert_equal flash[:notice], 'Comment was successfully created.'
+  end
+
+  def test_render_new_template_when_comment_cannot_be_saved
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:build).returns(mock_comment(:save => false, :errors => []))
+    post :create
+    assert_response :success
+    assert_template 'new'
+  end
+
+  def test_dont_show_flash_message_when_comment_cannot_be_saved
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:build).returns(mock_comment(:save => false, :errors => []))
+    post :create
+    assert flash.empty?
+  end
+end
+
+class UpdateActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+
+  def test_update_the_requested_object
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with('42').returns(mock_comment)
+    mock_comment.expects(:update_attributes).with({'these' => 'params'}).returns(true)
+    put :update, :id => '42', :post_id => '37', :comment => {:these => 'params'}
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+  end
+
+  def test_redirect_to_the_created_comment
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:update_attributes => true))
+    @controller.expects(:resource_url).returns('http://test.host/')
+    put :update
+    assert_redirected_to 'http://test.host/'
+  end
+
+  def test_show_flash_message_when_success
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:update_attributes => true))
+    put :update
+    assert_equal flash[:notice], 'Comment was successfully updated.'
+  end
+
+  def test_render_edit_template_when_comment_cannot_be_saved
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:update_attributes => false, :errors => []))
+    put :update
+    assert_response :success
+    assert_template 'edit'
+  end
+
+  def test_dont_show_flash_message_when_comment_cannot_be_saved
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:update_attributes => false, :errors => []))
+    put :update
+    assert flash.empty?
+  end
+end
+
+class DestroyActionBelongsToTest < Test::Unit::TestCase
+  include CommentTestHelper
+  
+  def test_the_resquested_comment_is_destroyed
+    Post.expects(:find).with('37').returns(mock_post)
+    mock_post.expects(:comments).returns(Comment)
+    Comment.expects(:find).with('42').returns(mock_comment)
+    mock_comment.expects(:destroy)
+    delete :destroy, :id => '42', :post_id => '37'
+    assert_equal mock_post, assigns(:post)
+    assert_equal mock_comment, assigns(:comment)
+  end
+
+  def test_show_flash_message
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:destroy => true))
+    delete :destroy
+    assert_equal flash[:notice], 'Comment was successfully destroyed.'
+  end
+
+  def test_redirects_to_comments_list
+    Post.stubs(:find).returns(mock_post(:comments => Comment))
+    Comment.stubs(:find).returns(mock_comment(:destroy => true))
+    @controller.expects(:collection_url).returns('http://test.host/')
+    delete :destroy
+    assert_redirected_to 'http://test.host/'
+  end
+end
+

data/test/belongs_to_test.rb

@@ -0,0 +1,109 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class GreatSchool
+end
+
+class Professor
+  def self.human_name; 'Professor'; end
+end
+
+BELONGS_TO_OPTIONS = {
+  :parent_class => GreatSchool,
+  :instance_name => :great_school,
+  :finder => :find_by_title!,
+  :param => :school_title
+}
+
+class ProfessorsController < InheritedResources::Base
+  belongs_to :school, BELONGS_TO_OPTIONS
+end
+
+# Create a TestHelper module with some helpers
+class BelongsToTest < Test::Unit::TestCase
+  def setup
+    @controller          = ProfessorsController.new
+    @controller.request  = @request  = ActionController::TestRequest.new
+    @controller.response = @response = ActionController::TestResponse.new
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:find).returns([mock_professor])
+    get :index, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:find).returns(mock_professor)
+    get :show, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:build).returns(mock_professor)
+    get :new, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:find).returns(mock_professor)
+    get :edit, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:build).returns(mock_professor(:save => true))
+    post :create, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:find).returns(mock_professor(:update_attributes => true))
+    put :update, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_expose_the_resquested_school_with_chosen_instance_variable
+    GreatSchool.expects(:find_by_title!).with('nice').returns(mock_school(:professors => Professor))
+    Professor.stubs(:find).returns(mock_professor(:destroy => true))
+    delete :destroy, :school_title => 'nice'
+    assert_equal mock_school, assigns(:great_school)
+  end
+
+  def test_belongs_to_raise_errors_with_invalid_arguments
+    assert_raise ArgumentError do
+      ProfessorsController.send(:belongs_to)
+    end
+
+    assert_raise ArgumentError do
+      ProfessorsController.send(:belongs_to, :arguments, :with_options, :parent_class => Professor)
+    end
+
+    assert_raise ArgumentError do
+      ProfessorsController.send(:belongs_to, :nice, :invalid_key => '')
+    end
+  end
+
+  def test_url_helpers_are_recreated_when_defaults_change
+    InheritedResources::UrlHelpers.expects(:create_resources_url_helpers!).returns(true).once
+    ProfessorsController.send(:defaults, BELONGS_TO_OPTIONS)
+  ensure
+    # Reestore default settings
+    ProfessorsController.send(:parents_symbols=, [:school])
+  end
+
+  protected
+    def mock_school(stubs={})
+      @mock_school ||= mock(stubs)
+    end
+
+    def mock_professor(stubs={})
+      @mock_professor ||= mock(stubs)
+    end
+end
+

data/test/class_methods_test.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Book; end
+class Folder; end
+
+class BooksController < InheritedResources::Base
+  actions :index, :show
+end
+
+class ReadersController < InheritedResources::Base
+  actions :all, :except => [ :edit, :update ]
+end
+
+class FoldersController < InheritedResources::Base
+end
+
+class ActionsTest < Test::Unit::TestCase
+  def test_actions_are_undefined_when_only_option_is_given
+    action_methods = BooksController.send(:action_methods)
+    assert_equal 2, action_methods.size
+
+    ['index', 'show'].each do |action|
+      assert action_methods.include? action
+    end
+  end
+
+  def test_actions_are_undefined_when_except_option_is_given
+    action_methods = ReadersController.send(:action_methods)
+    assert_equal 5, action_methods.size
+
+    ['index', 'new', 'show', 'create', 'destroy'].each do |action|
+      assert action_methods.include? action
+    end
+  end
+end
+
+class DefaultsTest < Test::Unit::TestCase
+
  def test_resource_class_is_set_to_nil_when_resource_model_cannot_be_found
+    assert_nil ReadersController.send(:resource_class)
+  end
+
+  def test_defaults_are_set
+    assert Folder, FoldersController.send(:resource_class)
+    assert :folder, FoldersController.send(:resources_configuration)[:self][:instance_name]
+    assert :folders, FoldersController.send(:resources_configuration)[:self][:collection_name]
+  end
+
+  def test_defaults_can_be_overwriten
+    BooksController.send(:defaults, :resource_class => String, :instance_name => 'string', :collection_name => 'strings')
+
+    assert String, BooksController.send(:resource_class)
+    assert :string, BooksController.send(:resources_configuration)[:self][:instance_name]
+    assert :strings, BooksController.send(:resources_configuration)[:self][:collection_name]
+
+    BooksController.send(:defaults, :class_name => 'Fixnum', :instance_name => :fixnum, :collection_name => :fixnums)
+
+    assert String, BooksController.send(:resource_class)
+    assert :string, BooksController.send(:resources_configuration)[:self][:instance_name]
+    assert :strings, BooksController.send(:resources_configuration)[:self][:collection_name]
+  end
+
+  def test_defaults_raises_invalid_key
+    assert_raise ArgumentError do
+      BooksController.send(:defaults, :boom => String)
+    end
+  end
+
+  def test_url_helpers_are_recreated_when_defaults_change
+    InheritedResources::UrlHelpers.expects(:create_resources_url_helpers!).returns(true).once
+    BooksController.send(:defaults, :instance_name => 'string', :collection_name => 'strings')
+  end
+
+end