rails_best_practices 1.19.0 → 1.19.1

data/spec/rails_best_practices/prepares/schema_prepare_spec.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
     describe SchemaPrepare do
       let(:runner) { Core::Runner.new(prepares: SchemaPrepare.new) }
 
-      it "should parse model attributes" do
+      it 'should parse model attributes' do
         content =<<-EOF
         ActiveRecord::Schema.define(version: 20110319172136) do
           create_table "posts", force: true do |t|
@@ -18,14 +18,14 @@ module RailsBestPractices
           end
         end
         EOF
-        runner.prepare("db/schema.rb", content)
+        runner.prepare('db/schema.rb', content)
         model_attributes = Prepares.model_attributes
-        expect(model_attributes.get_attribute_type("Post", "title")).to eq("string")
-        expect(model_attributes.get_attribute_type("Post", "body")).to eq("text")
-        expect(model_attributes.get_attribute_type("Post", "created_at")).to eq("datetime")
-        expect(model_attributes.get_attribute_type("Post", "user_id")).to eq("integer")
-        expect(model_attributes.get_attribute_type("Post", "comments_count")).to eq("integer")
-        expect(model_attributes.get_attribute_type("Post", "published")).to eq("boolean")
+        expect(model_attributes.get_attribute_type('Post', 'title')).to eq('string')
+        expect(model_attributes.get_attribute_type('Post', 'body')).to eq('text')
+        expect(model_attributes.get_attribute_type('Post', 'created_at')).to eq('datetime')
+        expect(model_attributes.get_attribute_type('Post', 'user_id')).to eq('integer')
+        expect(model_attributes.get_attribute_type('Post', 'comments_count')).to eq('integer')
+        expect(model_attributes.get_attribute_type('Post', 'published')).to eq('boolean')
       end
     end
   end

data/spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
     describe AddModelVirtualAttributeReview do
       let(:runner) { Core::Runner.new(reviews: AddModelVirtualAttributeReview.new) }
 
-      it "should add model virtual attribute" do
+      it 'should add model virtual attribute' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -18,10 +18,10 @@ 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 'should add model virtual attribute with local assignment' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -34,10 +34,10 @@ 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 'should not add model virtual attribute with differen param' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -52,7 +52,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not add model virtual attribute with read" do
+      it 'should not add model virtual attribute with read' do
         content = <<-EOF
         class UsersController < ApplicationController
           def show
@@ -68,7 +68,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should add model virtual attribute with two dimension params" do
+      it 'should add model virtual attribute with two dimension params' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -81,10 +81,10 @@ 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 'should no add model virtual attribute with two dimension params' do
         content = <<-EOF
         class UsersController < ApplicationController
           def create
@@ -99,7 +99,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not check ignored files" do
+      it 'should not check ignored files' do
         runner = Core::Runner.new(reviews: AddModelVirtualAttributeReview.new(ignored_files: /user/))
         content = <<-EOF
         class UsersController < ApplicationController

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
     describe AlwaysAddDbIndexReview do
       let(:runner) { Core::Runner.new(reviews: AlwaysAddDbIndexReview.new) }
 
-      it "should always add db index" do
+      it 'should always add db index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -22,11 +22,11 @@ module RailsBestPractices
         runner.review('db/schema.rb', content)
         runner.after_review
         expect(runner.errors.size).to eq(2)
-        expect(runner.errors[0].to_s).to eq("db/schema.rb:2 - always add db index (comments => [post_id])")
-        expect(runner.errors[1].to_s).to eq("db/schema.rb:2 - always add db index (comments => [user_id])")
+        expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (comments => [post_id])')
+        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 'should always add db index with polymorphic foreign key' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "versions", force: true do |t|
@@ -39,10 +39,10 @@ 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 'should always 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|
@@ -55,10 +55,10 @@ 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 'should always 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|
@@ -75,10 +75,10 @@ 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 'should always 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|
@@ -95,10 +95,10 @@ 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 => [tag_id])")
+        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 'should always 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|
@@ -114,10 +114,10 @@ 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 (websites => [user_id])")
+        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 'should 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|
@@ -131,7 +131,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not always add db index with add_index" do
+      it 'should not always add db index with add_index' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -153,7 +153,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not always add db index with t.index" do
+      it 'should 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
@@ -171,7 +171,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not always add db index with only _type column" do
+      it 'should 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|
@@ -184,7 +184,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should not always add db index with multi-column index" do
+      it 'should 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|
@@ -201,7 +201,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 'should 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|
@@ -218,7 +218,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 'should 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|
@@ -236,7 +236,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 'should 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|
@@ -249,7 +249,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 'should always add db index if association_name is different to foreign_key' do
         content =<<-EOF
         class Comment < ActiveRecord::Base
           belongs_to :commentor, class_name: "User"
@@ -273,10 +273,10 @@ 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 (comments => [commentor_id])")
+        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
+      it 'should not check ignored files' do
         runner = Core::Runner.new(reviews: AlwaysAddDbIndexReview.new(ignored_files: /db\/schema/))
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
@@ -296,7 +296,7 @@ module RailsBestPractices
         expect(runner.errors.size).to eq(0)
       end
 
-      it "should detect index option in column creation" do
+      it 'should detect index option in column creation' do
         content = <<-EOF
         ActiveRecord::Schema.define(version: 20100603080629) do
           create_table "comments", force: true do |t|
@@ -319,8 +319,8 @@ module RailsBestPractices
         runner.review('db/schema.rb', content)
         runner.after_review
         expect(runner.errors.size).to eq(2)
-        expect(runner.errors[0].to_s).to eq("db/schema.rb:2 - always add db index (comments => [image_id])")
-        expect(runner.errors[1].to_s).to eq("db/schema.rb:2 - always add db index (comments => [link_id])")
+        expect(runner.errors[0].to_s).to eq('db/schema.rb:2 - always add db index (comments => [image_id])')
+        expect(runner.errors[1].to_s).to eq('db/schema.rb:2 - always add db index (comments => [link_id])')
       end
     end
   end

data/spec/rails_best_practices/reviews/check_destroy_return_value_review_spec.rb

@@ -5,8 +5,8 @@ module RailsBestPractices
     describe CheckDestroyReturnValueReview do
       let(:runner) { Core::Runner.new(reviews: CheckDestroyReturnValueReview.new) }
 
-      describe "check_destroy_return_value" do
-        it "should warn you if you fail to check the destroy return value" do
+      describe 'check_destroy_return_value' do
+        it 'should warn you if you fail to check the destroy return value' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -20,7 +20,7 @@ module RailsBestPractices
           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 'should allow destroy return value if assigned to a var' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -33,7 +33,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in if" do
+        it 'should allow destroy return value used in if' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -50,7 +50,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in elsif" do
+        it 'should allow destroy return value used in elsif' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -69,7 +69,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in unless" do
+        it 'should allow destroy return value used in unless' do
           content =<<-EOF
           def my_method
             unless @post.destroy
@@ -81,7 +81,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in if_mod" do
+        it 'should allow destroy return value used in if_mod' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -94,7 +94,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in unless_mod" do
+        it 'should allow destroy return value used in unless_mod' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -107,7 +107,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy return value used in unless with &&" do
+        it 'should allow destroy return value used in unless with &&' do
           content =<<-EOF
           def my_method
             unless some_method(1) && other_method(2) && @post.destroy
@@ -119,7 +119,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow destroy!" do
+        it 'should allow destroy!' do
           content =<<-EOF
           def my_method
             post = Posts.create do |p|
@@ -133,7 +133,7 @@ module RailsBestPractices
         end
       end
 
-      it "should not check ignored files" do
+      it 'should not check ignored files' do
         runner = Core::Runner.new(reviews: CheckDestroyReturnValueReview.new(ignored_files: /helpers/))
         content =<<-EOF
           def my_method

data/spec/rails_best_practices/reviews/check_save_return_value_review_spec.rb

@@ -5,8 +5,8 @@ module RailsBestPractices
     describe CheckSaveReturnValueReview do
       let(:runner) { Core::Runner.new(reviews: CheckSaveReturnValueReview.new) }
 
-      describe "check_save_return_value" do
-        it "should warn you if you fail to check save return value" do
+      describe 'check_save_return_value' do
+        it 'should warn you if you fail to check save return value' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -20,7 +20,7 @@ module RailsBestPractices
           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 'should allow save return value assigned to var' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -33,7 +33,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in if" do
+        it 'should allow save return value used in if' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -50,7 +50,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in elsif" do
+        it 'should allow save return value used in elsif' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -69,7 +69,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in unless" do
+        it 'should allow save return value used in unless' do
           content =<<-EOF
           def my_method
             unless @post.save
@@ -81,7 +81,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in if_mod" do
+        it 'should allow save return value used in if_mod' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -94,7 +94,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in unless_mod" do
+        it 'should allow save return value used in unless_mod' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -107,7 +107,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save return value used in unless with &&" do
+        it 'should allow save return value used in unless with &&' do
           content =<<-EOF
           def my_method
             unless some_method(1) && other_method(2) && @post.save
@@ -119,7 +119,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "should allow save!" do
+        it 'should allow save!' do
           content =<<-EOF
           def my_method
             post = Posts.new do |p|
@@ -132,7 +132,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 'should warn you if you fail to check update_attributes return value' do
           content =<<-EOF
           def my_method
             @post.update_attributes params
@@ -143,7 +143,7 @@ module RailsBestPractices
           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 'should allow update_attributes if return value is checked' do
           content =<<-EOF
           def my_method
             @post.update_attributes(params) or raise "failed to save"
@@ -153,7 +153,7 @@ module RailsBestPractices
           expect(runner.errors.size).to eq(0)
         end
 
-        it "is not clever enough to allow update_attributes if value is returned from method" do
+        it 'is not clever enough to allow update_attributes if value is returned from method' do
           # This review is not clever enough to do a full liveness analysis
           # of whether the returned value is used in all cases.
           content =<<-EOF
@@ -177,7 +177,7 @@ module RailsBestPractices
           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 'should warn you if you use create which is always unsafe' do
           content =<<-EOF
           class Post < ActiveRecord::Base
           end
@@ -196,7 +196,7 @@ module RailsBestPractices
           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 'should warn you if you use create with a block which is always unsafe' do
           content =<<-EOF
           module Blog
             class Post < ActiveRecord::Base
@@ -224,7 +224,7 @@ module RailsBestPractices
           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
+        it 'allows create called on non-model classes' do
           content =<<-EOF
           def my_method
             pk12 = OpenSSL::PKCS12.create(
@@ -239,7 +239,7 @@ module RailsBestPractices
         end
       end
 
-      it "should not check ignored files" do
+      it 'should not check ignored files' do
         runner = Core::Runner.new(reviews: CheckSaveReturnValueReview.new(ignored_files: /helpers/))
         content =<<-EOF
           def my_method