rails_best_practices 1.20.0 → 1.22.1

data/spec/rails_best_practices/reviews/not_use_time_ago_in_words_review_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe NotUseTimeAgoInWordsReview do
-      let(:runner) { Core::Runner.new(reviews: NotUseTimeAgoInWordsReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
       describe 'time_ago_in_words' do
-        it 'should not use in views' do
+        it 'does not use in views' do
           content = <<-EOF
           <%= time_ago_in_words(post.created_at) %>
           EOF
@@ -17,7 +17,7 @@ module RailsBestPractices
           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
+        it 'does not use in helpers' do
           content = <<-EOF
           def timeago
             content_tag(:p, time_ago_in_words(post.created_at))
@@ -30,7 +30,7 @@ module RailsBestPractices
       end
 
       describe 'distance_of_time_in_words_to_now' do
-        it 'should not use in views' do
+        it 'does not use in views' do
           content = <<-EOF
           <%= distance_of_time_in_words_to_now(post.created_at) %>
           EOF
@@ -39,7 +39,7 @@ module RailsBestPractices
           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
+        it 'does not use in helpers' do
           content = <<-EOF
           def timeago
             content_tag(:p, distance_of_time_in_words_to_now(post.created_at))
@@ -51,8 +51,8 @@ module RailsBestPractices
         end
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: NotUseTimeAgoInWordsReview.new(ignored_files: /posts_helper/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /posts_helper/))
         content = <<-EOF
           def timeago
             content_tag(:p, time_ago_in_words(post.created_at))

data/spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe OveruseRouteCustomizationsReview do
-      let(:runner) { Core::Runner.new(reviews: OveruseRouteCustomizationsReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should overuse route customizations' do
+      it 'overuses route customizations' do
         content = <<-EOF
         RailsBestpracticesCom::Application.routes.draw do
           resources :posts do
@@ -28,7 +28,7 @@ module RailsBestPractices
         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
+      it 'overuses route customizations another way' do
         content = <<-EOF
         RailsBestpracticesCom::Application.routes.draw do
           resources :posts do
@@ -44,7 +44,7 @@ module RailsBestPractices
         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
+      it 'does not overuse route customizations without customization' do
         content = <<-EOF
         RailsBestpracticesCom::Application.routes.draw do
           resources :posts
@@ -54,7 +54,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not overuse route customizations when customize route is only one' do
+      it 'does not overuse route customizations when customize route is only one' do
         content = <<-EOF
         RailsBestpracticesCom::Application.routes.draw do
           resources :posts do
@@ -68,8 +68,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: OveruseRouteCustomizationsReview.new(ignored_files: /config\/routes\.rb/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: %r{config/routes\.rb}))
         content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.resources :posts, member: { comments: :get,

data/spec/rails_best_practices/reviews/protect_mass_assignment_review_spec.rb

@@ -5,12 +5,14 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe ProtectMassAssignmentReview do
-      let(:runner) {
-        Core::Runner.new(prepares: [Prepares::GemfilePrepare.new, Prepares::ConfigPrepare.new, Prepares::InitializerPrepare.new],
-                         reviews: ProtectMassAssignmentReview.new)
-      }
+      let(:runner) do
+        Core::Runner.new(
+          prepares: [Prepares::GemfilePrepare.new, Prepares::ConfigPrepare.new, Prepares::InitializerPrepare.new],
+          reviews: described_class.new
+        )
+      end
 
-      it 'should protect mass assignment' do
+      it 'protects mass assignment' do
         content = <<-EOF
         class User < ActiveRecord::Base
         end
@@ -20,7 +22,7 @@ module RailsBestPractices
         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
+      it 'does not protect mass assignment if attr_accessible is used with arguments and user set config.active_record.whitelist_attributes' do
         content = <<-EOF
         module RailsBestPracticesCom
           class Application < Rails::Application
@@ -38,7 +40,7 @@ module RailsBestPractices
         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
+      it 'does not protect mass assignment if attr_accessible is used without arguments and user set config.active_record.whitelist_attributes' do
         content = <<-EOF
         module RailsBestPracticesCom
           class Application < Rails::Application
@@ -56,7 +58,7 @@ module RailsBestPractices
         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
+      it 'does not protect mass assignment with attr_protected if user set config.active_record.whitelist_attributes' do
         content = <<-EOF
         module RailsBestPracticesCom
           class Application < Rails::Application
@@ -74,7 +76,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not protect mass assignment if using devise' do
+      it 'does not protect mass assignment if using devise' do
         content = <<-EOF
         class User < ActiveRecord::Base
           devise :database_authenticatable, :registerable, :confirmable, :recoverable, stretches: 20
@@ -84,7 +86,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not protect mass assignment if using authlogic with configuration' do
+      it 'does not protect mass assignment if using authlogic with configuration' do
         content = <<-EOF
         class User < ActiveRecord::Base
           acts_as_authentic do |c|
@@ -96,7 +98,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not protect mass assignment if using authlogic without configuration' do
+      it 'does not protect mass assignment if using authlogic without configuration' do
         content = <<-EOF
         class User < ActiveRecord::Base
           acts_as_authentic
@@ -106,7 +108,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not protect mass assignment if checking non ActiveRecord::Base inherited model' do
+      it 'does not protect mass assignment if checking non ActiveRecord::Base inherited model' do
         content = <<-EOF
         class User < Person
         end
@@ -116,7 +118,7 @@ module RailsBestPractices
       end
 
       context 'strong_parameters' do
-        it 'should not protect mass assignment for strong_parameters' do
+        it 'does not protect mass assignment for strong_parameters' do
           content = <<-EOF
           class User < ActiveRecord::Base
             include ActiveModel::ForbiddenAttributesProtection
@@ -126,7 +128,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not protect mass assignment for strong_parameters' do
+        it 'does not protect mass assignment for strong_parameters' do
           content = <<-EOF
           class AR
             ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)
@@ -143,7 +145,7 @@ module RailsBestPractices
       end
 
       context 'activerecord 4' do
-        it 'should not protect mass assignment for activerecord 4' do
+        it 'does not protect mass assignment for activerecord 4' do
           content = <<-EOF
   GEM
     remote: https://rubygems.org
@@ -159,7 +161,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should protect mass assignment for activerecord 3' do
+        it 'protects mass assignment for activerecord 3' do
           content = <<-EOF
   GEM
     remote: https://rubygems.org
@@ -176,9 +178,12 @@ module RailsBestPractices
         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/))
+      it 'does not check ignored files' do
+        runner =
+          Core::Runner.new(
+            prepares: [Prepares::GemfilePrepare.new, Prepares::ConfigPrepare.new, Prepares::InitializerPrepare.new],
+            reviews: described_class.new(ignored_files: %r{app/models/user\.rb})
+          )
         content = <<-EOF
         class User < ActiveRecord::Base
         end

data/spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe RemoveEmptyHelpersReview do
-      let(:runner) { Core::Runner.new(reviews: RemoveEmptyHelpersReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should remove empty helpers' do
+      it 'removes empty helpers' do
         content = <<-EOF
         module PostsHelper
         end
@@ -17,7 +17,7 @@ module RailsBestPractices
         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
+      it 'does not remove empty helpers' do
         content = <<-EOF
         module PostsHelper
           def post_link(post)
@@ -29,7 +29,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not remove empty application_helper' do
+      it 'does not remove empty application_helper' do
         content = <<-EOF
         module ApplicationHelper
         end
@@ -38,8 +38,8 @@ module RailsBestPractices
         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/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /posts_helper/))
         content = <<-EOF
         module PostsHelper
         end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb

@@ -5,15 +5,15 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe RemoveUnusedMethodsInControllersReview do
-      let(:runner) {
+      let(:runner) do
         Core::Runner.new(
           prepares: [Prepares::ControllerPrepare.new, Prepares::RoutePrepare.new],
-          reviews: RemoveUnusedMethodsInControllersReview.new('except_methods' => ['ExceptableController#*'])
+          reviews: described_class.new('except_methods' => ['ExceptableController#*'])
         )
-      }
+      end
 
       context 'private/protected' do
-        it 'should remove unused methods' do
+        it 'removes unused methods' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts do
@@ -40,11 +40,15 @@ module RailsBestPractices
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
           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)')
+          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
+        it 'does not remove unused methods for before_filter' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -66,7 +70,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods for around_filter' do
+        it 'does not remove unused methods for around_filter' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -91,7 +95,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods for around_action (new syntax)' do
+        it 'does not remove unused methods for around_action (new syntax)' do
           content = <<-EOF
           class PostsController < ActiveRecord::Base
             around_action :use_time_zone
@@ -109,7 +113,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods for layout' do
+        it 'does not remove unused methods for layout' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -131,7 +135,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove inherited_resources methods' do
+        it 'does not remove inherited_resources methods' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -155,7 +159,7 @@ module RailsBestPractices
       end
 
       context 'public' do
-        it 'should remove unused methods' do
+        it 'removes unused methods' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -172,10 +176,12 @@ module RailsBestPractices
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
           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)')
+          expect(runner.errors[0].to_s).to eq(
+            'app/controllers/posts_controller.rb:3 - remove unused methods (PostsController#list)'
+          )
         end
 
-        it 'should not remove inline routes' do
+        it 'does not remove inline routes' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts, only: :none do
@@ -196,7 +202,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods if all actions are used in route' do
+        it 'does not remove unused methods if all actions are used in route' do
           content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.connect 'internal/:action/*whatever', controller: "internal"
@@ -216,7 +222,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods if they are except_methods' do
+        it 'does not remove unused methods if they are except_methods' do
           content = <<-EOF
           class ExceptableController < ApplicationController
             def list; end
@@ -230,7 +236,7 @@ module RailsBestPractices
       end
 
       context 'assignment' do
-        it 'should not remove unused methods if call in base class' do
+        it 'does not remove unused methods if call in base class' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :user, only: :show do; end
@@ -259,7 +265,7 @@ module RailsBestPractices
       end
 
       context 'helper_method' do
-        it 'should remove unused methods if helper method is not called' do
+        it 'removes unused methods if helper method is not called' do
           content = <<-EOF
           class PostsController < ApplicationController
             helper_method :helper_post
@@ -271,10 +277,12 @@ module RailsBestPractices
           runner.review('app/controllers/posts_controller.rb', content)
           runner.after_review
           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)')
+          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
+        it 'does not remove unused methods if call helper method in views' do
           content = <<-EOF
           class PostsController < ApplicationController
             helper_method :helper_post
@@ -292,7 +300,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods if call helper method in helpers' do
+        it 'does not remove unused methods if call helper method in helpers' do
           content = <<-EOF
           class PostsController < ApplicationController
             helper_method :helper_post
@@ -316,7 +324,7 @@ module RailsBestPractices
       end
 
       context 'delegate to: :controller' do
-        it 'should remove unused methods if delegate method is not called' do
+        it 'removes unused methods if delegate method is not called' do
           content = <<-EOF
           class PostsController < ApplicationController
             protected
@@ -333,10 +341,12 @@ module RailsBestPractices
           runner.review('app/helpers/posts_helper.rb', content)
           runner.after_review
           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)')
+          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
+        it 'removes unused methods if delegate method is called' do
           content = <<-EOF
           class PostsController < ApplicationController
             protected
@@ -361,7 +371,7 @@ module RailsBestPractices
       end
 
       context 'cells' do
-        it 'should remove unused methods' do
+        it 'removes unused methods' do
           content = <<-EOF
           class PostsCell < Cell::Rails
             def list; end
@@ -374,7 +384,7 @@ module RailsBestPractices
           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
+        it 'does not remove unused methods if render_cell' do
           content = <<-EOF
           class PostsCell < Cell::Rails
             def list; end
@@ -392,7 +402,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not remove unused methods if render with state' do
+        it 'does not remove unused methods if render with state' do
           content = <<-EOF
           class PostsCell < Cell::Rails
             def list
@@ -415,7 +425,7 @@ module RailsBestPractices
         end
       end
 
-      it 'should not remove unused methods' do
+      it 'does not remove unused methods' do
         route_content = <<-EOF
         RailsBestPracticesCom::Application.routes.draw do
           namespace :admin do
@@ -452,9 +462,12 @@ module RailsBestPractices
         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: []))
+      it 'does not check ignored files' do
+        runner =
+          Core::Runner.new(
+            prepares: [Prepares::ControllerPrepare.new, Prepares::RoutePrepare.new],
+            reviews: described_class.new(ignored_files: /posts_controller/, except_methods: [])
+          )
         content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts do

data/spec/rails_best_practices/reviews/remove_unused_methods_in_helpers_review_spec.rb

@@ -5,14 +5,14 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe RemoveUnusedMethodsInHelpersReview do
-      let(:runner) {
+      let(:runner) do
         Core::Runner.new(
           prepares: [Prepares::ControllerPrepare.new, Prepares::HelperPrepare.new],
-          reviews: RemoveUnusedMethodsInHelpersReview.new(except_methods: [])
+          reviews: described_class.new(except_methods: [])
         )
-      }
+      end
 
-      it 'should remove unused methods' do
+      it 'removes unused methods' do
         content = <<-EOF
         module PostsHelper
           def unused; end
@@ -22,10 +22,12 @@ module RailsBestPractices
         runner.review('app/helpers/posts_helper.rb', content)
         runner.after_review
         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)')
+        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
+      it 'does not remove unused methods if called on views' do
         content = <<-EOF
         module PostsHelper
           def used?(post); end
@@ -42,7 +44,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not remove unused methods if called on helpers' do
+      it 'does not remove unused methods if called on helpers' do
         content = <<-EOF
         module PostsHelper
           def used?(post)
@@ -63,7 +65,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not remove unused methods if called on controllers' do
+      it 'does not remove unused methods if called on controllers' do
         helper_content = <<-EOF
         module PostsHelper
           def used?(post); end
@@ -88,7 +90,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not remove unused methods if called in descendant controllers' do
+      it 'does not remove unused methods if called in descendant controllers' do
         application_helper_content = <<-EOF
         module ApplicationHelper
           def admin?; end
@@ -118,9 +120,12 @@ module RailsBestPractices
         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: []))
+      it 'does not check ignored files' do
+        runner =
+          Core::Runner.new(
+            prepares: [Prepares::ControllerPrepare.new, Prepares::HelperPrepare.new],
+            reviews: described_class.new(ignored_files: /posts_helper/, except_methods: [])
+          )
 
         content = <<-EOF
         module PostsHelper