rails_best_practices 1.10.1 → 1.11.0

data/lib/rails_best_practices/core/error.rb

@@ -4,14 +4,12 @@ module RailsBestPractices
     # Error is the violation to rails best practice.
     #
     # it indicates the filenname, line number and error message for the violation.
-    class Error
-      attr_reader :filename, :line_number, :message, :type, :url
+    class Error < CodeAnalyzer::Warning
+      attr_reader :type, :url
       attr_accessor :git_commit, :git_username, :hg_commit, :hg_username, :highlight
 
       def initialize(options={})
-        @filename = options[:filename]
-        @line_number = options[:line_number].to_s
-        @message = options[:message]
+        super
         @type = options[:type]
         @url = options[:url]
         @git_commit = options[:git_commit]
@@ -28,10 +26,6 @@ module RailsBestPractices
       def first_line_number
         line_number.split(',').first
       end
-
-      def to_s
-        "#{@filename}:#{@line_number} - #{@message}"
-      end
     end
   end
 end

data/lib/rails_best_practices/core/runner.rb

@@ -1,6 +1,5 @@
 # encoding: utf-8
 require 'yaml'
-require 'ripper'
 require 'active_support/inflector'
 require 'active_support/core_ext/object/blank'
 begin
@@ -19,7 +18,6 @@ module RailsBestPractices
     # 2. review process, it does real check, if the source code violates some best practices, the violations will be notified.
     class Runner
       attr_reader :checks
-      attr_accessor :debug, :whiny, :color
 
       # set the base path.
       #
@@ -50,66 +48,46 @@ module RailsBestPractices
         @reviews = reviews.empty? ? load_reviews : reviews
         load_plugin_reviews if reviews.empty?
 
-        @checker ||= CheckingVisitor.new(prepares: @prepares, reviews: @reviews, lexicals: @lexicals)
-        @debug = false
-        @whiny = false
+        @lexical_checker ||= CodeAnalyzer::CheckingVisitor::Plain.new(checkers: @lexicals)
+        @prepare_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @prepares)
+        @review_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @reviews)
       end
 
       # lexical analysis the file.
       #
-      # @param [String] filename name of the file
-      # @param [String] content content of the file
+      # @param [String] filename of the file
+      # @param [String] content of the file
       def lexical(filename, content)
-        puts filename if @debug
-        @checker.lexical(filename, content)
+        @lexical_checker.check(filename, content)
       end
 
-      # lexical analysis the file.
-      #
-      # @param [String] filename
-      def lexical_file(filename)
-        lexical(filename, read_file(filename))
+      def after_lexical
+        @lexical_checker.after_check
       end
 
-      # parepare a file's content with filename.
+      # parepare the file.
       #
-      # @param [String] filename name of the file
-      # @param [String] content content of the file
+      # @param [String] filename of the file
+      # @param [String] content of the file
       def prepare(filename, content)
-        puts filename if @debug
-        node = parse_ruby(filename, content)
-        if node
-          node.file = filename
-          node.prepare(@checker)
-        end
+        @prepare_checker.check(filename, content)
       end
 
-      # parapare the file.
-      #
-      # @param [String] filename
-      def prepare_file(filename)
-        prepare(filename, read_file(filename))
+      def after_prepare
+        @prepare_checker.after_check
       end
 
-      # review a file's content with filename.
+      # review the file.
       #
-      # @param [String] filename name of the file
-      # @param [String] content content of the file
+      # @param [String] filename of the file
+      # @param [String] content of the file
       def review(filename, content)
-        puts filename if @debug
         content = parse_html_template(filename, content)
-        node = parse_ruby(filename, content)
-        if node
-          node.file = filename
-          node.review(@checker)
-        end
+        @review_checker.check(filename, content)
       end
 
-      # review the file.
-      #
-      # @param [String] filename
-      def review_file(filename)
-        review(filename, read_file(filename))
+      def after_review
+        @review_checker.after_check
       end
 
       # get all errors from lexicals and reviews.
@@ -119,45 +97,7 @@ module RailsBestPractices
         @errors ||= (@reviews + @lexicals).collect {|check| check.errors}.flatten
       end
 
-      def after_lexical; end
-
-      # provide a handler after all files reviewed.
-      def after_prepare
-        filename = "rails_best_practices.after_prepare"
-        content = "class RailsBestPractices::AfterPrepare; end"
-        node = parse_ruby(filename, content)
-        node.file = filename
-        node.prepare(@checker)
-      end
-
-      # provide a handler after all files reviewed.
-      def after_review
-        filename = "rails_best_practices.after_review"
-        content = "class RailsBestPractices::AfterReview; end"
-        node = parse_ruby(filename, content)
-        node.file = filename
-        node.review(@checker)
-      end
-
       private
-        # parse ruby code.
-        #
-        # @param [String] filename is the filename of ruby file.
-        # @param [String] content is the source code of ruby file.
-        def parse_ruby(filename, content)
-          begin
-            Sexp.from_array(Ripper::SexpBuilder.new(content).parse)
-          rescue Exception => e
-            if @debug
-              warning = "#{filename} looks like it's not a valid Ruby file.  Skipping..."
-              warning = warning.red if self.color
-              puts warning
-            end
-            raise e if @whiny
-            nil
-          end
-        end
-
         # parse html tempalte code, erb, haml and slim.
         #
         # @param [String] filename is the filename of the erb, haml or slim code.

data/lib/rails_best_practices/lexicals/long_line_check.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
-require 'rails_best_practices/reviews/review'
+require 'rails_best_practices/core/check'
+
 module RailsBestPractices
   module Lexicals
     # Keep lines fewer than 80 characters.

data/lib/rails_best_practices/lexicals/remove_tab_check.rb

@@ -7,9 +7,7 @@ module RailsBestPractices
     #
     # See the best practice details here http://rails-bestpractices.com/posts/81-remove-tab
     class RemoveTabCheck < Core::Check
-      def url
-        "http://rails-bestpractices.com/posts/81-remove-tab"
-      end
+      url "http://rails-bestpractices.com/posts/81-remove-tab"
 
       # check if the content of file contains a tab.
       #

data/lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb

@@ -7,9 +7,7 @@ module RailsBestPractices
     #
     # 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
+      url "http://rails-bestpractices.com/posts/60-remove-trailing-whitespace"
 
       # check if the content of file contain a trailing whitespace.
       #

data/lib/rails_best_practices/prepares/config_prepare.rb

@@ -11,7 +11,7 @@ module RailsBestPractices
         @configs = Prepares.configs
       end
 
-      def start_assign(node)
+      add_callback :start_assign do |node|
         if node.left_value.grep_node(sexp_type: [:vcall, :var_ref], to_s: "config").present?
           @configs[node.left_value.to_s] = node.right_value.to_s
         end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -8,7 +8,6 @@ module RailsBestPractices
       include Core::Check::Classable
       include Core::Check::InheritedResourcesable
       include Core::Check::Accessable
-      include Core::Check::Afterable
 
       interesting_nodes :class, :var_ref, :vcall, :command, :def
       interesting_files CONTROLLER_FILES
@@ -24,7 +23,7 @@ module RailsBestPractices
 
       # check class node to remember the class name.
       # also check if the controller is inherit from InheritedResources::Base.
-      def start_class(node)
+      add_callback :start_class do |node|
         @controllers << @klass
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
@@ -32,7 +31,7 @@ module RailsBestPractices
       end
 
       # remember the action names at the end of class node if the controller is a InheritedResources.
-      def end_class(node)
+      add_callback :end_class do |node|
         if @inherited_resources && "ApplicationController" != current_class_name
           @actions.each do |action|
             @methods.add_method(current_class_name, action, {"file" => node.file, "line" => node.line})
@@ -41,21 +40,21 @@ module RailsBestPractices
       end
 
       # check if there is a DSL call inherit_resources.
-      def start_var_ref(node)
+      add_callback :start_var_ref do |node|
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
       end
 
       # check if there is a DSL call inherit_resources.
-      def start_vcall(node)
+      add_callback :start_vcall do |node|
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
       end
 
       # restrict actions for inherited_resources
-      def start_command(node)
+      add_callback :start_command do |node|
         if "include" == node.message.to_s
           @helpers.add_module_decendant(node.arguments.all.first.to_s, current_class_name)
         elsif @inherited_resources && "actions" ==  node.message.to_s
@@ -83,13 +82,13 @@ module RailsBestPractices
       #         "create" => {"file" => "app/controllers/comments_controller.rb", "line" => 10, "unused" => false},
       #       }
       #     }
-      def start_def(node)
+      add_callback :start_def do |node|
         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
 
       # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.
-      def after_prepare
+      add_callback :after_check do
         decendants = @helpers.map(&:decendants).flatten
         if decendants.present?
           Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *decendants.map { |decendant| %r|#{decendant.underscore}| }

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
       end
 
       # check module node to remember the module name.
-      def start_module(node)
+      add_callback :start_module do |node|
         @helpers << Core::Mod.new(current_module_name, [])
       end
 
@@ -30,7 +30,7 @@ module RailsBestPractices
       #         "update_time" => {"file" => "app/helpers/posts_helper.rb", "line" => 10, "unused" => false}
       #       }
       #     }
-      def start_def(node)
+      add_callback :start_def do |node|
         if node.file =~ HELPER_FILES
           method_name = node.method_name.to_s
           @methods.add_method(current_module_name, method_name, {"file" => node.file, "line" => node.line}, current_access_control)

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
       #
       # if it is a subclass of ActionMailer::Base,
       # then remember its class name.
-      def start_class(node)
+      add_callback :start_class do |node|
         if "ActionMailer::Base" == current_extend_class_name
           @mailers << @klass
         end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -7,7 +7,6 @@ module RailsBestPractices
     class ModelPrepare < Core::Check
       include Core::Check::Classable
       include Core::Check::Accessable
-      include Core::Check::Afterable
 
       interesting_nodes :class, :def, :defs, :command, :alias
       interesting_files MODEL_FILES
@@ -22,7 +21,7 @@ module RailsBestPractices
       end
 
       # remember the class name.
-      def start_class(node)
+      add_callback :start_class do |node|
         if "ActionMailer::Base" != current_extend_class_name
           @models << @klass
         end
@@ -40,7 +39,7 @@ module RailsBestPractices
       #         "create" => {"file" => "app/models/comment.rb", "line" => 10, "unused" => false, "unused" => false},
       #       }
       #     }
-      def start_def(node)
+      add_callback :start_def do |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)
@@ -59,7 +58,7 @@ module RailsBestPractices
       #         "create" => {"file" => "app/models/comment.rb", "line" => 10, "unused" => false, "unused" => false},
       #       }
       #     }
-      def start_defs(node)
+      add_callback :start_defs do |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)
@@ -77,7 +76,7 @@ module RailsBestPractices
       #         "milestones => {"has_many" => "Milestone"}
       #       }
       #     }
-      def start_command(node)
+      add_callback :start_command do |node|
         case node.message.to_s
         when *%w(named_scope scope alias_method)
           method_name = node.arguments.all.first.to_s
@@ -101,13 +100,13 @@ module RailsBestPractices
       end
 
       # check alias node to remembr the alias methods.
-      def start_alias(node)
+      add_callback :start_alias do |node|
         method_name = node.new_method.to_s
         @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
+      add_callback :after_check do
         @model_associations.each do |model, model_associations|
           model_associations.each do |association_name, association_meta|
             unless @models.include?(association_meta["class_name"])

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
       end
 
       # remember route for rails3.
-      def start_command(node)
+      add_callback :start_command do |node|
         case node.message.to_s
         when "resources"
           add_resources_routes(node)
@@ -42,13 +42,14 @@ module RailsBestPractices
             if :bare_assoc_hash == first_argument.sexp_type
               route_node = first_argument.hash_values.first
               # do not parse redirect block
-              return if :method_add_arg == route_node.sexp_type
-              controller_name, action_name = route_node.to_s.split('#')
+              if :method_add_arg != route_node.sexp_type
+                controller_name, action_name = route_node.to_s.split('#')
+                @routes.add_route(current_namespaces, controller_name.underscore, action_name)
+              end
             elsif :array == first_argument.sexp_type
               first_argument.array_values.map(&:to_s).each do |action_node|
                 @routes.add_route(current_namespaces, controller_name, action_node.to_s)
               end
-              return
             elsif :bare_assoc_hash == second_argument.try(:sexp_type)
               if second_argument.hash_value("to").present?
                 controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
@@ -56,10 +57,11 @@ module RailsBestPractices
                 controller_name = current_controller_name
                 action_name = second_argument.hash_value("action")
               end
+              @routes.add_route(current_namespaces, controller_name.try(:underscore), action_name)
             else
               controller_name, action_name = first_argument.to_s.split('/')
+              @routes.add_route(current_namespaces, controller_name.underscore, action_name)
             end
-            @routes.add_route(current_namespaces, controller_name.try(:underscore), action_name)
           end
         when "match", "root"
           options = node.arguments.all.last
@@ -90,7 +92,7 @@ module RailsBestPractices
       end
 
       # remember route for rails2.
-      def start_command_call(node)
+      add_callback :start_command_call do |node|
         case node.message.to_s
         when "resources"
           add_resources_routes(node)
@@ -109,7 +111,7 @@ module RailsBestPractices
       end
 
       # remember the namespace.
-      def start_method_add_block(node)
+      add_callback :start_method_add_block do |node|
         case node.message.to_s
         when "namespace"
           @namespaces << node.arguments.all.first.to_s
@@ -134,7 +136,7 @@ module RailsBestPractices
       end
 
       # end of namespace call.
-      def end_method_add_block(node)
+      add_callback :end_method_add_block do |node|
         case node.message.to_s
         when "namespace"
           @namespaces.pop
@@ -148,18 +150,15 @@ module RailsBestPractices
       end
 
       # remember current controller name, used for nested resources.
-      def start_do_block(node)
+      add_callback :start_do_block, :start_brace_block do |node|
         @controller_names << @controller_name.try(:last)
       end
 
       # remove current controller name, and use upper lever resource name.
-      def end_do_block(node)
+      add_callback :end_do_block, :end_brace_block do |node|
         @controller_names.pop
       end
 
-      alias_method :start_brace_block, :start_do_block
-      alias_method :end_brace_block, :end_do_block
-
       [:resources, :resource].each do |route_name|
         class_eval <<-EOF
         def add_#{route_name}_routes(node)