rails_best_practices 0.6.6 → 0.6.7

data/lib/rails_best_practices/{checks/use_before_filter_check.rb → reviews/use_before_filter_review.rb}

@@ -1,21 +1,18 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller file to make sure to use before_filter to remove duplicated first code line in different action.
+  module Reviews
+    # Review a controller file to make sure to use before_filter to remove duplicated first code line in different action.
     #
     # See the best practice detailed here http://rails-bestpractices.com/posts/22-use-before_filter.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all first code line in method definitions (actions),
     #   if they are duplicated, then they should be moved to before_filter.
-    class UseBeforeFilterCheck < Check
+    class UseBeforeFilterReview < Review
 
       PROTECTED_PRIVATE_CALLS = [[:call, nil, :protected, [:arglist]], [:call, nil, :private, [:arglist]]]
 
@@ -23,15 +20,15 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/22-use-before_filter"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:class]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
-      # check class define node to see if there are method define nodes whose first code line are duplicated in review process.
+      # check class define node to see if there are method define nodes whose first code line are duplicated.
       #
       # it will check every defn nodes in the class node until protected or private identification,
       # if there are defn nodes who have the same first code line, like
@@ -74,7 +71,7 @@ module RailsBestPractices
       #     )
       #
       # then these duplicated first code lines should be moved to before_filter.
-      def review_start_class(class_node)
+      def start_class(class_node)
         @first_sentences = {}
 
         class_node.body.children.each do |child_node|

data/lib/rails_best_practices/{checks/use_model_association_check.rb → reviews/use_model_association_review.rb}

@@ -1,37 +1,34 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller file to make sure to use model association instead of foreign key id assignment.
+  module Reviews
+    # review a controller file to make sure to use model association instead of foreign key id assignment.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/2-use-model-association.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check model define nodes in all controller files,
     #   if there is an attribute assignment node with message xxx_id=,
     #   and after it, there is a call node with message :save or :save!,
     #   and the subjects of attribute assignment node and call node are the same,
     #   then model association should be used instead of xxx_id assignment.
-    class UseModelAssociationCheck < Check
+    class UseModelAssociationReview < Review
       def url
         "http://rails-bestpractices.com/posts/2-use-model-association"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:defn]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
-      # check method define nodes to see if there are some attribute assignments that can use model association instead in review process.
+      # check method define nodes to see if there are some attribute assignments that can use model association instead.
       #
       # it will check attribute assignment node with message xxx_id=, and call node with message :save or :save!
       #
@@ -40,7 +37,7 @@ module RailsBestPractices
       # 2. after assignment, if there is a call node with message :save or :save!,
       #    and the subject of call node is one of the subject of attribute assignment node,
       #    then the attribute assignment should be replaced by using model association.
-      def review_start_defn(node)
+      def start_defn(node)
         @attrasgns = {}
         node.recursive_children do |child|
           case child.node_type

data/lib/rails_best_practices/{checks/use_observer_check.rb → reviews/use_observer_review.rb}

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
+  module Reviews
     # Make sure to use observer (sorry we only check the mailer deliver now).
     #
     # See the best practice details here http://rails-bestpractices.com/posts/19-use-observer.
@@ -23,42 +23,25 @@ module RailsBestPractices
     #   if the method is a callback method,
     #   and there is a mailer deliver call,
     #   then the method should be replaced by using observer.
-    class UseObserverCheck < Check
+    class UseObserverReview < Review
       def url
         "http://rails-bestpractices.com/posts/19-use-observer"
       end
 
-      def interesting_prepare_nodes
-        [:class]
-      end
-
-      def interesting_review_nodes
+      def interesting_nodes
         [:defn, :call]
       end
 
-      def interesting_prepare_files
-        /#{MAILER_FILES}|#{MODEL_FILES}/
-      end
-
-      def interesting_review_files
+      def interesting_files
         MODEL_FILES
       end
 
       def initialize
         super
         @callbacks = []
-        @mailer_names = []
       end
 
-      # check class node in prepare process.
-      #
-      # if it is a subclass of ActionMailer::Base,
-      # then remember its class name.
-      def prepare_start_class(node)
-        remember_mailer_names(node)
-      end
-
-      # check a call node in review process.
+      # check a call node.
       #
       # if it is a callback definition, like
       #
@@ -66,7 +49,7 @@ module RailsBestPractices
       #     before_destroy :send_destroy_notification
       #
       # then remember its callback methods (:send_create_notification).
-      def review_start_call(node)
+      def start_call(node)
         remember_callback(node)
       end
 
@@ -75,27 +58,13 @@ module RailsBestPractices
       # if it is callback method,
       # and there is a actionmailer deliver call in the method define node,
       # then it should be replaced by using observer.
-      def review_start_defn(node)
+      def start_defn(node)
         if callback_method?(node) and deliver_mailer?(node)
           add_error "use observer"
         end
       end
 
       private
-        # check a class node, if its base class is ActionMailer::Base, like
-        #
-        #     s(:class, :ProjectMailer,
-        #       s(:colon2, s(:const, :ActionMailer), :Base),
-        #       s(:scope)
-        #     )
-        #
-        # then save the class name in @mailer_names
-        def remember_mailer_names(node)
-          if s(:colon2, s(:const, :ActionMailer), :Base) == node.base_class
-            @mailer_names << node.class_name.to_s
-          end
-        end
-
         # check a call node, if it is a callback definition, such as after_create, before_create, like
         #
         #     s(:call, nil, :after_create,
@@ -147,12 +116,16 @@ module RailsBestPractices
         def deliver_mailer?(node)
           node.grep_nodes(:node_type => :call) do |child_node|
             # rails2 actionmailer deliver
-            return true if child_node.message.to_s =~ /^deliver_/ && @mailer_names.include?(child_node.subject.to_s)
+            return true if child_node.message.to_s =~ /^deliver_/ && mailer_names.include?(child_node.subject.to_s)
             # rails3 actionmailer deliver
-            return true if :deliver == child_node.message && @mailer_names.include?(child_node.subject.subject.to_s)
+            return true if :deliver == child_node.message && mailer_names.include?(child_node.subject.subject.to_s)
           end
           false
         end
+
+        def mailer_names
+          @mailer_names ||= Prepares.mailer_names.collect(&:to_s)
+        end
     end
   end
 end

data/lib/rails_best_practices/{checks/use_query_attribute_check.rb → reviews/use_query_attribute_review.rb}

@@ -1,8 +1,8 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
+  module Reviews
     # Make sure to use query attribute instead of nil?, blank? and present?.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/56-use-query-attribute.
@@ -20,21 +20,19 @@ module RailsBestPractices
     #   and their messages of first call are not pluralize and not in any of the association names
     #   and their messages of second call are one of nil?, blank?, present?, or they are == ""
     #   then you can use query attribute instead.
-    class UseQueryAttributeCheck < Check
+    class UseQueryAttributeReview < Review
 
       QUERY_METHODS = [:nil?, :blank?, :present?]
 
-      prepare_model_associations
-
       def url
         "http://rails-bestpractices.com/posts/56-use-query-attribute"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:if]
       end
 
-      # check if node to see whose conditional statement nodes contain nodes that can use query attribute instead in review process.
+      # check if node to see whose conditional statement nodes contain nodes that can use query attribute instead.
       #
       # it will check every call nodes in the if nodes. If the call node is
       #
@@ -46,7 +44,7 @@ module RailsBestPractices
       #    the message is == and the argument is ""
       #
       # then the call node can use query attribute instead.
-      def review_start_if(node)
+      def start_if(node)
         if node = query_attribute_node(node.conditional_statement)
           subject_node = node.subject
           add_error "use query attribute (#{subject_node.subject}.#{subject_node.message}?)", node.file, node.line
@@ -85,24 +83,30 @@ module RailsBestPractices
         def possible_query_attribute?(node)
           return false unless :call == node.subject.node_type
           subject = node.subject.subject
+          return false unless subject
           message = node.subject.message
 
-          [:arglist] == node.subject.arguments && class_attribute?(subject, message) && !pluralize?(message.to_s) &&
-            (QUERY_METHODS.include?(node.message) || compare_with_empty_string?(node))
+          [:arglist] == node.subject.arguments && is_model?(subject) && !model_association?(subject, message) &&
+            !pluralize?(message.to_s) && (QUERY_METHODS.include?(node.message) || compare_with_empty_string?(node))
+        end
+
+        def is_model?(subject)
+          return false if :const == subject.node_type
+          class_name = subject.to_s(:remove_at => true).classify
+          !model_associations[class_name].nil?
         end
 
-        # check if the subject and message is one of the model's attribute.
-        # the subject should match one of the class model name, and the message should not match any of association name.
+        # check if the subject and message is one of the model's aassociation.
+        # the subject should match one of the class model name, and the message should match one of association name.
         #
         #     subject, subject of call node, like
         #         s(:ivar, @user)
         #
         #     message, message of call node, like
         #         :login
-        def class_attribute?(subject, message)
-          @klazzes.find do |klazz|
-            subject.to_s =~ %r|#{klazz.to_s.underscore}| && !@associations[klazz].find { |association| equal?(association, message) }
-          end
+        def model_association?(subject, message)
+          class_name = subject.to_s(:remove_at => true).classify
+          !model_associations[class_name][message.to_s].nil?
         end
 
 

data/lib/rails_best_practices/{checks/use_say_with_time_in_migrations_check.rb → reviews/use_say_with_time_in_migrations_review.rb}

@@ -1,23 +1,20 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a migration file to make sure to use say or say_with_time for customized data changes to produce a more readable output.
+  module Reviews
+    # Review a migration file to make sure to use say or say_with_time for customized data changes to produce a more readable output.
     #
     # See the best practice detials here http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check class method define nodes (self.up or self.down).
     #   if there is a method call in the class method definition,
     #   and the message of method call is not say, say_with_time and default migration methods (such as add_column and create_table),
     #   then the method call should be wrapped by say or say_with_time.
-    class UseSayWithTimeInMigrationsCheck < Check
+    class UseSayWithTimeInMigrationsReview < Review
 
       DEFAULT_MIGRATION_METHODS = [:add_column, :add_index, :add_timestamps, :change_column, :change_column_default, :change_table, :create_table, :drop_table, :remove_column, :remove_index, :remove_timestamps, :rename_column, :rename_index, :rename_table]
       WITH_SAY_METHODS = DEFAULT_MIGRATION_METHODS + [:say, :say_with_time]
@@ -26,15 +23,15 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/46-use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:defs]
       end
 
-      def interesting_review_files
+      def interesting_files
         MIGRATION_FILES
       end
 
-      # check a class method define node to see if there are method calls that need to be wrapped by :say or :say_with_time in review process.
+      # check a class method define node to see if there are method calls that need to be wrapped by :say or :say_with_time.
       #
       # it will check the first block node,
       # if any method call whose message is not default migration methods in the block node, like
@@ -67,7 +64,7 @@ module RailsBestPractices
       #     )
       #
       # then such method call should be wrapped by say or say_with_time
-      def review_start_defs(node)
+      def start_defs(node)
         block_node = node.grep_node(:node_type => :block)
         block_node.children.each do |child_node|
           if :iter == child_node.node_type

data/lib/rails_best_practices/{checks/use_scope_access_check.rb → reviews/use_scope_access_review.rb}

@@ -1,37 +1,34 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a controller to make sure to use scope access instead of manually checking current_user and redirect.
+  module Reviews
+    # Review a controller to make sure to use scope access instead of manually checking current_user and redirect.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/3-use-scope-access.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all if nodes to see
     #
     #   if they are compared with current_user or current_user.id,
     #   and there is redirect_to method call in if block body,
     #   then it should be replaced by using scope access.
-    class UseScopeAccessCheck < Check
+    class UseScopeAccessReview < Review
       def url
         "http://rails-bestpractices.com/posts/3-use-scope-access"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:if]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
-      # check if node in review process.
+      # check if node.
       #
       # if it is a method call compared with current_user or current_user.id,
       # and there is a redirect_to method call in the block body, like
@@ -42,7 +39,7 @@ module RailsBestPractices
       #     end
       #
       # then it should be replaced by using scope access.
-      def review_start_if(node)
+      def start_if(node)
         add_error "use scope access" if current_user_redirect?(node)
       end
 

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module RailsBestPractices
-  VERSION = "0.6.6"
+  VERSION = "0.6.7"
 end
 

data/rails_best_practices.gemspec

@@ -21,7 +21,8 @@ Gem::Specification.new do |s|
   s.add_dependency("i18n")
   s.add_dependency("activesupport")
 
-  s.add_development_dependency("rspec", "~> 2.0.1")
+  s.add_development_dependency("rake")
+  s.add_development_dependency("rspec", "~> 2.4.0")
   s.add_development_dependency("watchr", "~> 0.6")
   s.add_development_dependency("bundler", ">= 1.0.0")
 
@@ -35,7 +36,7 @@ Gem::Specification.new do |s|
 
   rails_best_practices is a code metric tool to check the quality of rails codes.
 
-  I highly recommend you go through the Rails Best Practices website first.
+  I highly recommend you browse the Rails Best Practices website first.
 
       http://rails-bestpractices.com
 

data/rails_best_practices.yml

@@ -1,22 +1,22 @@
-MoveFinderToNamedScopeCheck: { }
-UseModelAssociationCheck: { }
-UseScopeAccessCheck: { }
-AddModelVirtualAttributeCheck: { }
-ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
-MoveModelLogicIntoModelCheck: { use_count: 4 }
-OveruseRouteCustomizationsCheck: { customize_count: 3 }
-NeedlessDeepNestingCheck: { nested_count: 2 }
-NotUseDefaultRouteCheck: {  }
-KeepFindersOnTheirOwnModelCheck: { }
-LawOfDemeterCheck: { }
-UseObserverCheck: { }
-IsolateSeedDataCheck: { }
-AlwaysAddDbIndexCheck: { }
-UseBeforeFilterCheck: { }
-MoveCodeIntoControllerCheck: { }
-MoveCodeIntoModelCheck: { use_count: 2 }
-MoveCodeIntoHelperCheck: { array_count: 3 }
-ReplaceInstanceVariableWithLocalVariableCheck: { }
-DryBundlerInCapistranoCheck: { }
-UseSayWithTimeInMigrationsCheck: { }
-UseQueryAttributeCheck: { }
+MoveFinderToNamedScopeReview: { }
+UseModelAssociationReview: { }
+UseScopeAccessReview: { }
+AddModelVirtualAttributeReview: { }
+ReplaceComplexCreationWithFactoryMethodReview: { attribute_assignment_count: 2 }
+MoveModelLogicIntoModelReview: { use_count: 4 }
+OveruseRouteCustomizationsReview: { customize_count: 3 }
+NeedlessDeepNestingReview: { nested_count: 2 }
+NotUseDefaultRouteReview: {  }
+KeepFindersOnTheirOwnModelReview: { }
+LawOfDemeterReview: { }
+UseObserverReview: { }
+IsolateSeedDataReview: { }
+AlwaysAddDbIndexReview: { }
+UseBeforeFilterReview: { }
+MoveCodeIntoControllerReview: { }
+MoveCodeIntoModelReview: { use_count: 2 }
+MoveCodeIntoHelperReview: { array_count: 3 }
+ReplaceInstanceVariableWithLocalVariableReview: { }
+DryBundlerInCapistranoReview: { }
+UseSayWithTimeInMigrationsReview: { }
+UseQueryAttributeReview: { }