rails_best_practices 1.14.4 → 1.15.1

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -21,9 +21,9 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(2).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (comments => [post_id])"
-        runner.errors[1].to_s.should == "db/schema.rb:2 - always add db index (comments => [user_id])"
+        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])")
       end
 
       it "should always add db index with polymorphic foreign key" do
@@ -38,8 +38,8 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
+        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])")
       end
 
       it "should always add db index with polymorphic foreign key and _type is defined before _id" do
@@ -54,8 +54,8 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (versions => [versioned_id, versioned_type])"
+        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])")
       end
 
       it "should always add db index with single index, but without polymorphic foreign key" do
@@ -74,8 +74,8 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [taggable_id, taggable_type])"
+        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])")
       end
 
       it "should always add db index with polymorphic foreign key, but without single index" do
@@ -94,8 +94,8 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (taggings => [tag_id])"
+        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])")
       end
 
       it "should always add db index only _id without non related _type column" do
@@ -113,8 +113,8 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (websites => [user_id])"
+        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])")
       end
 
       it "should not always add db index with column has no id" do
@@ -128,7 +128,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index with add_index" do
@@ -150,7 +150,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index with t.index" do
@@ -168,7 +168,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index with only _type column" do
@@ -181,7 +181,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index with multi-column index" do
@@ -198,7 +198,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index if there is an index contains more columns" do
@@ -215,7 +215,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index if two indexes for polymorphic association" do
@@ -233,7 +233,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not always add db index if table does not exist" do
@@ -246,7 +246,7 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should always add db index if association_name is different to foreign_key" do
@@ -272,8 +272,28 @@ module RailsBestPractices
         EOF
         runner.review('db/schema.rb', content)
         runner.after_review
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (comments => [commentor_id])"
+        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])")
+      end
+
+      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
+          create_table "comments", force: true do |t|
+            t.string "content"
+            t.integer "post_id"
+            t.integer "user_id"
+          end
+          create_table "posts", force: true do |t|
+          end
+          create_table "users", force: true do |t|
+          end
+        end
+        EOF
+        runner.review('db/schema.rb', content)
+        runner.after_review
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/check_save_return_value_spec.rb

@@ -16,8 +16,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:5 - check 'save' return value or use 'save!'"
+          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!'")
         end
 
         it "should allow save return value assigned to var" do
@@ -30,7 +30,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in if" do
@@ -47,7 +47,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in elsif" do
@@ -66,7 +66,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in unless" do
@@ -78,7 +78,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in if_mod" do
@@ -91,7 +91,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          expect(runner).to have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in unless_mod" do
@@ -104,7 +104,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          expect(runner).to have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save return value used in unless with &&" do
@@ -116,7 +116,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should allow save!" do
@@ -129,7 +129,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "should warn you if you fail to check update_attributes return value" do
@@ -139,8 +139,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - check 'update_attributes' return value or use 'update_attributes!'"
+          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!'")
         end
 
         it "should allow update_attributes if return value is checked" do
@@ -150,7 +150,7 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(0).errors
+          expect(runner.errors.size).to eq(0)
         end
 
         it "is not clever enough to allow update_attributes if value is returned from method" do
@@ -173,8 +173,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/controllers/posts_controller.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:12 - check 'update_attributes' return value or use 'update_attributes!'"
+          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!'")
         end
 
         it "should warn you if you use create which is always unsafe" do
@@ -192,8 +192,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - use 'create!' instead of 'create' as the latter may not always save"
+          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")
         end
 
         it "should warn you if you use create with a block which is always unsafe" do
@@ -220,8 +220,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/blog/posts_helper.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "app/helpers/blog/posts_helper.rb:4 - use 'create!' instead of 'create' as the latter may not always save"
+          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")
         end
 
         it "allows create called on non-model classes" do
@@ -235,9 +235,23 @@ module RailsBestPractices
           end
           EOF
           runner.review('app/helpers/posts_helper.rb', content)
-          runner.errors.map(&:to_s).should == []
+          expect(runner.errors.map(&:to_s)).to eq([])
         end
       end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: CheckSaveReturnValueReview.new(ignored_files: /helpers/))
+        content =<<-EOF
+          def my_method
+            post = Posts.new do |p|
+              p.title = "foo"
+            end
+            post.save
+          end
+        EOF
+        runner.review('app/helpers/posts_helper.rb', content)
+        expect(runner.errors.size).to eq(0)
+      end
     end
   end
 end

data/spec/rails_best_practices/reviews/default_scope_is_evil_review_spec.rb

@@ -12,8 +12,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:2 - default_scope is evil"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/user.rb:2 - default_scope is evil")
       end
 
       it "should detect default_scope with old syntax" do
@@ -23,8 +23,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:2 - default_scope is evil"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/user.rb:2 - default_scope is evil")
       end
 
       it "should not detect default_scope" do
@@ -34,7 +34,18 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: DefaultScopeIsEvilReview.new(ignored_files: /user/))
+        content = <<-EOF
+        class User < ActiveRecord::Base
+          default_scope -> { order('created_at desc') }
+        end
+        EOF
+        runner.review('app/models/user.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb

@@ -23,8 +23,8 @@ module RailsBestPractices
         after 'deploy:update_code', 'bundler:bundle_new_release'
         EOF
         runner.review('config/deploy.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "config/deploy.rb:1 - dry bundler in capistrano"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("config/deploy.rb:1 - dry bundler in capistrano")
       end
 
       it "should not dry bundler in capistrano" do
@@ -32,7 +32,29 @@ module RailsBestPractices
           require 'bundler/capistrano'
         EOF
         runner.review('config/deploy.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: DryBundlerInCapistranoReview.new(ignored_files: /deploy\.rb/))
+        content = <<-EOF
+        namespace :bundler do
+          task :create_symlink, roles: :app do
+            shared_dir = File.join(shared_path, 'bundle')
+            release_dir = File.join(current_release, '.bundle')
+            run("mkdir -p \#{shared_dir} && ln -s \#{shared_dir} \#{release_dir}")
+          end
+
+          task :bundle_new_release, roles: :app do
+            bundler.create_symlink
+            run "cd \#{release_path} && bundle install --without development test"
+          end
+        end
+
+        after 'deploy:update_code', 'bundler:bundle_new_release'
+        EOF
+        runner.review('config/deploy.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/hash_syntax_review_spec.rb

@@ -12,8 +12,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/user.rb:2 - change Hash Syntax to 1.9"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/user.rb:2 - change Hash Syntax to 1.9")
       end
 
       it "should not find 1.8 Hash with string" do
@@ -23,7 +23,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not alert on 1.9 Syntax" do
@@ -33,7 +33,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/user.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should ignore haml_out" do
@@ -43,7 +43,7 @@ module RailsBestPractices
 #div{ class: "foo3" }
         EOF
         runner.review('app/views/files/show.html.haml', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not consider hash with array key" do
@@ -51,7 +51,7 @@ module RailsBestPractices
         transition [:unverified, :verified] => :deleted
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not consider hash with charaters not valid for symbol" do
@@ -59,7 +59,18 @@ module RailsBestPractices
         receiver.stub(:` => 'Error')
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: HashSyntaxReview.new(ignored_files: /user/))
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          CONST = { :foo => :bar }
+        end
+        EOF
+        runner.review('app/models/user.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/isolate_seed_data_review_spec.rb

@@ -25,8 +25,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('db/migrate/20090818130258_create_roles.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:8 - isolate seed data"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("db/migrate/20090818130258_create_roles.rb:8 - isolate seed data")
         end
       end
 
@@ -51,8 +51,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('db/migrate/20090818130258_create_roles.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("db/migrate/20090818130258_create_roles.rb:9 - isolate seed data")
         end
 
         it "should isolate seed data for instance variable" do
@@ -75,8 +75,8 @@ module RailsBestPractices
           end
           EOF
           runner.review('db/migrate/20090818130258_create_roles.rb', content)
-          runner.should have(1).errors
-          runner.errors[0].to_s.should == "db/migrate/20090818130258_create_roles.rb:9 - isolate seed data"
+          expect(runner.errors.size).to eq(1)
+          expect(runner.errors[0].to_s).to eq("db/migrate/20090818130258_create_roles.rb:9 - isolate seed data")
         end
       end
 
@@ -95,7 +95,30 @@ module RailsBestPractices
         end
         EOF
         runner.review('db/migrate/20090818130258_create_roles.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: IsolateSeedDataReview.new(ignored_files: /create_roles/))
+        content = <<-EOF
+          class CreateRoles < ActiveRecord::Migration
+            def self.up
+              create_table "roles", force: true do |t|
+                t.string :name
+              end
+
+              ["admin", "author", "editor", "account"].each do |name|
+                Role.create!(name: name)
+              end
+            end
+
+            def self.down
+              drop_table "roles"
+            end
+          end
+        EOF
+        runner.review('db/migrate/20090818130258_create_roles.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end

data/spec/rails_best_practices/reviews/keep_finders_on_their_own_model_review_spec.rb

@@ -17,8 +17,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/post.rb:5 - keep finders on their own model"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/post.rb:5 - keep finders on their own model")
       end
 
       it "should keep finders on thier own model with all method" do
@@ -33,8 +33,8 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/models/post.rb:5 - keep finders on their own model"
+        expect(runner.errors.size).to eq(1)
+        expect(runner.errors[0].to_s).to eq("app/models/post.rb:5 - keep finders on their own model")
       end
 
       it "should not keep finders on thier own model with self finder" do
@@ -49,7 +49,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not keep finders on thier own model with own finder" do
@@ -64,7 +64,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not keep finders on their own model without finder" do
@@ -78,7 +78,7 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
       end
 
       it "should not keep finders on their own model with ruby Array#find" do
@@ -92,7 +92,23 @@ module RailsBestPractices
         end
         EOF
         runner.review('app/models/post.rb', content)
-        runner.should have(0).errors
+        expect(runner.errors.size).to eq(0)
+      end
+
+      it "should not check ignored files" do
+        runner = Core::Runner.new(reviews: KeepFindersOnTheirOwnModelReview.new(ignored_files: /app\/models\/post\.rb/))
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
+
+          def find_valid_comments
+            self.comment.find(:all, conditions: { is_spam: false },
+                                    limit: 10)
+          end
+        end
+        EOF
+        runner.review('app/models/post.rb', content)
+        expect(runner.errors.size).to eq(0)
       end
     end
   end