rails_best_practices 1.20.0 → 1.20.1

data/spec/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe ReplaceComplexCreationWithFactoryMethodReview do
-      let(:runner) { Core::Runner.new(reviews: ReplaceComplexCreationWithFactoryMethodReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should replace complex creation with factory method' do
+      it 'replaces complex creation with factory method' do
         content = <<-EOF
         class InvoiceController < ApplicationController
           def create
@@ -28,10 +28,12 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/invoices_controller.rb', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/controllers/invoices_controller.rb:2 - replace complex creation with factory method (@invoice attribute_assignment_count > 2)')
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/invoices_controller.rb:2 - 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
+      it 'does not replace complex creation with factory method with simple creation' do
         content = <<-EOF
         class InvoiceController < ApplicationController
           def create
@@ -46,7 +48,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not replace complex creation with factory method when attrasgn_count is 5' do
+      it 'does not replace complex creation with factory method when attrasgn_count is 5' do
         content = <<-EOF
         class InvoiceController < ApplicationController
           def create
@@ -65,13 +67,13 @@ module RailsBestPractices
           end
         end
         EOF
-        runner = Core::Runner.new(reviews: ReplaceComplexCreationWithFactoryMethodReview.new('attribute_assignment_count' => 5))
+        runner = Core::Runner.new(reviews: described_class.new('attribute_assignment_count' => 5))
         runner.review('app/controllers/invoices_controller.rb', content)
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: ReplaceComplexCreationWithFactoryMethodReview.new(ignored_files: /invoices_controller/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /invoices_controller/))
         content = <<-EOF
         class InvoiceController < ApplicationController
           def create

data/spec/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review_spec.rb

@@ -5,36 +5,42 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe ReplaceInstanceVariableWithLocalVariableReview do
-      let(:runner) { Core::Runner.new(reviews: ReplaceInstanceVariableWithLocalVariableReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should replace instance variable with local varialbe' do
+      it 'replaces instance variable with local varialbe' do
         content = <<-EOF
         <%= @post.title %>
         EOF
         runner.review('app/views/posts/_post.html.erb', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/views/posts/_post.html.erb:1 - replace instance variable with local variable')
+        expect(runner.errors[0].to_s).to eq(
+          '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
+      it 'replaces instance variable with local varialbe in haml file' do
         content = <<~EOF
           = @post.title
         EOF
         runner.review('app/views/posts/_post.html.haml', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/views/posts/_post.html.haml:1 - replace instance variable with local variable')
+        expect(runner.errors[0].to_s).to eq(
+          'app/views/posts/_post.html.haml:1 - replace instance variable with local variable'
+        )
       end
 
-      it 'should replace instance variable with local varialbe in slim file' do
+      it 'replaces instance variable with local varialbe in slim file' do
         content = <<~EOF
           = @post.title
         EOF
         runner.review('app/views/posts/_post.html.slim', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/views/posts/_post.html.slim:1 - replace instance variable with local variable')
+        expect(runner.errors[0].to_s).to eq(
+          'app/views/posts/_post.html.slim:1 - replace instance variable with local variable'
+        )
       end
 
-      it 'should not replace instance variable with local varialbe' do
+      it 'does not replace instance variable with local varialbe' do
         content = <<-EOF
         <%= post.title %>
         EOF
@@ -42,8 +48,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: ReplaceInstanceVariableWithLocalVariableReview.new(ignored_files: /views\/posts/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: %r{views/posts}))
         content = <<-EOF
         <%= @post.title %>
         EOF

data/spec/rails_best_practices/reviews/restrict_auto_generated_routes_review_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe RestrictAutoGeneratedRoutesReview do
-      let(:runner) { Core::Runner.new(prepares: Prepares::ControllerPrepare.new, reviews: RestrictAutoGeneratedRoutesReview.new) }
+      let(:runner) { Core::Runner.new(prepares: Prepares::ControllerPrepare.new, reviews: described_class.new) }
 
       describe 'resources' do
-        before :each do
+        before do
           content = <<-EOF
           class PostsController < ApplicationController
             def show; end
@@ -22,7 +22,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
         end
 
-        it 'should restrict auto-generated routes' do
+        it 'restricts auto-generated routes' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -30,10 +30,12 @@ module RailsBestPractices
           EOF
           runner.review('config/routes.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])')
+          expect(runner.errors[0].to_s).to eq(
+            'config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])'
+          )
         end
 
-        it 'should not restrict auto-generated routes with only' do
+        it 'does not restrict auto-generated routes with only' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts, only: %w(show new create edit update destroy)
@@ -43,7 +45,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not restrict auto-generated routes with except' do
+        it 'does not restrict auto-generated routes with except' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts, except: :index
@@ -54,7 +56,7 @@ module RailsBestPractices
         end
 
         describe 'specify a controller' do
-          it 'should restrict auto-generated routes' do
+          it 'restricts auto-generated routes' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :articles, controller: "posts"
@@ -62,7 +64,9 @@ module RailsBestPractices
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes articles (except: [:index])')
+            expect(runner.errors[0].to_s).to eq(
+              'config/routes.rb:2 - restrict auto-generated routes articles (except: [:index])'
+            )
           end
         end
 
@@ -81,7 +85,7 @@ module RailsBestPractices
             runner.prepare('app/controllers/admin/comments_controller.rb', content)
           end
 
-          it 'should restrict auto-generated routes' do
+          it 'restricts auto-generated routes' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               namespace :admin do
@@ -91,10 +95,12 @@ module RailsBestPractices
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq('config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])')
+            expect(runner.errors[0].to_s).to eq(
+              'config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])'
+            )
           end
 
-          it 'should restrict auto-generated routes with scope :module' do
+          it 'restricts auto-generated routes with scope :module' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               scope module: :admin do
@@ -104,10 +110,12 @@ module RailsBestPractices
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq('config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])')
+            expect(runner.errors[0].to_s).to eq(
+              'config/routes.rb:3 - restrict auto-generated routes admin/comments (except: [:index])'
+            )
           end
 
-          it 'should restrict auto-generated routes with resources :module' do
+          it 'restricts auto-generated routes with resources :module' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :comments, module: :admin
@@ -115,12 +123,14 @@ module RailsBestPractices
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes admin/comments (except: [:index])')
+            expect(runner.errors[0].to_s).to eq(
+              'config/routes.rb:2 - restrict auto-generated routes admin/comments (except: [:index])'
+            )
           end
         end
 
         describe 'nested routes' do
-          before :each do
+          before do
             content = <<-EOF
             class CommentsController < ApplicationController
               def index; end
@@ -135,7 +145,7 @@ module RailsBestPractices
             runner.prepare('app/controllers/comments_controller.rb', content)
           end
 
-          it 'should restrict auto-generated routes' do
+          it 'restricts auto-generated routes' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :posts do
@@ -145,10 +155,12 @@ module RailsBestPractices
             EOF
             runner.review('config/routes.rb', content)
             expect(runner.errors.size).to eq(1)
-            expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])')
+            expect(runner.errors[0].to_s).to eq(
+              'config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])'
+            )
           end
 
-          it 'should not restrict auto-generated routes with only' do
+          it 'does not restrict auto-generated routes with only' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :posts, only: %w(show new create edit update destroy) do
@@ -160,7 +172,7 @@ module RailsBestPractices
             expect(runner.errors.size).to eq(0)
           end
 
-          it 'should not restrict auto-generated routes with except' do
+          it 'does not restrict auto-generated routes with except' do
             content = <<-EOF
             RailsBestPracticesCom::Application.routes.draw do
               resources :posts, except: :index do
@@ -175,7 +187,7 @@ module RailsBestPractices
       end
 
       describe 'resource' do
-        before :each do
+        before do
           content = <<-EOF
           class AccountsController < ApplicationController
             def show; end
@@ -188,7 +200,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/accounts_controller.rb', content)
         end
 
-        it 'should restrict auto-generated routes' do
+        it 'restricts auto-generated routes' do
           content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.resource :account
@@ -196,10 +208,12 @@ module RailsBestPractices
           EOF
           runner.review('config/routes.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes account (except: [:destroy])')
+          expect(runner.errors[0].to_s).to eq(
+            'config/routes.rb:2 - restrict auto-generated routes account (except: [:destroy])'
+          )
         end
 
-        it 'should not restrict auto-generated routes with only' do
+        it 'does not restrict auto-generated routes with only' do
           content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.resource :account, only: %w(show new create edit update)
@@ -209,7 +223,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should not restrict auto-generated routes with except' do
+        it 'does not restrict auto-generated routes with except' do
           content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
             map.resource :account, except: :destroy
@@ -219,9 +233,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,
-                                    reviews: RestrictAutoGeneratedRoutesReview.new(ignored_files: /config\/routes\.rb/))
+        it 'does not check ignored files' do
+          runner =
+            Core::Runner.new(
+              prepares: Prepares::ControllerPrepare.new,
+              reviews: described_class.new(ignored_files: %r{config/routes\.rb})
+            )
 
           content = <<-EOF
           ActionController::Routing::Routes.draw do |map|
@@ -234,7 +251,11 @@ module RailsBestPractices
       end
 
       context 'api_only = true' do
-        let(:runner) { Core::Runner.new(prepares: [Prepares::ConfigPrepare.new, Prepares::ControllerPrepare.new], reviews: RestrictAutoGeneratedRoutesReview.new) }
+        let(:runner) do
+          Core::Runner.new(
+            prepares: [Prepares::ConfigPrepare.new, Prepares::ControllerPrepare.new], reviews: described_class.new
+          )
+        end
 
         before do
           content = <<-EOF
@@ -256,7 +277,7 @@ module RailsBestPractices
           runner.prepare('app/controllers/posts_controller.rb', content)
         end
 
-        it 'should restrict auto-generated routes' do
+        it 'restricts auto-generated routes' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts
@@ -264,10 +285,12 @@ module RailsBestPractices
           EOF
           runner.review('config/routes.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq('config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])')
+          expect(runner.errors[0].to_s).to eq(
+            'config/routes.rb:2 - restrict auto-generated routes posts (except: [:index])'
+          )
         end
 
-        it 'should not restrict auto-generated routes with only' do
+        it 'does not restrict auto-generated routes with only' do
           content = <<-EOF
           RailsBestPracticesCom::Application.routes.draw do
             resources :posts, only: %w(show create update destroy)

data/spec/rails_best_practices/reviews/simplify_render_in_controllers_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe SimplifyRenderInControllersReview do
-      let(:runner) { Core::Runner.new(reviews: SimplifyRenderInControllersReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should simplify render action view' do
+      it 'simplifies render action view' do
         content = <<-EOF
         def edit
           render action: :edit
@@ -18,7 +18,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/controllers/posts_controller.rb:2 - simplify render in controllers')
       end
 
-      it "should simplify render actions's template" do
+      it "simplifies render actions's template" do
         content = <<-EOF
         def edit
           render template: 'books/edit'
@@ -29,7 +29,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/controllers/posts_controller.rb:2 - simplify render in controllers')
       end
 
-      it 'should simplify render an arbitrary file' do
+      it 'simplifies render an arbitrary file' do
         content = <<-EOF
         def edit
           render file: '/path/to/rails/app/views/books/edit'
@@ -40,7 +40,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/controllers/posts_controller.rb:2 - simplify render in controllers')
       end
 
-      it 'should not simplify render action view' do
+      it 'does not simplify render action view' do
         content = <<-EOF
         render :edit
         EOF
@@ -48,7 +48,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not simplify render actions's template" do
+      it "does not simplify render actions's template" do
         content = <<-EOF
         def edit
           render 'books/edit'
@@ -58,7 +58,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render an arbitrary file' do
+      it 'does not simplify render an arbitrary file' do
         content = <<-EOF
         def edit
           render '/path/to/rails/app/views/books/edit'
@@ -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: SimplifyRenderInControllersReview.new(ignored_files: /posts_controller/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /posts_controller/))
         content = <<-EOF
         def edit
           render action: :edit

data/spec/rails_best_practices/reviews/simplify_render_in_views_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe SimplifyRenderInViewsReview do
-      let(:runner) { Core::Runner.new(reviews: SimplifyRenderInViewsReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should simplify render simple partial' do
+      it 'simplifies render simple partial' do
         content = <<-EOF
         <%= render partial: 'sidebar' %>
         EOF
@@ -16,7 +16,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/views/posts/index.html.erb:1 - simplify render in views')
       end
 
-      it 'should simplify render partial with object' do
+      it 'simplifies render partial with object' do
         content = <<-EOF
         <%= render partial: 'post', object: @post %>
         EOF
@@ -25,7 +25,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/views/posts/index.html.erb:1 - simplify render in views')
       end
 
-      it 'should simplify render partial with collection' do
+      it 'simplifies render partial with collection' do
         content = <<-EOF
         <%= render partial: 'posts', collection: @posts %>
         EOF
@@ -34,7 +34,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/views/posts/index.html.erb:1 - simplify render in views')
       end
 
-      it 'should simplify render partial with local variables' do
+      it 'simplifies render partial with local variables' do
         content = <<-EOF
         <%= render partial: 'comment', locals: { parent: post } %>
         EOF
@@ -43,7 +43,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/views/posts/index.html.erb:1 - simplify render in views')
       end
 
-      it 'should not simplify render simple partial' do
+      it 'does not simplify render simple partial' do
         content = <<-EOF
         <%= render 'sidebar' %>
         <%= render 'shared/sidebar' %>
@@ -52,7 +52,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render partial with object' do
+      it 'does not simplify render partial with object' do
         content = <<-EOF
         <%= render @post %>
         EOF
@@ -60,7 +60,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render partial with collection' do
+      it 'does not simplify render partial with collection' do
         content = <<-EOF
         <%= render @posts %>
         EOF
@@ -68,7 +68,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render partial with local variables' do
+      it 'does not simplify render partial with local variables' do
         content = <<-EOF
         <%= render 'comment', parent: post %>
         EOF
@@ -76,7 +76,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render partial with complex partial' do
+      it 'does not simplify render partial with complex partial' do
         content = <<-EOF
         <%= render partial: 'shared/post', object: @post %>
         EOF
@@ -84,7 +84,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not simplify render partial with layout option' do
+      it 'does not simplify render partial with layout option' do
         content = <<-EOF
         <%= render partial: 'post', layout: 'post' %>
         EOF
@@ -92,8 +92,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: SimplifyRenderInViewsReview.new(ignored_files: /views\/posts\/index/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: %r{views/posts/index}))
         content = <<-EOF
         <%= render partial: 'sidebar' %>
         EOF