rails_best_practices 0.6.1 → 0.6.5

data/spec/rails_best_practices/checks/needless_deep_nesting_check_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::NeedlessDeepNestingCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NeedlessDeepNestingCheck.new)
+  end
+
+  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.review('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 needless deep nesting with resource" do
+      content = <<-EOF
+      map.resources :posts do |post|
+        post.resources :comments do |comment|
+          comment.resource :vote
+        end
+      end
+      EOF
+      @runner.review('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 needless deep nesting with block node" do
+      content = <<-EOF
+      map.resources :posts do |post|
+        post.resources :comments do |comment|
+          comment.resources :favorites
+        end
+        post.resources :votes
+      end
+      EOF
+      @runner.review('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.review('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+
+    it "should no needless deep nesting with block node" do
+      content = <<-EOF
+      map.resources :comments do |comment|
+        comment.resources :favorites
+        comment.resources :votes
+      end
+      EOF
+      @runner.review('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+  end
+
+  describe "rails3" do
+    it "should needless deep nesting" do
+      content = <<-EOF
+      resources :posts do
+        resources :comments do
+          resources :favorites
+        end
+      end
+      EOF
+      @runner.review('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
+
+    it "should needless deep nesting with resource" do
+      content = <<-EOF
+      resources :posts do
+        resources :comments do
+          resource :vote
+        end
+      end
+      EOF
+      @runner.review('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
+
+    it "should needless deep nesting with block node" do
+      content = <<-EOF
+      resources :posts do
+        resources :comments do
+          resources :favorites
+        end
+        resources :votes
+      end
+      EOF
+      @runner.review('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
+
+    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.review('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

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::NotUseDefaultRouteCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::NotUseDefaultRouteCheck.new)
+  end
+
+  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.review('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.review('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+  end
+
+  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.review('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.review('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

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::OveruseRouteCustomizationsCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::OveruseRouteCustomizationsCheck.new)
+  end
+
+  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 => :update,
+                                           :delete_comment => :delete }
+      end
+      EOF
+      @runner.review('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 => :update,
+                                           :delete_comment => :delete },
+                              :collection => { :comments => :get }
+      end
+      EOF
+      @runner.review('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 => :update,
+                                                  :delete_comment => :delete },
+                                     :collection => { :comments => :get }
+        end
+      end
+      EOF
+      @runner.review('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.review('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.review('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+
+    it "should not raise error for constants in routes" do
+      content =<<-EOF
+      IP_PATTERN = /(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[0-9]{1,2})\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[0-9]{1,2}))|[\d]+/.freeze
+      map.resources :vlans do |vlan|
+        vlan.resources :ip_ranges, :member => {:move => [:get, :post]} do |range|
+          range.resources :ips, :requirements => { :id => IP_PATTERN }
+        end
+      end
+      EOF
+      @runner.review('config/routes.rb', content)
+      errors = @runner.errors
+      errors.should be_empty
+    end
+  end
+
+  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
+            update :update_comment
+            delete :delete_comment
+          end
+
+          collection do
+            get :comments
+          end
+        end
+      end
+      EOF
+      @runner.review('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
+          update :update_comment, :on => :member
+          delete :delete_comment, :on => :member
+          get :comments, :on => :collection
+        end
+      end
+      EOF
+      @runner.review('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.review('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.review('config/routes.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

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck do
+  before(:each) do
+    @runner = RailsBestPractices::Core::Runner.new(RailsBestPractices::Checks::ReplaceComplexCreationWithFactoryMethodCheck.new)
+  end
+
+  it "should replace complex creation with factory method" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.vip = (@invoice.amount > 1000)
+
+        if Time.now.day > 15
+          @invoice.deliver_time = Time.now + 2.month
+        else
+          @invoice.deliver_time = Time.now + 1.month
+        end
+
+        @invoice.save
+      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)"
+  end
+
+  it "should not replace complex creation with factory method with simple creation" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.save
+      end
+    end
+    EOF
+    @runner.review('app/controllers/invoices_controller.rb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+
+  it "should not replace complex creation with factory method when attrasgn_count is 5" do
+    content = <<-EOF
+    class InvoiceController < ApplicationController
+
+      def create
+        @invoice = Invoice.new(params[:invoice])
+        @invoice.address = current_user.address
+        @invoice.phone = current_user.phone
+        @invoice.vip = (@invoice.amount > 1000)
+
+        if Time.now.day > 15
+          @invoice.deliver_time = Time.now + 2.month
+        else
+          @invoice.deliver_time = Time.now + 1.month
+        end
+
+        @invoice.save
+      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
+  end
+end

data/spec/rails_best_practices/checks/replace_instance_variable_with_local_variable_check_spec.rb

@@ -0,0 +1,36 @@
+require '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.review('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 replace instance variable with local varialbe in haml file" do
+    content = <<-EOF
+= @post.title
+    EOF
+    @runner.review('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 %>
+    EOF
+    @runner.review('app/views/posts/_post.html.erb', content)
+    errors = @runner.errors
+    errors.should be_empty
+  end
+end