rails_best_practices 1.7.2 → 1.8.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails_best_practices (1.7.2)
+    rails_best_practices (1.8.0)
       activesupport
       colored
       erubis

data/README.md

@@ -3,7 +3,7 @@ rails_best_practices
 
 [![Build Status](https://secure.travis-ci.org/railsbp/rails_best_practices.png)](http://travis-ci.org/railsbp/rails_best_practices)
 
-[![Click here to lend your support to: rails-bestpractices.com and make a donation at www.pledgie.com !](https://www.pledgie.com/campaigns/12057.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12057)
+[![Click here to lend your support to: rails best practices and make a donation at www.pledgie.com !](http://www.pledgie.com/campaigns/12057.png?skin_name=chrome)](http://www.pledgie.com/campaigns/12057)
 
 rails_best_practices is a code metric tool to check the quality of rails codes.
 
@@ -50,6 +50,8 @@ By default rails_best_practices will do parse codes in vendor, spec, test and fe
             --features                   include features files
         -x, --exclude PATTERNS           Don't analyze files matching a pattern
                                          (comma-separated regexp list)
+        -o, --only PATTERNS              analyze files only matching a pattern
+                                         (comma-separated regexp list)
         -g, --generate                   Generate configuration yaml
         -v, --version                    Show this version
         -h, --help                       Show this message
@@ -140,6 +142,7 @@ Now you can customize this configuration file, the default configuration is as f
     RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
     RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
     RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
+    NotUseTimeAgoInWordsCheck: {}
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -198,6 +201,7 @@ View
 3. Move code into helper
 4. Replace instance variable with local variable
 5. Simplify render in views
+6. Not use time_ago_in_words
 
 Deployment
 

data/lib/rails_best_practices/analyzer.rb

@@ -46,6 +46,7 @@ module RailsBestPractices
     # @param [Hash] options
     def analyze
       @options["exclude"] ||= []
+      @options["only"] ||= []
       @options["output-file"] ||= "rails_best_practices_output.html"
 
       Core::Runner.base_path = @path
@@ -98,6 +99,10 @@ module RailsBestPractices
         files = expand_dirs_to_files(@path)
         files = file_sort(files)
 
+        if @options["only"].present?
+          files = file_accept(files, @options["only"])
+        end
+
         # By default, tmp, vender, spec, test, features are ignored.
         ["vendor", "spec", "test", "features", "tmp"].each do |pattern|
           files = file_ignore(files, "#{pattern}/") unless @options[pattern]
@@ -157,6 +162,14 @@ module RailsBestPractices
       files.reject { |file| file.index(pattern) }
     end
 
+    # accept specific files.
+    #
+    # @param [Array] files
+    # @param [Regexp] patterns, files match any pattern will be accepted
+    def file_accept files, patterns
+      files.reject { |file| !patterns.any? { |pattern| file =~ pattern } }
+    end
+
     # output errors on terminal.
     def output_terminal_errors
       @runner.errors.each { |error| plain_output(error.to_s, 'red') }
@@ -186,8 +199,9 @@ module RailsBestPractices
     # load git commit and git username info.
     def load_git_info
       git_progressbar = ProgressBar.new('Git Info', @runner.errors.size) if display_bar?
+      start = @runner.class.base_path =~ /\/$/ ? @runner.class.base_path.size : @runner.class.base_path.size + 1
       @runner.errors.each do |error|
-        git_info = `cd #{@runner.class.base_path}; git blame #{error.filename[@runner.class.base_path.size..-1]} | sed -n #{error.line_number.split(',').first}p`
+        git_info = `cd #{@runner.class.base_path}; git blame -L #{error.line_number.split(',').first},+1 #{error.filename[start..-1]}`
         unless git_info == ""
           git_commit, git_username = git_info.split(/\d{4}-\d{2}-\d{2}/).first.split("(")
           error.git_commit = git_commit.split(" ").first.strip

data/lib/rails_best_practices/command.rb

@@ -19,6 +19,8 @@ require 'optparse'
 #        --features                   include features files
 #    -x, --exclude PATTERNS           don't analyze files matching a pattern
 #                                     (comma-separated regexp list)
+#    -o, --only PATTERNS              analyze files only matching a pattern
+#                                     (comma-separated regexp list)
 #    -g, --generate                   generate configuration yaml
 #    -v, --version                    show this version
 #    -h, --help                       show this message
@@ -94,12 +96,20 @@ OptionParser.new do |opts|
 
   opts.on("-x", "--exclude PATTERNS", "Don't analyze files matching a pattern", "(comma-separated regexp list)") do |list|
     begin
-      options["exclude"] = list.split(/,/).map{|x| Regexp.new x}
+      options["exclude"] = list.split(",").map{|x| Regexp.new x}
     rescue RegexpError => e
       raise OptionParser::InvalidArgument, e.message
     end
   end
 
+  opts.on("-o", "--only PATTERNS", "Analyze files only matching a pattern", "(comma-separated regexp list)") do |list|
+    begin
+      options["only"] = list.split(",").map { |x| Regexp.new x }
+    rescue RegexpError => e
+      raise OptionParser::InvalidArgument e.message
+    end
+  end
+
   opts.on("-g", "--generate", "Generate configuration yaml") do
     options["generate"] = true
   end

data/lib/rails_best_practices/core/check.rb

@@ -73,10 +73,16 @@ module RailsBestPractices
       # add error if source code violates rails best practice.
       #
       # @param [String] message, is the string message for violation of the rails best practice
-      # @param [String] file, is the filename of source code
-      # @param [Integer] line, is the line number of the source code which is reviewing
-      def add_error(message, file = @node.file, line = @node.line)
-        errors << RailsBestPractices::Core::Error.new("#{file}", "#{line}", message, self.class.to_s, url)
+      # @param [String] filename, is the filename of source code
+      # @param [Integer] line_number, is the line number of the source code which is reviewing
+      def add_error(message, filename = @node.file, line_number = @node.line)
+        errors << RailsBestPractices::Core::Error.new(
+          :filename => filename,
+          :line_number => line_number,
+          :message => message,
+          :type => self.class.to_s,
+          :url => url
+        )
       end
 
       # errors that vialote the rails best practices.
@@ -265,7 +271,7 @@ module RailsBestPractices
               when "alias_method_chain"
                 method, feature = *node.arguments.all.map(&:to_s)
                 call_method("#{method}_with_#{feature}")
-              when /(before|after)_/
+              when /^(before|after)_/
                 node.arguments.all.each { |argument| mark_used(argument) }
               else
                 mark_used(node.message)
@@ -374,6 +380,7 @@ module RailsBestPractices
                 class_name, method_name = except_method.split('#')
                 (class_name == '*' && method_name == method.method_name) ||
                   (method_name == '*' && class_name == method.class_name) ||
+                  (method_name == '*' && class_name == Prepares.klasses.find { |klass| klass.class_name == method.class_name }.try(:extend_class_name)) ||
                   (class_name == method.class_name && method_name == method.method_name)
               end
             end

data/lib/rails_best_practices/core/error.rb

@@ -8,12 +8,16 @@ module RailsBestPractices
       attr_reader :filename, :line_number, :message, :type, :url
       attr_accessor :git_commit, :git_username, :hg_commit, :hg_username
 
-      def initialize(filename, line_number, message, type, url = nil)
-        @filename = filename
-        @line_number = line_number
-        @message = message
-        @type = type
-        @url = url
+      def initialize(options={})
+        @filename = options[:filename]
+        @line_number = options[:line_number].to_s
+        @message = options[:message]
+        @type = options[:type]
+        @url = options[:url]
+        @git_commit = options[:git_commit]
+        @git_username = options[:git_username]
+        @hg_commit = options[:hg_commit]
+        @hg_username = options[:hg_username]
       end
 
       def short_filename

data/lib/rails_best_practices/core/model_associations.rb

@@ -7,7 +7,6 @@ module RailsBestPractices
         @associations = {}
       end
 
-      # Add a model association.
       #
       # @param [String] model name
       # @param [String] association name
@@ -37,6 +36,22 @@ module RailsBestPractices
         associations = @associations[model_name]
         associations && associations[association_name]
       end
+
+      # delegate each to @associations.
+      def each(&block)
+        @associations.each { |model, model_associations| yield model, model_associations }
+      end
+
+      # Get association's class name
+      #
+      # @param [String] table name
+      # @param [String] association_name
+      # @return [String] association's class name
+      def get_association_class_name(table_name, association_name)
+        associations = @associations.select { |model, model_associations| model.table_name == table_name }.values.first and
+          association_meta = associations.select { |name, meta| name == association_name }.values.first and
+          association_meta["class_name"]
+      end
     end
   end
 end

data/lib/rails_best_practices/core/runner.rb

@@ -3,6 +3,7 @@ require 'yaml'
 require 'ripper'
 require 'active_support/inflector'
 require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
 
 module RailsBestPractices
   module Core

data/lib/rails_best_practices/core.rb

@@ -15,6 +15,7 @@ require 'rails_best_practices/core/controllers'
 require 'rails_best_practices/core/helpers'
 require 'rails_best_practices/core/routes'
 
+require 'rails_best_practices/core_ext/string'
 require 'rails_best_practices/core_ext/sexp'
 require 'rails_best_practices/core_ext/enumerable'
 require 'rails_best_practices/core_ext/erubis'

data/lib/rails_best_practices/core_ext/sexp.rb

@@ -21,7 +21,7 @@ class Sexp
   #     s(:@ident, "test", s(2, 12)
   #       => 2
   def line
-    if [:def, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block,
+    if [:def, :defs, :command, :command_call, :call, :fcall, :method_add_arg, :method_add_block,
       :var_ref, :const_ref, :const_path_ref, :class, :module, :if, :unless, :elsif, :binary,
       :alias, :symbol_literal, :symbol, :aref].include? sexp_type
       self[1].line
@@ -382,8 +382,12 @@ class Sexp
   #
   # @return [Sexp] method name node
   def method_name
-    if :def == sexp_type
+    case sexp_type
+    when :def
       self[1]
+    when :defs
+      self[3]
+    else
     end
   end
 

data/lib/rails_best_practices/core_ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def table_name
+    self.gsub("::", "").tableize
+  end
+end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -7,8 +7,9 @@ module RailsBestPractices
     class ModelPrepare < Core::Check
       include Core::Check::Classable
       include Core::Check::Accessable
+      include Core::Check::Afterable
 
-      interesting_nodes :class, :def, :command, :var_ref, :alias
+      interesting_nodes :class, :def, :defs, :command, :var_ref, :alias
       interesting_files MODEL_FILES
 
       ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many embeds_many embeds_one embedded_in many one)
@@ -27,7 +28,7 @@ module RailsBestPractices
         end
       end
 
-      # check ref node to remember all methods.
+      # check def node to remember all methods.
       #
       # the remembered methods (@methods) are like
       #     {
@@ -46,6 +47,25 @@ module RailsBestPractices
         end
       end
 
+      # check defs node to remember all static methods.
+      #
+      # the remembered methods (@methods) are like
+      #     {
+      #       "Post" => {
+      #         "save" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false},
+      #         "find" => {"file" => "app/models/post.rb", "line" => 10, "unused" => false, "unused" => false}
+      #       },
+      #       "Comment" => {
+      #         "create" => {"file" => "app/models/comment.rb", "line" => 10, "unused" => false, "unused" => false},
+      #       }
+      #     }
+      def start_defs(node)
+        if @klass && "ActionMailer::Base" != current_extend_class_name
+          method_name = node.method_name.to_s
+          @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
+        end
+      end
+
       # check command node to remember all assoications or named_scope/scope methods.
       #
       # the remembered association names (@associations) are like
@@ -86,6 +106,21 @@ module RailsBestPractices
         @methods.add_method(current_class_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)
       end
 
+      # after prepare process, fix incorrect associations' class_name.
+      def after_prepare
+        @model_associations.each do |model, model_associations|
+          model_associations.each do |association_name, association_meta|
+            unless @models.include?(association_meta["class_name"])
+              if @models.include?("#{model}::#{association_meta['class_name']}")
+                association_meta["class_name"] = "#{model}::#{association_meta['class_name']}"
+              elsif @models.include?(model.gsub(/::\w+$/, ""))
+                association_meta["class_name"] = model.gsub(/::\w+$/, "")
+              end
+            end
+          end
+        end
+      end
+
       private
         # remember associations, with class to association names.
         def remember_association(node)

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -5,7 +5,7 @@ module RailsBestPractices
   module Prepares
     # Remembber routes.
     class RoutePrepare < Core::Check
-      interesting_nodes :command, :command_call, :method_add_block
+      interesting_nodes :command, :command_call, :method_add_block, :do_block
       interesting_files ROUTE_FILES
 
       RESOURCES_ACTIONS = %w(index show new create edit update destroy)
@@ -14,6 +14,7 @@ module RailsBestPractices
       def initialize
         @routes = Prepares.routes
         @namespaces = []
+        @controller_names = []
       end
 
       # remember route for rails3.
@@ -25,7 +26,8 @@ module RailsBestPractices
           add_resource_routes(node)
         when "get", "post", "put", "delete"
           first_argument = node.arguments.all.first
-          if current_controller_name.present?
+          second_argument = node.arguments.all[1]
+          if @controller_names.last
             action_name = first_argument.to_s
             @routes.add_route(current_namespaces, current_controller_name, action_name)
           else
@@ -34,6 +36,8 @@ module RailsBestPractices
               # do not parse redirect block
               return if :method_add_arg == route_node.sexp_type
               controller_name, action_name = route_node.to_s.split('#')
+            elsif :bare_assoc_hash == second_argument.try(:sexp_type) && second_argument.hash_value("to")
+              controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
             else
               controller_name, action_name = first_argument.to_s.split('/')
             end
@@ -91,10 +95,12 @@ module RailsBestPractices
         case node.message.to_s
         when "namespace"
           @namespaces << node.arguments.all.first.to_s
+          @controller_name = nil
         when "scope"
           if node.arguments.all.last.hash_value("module").present?
             @namespaces << node.arguments.all.last.hash_value("module").to_s
           end
+          @controller_name = nil
         when "with_options"
           argument = node.arguments.all.last
           if :bare_assoc_hash == argument.sexp_type && argument.hash_value("controller").present?
@@ -119,6 +125,16 @@ module RailsBestPractices
         end
       end
 
+      # remember current controller name, used for nested resources.
+      def start_do_block(node)
+        @controller_names << @controller_name
+      end
+
+      # remove current controller name, and use upper lever resource name.
+      def end_do_block(node)
+        @controller_names.pop
+      end
+
       [:resources, :resource].each do |route_name|
         class_eval <<-EOF
         def add_#{route_name}_routes(node)
@@ -185,7 +201,7 @@ module RailsBestPractices
       end
 
       def current_controller_name
-        @controller_name
+        @controller_names.last || @controller_name
       end
     end
   end

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -74,7 +74,9 @@ module RailsBestPractices
       # if there are any foreign keys not existed in index columns,
       # then we should add db index for that foreign keys.
       def after_review
+        remove_table_not_exist_foreign_keys
         remove_only_type_foreign_keys
+        combine_polymorphic_foreign_keys
         @foreign_keys.each do |table, foreign_key|
           table_node = @table_nodes[table]
           foreign_key.each do |column|
@@ -122,6 +124,18 @@ module RailsBestPractices
           end
         end
 
+        # remove the non foreign keys without corresponding tables.
+        def remove_table_not_exist_foreign_keys
+          @foreign_keys.each do |table, foreign_keys|
+            foreign_keys.delete_if do |key|
+              if key =~ /_id$/
+                class_name = Prepares.model_associations.get_association_class_name(table, key[0..-4])
+                class_name ? !@table_nodes[class_name.table_name] : !@table_nodes[key[0..-4].pluralize]
+              end
+            end
+          end
+        end
+
         # remove the non foreign keys with only _type column.
         def remove_only_type_foreign_keys
           @foreign_keys.each { |table, foreign_keys|
@@ -129,6 +143,22 @@ module RailsBestPractices
           }
         end
 
+        # combine polymorphic foreign keys, e.g.
+        #     [tagger_id], [tagger_type] => [tagger_id, tagger_type]
+        def combine_polymorphic_foreign_keys
+          @index_columns.each { |table, foreign_keys|
+            foreign_id_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_id/ }
+            foreign_type_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_type/ }
+            foreign_id_keys.each do |id_key|
+              if type_key = foreign_type_keys.detect { |type_key| type_key.first == id_key.first.sub(/_id/, '') + "_type" }
+                foreign_keys.delete(id_key)
+                foreign_keys.delete(type_key)
+                foreign_keys << id_key + type_key
+              end
+            end
+          }
+        end
+
         # check if the table's column is indexed.
         def indexed?(table, column)
           index_columns = @index_columns[table]

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    # Review view and helper files to make sure not use time_ago_in_words or distance_of_time_in_words_to_now.
+    #
+    # See the best practice details here http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words.
+    #
+    # Implementation:
+    #
+    # Review process:
+    #   check all fcall node to see if its message is time_ago_in_words and distance_of_time_in_words_to_now
+    class NotUseTimeAgoInWordsReview < Review
+      interesting_nodes :fcall
+      interesting_files VIEW_FILES, HELPER_FILES
+
+      def url
+        "http://rails-bestpractices.com/posts/105-not-use-time_ago_in_words"
+      end
+
+      # check fcall node to see if its message is time_ago_in_words or distance_of_time_in_words_to_now
+      def start_fcall(node)
+        if "time_ago_in_words" == node.message.to_s || "distance_of_time_in_words_to_now" == node.message.to_s
+          add_error "not use time_ago_in_words"
+        end
+      end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -98,7 +98,8 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(rescue_action).map { |method_name| "*\##{method_name}" }
+          %w(rescue_action).map { |method_name| "*\##{method_name}" } +
+            %w(Devise::OmniauthCallbacksController).map { |controller_name| "#{controller_name}#*" }
         end
 
         def mark_publicize(method_name, class_name=current_class_name)

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -40,7 +40,7 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          []
+          ["*#url_for"]
         end
     end
   end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
       include Callable
       include Exceptable
 
-      interesting_nodes :command
+      interesting_nodes :command, :command_call, :method_add_arg
       interesting_files ALL_FILES
 
       def initialize(options={})
@@ -31,12 +31,50 @@ module RailsBestPractices
       end
 
       # mark validate methods as used.
+      # mark key method and value method for collection_select and grouped_collection_select.
       def start_command(node)
+        arguments = node.arguments.all
         case node.message.to_s
         when "validate", "validate_on_create", "validate_on_update"
-          node.arguments.all.each { |argument| mark_used(argument) }
-        else
-          # nothing
+          arguments.each { |argument| mark_used(argument) }
+        when "collection_select"
+          mark_used(arguments[3])
+          mark_used(arguments[4])
+        when "grouped_collection_select"
+          mark_used(arguments[3])
+          mark_used(arguments[4])
+          mark_used(arguments[5])
+          mark_used(arguments[6])
+        end
+      end
+
+      # mark key method and value method for collection_select and grouped_collection_select.
+      def start_command_call(node)
+        arguments = node.arguments.all
+        case node.message.to_s
+        when "collection_select"
+          mark_used(arguments[2])
+          mark_used(arguments[3])
+        when "grouped_collection_select"
+          mark_used(arguments[2])
+          mark_used(arguments[3])
+          mark_used(arguments[4])
+          mark_used(arguments[5])
+        end
+      end
+
+      # mark key method and value method for options_from_collection_for_select and option_groups_from_collection_for_select.
+      def start_method_add_arg(node)
+        arguments = node.arguments.all
+        case node.message.to_s
+        when "options_from_collection_for_select"
+          mark_used(arguments[1])
+          mark_used(arguments[2])
+        when "option_groups_from_collection_for_select"
+          mark_used(arguments[1])
+          mark_used(arguments[2])
+          mark_used(arguments[3])
+          mark_used(arguments[4])
         end
       end
 
@@ -55,7 +93,11 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(initialize validate validate_each to_xml to_json assign_attributes after_find after_initialize).map { |method_name| "*\##{method_name}" }
+          %w(
+            initialize validate validate_each to_xml to_json assign_attributes after_find after_initialize
+            before_save before_create before_update before_destroy after_save after_create after_update after_destroy
+            to_param method_missing
+          ).map { |method_name| "*\##{method_name}" }
         end
     end
   end

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -86,10 +86,10 @@ module RailsBestPractices
             if hash_key_exist?(option_node,"controller")
               name = option_node.hash_value("controller").to_s
             else
-              name = node.arguments.all.first.to_s.tableize
+              name = node.arguments.all.first.to_s.table_name
             end
           else
-            name = node.arguments.all.first.to_s.tableize
+            name = node.arguments.all.first.to_s.table_name
           end
           namespaced_class_name(name)
         end

data/lib/rails_best_practices/reviews.rb

@@ -29,3 +29,4 @@ require 'rails_best_practices/reviews/restrict_auto_generated_routes_review'
 require 'rails_best_practices/reviews/remove_unused_methods_in_models_review'
 require 'rails_best_practices/reviews/remove_unused_methods_in_controllers_review'
 require 'rails_best_practices/reviews/remove_unused_methods_in_helpers_review'
+require 'rails_best_practices/reviews/not_use_time_ago_in_words_review'

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "1.7.2"
+  VERSION = "1.8.0"
 end

data/rails_best_practices.gemspec

@@ -40,6 +40,10 @@ Gem::Specification.new do |s|
 
       http://rails-bestpractices.com
 
+  Please also try our online service
+
+      https://railsbp.com
+
   Enjoy!
 
       Richard Huang (flyerhzm@gmail.com)

data/rails_best_practices.yml

@@ -30,3 +30,4 @@ RestrictAutoGeneratedRoutesCheck: { }
 RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
 RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
 RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
+NotUseTimeAgoInWordsCheck: { }

data/spec/rails_best_practices/core/error_spec.rb

@@ -2,15 +2,27 @@ require 'spec_helper'
 
 describe RailsBestPractices::Core::Error do
   it "should return error with filename, line number and message" do
-    RailsBestPractices::Core::Error.new("app/models/user.rb", "100", "not good", "BogusReview").to_s.should == "app/models/user.rb:100 - not good"
+    RailsBestPractices::Core::Error.new(
+      :filename => "app/models/user.rb",
+      :line_number => "100",
+      :message => "not good",
+      :type => "BogusReview").to_s.should == "app/models/user.rb:100 - not good"
   end
 
   it "should return short filename" do
     RailsBestPractices::Core::Runner.base_path = "../rails-bestpractices.com"
-    RailsBestPractices::Core::Error.new("../rails-bestpractices.com/app/models/user.rb", "100", "not good", "BogusReview").short_filename.should == "app/models/user.rb"
+    RailsBestPractices::Core::Error.new(
+      :filename => "../rails-bestpractices.com/app/models/user.rb",
+      :line_number => "100",
+      :message => "not good",
+      :type => "BogusReview").short_filename.should == "app/models/user.rb"
   end
 
   it "should return first line number" do
-    RailsBestPractices::Core::Error.new("app/models/user.rb", "50,70,100", "not good", "BogusReview").first_line_number.should == "50"
+    RailsBestPractices::Core::Error.new(
+      :filename => "app/models/user.rb",
+      :line_number => "50,70,100",
+      :message => "not good",
+      :type => "BogusReview").first_line_number.should == "50"
   end
 end

data/spec/rails_best_practices/core_ext/sexp_spec.rb

@@ -281,10 +281,15 @@ describe Sexp do
   end
 
   describe "method_name" do
-    it "should get the method name of defn" do
+    it "should get the method name of def" do
       node = parse_content("def show; end").grep_node(:sexp_type => :def)
       node.method_name.to_s.should == "show"
     end
+
+    it "should get the method name of defs" do
+      node = parse_content("def self.find; end").grep_node(:sexp_type => :defs)
+      node.method_name.to_s.should == "find"
+    end
   end
 
   describe "body" do

data/spec/rails_best_practices/prepares/helper_prepare_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe RailsBestPractices::Prepares::HelperPrepare do
-  let(:runner) { RailsBestPractices::Core::Runner.new(:parepare => RailsBestPractices::Prepares::HelperPrepare.new) }
+  let(:runner) { RailsBestPractices::Core::Runner.new(:prepares => RailsBestPractices::Prepares::HelperPrepare.new) }
 
   context "methods" do
     it "should parse helper methods" do

data/spec/rails_best_practices/prepares/model_prepare_spec.rb

@@ -93,6 +93,46 @@ describe RailsBestPractices::Prepares::ModelPrepare do
         model_associations = RailsBestPractices::Prepares.model_associations
         model_associations.get_association("Citizen", "nations").should == {"meta" => "has_and_belongs_to_many", "class_name" => "Country"}
       end
+
+      context "namespace" do
+        it "should parse with namespace" do
+          content =<<-EOF
+          class Community < ActiveRecord::Base
+            has_many :members
+          end
+          EOF
+          runner.prepare("app/models/community.rb", content)
+          content =<<-EOF
+          class Community::Member < ActiveRecord::Base
+            belongs_to :community
+          end
+          EOF
+          runner.prepare("app/models/community/member.rb", content)
+          runner.after_prepare
+          model_associations = RailsBestPractices::Prepares.model_associations
+          model_associations.get_association("Community", "members").should == {"meta" => "has_many", "class_name" => "Community::Member"}
+          model_associations.get_association("Community::Member", "community").should == {"meta" => "belongs_to", "class_name" => "Community"}
+        end
+
+        it "should parse without namespace" do
+          content =<<-EOF
+          class Community::Member::Rating < ActiveRecord::Base
+            belongs_to :member
+          end
+          EOF
+          runner.prepare("app/models/community/member/rating.rb", content)
+          content =<<-EOF
+          class Community::Member < ActiveRecord::Base
+            has_many :ratings
+          end
+          EOF
+          runner.prepare("app/models/community/member.rb", content)
+          runner.after_prepare
+          model_associations = RailsBestPractices::Prepares.model_associations
+          model_associations.get_association("Community::Member::Rating", "member").should == {"meta" => "belongs_to", "class_name" => "Community::Member"}
+          model_associations.get_association("Community::Member", "ratings").should == {"meta" => "has_many", "class_name" => "Community::Member::Rating"}
+        end
+      end
     end
 
     context "mongoid embeds" do

data/spec/rails_best_practices/prepares/route_prepare_spec.rb

@@ -255,6 +255,18 @@ describe RailsBestPractices::Prepares::RoutePrepare do
       routes = RailsBestPractices::Prepares.routes
       routes.map(&:to_s).should == ["AdminSessionController#new"]
     end
+
+    it "should not take former resources for direct get/post" do
+      content =<<-EOF
+      ActionController::Routing::Routes.draw do |map|
+        map.resources :posts
+        map.stop 'sprints/stop', :controller => 'sprints', :action => 'stop'
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.last.to_s.should == "SprintsController#stop"
+    end
   end
 
   context "rails3" do
@@ -517,6 +529,18 @@ describe RailsBestPractices::Prepares::RoutePrepare do
       routes.map(&:to_s).should == ["PostsController#show", "PostsController#create", "PostsController#update", "PostsController#destroy", "HighVoltage::PagesController#show"]
     end
 
+    it "should add routes for another get/post" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        get "/login", to: 'sessions#new', as: :login
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.size.should == 1
+      routes.first.to_s.should == "SessionsController#new"
+    end
+
     it "should add match route" do
       content =<<-EOF
       RailsBestPracticesCom::Application.routes.draw do
@@ -572,5 +596,31 @@ describe RailsBestPractices::Prepares::RoutePrepare do
       routes = RailsBestPractices::Prepares.routes
       routes.size.should == 0
     end
+
+    it "should parse customize route in nested resources" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        resources :posts do
+          resources :comments
+          post :stop
+        end
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.last.to_s.should == "PostsController#stop"
+    end
+
+    it "should not take former resources for direct get/post" do
+      content =<<-EOF
+      RailsBestPracticesCom::Application.routes.draw do
+        resources :posts
+        post "sprints/stop"
+      end
+      EOF
+      runner.prepare('config/routes.rb', content)
+      routes = RailsBestPractices::Prepares.routes
+      routes.last.to_s.should == "SprintsController#stop"
+    end
   end
 end

data/spec/rails_best_practices/reviews/always_add_db_index_review_spec.rb

@@ -13,6 +13,10 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
         t.integer "post_id"
         t.integer "user_id"
       end
+      create_table "posts", :force => true do |t|
+      end
+      create_table "users", :force => true do |t|
+      end
     end
     EOF
     runner.review('db/schema.rb', content)
@@ -62,6 +66,8 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
         t.integer  "taggable_id"
         t.string   "taggable_type"
       end
+      create_table "tags", :force => true do |t|
+      end
 
       add_index "taggings", ["tag_id"], :name => "index_taggings_on_tag_id"
     end
@@ -80,6 +86,8 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
         t.integer  "taggable_id"
         t.string   "taggable_type"
       end
+      create_table "tags", :force => true do |t|
+      end
 
       add_index "taggings", ["taggable_id", "taggable_type"], :name => "index_taggings_on_taggable_id_and_taggable_type"
     end
@@ -99,6 +107,8 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
         t.integer  "icon_file_size"
         t.string   "icon_content_type"
       end
+      create_table "users", :force => true do |t|
+      end
     end
     EOF
     runner.review('db/schema.rb', content)
@@ -129,6 +139,10 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
         t.integer "post_id"
         t.integer "user_id"
       end
+      create_table "posts", :force => true do |t|
+      end
+      create_table "users", :force => true do |t|
+      end
 
       add_index "comments", ["post_id"], :name => "index_comments_on_post_id"
       add_index "comments", ["user_id"], :name => "index_comments_on_user_id"
@@ -185,4 +199,62 @@ describe RailsBestPractices::Reviews::AlwaysAddDbIndexReview do
     runner.after_review
     runner.should have(0).errors
   end
+
+  it "should not always add db index if two indexes for polymorphic association" do
+    content =<<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "taggings", :force => true do |t|
+        t.integer "tagger_id"
+        t.string "tagger_type"
+        t.datetime "created_at"
+      end
+
+      add_index "taggings", ["tagger_id"], :name => "index_taggings_on_tagger_id"
+      add_index "taggings", ["tagger_type"], :name => "index_taggings_on_tagger_type"
+    end
+    EOF
+    runner.review('db/schema.rb', content)
+    runner.after_review
+    runner.should have(0).errors
+  end
+
+  it "should not always add db index if table does not exist" do
+    content =<<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "comments", :force => true do |t|
+        t.integer "post_id"
+      end
+    end
+    EOF
+    runner.review('db/schema.rb', content)
+    runner.after_review
+    runner.should have(0).errors
+  end
+
+  it "should always add db index if association_name is different to foreign_key" do
+    content =<<-EOF
+    class Comment < ActiveRecord::Base
+      belongs_to :commentor, :class_name => "User"
+    end
+    EOF
+    runner.prepare('app/models/comment.rb', content)
+    content =<<-EOF
+    class User < ActiveRecord::Base
+    end
+    EOF
+    runner.prepare('app/models/user.rb', content)
+    content =<<-EOF
+    ActiveRecord::Schema.define(:version => 20100603080629) do
+      create_table "comments", :force => true do |t|
+        t.integer "commentor_id"
+      end
+      create_table "users", :force => true do |t|
+      end
+    end
+    EOF
+    runner.review('db/schema.rb', content)
+    runner.after_review
+    runner.should have(1).errors
+    runner.errors[0].to_s.should == "db/schema.rb:2 - always add db index (comments => [commentor_id])"
+  end
 end

data/spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe RailsBestPractices::Reviews::NotUseTimeAgoInWordsReview do
+  let(:runner) { RailsBestPractices::Core::Runner.new(:reviews => RailsBestPractices::Reviews::NotUseTimeAgoInWordsReview.new) }
+
+  describe "time_ago_in_words" do
+    it "should not use in views" do
+      content =<<-EOF
+      <%= time_ago_in_words(post.created_at) %>
+      EOF
+      runner.review('app/views/posts/show.html.erb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/views/posts/show.html.erb:1 - not use time_ago_in_words"
+    end
+
+    it "should not use in helpers" do
+      content =<<-EOF
+      def timeago
+        content_tag(:p, time_ago_in_words(post.created_at))
+      end
+      EOF
+      runner.review('app/helpers/posts_helper.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - not use time_ago_in_words"
+    end
+  end
+
+  describe "distance_of_time_in_words_to_now" do
+    it "should not use in views" do
+      content =<<-EOF
+      <%= distance_of_time_in_words_to_now(post.created_at) %>
+      EOF
+      runner.review('app/views/posts/show.html.erb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/views/posts/show.html.erb:1 - not use time_ago_in_words"
+    end
+
+    it "should not use in helpers" do
+      content =<<-EOF
+      def timeago
+        content_tag(:p, distance_of_time_in_words_to_now(post.created_at))
+      end
+      EOF
+      runner.review('app/helpers/posts_helper.rb', content)
+      runner.should have(1).errors
+      runner.errors[0].to_s.should == "app/helpers/posts_helper.rb:2 - not use time_ago_in_words"
+    end
+  end
+end

data/spec/rails_best_practices/reviews/remove_unused_methods_in_models_review_spec.rb

@@ -602,5 +602,69 @@ describe RailsBestPractices::Reviews::RemoveUnusedMethodsInModelsReview do
       runner.after_review
       runner.should have(0).errors
     end
+
+    it "should not remove unused methods for to_param" do
+      content =<<-EOF
+      class Post < ActiveRecord::Base
+        def to_param
+          id
+        end
+      end
+      EOF
+      runner.prepare("app/models/post.rb", content)
+      runner.review("app/models/post.rb", content)
+      runner.after_review
+      runner.should have(0).errors
+    end
+  end
+
+  context "helper method" do
+    it "should not remove unused method for coommand_call collection_select" do
+      content =<<-EOF
+      class Category < ActiveRecord::Base
+        def indented_name; end
+      end
+      EOF
+      runner.prepare("app/models/category.rb", content)
+      runner.review("app/models/category.rb", content)
+      content =<<-EOF
+      <%= f.collection_select :parent_id, Category.all_hierarchic(except: @category), :id, :indented_name, {include_blank: true} %>
+      EOF
+      runner.review("app/views/categories/_form.html.erb", content)
+      runner.after_review
+      runner.should have(0).errors
+    end
+
+    it "should not remove unused method for command collection_select" do
+      content =<<-EOF
+      class Category < ActiveRecord::Base
+        def indented_name; end
+      end
+      EOF
+      runner.prepare("app/models/category.rb", content)
+      runner.review("app/models/category.rb", content)
+      content =<<-EOF
+      <%= collection_select :category, :parent_id, Category.all_hierarchic(except: @category), :id, :indented_name, {include_blank: true} %>
+      EOF
+      runner.review("app/views/categories/_form.html.erb", content)
+      runner.after_review
+      runner.should have(0).errors
+    end
+
+    it "should not remove unused method for options_from_collection_for_select" do
+      content =<<-EOF
+      class Category < ActiveRecord::Base
+        def indented_name; end
+      end
+      EOF
+      runner.prepare("app/models/category.rb", content)
+      runner.review("app/models/category.rb", content)
+      content =<<-EOF
+      <%= select_tag 'category', options_from_collection_for_select(Category.all_hierachic(except: @category), :id, :indented_name) %>
+      EOF
+      runner.review("app/views/categories/_form.html.erb", content)
+      runner.after_review
+      runner.should have(0).errors
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_best_practices
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-28 00:00:00.000000000Z
+date: 2012-02-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
-  requirement: &70233747842020 !ruby/object:Gem::Requirement
+  requirement: &70270463469100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747842020
+  version_requirements: *70270463469100
 - !ruby/object:Gem::Dependency
   name: progressbar
-  requirement: &70233747840780 !ruby/object:Gem::Requirement
+  requirement: &70270463467440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747840780
+  version_requirements: *70270463467440
 - !ruby/object:Gem::Dependency
   name: colored
-  requirement: &70233747835040 !ruby/object:Gem::Requirement
+  requirement: &70270463456860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747835040
+  version_requirements: *70270463456860
 - !ruby/object:Gem::Dependency
   name: erubis
-  requirement: &70233747833880 !ruby/object:Gem::Requirement
+  requirement: &70270463455020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747833880
+  version_requirements: *70270463455020
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70233747832640 !ruby/object:Gem::Requirement
+  requirement: &70270463453880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747832640
+  version_requirements: *70270463453880
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70233747831960 !ruby/object:Gem::Requirement
+  requirement: &70270463452620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70233747831960
+  version_requirements: *70270463452620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70233747831080 !ruby/object:Gem::Requirement
+  requirement: &70270463451560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233747831080
+  version_requirements: *70270463451560
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70233747830280 !ruby/object:Gem::Requirement
+  requirement: &70270463450820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233747830280
+  version_requirements: *70270463450820
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70233747829320 !ruby/object:Gem::Requirement
+  requirement: &70270463450120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233747829320
+  version_requirements: *70270463450120
 - !ruby/object:Gem::Dependency
   name: slim
-  requirement: &70233747828460 !ruby/object:Gem::Requirement
+  requirement: &70270463444400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233747828460
+  version_requirements: *70270463444400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70233747827520 !ruby/object:Gem::Requirement
+  requirement: &70270463443380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70233747827520
+  version_requirements: *70270463443380
 description: a code metric tool for rails codes, written in Ruby.
 email:
 - flyerhzm@gmail.com
@@ -179,6 +179,7 @@ files:
 - lib/rails_best_practices/core_ext/enumerable.rb
 - lib/rails_best_practices/core_ext/erubis.rb
 - lib/rails_best_practices/core_ext/sexp.rb
+- lib/rails_best_practices/core_ext/string.rb
 - lib/rails_best_practices/lexicals.rb
 - lib/rails_best_practices/lexicals/remove_tab_check.rb
 - lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb
@@ -203,6 +204,7 @@ files:
 - lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb
 - lib/rails_best_practices/reviews/needless_deep_nesting_review.rb
 - lib/rails_best_practices/reviews/not_use_default_route_review.rb
+- lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb
 - lib/rails_best_practices/reviews/overuse_route_customizations_review.rb
 - lib/rails_best_practices/reviews/remove_empty_helpers_review.rb
 - lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb
@@ -266,6 +268,7 @@ files:
 - spec/rails_best_practices/reviews/move_model_logic_into_model_review_spec.rb
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
+- spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb
@@ -289,7 +292,8 @@ licenses: []
 post_install_message: ! "********************************************************************************\n\n
   \ rails_best_practices is a code metric tool to check the quality of rails codes.\n\n
   \ I highly recommend you browse the Rails Best Practices website first.\n\n      http://rails-bestpractices.com\n\n
-  \ Enjoy!\n\n      Richard Huang (flyerhzm@gmail.com)\n\n********************************************************************************\n"
+  \ Please also try our online service\n\n      https://railsbp.com\n\n  Enjoy!\n\n
+  \     Richard Huang (flyerhzm@gmail.com)\n\n********************************************************************************\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -302,7 +306,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 539864756318375074
+      hash: 920336894600409116
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -311,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: a code metric tool for rails codes.
@@ -357,6 +361,7 @@ test_files:
 - spec/rails_best_practices/reviews/move_model_logic_into_model_review_spec.rb
 - spec/rails_best_practices/reviews/needless_deep_nesting_review_spec.rb
 - spec/rails_best_practices/reviews/not_use_default_route_review_spec.rb
+- spec/rails_best_practices/reviews/not_use_times_ago_in_words_review_spec.rb
 - spec/rails_best_practices/reviews/overuse_route_customizations_review_spec.rb
 - spec/rails_best_practices/reviews/remove_empty_helpers_review_spec.rb
 - spec/rails_best_practices/reviews/remove_unused_methods_in_controllers_review_spec.rb