rails_best_practices 1.20.0 → 1.22.1

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -20,15 +20,17 @@ module RailsBestPractices
       def initialize(options = {})
         super
         @helper_methods = Prepares.helper_methods
-        self.class.interesting_files Prepares.helpers.map(&:descendants)
+        self.class.interesting_files *Prepares.helpers.map(&:descendants)
       end
 
       # get all unused methods at the end of review process
       add_callback :after_check do
         @helper_methods.get_all_unused_methods.each do |method|
-          unless excepted?(method)
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
-          end
+          next if excepted?(method)
+
+          add_error "remove unused methods (#{method.class_name}##{method.method_name})",
+                    method.file,
+                    method.line_number
         end
       end
 

data/lib/rails_best_practices/reviews/remove_unused_methods_in_models_review.rb

@@ -80,9 +80,11 @@ module RailsBestPractices
       # get all unused methods at the end of review process.
       add_callback :after_check do
         @model_methods.get_all_unused_methods.each do |method|
-          if !excepted?(method) && method.method_name !~ /=$/
-            add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
-          end
+          next unless !excepted?(method) && method.method_name !~ /=$/
+
+          add_error "remove unused methods (#{method.class_name}##{method.method_name})",
+                    method.file,
+                    method.line_number
         end
       end
 
@@ -95,13 +97,31 @@ module RailsBestPractices
       def internal_except_methods
         %w[
           initialize
-          validate validate_each validate_on_create validate_on_update
-          human_attribute_name assign_attributes attributes attribute
-          to_xml to_json as_json to_param
-          before_save before_create before_update before_destroy after_save after_create
-          after_update after_destroy after_find after_initialize
+          validate
+          validate_each
+          validate_on_create
+          validate_on_update
+          human_attribute_name
+          assign_attributes
+          attributes
+          attribute
+          to_xml
+          to_json
+          as_json
+          to_param
+          before_save
+          before_create
+          before_update
+          before_destroy
+          after_save
+          after_create
+          after_update
+          after_destroy
+          after_find
+          after_initialize
           method_missing
-          table_name module_prefix
+          table_name
+          module_prefix
         ].map { |method_name| "*\##{method_name}" }
       end
     end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -49,9 +49,9 @@ module RailsBestPractices
 
       private
 
-        # check the call node to see if it is with message "save" or "save!",
-        # and the count attribute assignment on the receiver of the call node is greater than @assign_count defined,
-        # then it is a complex creation, should be replaced with factory method.
+      # check the call node to see if it is with message "save" or "save!",
+      # and the count attribute assignment on the receiver of the call node is greater than @assign_count defined,
+      # then it is a complex creation, should be replaced with factory method.
       def check_variable_save(node)
         if ['save', 'save!'].include? node.message.to_s
           variable = node.receiver.to_s

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -95,32 +95,33 @@ module RailsBestPractices
 
       private
 
-        # check resources call, if the routes generated by resources does not exist in the controller.
+      # check resources call, if the routes generated by resources does not exist in the controller.
       def check_resources(node)
         _check(node, resources_methods)
       end
 
-        # check resource call, if the routes generated by resources does not exist in the controller.
+      # check resource call, if the routes generated by resources does not exist in the controller.
       def check_resource(node)
         _check(node, resource_methods)
       end
 
-        # get the controller name.
+      # get the controller name.
       def controller_name(node)
         if option_with_hash(node)
           option_node = node.arguments.all[1]
-          if hash_key_exist?(option_node, 'controller')
-            name = option_node.hash_value('controller').to_s
-          else
-            name = node.arguments.all.first.to_s.gsub('::', '').tableize
-          end
+          name =
+            if hash_key_exist?(option_node, 'controller')
+              option_node.hash_value('controller').to_s
+            else
+              node.arguments.all.first.to_s.gsub('::', '').tableize
+            end
         else
           name = node.arguments.all.first.to_s.gsub('::', '').tableize
         end
         namespaced_class_name(name)
       end
 
-        # get the class name with namespace.
+      # get the class name with namespace.
       def namespaced_class_name(name)
         class_name = "#{name.split('/').map(&:camelize).join('::')}Controller"
         if @namespaces.empty?
@@ -138,11 +139,12 @@ module RailsBestPractices
         unless _methods.all? { |meth| Prepares.controller_methods.has_method?(controller_name, meth) }
           prepared_method_names = Prepares.controller_methods.get_methods(controller_name).map(&:method_name)
           only_methods = (_methods & prepared_method_names).map { |meth| ":#{meth}" }
-          routes_message = if only_methods.size > 3
-                             "except: [#{(methods.map { |meth| ':' + meth } - only_methods).join(', ')}]"
-                           else
-                             "only: [#{only_methods.join(', ')}]"
-                           end
+          routes_message =
+            if only_methods.size > 3
+              "except: [#{(methods.map { |meth| ':' + meth } - only_methods).join(', ')}]"
+            else
+              "only: [#{only_methods.join(', ')}]"
+            end
           add_error "restrict auto-generated routes #{friendly_route_name(node)} (#{routes_message})"
         end
       end
@@ -178,7 +180,7 @@ module RailsBestPractices
       end
 
       def hash_key_exist?(node, key)
-        node.hash_keys && node.hash_keys.include?(key)
+        node.hash_keys&.include?(key)
       end
 
       def friendly_route_name(node)

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -23,8 +23,7 @@ module RailsBestPractices
       add_callback :start_command do |node|
         if node.message.to_s == 'render'
           keys = node.arguments.all.first.hash_keys
-          if keys && keys.size == 1 &&
-             (keys.include?('action') || keys.include?('template') || keys.include?('file'))
+          if keys && keys.size == 1 && (keys.include?('action') || keys.include?('template') || keys.include?('file'))
             add_error 'simplify render in controllers'
           end
         end

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -23,9 +23,9 @@ module RailsBestPractices
       # then it should be replaced by simplified syntax.
       add_callback :start_command do |node|
         if node.message.to_s == 'render'
-          hash_node =  node.arguments.all.first
-          if hash_node && hash_node.sexp_type == :bare_assoc_hash &&
-             include_partial?(hash_node) && valid_hash?(hash_node)
+          hash_node = node.arguments.all.first
+          if hash_node && hash_node.sexp_type == :bare_assoc_hash && include_partial?(hash_node) &&
+               valid_hash?(hash_node)
             add_error 'simplify render in views'
           end
         end

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -12,6 +12,7 @@ module RailsBestPractices
     # Review process:
     #   check all first code line_number in method definitions (actions),
     #   if they are duplicated, then they should be moved to before_filter.
+
     class UseBeforeFilterReview < Review
       interesting_nodes :class
       interesting_files CONTROLLER_FILES
@@ -48,7 +49,7 @@ module RailsBestPractices
 
       private
 
-        # check method define node, and remember the first sentence.
+      # check method define node, and remember the first sentence.
       def remember_first_sentence(node)
         first_sentence = node.body.statements.first
         return unless first_sentence

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -43,8 +43,8 @@ module RailsBestPractices
 
       private
 
-        # check an attribute assignment node, if its message is xxx_id,
-        # then remember the receiver of the attribute assignment in @assignments.
+      # check an attribute assignment node, if its message is xxx_id,
+      # then remember the receiver of the attribute assignment in @assignments.
       def attribute_assignment(node)
         if node.left_value.message.is_a?(Sexp) && node.left_value.message.to_s =~ /_id$/
           receiver = node.left_value.receiver.to_s
@@ -52,9 +52,9 @@ module RailsBestPractices
         end
       end
 
-        # check a call node with message "save" or "save!",
-        # if the receiver of call node exists in @assignments,
-        # then the attribute assignment should be replaced by using model association.
+      # check a call node with message "save" or "save!",
+      # if the receiver of call node exists in @assignments,
+      # then the attribute assignment should be replaced by using model association.
       def call_assignment(node)
         if ['save', 'save!'].include? node.message.to_s
           receiver = node.receiver.to_s

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -11,6 +11,7 @@ module RailsBestPractices
     # Review process:
     #   check class node to remember the class name,
     #   and check the method definition nodes to see if the corresponding mailer views exist or not.
+
     class UseMultipartAlternativeAsContentTypeOfEmailReview < Review
       interesting_nodes :class, :def
       interesting_files MAILER_FILES
@@ -31,14 +32,14 @@ module RailsBestPractices
 
       private
 
-        # check if rails's syntax mailer views are canonical.
-        #
-        # @param [String] name method name in action_mailer
+      # check if rails's syntax mailer views are canonical.
+      #
+      # @param [String] name method name in action_mailer
       def rails_canonical_mailer_views?(name); end
 
-        # check if rails3's syntax mailer views are canonical.
-        #
-        # @param [String] name method name in action_mailer
+      # check if rails3's syntax mailer views are canonical.
+      #
+      # @param [String] name method name in action_mailer
       def rails3_canonical_mailer_views?(name)
         return true if mailer_files(name).empty?
         return true if mailer_files(name).none? { |filename| filename.index 'html' }
@@ -47,12 +48,12 @@ module RailsBestPractices
           mailer_files(name).any? { |filename| filename.index 'text' }
       end
 
-        # all mail view files for a method name.
+      # all mail view files for a method name.
       def mailer_files(name)
         Dir.entries(mailer_directory) { |filename| filename.index name.to_s }
       end
 
-        # the view directory of mailer.
+      # the view directory of mailer.
       def mailer_directory
         File.join(Core::Runner.base_path, "app/views/#{@klazz_name.to_s.underscore}")
       end

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -49,8 +49,8 @@ module RailsBestPractices
 
       private
 
-        # check a command node, if it is a callback definition, such as after_create, before_create,
-        # then save the callback methods in @callbacks
+      # check a command node, if it is a callback definition, such as after_create, before_create,
+      # then save the callback methods in @callbacks
       def remember_callback(node)
         if node.message.to_s =~ /^after_|^before_/
           node.arguments.all.each do |argument|
@@ -60,21 +60,21 @@ module RailsBestPractices
         end
       end
 
-        # check a defn node to see if the method name exists in the @callbacks.
+      # check a defn node to see if the method name exists in the @callbacks.
       def callback_method?(node)
         @callbacks.find { |callback| callback == node.method_name.to_s }
       end
 
-        # check a def node to see if it contains a actionmailer deliver call.
-        #
-        # 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.
+      # check a def node to see if it contains a actionmailer deliver call.
+      #
+      # 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|
           if child_node.message.to_s == 'deliver'
             if child_node.receiver.sexp_type == :method_add_arg &&
-               mailers.include?(child_node.receiver[1].receiver.to_s)
+                 mailers.include?(child_node.receiver[1].receiver.to_s)
               return true
             end
           end

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -34,11 +34,12 @@ module RailsBestPractices
       #
       # then the call node can use query attribute instead.
       add_callback :start_if, :start_unless, :start_elsif, :start_ifop, :start_if_mod, :start_unless_mod do |node|
-        all_conditions = if node.conditional_statement == node.conditional_statement.all_conditions
-                           [node.conditional_statement]
-                         else
-                           node.conditional_statement.all_conditions
-        end
+        all_conditions =
+          if node.conditional_statement == node.conditional_statement.all_conditions
+            [node.conditional_statement]
+          else
+            node.conditional_statement.all_conditions
+          end
         all_conditions.each do |condition_node|
           next unless query_attribute_node = query_attribute_node(condition_node)
 
@@ -51,13 +52,13 @@ module RailsBestPractices
 
       private
 
-        # recursively check conditional statement nodes to see if there is a call node that may be
-        # possible query attribute.
+      # recursively check conditional statement nodes to see if there is a call node that may be
+      # possible query attribute.
       def query_attribute_node(conditional_statement_node)
         case conditional_statement_node.sexp_type
         when :and, :or
-          node = query_attribute_node(conditional_statement_node[1]) ||
-                 query_attribute_node(conditional_statement_node[2])
+          node =
+            query_attribute_node(conditional_statement_node[1]) || query_attribute_node(conditional_statement_node[2])
           node.file = conditional_statement_code.file
           return node
         when :not
@@ -71,17 +72,17 @@ module RailsBestPractices
         nil
       end
 
-        # check if the node may use query attribute instead.
-        #
-        # if the node contains two method calls, e.g. @user.login.nil?
-        #
-        # for the first call, the receiver should be one of the class names and
-        # the message should be one of the attribute name.
-        #
-        # for the second call, the message should be one of nil?, blank? or present? or
-        # it is compared with an empty string.
-        #
-        # the node that may use query attribute.
+      # check if the node may use query attribute instead.
+      #
+      # if the node contains two method calls, e.g. @user.login.nil?
+      #
+      # for the first call, the receiver should be one of the class names and
+      # the message should be one of the attribute name.
+      #
+      # for the second call, the message should be one of nil?, blank? or present? or
+      # it is compared with an empty string.
+      #
+      # the node that may use query attribute.
       def possible_query_attribute?(node)
         return false unless node.receiver.sexp_type == :call
 
@@ -92,7 +93,7 @@ module RailsBestPractices
           (QUERY_METHODS.include?(node.message.to_s) || compare_with_empty_string?(node))
       end
 
-        # check if the receiver is one of the models.
+      # check if the receiver is one of the models.
       def is_model?(variable_node)
         return false if variable_node.const?
 
@@ -100,18 +101,17 @@ module RailsBestPractices
         models.include?(class_name)
       end
 
-        # check if the receiver and message is one of the model's attribute.
-        # the receiver should match one of the class model name, and the message should match one of attribute name.
+      # check if the receiver and message is one of the model's attribute.
+      # the receiver should match one of the class model name, and the message should match one of attribute name.
       def model_attribute?(variable_node, message)
         class_name = variable_node.to_s.sub(/^@/, '').classify
         attribute_type = model_attributes.get_attribute_type(class_name, message)
         attribute_type && !%w[integer float].include?(attribute_type)
       end
 
-        # check if the node is with node type :binary, node message :== and node argument is empty string.
+      # check if the node is with node type :binary, node message :== and node argument is empty string.
       def compare_with_empty_string?(node)
-        node.sexp_type == :binary &&
-          ['==', '!='].include?(node.message.to_s) &&
+        node.sexp_type == :binary && ['==', '!='].include?(node.message.to_s) &&
           s(:string_literal, s(:string_content)) == node.argument
       end
     end

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -31,13 +31,14 @@ module RailsBestPractices
         node.body.statements.each do |child_node|
           next if child_node.grep_nodes_count(sexp_type: %i[fcall command], message: WITH_SAY_METHODS) > 0
 
-          receiver_node = if child_node.sexp_type == :method_add_block
-                            child_node[1]
-                          elsif child_node.sexp_type == :method_add_arg
-                            child_node[1]
-                          else
-                            child_node
-                         end
+          receiver_node =
+            if child_node.sexp_type == :method_add_block
+              child_node[1]
+            elsif child_node.sexp_type == :method_add_arg
+              child_node[1]
+            else
+              child_node
+            end
           if receiver_node.sexp_type == :call
             add_error('use say with time in migrations', node.file, child_node.line_number)
           end

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -30,25 +30,27 @@ module RailsBestPractices
 
       private
 
-        # check a if node to see
-        #
-        # if the conditional statement is compared with current_user or current_user.id,
-        # and there is a redirect_to method call in the block body,
-        # then it should be replaced by using scope access.
+      # check a if node to see
+      #
+      # if the conditional statement is compared with current_user or current_user.id,
+      # and there is a redirect_to method call in the block body,
+      # then it should be replaced by using scope access.
       def current_user_redirect?(node)
-        all_conditions = if node.conditional_statement == node.conditional_statement.all_conditions
-                           [node.conditional_statement]
-                         else
-                           node.conditional_statement.all_conditions
-        end
-        results = all_conditions.map do |condition_node|
-          ['==', '!='].include?(condition_node.message.to_s) &&
-            (current_user?(condition_node.argument) || current_user?(condition_node.receiver))
-        end
+        all_conditions =
+          if node.conditional_statement == node.conditional_statement.all_conditions
+            [node.conditional_statement]
+          else
+            node.conditional_statement.all_conditions
+          end
+        results =
+          all_conditions.map do |condition_node|
+            ['==', '!='].include?(condition_node.message.to_s) &&
+              (current_user?(condition_node.argument) || current_user?(condition_node.receiver))
+          end
         results.any? { |result| result == true } && node.body.grep_node(message: 'redirect_to')
       end
 
-        # check a call node to see if it uses current_user, or current_user.id.
+      # check a call node to see if it uses current_user, or current_user.id.
       def current_user?(node)
         node.to_s == 'current_user' || (node.receiver.to_s == 'current_user' && node.message.to_s == 'id')
       end

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -18,7 +18,8 @@ module RailsBestPractices
       # check command node to see if load 'deploy/assets'
       add_callback :start_command do |node|
         if Prepares.gems.gem_version('rails').to_i == 3
-          if !Prepares.gems.has_gem?('turbo-sprockets-rails3') && node.message.to_s == 'load' && node.arguments.to_s == 'deploy/assets'
+          if !Prepares.gems.has_gem?('turbo-sprockets-rails3') && node.message.to_s == 'load' &&
+               node.arguments.to_s == 'deploy/assets'
             add_error 'speed up assets precompile with turbo-sprockets-rails3'
           end
         end

data/lib/rails_best_practices/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBestPractices
-  VERSION = '1.20.0'
+  VERSION = '1.22.1'
 end

data/lib/rails_best_practices.rb

@@ -8,8 +8,8 @@ require 'rails_best_practices/analyzer'
 require 'rails_best_practices/lexicals'
 require 'rails_best_practices/prepares'
 require 'rails_best_practices/reviews'
+require 'rails_best_practices/inline_disables'
 require 'rails_best_practices/option_parser'
 require 'rails_best_practices/cli'
 
-module RailsBestPractices
-end
+module RailsBestPractices; end

data/rails_best_practices.gemspec

@@ -1,43 +1,44 @@
 # frozen_string_literal: true
 
-require File.expand_path('lib/rails_best_practices/version', __dir__)
-
-Gem::Specification.new do |s|
-  s.name        = 'rails_best_practices'
-  s.version     = RailsBestPractices::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Richard Huang']
-  s.email       = ['flyerhzm@gmail.com']
-  s.homepage    = 'http://rails-bestpractices.com'
-  s.summary     = 'a code metric tool for rails codes.'
-  s.description = 'a code metric tool for rails codes, written in Ruby.'
-  s.license     = 'MIT'
-
-  s.required_ruby_version = '>= 1.9.0'
-  s.required_rubygems_version = '>= 1.3.6'
-
-  s.add_dependency('activesupport')
-  # TODO: add a dependency for Rails >= 3 ?
-  s.add_dependency('code_analyzer', '>= 0.5.1')
-  s.add_dependency('erubis')
-  s.add_dependency('i18n')
-  s.add_dependency('json')
-  s.add_dependency('require_all', '~> 3.0')
-  s.add_dependency('ruby-progressbar')
-
-  s.add_development_dependency('awesome_print')
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('haml')
-  s.add_development_dependency('rake')
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('slim')
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  s.require_paths = %w[lib assets]
-
-  s.post_install_message = <<~POST_INSTALL_MESSAGE
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_best_practices/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rails_best_practices'
+  spec.version     = RailsBestPractices::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Richard Huang']
+  spec.email       = ['flyerhzm@gmail.com']
+  spec.homepage    = 'http://rails-bestpractices.com'
+  spec.summary     = 'a code metric tool for rails codes.'
+  spec.description = 'a code metric tool for rails codes, written in Ruby.'
+  spec.license     = 'MIT'
+
+  spec.required_ruby_version = '>= 1.9.0'
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.add_runtime_dependency('activesupport')
+  spec.add_runtime_dependency('code_analyzer', '>= 0.5.2')
+  spec.add_runtime_dependency('erubis')
+  spec.add_runtime_dependency('i18n')
+  spec.add_runtime_dependency('json')
+  spec.add_runtime_dependency('require_all', '~> 3.0')
+  spec.add_runtime_dependency('ruby-progressbar')
+
+  spec.add_development_dependency('awesome_print')
+  spec.add_development_dependency('bundler')
+  spec.add_development_dependency('haml')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('slim')
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w[lib assets]
+
+  spec.post_install_message = <<~POST_INSTALL_MESSAGE
     #{'*' * 80}
 
       rails_best_practices is a code metric tool to check the quality of rails codes.

data/spec/fixtures/lib/rails_best_practices/plugins/reviews/not_use_rails_root_review.rb

@@ -5,8 +5,7 @@ require 'rails_best_practices/reviews/review'
 module RailsBestPractices
   module Plugins
     module Reviews
-      class NotUseRailsRootReview < RailsBestPractices::Reviews::Review
-      end
+      class NotUseRailsRootReview < RailsBestPractices::Reviews::Review; end
     end
   end
 end