rc_rails 2.1.0

data/resources_controller.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require 'resources_controller/version'
+version = ResourcesController::VERSION
+
+Gem::Specification.new do |s|
+  s.name        = "rc_rails"
+  s.version     = version
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ian White"]
+  s.email       = "ian.w.white@gmail.com"
+  s.homepage    = "http://github.com/ianwhite/resources_controller"
+  s.summary     = "resources_controller-#{version}"
+  s.description = "rc makes RESTful controllers fun"
+
+  s.rubygems_version   = "1.3.7"
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.extra_rdoc_files = [ "README.rdoc" ]
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_path     = "lib"
+
+  s.add_runtime_dependency "rails", '>= 3.1.0'
+  s.add_development_dependency "rspec", '>= 2.8.0'
+  s.add_development_dependency "rspec-rails", '>= 2.8.0'
+  s.add_development_dependency 'sqlite3'
+end                            

data/spec/app/database.yml

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: tmp/test.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/app.rb

@@ -0,0 +1,315 @@
+# Testing app setup
+
+module ResourcesControllerTest
+  class Application < Rails::Application
+    config.active_support.deprecation = :stderr
+    paths['config/database'] = File.expand_path('../app/database.yml', __FILE__)
+    paths['log'] = File.expand_path('../../../tmp/log', __FILE__)
+  end
+end
+
+ResourcesControllerTest::Application.initialize!
+
+##########
+# Routing
+##########
+
+Rails.application
+Rails.application.routes.clear!
+Rails.application.routes.draw do
+  # this tests :resource_path (or :erp), for named routes that map to resources
+  root :controller => 'forums', :action => 'index', :resource_path => '/forums'
+  match 'create_forum', :controller => 'forums', :action => 'create', :resource_path => '/forums', :resource_method => :post
+
+  namespace :admin do
+    resources :forums do
+      resources :interests
+    end
+    namespace :superduper do
+      resources :forums
+    end
+  end
+  
+  resources :users do
+    resources :posts, :controller => 'user_posts'
+    resources :comments, :controller => 'user_comments'
+    resources :addresses do
+      resources :tags
+    end
+  end
+  
+  resources :forums do
+    resources :interests
+    resources :posts, :controller => 'forum_posts' do
+      resources :comments do
+        resources :tags
+      end
+      resources :tags
+    end
+    resource :owner do
+      resources :posts do
+        resources :tags
+      end
+    end
+    resources :tags
+  end
+  
+  resource :account do
+    resources :posts
+    resource :info do
+      resources :tags
+    end
+  end
+  
+  resources :tags
+
+  with_options :path_prefix => ":tag_id", :name_prefix => "tag_" do
+    resources :forums
+  end
+  
+  # the following routes are for testing errors
+  resources :posts, :controller => 'forum_posts'
+  resources :foos do
+    resources :bars, :controller => 'forum_posts'
+  end
+  
+  match ':controller/:action/:id(.:format)' # naming this so we can test missing segment errors
+end
+
+
+##################
+# Database schema
+##################
+
+ActiveRecord::Migration.suppress_messages do
+  ActiveRecord::Schema.define(:version => 0) do
+    create_table :users, :force => true do |t|
+      t.string :login
+    end
+    
+    create_table :infos, :force => true do |t|
+      t.column "user_id", :integer
+    end
+
+    create_table :addresses, :force => true do |t|
+      t.column "user_id", :integer
+    end
+    
+    create_table :forums, :force => true do |t|
+      t.column "owner_id", :integer
+    end
+
+    create_table :posts, :force => true do |t|
+      t.column "forum_id", :integer
+      t.column "user_id", :integer
+    end
+
+    create_table :comments, :force => true do |t|
+      t.column "post_id", :integer
+      t.column "user_id", :integer
+    end
+    
+    create_table :interests, :force => true do |t|
+      t.column "interested_in_id", :integer
+      t.column "interested_in_type", :string
+    end
+    
+    create_table :tags, :force => true do |t|
+      t.column "taggable_id", :integer
+      t.column "taggable_type", :string
+    end
+  end
+end
+
+
+#########
+# Models
+#########
+
+class Interest < ActiveRecord::Base
+  belongs_to :interested_in, :polymorphic => true
+end
+
+class Tag < ActiveRecord::Base
+  belongs_to :taggable, :polymorphic => true
+end
+
+class User < ActiveRecord::Base
+  has_many :posts
+  has_many :comments
+  has_many :interests, :as => :interested_in
+  has_many :addresses
+  has_one :info
+  
+  def to_param
+    login
+  end
+end
+
+class Info < ActiveRecord::Base
+  belongs_to :user
+  has_many :tags, :as => :taggable
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :user
+  has_many :tags, :as => :taggable
+end
+
+class Forum < ActiveRecord::Base
+  has_many :posts
+  has_many :tags, :as => :taggable
+  has_many :interests, :as => :interested_in
+  has_many :users, :through => :posts
+  belongs_to :owner, :class_name => "User"
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :forum
+  belongs_to :user
+  has_many :comments
+  has_many :tags, :as => :taggable
+end
+
+class Comment < ActiveRecord::Base
+  validates_presence_of :user, :post
+  
+  belongs_to :user
+  belongs_to :post
+  has_many :tags, :as => :taggable
+end
+
+##############
+# Controllers
+##############
+
+class ApplicationController < ActionController::Base
+  map_enclosing_resource :account, :class => User, :singleton => true, :find => :current_user
+
+  map_enclosing_resource :user do
+    User.find_by_login(params[:user_id])
+  end
+    
+protected
+  def current_user
+    @current_user
+  end
+end
+
+module Admin
+  class ForumsController < ApplicationController
+    resources_controller_for :forums
+  end
+  
+  class InterestsController < ApplicationController
+    resources_controller_for :interests
+  end
+  
+  module NotANamespace
+    class ForumsController < ApplicationController
+      resources_controller_for :forums
+    end
+  end
+  
+  module Superduper
+    class ForumsController < ApplicationController
+      resources_controller_for :forums
+    end
+  end
+end
+
+class AccountsController < ApplicationController
+  resources_controller_for :account, :singleton => true, :source => :user, :find => :current_user
+end
+
+class InfosController < ApplicationController
+  resources_controller_for :info, :singleton => true, :only => [:show, :edit, :update]
+end
+
+class TagsController < ApplicationController
+  resources_controller_for :tags
+end
+
+class UsersController < ApplicationController
+  resources_controller_for :users, :except => [:new, :create, :destroy]
+  
+protected
+  def find_resource(id = params[:id])
+    resource_service.find_by_login(id)
+  end
+end
+
+class ForumsController < ApplicationController
+  resources_controller_for :forums
+end
+
+class OwnersController < ApplicationController
+  resources_controller_for :owner, :singleton => true, :class => User, :in => :forum
+end
+
+class PostsAbstractController < ApplicationController
+  include ResourcesController::ResourceMethods
+  attr_accessor :filter_trace
+  
+  # for testing filter load order
+  before_filter {|controller| controller.filter_trace ||= []; controller.filter_trace << :abstract}
+
+protected
+  # redefine find_resources
+  def find_resources
+    resource_service.find :all, :order => 'id DESC'
+  end
+end
+
+class PostsController < PostsAbstractController
+  # for testing filter load order
+  before_filter {|controller| controller.filter_trace ||= []; controller.filter_trace << :posts}
+  
+  # example of providing options to resources_controller_for
+  resources_controller_for :posts, :class => Post, :route => 'posts'
+  
+  def load_enclosing_resources_with_trace(*args)
+    self.filter_trace ||= []; self.filter_trace << :load_enclosing
+    load_enclosing_resources_without_trace(*args)
+  end
+  alias_method_chain :load_enclosing_resources, :trace
+end
+
+class UserPostsController < PostsController
+  # for testing filter load order
+  before_filter {|controller| controller.filter_trace ||= []; controller.filter_trace << :user_posts}
+  
+  # example of providing options to nested in
+  nested_in :user, :class => User, :key => 'user_id', :name_prefix => 'user_'
+end
+
+class AddressesController < ApplicationController
+  resources_controller_for :addresses
+end
+
+class ForumPostsController < PostsController
+  # for testing filter load order
+  before_filter {|controller| controller.filter_trace ||= []; controller.filter_trace << :forum_posts}
+
+  # test override resources_controller_for use
+  resources_controller_for :posts
+  
+  # example of providing a custom finder for the nesting resource
+  # also example of :as option, which allows you to assign an alias
+  # for an enclosing resource
+  nested_in :forum, :as => :other_name_for_forum do
+    Forum.find(params[:forum_id])
+  end
+end
+
+class CommentsController < ApplicationController
+  resources_controller_for :comments, :in => [:forum, :post], :load_enclosing => false
+end
+
+class InterestsController < ApplicationController
+  resources_controller_for :interests
+  nested_in :interested_in, :polymorphic => true
+  
+  # the above two lines are the same as:
+  #   resources_controller_for :interests, :in => '?interested_in'
+end

data/spec/controllers/accounts_controller_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+module AccountsControllerSpecHelper
+  def setup_mocks
+    @current_user = mock('user')
+    @current_user.stub!(:id).and_return('1')
+    User.stub!(:find).and_return(@current_user)
+    @controller.instance_variable_set('@current_user', @current_user)
+  end
+end
+
+describe AccountsController do
+  describe "Routing shortcuts for Account should map" do
+    include AccountsControllerSpecHelper
+  
+    before(:each) do
+      setup_mocks
+      get :show
+    end
+
+    it "resource_path to /account" do
+      controller.resource_path.should == '/account'
+    end
+   
+    it "resource_info_tags_path to /account/info/tags" do
+      controller.resource_info_tags_path.should == "/account/info/tags"
+    end    
+  end
+
+  describe AccountsController, " requesting garbage url" do
+    it "should raise ResourcesController::Specification::NoClassFoundError" do
+      lambda { get :show, :resource_path => "/crayzeee" }.should raise_error(ResourcesController::Specification::NoClassFoundError)
+    end
+  end
+  
+  describe AccountsController, "#resource_service" do
+    include AccountsControllerSpecHelper
+  
+    before(:each) do
+      setup_mocks 
+      get :show
+      @resource_service = controller.send :resource_service
+    end
+  
+    it ".new should call :new on User" do
+      User.should_receive(:new).with(:args => 'args')
+      @resource_service.new :args => 'args'
+    end
+  
+    it ".find should call :current_user" do
+      @controller.should_receive(:current_user).once.and_return(@current_user)
+      @resource_service.find
+    end
+  
+    it ".find should call whatever is in resource_specification @find" do
+      @controller.should_receive(:lambda_called).once.and_return(@current_user)
+      resource_specification = @controller.send(:resource_specification)
+      resource_specification.stub(:find).and_return(lambda { lambda_called })
+      @resource_service.find
+    end
+  
+    it ".find should raise CantFindSingleton when no custom finder (and no enclosing resource)" do
+      @controller.send(:resource_specification).stub!(:find).and_return nil
+      lambda{ @resource_service.find }.should raise_error(ResourcesController::CantFindSingleton)
+    end
+  
+    it ".foo should call foo on User" do
+      User.should_receive(:foo).once
+      @resource_service.foo
+    end
+  
+    it ".respond_to?(:foo) should call respond_to?(:foo) on User" do
+      User.stub!(:foo)
+      @resource_service.respond_to?(:foo).should be_true
+    end
+  end
+end