rails_best_practices 0.3.0 → 0.4.0

data/spec/rails_best_practices/checks/isolate_seed_data_check_spec.rb

@@ -24,7 +24,6 @@ describe RailsBestPractices::Checks::IsolateSeedDataCheck do
     end
     EOF
     @runner.check('db/migrate/20090818130258_create_roles.rb', content)
-    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
     errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:8 - isolate seed data"
@@ -51,7 +50,6 @@ describe RailsBestPractices::Checks::IsolateSeedDataCheck do
     end
     EOF
     @runner.check('db/migrate/20090818130258_create_roles.rb', content)
-    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
     errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
@@ -72,7 +70,6 @@ describe RailsBestPractices::Checks::IsolateSeedDataCheck do
     end
     EOF
     @runner.check('db/migrate/20090818130258_create_roles.rb', content)
-    @runner.check('db/migrate/20090818130258_create_roles.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end

data/spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb

@@ -22,6 +22,23 @@ describe RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck do
     errors[0].to_s.should == "app/models/post.rb:5 - keep finders on their own model"
   end
 
+  it "should keep finders on thier own model with all method" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.comment.all(:conditions => { :is_spam => false },
+                         :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/models/post.rb:5 - keep finders on their own model"
+  end
+
   it "should not keep finders on thier own model with self finder" do
     content = <<-EOF
     class Post < ActiveRecord::Base
@@ -54,7 +71,7 @@ describe RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck do
     errors.should be_empty
   end
 
-  it "should not keep finders on thier own model without finder" do
+  it "should not keep finders on their own model without finder" do
     content = <<-EOF
     class Post < ActiveRecord::Base
       has_many :comments
@@ -68,4 +85,19 @@ describe RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck do
     errors = @runner.errors
     errors.should be_empty
   end
+
+  it "should not keep finders on their own model with ruby Array#find" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def active_comments
+        self.comments.find {|comment| comment.status == 'active'}
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
 end

data/spec/rails_best_practices/checks/law_of_demeter_check_spec.rb

@@ -1,37 +1,76 @@
 require File.join(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe RailsBestPractices::Checks::LawOfDemeterCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::LawOfDemeterCheck.new)
+  
+  describe "belongs_to" do
+    before(:each) do
+      @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::LawOfDemeterCheck.new)
 
-    content = <<-EOF
-    class Invoice < ActiveRecord::Base
-      belongs_to :user
+      content = <<-EOF
+      class Invoice < ActiveRecord::Base
+        belongs_to :user
+      end
+      EOF
+      @runner.check('app/models/invoice.rb', content)
+    end
+
+    it "should law of demeter" do
+      content = <<-EOF
+      <%= @invoice.user.name %>
+      <%= @invoice.user.address %>
+      <%= @invoice.user.cellphone %>
+      EOF
+      @runner.check('app/views/invoices/show.html.erb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+    end
+
+    it "should law of demeter" do
+      content = <<-EOF
+= @invoice.user.name
+= @invoice.user.address
+= @invoice.user.cellphone
+      EOF
+      @runner.check('app/views/invoices/show.html.haml', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/views/invoices/show.html.haml:1 - law of demeter"
     end
-    EOF
-    @runner.check('app/models/invoice.rb', content)
-  end
 
-  it "should law of demeter" do
-    content = <<-EOF
-    <%= @invoice.user.name %>
-    <%= @invoice.user.address %>
-    <%= @invoice.user.cellphone %>
-    EOF
-    @runner.check('app/views/invoices/show.html.erb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+    it "should no law of demeter" do
+      content = <<-EOF
+      <%= @invoice.user_name %>
+      <%= @invoice.user_address %>
+      <%= @invoice.user_cellphone %>
+      EOF
+      @runner.check('app/views/invoices/show.html.erb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
   end
 
-  it "should no law of demeter" do
-    content = <<-EOF
-    <%= @invoice.user_name %>
-    <%= @invoice.user_address %>
-    <%= @invoice.user_cellphone %>
-    EOF
-    @runner.check('app/views/invoices/show.html.erb', content)
-    errors = @runner.errors
-    errors.should be_empty
+  describe "has_one" do
+    before(:each) do
+      @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::LawOfDemeterCheck.new)
+
+      content = <<-EOF
+      class Invoice < ActiveRecord::Base
+        has_one :price
+      end
+      EOF
+      @runner.check('app/models/invoice.rb', content)
+    end
+
+    it "should law of demeter" do
+      content = <<-EOF
+      <%= @invoice.price.currency %>
+      <%= @invoice.price.number %>
+      EOF
+      @runner.check('app/views/invoices/show.html.erb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+    end
   end
 end

data/spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb

@@ -2,7 +2,7 @@ require File.join(File.dirname(__FILE__) + '/../../spec_helper')
 
 describe RailsBestPractices::Checks::MoveCodeIntoHelperCheck do
   before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoHelperCheck.new)
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoHelperCheck.new('array_count' => 2))
   end
 
   it "should move code into helper" do
@@ -15,7 +15,7 @@ describe RailsBestPractices::Checks::MoveCodeIntoHelperCheck do
     @runner.check('app/views/posts/show.html.erb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/views/posts/show.html.erb:3 - move code into helper"
+    errors[0].to_s.should == "app/views/posts/show.html.erb:3 - move code into helper (array_count >= 2)"
   end
 
   it "should not move code into helper with simple arguments" do

data/spec/rails_best_practices/checks/move_code_into_model_check_spec.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::MoveCodeIntoModelCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoModelCheck.new)
+  end
+
+  it "should move code into model" do
+    content =<<-EOF
+    <% if current_user && (current_user == @post.user || @post.editors.include?(current_user)) %>
+      <%= link_to 'Edit this post', edit_post_url(@post) %>
+    <% end %>
+    EOF
+    @runner.check('app/views/posts/show.html.erb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/show.html.erb:1 - move code into model (@post)"
+  end
+
+  it "should move code into model with haml" do
+    content =<<-EOF
+- if current_user && (current_user == @post.user || @post.editors.include?(current_user))
+  = link_to 'Edit this post', edit_post_url(@post)
+    EOF
+    @runner.check('app/views/posts/show.html.haml', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/show.html.haml:1 - move code into model (@post)"
+  end
+  
+  it "should move code into model only check for current if conditional statement" do
+    content =<<-EOF
+    <% if @post.title %>
+      <% if @post.user %>
+        <% if @post.description %>
+        <% end %>
+      <% end %>
+    <% end %>
+    EOF
+    @runner.check('app/views/posts/show.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not move code into model" do
+    content =<<-EOF
+    <% if @post.editable_by?(current_user) %>
+      <%= link_to 'Edit this post', edit_post_url(@post) %>
+    <% end %>
+    EOF
+    @runner.check('app/views/posts/show.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb

@@ -5,32 +5,66 @@ describe RailsBestPractices::Checks::NeedlessDeepNestingCheck do
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NeedlessDeepNestingCheck.new)
   end
   
-  it "should needless deep nesting" do
-    content = <<-EOF
-    map.resources :posts do |post|
-      post.resources :comments do |comment|
+  describe "rails2" do
+    it "should needless deep nesting" do
+      content = <<-EOF
+      map.resources :posts do |post|
+        post.resources :comments do |comment|
+          comment.resources :favorites
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:3 - needless deep nesting (nested_count > 2)"
+    end
+
+    it "should no needless deep nesting" do
+      content = <<-EOF
+      map.resources :posts do |post|
+        post.resources :comments
+      end
+      
+      map.resources :comments do |comment|
         comment.resources :favorites
       end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
     end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:3 - needless deep nesting (nested_count > 2)"
   end
 
-  it "should no needless deep nesting" do
-    content = <<-EOF
-    map.resources :posts do |post|
-      post.resources :comments
+  describe "rails3" do
+    it "should needless deep nesting" do
+      content = <<-EOF
+      resources :posts do
+        resources :comments do
+          resources :favorites
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:4 - needless deep nesting (nested_count > 2)"
     end
-    
-    map.resources :comments do |comment|
-      comment.resources :favorites
+
+    it "should no needless deep nesting" do
+      content = <<-EOF
+      resources :posts do
+        resources :comments
+        resources :votes
+      end
+      
+      resources :comments do
+        resources :favorites
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
     end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/not_use_default_route_check_spec.rb

@@ -5,30 +5,59 @@ describe RailsBestPractices::Checks::NotUseDefaultRouteCheck do
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NotUseDefaultRouteCheck.new)
   end
   
-  it "should not use default route" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts, :member => { :push => :post }
-      
-      map.connect ':controller/:action/:id'
-      map.connect ':controller/:action/:id.:format'
+  describe "rails2" do
+    it "should not use default route" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts, :member => { :push => :post }
+        
+        map.connect ':controller/:action/:id'
+        map.connect ':controller/:action/:id.:format'
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:4 - not use default route"
+      errors[1].to_s.should == "config/routes.rb:5 - not use default route"
+    end
+
+    it "should no not use default route" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts, :member => { :push => :post }
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
     end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:4 - not use default route"
-    errors[1].to_s.should == "config/routes.rb:5 - not use default route"
   end
 
-  it "should no not use default route" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts, :member => { :push => :post }
+  describe "rails3" do
+    it "should not use default route" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts
+        
+        match ':controller(/:action(/:id(.:format)))'
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:5 - not use default route"
+    end
+
+    it "should no not use default route" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
     end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/overuse_route_customizations_check_spec.rb

@@ -4,56 +4,142 @@ describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
   before(:each) do
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::OveruseRouteCustomizationsCheck.new)
   end
-  
-  it "should overuse route customizations" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts, :member => { :comments => :get,
-                                         :create_comment => :post,
-                                         :update_comment => :post,
-                                         :delete_comment => :post }
-    end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
-  end
-  
-  it "should overuse route customizations with collection" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts, :member => { :create_comment => :post,
-                                         :update_comment => :post,
-                                         :delete_comment => :post },
-                            :collection => { :comments => :get }
-    end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
-  end
-  
-  it "should not overuse route customizations without customization" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts
-    end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+
+  describe "rails2" do
+    it "should overuse route customizations" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts, :member => { :comments => :get,
+                                           :create_comment => :post,
+                                           :update_comment => :post,
+                                           :delete_comment => :post }
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+    end
+    
+    it "should overuse route customizations with collection" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts, :member => { :create_comment => :post,
+                                           :update_comment => :post,
+                                           :delete_comment => :post },
+                              :collection => { :comments => :get }
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+    end
+
+    it "should overuse route customizations with collection 2" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :categories do |category|
+          category.resources :posts, :member => { :create_comment => :post,
+                                                  :update_comment => :post,
+                                                  :delete_comment => :post },
+                                     :collection => { :comments => :get }
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:3 - overuse route customizations (customize_count > 3)"
+    end
+    
+    it "should not overuse route customizations without customization" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+
+    it "should not overuse route customizations when customize route is only one" do
+      content = <<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts, :member => { :vote => :post }
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
   end
 
-  it "should not overuse route customizations when customize route is only one" do
-    content = <<-EOF
-    ActionController::Routing::Routes.draw do |map|
-      map.resources :posts, :member => { :vote => :post }
+  describe "rails3" do
+    it "should overuse route customizations" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts do
+          member do
+            post :create_comment
+            post :update_comment
+            post :delete_comment
+          end
+
+          collection do
+            get :comments
+          end
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+    end
+
+    it "should overuse route customizations another way" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts do
+          post :create_comment, :on => :member
+          post :update_comment, :on => :member
+          post :delete_comment, :on => :member
+          get :comments, :on => :collection
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should_not be_empty
+      errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+    end
+    
+    it "should not overuse route customizations without customization" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+
+    it "should not overuse route customizations when customize route is only one" do
+      content = <<-EOF
+      RailsBestpracticesCom::Application.routes.draw do |map|
+        resources :posts do
+          member do
+            post :vote
+          end
+        end
+      end
+      EOF
+      @runner.check('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
     end
-    EOF
-    @runner.check('config/routes.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
   end
 end

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -15,6 +15,16 @@ describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableChe
     errors[0].to_s.should == "app/views/posts/_post.html.erb:1 - replace instance variable with local variable"
   end
 
+  it "should replace instance variable with local varialbe in haml file" do
+    content = <<-EOF
+= @post.title
+    EOF
+    @runner.check('app/views/posts/_post.html.haml', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/_post.html.haml:1 - replace instance variable with local variable"
+  end
+
   it "should not replace instance variable with local varialbe" do
     content = <<-EOF
     <%= post.title %>
@@ -23,4 +33,4 @@ describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableChe
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end