rails_best_practices 1.19.1 → 1.19.2

data/lib/rails_best_practices/reviews/remove_empty_helpers_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a helper file to make sure it is not an empty moduel.

data/lib/rails_best_practices/reviews/remove_unused_methods_in_controllers_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Find out unused methods in controllers.
@@ -20,9 +21,9 @@ module RailsBestPractices
       interesting_nodes :class, :command, :method_add_arg, :assign
       interesting_files CONTROLLER_FILES, VIEW_FILES, HELPER_FILES
 
-      INHERITED_RESOURCES_METHODS = %w(resource collection begin_of_association_chain build_resource)
+      INHERITED_RESOURCES_METHODS = %w[resource collection begin_of_association_chain build_resource].freeze
 
-      def initialize(options={})
+      def initialize(options = {})
         super
         @controller_methods = Prepares.controller_methods
         @routes = Prepares.routes
@@ -30,7 +31,7 @@ module RailsBestPractices
       end
 
       # mark custom inherited_resources methods as used.
-      add_callback :end_class do |node|
+      add_callback :end_class do |_node|
         if @inherited_resources
           INHERITED_RESOURCES_METHODS.each do |method|
             call_method(method)
@@ -40,14 +41,14 @@ module RailsBestPractices
 
       # skip render and around_filter nodes for start_command callbacks.
       def skip_command_callback_nodes
-        %w(render_cell render around_filter)
+        %w[render_cell render around_filter]
       end
 
       # mark corresponding action as used for cells' render and render_call.
       add_callback :start_command, :start_method_add_arg do |node|
         case node.message.to_s
         when 'render_cell'
-          controller_name, action_name, _ = *node.arguments.all.map(&:to_s)
+          controller_name, action_name, = *node.arguments.all.map(&:to_s)
           call_method(action_name, "#{controller_name}_cell".classify)
         when 'render'
           first_argument = node.arguments.all.first
@@ -93,7 +94,7 @@ module RailsBestPractices
           end
         end
         @controller_methods.get_all_unused_methods.each do |method|
-          if !excepted?(method)
+          unless excepted?(method)
             add_error "remove unused methods (#{method.class_name}##{method.method_name})", method.file, method.line_number
           end
         end
@@ -106,11 +107,11 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(rescue_action default_url_options).map { |method_name| "*\##{method_name}" } +
-            %w(Devise::OmniauthCallbacksController).map { |controller_name| "#{controller_name}#*" }
+          %w[rescue_action default_url_options].map { |method_name| "*\##{method_name}" } +
+            %w[Devise::OmniauthCallbacksController].map { |controller_name| "#{controller_name}#*" }
         end
 
-        def mark_publicize(method_name, class_name=current_class_name)
+        def mark_publicize(method_name, class_name = current_class_name)
           @controller_methods.mark_publicize(class_name, method_name)
           @controller_methods.mark_parent_class_methods_publicize(class_name, method_name)
         end

data/lib/rails_best_practices/reviews/remove_unused_methods_in_helpers_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Find out unused methods in helpers.
@@ -16,7 +17,7 @@ module RailsBestPractices
 
       interesting_files HELPER_FILES, VIEW_FILES, CONTROLLER_FILES
 
-      def initialize(options={})
+      def initialize(options = {})
         super
         @helper_methods = Prepares.helper_methods
         self.class.interesting_files Prepares.helpers.map(&:descendants)
@@ -25,7 +26,7 @@ module RailsBestPractices
       # get all unused methods at the end of review process
       add_callback :after_check do
         @helper_methods.get_all_unused_methods.each do |method|
-          if !excepted?(method)
+          unless 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

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Find out unused methods in models.
@@ -17,14 +18,14 @@ module RailsBestPractices
       interesting_nodes :command, :command_call, :method_add_arg
       interesting_files ALL_FILES
 
-      def initialize(options={})
+      def initialize(options = {})
         super
         @model_methods = Prepares.model_methods
       end
 
       # skip scope and validate nodes for start_command callbacks.
       def skip_command_callback_nodes
-        %w(named_scope scope validate validate_on_create validate_on_update)
+        %w[named_scope scope validate validate_on_create validate_on_update]
       end
 
       # mark validate methods as used.
@@ -92,7 +93,7 @@ module RailsBestPractices
         end
 
         def internal_except_methods
-          %w(
+          %w[
             initialize
             validate validate_each validate_on_create validate_on_update
             human_attribute_name assign_attributes attributes attribute
@@ -101,7 +102,7 @@ module RailsBestPractices
             after_update after_destroy after_find after_initialize
             method_missing
             table_name module_prefix
-          ).map { |method_name| "*\##{method_name}" }
+          ].map { |method_name| "*\##{method_name}" }
         end
     end
   end

data/lib/rails_best_practices/reviews/replace_complex_creation_with_factory_method_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a controller file to make sure that complex model creation should not exist in
@@ -41,7 +42,6 @@ module RailsBestPractices
             end
           when :call
             check_variable_save(child_node)
-          else
           end
         end
         reset_variable_use_count

data/lib/rails_best_practices/reviews/replace_instance_variable_with_local_variable_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a partail view file to make sure there is no instance variable.

data/lib/rails_best_practices/reviews/restrict_auto_generated_routes_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a route file to make sure all auto-generated routes have corresponding actions in controller.
@@ -19,9 +20,9 @@ module RailsBestPractices
 
       def resource_methods
         if Prepares.configs['config.api_only']
-          %w(show create update destroy)
+          %w[show create update destroy]
         else
-          %w(show new create edit update destroy)
+          %w[show new create edit update destroy]
         end
       end
 
@@ -29,7 +30,7 @@ module RailsBestPractices
         resource_methods + ['index']
       end
 
-      def initialize(options={})
+      def initialize(options = {})
         super(options)
         @namespaces = []
         @resource_controllers = []
@@ -69,7 +70,6 @@ module RailsBestPractices
           if check_method_add_block?(node) && (mod = module_option(node))
             @namespaces << mod
           end
-        else
         end
       end
 
@@ -109,7 +109,7 @@ module RailsBestPractices
         def controller_name(node)
           if option_with_hash(node)
             option_node = node.arguments.all[1]
-            if hash_key_exist?(option_node,'controller')
+            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
@@ -122,7 +122,7 @@ module RailsBestPractices
 
         # get the class name with namespace.
         def namespaced_class_name(name)
-          class_name = "#{name.split("/").map(&:camelize).join("::")}Controller"
+          class_name = "#{name.split('/').map(&:camelize).join('::')}Controller"
           if @namespaces.empty?
             class_name
           else
@@ -138,7 +138,7 @@ module RailsBestPractices
             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(', ')}]"
+                               "except: [#{(methods.map { |meth| ':' + meth } - only_methods).join(', ')}]"
                              else
                                "only: [#{only_methods.join(', ')}]"
                              end

data/lib/rails_best_practices/reviews/review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # A Review class that takes charge of reviewing one rails best practice.
@@ -31,10 +32,10 @@ module RailsBestPractices
 
       # find variable in the call or field node.
       def variable(node)
-        while [:call, :field, :method_add_arg, :method_add_block].include?(node.receiver.sexp_type)
+        while %i[call field method_add_arg method_add_block].include?(node.receiver.sexp_type)
           node = node.receiver
         end
-        return if [:fcall, :hash].include?(node.receiver.sexp_type)
+        return if %i[fcall hash].include?(node.receiver.sexp_type)
         node.receiver
       end
 

data/lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a controller file to make sure using simplified syntax for render.

data/lib/rails_best_practices/reviews/simplify_render_in_views_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a view file to make sure using simplified syntax for render.
@@ -15,7 +16,7 @@ module RailsBestPractices
       interesting_files VIEW_FILES
       url 'https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/'
 
-      VALID_KEYS = %w(object collection locals)
+      VALID_KEYS = %w[object collection locals].freeze
 
       # check command node in view file,
       # if its message is render and the arguments contain a key partial,

data/lib/rails_best_practices/reviews/use_before_filter_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a controller file to make sure to use before_filter to remove duplicated first code
@@ -30,12 +31,12 @@ module RailsBestPractices
         @first_sentences = {}
 
         node.body.statements.each do |statement_node|
-          var_ref_or_vcall_included = [:var_ref, :vcall].include?(statement_node.sexp_type)
-          private_or_protected_included = ['protected', 'private'].include?(statement_node.to_s)
+          var_ref_or_vcall_included = %i[var_ref vcall].include?(statement_node.sexp_type)
+          private_or_protected_included = %w[protected private].include?(statement_node.to_s)
           break if var_ref_or_vcall_included && private_or_protected_included
           remember_first_sentence(statement_node) if :def == statement_node.sexp_type
         end
-        @first_sentences.each do |first_sentence, def_nodes|
+        @first_sentences.each do |_first_sentence, def_nodes|
           if def_nodes.size > @customize_count
             add_error "use before_filter for #{def_nodes.map { |node| node.method_name.to_s }.join(',')}",
                       node.file,

data/lib/rails_best_practices/reviews/use_model_association_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # review a controller file to make sure to use model association instead of foreign key id assignment.
@@ -35,7 +36,6 @@ module RailsBestPractices
             attribute_assignment(child)
           when :call
             call_assignment(child)
-          else
           end
         end
         @assignments = nil

data/lib/rails_best_practices/reviews/use_multipart_alternative_as_content_type_of_email_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Make sure to use multipart/alternative as content_type of email.
@@ -23,7 +24,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 !rails3_canonical_mailer_views?(name)
+        unless rails3_canonical_mailer_views?(name)
           add_error('use multipart/alternative as content_type of email')
         end
       end
@@ -33,14 +34,13 @@ module RailsBestPractices
         # check if rails's syntax mailer views are canonical.
         #
         # @param [String] name method name in action_mailer
-        def rails_canonical_mailer_views?(name)
-        end
+        def rails_canonical_mailer_views?(name); end
 
         # 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).length == 0
+          return true if mailer_files(name).empty?
           return true if mailer_files(name).none? { |filename| filename.index 'html' }
           mailer_files(name).any? { |filename| filename.index 'html' } &&
             mailer_files(name).any? { |filename| filename.index 'text' }

data/lib/rails_best_practices/reviews/use_observer_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Make sure to use observer (sorry we only check the mailer deliver now).

data/lib/rails_best_practices/reviews/use_parentheses_in_method_def_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Check if method definition has parentheses around parameters.

data/lib/rails_best_practices/reviews/use_query_attribute_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Make sure to use query attribute instead of nil?, blank? and present?.
@@ -18,7 +19,7 @@ module RailsBestPractices
       interesting_files ALL_FILES
       url 'https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/'
 
-      QUERY_METHODS = %w(nil? blank? present?)
+      QUERY_METHODS = %w[nil? blank? present?].freeze
 
       # check if node to see whose conditional statement nodes contain nodes that can use query attribute instead.
       #
@@ -102,7 +103,7 @@ module RailsBestPractices
         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 && !['integer', 'float'].include?(attribute_type)
+          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.

data/lib/rails_best_practices/reviews/use_say_with_time_in_migrations_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a migration file to make sure to use say or say_with_time for customized data changes
@@ -18,7 +19,7 @@ module RailsBestPractices
       interesting_files MIGRATION_FILES
       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)
+      WITH_SAY_METHODS = %w[say say_with_time].freeze
 
       # check a class method define node to see if there are method calls that need to be wrapped by say
       # or say_with_time.
@@ -28,7 +29,7 @@ module RailsBestPractices
       # then such method call should be wrapped by say or say_with_time
       add_callback :start_defs do |node|
         node.body.statements.each do |child_node|
-          next if child_node.grep_nodes_count(sexp_type: [:fcall, :command], message: WITH_SAY_METHODS) > 0
+          next if child_node.grep_nodes_count(sexp_type: %i[fcall command], message: WITH_SAY_METHODS) > 0
 
           receiver_node = if :method_add_block == child_node.sexp_type
                            child_node[1]

data/lib/rails_best_practices/reviews/use_scope_access_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a controller to make sure to use scope access instead of manually checking current_user and redirect.

data/lib/rails_best_practices/reviews/use_turbo_sprockets_rails3_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Prepare Gemfile and review Capfile file to make sure using turbo-sprocket-rails3

data/lib/rails_best_practices/version.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
-  VERSION = '1.19.1'
+  VERSION = '1.19.2'.freeze
 end

data/rails_best_practices.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require File.expand_path('../lib/rails_best_practices/version', __FILE__)
 
 Gem::Specification.new do |s|
@@ -20,24 +21,24 @@ Gem::Specification.new do |s|
   s.add_dependency('code_analyzer', '>= 0.4.8')
   s.add_dependency('erubis')
   s.add_dependency('i18n')
-  s.add_dependency('require_all', '~> 1.5.0')
-  s.add_dependency('ruby-progressbar')
   s.add_dependency('json')
+  s.add_dependency('require_all', '~> 2.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', '< 11.0')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('haml')
   s.add_development_dependency('slim')
-  s.add_development_dependency('bundler')
-  s.add_development_dependency('awesome_print')
 
   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 = ['lib', 'assets']
+  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
-#{"*" * 80}
+#{'*' * 80}
 
   rails_best_practices is a code metric tool to check the quality of rails codes.
 
@@ -53,6 +54,6 @@ Gem::Specification.new do |s|
 
       Richard Huang (flyerhzm@gmail.com)
 
-#{"*" * 80}
+#{'*' * 80}
   POST_INSTALL_MESSAGE
 end