rails_best_practices 0.6.7 → 0.7.0

data/README.md

@@ -83,28 +83,30 @@ to generate `rails_best_practices.yml` file.
 
 Now you can customize this configuration file, the default configuration is as follows:
 
-    MoveFinderToNamedScopeReview: { }
-    UseModelAssociationReview: { }
-    UseScopeAccessReview: { }
-    AddModelVirtualAttributeReview: { }
-    ReplaceComplexCreationWithFactoryMethodReview: { attribute_assignment_count: 2 }
-    MoveModelLogicIntoModelReview: { use_count: 4 }
-    OveruseRouteCustomizationsReview: { customize_count: 3 }
-    NeedlessDeepNestingReview: { nested_count: 2 }
-    NotUseDefaultRouteReview: {  }
-    KeepFindersOnTheirOwnModelReview: { }
-    LawOfDemeterReview: { }
-    UseObserverReview: { }
-    IsolateSeedDataReview: { }
-    AlwaysAddDbIndexReview: { }
-    UseBeforeFilterReview: { }
-    MoveCodeIntoControllerReview: { }
-    MoveCodeIntoModelReview: { use_count: 2 }
-    MoveCodeIntoHelperReview: { array_count: 3 }
-    ReplaceInstanceVariableWithLocalVariableReview: { }
-    DryBundlerInCapistranoReview: { }
-    UseSayWithTimeInMigrationsReview: { }
-    UseQueryAttributeReview: { }
+    MoveFinderToNamedScopeCheck: { }
+    UseModelAssociationCheck: { }
+    UseScopeAccessCheck: { }
+    AddModelVirtualAttributeCheck: { }
+    ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+    MoveModelLogicIntoModelCheck: { use_count: 4 }
+    OveruseRouteCustomizationsCheck: { customize_count: 3 }
+    NeedlessDeepNestingCheck: { nested_count: 2 }
+    NotUseDefaultRouteCheck: {  }
+    KeepFindersOnTheirOwnModelCheck: { }
+    LawOfDemeterCheck: { }
+    UseObserverCheck: { }
+    IsolateSeedDataCheck: { }
+    AlwaysAddDbIndexCheck: { }
+    UseBeforeFilterCheck: { }
+    MoveCodeIntoControllerCheck: { }
+    MoveCodeIntoModelCheck: { use_count: 2 }
+    MoveCodeIntoHelperCheck: { array_count: 3 }
+    ReplaceInstanceVariableWithLocalVariableCheck: { }
+    DryBundlerInCapistranoCheck: { }
+    UseSayWithTimeInMigrationsCheck: { }
+    UseQueryAttributeCheck: { }
+    RemoveTrailingWhitespaceCheck: { }
+    UseMultipartAlternativeAsContentTypeOfEmailCheck: {}
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -133,6 +135,10 @@ Model
 3. Use Observer
 4. Use Query Attribute
 
+Mailer
+
+1. Use multipart/alternative as content_type of email
+
 Migration
 
 1. Isolating Seed Data
@@ -154,6 +160,10 @@ Deployment
 
 1. Dry bundler in capistrano
 
+Other
+
+1. Remove Trailing Whitespace
+
 Contribute
 ----------
 

data/Rakefile

@@ -35,3 +35,4 @@ Rspec::Core::RakeTask.new('spec:progress') do |spec|
 end
 
 task :default => :spec
+task :test => :spec

data/lib/rails_best_practices.rb

@@ -26,6 +26,7 @@ require 'rubygems'
 require 'progressbar'
 require 'colored'
 require 'haml'
+require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
 require 'rails_best_practices/core'
@@ -79,9 +80,8 @@ module RailsBestPractices
         plain_output("AlwaysAddDbIndexReview is disabled as there is no db/schema.rb file in your rails project.", 'blue')
       end
 
-      @bar = ProgressBar.new('Analyzing', prepare_files.size + review_files.size)
-      process("prepare")
-      process("review")
+      @bar = ProgressBar.new('Analyzing', lexical_files.size + prepare_files.size + review_files.size)
+      ["lexical", "prepare", "review"].each { |process| send(:process, process) }
       @bar.finish
 
       if @options['format'] == 'html'
@@ -92,12 +92,12 @@ module RailsBestPractices
       exit @runner.errors.size
     end
 
-    # process prepare or reivew.
+    # process lexical, prepare or reivew.
     #
     # get all files for the process, analyze each file,
     # and increment progress bar unless debug.
     #
-    # @param [String] process the process name, prepare or review.
+    # @param [String] process the process name, lexical, prepare or review.
     def process(process)
       files = send("#{process}_files")
       files.each do |file|
@@ -137,6 +137,8 @@ module RailsBestPractices
       end
     end
 
+    alias :lexical_files :review_files
+
     # expand all files with extenstion rb, erb, haml and builder under the dirs
     #
     # @param [Array] dirs what directories to expand

data/lib/rails_best_practices/core/check.rb

@@ -9,11 +9,17 @@ module RailsBestPractices
       CONTROLLER_FILES = /_controller\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
-      MAILER_FILES = /models\/.*\.rb$|mailers\/.*\.rb/
+      MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
       VIEW_FILES = /views\/.*\.(erb|haml)$/
       PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
       ROUTE_FILE = /config\/routes.rb/
 
+      attr_reader :errors
+
+      def initialize
+        @errors = []
+      end
+
       # default interesting nodes.
       def interesting_nodes
         []
@@ -46,6 +52,21 @@ module RailsBestPractices
         self.send("end_#{node.node_type}", node)
       end
 
+      # add error if source code violates rails best practice.
+      #   error is the string message for violation of the rails best practice
+      #   file is the filename of source code
+      #   line is the line number of the source code which is reviewing
+      def add_error(error, file = @node.file, line = @node.line)
+        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error, url)
+      end
+
+      # default url is empty.
+      #
+      # @return [String] the url of rails best practice
+      def url
+        ""
+      end
+
       # method_missing to catch all start and end process for each node type, like
       #
       #     start_defn

data/lib/rails_best_practices/core/checking_visitor.rb

@@ -3,25 +3,26 @@ module RailsBestPractices
   module Core
     # CheckingVisitor is a visitor class.
     #
-    # it remembers all the checks for prepare and review processes according to interesting_prepare_nodes and interesting_review_nodes,
+    # it remembers all the checks for prepare and review processes according to interesting_nodes and interesting_nodes,
     # then recursively iterate all sexp nodes,
     #
     # for prepare process
-    # if the node_type and the node filename match the interesting_prepare_nodes and interesting_prepare_files,
+    # if the node_type and the node filename match the interesting_prepare_nodes and interesting_files,
     # then run the prepare for that node.
     #
     # for review process
-    # if the node_type and the node filename match the interesting_review_nodes and interesting_review_files,
+    # if the node_type and the node filename match the interesting_review_nodes and interesting_files,
     # then run the reivew for that node.
     class CheckingVisitor
       # remember all the checks for prepare and review processes according to interesting_nodes.
       #
-      # @param [Array] prepares
-      # @param [Array] reviews
-      def initialize(prepares, reviews)
+      # @param [Hash] options
+      #     {:lexicals => [], :prepares => [], :reviews => []}
+      def initialize(options={})
+        @lexicals = options[:lexicals]
         [:prepare, :review].each do |process|
           instance_variable_set("@#{process}_checks", {})                  # @review_checks = {}
-          eval("#{process}s").each do |check|                              # reviews.each do |check|
+          options["#{process}s".to_sym].each do |check|                    # options[:reviews].each do |check|
             check.send("interesting_nodes").each do |node|                 #   check.interesting_nodes.each do |node|
               instance_variable_get("@#{process}_checks")[node] ||= []     #     @review_checks[node] ||= []
               instance_variable_get("@#{process}_checks")[node] << check   #     @review_checks[node] << check
@@ -31,6 +32,14 @@ module RailsBestPractices
         end
       end
 
+      # for lexical process
+      # check the content of files one by one.
+      def lexical(filename, content)
+        @lexicals.each do |lexical|
+          lexical.check(filename, content)
+        end
+      end
+
       # for prepare process
       # if the node_type and the node filename match the interesting_nodes and interesting_files,
       # then run the prepare for that node.

data/lib/rails_best_practices/core/runner.rb

@@ -40,13 +40,30 @@ module RailsBestPractices
 
         prepares = Array(options[:prepares])
         reviews = Array(options[:reviews])
+        @lexicals = load_lexicals
         @prepares = prepares.empty? ? load_prepares : prepares
         @reviews = reviews.empty? ? load_reviews : reviews
 
-        @checker ||= CheckingVisitor.new(@prepares, @reviews)
+        @checker ||= CheckingVisitor.new(:prepares => @prepares, :reviews => @reviews, :lexicals => @lexicals)
         @debug = false
       end
 
+      # lexical analysis the file.
+      #
+      # @param [String] filename name of the file
+      # @param [String] content content of the file
+      def lexical(filename, content)
+        puts filename if @debug
+        @checker.lexical(filename, content)
+      end
+
+      # lexical analysis the file.
+      #
+      # @param [String] filename
+      def lexical_file(filename)
+        lexical(filename, File.read(filename))
+      end
+
       # prepare and review a file's content with filename.
       # the file may be a ruby, erb or haml file.
       #
@@ -67,11 +84,11 @@ module RailsBestPractices
         EOS
       end
 
-      # get all errors from reviews.
+      # get all errors from lexicals and reviews.
       #
-      # @return [Array] all errors from reviews
+      # @return [Array] all errors from lexicals and reviews
       def errors
-        @reviews.collect {|review| review.errors}.flatten
+        (@reviews + @lexicals).collect {|check| check.errors}.flatten
       end
 
       private
@@ -111,6 +128,20 @@ module RailsBestPractices
           content
         end
 
+        # load all lexical checks.
+        def load_lexicals
+          checks_from_config.inject([]) { |active_checks, check|
+            begin
+              check_name, options = *check
+              klass = RailsBestPractices::Lexicals.const_get(check_name)
+              active_checks << (options.empty? ? klass.new : klass.new(options))
+            rescue
+              # the check does not exist in the Lexicals namepace.
+            end
+            active_checks
+          }
+        end
+
         # load all prepares.
         def load_prepares
           [RailsBestPractices::Prepares::ModelPrepare.new, RailsBestPractices::Prepares::MailerPrepare.new]
@@ -118,13 +149,21 @@ module RailsBestPractices
 
         # load all reviews according to configuration.
         def load_reviews
-          check_objects = []
-          checks = YAML.load_file @config
-          checks.each do |check|
-            klass = RailsBestPractices::Reviews.const_get(check[0].gsub(/Check/, 'Review'))
-            check_objects << (check[1].empty? ? klass.new : klass.new(check[1]))
-          end
-          check_objects
+          checks_from_config.inject([]) { |active_checks, check|
+            begin
+              check_name, options = *check
+              klass = RailsBestPractices::Reviews.const_get(check_name.gsub(/Check/, 'Review'))
+              active_checks << (options.empty? ? klass.new : klass.new(options))
+            rescue
+              # the check does not exist in the Reviews namepace.
+            end
+            active_checks
+          }
+        end
+
+        # read the checks from yaml config.
+        def checks_from_config
+          @checks ||= YAML.load_file @config
         end
     end
   end

data/lib/rails_best_practices/core/visitable_sexp.rb

@@ -400,6 +400,8 @@ class Sexp
   # @return [String] to_s
   def to_s(options={})
     case node_type
+    when :true, :false, :nil
+      self[0].to_s
     when :ivar
       options[:remove_at] ? self[1].to_s[1..-1] : self[1].to_s
     when :lvar, :str, :lit, :const
@@ -408,12 +410,17 @@ class Sexp
       "[\"#{self.children.collect(&:to_s).join('", "')}\"]"
     when :hash
       key_value = false # false is key, true is value
-      result = ['{"']
+      result = ['{']
       children.each do |child|
-        result << "#{child.to_s}#{key_value ? '", "' : '" => "'}"
+        if [:true, :false, :nil, :array, :hash].include? child.node_type
+          result << "#{child}"
+        else
+          result << "\"#{child}\""
+        end
+        result << (key_value ? ", " : " => ")
         key_value = !key_value
       end
-      result.join("").sub(/, "$/, '') + '}'
+      result.join("").sub(/, $/, '') + '}'
     when :colon2
       "#{self[1]}::#{self[2]}"
     else

data/lib/rails_best_practices/lexicals.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'rails_best_practices/lexicals/remove_trailing_whitespace_check'

data/lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Lexicals
+    # Make sure there are no trailing whitespace in codes.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/60-remove-trailing-whitespace
+    class RemoveTrailingWhitespaceCheck < Core::Check
+      def url
+        "http://rails-bestpractices.com/posts/60-remove-trailing-whitespace"
+      end
+
+      # check if the content of file contain a trailing whitespace.
+      #
+      # @param [String] filename name of the file
+      # @param [String] content content of the file
+      def check(filename, content)
+        if content =~ / +\n/m
+          line_no = $`.count("\n") + 1
+          add_error("remove trailing whitespace", filename, line_no)
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/reviews.rb

@@ -21,3 +21,4 @@ require 'rails_best_practices/reviews/replace_instance_variable_with_local_varia
 require 'rails_best_practices/reviews/dry_bundler_in_capistrano_review'
 require 'rails_best_practices/reviews/use_say_with_time_in_migrations_review'
 require 'rails_best_practices/reviews/use_query_attribute_review'
+require 'rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review'

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -9,9 +9,6 @@ module RailsBestPractices
     #
     # Implementation:
     #
-    # Prepare process:
-    #   only review all model files to save model names and association names.
-    #
     # Review process:
     #   check all method calls to see if there is method call to the association object.
     #   if there is a call node whose subject is an object of model (compare by name),

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -113,13 +113,13 @@ module RailsBestPractices
         # if so, it is the needless deep nesting.
         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
             @counter += 1
             recursively_check(node.body)
             @counter -= 1
           elsif :block == node.node_type
-            node.children.each do |child_node|
-              recursively_check(child_node)
-            end
+            node.children.each { |child_node| recursively_check(child_node) }
           elsif :call == node.node_type && [:resources, :resource].include?(node.message)
             add_error "needless deep nesting (nested_count > #{@nested_count})", node.file, node.line if @counter >= @nested_count
           end

data/lib/rails_best_practices/reviews/review.rb

@@ -6,21 +6,6 @@ module RailsBestPractices
   module Reviews
     # A Review class that takes charge of reviewing one rails best practice.
     class Review < Core::Check
-      attr_reader :errors
-
-      def initialize
-        super
-        @errors = []
-      end
-
-      # add error if source code violates rails best practice.
-      #   error is the string message for violation of the rails best practice
-      #   file is the filename of source code
-      #   line is the line number of the source code which is reviewing
-      def add_error(error, file = @node.file, line = @node.line)
-        @errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", error, 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,

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'rails_best_practices/core/runner'
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Make sure to use multipart/alternative as content_type of email.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check class node to remember the class name,
+    #   and check the method definition nodes to see if the corresponding mailer views exist or not.
+    class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
+      def url
+        "http://rails-bestpractices.com/posts/41-use-multipart-alternative-as-content_type-of-email"
+      end
+
+      def interesting_nodes
+        [:class, :defn]
+      end
+
+      def interesting_files
+        MAILER_FILES
+      end
+
+      # check class node to remember the ActionMailer class name.
+      def start_class(node)
+        @klazz_name = node.class_name
+      end
+
+      # check defn node and find if the corresponding views exist or not?
+      def start_defn(node)
+        name = node.method_name
+        return unless deliver_method?(name)
+        if !rails2_mailer_views_exist?(name) && !rails3_mailer_views_exist?(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.
+        # @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"))
+        end
+
+        # check if rails3's syntax mailer views exist or not according to the method name.
+        #
+        # @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"))
+        end
+
+        # check if the filename existed in the mailer directory.
+        def exist?(filename)
+          File.exist? File.join(mailer_directory, filename)
+        end
+
+        # check if the method is a deliver_method.
+        #
+        # @param [String] name the name of the method
+        def deliver_method?(name)
+          Dir.entries(mailer_directory).find { |filename| filename.index name.to_s }
+        rescue
+          false
+        end
+
+        # the view directory of mailer.
+        def mailer_directory
+          File.join(Core::Runner.base_path, "app/views/#{@klazz_name.to_s.underscore}")
+        end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -11,10 +11,6 @@ module RailsBestPractices
     #
     # Implementation:
     #
-    # Prepare process:
-    #   check all class nodes to see if they are the subclass of ActionMailer::Base,
-    #   if so, remember the class name.
-    #
     # Review process:
     #   check all call nodes to see if they are callback definitions, like after_create, before_destroy,
     #   if so, remember the callback methods.

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -9,11 +9,6 @@ module RailsBestPractices
     #
     # Implementation:
     #
-    # Prepare process:
-    #   only check all model files to save model names and association names,
-    #   model names are saved as only when subject of call method is equal to one of the model name, then the call method may use query attribute instead,
-    #   association names are saved as association attributes should not be detected as query attributes.
-    #
     # Review process:
     #   check all method calls within conditional statements, like @user.login.nil?
     #   if their subjects are one of the model names

data/lib/rails_best_practices/version.rb

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

data/rails_best_practices.yml

@@ -1,22 +1,24 @@
-MoveFinderToNamedScopeReview: { }
-UseModelAssociationReview: { }
-UseScopeAccessReview: { }
-AddModelVirtualAttributeReview: { }
-ReplaceComplexCreationWithFactoryMethodReview: { attribute_assignment_count: 2 }
-MoveModelLogicIntoModelReview: { use_count: 4 }
-OveruseRouteCustomizationsReview: { customize_count: 3 }
-NeedlessDeepNestingReview: { nested_count: 2 }
-NotUseDefaultRouteReview: {  }
-KeepFindersOnTheirOwnModelReview: { }
-LawOfDemeterReview: { }
-UseObserverReview: { }
-IsolateSeedDataReview: { }
-AlwaysAddDbIndexReview: { }
-UseBeforeFilterReview: { }
-MoveCodeIntoControllerReview: { }
-MoveCodeIntoModelReview: { use_count: 2 }
-MoveCodeIntoHelperReview: { array_count: 3 }
-ReplaceInstanceVariableWithLocalVariableReview: { }
-DryBundlerInCapistranoReview: { }
-UseSayWithTimeInMigrationsReview: { }
-UseQueryAttributeReview: { }
+MoveFinderToNamedScopeCheck: { }
+UseModelAssociationCheck: { }
+UseScopeAccessCheck: { }
+AddModelVirtualAttributeCheck: { }
+ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+MoveModelLogicIntoModelCheck: { use_count: 4 }
+OveruseRouteCustomizationsCheck: { customize_count: 3 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotUseDefaultRouteCheck: {  }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+UseObserverCheck: { }
+IsolateSeedDataCheck: { }
+AlwaysAddDbIndexCheck: { }
+UseBeforeFilterCheck: { }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoModelCheck: { use_count: 2 }
+MoveCodeIntoHelperCheck: { array_count: 3 }
+ReplaceInstanceVariableWithLocalVariableCheck: { }
+DryBundlerInCapistranoCheck: { }
+UseSayWithTimeInMigrationsCheck: { }
+UseQueryAttributeCheck: { }
+RemoveTrailingWhitespaceCheck: { }
+UseMultipartAlternativeAsContentTypeOfEmailCheck: {}

data/spec/rails_best_practices/core/checking_visitor_spec.rb

@@ -1,6 +1,10 @@
 # encoding: utf-8
 require 'spec_helper'
 
+class TestLexical1
+end
+class TestLexical2
+end
 class TestPrepare1
   def interesting_nodes
     [:call]
@@ -42,11 +46,27 @@ class TestReview2
 end
 
 describe RailsBestPractices::Core::CheckingVisitor do
+  let(:lexical1) { TestLexical1.new }
+  let(:lexical2) { TestLexical2.new }
   let(:prepare1) { TestPrepare1.new }
   let(:prepare2) { TestPrepare2.new }
   let(:review1) { TestReview1.new }
   let(:review2) { TestReview2.new }
-  let(:visitor) { RailsBestPractices::Core::CheckingVisitor.new([prepare1, prepare2], [review1, review2]) }
+  let(:visitor) {
+    RailsBestPractices::Core::CheckingVisitor.new(
+      :lexicals => [lexical1, lexical2],
+      :prepares => [prepare1, prepare2],
+      :reviews => [review1, review2]
+    )
+  }
+
+  it "should lexical check" do
+    filename = "app/models/user.rb"
+    content = "class User; end"
+    lexical1.should_receive(:check).with(filename, content)
+    lexical2.should_receive(:check).with(filename, content)
+    visitor.lexical(filename, content)
+  end
 
   it "should prepare model associations" do
     node = stub(:node_type => :call, :children => [], :file => "app/models/user.rb")

data/spec/rails_best_practices/core/visitable_sexp_spec.rb

@@ -254,6 +254,16 @@ describe Sexp do
       node.to_s.should == '{"first_name" => "Richard", "last_name" => "Huang"}'
     end
 
+    it "should get to_s for hash with true/false" do
+      node = parser.parse("{:shallow => true, :index => false}")
+      node.to_s.should == '{"shallow" => true, "index" => false}'
+    end
+
+    it "should get to_s for array and hash mixed" do
+      node = parser.parse("{:only => [:show, :index]}")
+      node.to_s.should == '{"only" => ["show", "index"]}'
+    end
+
     it "should get to_s for colon2" do
       node = parser.parse("RailsBestPractices::Core")
       node.to_s.should == "RailsBestPractices::Core"

data/spec/rails_best_practices/lexicals/remove_trailing_whitespace_check_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Lexicals::RemoveTrailingWhitespaceCheck do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:lexicals => RailsBestPractices::Lexicals::RemoveTrailingWhitespaceCheck.new) }
+
+  it "should remove trailing whitespace" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+    end
+    EOF
+    content.gsub!("\n", "  \n")
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/models/user.rb:1 - remove trailing whitespace"
+  end
+
+  it "should remove whitespace with third line" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+    end
+    EOF
+    content.gsub!("d\n", "d  \n")
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "app/models/user.rb:3 - remove trailing whitespace"
+  end
+
+  it "should not remove trailing whitespace" do
+    content =<<-EOF
+    class User < ActiveRecord::Base
+      has_many :projects
+    end
+    EOF
+    runner.lexical('app/models/user.rb', content)
+    runner.should have(0).errors
+  end
+end

data/spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb

@@ -17,6 +17,18 @@ describe RailsBestPractices::Reviews::NeedlessDeepNestingReview do
       runner.errors[0].to_s.should == "config/routes.rb:3 - needless deep nesting (nested_count > 2)"
     end
 
+    it "should not needless deep nesting for shallow" do
+      content = <<-EOF
+      map.resources :posts, :shallow => true do |post|
+        post.resources :comments do |comment|
+          comment.resources :favorites
+        end
+      end
+      EOF
+      runner.review('config/routes.rb', content)
+      runner.should have(0).errors
+    end
+
     it "should needless deep nesting with resource" do
       content = <<-EOF
       map.resources :posts do |post|
@@ -84,6 +96,18 @@ describe RailsBestPractices::Reviews::NeedlessDeepNestingReview do
       runner.errors[0].to_s.should == "config/routes.rb:4 - needless deep nesting (nested_count > 2)"
     end
 
+    it "should not needless deep nesting for shallow" do
+      content = <<-EOF
+      resources :posts, :shallow => true do
+        resources :comments do
+          resources :favorites
+        end
+      end
+      EOF
+      runner.review('config/routes.rb', content)
+      runner.should have(0).errors
+    end
+
     it "should needless deep nesting with resource" do
       content = <<-EOF
       resources :posts do

data/spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmailReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::UseMultipartAlternativeAsContentTypeOfEmailReview.new) }
+
+  context "rails2" do
+    before :each do
+      RailsBestPractices::Core::Runner.stub!(:base_path).and_return(".")
+    end
+
+    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
+        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
+        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
+        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
+        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
+      content =<<-EOF
+      class ProjectMailer < ActionMailer::Base
+        def no_deliver
+        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(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
+        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
+        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
+        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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_best_practices
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 3
   prerelease: 
   segments: 
   - 0
-  - 6
   - 7
-  version: 0.6.7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 +08:00
+date: 2011-02-15 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -196,6 +196,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - .rspec.example
 - .rvmrc.example
@@ -219,6 +220,8 @@ files:
 - 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
 - lib/rails_best_practices/prepares/mailer_prepare.rb
 - lib/rails_best_practices/prepares/model_prepare.rb
@@ -242,6 +245,7 @@ files:
 - lib/rails_best_practices/reviews/review.rb
 - lib/rails_best_practices/reviews/use_before_filter_review.rb
 - lib/rails_best_practices/reviews/use_model_association_review.rb
+- lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb
 - lib/rails_best_practices/reviews/use_observer_review.rb
 - lib/rails_best_practices/reviews/use_query_attribute_review.rb
 - lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb
@@ -256,6 +260,7 @@ files:
 - 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
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
@@ -277,6 +282,7 @@ files:
 - spec/rails_best_practices/reviews/review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
+- spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb
 - spec/rails_best_practices/reviews/use_observer_review_spec.rb
 - spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb
@@ -340,6 +346,7 @@ test_files:
 - 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
 - spec/rails_best_practices/reviews/add_model_virtual_attribute_review_spec.rb
@@ -361,6 +368,7 @@ test_files:
 - spec/rails_best_practices/reviews/review_spec.rb
 - spec/rails_best_practices/reviews/use_before_filter_review_spec.rb
 - spec/rails_best_practices/reviews/use_model_association_review_spec.rb
+- spec/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review_spec.rb
 - spec/rails_best_practices/reviews/use_observer_review_spec.rb
 - spec/rails_best_practices/reviews/use_query_attribute_review_spec.rb
 - spec/rails_best_practices/reviews/use_say_with_time_in_migrations_review_spec.rb