rails_best_practices 1.9.0 → 1.9.1

data/spec/rails_best_practices/reviews/dry_bundler_in_capistrano_review_spec.rb

@@ -1,35 +1,39 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Reviews::DryBundlerInCapistranoReview do
-  let(:runner) { runner = RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::DryBundlerInCapistranoReview.new) }
+module RailsBestPractices
+  module Reviews
+    describe DryBundlerInCapistranoReview do
+      let(:runner) { 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
-        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}")
+      it "should dry bundler in capistrno" do
+        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)
+        runner.should have(1).errors
+        runner.errors[0].to_s.should == "config/deploy.rb:1 - dry bundler in capistrano"
       end
 
-      task :bundle_new_release, :roles => :app do
-        bundler.create_symlink
-        run "cd \#{release_path} && bundle install --without development test"
+      it "should not dry bundler in capistrano" do
+        content = <<-EOF
+          require 'bundler/capistrano'
+        EOF
+        runner.review('config/deploy.rb', content)
+        runner.should have(0).errors
       end
     end
-
-    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"
-  end
-
-  it "should not dry bundler in capistrano" do
-    content = <<-EOF
-      require 'bundler/capistrano'
-    EOF
-    runner.review('config/deploy.rb', content)
-    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/reviews/isolate_seed_data_review_spec.rb

@@ -1,98 +1,102 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Reviews::IsolateSeedDataReview do
-  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::IsolateSeedDataReview.new) }
+module RailsBestPractices
+  module Reviews
+    describe IsolateSeedDataReview do
+      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|
-            t.string :name
-          end
+      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|
+                t.string :name
+              end
 
-          ["admin", "author", "editor", "account"].each do |name|
-            Role.create!(:name => name)
-          end
-        end
+              ["admin", "author", "editor", "account"].each do |name|
+                Role.create!(:name => name)
+              end
+            end
 
-        def self.down
-          drop_table "roles"
+            def self.down
+              drop_table "roles"
+            end
+          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"
         end
       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"
-    end
-  end
 
-  context "new and save" do
-    it "should isolate seed data for local variable" do
-      content = <<-EOF
-      class CreateRoles < ActiveRecord::Migration
-        def self.up
-          create_table "roles", :force => true do |t|
-            t.string :name
-          end
+      context "new and save" do
+        it "should isolate seed data for local variable" do
+          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 = Role.new(:name => name)
+                role.save!
+              end
+            end
 
-          ["admin", "author", "editor", "account"].each do |name|
-            role = Role.new(:name => name)
-            role.save!
+            def self.down
+              drop_table "roles"
+            end
           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"
         end
 
-        def self.down
-          drop_table "roles"
-        end
-      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"
-    end
+        it "should isolate seed data for instance variable" do
+          content = <<-EOF
+          class CreateRoles < ActiveRecord::Migration
+            def self.up
+              create_table "roles", :force => true do |t|
+                t.string :name
+              end
 
-    it "should isolate seed data for instance variable" do
-      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 = Role.new(:name => name)
+                @role.save!
+              end
+            end
 
-          ["admin", "author", "editor", "account"].each do |name|
-            @role = Role.new(:name => name)
-            @role.save!
+            def self.down
+              drop_table "roles"
+            end
           end
-        end
-
-        def self.down
-          drop_table "roles"
+          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"
         end
       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"
-    end
-  end
 
-  it "should not isolate seed data without data insert" do
-    content = <<-EOF
-    class CreateRoles < ActiveRecord::Migration
-      def self.up
-        create_table "roles", :force => true do |t|
-          t.string :name
-        end
-      end
+      it "should not isolate seed data without data insert" do
+        content = <<-EOF
+        class CreateRoles < ActiveRecord::Migration
+          def self.up
+            create_table "roles", :force => true do |t|
+              t.string :name
+            end
+          end
 
-      def self.down
-        drop_table "roles"
+          def self.down
+            drop_table "roles"
+          end
+        end
+        EOF
+        runner.review('db/migrate/20090818130258_create_roles.rb', content)
+        runner.should have(0).errors
       end
     end
-    EOF
-    runner.review('db/migrate/20090818130258_create_roles.rb', content)
-    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/reviews/keep_finders_on_their_own_model_review_spec.rb

@@ -1,95 +1,99 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Reviews::KeepFindersOnTheirOwnModelReview do
-  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::KeepFindersOnTheirOwnModelReview.new) }
+module RailsBestPractices
+  module Reviews
+    describe KeepFindersOnTheirOwnModelReview do
+      let(:runner) { Core::Runner.new(:reviews => KeepFindersOnTheirOwnModelReview.new) }
 
-  it "should keep finders on thier own model" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should keep finders on thier own model" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def find_valid_comments
-        self.comment.find(:all, :conditions => { :is_spam => false },
-                                :limit => 10)
+          def find_valid_comments
+            self.comment.find(:all, :conditions => { :is_spam => false },
+                                    :limit => 10)
+          end
+        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"
       end
-    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"
-  end
 
-  it "should keep finders on thier own model with all method" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should keep finders on thier own model with all method" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def find_valid_comments
-        self.comment.all(:conditions => { :is_spam => false },
-                         :limit => 10)
+          def find_valid_comments
+            self.comment.all(:conditions => { :is_spam => false },
+                             :limit => 10)
+          end
+        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"
       end
-    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"
-  end
 
-  it "should not keep finders on thier own model with self finder" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should not keep finders on thier own model with self finder" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def find_valid_comments
-        self.find(:all, :conditions => { :is_spam => false },
-                                :limit => 10)
+          def find_valid_comments
+            self.find(:all, :conditions => { :is_spam => false },
+                                    :limit => 10)
+          end
+        end
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
       end
-    end
-    EOF
-    runner.review('app/models/post.rb', content)
-    runner.should have(0).errors
-  end
 
-  it "should not keep finders on thier own model with own finder" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should not keep finders on thier own model with own finder" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def find_valid_comments
-        Post.find(:all, :conditions => { :is_spam => false },
-                                :limit => 10)
+          def find_valid_comments
+            Post.find(:all, :conditions => { :is_spam => false },
+                                    :limit => 10)
+          end
+        end
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
       end
-    end
-    EOF
-    runner.review('app/models/post.rb', content)
-    runner.should have(0).errors
-  end
 
-  it "should not keep finders on their own model without finder" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should not keep finders on their own model without finder" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def find_valid_comments
-        self.comments.destroy_all
+          def find_valid_comments
+            self.comments.destroy_all
+          end
+        end
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
       end
-    end
-    EOF
-    runner.review('app/models/post.rb', content)
-    runner.should have(0).errors
-  end
 
-  it "should not keep finders on their own model with ruby Array#find" do
-    content = <<-EOF
-    class Post < ActiveRecord::Base
-      has_many :comments
+      it "should not keep finders on their own model with ruby Array#find" do
+        content = <<-EOF
+        class Post < ActiveRecord::Base
+          has_many :comments
 
-      def active_comments
-        self.comments.find {|comment| comment.status == 'active'}
+          def active_comments
+            self.comments.find {|comment| comment.status == 'active'}
+          end
+        end
+        EOF
+        runner.review('app/models/post.rb', content)
+        runner.should have(0).errors
       end
     end
-    EOF
-    runner.review('app/models/post.rb', content)
-    runner.should have(0).errors
   end
 end

data/spec/rails_best_practices/reviews/law_of_demeter_review_spec.rb

@@ -1,167 +1,165 @@
 require 'spec_helper'
 
-describe RailsBestPractices::Reviews::LawOfDemeterReview do
-
-  let(:runner) {
-    RailsBestPractices::Core::Runner.new(
-      :prepares => [RailsBestPractices::Prepares::ModelPrepare.new, RailsBestPractices::Prepares::SchemaPrepare.new],
-      :reviews => RailsBestPractices::Reviews::LawOfDemeterReview.new
-    )
-  }
-
-  describe "belongs_to" do
-    before(:each) do
-      content = <<-EOF
-      class Invoice < ActiveRecord::Base
-        belongs_to :user
-      end
-      EOF
-      runner.prepare('app/models/invoice.rb', content)
-
-      content = <<-EOF
-      ActiveRecord::Schema.define(:version => 20110216150853) do
-        create_table "users", force => true do |t|
-          t.string :name
-          t.string :address
-          t.string :cellphone
+module RailsBestPractices
+  module Reviews
+    describe LawOfDemeterReview do
+      let(:runner) { Core::Runner.new(:prepares => [Prepares::ModelPrepare.new, Prepares::SchemaPrepare.new], :reviews => LawOfDemeterReview.new) }
+
+      describe "belongs_to" do
+        before(:each) do
+          content = <<-EOF
+          class Invoice < ActiveRecord::Base
+            belongs_to :user
+          end
+          EOF
+          runner.prepare('app/models/invoice.rb', content)
+
+          content = <<-EOF
+          ActiveRecord::Schema.define(:version => 20110216150853) do
+            create_table "users", force => true do |t|
+              t.string :name
+              t.string :address
+              t.string :cellphone
+            end
+          end
+          EOF
+          runner.prepare('db/schema.rb', content)
         end
-      end
-      EOF
-      runner.prepare('db/schema.rb', content)
-    end
 
-    it "should law of demeter with erb" do
-      content = <<-EOF
-      <%= @invoice.user.name %>
-      <%= @invoice.user.address %>
-      <%= @invoice.user.cellphone %>
-      EOF
-      runner.review('app/views/invoices/show.html.erb', content)
-      runner.should have(3).errors
-      runner.errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
-    end
+        it "should law of demeter with erb" do
+          content = <<-EOF
+          <%= @invoice.user.name %>
+          <%= @invoice.user.address %>
+          <%= @invoice.user.cellphone %>
+          EOF
+          runner.review('app/views/invoices/show.html.erb', content)
+          runner.should have(3).errors
+          runner.errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+        end
 
-    it "should law of demeter with haml" do
-      content = <<-EOF
+        it "should law of demeter with haml" do
+          content = <<-EOF
 = @invoice.user.name
 = @invoice.user.address
 = @invoice.user.cellphone
-      EOF
-      runner.review('app/views/invoices/show.html.haml', content)
-      runner.should have(3).errors
-      runner.errors[0].to_s.should == "app/views/invoices/show.html.haml:1 - law of demeter"
-    end
+          EOF
+          runner.review('app/views/invoices/show.html.haml', content)
+          runner.should have(3).errors
+          runner.errors[0].to_s.should == "app/views/invoices/show.html.haml:1 - law of demeter"
+        end
 
-    it "should law of demeter with slim" do
-      content = <<-EOF
+        it "should law of demeter with slim" do
+          content = <<-EOF
 = @invoice.user.name
 = @invoice.user.address
 = @invoice.user.cellphone
-      EOF
-      runner.review('app/views/invoices/show.html.slim', content)
-      runner.should have(3).errors
-      runner.errors[0].to_s.should == "app/views/invoices/show.html.slim:1 - law of demeter"
-    end
-
-    it "should no law of demeter" do
-      content = <<-EOF
-      <%= @invoice.user_name %>
-      <%= @invoice.user_address %>
-      <%= @invoice.user_cellphone %>
-      EOF
-      runner.review('app/views/invoices/show.html.erb', content)
-      runner.should have(0).errors
-    end
-  end
-
-  describe "has_one" do
-    before(:each) do
-      content = <<-EOF
-      class Invoice < ActiveRecord::Base
-        has_one :price
-      end
-      EOF
-      runner.prepare('app/models/invoice.rb', content)
+          EOF
+          runner.review('app/views/invoices/show.html.slim', content)
+          runner.should have(3).errors
+          runner.errors[0].to_s.should == "app/views/invoices/show.html.slim:1 - law of demeter"
+        end
 
-      content = <<-EOF
-      ActiveRecord::Schema.define(:version => 20110216150853) do
-        create_table "prices", force => true do |t|
-          t.string :currency
-          t.integer :number
+        it "should no law of demeter" do
+          content = <<-EOF
+          <%= @invoice.user_name %>
+          <%= @invoice.user_address %>
+          <%= @invoice.user_cellphone %>
+          EOF
+          runner.review('app/views/invoices/show.html.erb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      runner.prepare('db/schema.rb', content)
-    end
 
-    it "should law of demeter" do
-      content = <<-EOF
-      <%= @invoice.price.currency %>
-      <%= @invoice.price.number %>
-      EOF
-      runner.review('app/views/invoices/show.html.erb', content)
-      runner.should have(2).errors
-      runner.errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
-    end
-  end
+      describe "has_one" do
+        before(:each) do
+          content = <<-EOF
+          class Invoice < ActiveRecord::Base
+            has_one :price
+          end
+          EOF
+          runner.prepare('app/models/invoice.rb', content)
+
+          content = <<-EOF
+          ActiveRecord::Schema.define(:version => 20110216150853) do
+            create_table "prices", force => true do |t|
+              t.string :currency
+              t.integer :number
+            end
+          end
+          EOF
+          runner.prepare('db/schema.rb', content)
+        end
 
-  context "polymorphic association" do
-    before :each do
-      content = <<-EOF
-      class Comment < ActiveRecord::Base
-        belongs_to :commentable, :polymorphic => true
+        it "should law of demeter" do
+          content = <<-EOF
+          <%= @invoice.price.currency %>
+          <%= @invoice.price.number %>
+          EOF
+          runner.review('app/views/invoices/show.html.erb', content)
+          runner.should have(2).errors
+          runner.errors[0].to_s.should == "app/views/invoices/show.html.erb:1 - law of demeter"
+        end
       end
-      EOF
-      runner.prepare('app/models/comment.rb', content)
 
-      content = <<-EOF
-      class Post < ActiveRecord::Base
-        has_many :comments
-      end
-      EOF
-      runner.prepare('app/models/comment.rb', content)
+      context "polymorphic association" do
+        before :each do
+          content = <<-EOF
+          class Comment < ActiveRecord::Base
+            belongs_to :commentable, :polymorphic => true
+          end
+          EOF
+          runner.prepare('app/models/comment.rb', content)
+
+          content = <<-EOF
+          class Post < ActiveRecord::Base
+            has_many :comments
+          end
+          EOF
+          runner.prepare('app/models/comment.rb', content)
+
+          content = <<-EOF
+          ActiveRecord::Schema.define(:version => 20110216150853) do
+            create_table "posts", force => true do |t|
+              t.string :title
+            end
+          end
+          EOF
+          runner.prepare('db/schema.rb', content)
+        end
 
-      content = <<-EOF
-      ActiveRecord::Schema.define(:version => 20110216150853) do
-        create_table "posts", force => true do |t|
-          t.string :title
+        it "should law of demeter" do
+          content = <<-EOF
+          <%= @comment.commentable.title %>
+          EOF
+          runner.review('app/views/comments/index.html.erb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/views/comments/index.html.erb:1 - law of demeter"
         end
       end
-      EOF
-      runner.prepare('db/schema.rb', content)
-    end
 
-    it "should law of demeter" do
-      content = <<-EOF
-      <%= @comment.commentable.title %>
-      EOF
-      runner.review('app/views/comments/index.html.erb', content)
-      runner.should have(1).errors
-      runner.errors[0].to_s.should == "app/views/comments/index.html.erb:1 - law of demeter"
-    end
-  end
-
-  it "should no law of demeter with method call" do
-    content = <<-EOF
-    class Question < ActiveRecord::Base
-      has_many :answers, :dependent => :destroy
-    end
-    EOF
-    runner.prepare('app/models/question.rb', content)
-    content = <<-EOF
-    class Answer < ActiveRecord::Base
-      belongs_to :question, :counter_cache => true, :touch => true
-    end
-    EOF
-    runner.prepare('app/models/answer.rb', content)
-    content = <<-EOF
-    class CommentsController < ApplicationController
-      def comment_url
-        question_path(@answer.question)
+      it "should no law of demeter with method call" do
+        content = <<-EOF
+        class Question < ActiveRecord::Base
+          has_many :answers, :dependent => :destroy
+        end
+        EOF
+        runner.prepare('app/models/question.rb', content)
+        content = <<-EOF
+        class Answer < ActiveRecord::Base
+          belongs_to :question, :counter_cache => true, :touch => true
+        end
+        EOF
+        runner.prepare('app/models/answer.rb', content)
+        content = <<-EOF
+        class CommentsController < ApplicationController
+          def comment_url
+            question_path(@answer.question)
+          end
+        end
+        EOF
+        runner.review('app/controllers/comments_controller.rb', content)
+        runner.should have(0).errors
       end
     end
-    EOF
-    runner.review('app/controllers/comments_controller.rb', content)
-    runner.should have(0).errors
   end
 end