rails_best_practices 0.6.6 → 0.6.7

data/lib/rails_best_practices/reviews.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'rails_best_practices/reviews/move_finder_to_named_scope_review'
+require 'rails_best_practices/reviews/use_model_association_review'
+require 'rails_best_practices/reviews/use_scope_access_review'
+require 'rails_best_practices/reviews/add_model_virtual_attribute_review'
+require 'rails_best_practices/reviews/replace_complex_creation_with_factory_method_review'
+require 'rails_best_practices/reviews/move_model_logic_into_model_review'
+require 'rails_best_practices/reviews/overuse_route_customizations_review'
+require 'rails_best_practices/reviews/needless_deep_nesting_review'
+require 'rails_best_practices/reviews/not_use_default_route_review'
+require 'rails_best_practices/reviews/keep_finders_on_their_own_model_review'
+require 'rails_best_practices/reviews/law_of_demeter_review'
+require 'rails_best_practices/reviews/use_observer_review'
+require 'rails_best_practices/reviews/isolate_seed_data_review'
+require 'rails_best_practices/reviews/always_add_db_index_review'
+require 'rails_best_practices/reviews/use_before_filter_review'
+require 'rails_best_practices/reviews/move_code_into_controller_review'
+require 'rails_best_practices/reviews/move_code_into_model_review'
+require 'rails_best_practices/reviews/move_code_into_helper_review'
+require 'rails_best_practices/reviews/replace_instance_variable_with_local_variable_review'
+require 'rails_best_practices/reviews/dry_bundler_in_capistrano_review'
+require 'rails_best_practices/reviews/use_say_with_time_in_migrations_review'
+require 'rails_best_practices/reviews/use_query_attribute_review'

data/lib/rails_best_practices/{checks/add_model_virtual_attribute_check.rb → reviews/add_model_virtual_attribute_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
+  module Reviews
     # Make sure to add a model virual attribute to simplify model creation.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/4-add-model-virtual-attribute
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check method define nodes in all controller files,
     #   if there are more than one [] method calls with the same subject and arguments,
@@ -26,16 +23,16 @@ module RailsBestPractices
     #       end
     #
     #   then the model needs to add a virtual attribute.
-    class AddModelVirtualAttributeCheck < Check
+    class AddModelVirtualAttributeReview < Review
       def url
         "http://rails-bestpractices.com/posts/4-add-model-virtual-attribute"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:defn]
       end
 
-      def interesting_review_files
+      def interesting_files
         CONTROLLER_FILES
       end
 
@@ -53,7 +50,7 @@ module RailsBestPractices
       # 5. and the subject of save or save! call node should be the same with the subject of attribute assignment nodes
       #
       # then the attribute assignment nodes can add model virtual attribute instead.
-      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/always_add_db_index_check.rb → reviews/always_add_db_index_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check db/schema.rb file to make sure every reference key has a database index.
+  module Reviews
+    # Review db/schema.rb file to make sure every reference key has a database index.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/21-always-add-db-index
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   only check the call nodes and at the end of iter node in db/schema file,
     #   if the subject of call node is :create_table, then remember the table names
@@ -26,16 +23,16 @@ module RailsBestPractices
     #
     #   if there are any foreign keys not existed in index columns,
     #   then the foreign keys should add db index.
-    class AlwaysAddDbIndexCheck < Check
+    class AlwaysAddDbIndexReview < Review
       def url
         "http://rails-bestpractices.com/posts/21-always-add-db-index"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call, :iter]
       end
 
-      def interesting_review_files
+      def interesting_files
         /db\/schema.rb/
       end
 
@@ -46,7 +43,7 @@ module RailsBestPractices
         @table_nodes = {}
       end
 
-      # check call node in review process.
+      # check call node.
       #
       # if the message of call node is :create_table,
       # then remember the table name (@table_nodes) like
@@ -75,7 +72,7 @@ module RailsBestPractices
       #     "comments" =>
       #       ["post_id", "user_id"]
       #   }
-      def review_start_call(node)
+      def start_call(node)
         case node.message
         when :create_table
           remember_table_nodes(node)
@@ -113,7 +110,7 @@ module RailsBestPractices
       #
       # if there are any foreign keys not existed in index columns,
       # then we should add db index for that foreign keys.
-      def review_end_iter(node)
+      def end_iter(node)
         first_node = node.subject
         if :call == first_node.node_type && s(:colon2, s(:const, :ActiveRecord), :Schema) == first_node.subject
           remove_only_type_foreign_keys

data/lib/rails_best_practices/{checks/dry_bundler_in_capistrano_check.rb → reviews/dry_bundler_in_capistrano_review.rb}

@@ -1,36 +1,33 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check config/deploy.rb file to make sure using the bundler's capistrano recipe.
+  module Reviews
+    # Review config/deploy.rb file to make sure using the bundler's capistrano recipe.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   only check the call nodes to see if there is bundler namespace in config/deploy.rb file,
     #
     #   if the message of call node is :namespace and the arguments of the call node is :bundler,
     #   then it should use bundler's capistrano recipe.
-    class DryBundlerInCapistranoCheck < Check
+    class DryBundlerInCapistranoReview < Review
       def url
         "http://rails-bestpractices.com/posts/51-dry-bundler-in-capistrano"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         /config\/deploy.rb/
       end
 
-      # check call node in review process to see if it is with message :namespace and arguments :bundler.
+      # check call node to see if it is with message :namespace and arguments :bundler.
       #
       # the ruby code is
       #
@@ -41,7 +38,7 @@ module RailsBestPractices
       # then the call node is as follows
       #
       #     s(:call, nil, :namespace, s(:arglist, s(:lit, :bundler)))
-      def review_start_call(node)
+      def start_call(node)
         if :namespace == node.message and equal?(node.arguments[1], "bundler")
           add_error "dry bundler in capistrano"
         end

data/lib/rails_best_practices/{checks/isolate_seed_data_check.rb → reviews/isolate_seed_data_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
+  module Reviews
     # Make sure not to insert data in migration, move them to seed file.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/20-isolating-seed-data.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   1. check all local assignment and instance assignment nodes,
     #   if the right value is a call node with message :new,
@@ -23,16 +20,16 @@ module RailsBestPractices
     #   if the message is :save or :save!,
     #   and the subject is included in new variables,
     #   then it should be isolated to db seed.
-    class IsolateSeedDataCheck < Check
+    class IsolateSeedDataReview < Review
       def url
         "http://rails-bestpractices.com/posts/20-isolating-seed-data"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call, :lasgn, :iasgn]
       end
 
-      def interesting_review_files
+      def interesting_files
         MIGRATION_FILES
       end
 
@@ -41,23 +38,23 @@ module RailsBestPractices
         @new_variables = []
       end
 
-      # check local assignment node in review process.
+      # check local assignment node.
       #
       # if the right value of the node is a call node with :new message,
       # then remember it as new variables (@new_variables).
-      def review_start_lasgn(node)
+      def start_lasgn(node)
         remember_new_variable(node)
       end
 
-      # check instance assignment node in review process.
+      # check instance assignment node.
       #
       # if the right value of the node is a call node with :new message,
       # then remember it as new variables (@new_variables).
-      def review_start_iasgn(node)
+      def start_iasgn(node)
         remember_new_variable(node)
       end
 
-      # check the call node in review process.
+      # check the call node.
       #
       # if the message of the call node is :create or :create!,
       # then you should isolate it to seed data.
@@ -65,7 +62,7 @@ module RailsBestPractices
       # if the message of the call node is :save or :save!,
       # and the subject of the call node is included in @new_variables,
       # then you should isolate it to seed data.
-      def review_start_call(node)
+      def start_call(node)
         if [:create, :create!].include? node.message
           add_error("isolate seed data")
         elsif [:save, :save!].include? node.message

data/lib/rails_best_practices/{checks/keep_finders_on_their_own_model_check.rb → reviews/keep_finders_on_their_own_model_review.rb}

@@ -1,17 +1,14 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check model files to ake sure finders are on their own model.
+  module Reviews
+    # Review model files to ake sure finders are on their own model.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check all call nodes in model files.
     #
@@ -19,7 +16,7 @@ module RailsBestPractices
     #   and the it calls the other model,
     #   and there is a hash argument for finder,
     #   then it should keep finders on its own model.
-    class KeepFindersOnTheirOwnModelCheck < Check
+    class KeepFindersOnTheirOwnModelReview < Review
 
       FINDERS = [:find, :all, :first, :last]
 
@@ -27,11 +24,11 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/13-keep-finders-on-their-own-model"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         MODEL_FILES
       end
 
@@ -44,7 +41,7 @@ module RailsBestPractices
       # 3. the any of its arguments is a hash (complex finder)
       #
       # then it should keep finders on its own model.
-      def review_start_call(node)
+      def start_call(node)
         add_error "keep finders on their own model" if other_finder?(node)
       end
 

data/lib/rails_best_practices/{checks/law_of_demeter_check.rb → reviews/law_of_demeter_review.rb}

@@ -1,16 +1,16 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check to make sure not to avoid the law of demeter.
+  module Reviews
+    # Review to make sure not to avoid the law of demeter.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/15-the-law-of-demeter.
     #
     # Implementation:
     #
     # Prepare process:
-    #   only check all model files to save model names and association names.
+    #   only review all model files to save model names and association names.
     #
     # Review process:
     #   check all method calls to see if there is method call to the association object.
@@ -18,19 +18,17 @@ module RailsBestPractices
     #   and whose message is an association of that model (also compare by name),
     #   and outer the call node, it is also a call node,
     #   then it violate the law of demeter.
-    class LawOfDemeterCheck < Check
-
-      prepare_model_associations
+    class LawOfDemeterReview < Review
 
       def url
         "http://rails-bestpractices.com/posts/15-the-law-of-demeter"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      # check the call node in review process,
+      # check the call node,
       #
       # if the subject of the call node is also a call node,
       # and the subject of the subject call node matchs one of the class names,
@@ -43,7 +41,7 @@ module RailsBestPractices
       #     )
       #
       # then it violates the law of demeter.
-      def review_start_call(node)
+      def start_call(node)
         if [:lvar, :ivar].include?(node.subject.subject.node_type) && need_delegate?(node)
           add_error "law of demeter"
         end
@@ -67,10 +65,8 @@ module RailsBestPractices
         # as you see the subject of subject of the call node is [:ivar, @invoice],
         # and the message of subject of the call node is :user
         def need_delegate?(node)
-          @associations.each do |class_name, associations|
-            return true if equal?(node.subject.subject, class_name) && associations.find { |association| equal?(association, node.subject.message) }
-          end
-          false
+          class_name = node.subject.subject.to_s(:remove_at => true).classify
+          association_methods.include? model_associations[class_name][node.subject.message.to_s]
         end
 
         # only check belongs_to and has_one association.

data/lib/rails_best_practices/{checks/move_code_into_controller_check.rb → reviews/move_code_into_controller_review.rb}

@@ -1,20 +1,17 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a view file to make sure there is no finder, finder should be moved to controller.
+  module Reviews
+    # Review a view file to make sure there is no finder, finder should be moved to controller.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/24-move-code-into-controller.
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   only check all view files to see if there are finders, then the finders should be moved to controller.
-    class MoveCodeIntoControllerCheck < Check
+    class MoveCodeIntoControllerReview < Review
 
       FINDERS = [:find, :all, :first, :last]
 
@@ -22,20 +19,20 @@ module RailsBestPractices
         "http://rails-bestpractices.com/posts/24-move-code-into-controller"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         VIEW_FILES
       end
 
-      # check call nodes in review process.
+      # check call nodes.
       #
       # if the subject of the call node is a constant,
       # and the message of the call node is one of the :find, :all, :first and :last,
       # then it is a finder and should be moved to controller.
-      def review_start_call(node)
+      def start_call(node)
         add_error "move code into controller" if finder?(node)
       end
 

data/lib/rails_best_practices/{checks/move_code_into_helper_check.rb → reviews/move_code_into_helper_review.rb}

@@ -1,9 +1,9 @@
 # encoding: utf-8
-require 'rails_best_practices/checks/check'
+require 'rails_best_practices/reviews/review'
 
 module RailsBestPractices
-  module Checks
-    # Check a view file to make sure there is no complex options_for_select message call.
+  module Reviews
+    # Review a view file to make sure there is no complex options_for_select message call.
     #
     # See the best practice details here http://rails-bestpractices.com/posts/26-move-code-into-helper.
     #
@@ -11,9 +11,6 @@ module RailsBestPractices
     #
     # Implementation:
     #
-    # Prepare process:
-    #   none
-    #
     # Review process:
     #   check al method calls to see if there is a complex options_for_select helper.
     #
@@ -21,16 +18,16 @@ module RailsBestPractices
     #   and the first argument of the call node is array,
     #   and the size of the array is greater than array_count defined,
     #   then the options_for_select method should be moved into helper.
-    class MoveCodeIntoHelperCheck < Check
+    class MoveCodeIntoHelperReview < Review
       def url
         "http://rails-bestpractices.com/posts/26-move-code-into-helper"
       end
 
-      def interesting_review_nodes
+      def interesting_nodes
         [:call]
       end
 
-      def interesting_review_files
+      def interesting_files
         VIEW_FILES
       end
 
@@ -44,7 +41,7 @@ module RailsBestPractices
       # if the first argument of options_for_select method call is an array,
       # and the size of the array is more than @array_count defined,
       # then the options_for_select helper should be moved into helper.
-      def review_start_call(node)
+      def start_call(node)
         add_error "move code into helper (array_count >= #{@array_count})" if complex_select_options?(node)
       end