rails_best_practices 1.3.0 → 1.4.0

data/lib/rails_best_practices/core_ext/sexp.rb

@@ -782,10 +782,21 @@ class Sexp
     end
   end
 
+  # check if the self node is a const.
   def const?
     :@const == self.sexp_type || (:var_ref == self.sexp_type && :@const == self[1].sexp_type)
   end
 
+  # true
+  def present?
+    true
+  end
+
+  # false
+  def blank?
+    false
+  end
+
   # remove the line and column info from sexp.
   def remove_line_and_column
     node = self.clone

data/lib/rails_best_practices/prepares.rb

@@ -3,12 +3,11 @@ require 'rails_best_practices/prepares/model_prepare'
 require 'rails_best_practices/prepares/mailer_prepare'
 require 'rails_best_practices/prepares/schema_prepare'
 require 'rails_best_practices/prepares/controller_prepare'
+require 'rails_best_practices/prepares/route_prepare'
 
 module RailsBestPractices
   module Prepares
     class <<self
-      attr_writer :models, :model_associations, :model_attributes, :mailers
-
       def klasses
         models + mailers + controllers
       end
@@ -41,6 +40,10 @@ module RailsBestPractices
         @controller_methods ||= Core::Methods.new
       end
 
+      def routes
+        @routes ||= Core::Routes.new
+      end
+
       # Clear all prepare objects.
       def clear
         instance_variables.each do |instance_variable|

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -6,17 +6,13 @@ module RailsBestPractices
     # Remember controllers and controller methods
     class ControllerPrepare < Core::Check
       include Core::Check::Klassable
+      include Core::Check::InheritedResourcesable
       include Core::Check::Accessable
 
-      DEFAULT_ACTIONS = %w(index show new create edit update destroy)
-
-      def interesting_nodes
-        [:module, :class, :def, :command, :var_ref]
-      end
+      interesting_nodes :class, :var_ref, :command, :def
+      interesting_files CONTROLLER_FILES
 
-      def interesting_files
-        CONTROLLER_FILES
-      end
+      DEFAULT_ACTIONS = %w(index show new create edit update destroy)
 
       def initialize
         @controllers = Prepares.controllers
@@ -28,25 +24,23 @@ module RailsBestPractices
       # also check if the controller is inherit from InheritedResources::Base.
       def start_class(node)
         @controllers << @klass
-        if "InheritedResources::Base" == current_extend_class_name
-          @inherited_resources = true
+        if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
       end
 
       # remember the action names at the end of class node if the controller is a InheritedResources.
       def end_class(node)
-        if @inherited_resources
+        if @inherited_resources && "ApplicationController" != current_class_name
           @actions.each do |action|
-            @methods.add_method(current_class_name, action)
+            @methods.add_method(current_class_name, action, {"file" => node.file, "line" => node.line})
           end
         end
       end
 
       # check if there is a DSL call inherit_resources.
       def start_var_ref(node)
-        if "inherit_resources" == node.to_s
-          @inherited_resources = true
+        if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
       end

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -7,13 +7,8 @@ module RailsBestPractices
     class MailerPrepare < Core::Check
       include Core::Check::Klassable
 
-      def interesting_nodes
-        [:class, :module]
-      end
-
-      def interesting_files
-        /#{MAILER_FILES}|#{MODEL_FILES}/
-      end
+      interesting_nodes :class
+      interesting_files MAILER_FILES, MODEL_FILES
 
       def initialize
         @mailers = Prepares.mailers

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -8,15 +8,10 @@ module RailsBestPractices
       include Core::Check::Klassable
       include Core::Check::Accessable
 
-      ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many)
-
-      def interesting_nodes
-        [:module, :class, :def, :command, :var_ref, :alias]
-      end
+      interesting_nodes :class, :def, :command, :var_ref, :alias
+      interesting_files MODEL_FILES
 
-      def interesting_files
-        MODEL_FILES
-      end
+      ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many)
 
       def initialize
         @models = Prepares.models

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+require 'rails_best_practices/core/check'
+
+module RailsBestPractices
+  module Prepares
+    # Remembber routes.
+    class RoutePrepare < Core::Check
+      interesting_nodes :command, :command_call, :method_add_block
+      interesting_files ROUTE_FILES
+
+      RESOURCES_ACTIONS = %w(index show new create edit update destroy)
+      RESOURCE_ACTIONS = %w(show new create edit update destroy)
+
+      def initialize
+        @routes = Prepares.routes
+        @namespaces = []
+      end
+
+      # remember route for rails3.
+      def start_command(node)
+        case node.message.to_s
+        when "resources"
+          add_resources_routes(node)
+        when "resource"
+          add_resource_routes(node)
+        when "get", "post", "put", "delete"
+          action_name = node.arguments.all.first.to_s
+          @routes.add_route(current_namespaces, current_resource_name, action_name)
+        when "match", "root"
+          options = node.arguments.all.last
+          if options.hash_value("controller").present?
+            controller_name = options.hash_value("controller").to_s
+            action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
+            @routes.add_route(current_namespaces, controller_name, action_name)
+          else
+            route_node = options.hash_values.find { |value_node| :string_literal == value_node.sexp_type && value_node.to_s.include?('#') }
+            if route_node.present?
+              controller_name, action_name = route_node.to_s.split('#')
+              @routes.add_route(current_namespaces, controller_name.underscore, action_name)
+            end
+          end
+        else
+          # nothing to do
+        end
+      end
+
+      # remember route for rails2.
+      def start_command_call(node)
+        case node.message.to_s
+        when "resources"
+          add_resources_routes(node)
+        when "resource"
+          add_resource_routes(node)
+        when "namespace"
+          # nothing to do
+        else
+          options = node.arguments.all.last
+          controller_name = options.hash_value("controller").to_s
+          action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
+          @routes.add_route(current_namespaces, controller_name, action_name)
+        end
+      end
+
+      # remember the namespace.
+      def start_method_add_block(node)
+        if "namespace" == node.message.to_s
+          @namespaces << node.arguments.all.first.to_s
+        end
+      end
+
+      # end of namespace call.
+      def end_method_add_block(node)
+        if "namespace" == node.message.to_s
+          @namespaces.pop
+        end
+      end
+
+      [:resources, :resource].each do |route_name|
+        class_eval <<-EOF
+        def add_#{route_name}_routes(node)
+          resource_names = node.arguments.all.select { |argument| :symbol_literal == argument.sexp_type }
+          resource_names.each do |resource_name|
+            @resource_name = node.arguments.all.first.to_s
+            options = node.arguments.all.last
+            if options.hash_value("controller").present?
+              @resource_name = options.hash_value("controller").to_s
+            end
+            action_names = if options.hash_value("only").present?
+                             get_#{route_name}_actions(options.hash_value("only").to_object)
+                           elsif options.hash_value("except").present?
+                             self.class.const_get(:#{route_name.upcase}_ACTIONS) - get_#{route_name}_actions(options.hash_value("except").to_object)
+                           else
+                             self.class.const_get(:#{route_name.upcase}_ACTIONS)
+                           end
+            Array(action_names).each do |action_name|
+              @routes.add_route(current_namespaces, current_resource_name, action_name)
+            end
+
+            member_routes = options.hash_value("member")
+            if member_routes.present?
+              action_names = :array == member_routes.sexp_type ? member_routes.to_object : member_routes.hash_keys
+              action_names.each do |action_name|
+                @routes.add_route(current_namespaces, current_resource_name, action_name)
+              end
+            end
+
+            collection_routes = options.hash_value("collection")
+            if collection_routes.present?
+              action_names = :array == collection_routes.sexp_type ? collection_routes.to_object : collection_routes.hash_keys
+              action_names.each do |action_name|
+                @routes.add_route(current_namespaces, current_resource_name, action_name)
+              end
+            end
+          end
+        end
+
+        def get_#{route_name}_actions(action_names)
+          case action_names
+          when "all"
+            self.class.const_get(:#{route_name.upcase}_ACTIONS)
+          when "none"
+            []
+          else
+            action_names
+          end
+        end
+
+        def add_customize_routes
+        end
+        EOF
+      end
+
+      def current_namespaces
+        @namespaces.dup
+      end
+
+      def current_resource_name
+        @resource_name
+      end
+    end
+  end
+end

data/lib/rails_best_practices/prepares/schema_prepare.rb

@@ -5,17 +5,12 @@ module RailsBestPractices
   module Prepares
     # Remember the model attributes.
     class SchemaPrepare < Core::Check
+      interesting_nodes :command, :command_call
+      interesting_files SCHEMA_FILE
+
       # all attribute types
       ATTRIBUTE_TYPES = %w(integer float boolean string text date time datetime binary)
 
-      def interesting_nodes
-        [:command, :command_call]
-      end
-
-      def interesting_files
-        SCHEMA_FILE
-      end
-
       def initialize
         @model_attributes = Prepares.model_attributes
       end

data/lib/rails_best_practices/reviews.rb

@@ -27,3 +27,4 @@ require 'rails_best_practices/reviews/simplify_render_in_controllers_review'
 require 'rails_best_practices/reviews/remove_empty_helpers_review'
 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'

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -16,18 +16,13 @@ module RailsBestPractices
     #   and after these method calls, there is a save method call for that model,
     #   then the model needs to add a virtual attribute.
     class AddModelVirtualAttributeReview < Review
+      interesting_nodes :def
+      interesting_files CONTROLLER_FILES
+
       def url
         "http://rails-bestpractices.com/posts/4-add-model-virtual-attribute"
       end
 
-      def interesting_nodes
-        [:def]
-      end
-
-      def interesting_files
-        CONTROLLER_FILES
-      end
-
       # check method define nodes to see if there are some attribute assignments that can use model virtual attribute instead in review process.
       #
       # it will check every attribute assignment nodes and call node of message :save or :save!, if

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -10,12 +10,12 @@ module RailsBestPractices
     # Implementation:
     #
     # Review process:
-    #   only check the command and command_calls nodes and at the end of program node in db/schema file,
+    #   only check the command and command_calls nodes and at the end of review process,
     #   if the subject of command node is "create_table", then remember the table names
     #   if the subject of command_call node is "integer" and suffix with id, then remember it as foreign key
     #   if the sujbect of command_call node is "string", the name of it is _type suffixed and there is an integer column _id suffixed, then remember it as polymorphic foreign key
     #   if the subject of command node is "add_index", then remember the index columns
-    #   after all of these, at the end of program node
+    #   after all of these, at the end of review process
     #
     #       ActiveRecord::Schema.define(:version => 20101201111111) do
     #         ......
@@ -24,16 +24,13 @@ module RailsBestPractices
     #   if there are any foreign keys not existed in index columns,
     #   then the foreign keys should add db index.
     class AlwaysAddDbIndexReview < Review
-      def url
-        "http://rails-bestpractices.com/posts/21-always-add-db-index"
-      end
+      include Completeable
 
-      def interesting_nodes
-        [:command, :command_call, :program]
-      end
+      interesting_nodes :command, :command_call
+      interesting_files SCHEMA_FILE
 
-      def interesting_files
-        SCHEMA_FILE
+      def url
+        "http://rails-bestpractices.com/posts/21-always-add-db-index"
       end
 
       def initialize
@@ -71,12 +68,12 @@ module RailsBestPractices
         end
       end
 
-      # check at the end of program node.
+      # check at the end of review process.
       #
       # compare foreign keys and index columns,
       # if there are any foreign keys not existed in index columns,
       # then we should add db index for that foreign keys.
-      def end_program(node)
+      def on_complete
         remove_only_type_foreign_keys
         @foreign_keys.each do |table, foreign_key|
           table_node = @table_nodes[table]

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -15,18 +15,13 @@ module RailsBestPractices
     #   if the message of command node is "namespace" and the first argument  is "bundler",
     #   then it should use bundler's capistrano recipe.
     class DryBundlerInCapistranoReview < Review
+      interesting_nodes :command
+      interesting_files DEPLOY_FILES
+
       def url
         "http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano"
       end
 
-      def interesting_nodes
-        [:command]
-      end
-
-      def interesting_files
-        /config\/deploy.rb/
-      end
-
       # check call node to see if it is with message "namespace" and argument "bundler".
       def start_command(node)
         if "namespace" == node.message.to_s && "bundler" == node.arguments.all[0].to_s

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -21,18 +21,13 @@ module RailsBestPractices
     #   and the subject is included in new variables,
     #   then it should be isolated to db seed.
     class IsolateSeedDataReview < Review
+      interesting_nodes :call, :assign
+      interesting_files MIGRATION_FILES
+
       def url
         "http://rails-bestpractices.com/posts/20-isolating-seed-data"
       end
 
-      def interesting_nodes
-        [:call, :assign]
-      end
-
-      def interesting_files
-        MIGRATION_FILES
-      end
-
       def initialize
         super
         @new_variables = []

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -17,6 +17,8 @@ module RailsBestPractices
     #   and there is a hash argument for finder,
     #   then it should keep finders on its own model.
     class KeepFindersOnTheirOwnModelReview < Review
+      interesting_nodes :method_add_arg
+      interesting_files MODEL_FILES
 
       FINDERS = %w(find all first last)
 
@@ -24,14 +26,6 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
       end
 
-      def interesting_nodes
-        [:method_add_arg]
-      end
-
-      def interesting_files
-        MODEL_FILES
-      end
-
       # check all the call nodes to see if there is a finder for other model.
       #
       # if the call node is