rails_best_practices 0.6.6 → 0.6.7

data/spec/rails_best_practices/{checks/replace_complex_creation_with_factory_method_check_spec.rb → reviews/replace_complex_creation_with_factory_method_review_spec.rb}

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new)
-  end
+describe RailsBestPractices::Reviews::ReplaceComplexCreationWithFactoryMethodReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::ReplaceComplexCreationWithFactoryMethodReview.new) }
 
   it "should replace complex creation with factory method" do
     content = <<-EOF
@@ -25,10 +23,9 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.review('app/controllers/invoices_controller.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/controllers/invoices_controller.rb:3 - replace complex creation with factory method (@invoice attribute_assignment_count > 2)"
+    runner.review('app/controllers/invoices_controller.rb', content)
+    runner.should have(1).errors
+    runner.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,9 +40,8 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner.review('app/controllers/invoices_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/invoices_controller.rb', content)
+    runner.should have(0).errors
   end
 
   it "should not replace complex creation with factory method when attrasgn_count is 5" do
@@ -68,9 +64,8 @@ describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodChec
       end
     end
     EOF
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new('attribute_assignment_count' => 5))
-    @runner.review('app/controllers/invoices_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner = RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::ReplaceComplexCreationWithFactoryMethodReview.new('attribute_assignment_count' => 5))
+    runner.review('app/controllers/invoices_controller.rb', content)
+    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::ReplaceInstanceVariableWithLocalVariableReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::ReplaceInstanceVariableWithLocalVariableReview.new) }
+
+  it "should replace instance variable with local varialbe" do
+    content = <<-EOF
+    <%= @post.title %>
+    EOF
+    runner.review('app/views/posts/_post.html.erb', content)
+    runner.should have(1).errors
+    runner.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.review('app/views/posts/_post.html.haml', content)
+    runner.should have(1).errors
+    runner.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 %>
+    EOF
+    runner.review('app/views/posts/_post.html.erb', content)
+    runner.should have(0).errors
+  end
+end

data/spec/rails_best_practices/reviews/review_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::Review do
+  let(:check) { RailsBestPractices::Reviews::Review.new }
+
+  context "equal?" do
+    it "should be true when compare symbol string with symbol" do
+      check.equal?(":test", :test).should be_true
+    end
+  end
+end

data/spec/rails_best_practices/{checks/use_before_filter_check_spec.rb → reviews/use_before_filter_review_spec.rb}

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Checks::UseBeforeFilterCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseBeforeFilterCheck.new)
-  end
+describe RailsBestPractices::Reviews::UseBeforeFilterReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseBeforeFilterReview.new) }
 
   it "should use before_filter" do
     content = <<-EOF
@@ -29,10 +27,9 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
 
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/controllers/posts_controller.rb:3,7,11,16 - use before_filter for show,edit,update,destroy"
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3,7,11,16 - use before_filter for show,edit,update,destroy"
   end
 
   it "should not use before_filter" do
@@ -55,9 +52,8 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
       end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
   end
 
   it "should not use before_filter by nil" do
@@ -78,9 +74,8 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
 
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
   end
 
   it "should not use before_filter for protected/private methods" do
@@ -98,8 +93,7 @@ describe RailsBestPractices::Checks::UseBeforeFilterCheck do
         end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/{checks/use_model_association_check_spec.rb → reviews/use_model_association_review_spec.rb}

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Checks::UseModelAssociationCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseModelAssociationCheck.new)
-  end
+describe RailsBestPractices::Reviews::UseModelAssociationReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseModelAssociationReview.new) }
 
   it "should use model association for instance variable" do
     content = <<-EOF
@@ -16,10 +14,9 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for @post)"
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(1).errors
+    runner.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,9 +29,8 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
   end
 
   it "should use model association for local variable" do
@@ -48,10 +44,9 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should_not be_empty
-    errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - use model association (for post)"
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(1).errors
+    runner.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,8 +59,7 @@ describe RailsBestPractices::Checks::UseModelAssociationCheck do
       end
     end
     EOF
-    @runner.review('app/controllers/posts_controller.rb', content)
-    errors = @runner.errors
-    errors.should be_empty
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/{checks/use_observer_check_spec.rb → reviews/use_observer_review_spec.rb}

@@ -1,14 +1,19 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Checks::UseObserverCheck do
-  before(:each) do
-    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseObserverCheck.new)
-
+describe RailsBestPractices::Reviews::UseObserverReview do
+  let(:runner) {
+    RailsBestPractices::Core::Runner.new(
+      :prepares => RailsBestPractices::Prepares::MailerPrepare.new,
+      :reviews => RailsBestPractices::Reviews::UseObserverReview.new
+    )
+  }
+
+  before :each do
     content =<<-EOF
     class ProjectMailer < ActionMailer::Base
     end
     EOF
-    @runner.prepare('app/models/project_mailer.rb', content)
+    runner.prepare('app/models/project_mailer.rb', content)
   end
 
   describe "rails2" do
@@ -26,10 +31,9 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('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"
+      runner.review('app/models/project.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/models/project.rb:6 - use observer"
     end
 
     it "should not use observer without callback" do
@@ -44,9 +48,8 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('app/models/project.rb', content)
-      errors = @runner.errors
-      errors.should be_empty
+      runner.review('app/models/project.rb', content)
+      runner.should have(0).errors
     end
 
     it "should use observer with two after_create" do
@@ -66,10 +69,9 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('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"
+      runner.review('app/models/project.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/models/project.rb:6 - use observer"
     end
 
     it "should not raise when initiate an object in callback" do
@@ -78,7 +80,7 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         after_create ProjectMailer.new
       end
       EOF
-      lambda { @runner.review('app/models/project.rb', content) }.should_not raise_error
+      lambda { runner.review('app/models/project.rb', content) }.should_not raise_error
     end
   end
 
@@ -97,10 +99,9 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('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"
+      runner.review('app/models/project.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/models/project.rb:6 - use observer"
     end
 
     it "should not use observer without callback" do
@@ -115,9 +116,8 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('app/models/project.rb', content)
-      errors = @runner.errors
-      errors.should be_empty
+      runner.review('app/models/project.rb', content)
+      runner.should have(0).errors
     end
 
     it "should use observer with two after_create" do
@@ -137,10 +137,9 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         end
       end
       EOF
-      @runner.review('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"
+      runner.review('app/models/project.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/models/project.rb:6 - use observer"
     end
 
     it "should not raise when initiate an object in callback" do
@@ -149,7 +148,7 @@ describe RailsBestPractices::Checks::UseObserverCheck do
         after_create ProjectMailer.new
       end
       EOF
-      lambda { @runner.review('app/models/project.rb', content) }.should_not raise_error
+      lambda { runner.review('app/models/project.rb', content) }.should_not raise_error
     end
   end
 end

data/spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb

@@ -0,0 +1,190 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::UseQueryAttributeReview do
+  let(:runner) {
+    RailsBestPractices::Core::Runner.new(
+      :prepares => RailsBestPractices::Prepares::ModelPrepare.new,
+      :reviews => RailsBestPractices::Reviews::UseQueryAttributeReview.new
+    )
+  }
+
+  before :each do
+    content = <<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+      belongs_to :location
+      has_one :phone
+
+      belongs_to :category, :class_name => 'IssueCategory', :foreign_key => 'category_id'
+    end
+    EOF
+    runner.prepare('app/models/user.rb', content)
+  end
+
+  it "should use query attribute by blank call" do
+    content = <<-EOF
+    <% if @user.login.blank? %>
+      <%= link_to 'login', new_session_path %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should use query attribute by comparing empty string" do
+    content = <<-EOF
+    <% if @user.login == "" %>
+      <%= link_to 'login', new_session_path %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should use query attribute by nil call" do
+    content = <<-EOF
+    <% if @user.login.nil? %>
+      <%= link_to 'login', new_session_path %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should use query attribute by present call" do
+    content = <<-EOF
+    <% if @user.login.present? %>
+      <%= @user.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should use query attribute within and conditions" do
+    content = <<-EOF
+    <% if @user.active? and @user.login.present? %>
+      <%= @user.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should use query attribute within or conditions" do
+    content = <<-EOF
+    <% if @user.active? or @user.login != "" %>
+      <%= @user.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/views/users/show.html.erb:1 - use query attribute (@user.login?)"
+  end
+
+  it "should not use query attribute" do
+    content = <<-EOF
+    <% if @user.login? %>
+      <%= @user.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not review for pluralize attribute" do
+    content = <<-EOF
+    <% if @user.roles.blank? %>
+      <%= @user.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not review non model class" do
+    content = <<-EOF
+    <% if @person.login.present? %>
+      <%= @person.login %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  context "association" do
+    it "should not review belongs_to association" do
+      content = <<-EOF
+      <% if @user.location.present? %>
+        <%= @user.location.name %>
+      <% end %>
+      EOF
+      runner.review('app/views/users/show.html.erb', content)
+      runner.should have(0).errors
+    end
+
+    it "should not review belongs_to category" do
+      content = <<-EOF
+      <% if @user.category.present? %>
+        <%= @user.category.name %>
+      <% end %>
+      EOF
+      runner.review('app/views/users/show.html.erb', content)
+      runner.should have(0).errors
+    end
+
+    it "should not review has_one association" do
+      content = <<-EOF
+      <% if @user.phone.present? %>
+        <%= @user.phone.number %>
+      <% end %>
+      EOF
+      runner.review('app/views/users/show.html.erb', content)
+      runner.should have(0).errors
+    end
+
+    it "should not review has_many association" do
+      content = <<-EOF
+      <% if @user.projects.present? %>
+        <%= @user.projects.first.name %>
+      <% end %>
+      EOF
+      runner.review('app/views/users/show.html.erb', content)
+      runner.should have(0).errors
+    end
+  end
+
+  it "should not review for class method" do
+    content = <<-EOF
+    <% if User.name.present? %>
+      <%= User.name %>
+    <% end %>
+    EOF
+    runner.review('app/views/users/show.html.erb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not review for non attribute call" do
+    content = <<-EOF
+    if @user.login(false).nil?
+      puts @user.login(false)
+    end
+    EOF
+    runner.review('app/models/users_controller.rb', content)
+    runner.should have(0).errors
+  end
+
+  it "should not raise error for common conditional statement" do
+    content = <<-EOF
+    if voteable.is_a? Answer
+      puts voteable.title
+    end
+    EOF
+    lambda { runner.review('app/models/users_controller.rb', content) }.should_not raise_error
+  end
+end