rails_best_practices 0.7.1 → 0.7.2

data/README.md

@@ -98,7 +98,7 @@ Now you can customize this configuration file, the default configuration is as f
     UseObserverCheck: { }
     IsolateSeedDataCheck: { }
     AlwaysAddDbIndexCheck: { }
-    UseBeforeFilterCheck: { }
+    UseBeforeFilterCheck: { customize_count: 1 }
     MoveCodeIntoControllerCheck: { }
     MoveCodeIntoModelCheck: { use_count: 2 }
     MoveCodeIntoHelperCheck: { array_count: 3 }
@@ -165,6 +165,11 @@ Other
 
 1. Remove Trailing Whitespace
 
+Write Your Own Check List
+-------------------------
+
+If you want to write your own check list (some check list only for your rails projects), please read this first, [How to write your own check list?][1]
+
 Contribute
 ----------
 
@@ -181,3 +186,6 @@ Send us email: <team@rails-bestpractices.com>
 
 
 Copyright © 2009 - 2011 Richard Huang (flyerhzm@gmail.com), released under the MIT license
+
+
+[1]:https://github.com/flyerhzm/rails_best_practices/wiki/How-to-write-your-own-check-list

data/lib/rails_best_practices.rb

@@ -70,6 +70,8 @@ module RailsBestPractices
     def start(path, options)
       @path = path || '.'
       @options = options
+      @options[:exclude] ||= []
+
       Core::Runner.base_path = @path
       @runner = Core::Runner.new
       @runner.debug = true if @options['debug']

data/lib/rails_best_practices/core.rb

@@ -3,7 +3,9 @@ require 'rails_best_practices/core/check'
 require 'rails_best_practices/core/runner'
 require 'rails_best_practices/core/checking_visitor'
 require 'rails_best_practices/core/error'
+require 'rails_best_practices/core/nil'
 require 'rails_best_practices/core/visitable_sexp'
+require 'rails_best_practices/core/models'
+require 'rails_best_practices/core/model_associations'
 
 require 'rails_best_practices/core_ext/enumerable'
-require 'rails_best_practices/core_ext/nil_class'

data/lib/rails_best_practices/core/check.rb

@@ -22,7 +22,7 @@ module RailsBestPractices
 
       # default interesting nodes.
       def interesting_nodes
-        []
+        NODE_TYPES
       end
 
       # default interesting files.

data/lib/rails_best_practices/core/model_associations.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class ModelAssociations
+      def initialize
+        @associations = {}
+      end
+
+      def add_association(model_name, association_name, association_meta, association_class=nil)
+        @associations[model_name] ||= {}
+        @associations[model_name][association_name] = {:meta => association_meta, :class_name => association_class || association_name.classify}
+      end
+
+      def get_association(model_name, association_name)
+        associations = @associations[model_name]
+        associations and associations[association_name]
+      end
+
+      def is_association?(model_name, association_name)
+        associations = @associations[model_name]
+        associations && associations[association_name]
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/models.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Models < Array
+    end
+  end
+end

data/lib/rails_best_practices/core/nil.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Nil
+      def to_s(*arguments)
+        self
+      end
+
+      # return self
+      def method_missing(method_sym, *arguments, &block)
+        self
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -44,6 +44,8 @@ module RailsBestPractices
         @prepares = prepares.empty? ? load_prepares : prepares
         @reviews = reviews.empty? ? load_reviews : reviews
 
+        load_plugin_reviews
+
         @checker ||= CheckingVisitor.new(:prepares => @prepares, :reviews => @reviews, :lexicals => @lexicals)
         @debug = false
       end
@@ -161,6 +163,21 @@ module RailsBestPractices
           }
         end
 
+        # load all plugin reviews.
+        def load_plugin_reviews
+          begin
+            plugins = "lib/rails_best_practices/plugins/reviews"
+            if File.directory?(plugins)
+              Dir[File.expand_path(File.join(plugins, "*.rb"))].each do |review|
+                require review
+              end
+              RailsBestPractices::Plugins::Reviews.constants.each do |review|
+                @reviews << RailsBestPractices::Plugins::Reviews.const_get(review).new
+              end
+            end
+          end
+        end
+
         # read the checks from yaml config.
         def checks_from_config
           @checks ||= YAML.load_file @config

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -427,4 +427,16 @@ class Sexp
       ""
     end
   end
+
+  # if the return value of these methods is nil, then return RailsBestPractices::Core::Nil.new instead
+  [:node_type, :subject, :message, :arguments, :class_name, :base_class, :method_name, :body, :conditional_statement, :true_node, :false_node, :left_value, :right_value].each do |method|
+    class_eval <<-EOS
+      alias_method :origin_#{method}, :#{method}
+
+      def #{method}
+        ret = origin_#{method}
+        ret.nil? ? RailsBestPractices::Core::Nil.new : ret
+      end
+    EOS
+  end
 end

data/lib/rails_best_practices/prepares.rb

@@ -5,7 +5,7 @@ require 'rails_best_practices/prepares/mailer_prepare'
 module RailsBestPractices
   module Prepares
     class <<self
-      attr_accessor :model_associations, :mailer_names
+      attr_accessor :models, :model_associations, :mailer_names
     end
   end
 end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -15,17 +15,20 @@ module RailsBestPractices
       end
 
       def initialize
-        @associations = {}
+        @models = Core::Models.new
+        @model_associations = Core::ModelAssociations.new
       end
 
       # check class node to remember the last class name.
       def start_class(class_node)
         @last_klazz = class_node.class_name.to_s
+        @models << @last_klazz
       end
 
-      # assign @associations to Prepare.model_associations.
+      # assign @model_associations to Prepare.model_associations.
       def end_class(class_node)
-        Prepares.model_associations = @associations
+        Prepares.models = @models
+        Prepares.model_associations = @model_associations
       end
 
       # check call node to remember all assoications.
@@ -33,10 +36,10 @@ module RailsBestPractices
       # the remembered association names (@associations) are like
       #     {
       #       :Project=>{
-      #         "categories"=>:has_and_belongs_to_many,
-      #         "project_manager"=>:has_one,
-      #         "portfolio"=>:belongs_to,
-      #         "milestones=>:has_many"
+      #         "categories" => {:has_and_belongs_to_many => "Category"},
+      #         "project_manager" => {:has_one => "ProjectManager"},
+      #         "portfolio" => {:belongs_to => "Portfolio"},
+      #         "milestones => {:has_many" => "Milestone"}
       #       }
       #     }
       def start_call(node)
@@ -47,8 +50,11 @@ module RailsBestPractices
       def remember_association(association_node)
         association_meta = association_node.message
         association_name = association_node.arguments[1].to_s
-        @associations[@last_klazz] ||= {}
-        @associations[@last_klazz][association_name] = association_meta
+        if association_node.arguments[2] && :hash == association_node.arguments[2].node_type
+          association_options = eval(association_node.arguments[2].to_s)
+          association_class = association_options["class_name"]
+        end
+        @model_associations.add_association(@last_klazz, association_name, association_meta, association_class)
       end
 
       # default rails association methods.

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -94,8 +94,7 @@ module RailsBestPractices
           subject = node.subject
           arguments_node = node.arguments.grep_node(:message => :[])
           return if subject.nil? or arguments_node.nil?
-          @attrasgns[subject] ||= []
-          @attrasgns[subject] << {:message => node.message, :arguments => arguments_node}
+          attrasgns(subject) << {:message => node.message, :arguments => arguments_node}
         end
 
         # check a call node with message :save or :save!,
@@ -123,7 +122,7 @@ module RailsBestPractices
         def call_assignment(node)
           if [:save, :save!].include? node.message
             subject = node.subject
-            add_error "add model virtual attribute (for #{subject})" if params_dup?(@attrasgns[subject].collect {|h| h[:arguments]})
+            add_error "add model virtual attribute (for #{subject})" if params_dup?(attrasgns(subject).collect {|h| h[:arguments]})
           end
         end
 
@@ -132,6 +131,11 @@ module RailsBestPractices
           return false if nodes.nil?
           !nodes.dups.empty?
         end
+
+        # get the attrasgns of subject, or empty array.
+        def attrasgns(subject)
+          @attrasgns[subject] ||= []
+        end
     end
   end
 end

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -63,7 +63,8 @@ module RailsBestPractices
         # and the message of subject of the call node is :user
         def need_delegate?(node)
           class_name = node.subject.subject.to_s(:remove_at => true).classify
-          association_methods.include? model_associations[class_name][node.subject.message.to_s]
+          association = model_associations.get_association(class_name, node.subject.message.to_s)
+          association && association_methods.include?(association[:meta])
         end
 
         # only check belongs_to and has_one association.

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -114,7 +114,7 @@ module RailsBestPractices
         def recursively_check(node)
           if :iter == node.node_type && :resources == node.subject.message
             options = eval(node.subject.arguments[2].to_s)
-            return if options["shallow"] == true
+            return if options && options["shallow"] == true
             @counter += 1
             recursively_check(node.body)
             @counter -= 1

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -127,9 +127,10 @@ module RailsBestPractices
           if :resources == node.message
             hash_node = node.arguments[2]
             if hash_node
-              (hash_node.grep_nodes_count(:node_type => :lit) - hash_node.grep_nodes_count(:node_type => :hash)) / 2
+              return (hash_node.grep_nodes_count(:node_type => :lit) - hash_node.grep_nodes_count(:node_type => :hash)) / 2
             end
           end
+          0
         end
 
         # check iter node to calculate the count of member and collection custom routes.
@@ -160,9 +161,7 @@ module RailsBestPractices
         #       )
         #     )
         def member_and_collection_count_for_rails3(node)
-          if :resources == node.subject.message
-            node.grep_nodes_count(:node_type => :call, :message => VERBS)
-          end
+          :resources == node.subject.message ? node.grep_nodes_count(:node_type => :call, :message => VERBS) : 0
         end
     end
   end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -60,7 +60,7 @@ module RailsBestPractices
         def check_variable_save(node)
           if [:save, :save!].include? node.message
             variable = node.subject
-            if variable_use_count[variable] > @attrasgn_count
+            if variable_use_count[variable].to_i > @attrasgn_count
               add_error "replace complex creation with factory method (#{variable} attribute_assignment_count > #{@attrasgn_count})"
             end
           end

data/lib/rails_best_practices/reviews/review.rb

@@ -6,6 +6,10 @@ module RailsBestPractices
   module Reviews
     # A Review class that takes charge of reviewing one rails best practice.
     class Review < Core::Check
+      # default url.
+      def url
+        "#"
+      end
       # remember use count for the local or instance variable in the call or attrasgn node.
       #
       # find the local variable or instance variable in the call or attrasgn node,
@@ -56,6 +60,13 @@ module RailsBestPractices
         end
       end
 
+      # get the models from Prepares.
+      #
+      # @return [Array]
+      def models
+        @models ||= Prepares.models
+      end
+
       # get the model associations from Prepares.
       #
       # @return [Hash]

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -28,6 +28,11 @@ module RailsBestPractices
         CONTROLLER_FILES
       end
 
+      def initialize(options = {})
+        super()
+        @customize_count = options['customize_count'] || 1
+      end
+
       # check class define node to see if there are method define nodes whose first code line are duplicated.
       #
       # it will check every defn nodes in the class node until protected or private identification,
@@ -79,7 +84,7 @@ module RailsBestPractices
           remember_first_sentence(child_node) if :defn == child_node.node_type
         end
         @first_sentences.each do |first_sentence, defn_nodes|
-          if defn_nodes.size > 1
+          if defn_nodes.size > @customize_count
             add_error "use before_filter for #{defn_nodes.collect(&:method_name).join(',')}", class_node.file, defn_nodes.collect(&:line).join(',')
           end
         end

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -35,26 +35,27 @@ module RailsBestPractices
       def start_defn(node)
         name = node.method_name
         return unless deliver_method?(name)
-        if !rails2_mailer_views_exist?(name) && !rails3_mailer_views_exist?(name)
+        if rails2_canonical_mailer_views?(name) || rails3_canonical_mailer_views?(name)
           add_error("use multipart/alternative as content_type of email")
         end
       end
 
       private
-        # check if rails2's syntax mailer views exist or not according to the method name.
+        # check if rails2's syntax mailer views are canonical.
+        #
         # @param [String] name method name in action_mailer
-        def rails2_mailer_views_exist?(name)
-          (exist?("#{name}.text.plain.erb") && exist?("#{name}.text.html.erb")) ||
-          (exist?("#{name}.text.plain.haml") && exist?("#{name}.text.html.haml")) ||
-          (exist?("#{name}.text.plain.rhtml") && exist?("#{name}.text.html.rhtml"))
+        def rails2_canonical_mailer_views?(name)
+          (exist?("#{name}.text.html.erb") && !exist?("#{name}.text.plain.erb")) ||
+          (exist?("#{name}.text.html.haml") && !exist?("#{name}.text.plain.haml")) ||
+          (exist?("#{name}.text.html.rhtml") && !exist?("#{name}.text.plain.rhtml"))
         end
 
-        # check if rails3's syntax mailer views exist or not according to the method name.
+        # check if rails3's syntax mailer views are canonical.
         #
         # @param [String] name method name in action_mailer
-        def rails3_mailer_views_exist?(name)
-          (exist?("#{name}.text.erb") && exist?("#{name}.html.erb")) ||
-          (exist?("#{name}.text.haml") && exist?("#{name}.html.haml"))
+        def rails3_canonical_mailer_views?(name)
+          (exist?("#{name}.html.erb") && !exist?("#{name}.text.erb")) ||
+          (exist?("#{name}.html.haml") && !exist?("#{name}.text.haml"))
         end
 
         # check if the filename existed in the mailer directory.

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -85,10 +85,14 @@ module RailsBestPractices
             !pluralize?(message.to_s) && (QUERY_METHODS.include?(node.message) || compare_with_empty_string?(node))
         end
 
+        # check if the subject is one of the models.
+        #
+        #     subject, subject of call node, like
+        #         s(:ivar, @user)
         def is_model?(subject)
           return false if :const == subject.node_type
           class_name = subject.to_s(:remove_at => true).classify
-          !model_associations[class_name].nil?
+          models.include?(class_name)
         end
 
         # check if the subject and message is one of the model's aassociation.
@@ -101,7 +105,7 @@ module RailsBestPractices
         #         :login
         def model_association?(subject, message)
           class_name = subject.to_s(:remove_at => true).classify
-          !model_associations[class_name][message.to_s].nil?
+          model_associations.is_association?(class_name, message.to_s)
         end
 
 

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
     class UseSayWithTimeInMigrationsReview < Review
 
       DEFAULT_MIGRATION_METHODS = [:add_column, :add_index, :add_timestamps, :change_column, :change_column_default, :change_table, :create_table, :drop_table, :remove_column, :remove_index, :remove_timestamps, :rename_column, :rename_index, :rename_table]
-      WITH_SAY_METHODS = DEFAULT_MIGRATION_METHODS + [:say, :say_with_time]
+      WITH_SAY_METHODS = [:say, :say_with_time]
 
       def url
         "http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log"
@@ -67,11 +67,11 @@ module RailsBestPractices
       def start_defs(node)
         block_node = node.grep_node(:node_type => :block)
         block_node.children.each do |child_node|
-          if :iter == child_node.node_type
-            subject_node = child_node.subject
-            if :call == subject_node.node_type && !WITH_SAY_METHODS.include?(subject_node.message)
-              add_error("use say with time in migrations", subject_node.file, subject_node.line)
-            end
+          next if :iter != child_node.node_type || child_node.grep_nodes_count(:node_type => :call, :message => WITH_SAY_METHODS) > 0
+
+          subject_node = child_node.subject
+          if :call == subject_node.node_type && !DEFAULT_MIGRATION_METHODS.include?(subject_node.message)
+            add_error("use say with time in migrations", subject_node.file, subject_node.line)
           end
         end
       end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end
 

data/rails_best_practices.yml

@@ -12,7 +12,7 @@ LawOfDemeterCheck: { }
 UseObserverCheck: { }
 IsolateSeedDataCheck: { }
 AlwaysAddDbIndexCheck: { }
-UseBeforeFilterCheck: { }
+UseBeforeFilterCheck: { customize_count: 1 }
 MoveCodeIntoControllerCheck: { }
 MoveCodeIntoModelCheck: { use_count: 2 }
 MoveCodeIntoHelperCheck: { array_count: 3 }

data/spec/rails_best_practices/core/check_spec.rb

@@ -4,7 +4,7 @@ describe RailsBestPractices::Core::Check do
   let(:check) { RailsBestPractices::Core::Check.new }
 
   it "should get empty interesting nodes" do
-    check.interesting_nodes.should == []
+    check.interesting_nodes.should == RailsBestPractices::Core::Check::NODE_TYPES
   end
 
   it "should match all files of interesting files" do

data/spec/rails_best_practices/core/model_associations_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::ModelAssociations do
+  let(:model_associations) { RailsBestPractices::Core::ModelAssociations.new }
+
+  before :each do
+    model_associations.add_association("Project", "project_manager", :belongs_to)
+    model_associations.add_association("Project", "people", :has_many, "Person")
+  end
+
+  it "should get model associations" do
+    model_associations.get_association("Project", "project_manager").should == {:meta => :belongs_to, :class_name => "ProjectManager"}
+    model_associations.get_association("Project", "people").should == {:meta => :has_many, :class_name => "Person"}
+    model_associations.get_association("Project", "unknown").should be_nil
+  end
+
+  it "should check is model associatiosn" do
+    model_associations.get_association("Project", "project_manager").should be_true
+    model_associations.get_association("Project", "people").should be_true
+    model_associations.get_association("Project", "unknown").should be_false
+  end
+end

data/spec/rails_best_practices/core/models_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::Models do
+  it { should be_a_kind_of Array }
+end

data/spec/rails_best_practices/core/nil_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Core::Nil do
+  let(:core_nil) { RailsBestPractices::Core::Nil.new }
+
+  context "to_s" do
+    it "should return self" do
+      core_nil.to_s.should == core_nil
+    end
+  end
+
+  context "method_missing" do
+    it "should return self" do
+      core_nil.undefined.should == core_nil
+    end
+  end
+end

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -14,9 +14,55 @@ describe RailsBestPractices::Prepares::ModelPrepare do
     EOF
     runner.prepare('app/models/project.rb', content)
     model_associations = RailsBestPractices::Prepares.model_associations
-    model_associations["Project"]["portfolio"].should == :belongs_to
-    model_associations["Project"]["project_manager"].should == :has_one
-    model_associations["Project"]["milestones"].should == :has_many
-    model_associations["Project"]["categories"].should == :has_and_belongs_to_many
+    model_associations.get_association("Project", "portfolio").should == {:meta => :belongs_to, :class_name => "Portfolio"}
+    model_associations.get_association("Project", "project_manager").should == {:meta => :has_one, :class_name => "ProjectManager"}
+    model_associations.get_association("Project", "milestones").should == {:meta => :has_many, :class_name => "Milestone"}
+    model_associations.get_association("Project", "categories").should == {:meta => :has_and_belongs_to_many, :class_name => "Category"}
+  end
+
+  context "class_name" do
+    it "should parse belongs_to" do
+      content =<<-EOF
+      class Post < ActiveRecord::Base
+        belongs_to :author, :class_name => "Person"
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      model_associations = RailsBestPractices::Prepares.model_associations
+      model_associations.get_association("Post", "author").should == {:meta => :belongs_to, :class_name => "Person"}
+    end
+
+    it "should parse has_one" do
+      content =<<-EOF
+      class Project < ActiveRecord::Base
+        has_one :project_manager, :class_name => "Person"
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      model_associations = RailsBestPractices::Prepares.model_associations
+      model_associations.get_association("Project", "project_manager").should == {:meta => :has_one, :class_name => "Person"}
+    end
+
+    it "should parse has_many" do
+      content =<<-EOF
+      class Project < ActiveRecord::Base
+        has_many :people, :class_name => "Person"
+      end
+      EOF
+      runner.prepare("app/models/project.rb", content)
+      model_associations = RailsBestPractices::Prepares.model_associations
+      model_associations.get_association("Project", "people").should == {:meta => :has_many, :class_name => "Person"}
+    end
+
+    it "should parse has_and_belongs_to_many" do
+      content =<<-EOF
+      class Citizen < ActiveRecord::Base
+        has_and_belongs_to_many :nations, :class_name => "Country"
+      end
+      EOF
+      runner.prepare("app/models/citizen.rb", content)
+      model_associations = RailsBestPractices::Prepares.model_associations
+      model_associations.get_association("Citizen", "nations").should == {:meta => :has_and_belongs_to_many, :class_name => "Country"}
+    end
   end
 end

data/spec/rails_best_practices/reviews/use_before_filter_review_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe RailsBestPractices::Reviews::UseBeforeFilterReview do
-  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseBeforeFilterReview.new) }
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseBeforeFilterReview.new('customize_count' => 2)) }
 
   it "should use before_filter" do
     content = <<-EOF
@@ -32,6 +32,23 @@ describe RailsBestPractices::Reviews::UseBeforeFilterReview do
     runner.errors[0].to_s.should == "app/controllers/posts_controller.rb:3,7,11,16 - use before_filter for show,edit,update,destroy"
   end
 
+  it "should not use before_filter when equal to customize count" do
+    content = <<-EOF
+    class PostsController < ApplicationController
+
+      def show
+        @post = Post.find(params[:id])
+      end
+
+      def edit
+        @post = Post.find(params[:id])
+      end
+    end
+    EOF
+    runner.review('app/controllers/posts_controller.rb', content)
+    runner.should have(0).errors
+  end
+
   it "should not use before_filter" do
     content = <<-EOF
     class PostsController < ApplicationController

data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb

@@ -3,108 +3,102 @@ require 'spec_helper'
 describe RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmailReview do
   let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmailReview.new) }
 
+  before :each do
+    RailsBestPractices::Core::Runner.stub!(:base_path).and_return(".")
+  end
+
+  def mock_email_files(entry_files, options={})
+    Dir.stub!(:entries).with("./app/views/project_mailer").and_return(entry_files)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(options["text.plain.erb"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(options["text.html.erb"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(options["text.erb"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(options["html.erb"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(options["text.plain.haml"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(options["text.html.haml"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(options["text.haml"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(options["html.haml"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(options["text.plain.rhtml"] || false)
+    File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(options["text.html.rhtml"] || false)
+  end
+
   context "rails2" do
-    before :each do
-      RailsBestPractices::Core::Runner.stub!(:base_path).and_return(".")
-    end
+    context "project_mailer" do
+      let(:content) {
+        <<-EOF
+        class ProjectMailer < ActionMailer::Base
+          def send_email(email)
+            subject       email.subject
+            from          email.from
+            recipients    email.recipients
+            sent_on       Time.now
+            body          :email => email
+          end
+        end
+        EOF
+      }
 
-    it "should use mulipart/alternative as content_type of email" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+      context "erb" do
+        it "should use mulipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.erb"], "text.html.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
         end
-      end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(1).errors
-      runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
-    end
 
-    it "should not use mulipart/alternative as content_type of email by erb" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+        it "should not use multipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.erb"], "text.plain.erb" => true, "text.html.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+
+        it "should not use multiple/alternative as content_type of email when only plain text" do
+          mock_email_files(["send_email.text.plain.erb"], "text.plain.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(false)
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(0).errors
-    end
 
-    it "should not use mulipart/alternative as content_type of email by haml" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+      context "haml" do
+        it "should use mulipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.haml"], "text.html.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
+        end
+
+        it "should not use multipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.haml"], "text.plain.haml" => true, "text.html.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+
+        it "should not use multiple/alternative as content_type of email when only plain text" do
+          mock_email_files(["send_email.text.plain.haml"], "text.plain.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(false)
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(0).errors
-    end
 
-    it "should not use mulipart/alternative as content_type of email by rhtml" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+      context "rhtml" do
+        it "should use mulipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.rhtml"], "text.html.rhtml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
+        end
+
+        it "should not use multipart/alternative as content_type of email" do
+          mock_email_files(["send_email.text.html.rhtml"], "text.plain.rhtml" => true, "text.html.rhtml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+
+        it "should not use multiple/alternative as content_type of email when only plain text" do
+          mock_email_files(["send_email.text.plain.rhtml"], "text.plain.rhtml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(true)
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(0).errors
     end
 
     it "should not use mulipart/alternative as content_type of email for non deliver method" do
@@ -114,83 +108,69 @@ describe RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmai
         end
       end
       EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
+      mock_email_files(["send_email.text.html.erb"])
       runner.review('app/mailers/project_mailer.rb', content)
       runner.should have(0).errors
     end
   end
 
   context "rails3" do
-    it "should use mulipart/alternative as content_type of email" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+    context "project_mailer" do
+      let(:content) {
+        <<-EOF
+        class ProjectMailer < ActionMailer::Base
+          def send_email(email)
+            subject       email.subject
+            from          email.from
+            recipients    email.recipients
+            sent_on       Time.now
+            body          :email => email
+          end
         end
-      end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(1).errors
-      runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
-    end
+        EOF
+      }
 
-    it "should not use mulipart/alternative as content_type of email by erb" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+      context "erb" do
+        it "should use mulipart/alternative as content_type of email" do
+          mock_email_files(["send_email.html.erb"], "html.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
+        end
+
+        it "should not use multipart/alternative as content_type of email" do
+          mock_email_files(["send_email.html.erb"], "text.erb" => true, "html.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+
+        it "should not use multiple/alternative as content_type of email when only plain text" do
+          mock_email_files(["send_email.text.erb"], "text.erb" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(false)
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(0).errors
-    end
 
-    it "should not use mulipart/alternative as content_type of email by haml" do
-      content =<<-EOF
-      class ProjectMailer < ActionMailer::Base
-        def send_email(email)
-          subject       email.subject
-          from          email.from
-          recipients    email.recipients
-          sent_on       Time.now
-          body          :email => email
+      context "haml" do
+        it "should use mulipart/alternative as content_type of email" do
+          mock_email_files(["send_email.html.haml"], "html.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(1).errors
+          runner.errors[0].to_s.should == "app/mailers/project_mailer.rb:2 - use multipart/alternative as content_type of email"
+        end
+
+        it "should not use multipart/alternative as content_type of email" do
+          mock_email_files(["send_email.html.haml"], "text.haml" => true, "html.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
+        end
+
+        it "should not use multiple/alternative as content_type of email when only plain text" do
+          mock_email_files(["send_email.text.haml"], "text.haml" => true)
+          runner.review('app/mailers/project_mailer.rb', content)
+          runner.should have(0).errors
         end
       end
-      EOF
-      Dir.stub!(:entries).with("./app/views/project_mailer").and_return(["send_email.html.erb"])
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.erb").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.haml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.haml").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.html.haml").and_return(true)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.plain.rhtml").and_return(false)
-      File.stub!(:exist?).with("./app/views/project_mailer/send_email.text.html.rhtml").and_return(false)
-      runner.review('app/mailers/project_mailer.rb', content)
-      runner.should have(0).errors
     end
   end
 end

data/spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb

@@ -52,6 +52,20 @@ describe RailsBestPractices::Reviews::UseSayWithTimeInMigrationsReview do
     runner.should have(0).errors
   end
 
+  it "should not use say with time in migrations when not first code line" do
+    content =<<-EOF
+    def self.up
+      User.find_each do |user|
+        say_with_time 'Updating user with latest data' do
+          user.do_time_consuming_stuff
+        end
+      end
+    end
+    EOF
+    runner.review('db/migrate/20101010080658_update_users.rb', content)
+    runner.should have(0).errors
+  end
+
   it "should not use say with time when default migration message" do
     content =<<-EOF
     def self.up

data/spec/rails_best_practices_spec.rb

@@ -33,6 +33,7 @@ describe RailsBestPractices do
     check1.add_error "law of demeter", "app/models/user.rb", 10
     check2.add_error "use query attribute", "app/models/post.rb", 100
     RailsBestPractices.runner = runner
+    RailsBestPractices.instance_variable_set("@options", {"without-color" => false})
 
     $origin_stdout = $stdout
     $stdout = StringIO.new

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 0
   - 7
-  - 1
-  version: 0.7.1
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-24 00:00:00 +08:00
+date: 2011-03-17 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -216,10 +216,12 @@ files:
 - lib/rails_best_practices/core/check.rb
 - lib/rails_best_practices/core/checking_visitor.rb
 - lib/rails_best_practices/core/error.rb
+- lib/rails_best_practices/core/model_associations.rb
+- lib/rails_best_practices/core/models.rb
+- lib/rails_best_practices/core/nil.rb
 - lib/rails_best_practices/core/runner.rb
 - lib/rails_best_practices/core/visitable_sexp.rb
 - lib/rails_best_practices/core_ext/enumerable.rb
-- lib/rails_best_practices/core_ext/nil_class.rb
 - lib/rails_best_practices/lexicals.rb
 - lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb
 - lib/rails_best_practices/prepares.rb
@@ -257,9 +259,11 @@ files:
 - spec/rails_best_practices/core/check_spec.rb
 - spec/rails_best_practices/core/checking_visitor_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/model_associations_spec.rb
+- spec/rails_best_practices/core/models_spec.rb
+- spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/visitable_sexp_spec.rb
 - spec/rails_best_practices/core_ext/enumerable_spec.rb
-- spec/rails_best_practices/core_ext/nil_class_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb
@@ -343,9 +347,11 @@ test_files:
 - spec/rails_best_practices/core/check_spec.rb
 - spec/rails_best_practices/core/checking_visitor_spec.rb
 - spec/rails_best_practices/core/error_spec.rb
+- spec/rails_best_practices/core/model_associations_spec.rb
+- spec/rails_best_practices/core/models_spec.rb
+- spec/rails_best_practices/core/nil_spec.rb
 - spec/rails_best_practices/core/visitable_sexp_spec.rb
 - spec/rails_best_practices/core_ext/enumerable_spec.rb
-- spec/rails_best_practices/core_ext/nil_class_spec.rb
 - spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb
 - spec/rails_best_practices/prepares/mailer_prepare_spec.rb
 - spec/rails_best_practices/prepares/model_prepare_spec.rb

data/lib/rails_best_practices/core_ext/nil_class.rb

@@ -1,8 +0,0 @@
-# encoding: utf-8
-class NilClass
-  # do not raise error when calling messages on nil object.
-  def method_missing(method_sym, *arguments, &block)
-    return nil
-  end
-end
-

data/spec/rails_best_practices/core_ext/nil_class_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe NilClass do
-  it "should return nil when calling undefined methods on nil" do
-    nil.undefined.should == nil
-  end
-
-  it "should do not return nil when calling exist methods" do
-    nil.nil?.should be_true
-  end
-end