rails_best_practices 1.18.1 → 1.19.0

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review view and helper files to make sure not use time_ago_in_words or distance_of_time_in_words_to_now.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/
+    # See the best practice details here https://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class NotUseTimeAgoInWordsReview < Review
       interesting_nodes :fcall
       interesting_files VIEW_FILES, HELPER_FILES
-      url "http://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/"
+      url "https://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/"
 
       # check fcall node to see if its message is time_ago_in_words or distance_of_time_in_words_to_now
       add_callback :start_fcall do |node|

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -3,22 +3,11 @@ module RailsBestPractices
   module Reviews
     # Review config/routes.rb file to make sure there are no overuse route customizations.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/
     #
     # Implementation:
     #
     # Review process:
-    #   the check methods are different for rails2 and rails3 syntax.
-    #
-    #   for rails2
-    #
-    #   check all command_call nodes in route file.
-    #   if the message of command_call node is resources,
-    #   and the second argument of command_call node is a hash,
-    #   and the count of the pair (key/value) in hash is greater than @customize_count,
-    #   then these custom routes are overuse.
-    #
-    #   for rails3
     #
     #   check all method_add_block nodes in route file.
     #   if the receiver of method_add_block node is with message resources,
@@ -28,7 +17,7 @@ module RailsBestPractices
     class OveruseRouteCustomizationsReview < Review
       interesting_nodes :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/"
+      url "https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/"
 
       VERBS = %w(get post update delete)
 
@@ -37,21 +26,7 @@ module RailsBestPractices
         @customize_count = options['customize_count'] || 3
       end
 
-      # check command_call node to see if the count of member and collection custom routes is more than @customize_count defined.
-      # this is for rails2 syntax.
-      #
-      # if the message of call node is "resources",
-      # and the second argument of call node is a hash,
-      # and the count of the pair (key/value) in hash is greater than @customize_count,
-      # then they are overuse route customizations.
-      add_callback :start_command_call do |node|
-        if member_and_collection_count_for_rails2(node) > @customize_count
-          add_error "overuse route customizations (customize_count > #{@customize_count})", node.file, node.receiver.line_number
-        end
-      end
-
       # check method_add_block node to see if the count of member and collection custom routes is more than @customize_count defined.
-      # this is for rails3 syntax.
       #
       # if the receiver of method_add_block node is with message "resources",
       # and in the block body of method_add_block node, there are more than @customize_count call nodes,
@@ -65,27 +40,7 @@ module RailsBestPractices
 
       private
 
-        # check command_call node to calculate the count of member and collection custom routes.
-        # this is for rails2 syntax.
-        #
-        # if the message of command_call node is "resources",
-        # and the second argument is a hash,
-        # then calculate the pair (key/value) count,
-        # 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.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")
-              return (member_node.hash_size || member_node.array_size) + (collection_node.hash_size || collection_node.array_size)
-            end
-          end
-          0
-        end
-
         # check method_add_block node to calculate the count of member and collection custom routes.
-        # this is for rails3 syntax.
         #
         # if its receiver is with message "resources",
         # then calculate the count of call nodes, whose message is get, post, update or delete,

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review model files to make sure to use attr_accessible, attr_protected or strong_parameters to protect mass assignment.
     #
-    # See the best practices details here http://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/
+    # See the best practices details here https://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/
     #
     # Implmentation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class ProtectMassAssignmentReview < Review
       interesting_files MODEL_FILES
       interesting_nodes :class, :command, :var_ref, :vcall, :fcall
-      url "http://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/"
+      url "https://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/"
 
       # we treat it as mass assignment by default.
       add_callback :start_class do |node|

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a helper file to make sure it is not an empty moduel.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/
+    # See the best practice details here https://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class RemoveEmptyHelpersReview < Review
       interesting_nodes :module
       interesting_files HELPER_FILES
-      url "http://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/"
+      url "https://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/"
 
       # check the body of module node, if it is nil, then it should be removed.
       add_callback :start_module do |module_node|

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # Review a controller file to make sure that complex model creation should not exist in
     # controller, should be replaced with factory method.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/
     #
     # Implementation:
     #
@@ -17,7 +17,7 @@ module RailsBestPractices
     class ReplaceComplexCreationWithFactoryMethodReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/"
+      url "https://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/"
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a partail view file to make sure there is no instance variable.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class ReplaceInstanceVariableWithLocalVariableReview < Review
       interesting_nodes :var_ref, :vcall
       interesting_files PARTIAL_VIEW_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/"
+      url "https://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/"
 
       # check ivar node in partial view file,
       # it is an instance variable, and should be replaced with local variable.

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a route file to make sure all auto-generated routes have corresponding actions in controller.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/
+    # See the best practice details here https://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/
     #
     # Implementation:
     #
@@ -15,10 +15,19 @@ module RailsBestPractices
     class RestrictAutoGeneratedRoutesReview < Review
       interesting_nodes :command, :command_call, :method_add_block
       interesting_files ROUTE_FILES
-      url "http://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/"
+      url "https://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/"
 
-      RESOURCE_METHODS = ["show", "new", "create", "edit", "update", "destroy"]
-      RESOURCES_METHODS = RESOURCE_METHODS + ["index"]
+      def resource_methods
+        if Prepares.configs['config.api_only']
+          %w(show create update destroy)
+        else
+          %w(show new create edit update destroy)
+        end
+      end
+
+      def resources_methods
+        resource_methods + ['index']
+      end
 
       def initialize(options={})
         super(options)
@@ -88,12 +97,12 @@ module RailsBestPractices
 
         # check resources call, if the routes generated by resources does not exist in the controller.
         def check_resources(node)
-          _check(node, RESOURCES_METHODS)
+          _check(node, resources_methods)
         end
 
         # check resource call, if the routes generated by resources does not exist in the controller.
         def check_resource(node)
-          _check(node, RESOURCE_METHODS)
+          _check(node, resource_methods)
         end
 
         # get the controller name.

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a controller file to make sure using simplified syntax for render.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/
     #
     # Implementation:
     #
@@ -14,7 +14,7 @@ module RailsBestPractices
     class SimplifyRenderInControllersReview < Review
       interesting_nodes :command
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/"
+      url "https://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/"
 
       # check command node in the controller file,
       # if its message is render and the arguments contain a key action, template or file,

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Review a view file to make sure using simplified syntax for render.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class SimplifyRenderInViewsReview < Review
       interesting_nodes :command
       interesting_files VIEW_FILES
-      url "http://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/"
+      url "https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/"
 
       VALID_KEYS = %w(object collection locals)
 

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # Review a controller file to make sure to use before_filter to remove duplicated first code
     # line_number in different action.
     #
-    # See the best practice detailed here http://rails-bestpractices.com/posts/2010/07/24/use-before_filter/
+    # See the best practice detailed here https://rails-bestpractices.com/posts/2010/07/24/use-before_filter/
     #
     # Implementation:
     #
@@ -14,7 +14,7 @@ module RailsBestPractices
     class UseBeforeFilterReview < Review
       interesting_nodes :class
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/24/use-before_filter/"
+      url "https://rails-bestpractices.com/posts/2010/07/24/use-before_filter/"
 
       def initialize(options = {})
         super()

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   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/2010/07/19/use-model-association/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/19/use-model-association/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseModelAssociationReview < Review
       interesting_nodes :def
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/19/use-model-association/"
+      url "https://rails-bestpractices.com/posts/2010/07/19/use-model-association/"
 
       # check method define nodes to see if there are some attribute assignments that can use model association instead.
       #

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Make sure to use multipart/alternative as content_type of email.
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/
     #
     # Implementation:
     #
@@ -13,7 +13,7 @@ module RailsBestPractices
     class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
       interesting_nodes :class, :def
       interesting_files MAILER_FILES
-      url "http://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/"
+      url "https://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/"
 
       # check class node to remember the ActionMailer class name.
       add_callback :start_class do |node|
@@ -23,7 +23,7 @@ module RailsBestPractices
       # check def node and find if the corresponding views exist or not?
       add_callback :start_def do |node|
         name = node.method_name.to_s
-        if !rails_canonical_mailer_views?(name)
+        if !rails3_canonical_mailer_views?(name)
           add_error("use multipart/alternative as content_type of email")
         end
       end
@@ -34,21 +34,6 @@ module RailsBestPractices
         #
         # @param [String] name method name in action_mailer
         def rails_canonical_mailer_views?(name)
-          if Prepares.gems.gem_version("rails").to_i > 2
-            rails3_canonical_mailer_views?(name)
-          else
-            rails2_canonical_mailer_views?(name)
-          end
-        end
-
-        # check if rails2's syntax mailer views are canonical.
-        #
-        # @param [String] name method name in action_mailer
-        def rails2_canonical_mailer_views?(name)
-          return true if mailer_files(name).length == 0
-          return true if mailer_files(name).none? { |filename| filename.index 'text.html' }
-          mailer_files(name).any? { |filename| filename.index 'text.html' } &&
-            mailer_files(name).any? { |filename| filename.index 'text.plain' }
         end
 
         # check if rails3's syntax mailer views are canonical.

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   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/2010/07/24/use-observer/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/24/use-observer/
     #
     # TODO: we need a better solution, any suggestion?
     #
@@ -20,7 +20,7 @@ module RailsBestPractices
     class UseObserverReview < Review
       interesting_nodes :def, :command
       interesting_files MODEL_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/24/use-observer/"
+      url "https://rails-bestpractices.com/posts/2010/07/24/use-observer/"
 
       def initialize(options = {})
         super
@@ -66,22 +66,11 @@ module RailsBestPractices
 
         # check a def node to see if it contains a actionmailer deliver call.
         #
-        # for rails2
-        #
-        # if the message of call node is deliver_xxx,
-        # and the receiver of the call node exists in @callbacks,
-        #
-        # for rails3
-        #
         # if the message of call node is deliver,
         # and the receiver of the call node is with receiver node who exists in @callbacks,
-        #
         # then the call node is actionmailer deliver call.
         def deliver_mailer?(node)
           node.grep_nodes(sexp_type: :call) do |child_node|
-            # rails2 actionmailer deliver
-            return true if child_node.message.to_s =~ /^deliver_/ && mailers.include?(child_node.receiver.to_s)
-            # rails3 actionmailer deliver
             if "deliver" == child_node.message.to_s
               if :method_add_arg == child_node.receiver.sexp_type &&
                 mailers.include?(child_node.receiver[1].receiver.to_s)

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   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/2010/10/03/use-query-attribute/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseQueryAttributeReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files ALL_FILES
-      url "http://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/"
+      url "https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/"
 
       QUERY_METHODS = %w(nil? blank? present?)
 

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -4,7 +4,7 @@ module RailsBestPractices
     # 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/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/
+    # See the best practice detials here https://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseSayWithTimeInMigrationsReview < Review
       interesting_nodes :defs
       interesting_files MIGRATION_FILES
-      url "http://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/"
+      url "https://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/"
 
       WITH_SAY_METHODS = %w(say say_with_time)
 

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   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/2010/07/20/use-scope-access/
+    # See the best practice details here https://rails-bestpractices.com/posts/2010/07/20/use-scope-access/
     #
     # Implementation:
     #
@@ -16,7 +16,7 @@ module RailsBestPractices
     class UseScopeAccessReview < Review
       interesting_nodes :if, :unless, :elsif, :ifop, :if_mod, :unless_mod
       interesting_files CONTROLLER_FILES
-      url "http://rails-bestpractices.com/posts/2010/07/20/use-scope-access/"
+      url "https://rails-bestpractices.com/posts/2010/07/20/use-scope-access/"
 
       # check if node.
       #

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -3,7 +3,7 @@ module RailsBestPractices
   module Reviews
     # Prepare Gemfile and review Capfile file to make sure using turbo-sprocket-rails3
     #
-    # See the best practice details here http://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/
+    # See the best practice details here https://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/
     #
     # Implementation:
     #
@@ -12,7 +12,7 @@ module RailsBestPractices
     class UseTurboSprocketsRails3Review < Review
       interesting_nodes :command
       interesting_files CAPFILE
-      url "http://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/"
+      url "https://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/"
 
       # check command node to see if load 'deploy/assets'
       add_callback :start_command do |node|