rails_best_practices 1.20.0 → 1.22.1

data/spec/rails_best_practices/core/runner_spec.rb

@@ -6,20 +6,22 @@ module RailsBestPractices::Core
   describe Runner do
     describe 'load_plugin_reviews' do
       shared_examples_for 'load_plugin_reviews' do
-        it 'should load plugins in lib/rails_best_practices/plugins/reviews' do
-          runner = Runner.new
-          expect(runner.instance_variable_get('@reviews').map(&:class)).to include(RailsBestPractices::Plugins::Reviews::NotUseRailsRootReview)
+        it 'loads plugins in lib/rails_best_practices/plugins/reviews' do
+          runner = described_class.new
+          expect(runner.instance_variable_get('@reviews').map(&:class)).to include(
+            RailsBestPractices::Plugins::Reviews::NotUseRailsRootReview
+          )
         end
       end
 
       context 'given a path that ends with a slash' do
-        before { Runner.base_path = 'spec/fixtures/' }
-        it_should_behave_like 'load_plugin_reviews'
+        before { described_class.base_path = 'spec/fixtures/' }
+        it_behaves_like 'load_plugin_reviews'
       end
 
       context 'given a path that does not end with a slash' do
-        before { Runner.base_path = 'spec/fixtures' }
-        it_should_behave_like 'load_plugin_reviews'
+        before { described_class.base_path = 'spec/fixtures' }
+        it_behaves_like 'load_plugin_reviews'
       end
     end
   end

data/spec/rails_best_practices/core_ext/erubis_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe Erubis::OnlyRuby do
-  subject {
+  subject do
     content = <<-EOF
     <h1>Title</h1>
     <% if current_user %>
@@ -13,14 +13,14 @@ describe Erubis::OnlyRuby do
       Not logged in
     <% end %>
     EOF
-    Erubis::OnlyRuby.new(content).src
-  }
+    described_class.new(content).src
+  end
 
-  it { should_not include('h1') }
-  it { should_not include('Title') }
-  it { should_not include('Not logged in') }
-  it { should include('current_user') }
-  it { should include('if') }
-  it { should include('else') }
-  it { should include('end') }
+  it { is_expected.not_to include('h1') }
+  it { is_expected.not_to include('Title') }
+  it { is_expected.not_to include('Not logged in') }
+  it { is_expected.to include('current_user') }
+  it { is_expected.to include('if') }
+  it { is_expected.to include('else') }
+  it { is_expected.to include('end') }
 end

data/spec/rails_best_practices/inline_disables/inline_disable_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module RailsBestPractices
+  module InlineDisables
+    describe InlineDisable do
+      let(:runner) { Core::Runner.new(reviews: Reviews::MoveModelLogicIntoModelReview.new) }
+
+      it 'moves model logic into model' do
+        content = <<-EOF
+        class PostsController < ApplicationController
+          def publish
+            @post = Post.find(params[:id])
+            @post.update_attributes(:is_published, true)
+            @post.approved_by = current_user
+
+            if @post.created_at > Time.now - 7.days
+              @post.popular = 100
+            else
+              @post.popular = 0
+            end
+
+            redirect_to post_url(@post)
+          end
+        end
+        EOF
+        runner.review('app/controllers/posts_controller.rb', content)
+        runner.inline_disable('app/controllers/posts_controller.rb', content)
+
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/posts_controller.rb:2 - move model logic into model (@post use_count > 4)'
+        )
+      end
+
+      it 'is no error is output' do
+        content = <<-EOF
+        class PostsController < ApplicationController
+          def publish # rails_best_practices:disable MoveModelLogicIntoModelCheck
+            @post = Post.find(params[:id])
+            @post.update_attributes(:is_published, true)
+            @post.approved_by = current_user
+
+            if @post.created_at > Time.now - 7.days
+              @post.popular = 100
+            else
+              @post.popular = 0
+            end
+
+            redirect_to post_url(@post)
+          end
+        end
+        EOF
+        runner.review('app/controllers/posts_controller.rb', content)
+        runner.inline_disable('app/controllers/posts_controller.rb', content)
+
+        expect(runner.errors.size).to eq(0)
+      end
+    end
+  end
+end

data/spec/rails_best_practices/lexicals/long_line_check_spec.rb

@@ -5,8 +5,8 @@ require 'spec_helper'
 module RailsBestPractices
   module Lexicals
     describe LongLineCheck do
-      it 'should find long lines' do
-        runner = Core::Runner.new(lexicals: LongLineCheck.new)
+      it 'finds long lines' do
+        runner = Core::Runner.new(lexicals: described_class.new)
         content = <<~EOF
           class User < ActiveRecord::Base
           # 81 Chars
@@ -20,8 +20,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(1)
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:3 - line is longer than 80 characters (81 characters)')
       end
-      it 'should find long lines with own max size' do
-        runner = Core::Runner.new(lexicals: LongLineCheck.new('max_line_length' => 90))
+      it 'finds long lines with own max size' do
+        runner = Core::Runner.new(lexicals: described_class.new('max_line_length' => 90))
         content = <<~EOF
           class User < ActiveRecord::Base
           # 91 Chars
@@ -35,16 +35,17 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(1)
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:3 - line is longer than 90 characters (91 characters)')
       end
-      it 'should not check non .rb files' do
-        runner = Core::Runner.new(lexicals: LongLineCheck.new)
-        content = "
+      it 'does not check non .rb files' do
+        runner = Core::Runner.new(lexicals: described_class.new)
+        content =
+          '
 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-"
+'
         runner.lexical('app/views/users/index.html.erb', content)
         expect(runner.errors.size).to eq(0)
       end
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(lexicals: LongLineCheck.new(max_line_length: 80, ignored_files: /user/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(lexicals: described_class.new(max_line_length: 80, ignored_files: /user/))
         content = <<~EOF
           class User < ActiveRecord::Base
           # 81 Chars

data/spec/rails_best_practices/lexicals/remove_tab_check_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Lexicals
     describe RemoveTabCheck do
-      let(:runner) { Core::Runner.new(lexicals: RemoveTabCheck.new) }
+      let(:runner) { Core::Runner.new(lexicals: described_class.new) }
 
-      it 'should remove tab' do
+      it 'removes tab' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -19,7 +19,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:1 - remove tab, use spaces instead')
       end
 
-      it 'should remove tab with third line' do
+      it 'removes tab with third line' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -31,7 +31,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:3 - remove tab, use spaces instead')
       end
 
-      it 'should not remove trailing whitespace' do
+      it 'does not remove trailing whitespace' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -40,8 +40,8 @@ module RailsBestPractices
         runner.lexical('app/models/user.rb', content)
         expect(runner.errors.size).to eq(0)
       end
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(lexicals: RemoveTabCheck.new(ignored_files: /user/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(lexicals: described_class.new(ignored_files: /user/))
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects

data/spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Lexicals
     describe RemoveTrailingWhitespaceCheck do
-      let(:runner) { Core::Runner.new(lexicals: RemoveTrailingWhitespaceCheck.new) }
+      let(:runner) { Core::Runner.new(lexicals: described_class.new) }
 
-      it 'should remove trailing whitespace' do
+      it 'removes trailing whitespace' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -19,7 +19,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:1 - remove trailing whitespace')
       end
 
-      it 'should remove whitespace with third line' do
+      it 'removes whitespace with third line' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -31,7 +31,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('app/models/user.rb:3 - remove trailing whitespace')
       end
 
-      it 'should not remove trailing whitespace' do
+      it 'does not remove trailing whitespace' do
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects
@@ -41,8 +41,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(lexicals: RemoveTrailingWhitespaceCheck.new(ignored_files: /user/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(lexicals: described_class.new(ignored_files: /user/))
         content = <<-EOF
         class User < ActiveRecord::Base
           has_many :projects

data/spec/rails_best_practices/prepares/config_prepare_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe ConfigPrepare do
-      let(:runner) { Core::Runner.new(prepares: ConfigPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
       context 'configs' do
-        it 'should parse configs' do
+        it 'parses configs' do
           content = <<-EOF
           module RailsBestPracticesCom
             class Application < Rails::Application

data/spec/rails_best_practices/prepares/controller_prepare_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe ControllerPrepare do
-      let(:runner) { Core::Runner.new(prepares: [ControllerPrepare.new, HelperPrepare.new]) }
+      let(:runner) { Core::Runner.new(prepares: [described_class.new, HelperPrepare.new]) }
 
       context 'methods' do
-        it 'should parse controller methods' do
+        it 'parses controller methods' do
           content = <<-EOF
           class PostsController < ApplicationController
             def index; end
@@ -20,7 +20,7 @@ module RailsBestPractices
           expect(methods.get_methods('PostsController').map(&:method_name)).to eq(%w[index show])
         end
 
-        it 'should parse model methods with access control' do
+        it 'parses model methods with access control' do
           content = <<-EOF
           class PostsController < ApplicationController
             def index; end
@@ -39,7 +39,7 @@ module RailsBestPractices
           expect(methods.get_methods('PostsController', 'private').map(&:method_name)).to eq(['resource'])
         end
 
-        it 'should parse controller methods with module ::' do
+        it 'parses controller methods with module ::' do
           content = <<-EOF
           class Admin::Blog::PostsController < ApplicationController
             def index; end
@@ -51,7 +51,7 @@ module RailsBestPractices
           expect(methods.get_methods('Admin::Blog::PostsController').map(&:method_name)).to eq(%w[index show])
         end
 
-        it 'should parse controller methods with module' do
+        it 'parses controller methods with module' do
           content = <<-EOF
           module Admin
             module Blog
@@ -75,7 +75,9 @@ module RailsBestPractices
             EOF
             runner.prepare('app/controllers/posts_controller.rb', content)
             methods = Prepares.controller_methods
-            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(%w[index show new create edit update destroy])
+            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(
+              %w[index show new create edit update destroy]
+            )
           end
 
           it 'extend inherited_resources with actions' do
@@ -97,7 +99,9 @@ module RailsBestPractices
             EOF
             runner.prepare('app/controllers/posts_controller.rb', content)
             methods = Prepares.controller_methods
-            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(%w[index new create edit update destroy])
+            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(
+              %w[index new create edit update destroy]
+            )
           end
 
           it 'extend inherited_resources with all actions with no arguments' do
@@ -108,7 +112,9 @@ module RailsBestPractices
             EOF
             runner.prepare('app/controllers/posts_controller.rb', content)
             methods = Prepares.controller_methods
-            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(%w[index show new create edit update destroy])
+            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(
+              %w[index show new create edit update destroy]
+            )
           end
 
           it 'DSL inherit_resources' do
@@ -119,13 +125,15 @@ module RailsBestPractices
             EOF
             runner.prepare('app/controllers/posts_controller.rb', content)
             methods = Prepares.controller_methods
-            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(%w[index show new create edit update destroy])
+            expect(methods.get_methods('PostsController').map(&:method_name)).to eq(
+              %w[index show new create edit update destroy]
+            )
           end
         end
       end
 
       context 'helpers' do
-        it 'should add helper descendant' do
+        it 'adds helper descendant' do
           content = <<-EOF
           module PostsHelper
           end

data/spec/rails_best_practices/prepares/gemfile_prepare_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe GemfilePrepare do
-      let(:runner) { Core::Runner.new(prepares: GemfilePrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
       context 'gemfile' do
-        it 'should parse gems' do
+        it 'parses gems' do
           content = <<~EOF
             GEM
               remote: https://rubygems.org/

data/spec/rails_best_practices/prepares/helper_prepare_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe HelperPrepare do
-      let(:runner) { Core::Runner.new(prepares: HelperPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
       context 'methods' do
-        it 'should parse helper methods' do
+        it 'parses helper methods' do
           content = <<-EOF
           module PostsHelper
             def used; end
@@ -20,7 +20,7 @@ module RailsBestPractices
           expect(methods.get_methods('PostsHelper').map(&:method_name)).to eq(%w[used unused])
         end
 
-        it 'should parse helpers' do
+        it 'parses helpers' do
           content = <<-EOF
           module PostsHelper
           end

data/spec/rails_best_practices/prepares/initializer_prepare_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe InitializerPrepare do
-      let(:runner) { Core::Runner.new(prepares: InitializerPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
       context 'initializers' do
-        it 'should set include_forbidden_attributes_protection config' do
+        it 'sets include_forbidden_attributes_protection config' do
           content = <<-EOF
           class AR
             ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)
@@ -19,7 +19,7 @@ module RailsBestPractices
           expect(configs['railsbp.include_forbidden_attributes_protection']).to eq('true')
         end
 
-        it 'should not set include_forbidden_attributes_protection config' do
+        it 'does not set include_forbidden_attributes_protection config' do
           content = <<-EOF
           class AR
           end

data/spec/rails_best_practices/prepares/mailer_prepare_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe MailerPrepare do
-      let(:runner) { Core::Runner.new(prepares: MailerPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
-      it 'should parse mailer names' do
+      it 'parses mailer names' do
         content = <<-EOF
         class ProjectMailer < ActionMailer::Base
         end