rails_best_practices 1.3.0 → 1.4.0

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -16,16 +16,15 @@ module RailsBestPractices
     #   and outer the call node, it is also a call node,
     #   then it violate the law of demeter.
     class LawOfDemeterReview < Review
+      interesting_nodes :call
+      interesting_files ALL_FILES
+
       ASSOCIATION_METHODS = %w(belongs_to has_one)
 
       def url
         "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
       end
 
-      def interesting_nodes
-        [:call]
-      end
-
       # check the call node,
       #
       # if the subject of the call node is also a call node,

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -12,6 +12,8 @@ module RailsBestPractices
     # Review process:
     #   only check all view files to see if there are finders, then the finders should be moved to controller.
     class MoveCodeIntoControllerReview < Review
+      interesting_nodes :method_add_arg, :assign
+      interesting_files VIEW_FILES
 
       FINDERS = %w(find all first last)
 
@@ -19,14 +21,6 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/24-move-code-into-controller"
       end
 
-      def interesting_nodes
-        [:method_add_arg, :assign]
-      end
-
-      def interesting_files
-        VIEW_FILES
-      end
-
       # check method_add_arg nodes.
       #
       # if the subject of the method_add_arg node is a constant,

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

@@ -19,18 +19,13 @@ module RailsBestPractices
     #   and the size of the array is greater than array_count defined,
     #   then the options_for_select method should be moved into helper.
     class MoveCodeIntoHelperReview < Review
+      interesting_nodes :method_add_arg
+      interesting_files VIEW_FILES
+
       def url
         "http://rails-bestpractices.com/posts/26-move-code-into-helper"
       end
 
-      def interesting_nodes
-        [:method_add_arg]
-      end
-
-      def interesting_files
-        VIEW_FILES
-      end
-
       def initialize(options = {})
         super()
         @array_count = options['array_count'] || 3

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -13,18 +13,13 @@ module RailsBestPractices
     #   check if, unless, elsif there are multiple method calls or attribute assignments apply to one subject,
     #   and the subject is a variable, then they should be moved into model.
     class MoveCodeIntoModelReview < Review
+      interesting_nodes :if, :unless, :elsif
+      interesting_files VIEW_FILES
+
       def url
         "http://rails-bestpractices.com/posts/25-move-code-into-model"
       end
 
-      def interesting_nodes
-        [:if, :unless, :elsif]
-      end
-
-      def interesting_files
-        VIEW_FILES
-      end
-
       def initialize(options={})
         super()
         @use_count = options['use_count'] || 2

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -15,6 +15,8 @@ module RailsBestPractices
     #   and it has a hash argument,
     #   then it is a complex finder, and should be moved to model's named scope.
     class MoveFinderToNamedScopeReview < Review
+      interesting_nodes :method_add_arg
+      interesting_files CONTROLLER_FILES
 
       FINDERS = %w(find all first last)
 
@@ -22,14 +24,6 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
       end
 
-      def interesting_nodes
-        [:method_add_arg]
-      end
-
-      def interesting_files
-        CONTROLLER_FILES
-      end
-
       # check method_add_ag node if its message is one of find, all, first or last,
       # and it has a hash argument,
       # then the call node is the finder that should be moved to model's named_scope.

data/lib/rails_best_practices/reviews/move_model_logic_into_model_review.rb

@@ -15,18 +15,13 @@ module RailsBestPractices
     #   and the subject is a variable,
     #   then they are complex model logic, and they should be moved into model.
     class MoveModelLogicIntoModelReview < Review
+      interesting_nodes :def
+      interesting_files CONTROLLER_FILES
+
       def url
         "http://rails-bestpractices.com/posts/7-move-model-logic-into-the-model"
       end
 
-      def interesting_nodes
-        [:def]
-      end
-
-      def interesting_files
-        CONTROLLER_FILES
-      end
-
       def initialize(options = {})
         super()
         @use_count = options['use_count'] || 4

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -24,18 +24,13 @@ module RailsBestPractices
     #   and the @counter is greater than @nested_count defined,
     #   then it is a needless deep nesting.
     class NeedlessDeepNestingReview < Review
+      interesting_nodes :method_add_block
+      interesting_files ROUTE_FILES
+
       def url
         "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
       end
 
-      def interesting_nodes
-        [:method_add_block]
-      end
-
-      def interesting_files
-        ROUTE_FILES
-      end
-
       def initialize(options = {})
         super()
         @counter = 0

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -19,18 +19,13 @@ module RailsBestPractices
     #
     #     match ':controller(/:action(/:id(.:format)))'
     class NotUseDefaultRouteReview < Review
+      interesting_nodes :command_call, :command
+      interesting_files ROUTE_FILES
+
       def url
         "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
       end
 
-      def interesting_nodes
-        [:command_call, :command]
-      end
-
-      def interesting_files
-        ROUTE_FILES
-      end
-
       # check all command call nodes, compare with rails2 default route
       def start_command_call(node)
         if "map" == node.subject.to_s && "connect" == node.message.to_s &&

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -28,6 +28,8 @@ module RailsBestPractices
     #   whose message is get, post, update or delete,
     #   then these custom routes are overuse.
     class OveruseRouteCustomizationsReview < Review
+      interesting_nodes :command_call, :method_add_block
+      interesting_files ROUTE_FILES
 
       VERBS = %w(get post update delete)
 
@@ -35,14 +37,6 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/10-overuse-route-customizations"
       end
 
-      def interesting_nodes
-        [:command_call, :method_add_block]
-      end
-
-      def interesting_files
-        ROUTE_FILES
-      end
-
       def initialize(options = {})
         super()
         @customize_count = options['customize_count'] || 3
@@ -84,7 +78,7 @@ module RailsBestPractices
         # it is just the count of member and collection custom routes.
         def member_and_collection_count_for_rails2(node)
           if "resources" == node.message.to_s
-            hash_node = node.arguments.all[1]
+            hash_node = node.arguments.all.last
             if hash_node && :bare_assoc_hash == hash_node.sexp_type
               member_node = hash_node.hash_value("member")
               collection_node = hash_node.hash_value("collection")

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -12,18 +12,13 @@ module RailsBestPractices
     # Review process:
     #   check all helper files, if the body of module is nil, then the helper file should be removed.
     class RemoveEmptyHelpersReview < Review
+      interesting_nodes :module
+      interesting_files HELPER_FILES
+
       def url
         "http://rails-bestpractices.com/posts/72-remove-empty-helpers"
       end
 
-      def interesting_files
-        HELPER_FILES
-      end
-
-      def interesting_nodes
-        [:module]
-      end
-
       # check the body of module node, if it is nil, then it should be removed.
       def start_module(node)
         if s(:bodystmt, s(:stmts_add, s(:stmts_new), s(:void_stmt)), nil, nil, nil) == node.body

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/review'
+
+module RailsBestPractices
+  module Reviews
+    class RemoveUnusedMethodsInControllersReview < Review
+      include Klassable
+      include Completeable
+      include Callable
+      include InheritedResourcesable
+
+      interesting_nodes :class
+      interesting_files CONTROLLER_FILES
+
+      EXCEPT_METHODS = %w(rescue_action)
+      INHERITED_RESOURCES_METHODS = %w(resource collection begin_of_association_chain build_resource)
+
+      def initialize(options={})
+        @controller_methods = Prepares.controller_methods
+        @routes = Prepares.routes
+        @inherited_resources = false
+        @except_methods = EXCEPT_METHODS + options['except_methods']
+      end
+
+      # mark custom inherited_resources methods as used.
+      def end_class(node)
+        if @inherited_resources
+          INHERITED_RESOURCES_METHODS.each do |method|
+            call_method(method)
+          end
+        end
+      end
+
+      # get all unused methods at the end of review process.
+      def on_complete
+        @routes.each do |route|
+          if "*" == route.action_name
+            action_names = @controller_methods.get_methods(route.controller_name_with_namespaces).map(&:method_name)
+            action_names.each { |action_name| call_method(action_name, route.controller_name_with_namespaces) }
+          else
+            call_method(route.action_name, route.controller_name_with_namespaces)
+          end
+        end
+        @controller_methods.get_all_unused_methods.each do |method|
+          if !@except_methods.include?(method.method_name)
+            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line
+          end
+        end
+      end
+
+      protected
+        def methods
+          @controller_methods
+        end
+    end
+  end
+end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -14,12 +14,11 @@ module RailsBestPractices
     class RemoveUnusedMethodsInModelsReview < Review
       include Klassable
       include Completeable
+      include Callable
 
-      EXCEPT_METHODS = %w(initialize validate to_xml to_json assign_attributes after_find after_initialize)
+      interesting_files ALL_FILES
 
-      def interesting_nodes
-        [:module, :class, :call, :fcall, :command, :command_call, :method_add_arg, :var_ref, :alias, :bare_assoc_hash]
-      end
+      EXCEPT_METHODS = %w(initialize validate to_xml to_json assign_attributes after_find after_initialize)
 
       def initialize(options={})
         super()
@@ -27,75 +26,6 @@ module RailsBestPractices
         @except_methods = EXCEPT_METHODS + options['except_methods']
       end
 
-      # remember the message of call node.
-      def start_call(node)
-        mark_used(node.message)
-      end
-
-      # remember the message of fcall node.
-      def start_fcall(node)
-        mark_used(node.message)
-      end
-
-      # remember name of var_ref node.
-      def start_var_ref(node)
-        mark_used(node)
-      end
-
-      # remember the message of command call node.
-      def start_command_call(node)
-        mark_used(node.message)
-      end
-
-      # remember the message of command node.
-      # remember the argument of alias_method and alias_method_chain as well.
-      def start_command(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
-
-      # remember the old method of alias node.
-      def start_alias(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
-      def start_bare_assoc_hash(node)
-        if node.hash_keys.include? "methods"
-          mark_used(node.hash_value("methods"))
-        end
-      end
-
-      # remember the first argument for try and send method.
-      def start_method_add_arg(node)
-        case node.message.to_s
-        when "try"
-          method_name = node.arguments.all[0].to_s
-          call_method(method_name)
-        when "send"
-          if [:symbol_literal, :string_literal].include?(node.arguments.all[0].sexp_type)
-            method_name = node.arguments.all[0].to_s
-            call_method(method_name)
-          end
-        else
-          # nothing
-        end
-      end
-
       # get all unused methods at the end of review process.
       def on_complete
         @model_methods.get_all_unused_methods.each do |method|
@@ -105,25 +35,9 @@ module RailsBestPractices
         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)
-          if @model_methods.has_method?(current_class_name, method_name)
-            @model_methods.get_method(current_class_name, method_name).mark_used
-          end
-          @model_methods.mark_parent_class_method_used(current_class_name, method_name)
-          @model_methods.mark_subclasses_method_used(current_class_name, method_name)
-          @model_methods.possible_public_used(method_name)
+      protected
+        def methods
+          @model_methods
         end
     end
   end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -16,18 +16,13 @@ module RailsBestPractices
     #   and after them there is a call node with message "save" or "save!",
     #   then these attribute assignments are complex creation, should be replaced with factory method.
     class ReplaceComplexCreationWithFactoryMethodReview < Review
+      interesting_nodes :def
+      interesting_files CONTROLLER_FILES
+
       def url
         "http://rails-bestpractices.com/posts/6-replace-complex-creation-with-factory-method"
       end
 
-      def interesting_nodes
-        [:def]
-      end
-
-      def interesting_files
-        CONTROLLER_FILES
-      end
-
       def initialize(options = {})
         super()
         @assigns_count = options['attribute_assignment_count'] || 2

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -13,18 +13,13 @@ module RailsBestPractices
     #   check all instance variable in partial view files,
     #   if exist, then they should be replaced with local variable
     class ReplaceInstanceVariableWithLocalVariableReview < Review
+      interesting_nodes :var_ref
+      interesting_files PARTIAL_VIEW_FILES
+
       def url
         "http://rails-bestpractices.com/posts/27-replace-instance-variable-with-local-variable"
       end
 
-      def interesting_nodes
-        [:var_ref]
-      end
-
-      def interesting_files
-        PARTIAL_VIEW_FILES
-      end
-
       # check ivar node in partial view file,
       # it is an instance variable, and should be replaced with local variable.
       def start_var_ref(node)