rails_best_practices 1.20.0 → 1.20.1

data/spec/rails_best_practices/prepares/schema_prepare_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe SchemaPrepare do
-      let(:runner) { Core::Runner.new(prepares: SchemaPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: described_class.new) }
 
-      it 'should parse model attributes' do
+      it 'parses model attributes' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20110319172136) do
           create_table "posts", force: true do |t|

data/spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe AddModelVirtualAttributeReview do
-      let(:runner) { Core::Runner.new(reviews: AddModelVirtualAttributeReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should add model virtual attribute' do
+      it 'adds model virtual attribute' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -20,10 +20,12 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/controllers/users_controller.rb:2 - add model virtual attribute (for @user)')
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/users_controller.rb:2 - add model virtual attribute (for @user)'
+        )
       end
 
-      it 'should add model virtual attribute with local assignment' do
+      it 'adds model virtual attribute with local assignment' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -36,10 +38,12 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/controllers/users_controller.rb:2 - add model virtual attribute (for user)')
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/users_controller.rb:2 - add model virtual attribute (for user)'
+        )
       end
 
-      it 'should not add model virtual attribute with differen param' do
+      it 'does not add model virtual attribute with differen param' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -54,7 +58,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not add model virtual attribute with read' do
+      it 'does not add model virtual attribute with read' do
         content = <<-EOF
         class UsersController < ApplicationController
           def show
@@ -70,7 +74,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should add model virtual attribute with two dimension params' do
+      it 'adds model virtual attribute with two dimension params' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -83,10 +87,12 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('app/controllers/users_controller.rb:2 - add model virtual attribute (for @user)')
+        expect(runner.errors[0].to_s).to eq(
+          'app/controllers/users_controller.rb:2 - add model virtual attribute (for @user)'
+        )
       end
 
-      it 'should no add model virtual attribute with two dimension params' do
+      it 'noes add model virtual attribute with two dimension params' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -101,8 +107,8 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: AddModelVirtualAttributeReview.new(ignored_files: /user/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /user/))
         content = <<-EOF
         class UsersController < ApplicationController
           def create

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -5,9 +5,9 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe AlwaysAddDbIndexReview do
-      let(:runner) { Core::Runner.new(reviews: AlwaysAddDbIndexReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
-      it 'should always add db index' do
+      it 'alwayses add db index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -28,7 +28,7 @@ module RailsBestPractices
         expect(runner.errors[1].to_s).to eq('db/schema.rb:2 - always add db index (comments => [user_id])')
       end
 
-      it 'should always add db index with polymorphic foreign key' do
+      it 'alwayses add db index with polymorphic foreign key' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "versions", force: true do |t|
@@ -41,10 +41,12 @@ module RailsBestPractices
         runner.review('db/schema.rb', content)
         runner.after_review
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])')
+        expect(runner.errors[0].to_s).to eq(
+          'db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])'
+        )
       end
 
-      it 'should always add db index with polymorphic foreign key and _type is defined before _id' do
+      it 'alwayses add db index with polymorphic foreign key and _type is defined before _id' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "versions", force: true do |t|
@@ -57,10 +59,12 @@ module RailsBestPractices
         runner.review('db/schema.rb', content)
         runner.after_review
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])')
+        expect(runner.errors[0].to_s).to eq(
+          'db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])'
+        )
       end
 
-      it 'should always add db index with single index, but without polymorphic foreign key' do
+      it 'alwayses add db index with single index, but without polymorphic foreign key' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "taggings", force: true do |t|
@@ -77,10 +81,12 @@ module RailsBestPractices
         runner.review('db/schema.rb', content)
         runner.after_review
         expect(runner.errors.size).to eq(1)
-        expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (taggings => [taggable_id, taggable_type])')
+        expect(runner.errors[0].to_s).to eq(
+          'db/schema.rb:2 - always add db index (taggings => [taggable_id, taggable_type])'
+        )
       end
 
-      it 'should always add db index with polymorphic foreign key, but without single index' do
+      it 'alwayses add db index with polymorphic foreign key, but without single index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "taggings", force: true do |t|
@@ -100,7 +106,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (taggings => [tag_id])')
       end
 
-      it 'should always add db index only _id without non related _type column' do
+      it 'alwayses add db index only _id without non related _type column' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "websites", force: true do |t|
@@ -119,7 +125,7 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (websites => [user_id])')
       end
 
-      it 'should not always add db index with column has no id' do
+      it 'does not always add db index with column has no id' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -133,7 +139,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index with add_index' do
+      it 'does not always add db index with add_index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -155,7 +161,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index with t.index' do
+      it 'does not always add db index with t.index' do
         # e.g. schema_plus creates indices like this https://github.com/lomba/schema_plus
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
@@ -173,7 +179,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index with only _type column' do
+      it 'does not always add db index with only _type column' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "versions", force: true do |t|
@@ -186,7 +192,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index with multi-column index' do
+      it 'does not always add db index with multi-column index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "versions", force: true do |t|
@@ -203,7 +209,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index if there is an index contains more columns' do
+      it 'does not always add db index if there is an index contains more columns' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "taggings", force: true do |t|
@@ -220,7 +226,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index if two indexes for polymorphic association' do
+      it 'does not always add db index if two indexes for polymorphic association' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "taggings", force: true do |t|
@@ -238,7 +244,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should not always add db index if table does not exist' do
+      it 'does not always add db index if table does not exist' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -251,7 +257,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should always add db index if association_name is different to foreign_key' do
+      it 'alwayses add db index if association_name is different to foreign_key' do
         content = <<-EOF
         class Comment < ActiveRecord::Base
           belongs_to :commentor, class_name: "User"
@@ -278,8 +284,8 @@ module RailsBestPractices
         expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (comments => [commentor_id])')
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: AlwaysAddDbIndexReview.new(ignored_files: /db\/schema/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: %r{db/schema}))
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -298,7 +304,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it 'should detect index option in column creation' do
+      it 'detects index option in column creation' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|

data/spec/rails_best_practices/reviews/check_destroy_return_value_review_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe CheckDestroyReturnValueReview do
-      let(:runner) { Core::Runner.new(reviews: CheckDestroyReturnValueReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
       describe 'check_destroy_return_value' do
-        it 'should warn you if you fail to check the destroy return value' do
+        it 'warns you if you fail to check the destroy return value' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -19,10 +19,12 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:5 - check 'destroy' return value or use 'destroy!'")
+          expect(runner.errors[0].to_s).to eq(
+            "app/helpers/posts_helper.rb:5 - check 'destroy' return value or use 'destroy!'"
+          )
         end
 
-        it 'should allow destroy return value if assigned to a var' do
+        it 'allows destroy return value if assigned to a var' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -35,7 +37,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in if' do
+        it 'allows destroy return value used in if' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -52,7 +54,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in elsif' do
+        it 'allows destroy return value used in elsif' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -71,7 +73,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in unless' do
+        it 'allows destroy return value used in unless' do
           content = <<-EOF
           def my_method
             unless @post.destroy
@@ -83,7 +85,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in if_mod' do
+        it 'allows destroy return value used in if_mod' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -96,7 +98,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in unless_mod' do
+        it 'allows destroy return value used in unless_mod' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -109,7 +111,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy return value used in unless with &&' do
+        it 'allows destroy return value used in unless with &&' do
           content = <<-EOF
           def my_method
             unless some_method(1) && other_method(2) && @post.destroy
@@ -121,7 +123,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow destroy!' do
+        it 'allows destroy!' do
           content = <<-EOF
           def my_method
             post = Posts.create do |p|
@@ -135,8 +137,8 @@ module RailsBestPractices
         end
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: CheckDestroyReturnValueReview.new(ignored_files: /helpers/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /helpers/))
         content = <<-EOF
           def my_method
             post = Posts.create do |p|

data/spec/rails_best_practices/reviews/check_save_return_value_review_spec.rb

@@ -5,10 +5,10 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe CheckSaveReturnValueReview do
-      let(:runner) { Core::Runner.new(reviews: CheckSaveReturnValueReview.new) }
+      let(:runner) { Core::Runner.new(reviews: described_class.new) }
 
       describe 'check_save_return_value' do
-        it 'should warn you if you fail to check save return value' do
+        it 'warns you if you fail to check save return value' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -19,10 +19,12 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:5 - check 'save' return value or use 'save!'")
+          expect(runner.errors[0].to_s).to eq(
+            "app/helpers/posts_helper.rb:5 - check 'save' return value or use 'save!'"
+          )
         end
 
-        it 'should allow save return value assigned to var' do
+        it 'allows save return value assigned to var' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -35,7 +37,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in if' do
+        it 'allows save return value used in if' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -52,7 +54,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in elsif' do
+        it 'allows save return value used in elsif' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -71,7 +73,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in unless' do
+        it 'allows save return value used in unless' do
           content = <<-EOF
           def my_method
             unless @post.save
@@ -83,7 +85,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in if_mod' do
+        it 'allows save return value used in if_mod' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -96,7 +98,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in unless_mod' do
+        it 'allows save return value used in unless_mod' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -109,7 +111,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save return value used in unless with &&' do
+        it 'allows save return value used in unless with &&' do
           content = <<-EOF
           def my_method
             unless some_method(1) && other_method(2) && @post.save
@@ -121,7 +123,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should allow save!' do
+        it 'allows save!' do
           content = <<-EOF
           def my_method
             post = Posts.new do |p|
@@ -134,7 +136,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it 'should warn you if you fail to check update_attributes return value' do
+        it 'warns you if you fail to check update_attributes return value' do
           content = <<-EOF
           def my_method
             @post.update_attributes params
@@ -142,10 +144,12 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:2 - check 'update_attributes' return value or use 'update_attributes!'")
+          expect(runner.errors[0].to_s).to eq(
+            "app/helpers/posts_helper.rb:2 - check 'update_attributes' return value or use 'update_attributes!'"
+          )
         end
 
-        it 'should allow update_attributes if return value is checked' do
+        it 'allows update_attributes if return value is checked' do
           content = <<-EOF
           def my_method
             @post.update_attributes(params) or raise "failed to save"
@@ -176,10 +180,12 @@ module RailsBestPractices
           EOF
           runner.review('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:12 - check 'update_attributes' return value or use 'update_attributes!'")
+          expect(runner.errors[0].to_s).to eq(
+            "app/controllers/posts_controller.rb:12 - check 'update_attributes' return value or use 'update_attributes!'"
+          )
         end
 
-        it 'should warn you if you use create which is always unsafe' do
+        it 'warns you if you use create which is always unsafe' do
           content = <<-EOF
           class Post < ActiveRecord::Base
           end
@@ -195,10 +201,12 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq("app/helpers/posts_helper.rb:2 - use 'create!' instead of 'create' as the latter may not always save")
+          expect(runner.errors[0].to_s).to eq(
+            "app/helpers/posts_helper.rb:2 - use 'create!' instead of 'create' as the latter may not always save"
+          )
         end
 
-        it 'should warn you if you use create with a block which is always unsafe' do
+        it 'warns you if you use create with a block which is always unsafe' do
           content = <<-EOF
           module Blog
             class Post < ActiveRecord::Base
@@ -223,7 +231,9 @@ module RailsBestPractices
           EOF
           runner.review('app/helpers/blog/posts_helper.rb', content)
           expect(runner.errors.size).to eq(1)
-          expect(runner.errors[0].to_s).to eq("app/helpers/blog/posts_helper.rb:4 - use 'create!' instead of 'create' as the latter may not always save")
+          expect(runner.errors[0].to_s).to eq(
+            "app/helpers/blog/posts_helper.rb:4 - use 'create!' instead of 'create' as the latter may not always save"
+          )
         end
 
         it 'allows create called on non-model classes' do
@@ -241,8 +251,8 @@ module RailsBestPractices
         end
       end
 
-      it 'should not check ignored files' do
-        runner = Core::Runner.new(reviews: CheckSaveReturnValueReview.new(ignored_files: /helpers/))
+      it 'does not check ignored files' do
+        runner = Core::Runner.new(reviews: described_class.new(ignored_files: /helpers/))
         content = <<-EOF
           def my_method
             post = Posts.new do |p|