rails_best_practices 1.19.1 → 1.19.2

data/lib/rails_best_practices/core/mailers.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Mailer classes.

data/lib/rails_best_practices/core/methods.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Method container.
@@ -14,7 +15,7 @@ module RailsBestPractices
       # @param [String] method name
       # @param [Hash] method meta, file and line, {"file" => "app/models/post.rb", "line_number" => 5}
       # @param [String] access control, public, protected or private
-      def add_method(class_name, method_name, meta={}, access_control='public')
+      def add_method(class_name, method_name, meta = {}, access_control = 'public')
         return if class_name == ''
         return if has_method?(class_name, method_name)
         methods(class_name) << Method.new(class_name, method_name, access_control, meta)
@@ -28,7 +29,7 @@ module RailsBestPractices
       # @param [String] class name
       # @param [String] access control
       # @return [Array] all methods of a class for such access control, if access control is nil, return all public/protected/private methods
-      def get_methods(class_name, access_control=nil)
+      def get_methods(class_name, access_control = nil)
         if access_control
           methods(class_name).select { |method| method.access_control == access_control }
         else
@@ -42,7 +43,7 @@ module RailsBestPractices
       # @param [String] method name
       # @param [String] access control
       # @return [Boolean] has a method or not
-      def has_method?(class_name, method_name, access_control=nil)
+      def has_method?(class_name, method_name, access_control = nil)
         if access_control
           !!methods(class_name).find { |method| method.method_name == method_name && method.access_control == access_control }
         else
@@ -109,7 +110,7 @@ module RailsBestPractices
       # @param [String] method name
       # @param [String] access control
       # @return [Method] Method object
-      def get_method(class_name, method_name, access_control=nil)
+      def get_method(class_name, method_name, access_control = nil)
         if access_control
           methods(class_name).find { |method| method.method_name == method_name && method.access_control == access_control }
         else
@@ -121,12 +122,12 @@ module RailsBestPractices
       #
       # @param [String] access control
       # @return [Array] array of Method
-      def get_all_unused_methods(access_control=nil)
-        @methods.inject([]) { |unused_methods, (class_name, methods)|
+      def get_all_unused_methods(access_control = nil)
+        @methods.inject([]) { |unused_methods, (_class_name, methods)|
           unused_methods += if access_control
             methods.select { |method| method.access_control == access_control && !method.used }
           else
-            methods.select { |method| !method.used }
+            methods.reject { |method| method.used }
           end
         }.reject { |method| method.access_control == 'public' && @possible_methods[method.method_name] }
       end
@@ -164,8 +165,6 @@ module RailsBestPractices
       def publicize
         @access_control = 'public'
       end
-
     end
   end
 end
-

data/lib/rails_best_practices/core/model_associations.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Model associations container.
@@ -12,9 +13,9 @@ module RailsBestPractices
       # @param [String] association name
       # @param [String] association meta, has_many, has_one, belongs_to and has_and_belongs_to_many
       # @param [String] association class name
-      def add_association(model_name, association_name, association_meta, association_class=nil)
+      def add_association(model_name, association_name, association_meta, association_class = nil)
         @associations[model_name] ||= {}
-        @associations[model_name][association_name] = {'meta' => association_meta, 'class_name' => association_class || association_name.classify}
+        @associations[model_name][association_name] = { 'meta' => association_meta, 'class_name' => association_class || association_name.classify }
       end
 
       # Get a model association.
@@ -48,8 +49,8 @@ module RailsBestPractices
       # @param [String] association_name
       # @return [String] association's class name
       def get_association_class_name(table_name, association_name)
-        associations = @associations.select { |model, model_associations| model.gsub('::', '').tableize == table_name }.values.first and
-          association_meta = associations.select { |name, meta| name == association_name }.values.first and
+        associations = @associations.select { |model, _model_associations| model.gsub('::', '').tableize == table_name }.values.first and
+          association_meta = associations.select { |name, _meta| name == association_name }.values.first and
           association_meta['class_name']
       end
     end

data/lib/rails_best_practices/core/model_attributes.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Model attributes container.

data/lib/rails_best_practices/core/models.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Model classes.

data/lib/rails_best_practices/core/modules.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     # Module container

data/lib/rails_best_practices/core/routes.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Core
     class Routes < Array

data/lib/rails_best_practices/core/runner.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'yaml'
 require 'active_support/core_ext/object/blank'
 begin
@@ -45,13 +46,13 @@ module RailsBestPractices
       # @return [String] the config path
       def self.config_path
         custom_config = @config_path || File.join(Runner.base_path, 'config/rails_best_practices.yml')
-        File.exists?(custom_config) ? custom_config : RailsBestPractices::Analyzer::DEFAULT_CONFIG
+        File.exist?(custom_config) ? custom_config : RailsBestPractices::Analyzer::DEFAULT_CONFIG
       end
 
       # initialize the runner.
       #
       # @param [Hash] options pass the prepares and reviews.
-      def initialize(options={})
+      def initialize(options = {})
         @config = self.class.config_path
 
         lexicals = Array(options[:lexicals])
@@ -66,7 +67,7 @@ module RailsBestPractices
 
         @lexical_checker ||= CodeAnalyzer::CheckingVisitor::Plain.new(checkers: @lexicals)
         @plain_prepare_checker ||= CodeAnalyzer::CheckingVisitor::Plain.new(checkers: @prepares.select { |checker| checker.is_a? Prepares::GemfilePrepare })
-        @default_prepare_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @prepares.select { |checker| !checker.is_a? Prepares::GemfilePrepare })
+        @default_prepare_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @prepares.reject { |checker| checker.is_a? Prepares::GemfilePrepare })
         @review_checker ||= CodeAnalyzer::CheckingVisitor::Default.new(checkers: @reviews)
       end
 
@@ -156,7 +157,7 @@ module RailsBestPractices
 
         # load all plugin reviews.
         def load_plugin_reviews
-          begin
+          
             plugins = File.join(Runner.base_path, 'lib', 'rails_best_practices', 'plugins', 'reviews')
             if File.directory?(plugins)
               Dir[File.expand_path(File.join(plugins, '*.rb'))].each do |review|
@@ -168,7 +169,7 @@ module RailsBestPractices
                 end
               end
             end
-          end
+          
         end
     end
   end

data/lib/rails_best_practices/core_ext/erubis.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'erubis'
 
 module Erubis
   class OnlyRuby < Eruby
-    def add_preamble(src)
-    end
+    def add_preamble(src); end
 
     def add_text(src, text)
       src << text.gsub(/[^\s;]/, '')
@@ -30,7 +30,6 @@ module Erubis
       src << ';'
     end
 
-    def add_postamble(src)
-    end
+    def add_postamble(src); end
   end
 end

data/lib/rails_best_practices/lexicals.rb

@@ -1,2 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require_rel 'lexicals'

data/lib/rails_best_practices/lexicals/long_line_check.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Lexicals
     # Keep lines fewer than 80 characters.

data/lib/rails_best_practices/lexicals/remove_tab_check.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Lexicals
     # Make sure there are no tabs in files.

data/lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Lexicals
     # Make sure there are no trailing whitespace in codes.

data/lib/rails_best_practices/prepares.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require_rel 'prepares'
 
 module RailsBestPractices

data/lib/rails_best_practices/prepares/config_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember all configs
@@ -12,7 +13,7 @@ module RailsBestPractices
 
       # check assignments to config
       add_callback :start_assign do |node|
-        if node.left_value.grep_node(sexp_type: [:vcall, :var_ref], to_s: 'config').present?
+        if node.left_value.grep_node(sexp_type: %i[vcall var_ref], to_s: 'config').present?
           @configs[node.left_value.to_s] = node.right_value.to_s
         end
       end

data/lib/rails_best_practices/prepares/controller_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember controllers and controller methods
@@ -10,7 +11,7 @@ module RailsBestPractices
       interesting_nodes :class, :var_ref, :vcall, :command, :def
       interesting_files CONTROLLER_FILES
 
-      DEFAULT_ACTIONS = %w(index show new create edit update destroy)
+      DEFAULT_ACTIONS = %w[index show new create edit update destroy].freeze
 
       def initialize
         @controllers = Prepares.controllers
@@ -21,7 +22,7 @@ module RailsBestPractices
 
       # check class node to remember the class name.
       # also check if the controller is inherit from InheritedResources::Base.
-      add_callback :start_class do |node|
+      add_callback :start_class do |_node|
         @controllers << @klass
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
@@ -32,20 +33,20 @@ module RailsBestPractices
       add_callback :end_class do |node|
         if @inherited_resources && 'ApplicationController' != current_class_name
           @actions.each do |action|
-            @methods.add_method(current_class_name, action, {'file' => node.file, 'line_number' => node.line_number})
+            @methods.add_method(current_class_name, action, 'file' => node.file, 'line_number' => node.line_number)
           end
         end
       end
 
       # check if there is a DSL call inherit_resources.
-      add_callback :start_var_ref do |node|
+      add_callback :start_var_ref do |_node|
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
       end
 
       # check if there is a DSL call inherit_resources.
-      add_callback :start_vcall do |node|
+      add_callback :start_vcall do |_node|
         if @inherited_resources
           @actions = DEFAULT_ACTIONS
         end
@@ -82,14 +83,14 @@ module RailsBestPractices
       #     }
       add_callback :start_def do |node|
         method_name = node.method_name.to_s
-        @methods.add_method(current_class_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+        @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
       end
 
       # ask Reviews::RemoveUnusedMoethodsInHelperReview to check the controllers who include helpers.
       add_callback :after_check do
         descendants = @helpers.map(&:descendants).flatten
         if descendants.present?
-          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *descendants.map { |descendant| %r|#{descendant.underscore}| }
+          Reviews::RemoveUnusedMethodsInHelpersReview.interesting_files *descendants.map { |descendant| /#{descendant.underscore}/ }
         end
       end
     end

data/lib/rails_best_practices/prepares/gemfile_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember all gems in Gemfile

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember helper methods.
@@ -15,7 +16,7 @@ module RailsBestPractices
       end
 
       # check module node to remember the module name.
-      add_callback :start_module do |node|
+      add_callback :start_module do |_node|
         @helpers << Core::Mod.new(current_module_name, [])
       end
 
@@ -31,7 +32,7 @@ module RailsBestPractices
       add_callback :start_def do |node|
         if node.file =~ HELPER_FILES
           method_name = node.method_name.to_s
-          @methods.add_method(current_module_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+          @methods.add_method(current_module_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
         end
       end
     end

data/lib/rails_best_practices/prepares/initializer_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Check all initializers

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember the mailer names.
@@ -16,7 +17,7 @@ module RailsBestPractices
       #
       # if it is a subclass of ActionMailer::Base,
       # then remember its class name.
-      add_callback :start_class do |node|
+      add_callback :start_class do |_node|
         if 'ActionMailer::Base' == current_extend_class_name
           @mailers << @klass
         end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember models and model associations.
@@ -9,7 +10,7 @@ module RailsBestPractices
       interesting_nodes :class, :def, :defs, :command, :alias
       interesting_files MODEL_FILES
 
-      ASSOCIATION_METHODS = %w(belongs_to has_one has_many has_and_belongs_to_many embeds_many embeds_one embedded_in many one)
+      ASSOCIATION_METHODS = %w[belongs_to has_one has_many has_and_belongs_to_many embeds_many embeds_one embedded_in many one].freeze
 
       def initialize
         @models = Prepares.models
@@ -19,7 +20,7 @@ module RailsBestPractices
       end
 
       # remember the class name.
-      add_callback :start_class do |node|
+      add_callback :start_class do |_node|
         if 'ActionMailer::Base' != current_extend_class_name
           @models << @klass
         end
@@ -42,7 +43,7 @@ module RailsBestPractices
             'ActionMailer::Base' != current_extend_class_name &&
             (classable_modules.empty? || klasses.any?)
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
         end
       end
 
@@ -61,7 +62,7 @@ module RailsBestPractices
       add_callback :start_defs do |node|
         if @klass && 'ActionMailer::Base' != current_extend_class_name
           method_name = node.method_name.to_s
-          @methods.add_method(current_class_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
         end
       end
 
@@ -78,13 +79,13 @@ module RailsBestPractices
       #     }
       add_callback :start_command do |node|
         case node.message.to_s
-        when *%w(named_scope scope alias_method)
+        when 'named_scope', 'scope', 'alias_method'
           method_name = node.arguments.all.first.to_s
-          @methods.add_method(current_class_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+          @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
         when 'alias_method_chain'
           method, feature = *node.arguments.all.map(&:to_s)
-          @methods.add_method(current_class_name, "#{method}_with_#{feature}", {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
-          @methods.add_method(current_class_name, "#{method}", {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+          @methods.add_method(current_class_name, "#{method}_with_#{feature}", { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
+          @methods.add_method(current_class_name, method.to_s, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
         when 'field'
           arguments = node.arguments.all
           attribute_name = arguments.first.to_s
@@ -95,20 +96,19 @@ module RailsBestPractices
           @model_attributes.add_attribute(current_class_name, attribute_name, attribute_type)
         when *ASSOCIATION_METHODS
           remember_association(node)
-        else
         end
       end
 
       # check alias node to remembr the alias methods.
       add_callback :start_alias do |node|
         method_name = node.new_method.to_s
-        @methods.add_method(current_class_name, method_name, {'file' => node.file, 'line_number' => node.line_number}, current_access_control)
+        @methods.add_method(current_class_name, method_name, { 'file' => node.file, 'line_number' => node.line_number }, current_access_control)
       end
 
       # after prepare process, fix incorrect associations' class_name.
       add_callback :after_check do
         @model_associations.each do |model, model_associations|
-          model_associations.each do |association_name, association_meta|
+          model_associations.each do |_association_name, association_meta|
             unless @models.include?(association_meta['class_name'])
               if @models.include?("#{model}::#{association_meta['class_name']}")
                 association_meta['class_name'] = "#{model}::#{association_meta['class_name']}"