rails_best_practices 1.3.0 → 1.4.0

data/Gemfile.lock

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

data/README.md

@@ -135,6 +135,7 @@ Now you can customize this configuration file, the default configuration is as f
     RemoveTabCheck: {}
     RestrictAutoGeneratedRoutesCheck: { }
     RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+    RemoveUnusedMethodsInControllersCheck: { except_methods: [] }
 
 You can remove or comment one review to disable it, and you can change the options.
 
@@ -147,8 +148,8 @@ Move code from Controller to Model
 2. Use model association
 3. Use scope access
 4. Add model virtual attribute
-5. Replace Complex Creation with Factory Method
-6. Move Model Logic into the Model
+5. Replace complex creation with factory method
+6. Move model logic into the Model
 
 RESTful Conventions
 
@@ -159,11 +160,11 @@ RESTful Conventions
 
 Model
 
-1. Keep Finders on Their Own Model (rails2 only)
-2. the Law of Demeter
-3. Use Observer
-4. Use Query Attribute
-5. Remove Unused Methods In Models (Experiment, not available by default configuration)
+1. Keep finders on their own model (rails2 only)
+2. the law of demeter
+3. Use observer
+4. Use query attribute
+5. Remove unused methods in models
 
 Mailer
 
@@ -171,14 +172,15 @@ Mailer
 
 Migration
 
-1. Isolating Seed Data
-2. Always add DB index
-3. Use Say with Time in Migrations
+1. Isolating seed data
+2. Always add db`index
+3. Use say with time in migrations
 
 Controller
 
 1. Use before_filter
 2. Simplify render in controllers
+3. Remove unused methods In controllers
 
 Helper
 
@@ -198,8 +200,8 @@ Deployment
 
 Other
 
-1. Remove Trailing Whitespace
-2. Remove Tab
+1. Remove trailing whitespace
+2. Remove tab
 
 Write Your Own Check List
 -------------------------

data/lib/rails_best_practices.rb

@@ -77,11 +77,11 @@ module RailsBestPractices
       @runner.color = !options['without-color']
 
       if @runner.checks.find { |check| check.is_a? Reviews::AlwaysAddDbIndexReview } &&
-         !review_files.find { |file| file.index "db\/schema.rb" }
+         !parse_files.find { |file| file.index "db\/schema.rb" }
         plain_output("AlwaysAddDbIndexReview is disabled as there is no db/schema.rb file in your rails project.", 'blue')
       end
 
-      @bar = ProgressBar.new('Source Codes', lexical_files.size + prepare_files.size + review_files.size)
+      @bar = ProgressBar.new('Source Codes', parse_files.size * 3)
       ["lexical", "prepare", "review"].each { |process| send(:process, process) }
       @runner.on_complete
       @bar.finish
@@ -102,29 +102,17 @@ module RailsBestPractices
     #
     # @param [String] process the process name, lexical, prepare or review.
     def process(process)
-      files = send("#{process}_files")
-      files.each do |file|
+      parse_files.each do |file|
         @runner.send("#{process}_file", file)
         @bar.inc unless @options['debug']
       end
     end
 
-    # get all files for prepare process.
+    # get all files for parsing.
     #
-    # @return [Array] all files for prepare process
-    def prepare_files
-      @prepare_files ||= begin
-        ['app/models', 'app/mailers', 'db/schema.rb', 'app/controllers'].inject([]) { |files, name|
-          files += expand_dirs_to_files(File.join(@path, name))
-        }.compact
-      end
-    end
-
-    # get all files for review process.
-    #
-    # @return [Array] all files for review process
-    def review_files
-      @review_files ||= begin
+    # @return [Array] all files for parsing
+    def parse_files
+      @parse_files ||= begin
         files = expand_dirs_to_files(@path)
         files = file_sort(files)
 
@@ -142,8 +130,6 @@ 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.rb

@@ -11,6 +11,7 @@ require 'rails_best_practices/core/model_attributes'
 require 'rails_best_practices/core/mailers'
 require 'rails_best_practices/core/methods'
 require 'rails_best_practices/core/controllers'
+require 'rails_best_practices/core/routes'
 
 require 'rails_best_practices/core_ext/sexp'
 require 'rails_best_practices/core_ext/enumerable'

data/lib/rails_best_practices/core/check.rb

@@ -4,24 +4,34 @@ module RailsBestPractices
     # A Check class that takes charge of checking the sexp.
     class Check
 
+      ALL_FILES = /.*/
       CONTROLLER_FILES = /controllers\/.*\.rb$/
       MIGRATION_FILES = /db\/migrate\/.*\.rb$/
       MODEL_FILES = /models\/.*\.rb$/
       MAILER_FILES = /models\/.*mailer\.rb$|mailers\/.*mailer\.rb/
       VIEW_FILES = /views\/.*\.(erb|haml)$/
       PARTIAL_VIEW_FILES = /views\/.*\/_.*\.(erb|haml)$/
-      ROUTE_FILES = /config\/routes(.*)?\.rb/
+      ROUTE_FILES = /config\/routes.*\.rb/
       SCHEMA_FILE = /db\/schema\.rb/
-      HELPER_FILES = /helpers.*\.rb$/
+      HELPER_FILES = /helpers\/.*\.rb$/
+      DEPLOY_FILES = /config\/deploy.*\.rb/
 
-      # default interesting nodes.
+      # interesting nodes that the check will parse.
       def interesting_nodes
-        []
+        self.class.interesting_nodes
       end
 
-      # default interesting files.
+      # interesting files that the check will parse.
       def interesting_files
-        /.*/
+        self.class.interesting_files
+      end
+
+      # check if the check will need to parse the node file.
+      #
+      # @param [String] the file name of node.
+      # @return [Boolean] true if the check will need to parse the file.
+      def parse_file?(node_file)
+        interesting_files.any? { |pattern| node_file =~ pattern }
       end
 
       # delegate to start_### according to the sexp_type, like
@@ -92,6 +102,18 @@ module RailsBestPractices
       end
 
       class <<self
+        def interesting_nodes(*nodes)
+          @interesting_nodes ||= []
+          @interesting_nodes += nodes
+          @interesting_nodes.uniq
+        end
+
+        def interesting_files(*file_patterns)
+          @interesting_files ||= []
+          @interesting_files += file_patterns
+          @interesting_files.uniq
+        end
+
         # callbacks for start_xxx and end_xxx.
         def callbacks
           @callbacks ||= {}
@@ -111,6 +133,8 @@ module RailsBestPractices
       module Klassable
         def self.included(base)
           base.class_eval do
+            interesting_nodes :module, :class
+
             # remember module name
             add_callback "start_module" do |node|
               modules << node.module_name.to_s
@@ -153,6 +177,9 @@ module RailsBestPractices
       module Completeable
         def self.included(base)
           base.class_eval do
+            interesting_nodes :class
+            interesting_files /rails_best_practices\.complete/
+
             add_callback "end_class" do |node|
               if "RailsBestPractices::Complete" == node.class_name.to_s
                 on_complete
@@ -162,10 +189,133 @@ module RailsBestPractices
         end
       end
 
+      # Helper to add callbacks to mark the methods are used.
+      module Callable
+        def self.included(base)
+          base.class_eval do
+            interesting_nodes :call, :fcall, :var_ref, :command_call, :command, :alias, :bare_assoc_hash, :method_add_arg
+
+            # remembe the message of call node.
+            add_callback "start_call" do |node|
+              mark_used(node.message)
+            end
+
+            # remembe the message of fcall node.
+            add_callback "start_fcall" do |node|
+              mark_used(node.message)
+            end
+
+            # remembe name of var_ref node.
+            add_callback "start_var_ref" do |node|
+              mark_used(node)
+            end
+
+            # remember the message of command node.
+            # remember the argument of alias_method and alias_method_chain as well.
+            add_callback "start_command" do |node|
+              case node.message.to_s
+              when "named_scope", "scope"
+                # nothing
+              when "alias_method"
+                mark_used(node.arguments.all[1])
+              when "alias_method_chain"
+                method, feature = *node.arguments.all.map(&:to_s)
+                call_method("#{method}_with_#{feature}")
+              else
+                mark_used(node.message)
+                node.arguments.all.each { |argument| mark_used(argument) }
+              end
+            end
+
+            # remembe the message of command call node.
+            add_callback "start_command_call" do |node|
+              mark_used(node.message)
+            end
+
+            # remember the old method of alias node.
+            add_callback "start_alias" do |node|
+              mark_used(node.old_method)
+            end
+
+            # remember hash values for hash key "methods".
+            #
+            #     def to_xml(options = {})
+            #       super options.merge(:exclude => :visible, :methods => [:is_discussion_conversation])
+            #     end
+            add_callback "start_bare_assoc_hash" do |node|
+              if node.hash_keys.include? "methods"
+                mark_used(node.hash_value("methods"))
+              end
+            end
+
+            # remember the first argument for try and send method.
+            add_callback "start_method_add_arg" do |node|
+              case node.message.to_s
+              when "try"
+                mark_used(node.arguments.all.first)
+              when "send"
+                if [:symbol_literal, :string_literal].include?(node.arguments.all[0].sexp_type)
+                  mark_used(node.arguments.all.first)
+                end
+              else
+                # nothing
+              end
+            end
+
+            private
+              def mark_used(method_node)
+                if :bare_assoc_hash == method_node.sexp_type
+                  method_node.hash_values.each { |value_node| mark_used(value_node) }
+                elsif :array == method_node.sexp_type
+                  method_node.array_values.each { |value_node| mark_used(value_node) }
+                else
+                  method_name = method_node.to_s
+                end
+                call_method(method_name)
+              end
+
+              def call_method(method_name, class_name=current_class_name)
+                if methods.has_method?(class_name, method_name)
+                  methods.get_method(class_name, method_name).mark_used
+                end
+                methods.mark_parent_class_method_used(class_name, method_name)
+                methods.mark_subclasses_method_used(class_name, method_name)
+                methods.possible_public_used(method_name)
+              end
+          end
+        end
+      end
+
+      # Helper to indicate if the controller is inherited from InheritedResources.
+      module InheritedResourcesable
+        def self.included(base)
+          base.class_eval do
+            interesting_nodes :class, :var_ref
+            interesting_files CONTROLLER_FILES
+
+            # check if the controller is inherit from InheritedResources::Base.
+            add_callback "start_class" do |node|
+              if "InheritedResources::Base" == current_extend_class_name
+                @inherited_resources = true
+              end
+            end
+
+            # check if there is a DSL call inherit_resources.
+            add_callback "start_var_ref" do |node|
+              if "inherit_resources" == node.to_s
+                @inherited_resources = true
+              end
+            end
+          end
+        end
+      end
+
       # Helper to parse the access control.
       module Accessable
         def self.included(base)
           base.class_eval do
+            interesting_nodes :var_ref, :class, :module
+
             # remember the current access control for methods.
             add_callback "start_var_ref" do |node|
               if %w(public protected private).include? node.to_s

data/lib/rails_best_practices/core/checking_visitor.rb

@@ -53,7 +53,7 @@ module RailsBestPractices
             checks = @#{process}_checks[node.sexp_type]                #   checks = @review_checks[node.sexp_type]
             if checks                                                  #   if checks
               checks.each { |check|                                    #     checks.each { |check|
-                if node.file =~ check.interesting_files                #      if node.file =~ check.interesting_files
+                if check.parse_file?(node.file)                        #      if check.parse_file?(node.file)
                   check.node_start(node)                               #         check.node_start(node)
                 end                                                    #       end
               }                                                        #     }
@@ -64,7 +64,7 @@ module RailsBestPractices
             }                                                          #   }
             if checks                                                  #   if checks
               checks.each { |check|                                    #     checks.each { |check|
-                if node.file =~ check.interesting_files                #       if node.file =~ check.interesting_files
+                if check.parse_file?(node.file)                        #      if check.parse_file?(node.file)
                   check.node_end(node)                                 #         check.node_end(node)
                 end                                                    #       end
               }                                                        #     }

data/lib/rails_best_practices/core/methods.rb

@@ -16,6 +16,7 @@ module RailsBestPractices
       # @param [String] access control, public, protected or private
       def add_method(class_name, method_name, meta={}, access_control="public")
         return if class_name == ""
+        return if has_method?(class_name, method_name)
         methods(class_name) << Method.new(class_name, method_name, access_control, meta)
         if access_control == "public"
           @possible_methods[method_name] = false

data/lib/rails_best_practices/core/nil.rb

@@ -18,6 +18,16 @@ module RailsBestPractices
         self
       end
 
+      # false
+      def present?
+        false
+      end
+
+      # true
+      def blank?
+        true
+      end
+
       # return self.
       def method_missing(method_sym, *arguments, &block)
         self

data/lib/rails_best_practices/core/routes.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module RailsBestPractices
+  module Core
+    class Routes < Array
+      # add a route.
+      #
+      # @param [Array] namesapces
+      # @param [String] controller name
+      # @param [String] action name
+      def add_route(namespaces, controller_name, action_name)
+        self << Route.new(namespaces, controller_name, action_name)
+      end
+    end
+
+    class Route
+      attr_reader :namespaces, :controller_name, :action_name
+
+      def initialize(namespaces, controller_name, action_name)
+        @namespaces = namespaces
+        @controller_name = controller_name
+        @action_name = action_name
+      end
+
+      def controller_name_with_namespaces
+        namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + "#{controller_name.camelize}Controller"
+      end
+
+      def to_s
+        "#{controller_name_with_namespaces}\##{action_name}"
+      end
+    end
+  end
+end

data/lib/rails_best_practices/core/runner.rb

@@ -4,6 +4,8 @@ require 'ripper'
 require 'erubis'
 require 'yaml'
 require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
 
 module RailsBestPractices
   module Core
@@ -182,7 +184,7 @@ module RailsBestPractices
 
         # load all prepares.
         def load_prepares
-          [Prepares::ModelPrepare.new, Prepares::MailerPrepare.new, Prepares::SchemaPrepare.new, Prepares::ControllerPrepare.new]
+          Prepares.constants.map { |prepare| Prepares.const_get(prepare).new }
         end
 
         # load all reviews according to configuration.