rails_best_practices 0.2.0 → 0.3.0

data/spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::KeepFindersOnTheirOwnModelCheck.new)
+  end
+
+  it "should keep finders on thier own model" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.comment.find(: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
+      has_many :comments
+
+      def find_valid_comments
+        self.find(:all, :conditions => { :is_spam => false }, 
+                                :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not keep finders on thier own model with own finder" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        Post.find(:all, :conditions => { :is_spam => false }, 
+                                :limit => 10)
+      end
+    end
+    EOF
+    @runner.check('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not keep finders on thier own model without finder" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+      has_many :comments
+
+      def find_valid_comments
+        self.comments.destroy_all
+      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

@@ -0,0 +1,37 @@
+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)
+
+    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 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

data/spec/rails_best_practices/checks/move_code_into_controller_check_spec.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::MoveCodeIntoControllerCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoControllerCheck.new)
+  end
+  
+  it "should move code into controller" do
+    content = <<-EOF
+    <% @posts = Post.find(:all) %>
+    <% @posts.each do |post| %>
+      <%=h post.title %>
+      <%=h post.content %>
+    <% end %>
+    EOF
+    @runner.check('app/views/posts/index.html.erb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/index.html.erb:1 - move code into controller"
+  end
+
+  it "should not move code into controller" do
+    content = <<-EOF
+    <% @posts.each do |post| %>
+      <%=h post.title %>
+      <%=h post.content %>
+    <% end %>
+    EOF
+    @runner.check('app/views/posts/index.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/move_code_into_helper_check_spec.rb

@@ -0,0 +1,29 @@
+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)
+  end
+
+  it "should move code into helper" do
+    content = <<-EOF
+    <%= select_tag :state, options_for_select( [[t(:draft), "draft"],
+                                                [t(:published), "published"]],
+                                               params[:default_state] ) %>
+    
+    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:3 - move code into helper"
+  end
+
+  it "should not move code into helper with simple arguments" do
+    content = <<-EOF
+    <%= select_tag :state, options_for_select( Post.STATES ) %>
+    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/move_finder_to_named_scope_check_spec.rb

@@ -20,11 +20,11 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.size.should == 2
-    errors[0].to_s.should == "app/controller/posts_controller.rb:4 - move finder to named_scope"
-    errors[1].to_s.should == "app/controller/posts_controller.rb:8 - move finder to named_scope"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - move finder to named_scope"
+    errors[1].to_s.should == "app/controllers/posts_controller.rb:8 - move finder to named_scope"
   end
   
   it "should not move simple finder" do
@@ -41,7 +41,7 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     @runner.errors.should be_empty
   end
   
@@ -55,7 +55,7 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     @runner.errors.should be_empty
   end
   
@@ -79,4 +79,4 @@ describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
     @runner.errors.should be_empty
     
   end
-end
+end

data/spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb

@@ -23,10 +23,10 @@ describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
       redirect_to post_url(@post)
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - move model logic into model (@post called_count > 4)"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - move model logic into model (@post called_count > 4)"
   end
 
   it "should not move model logic into model with simple model calling" do
@@ -42,8 +42,8 @@ describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
       redirect_to post_url(@post)
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/replace_complex_creation_with_factory_method_check_spec.rb

@@ -25,10 +25,10 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/invoices_controller.rb:3 - replace complex creation with factory method (@invoice attribute_assignment_count > 2)"
+    errors[0].to_s.should == "app/controllers/invoices_controller.rb:3 - replace complex creation with factory method (@invoice attribute_assignment_count > 2)"
   end
 
   it "should not replace complex creation with factory method with simple creation" do
@@ -43,7 +43,7 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
@@ -69,8 +69,8 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
     end
     EOF
     @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new('attribute_assignment_count' => 5))
-    @runner.check('app/controller/invoices_controller.rb', content)
+    @runner.check('app/controllers/invoices_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
-end
+end

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceInstanceVariableWithLocalVariableCheck.new)
+  end
+
+  it "should replace instance variable with local varialbe" do
+    content = <<-EOF
+    <%= @post.title %>
+    EOF
+    @runner.check('app/views/posts/_post.html.erb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/views/posts/_post.html.erb:1 - replace instance variable with local variable"
+  end
+
+  it "should not replace instance variable with local varialbe" do
+    content = <<-EOF
+    <%= post.title %>
+    EOF
+    @runner.check('app/views/posts/_post.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/use_filter_check_spec.rb

@@ -0,0 +1,85 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseFilterCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseFilterCheck.new)
+  end
+  
+  it "should use filter" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def show
+        @post = current_user.posts.find(params[:id])
+      end
+
+      def edit
+        @post = current_user.posts.find(params[:id])
+      end
+
+      def update
+        @post = current_user.posts.find(params[:id])
+        @post.update_attributes(params[:post])
+      end
+
+      def destroy
+        @post = current_user.posts.find(params[:id])
+        @post.destroy
+      end
+
+    end
+    EOF
+    @runner.check('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:1 - use filter for @post = current_user.posts.find(params[:id]) in show,edit,update,destroy"
+  end
+  
+  it "should not use filter" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+      before_filter :find_post, :only => [:show, :edit, :update, :destroy]
+
+      def update
+        @post.update_attributes(params[:post])
+      end
+
+      def destroy
+        @post.destroy
+      end
+
+      protected
+
+      def find_post
+        @post = current_user.posts.find(params[:id])
+      end
+    end
+    EOF
+    @runner.check('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not use filter by nil" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def show
+      end
+
+      def edit
+      end
+
+      def update
+      end
+
+      def destroy
+      end
+
+    end
+    EOF
+    @runner.check('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/use_model_association_check_spec.rb

@@ -16,10 +16,10 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association (for @post)"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for @post)"
   end
 
   it "should not use model association without association assign" do
@@ -32,7 +32,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end
@@ -48,10 +48,10 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should_not be_empty
-    errors[0].to_s.should == "app/controller/posts_controller.rb:3 - use model association (for post)"
+    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for post)"
   end
 
   it "should not use model association" do
@@ -64,7 +64,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.check('app/controller/posts_controller.rb', content)
+    @runner.check('app/controllers/posts_controller.rb', content)
     errors = @runner.errors
     errors.should be_empty
   end

data/spec/rails_best_practices/checks/use_observer_check_spec.rb

@@ -0,0 +1,67 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe RailsBestPractices::Checks::UseObserverCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseObserverCheck.new)
+  end
+
+  it "should use observer" do
+    content =<<-EOF
+    class Project < ActiveRecord::Base
+      after_create :send_create_notification
+
+      private
+
+      def send_create_notification
+        self.members.each do |member|
+          ProjectMailer.deliver_notification(self, member)
+        end
+      end
+    end
+    EOF
+    @runner.check('app/models/project.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/models/project.rb:6 - use observer"
+  end
+
+  it "should not use observer without callback" do
+    content =<<-EOF
+    class Project < ActiveRecord::Base
+      private
+
+      def send_create_notification
+        self.members.each do |member|
+          ProjectMailer.deliver_notification(self, member)
+        end
+      end
+    end
+    EOF
+    @runner.check('app/models/project.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should use observer with two after_create" do
+    content =<<-EOF
+    class Project < ActiveRecord::Base
+      after_create :send_create_notification, :update_author
+
+      private
+
+      def send_create_notification
+        self.members.each do |member|
+          ProjectMailer.deliver_notification(self, member)
+        end
+      end
+
+      def update_author
+      end
+    end
+    EOF
+    @runner.check('app/models/project.rb', content)
+    errors = @runner.errors
+    errors.should_not be_empty
+    errors[0].to_s.should == "app/models/project.rb:6 - use observer"
+  end
+end

data/spec/rails_best_practices/checks/use_scope_access_check_spec.rb

@@ -20,10 +20,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access by comparing with id" do
@@ -40,10 +40,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access with current_user ==" do
@@ -60,10 +60,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
 
     it "shoud use scope access by current_user.id ==" do
@@ -80,10 +80,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:7 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:7 - use scope access"
     end
   end
 
@@ -102,10 +102,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access by comparing with id" do
@@ -122,10 +122,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access with current_user ==" do
@@ -142,10 +142,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
 
     it "shoud use scope access by current_user.id ==" do
@@ -162,10 +162,10 @@ describe RailsBestPractices::Checks::UseScopeAccessCheck do
         end
       end
       EOF
-      @runner.check('app/controller/posts_controller.rb', content)
+      @runner.check('app/controllers/posts_controller.rb', content)
       errors = @runner.errors
       errors.should_not be_empty
-      errors[0].to_s.should == "app/controller/posts_controller.rb:6 - use scope access"
+      errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - use scope access"
     end
   end
-end
+end