rails_best_practices 0.6.1 → 0.6.5

data/spec/rails_best_practices/checks/keep_finders_on_their_own_model_check_spec.rb

@@ -0,0 +1,103 @@
+require '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.review('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 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.review('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.review('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.review('app/models/post.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not keep finders on their 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.review('app/models/post.rb', content)
+    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.review('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,101 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::LawOfDemeterCheck do
+
+  before :each do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::LawOfDemeterCheck.new)
+  end
+
+  describe "belongs_to" do
+    before(:each) do
+      content = <<-EOF
+      class Invoice < ActiveRecord::Base
+        belongs_to :user
+      end
+      EOF
+      @runner.prepare('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.review('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.review('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
+
+    it "should no law of demeter" do
+      content = <<-EOF
+      <%= @invoice.user_name %>
+      <%= @invoice.user_address %>
+      <%= @invoice.user_cellphone %>
+      EOF
+      @runner.review('app/views/invoices/show.html.erb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+  end
+
+  describe "has_one" do
+    before(:each) do
+      content = <<-EOF
+      class Invoice < ActiveRecord::Base
+        has_one :price
+      end
+      EOF
+      @runner.prepare('app/models/invoice.rb', content)
+    end
+
+    it "should law of demeter" do
+      content = <<-EOF
+      <%= @invoice.price.currency %>
+      <%= @invoice.price.number %>
+      EOF
+      @runner.review('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
+
+  it "should no law of demeter with method call" do
+    content = <<-EOF
+    class Question < ActiveRecord::Base
+      has_many :answers, :dependent => :destroy
+    end
+    EOF
+    @runner.prepare('app/models/question.rb', content)
+    content = <<-EOF
+    class Answer < ActiveRecord::Base
+      belongs_to :question, :counter_cache => true, :touch => true
+    end
+    EOF
+    @runner.prepare('app/models/answer.rb', content)
+    content = <<-EOF
+    class CommentsController < ApplicationController
+      def comment_url
+        question_path(@answer.question)
+      end
+    end
+    EOF
+    @runner.review('app/controllers/comments_controller.rb', 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 '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.review('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.review('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,28 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::MoveCodeIntoHelperCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveCodeIntoHelperCheck.new('array_count' => 2))
+  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.review('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 (array_count >= 2)"
+  end
+
+  it "should not move code into helper with simple arguments" do
+    content = <<-EOF
+    <%= select_tag :state, options_for_select( Post.STATES ) %>
+    EOF
+    @runner.review('app/views/posts/show.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end

data/spec/rails_best_practices/checks/move_code_into_model_check_spec.rb

@@ -0,0 +1,55 @@
+require '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.review('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 use_count > 2)"
+  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.review('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 use_count > 2)"
+  end
+
+  it "should move code into model only review for current if conditional statement" do
+    content =<<-EOF
+    <% if @post.title %>
+      <% if @post.user %>
+        <% if @post.description %>
+        <% end %>
+      <% end %>
+    <% end %>
+    EOF
+    @runner.review('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.review('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

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::MoveFinderToNamedScopeCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveFinderToNamedScopeCheck.new)
+  end
+
+  it "should move finder to named_scope" do
+    content = <<-EOF
+    class PostsController < ActionController::Base
+
+      def index
+        @public_posts = Post.find(:all, :conditions => { :state => 'public' },
+                                        :limit => 10,
+                                        :order => 'created_at desc')
+
+        @draft_posts  = Post.find(:all, :conditions => { :state => 'draft' },
+                                        :limit => 10,
+                                        :order => 'created_at desc')
+      end
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.size.should == 2
+    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
+    content = <<-EOF
+    class PostsController < ActionController::Base
+
+      def index
+        @all_posts = Post.find(:all)
+        @another_all_posts = Post.all
+        @first_post = Post.find(:first)
+        @another_first_post = Post.first
+        @last_post = Post.find(:last)
+        @another_last_post = Post.last
+      end
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    @runner.errors.should be_empty
+  end
+
+  it "should not move namd_scope" do
+    content = <<-EOF
+    class PostsController < ActionController::Base
+
+      def index
+        @public_posts = Post.published
+        @draft_posts  = Post.draft
+      end
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    @runner.errors.should be_empty
+  end
+
+  it "should not review model file" do
+    content = <<-EOF
+    class Post < ActiveRecord::Base
+
+      def published
+        Post.find(:all, :conditions => { :state => 'public' },
+                        :limit => 10, :order => 'created_at desc')
+      end
+
+      def published
+        Post.find(:all, :conditions => { :state => 'draft' },
+                        :limit => 10, :order => 'created_at desc')
+      end
+
+    end
+    EOF
+    @runner.review('app/model/post.rb', content)
+    @runner.errors.should be_empty
+
+  end
+end

data/spec/rails_best_practices/checks/move_model_logic_into_model_check_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::MoveModelLogicIntoModelCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::MoveModelLogicIntoModelCheck.new)
+  end
+
+  it "should move model logic into model" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def publish
+        @post = Post.find(params[:id])
+        @post.update_attributes(:is_published, true)
+        @post.approved_by = current_user
+        if @post.created_at > Time.now - 7.days
+          @post.popular = 100
+        else
+          @post.popular = 0
+        end
+      end
+
+      redirect_to post_url(@post)
+    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 - move model logic into model (@post use_count > 4)"
+  end
+
+  it "should not move model logic into model with simple model calling" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def publish
+        @post = Post.find(params[:id])
+        @post.update_attributes(:is_published, true)
+        @post.approved_by = current_user
+      end
+
+      redirect_to post_url(@post)
+    end
+    EOF
+    @runner.review('app/controllers/posts_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end