rails_best_practices 0.6.1 → 0.6.5

data/spec/rails_best_practices/checks/use_before_filter_check_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::UseBeforeFilterCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseBeforeFilterCheck.new)
+  end
+
+  it "should use before_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.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"
+  end
+
+  it "should not use before_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.review('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not use before_filter by nil" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def show
+      end
+
+      def edit
+      end
+
+      def update
+      end
+
+      def destroy
+      end
+
+    end
+    EOF
+    @runner.review('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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::UseModelAssociationCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseModelAssociationCheck.new)
+  end
+
+  it "should use model association for instance variable" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        @post = Post.new(params[:post])
+        @post.user_id = current_user.id
+        @post.save
+      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)"
+  end
+
+  it "should not use model association without association assign" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        @post = Post.new(params[:post])
+        @post.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should use model association for local variable" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        post = Post.new(params[:post])
+        post.user_id = current_user.id
+        post.save
+      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)"
+  end
+
+  it "should not use model association" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def create
+        post = current_user.posts.buid(params[:post])
+        post.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/use_observer_check_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::UseObserverCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseObserverCheck.new)
+
+    content =<<-EOF
+    class ProjectMailer < ActionMailer::Base
+    end
+    EOF
+    @runner.prepare('app/models/project_mailer.rb', content)
+  end
+
+  describe "rails2" do
+    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.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"
+    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.review('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.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"
+    end
+
+    it "should not raise when initiate an object in callback" do
+      content =<<-EOF
+      class Project < ActiveRecord::Base
+        after_create ProjectMailer.new
+      end
+      EOF
+      lambda { @runner.review('app/models/project.rb', content) }.should_not raise_error
+    end
+  end
+
+  describe "rails3" do
+    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.notification(self, member).deliver
+          end
+        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"
+    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.notification(self, member).deliver
+          end
+        end
+      end
+      EOF
+      @runner.review('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.notification(self, member).deliver
+          end
+        end
+
+        def update_author
+        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"
+    end
+
+    it "should not raise when initiate an object in callback" do
+      content =<<-EOF
+      class Project < ActiveRecord::Base
+        after_create ProjectMailer.new
+      end
+      EOF
+      lambda { @runner.review('app/models/project.rb', content) }.should_not raise_error
+    end
+  end
+end

data/spec/rails_best_practices/checks/use_query_attribute_check_spec.rb

@@ -0,0 +1,192 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::UseQueryAttributeCheck do
+
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::UseQueryAttributeCheck.new)
+
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should_not be_empty
+    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)
+    errors = @runner.errors
+    errors.should be_empty
+  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)
+    errors = @runner.errors
+    errors.should be_empty
+  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)
+    errors = @runner.errors
+    errors.should be_empty
+  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)
+      errors = @runner.errors
+      errors.should be_empty
+    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)
+        errors = @runner.errors
+        errors.should be_empty
+      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)
+      errors = @runner.errors
+      errors.should be_empty
+    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)
+      errors = @runner.errors
+      errors.should be_empty
+    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)
+    errors = @runner.errors
+    errors.should be_empty
+  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)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end