rails_best_practices 1.19.0 → 1.19.1

data/lib/rails_best_practices/core/klasses.rb

@@ -18,7 +18,7 @@ module RailsBestPractices
 
       def initialize(class_name, extend_class_name, modules)
         @modules = modules.dup
-        base = @modules.map { |modu| "#{modu}::" }.join("")
+        base = @modules.map { |modu| "#{modu}::" }.join('')
         @class_name =  base + class_name
         if extend_class_name
           @extend_class_name = base + extend_class_name

data/lib/rails_best_practices/core/methods.rb

@@ -14,11 +14,11 @@ 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")
-        return if class_name == ""
+      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)
-        if access_control == "public"
+        if access_control == 'public'
           @possible_methods[method_name] = false
         end
       end
@@ -128,7 +128,7 @@ module RailsBestPractices
           else
             methods.select { |method| !method.used }
           end
-        }.reject { |method| method.access_control == "public" && @possible_methods[method.method_name] }
+        }.reject { |method| method.access_control == 'public' && @possible_methods[method.method_name] }
       end
 
       private
@@ -149,8 +149,8 @@ module RailsBestPractices
       def initialize(class_name, method_name, access_control, meta)
         @class_name = class_name
         @method_name = method_name
-        @file = meta["file"]
-        @line_number = meta["line_number"]
+        @file = meta['file']
+        @line_number = meta['line_number']
         @access_control = access_control
         @used = false
       end
@@ -162,7 +162,7 @@ module RailsBestPractices
 
       # Mark the method as public
       def publicize
-        @access_control = "public"
+        @access_control = 'public'
       end
 
     end

data/lib/rails_best_practices/core/model_associations.rb

@@ -14,7 +14,7 @@ module RailsBestPractices
       # @param [String] association class name
       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,9 +48,9 @@ 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
+        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"]
+          association_meta['class_name']
       end
     end
   end

data/lib/rails_best_practices/core/modules.rb

@@ -31,7 +31,7 @@ module RailsBestPractices
         if @modules.empty?
           @module_name
         else
-          @modules.map { |modu| "#{modu}::" }.join("") + @module_name
+          @modules.map { |modu| "#{modu}::" }.join('') + @module_name
         end
       end
     end

data/lib/rails_best_practices/core/routes.rb

@@ -37,9 +37,9 @@ module RailsBestPractices
 
       def controller_name_with_namespaces
         if controller_name
-          namespaces.map { |namespace| "#{namespace.camelize}::" }.join("") + "#{controller_name.camelize}Controller"
+          namespaces.map { |namespace| "#{namespace.camelize}::" }.join('') + "#{controller_name.camelize}Controller"
         else
-          namespaces.map { |namespace| namespace.camelize }.join("::") + "Controller"
+          namespaces.map(&:camelize).join('::') + 'Controller'
         end
       end
 

data/lib/rails_best_practices/core/runner.rb

@@ -30,7 +30,7 @@ module RailsBestPractices
       #
       # @return [String] the base path
       def self.base_path
-        @base_path || "."
+        @base_path || '.'
       end
 
       # set the configuration path
@@ -113,7 +113,7 @@ module RailsBestPractices
       #
       # @return [Array] all errors from lexicals and reviews
       def errors
-        @errors ||= (@reviews + @lexicals).collect {|check| check.errors}.flatten
+        @errors ||= (@reviews + @lexicals).collect(&:errors).flatten
       end
 
       private
@@ -159,7 +159,7 @@ module RailsBestPractices
           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|
+              Dir[File.expand_path(File.join(plugins, '*.rb'))].each do |review|
                 require review
               end
               if RailsBestPractices.constants.map(&:to_sym).include? :Plugins

data/lib/rails_best_practices/core_ext/erubis.rb

@@ -12,22 +12,22 @@ module Erubis
 
     def add_stmt(src, code)
       src << code
-      src << ";"
+      src << ';'
     end
 
     def add_expr_literal(src, code)
       src << code
-      src << ";"
+      src << ';'
     end
 
     def add_expr_escaped(src, code)
       src << code
-      src << ";"
+      src << ';'
     end
 
     def add_expr_debug(src, code)
       src << code
-      src << ";"
+      src << ';'
     end
 
     def add_postamble(src)

data/lib/rails_best_practices/lexicals/remove_tab_check.rb

@@ -6,7 +6,7 @@ module RailsBestPractices
     # See the best practice details here https://rails-bestpractices.com/posts/2011/07/04/remove-tab/
     class RemoveTabCheck < Core::Check
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2011/07/04/remove-tab/"
+      url 'https://rails-bestpractices.com/posts/2011/07/04/remove-tab/'
 
       # check if the content of file contains a tab.
       #
@@ -15,7 +15,7 @@ module RailsBestPractices
       def check(filename, content)
         if content =~ /\t/m
           line_no = $`.count("\n") + 1
-          add_error("remove tab, use spaces instead", filename, line_no)
+          add_error('remove tab, use spaces instead', filename, line_no)
         end
       end
     end

data/lib/rails_best_practices/lexicals/remove_trailing_whitespace_check.rb

@@ -6,7 +6,7 @@ module RailsBestPractices
     # See the best practice details here https://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/
     class RemoveTrailingWhitespaceCheck < Core::Check
       interesting_files ALL_FILES
-      url "https://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/"
+      url 'https://rails-bestpractices.com/posts/2010/12/02/remove-trailing-whitespace/'
 
       # check if the content of file contain a trailing whitespace.
       #
@@ -15,7 +15,7 @@ module RailsBestPractices
       def check(filename, content)
         if content =~ / +\n/m
           line_no = $`.count("\n") + 1
-          add_error("remove trailing whitespace", filename, line_no)
+          add_error('remove trailing whitespace', filename, line_no)
         end
       end
     end

data/lib/rails_best_practices/prepares/config_prepare.rb

@@ -12,7 +12,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: [: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

@@ -30,9 +30,9 @@ module RailsBestPractices
 
       # remember the action names at the end of class node if the controller is a InheritedResources.
       add_callback :end_class do |node|
-        if @inherited_resources && "ApplicationController" != current_class_name
+        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
@@ -53,14 +53,14 @@ module RailsBestPractices
 
       # restrict actions for inherited_resources
       add_callback :start_command do |node|
-        if "include" == node.message.to_s
+        if 'include' == node.message.to_s
           @helpers.add_module_descendant(node.arguments.all.first.to_s, current_class_name)
-        elsif @inherited_resources && "actions" ==  node.message.to_s
-          if "all" == node.arguments.all.first.to_s
+        elsif @inherited_resources && 'actions' ==  node.message.to_s
+          if 'all' == node.arguments.all.first.to_s
             @actions = DEFAULT_ACTIONS
             option_argument = node.arguments.all[1]
-            if option_argument && :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value("except")
-              @actions -= option_argument.hash_value("except").to_object
+            if option_argument && :bare_assoc_hash == option_argument.sexp_type && option_argument.hash_value('except')
+              @actions -= option_argument.hash_value('except').to_object
             end
           else
             @actions = node.arguments.all.map(&:to_s)
@@ -82,7 +82,7 @@ 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.

data/lib/rails_best_practices/prepares/helper_prepare.rb

@@ -31,7 +31,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

@@ -13,16 +13,16 @@ module RailsBestPractices
       # check if AR include ActiveModel::ForbiddenAttributesProtection
       add_callback :start_method_add_arg do |node|
         if include_forbidden_attributes_protection?(node)
-          @configs["railsbp.include_forbidden_attributes_protection"] = "true"
+          @configs['railsbp.include_forbidden_attributes_protection'] = 'true'
         end
       end
 
       # check if the node is
       #     ActiveRecord::Base.send(:include, ActiveModel::ForbiddenAttributesProtection)
       def include_forbidden_attributes_protection?(node)
-        "ActiveRecord::Base" == node.receiver.to_s &&
-          "send" == node.message.to_s &&
-          ["include", "ActiveModel::ForbiddenAttributesProtection"] == node.arguments.all.map(&:to_s)
+        'ActiveRecord::Base' == node.receiver.to_s &&
+          'send' == node.message.to_s &&
+          ['include', 'ActiveModel::ForbiddenAttributesProtection'] == node.arguments.all.map(&:to_s)
       end
     end
   end

data/lib/rails_best_practices/prepares/mailer_prepare.rb

@@ -17,7 +17,7 @@ module RailsBestPractices
       # if it is a subclass of ActionMailer::Base,
       # then remember its class name.
       add_callback :start_class do |node|
-        if "ActionMailer::Base" == current_extend_class_name
+        if 'ActionMailer::Base' == current_extend_class_name
           @mailers << @klass
         end
       end

data/lib/rails_best_practices/prepares/model_prepare.rb

@@ -20,7 +20,7 @@ module RailsBestPractices
 
       # remember the class name.
       add_callback :start_class do |node|
-        if "ActionMailer::Base" != current_extend_class_name
+        if 'ActionMailer::Base' != current_extend_class_name
           @models << @klass
         end
       end
@@ -39,10 +39,10 @@ module RailsBestPractices
       #     }
       add_callback :start_def do |node|
         if @klass &&
-            "ActionMailer::Base" != current_extend_class_name &&
+            '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
 
@@ -59,9 +59,9 @@ module RailsBestPractices
       #       }
       #     }
       add_callback :start_defs do |node|
-        if @klass && "ActionMailer::Base" != current_extend_class_name
+        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
 
@@ -80,17 +80,17 @@ module RailsBestPractices
         case node.message.to_s
         when *%w(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)
-        when "alias_method_chain"
+          @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)
-        when "field"
+          @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)
+        when 'field'
           arguments = node.arguments.all
           attribute_name = arguments.first.to_s
-          attribute_type = arguments.last.hash_value("type").present? ? arguments.last.hash_value("type").to_s : "String"
+          attribute_type = arguments.last.hash_value('type').present? ? arguments.last.hash_value('type').to_s : 'String'
           @model_attributes.add_attribute(current_class_name, attribute_name, attribute_type)
-        when "key"
+        when 'key'
           attribute_name, attribute_type = node.arguments.all.map(&:to_s)
           @model_attributes.add_attribute(current_class_name, attribute_name, attribute_type)
         when *ASSOCIATION_METHODS
@@ -102,18 +102,18 @@ module RailsBestPractices
       # 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|
-            unless @models.include?(association_meta["class_name"])
+            unless @models.include?(association_meta['class_name'])
               if @models.include?("#{model}::#{association_meta['class_name']}")
-                association_meta["class_name"] = "#{model}::#{association_meta['class_name']}"
-              elsif @models.include?(model.gsub(/::\w+$/, ""))
-                association_meta["class_name"] = model.gsub(/::\w+$/, "")
+                association_meta['class_name'] = "#{model}::#{association_meta['class_name']}"
+              elsif @models.include?(model.gsub(/::\w+$/, ''))
+                association_meta['class_name'] = model.gsub(/::\w+$/, '')
               end
             end
           end
@@ -127,8 +127,8 @@ module RailsBestPractices
           association_meta = node.message.to_s
           association_name = node.arguments.all.first.to_s
           arguments_node = node.arguments.all.last
-          if arguments_node.hash_value("class_name").present?
-            association_class = arguments_node.hash_value("class_name").to_s
+          if arguments_node.hash_value('class_name').present?
+            association_class = arguments_node.hash_value('class_name').to_s
           end
           association_class ||= association_name.classify
           @model_associations.add_association(current_class_name, association_name, association_meta, association_class)

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -18,11 +18,11 @@ module RailsBestPractices
       # remember route for rails3.
       add_callback :start_command do |node|
         case node.message.to_s
-        when "resources"
+        when 'resources'
           add_resources_routes(node)
-        when "resource"
+        when 'resource'
           add_resource_routes(node)
-        when "get", "post", "put", "patch", "delete"
+        when 'get', 'post', 'put', 'patch', 'delete'
           first_argument = node.arguments.all.first
           second_argument = node.arguments.all[1]
           if @controller_names.last
@@ -30,12 +30,12 @@ module RailsBestPractices
               action_names = [first_argument.hash_values.first.to_s]
             elsif :array == first_argument.sexp_type
               action_names = first_argument.array_values.map(&:to_s)
-            elsif :bare_assoc_hash == second_argument.try(:sexp_type) && second_argument.hash_value("to").present?
-              if :string_literal == second_argument.hash_value("to").sexp_type
-                controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
+            elsif :bare_assoc_hash == second_argument.try(:sexp_type) && second_argument.hash_value('to').present?
+              if :string_literal == second_argument.hash_value('to').sexp_type
+                controller_name, action_name = second_argument.hash_value('to').to_s.split('#')
                 action_names = [action_name]
               else
-                action_names = [second_argument.hash_value("to").to_s]
+                action_names = [second_argument.hash_value('to').to_s]
               end
             elsif :symbol_literal == first_argument.sexp_type && second_argument.try(:sexp_type) && \
               :symbol_literal == second_argument.sexp_type
@@ -60,11 +60,11 @@ module RailsBestPractices
                 @routes.add_route(current_namespaces, controller_name, action_node.to_s)
               end
             elsif :bare_assoc_hash == second_argument.try(:sexp_type)
-              if second_argument.hash_value("to").present?
-                controller_name, action_name = second_argument.hash_value("to").to_s.split('#')
+              if second_argument.hash_value('to').present?
+                controller_name, action_name = second_argument.hash_value('to').to_s.split('#')
               else
                 controller_name = current_controller_name
-                action_name = second_argument.hash_value("action")
+                action_name = second_argument.hash_value('action')
               end
               @routes.add_route(current_namespaces, controller_name.try(:underscore), action_name)
             else
@@ -72,14 +72,14 @@ module RailsBestPractices
               @routes.add_route(current_namespaces, controller_name.underscore, action_name)
             end
           end
-        when "match"
+        when 'match'
           options = node.arguments.all.last
           case options.sexp_type
           when :bare_assoc_hash
-            if options.hash_value("controller").present?
-              return if :regexp_literal == options.hash_value("controller").sexp_type
-              controller_name = options.hash_value("controller").to_s
-              action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
+            if options.hash_value('controller').present?
+              return if :regexp_literal == options.hash_value('controller').sexp_type
+              controller_name = options.hash_value('controller').to_s
+              action_name = options.hash_value('action').present? ? options.hash_value('action').to_s : '*'
               @routes.add_route(current_namespaces, controller_name, action_name)
             else
               route_node = options.hash_values.find { |value_node| :string_literal == value_node.sexp_type && value_node.to_s.include?('#') }
@@ -95,7 +95,7 @@ module RailsBestPractices
           else
             # do nothing
           end
-        when "root"
+        when 'root'
           options = node.arguments.all.last
           case options.sexp_type
           when :bare_assoc_hash
@@ -117,18 +117,18 @@ module RailsBestPractices
       # remember route for rails2.
       add_callback :start_command_call do |node|
         case node.message.to_s
-        when "resources"
+        when 'resources'
           add_resources_routes(node)
-        when "resource"
+        when 'resource'
           add_resource_routes(node)
-        when "namespace"
+        when 'namespace'
           # nothing to do
         else
           options = node.arguments.all.last
-          if options.hash_value("controller").present?
-            @controller_name = [:option, options.hash_value("controller").to_s]
+          if options.hash_value('controller').present?
+            @controller_name = [:option, options.hash_value('controller').to_s]
           end
-          action_name = options.hash_value("action").present? ? options.hash_value("action").to_s : "*"
+          action_name = options.hash_value('action').present? ? options.hash_value('action').to_s : '*'
           @routes.add_route(current_namespaces, current_controller_name, action_name)
         end
       end
@@ -136,22 +136,22 @@ module RailsBestPractices
       # remember the namespace.
       add_callback :start_method_add_block do |node|
         case node.message.to_s
-        when "namespace"
+        when 'namespace'
           @namespaces << node.arguments.all.first.to_s
           @controller_name = nil
-        when "scope"
-          if node.arguments.all.last.hash_value("module").present?
-            @namespaces << node.arguments.all.last.hash_value("module").to_s
+        when 'scope'
+          if node.arguments.all.last.hash_value('module').present?
+            @namespaces << node.arguments.all.last.hash_value('module').to_s
           end
-          if node.arguments.all.last.hash_value("controller").present?
-            @controller_name = [:scope, node.arguments.all.last.hash_value("controller").to_s]
+          if node.arguments.all.last.hash_value('controller').present?
+            @controller_name = [:scope, node.arguments.all.last.hash_value('controller').to_s]
           else
             @controller_name = @controller_name.try(:first) == :scope ? @controller_name : nil
           end
-        when "with_options"
+        when 'with_options'
           argument = node.arguments.all.last
-          if :bare_assoc_hash == argument.sexp_type && argument.hash_value("controller").present?
-            @controller_name = [:with_option, argument.hash_value("controller").to_s]
+          if :bare_assoc_hash == argument.sexp_type && argument.hash_value('controller').present?
+            @controller_name = [:with_option, argument.hash_value('controller').to_s]
           end
         else
           # do nothing
@@ -161,10 +161,10 @@ module RailsBestPractices
       # end of namespace call.
       add_callback :end_method_add_block do |node|
         case node.message.to_s
-        when "namespace"
+        when 'namespace'
           @namespaces.pop
-        when "scope"
-          if node.arguments.all.last.hash_value("module").present?
+        when 'scope'
+          if node.arguments.all.last.hash_value('module').present?
             @namespaces.pop
           end
         else