rails_best_practices 1.9.1 → 1.10.0

data/spec/rails_best_practices/prepares/schema_prepare_spec.rb

@@ -3,18 +3,18 @@ require 'spec_helper'
 module RailsBestPractices
   module Prepares
     describe SchemaPrepare do
-      let(:runner) { Core::Runner.new(:prepares => SchemaPrepare.new) }
+      let(:runner) { Core::Runner.new(prepares: SchemaPrepare.new) }
 
       it "should parse model attributes" do
         content =<<-EOF
-        ActiveRecord::Schema.define(:version => 20110319172136) do
-          create_table "posts", :force => true do |t|
+        ActiveRecord::Schema.define(version: 20110319172136) do
+          create_table "posts", force: true do |t|
             t.string   "title"
-            t.text     "body",           :limit => 16777215
+            t.text     "body",           limit: 16777215
             t.datetime "created_at"
             t.integer  "user_id"
-            t.integer  "comments_count",                     :default => 0
-            t.boolean  "published",                          :default => false, :null => false
+            t.integer  "comments_count",                     default: 0
+            t.boolean  "published",                          default: false, null: false
           end
         end
         EOF

data/spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe AddModelVirtualAttributeReview do
-      let(:runner) { Core::Runner.new(:reviews => AddModelVirtualAttributeReview.new) }
+      let(:runner) { Core::Runner.new(reviews: AddModelVirtualAttributeReview.new) }
 
       it "should add model virtual attribute" do
         content = <<-EOF
@@ -18,7 +18,7 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for @user)"
+        runner.errors[0].to_s.should == "app/controllers/users_controller.rb:2 - add model virtual attribute (for @user)"
       end
 
       it "should add model virtual attribute with local assignment" do
@@ -34,7 +34,7 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for user)"
+        runner.errors[0].to_s.should == "app/controllers/users_controller.rb:2 - add model virtual attribute (for user)"
       end
 
       it "should not add model virtual attribute with differen param" do
@@ -81,7 +81,7 @@ module RailsBestPractices
         EOF
         runner.review('app/controllers/users_controller.rb', content)
         runner.should have(1).errors
-        runner.errors[0].to_s.should == "app/controllers/users_controller.rb:3 - add model virtual attribute (for @user)"
+        runner.errors[0].to_s.should == "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

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe AlwaysAddDbIndexReview do
-      let(:runner) { Core::Runner.new(:reviews => AlwaysAddDbIndexReview.new) }
+      let(:runner) { Core::Runner.new(reviews: AlwaysAddDbIndexReview.new) }
 
       it "should always add db index" do
         content = <<-EOF
-        ActiveRecord::Schema.define(:version => 20100603080629) do
-          create_table "comments", :force => true do |t|
+        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|
+          create_table "posts", force: true do |t|
           end
-          create_table "users", :force => true do |t|
+          create_table "users", force: true do |t|
           end
         end
         EOF
@@ -28,8 +28,8 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "versions", force: true do |t|
             t.integer  "versioned_id"
             t.string   "versioned_type"
             t.string   "tag"
@@ -44,8 +44,8 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "versions", force: true do |t|
             t.string   "versioned_type"
             t.integer  "versioned_id"
             t.string   "tag"
@@ -60,16 +60,16 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "taggings", force: true do |t|
             t.integer  "tag_id"
             t.integer  "taggable_id"
             t.string   "taggable_type"
           end
-          create_table "tags", :force => true do |t|
+          create_table "tags", force: true do |t|
           end
 
-          add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
+          add_index "taggings", ["tag_id"], name: "index_taggings_on_tag_id"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -80,16 +80,16 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "taggings", force: true do |t|
             t.integer  "tag_id"
             t.integer  "taggable_id"
             t.string   "taggable_type"
           end
-          create_table "tags", :force => true do |t|
+          create_table "tags", force: true do |t|
           end
 
-          add_index "taggings", ["taggable_id", "taggable_type"], :name => "index_taggings_on_taggable_id_and_taggable_type"
+          add_index "taggings", ["taggable_id", "taggable_type"], name: "index_taggings_on_taggable_id_and_taggable_type"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -100,14 +100,14 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "websites", force: true do |t|
             t.integer  "user_id"
             t.string   "icon_file_name"
             t.integer  "icon_file_size"
             t.string   "icon_content_type"
           end
-          create_table "users", :force => true do |t|
+          create_table "users", force: true do |t|
           end
         end
         EOF
@@ -119,8 +119,8 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "comments", force: true do |t|
             t.string "content"
             t.integer "position"
           end
@@ -133,19 +133,19 @@ module RailsBestPractices
 
       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|
+        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|
+          create_table "posts", force: true do |t|
           end
-          create_table "users", :force => true do |t|
+          create_table "users", force: true do |t|
           end
 
-          add_index "comments", ["post_id"], :name => "index_comments_on_post_id"
-          add_index "comments", ["user_id"], :name => "index_comments_on_user_id"
+          add_index "comments", ["post_id"], name: "index_comments_on_post_id"
+          add_index "comments", ["user_id"], name: "index_comments_on_user_id"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -155,8 +155,8 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "versions", force: true do |t|
             t.string   "versioned_type"
           end
         end
@@ -168,14 +168,14 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "versions", force: true do |t|
             t.integer  "versioned_id"
             t.string   "versioned_type"
             t.string   "tag"
           end
 
-          add_index "versions", ["versioned_id", "versioned_type"], :name => "index_versions_on_versioned_id_and_versioned_type"
+          add_index "versions", ["versioned_id", "versioned_type"], name: "index_versions_on_versioned_id_and_versioned_type"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -185,14 +185,14 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "taggings", force: true do |t|
             t.integer  "taggable_id"
             t.string   "taggable_type"
             t.string   "context"
           end
 
-          add_index "taggings", ["taggable_id", "taggable_type", "context"], :name => "index_taggings_on_taggable_id_and_taggable_type_and_context"
+          add_index "taggings", ["taggable_id", "taggable_type", "context"], name: "index_taggings_on_taggable_id_and_taggable_type_and_context"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -202,15 +202,15 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "taggings", force: true do |t|
             t.integer "tagger_id"
             t.string "tagger_type"
             t.datetime "created_at"
           end
 
-          add_index "taggings", ["tagger_id"], :name => "index_taggings_on_tagger_id"
-          add_index "taggings", ["tagger_type"], :name => "index_taggings_on_tagger_type"
+          add_index "taggings", ["tagger_id"], name: "index_taggings_on_tagger_id"
+          add_index "taggings", ["tagger_type"], name: "index_taggings_on_tagger_type"
         end
         EOF
         runner.review('db/schema.rb', content)
@@ -220,8 +220,8 @@ module RailsBestPractices
 
       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|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "comments", force: true do |t|
             t.integer "post_id"
           end
         end
@@ -234,7 +234,7 @@ module RailsBestPractices
       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"
+          belongs_to :commentor, class_name: "User"
         end
         EOF
         runner.prepare('app/models/comment.rb', content)
@@ -244,11 +244,11 @@ module RailsBestPractices
         EOF
         runner.prepare('app/models/user.rb', content)
         content =<<-EOF
-        ActiveRecord::Schema.define(:version => 20100603080629) do
-          create_table "comments", :force => true do |t|
+        ActiveRecord::Schema.define(version: 20100603080629) do
+          create_table "comments", force: true do |t|
             t.integer "commentor_id"
           end
-          create_table "users", :force => true do |t|
+          create_table "users", force: true do |t|
           end
         end
         EOF

data/spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb

@@ -3,18 +3,18 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe DryBundlerInCapistranoReview do
-      let(:runner) { runner = Core::Runner.new(:reviews => DryBundlerInCapistranoReview.new) }
+      let(:runner) { Core::Runner.new(reviews: DryBundlerInCapistranoReview.new) }
 
       it "should dry bundler in capistrno" do
         content = <<-EOF
         namespace :bundler do
-          task :create_symlink, :roles => :app 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
+          task :bundle_new_release, roles: :app do
             bundler.create_symlink
             run "cd \#{release_path} && bundle install --without development test"
           end

data/spec/rails_best_practices/reviews/hash_syntax_review_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+module RailsBestPractices
+  module Reviews
+    describe HashSyntaxReview do
+      let(:runner) { Core::Runner.new(reviews: HashSyntaxReview.new) }
+
+      it "should find 1.8 Hash with symbol" do
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          CONST = { :foo => :bar }
+        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"
+      end
+
+      it "should find 1.8 Hash with symbol" do
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          CONST = { "foo" => "bar" }
+        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"
+      end
+
+      it "should not alert on 1.9 Syntax" do
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          CONST = { foo: :bar }
+        end
+        EOF
+        runner.review('app/models/user.rb', content)
+        runner.should have(0).errors
+      end
+
+      it "should only check symbol syntax" do
+        runner = Core::Runner.new(reviews: HashSyntaxReview.new(only_symbol: true))
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          SYMBOL_CONST = { :foo => :bar }
+          STRING_CONST = { "foo" => "bar" }
+        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"
+      end
+
+      it "should only check string syntax" do
+        runner = Core::Runner.new(reviews: HashSyntaxReview.new(only_string: true))
+        content =<<-EOF
+        class User < ActiveRecord::Base
+          SYMBOL_CONST = { :foo => :bar }
+          STRING_CONST = { "foo" => "bar" }
+        end
+        EOF
+        runner.review('app/models/user.rb', content)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "app/models/user.rb:3 - change Hash Syntax to 1.9"
+      end
+    end
+  end
+end

data/spec/rails_best_practices/reviews/isolate_seed_data_review_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 module RailsBestPractices
   module Reviews
     describe IsolateSeedDataReview do
-      let(:runner) { Core::Runner.new(:reviews => IsolateSeedDataReview.new) }
+      let(:runner) { Core::Runner.new(reviews: IsolateSeedDataReview.new) }
 
       context "create" do
         it "should isolate seed data" do
           content = <<-EOF
           class CreateRoles < ActiveRecord::Migration
             def self.up
-              create_table "roles", :force => true do |t|
+              create_table "roles", force: true do |t|
                 t.string :name
               end
 
               ["admin", "author", "editor", "account"].each do |name|
-                Role.create!(:name => name)
+                Role.create!(name: name)
               end
             end
 
@@ -35,12 +35,12 @@ module RailsBestPractices
           content = <<-EOF
           class CreateRoles < ActiveRecord::Migration
             def self.up
-              create_table "roles", :force => true do |t|
+              create_table "roles", force: true do |t|
                 t.string :name
               end
 
               ["admin", "author", "editor", "account"].each do |name|
-                role = Role.new(:name => name)
+                role = Role.new(name: name)
                 role.save!
               end
             end
@@ -59,12 +59,12 @@ module RailsBestPractices
           content = <<-EOF
           class CreateRoles < ActiveRecord::Migration
             def self.up
-              create_table "roles", :force => true do |t|
+              create_table "roles", force: true do |t|
                 t.string :name
               end
 
               ["admin", "author", "editor", "account"].each do |name|
-                @role = Role.new(:name => name)
+                @role = Role.new(name: name)
                 @role.save!
               end
             end
@@ -84,7 +84,7 @@ module RailsBestPractices
         content = <<-EOF
         class CreateRoles < ActiveRecord::Migration
           def self.up
-            create_table "roles", :force => true do |t|
+            create_table "roles", force: true do |t|
               t.string :name
             end
           end