rails_best_practices 1.14.4 → 1.15.1

data/spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb

@@ -11,8 +11,8 @@ module RailsBestPractices
           <%= time_ago_in_words(post.created_at) %>
           EOF
           runner.review('app/views/posts/show.html.erb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/views/posts/show.html.erb:1 - not use time_ago_in_words"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/views/posts/show.html.erb:1 - not use time_ago_in_words")
         end
 
         it "should not use in helpers" do
@@ -22,8 +22,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - not use time_ago_in_words"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:2 - not use time_ago_in_words")
         end
       end
 
@@ -33,8 +33,8 @@ module RailsBestPractices
           <%= distance_of_time_in_words_to_now(post.created_at) %>
           EOF
           runner.review('app/views/posts/show.html.erb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/views/posts/show.html.erb:1 - not use time_ago_in_words"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/views/posts/show.html.erb:1 - not use time_ago_in_words")
         end
 
         it "should not use in helpers" do
@@ -44,10 +44,21 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - not use time_ago_in_words"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:2 - not use time_ago_in_words")
         end
       end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: NotUseTimeAgoInWordsReview.new(ignored_files: /posts_helper/))
+        content =<<-EOF
+          def timeago
+            content_tag(:p, time_ago_in_words(post.created_at))
+          end
+        EOF
+        runner.review('app/helpers/posts_helper.rb', content)
+        expect(runner.errors.size).to eq(0)
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb

@@ -16,8 +16,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - overuse route customizations (customize_count > 3)")
         end
 
         it "should overuse route customizations with member" do
@@ -30,8 +30,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - overuse route customizations (customize_count > 3)")
         end
 
         it "should overuse route customizations with collection" do
@@ -44,8 +44,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - overuse route customizations (customize_count > 3)")
         end
 
         it "should overuse route customizations with hash member and collection" do
@@ -60,8 +60,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:3 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - overuse route customizations (customize_count > 3)")
         end
 
         it "should overuse route customizations with array member and collection" do
@@ -74,8 +74,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:3 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:3 - overuse route customizations (customize_count > 3)")
         end
 
         it "should not overuse route customizations without customization" do
@@ -85,7 +85,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not overuse route customizations when customize route is only one" do
@@ -95,7 +95,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not raise error for constants in routes" do
@@ -108,7 +108,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -130,8 +130,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - overuse route customizations (customize_count > 3)")
         end
 
         it "should overuse route customizations another way" do
@@ -146,8 +146,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "config/routes.rb:2 - overuse route customizations (customize_count > 3)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("config/routes.rb:2 - overuse route customizations (customize_count > 3)")
         end
 
         it "should not overuse route customizations without customization" do
@@ -157,7 +157,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not overuse route customizations when customize route is only one" do
@@ -171,9 +171,23 @@ module RailsBestPractices
           end
           EOF
           runner.review('config/routes.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: OveruseRouteCustomizationsReview.new(ignored_files: /config\/routes\.rb/))
+        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)
+        expect(runner.errors.size).to eq(0)
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb

@@ -12,8 +12,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:1 - protect mass assignment"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/user.rb:1 - protect mass assignment")
       end
 
       it "should not protect mass assignment if attr_accessible is used with arguments and user set config.active_record.whitelist_attributes" do
@@ -31,7 +31,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment if attr_accessible is used without arguments and user set config.active_record.whitelist_attributes" do
@@ -49,7 +49,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment with attr_protected if user set config.active_record.whitelist_attributes" do
@@ -67,7 +67,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment if using devise" do
@@ -77,7 +77,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment if using authlogic with configuration" do
@@ -89,7 +89,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment if using authlogic without configuration" do
@@ -99,7 +99,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not protect mass assignment if checking non ActiveRecord::Base inherited model" do
@@ -108,7 +108,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       context "strong_parameters" do
@@ -119,7 +119,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/models/user.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not protect mass assignment for strong_parameters" do
@@ -134,7 +134,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/models/user.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -152,7 +152,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/models/user.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should protect mass assignment for rails 3" do
@@ -168,9 +168,21 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/models/user.rb', content)
-          runner.should have(1).errors
+          expect(runner.errors.size).to eq(1)
         end
       end
+
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(prepares: [Prepares::GemfilePrepare.new, Prepares::ConfigPrepare.new, Prepares::InitializerPrepare.new],
+                                  reviews: ProtectMassAssignmentReview.new(ignored_files: /app\/models\/user\.rb/))
+        content =<<-EOF
+        class User < ActiveRecord::Base
+        end
+        EOF
+        runner.review('app/models/user.rb', content)
+        expect(runner.errors.size).to eq(0)
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb

@@ -11,8 +11,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/helpers/posts_helper.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:1 - remove empty helpers"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:1 - remove empty helpers")
       end
 
       it "should not remove empty helpers" do
@@ -24,7 +24,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/helpers/posts_helper.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not remove empty application_helper" do
@@ -33,7 +33,17 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/helpers/application_helper.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: RemoveEmptyHelpersReview.new(ignored_files: /posts_helper/))
+        content =<<-EOF
+        module PostsHelper
+        end
+        EOF
+        runner.review('app/helpers/posts_helper.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -35,9 +35,9 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(2).errors
-          runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:6 - remove unused methods (PostsController#load_post)"
-          runner.errors[1].to_s.should == "app/controllers/posts_controller.rb:8 - remove unused methods (PostsController#load_user)"
+          expect(runner.errors.size).to eq(2)
+          expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:6 - remove unused methods (PostsController#load_post)")
+          expect(runner.errors[1].to_s).to eq("app/controllers/posts_controller.rb:8 - remove unused methods (PostsController#load_user)")
         end
 
         it "should not remove unused methods for before_filter" do
@@ -59,7 +59,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove unused methods for around_filter" do
@@ -84,7 +84,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove unused methods for layout" do
@@ -106,7 +106,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove inherited_resources methods" do
@@ -128,7 +128,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -149,8 +149,8 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#list)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#list)")
         end
 
         it "should not remove unused methods if all actions are used in route" do
@@ -170,7 +170,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/internal_controller.rb', content)
           runner.review('app/controllers/internal_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove unused methods if they are except_methods" do
@@ -182,7 +182,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/exceptable_controller.rb', content)
           runner.review('app/controllers/exceptable_controller.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -211,7 +211,7 @@ module RailsBestPractices
           runner.review('app/controllers/application_controller.rb', application_content)
           runner.review('app/controllers/users_controller.rb', users_content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -227,8 +227,8 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:4 - remove unused methods (PostsController#helper_post)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:4 - remove unused methods (PostsController#helper_post)")
         end
 
         it "should not remove unused methods if call helper method in views" do
@@ -246,7 +246,7 @@ module RailsBestPractices
           EOF
           runner.review('app/views/posts/show.html.erb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove unused methods if call helper method in helpers" do
@@ -268,7 +268,7 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -289,8 +289,8 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           runner.after_review
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#helper_post)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#helper_post)")
         end
 
         it "should remove unused methods if delegate method is called" do
@@ -313,7 +313,7 @@ module RailsBestPractices
           EOF
           runner.review('app/views/posts/show.html.erb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
 
@@ -327,8 +327,8 @@ module RailsBestPractices
           runner.prepare('app/cells/posts_cell.rb', content)
           runner.review('app/cells/posts_cell.rb', content)
           runner.after_review
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/cells/posts_cell.rb:2 - remove unused methods (PostsCell#list)"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("app/cells/posts_cell.rb:2 - remove unused methods (PostsCell#list)")
         end
 
         it "should not remove unused methods if render_cell" do
@@ -346,7 +346,7 @@ module RailsBestPractices
           EOF
           runner.review('app/views/posts/index.html.erb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should not remove unused methods if render with state" do
@@ -368,9 +368,77 @@ module RailsBestPractices
           EOF
           runner.review('app/views/posts/index.html.erb', content)
           runner.after_review
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
       end
+
+      it "should not remove unused methods" do
+        route_content =<<-EOF
+        RailsBestPracticesCom::Application.routes.draw do
+          namespace :admin do
+            resources :users, only: :index
+          end
+        end
+        EOF
+        app_controller_content =<<-EOF
+        module Admin
+          class AppController < ApplicationController
+            def index
+              @collection = model.all
+            end
+          end
+        end
+        EOF
+        users_controller_content =<<-EOF
+        module Admin
+          class UsersController < AppController
+            private
+
+            def model
+              User
+            end
+          end
+        end
+        EOF
+        runner.prepare('config/routes.rb', route_content)
+        runner.prepare('app/controllers/admin/app_controller.rb', app_controller_content)
+        runner.prepare('app/controllers/admin/users_controller.rb', users_controller_content)
+        runner.review('app/controllers/admin/app_controller.rb', app_controller_content)
+        runner.review('app/controllers/admin/users_controller.rb', users_controller_content)
+        runner.after_review
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(prepares: [Prepares::ControllerPrepare.new, Prepares::RoutePrepare.new],
+                                  reviews: RemoveUnusedMethodsInControllersReview.new(ignored_files: /posts_controller/, except_methods: []))
+        content =<<-EOF
+          RailsBestPracticesCom::Application.routes.draw do
+            resources :posts do
+              member do
+                post 'link_to/:other_id' => 'posts#link_to_post'
+                post 'extra_update' => 'posts#extra_update'
+              end
+            end
+          end
+        EOF
+        runner.prepare('config/routes.rb', content)
+        content =<<-EOF
+          class PostsController < ActiveRecord::Base
+            def show; end
+            def extra_update; end
+            def link_to_post; end
+            protected
+            def load_post; end
+            private
+            def load_user; end
+          end
+        EOF
+        runner.prepare('app/controllers/posts_controller.rb', content)
+        runner.review('app/controllers/posts_controller.rb', content)
+        runner.after_review
+        expect(runner.errors.size).to eq(0)
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_helpers_review_spec.rb

@@ -17,8 +17,8 @@ module RailsBestPractices
         runner.prepare('app/helpers/posts_helper.rb', content)
         runner.review('app/helpers/posts_helper.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - remove unused methods (PostsHelper#unused)"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:2 - remove unused methods (PostsHelper#unused)")
       end
 
       it "should not remove unused methods if called on views" do
@@ -35,7 +35,7 @@ module RailsBestPractices
         EOF
         runner.review('app/views/posts/show.html.erb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not remove unused methods if called on helpers" do
@@ -56,7 +56,7 @@ module RailsBestPractices
         EOF
         runner.review('app/views/posts/show.html.erb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not remove unused methods if called on controllers" do
@@ -81,8 +81,23 @@ module RailsBestPractices
         runner.review('app/helpers/posts_helper.rb', helper_content)
         runner.review('app/controllers/posts_controller.rb', controller_content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
+
+       it "should not check ignored files" do
+        runner = Core::Runner.new(prepares: [Prepares::ControllerPrepare.new, Prepares::HelperPrepare.new],
+                                  reviews: RemoveUnusedMethodsInHelpersReview.new(ignored_files: /posts_helper/, except_methods: []))
+
+        content =<<-EOF
+        module PostsHelper
+          def unused; end
+        end
+        EOF
+        runner.prepare('app/helpers/posts_helper.rb', content)
+        runner.review('app/helpers/posts_helper.rb', content)
+        runner.after_review
+        expect(runner.errors.size).to eq(0)
+       end
     end
   end
 end