rails_best_practices 1.19.1 → 1.19.2

data/lib/rails_best_practices/prepares/route_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remembber routes.
@@ -6,8 +7,8 @@ module RailsBestPractices
       interesting_nodes :command, :command_call, :method_add_block, :do_block, :brace_block
       interesting_files ROUTE_FILES
 
-      RESOURCES_ACTIONS = %w(index show new create edit update destroy)
-      RESOURCE_ACTIONS = %w(show new create edit update destroy)
+      RESOURCES_ACTIONS = %w[index show new create edit update destroy].freeze
+      RESOURCE_ACTIONS = %w[show new create edit update destroy].freeze
 
       def initialize
         @routes = Prepares.routes
@@ -40,7 +41,7 @@ module RailsBestPractices
             elsif :symbol_literal == first_argument.sexp_type && second_argument.try(:sexp_type) && \
               :symbol_literal == second_argument.sexp_type
               action_names = node.arguments.all.select \
-                {|arg| :symbol_literal == arg.sexp_type }.map(&:to_s)
+                { |arg| :symbol_literal == arg.sexp_type }.map(&:to_s)
             else
               action_names = [first_argument.to_s]
             end
@@ -173,16 +174,16 @@ module RailsBestPractices
       end
 
       # remember current controller name, used for nested resources.
-      add_callback :start_do_block, :start_brace_block do |node|
+      add_callback :start_do_block, :start_brace_block do |_node|
         @controller_names << @controller_name.try(:last)
       end
 
       # remove current controller name, and use upper lever resource name.
-      add_callback :end_do_block, :end_brace_block do |node|
+      add_callback :end_do_block, :end_brace_block do |_node|
         @controller_names.pop
       end
 
-      [:resources, :resource].each do |route_name|
+      %i[resources resource].each do |route_name|
         class_eval <<-EOF
         def add_#{route_name}_routes(node)
           resource_names = node.arguments.all.select { |argument| :symbol_literal == argument.sexp_type }

data/lib/rails_best_practices/prepares/schema_prepare.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Prepares
     # Remember the model attributes.
@@ -7,7 +8,7 @@ module RailsBestPractices
       interesting_files SCHEMA_FILE
 
       # all attribute types
-      ATTRIBUTE_TYPES = %w(integer float boolean string text date time datetime binary)
+      ATTRIBUTE_TYPES = %w[integer float boolean string text date time datetime binary].freeze
 
       def initialize
         @model_attributes = Prepares.model_attributes

data/lib/rails_best_practices/reviews.rb

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

data/lib/rails_best_practices/reviews/add_model_virtual_attribute_review.rb

@@ -1,4 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require_rel 'review'
+
 module RailsBestPractices
   module Reviews
     # Make sure to add a model virual attribute to simplify model creation.
@@ -51,7 +54,7 @@ module RailsBestPractices
           return unless :field == left_value.sexp_type && :call == right_value.sexp_type
           aref_node = right_value.grep_node(sexp_type: :aref)
           if aref_node
-            assignments(left_value.receiver.to_s) << {message: left_value.message.to_s, arguments: aref_node.to_s}
+            assignments(left_value.receiver.to_s) << { message: left_value.message.to_s, arguments: aref_node.to_s }
           end
         end
 
@@ -62,7 +65,7 @@ module RailsBestPractices
         def call_assignment(node)
           if ['save', 'save!'].include? node.message.to_s
             receiver = node.receiver.to_s
-            add_error "add model virtual attribute (for #{receiver})" if params_dup?(assignments(receiver).collect {|h| h[:arguments]})
+            add_error "add model virtual attribute (for #{receiver})" if params_dup?(assignments(receiver).collect { |h| h[:arguments] })
           end
         end
 
@@ -81,7 +84,7 @@ module RailsBestPractices
         #
         # @return [Enumerable] the duplicate entries.
         def dups(nodes)
-          nodes.inject({}) {|h,v| h[v]=h[v].to_i+1; h}.reject{|k,v| v==1}.keys
+          nodes.inject({}) { |h, v| h[v] = h[v].to_i + 1; h }.reject { |_k, v| v == 1 }.keys
         end
     end
   end

data/lib/rails_best_practices/reviews/always_add_db_index_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review db/schema.rb file to make sure every reference key has a database index.
@@ -27,7 +28,7 @@ module RailsBestPractices
       interesting_files SCHEMA_FILE
       url 'https://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/'
 
-      def initialize(options={})
+      def initialize(options = {})
         super(options)
         @index_columns = {}
         @foreign_keys = {}
@@ -39,7 +40,7 @@ module RailsBestPractices
       # if the message of command_call node is "create_table", then remember the table name.
       # if the message of command_call node is "add_index", then remember it as index columns.
       add_callback :start_command_call do |node|
-        if %w(integer string).include? node.message.to_s
+        if %w[integer string].include? node.message.to_s
           remember_foreign_key_columns(node)
         elsif 'index' == node.message.to_s
           remember_index_columns_inside_table(node)
@@ -134,7 +135,7 @@ module RailsBestPractices
 
           if foreign_id_column
             index_node = node.arguments.all.last.hash_value('index')
-            if index_node.present? and 'false' != index_node.to_s
+            if index_node.present? && ('false' != index_node.to_s)
               @index_columns[table_name] ||= []
               @index_columns[table_name] << foreign_id_column
             end
@@ -155,7 +156,7 @@ module RailsBestPractices
 
         # remove the non foreign keys with only _type column.
         def remove_only_type_foreign_keys
-          @foreign_keys.each { |table, foreign_keys|
+          @foreign_keys.each { |_table, foreign_keys|
             foreign_keys.delete_if { |key| key =~ /_type$/ }
           }
         end
@@ -163,7 +164,7 @@ module RailsBestPractices
         # combine polymorphic foreign keys, e.g.
         #     [tagger_id], [tagger_type] => [tagger_id, tagger_type]
         def combine_polymorphic_foreign_keys
-          @index_columns.each { |table, foreign_keys|
+          @index_columns.each { |_table, foreign_keys|
             foreign_id_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_id/ }
             foreign_type_keys = foreign_keys.select { |key| key.size == 1 && key.first =~ /_type/ }
             foreign_id_keys.each do |id_key|
@@ -179,7 +180,7 @@ module RailsBestPractices
         # check if the table's column is indexed.
         def not_indexed?(table, column)
           index_columns = @index_columns[table]
-          !index_columns || !index_columns.any? { |e| greater_than_or_equal(Array(e), Array(column)) }
+          !index_columns || index_columns.none? { |e| greater_than_or_equal(Array(e), Array(column)) }
         end
 
         # check if more_array is greater than less_array or equal to less_array.

data/lib/rails_best_practices/reviews/check_destroy_return_value_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review all code to make sure we either check the return value of "destroy"
@@ -22,7 +23,7 @@ module RailsBestPractices
 
       add_callback :start_binary do |node|
         # Consider anything used in an expression like "A or B" as used
-        if %w(&& || and or).include?(node[2].to_s)
+        if %w[&& || and or].include?(node[2].to_s)
           all_conditions = node.all_conditions
           # if our current binary is a subset of the @used_return_value_of
           # then don't overwrite it
@@ -33,7 +34,7 @@ module RailsBestPractices
         end
       end
 
-      def return_value_is_used? node
+      def return_value_is_used?(node)
         return false unless @used_return_value_of
         node == @used_return_value_of or @used_return_value_of.include?(node)
       end

data/lib/rails_best_practices/reviews/check_save_return_value_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review all code to make sure we either check the return value of "save", "update_attributes"
@@ -27,7 +28,7 @@ module RailsBestPractices
 
       add_callback :start_binary do |node|
         # Consider anything used in an expression like "A or B" as used
-        if %w(&& || and or).include?(node[2].to_s)
+        if %w[&& || and or].include?(node[2].to_s)
           all_conditions = node.all_conditions
           # if our current binary is a subset of the @used_return_value_of
           # then don't overwrite it
@@ -38,7 +39,7 @@ module RailsBestPractices
         end
       end
 
-      def return_value_is_used? node
+      def return_value_is_used?(node)
         return false unless @used_return_value_of
         node == @used_return_value_of or @used_return_value_of.include?(node)
       end
@@ -50,7 +51,7 @@ module RailsBestPractices
       add_callback :start_call, :start_command_call, :start_method_add_arg do |node|
         unless @already_checked == node
           message = node.message.to_s
-          if ['save', 'update_attributes'].include? message
+          if %w[save update_attributes].include? message
             unless return_value_is_used? node
               add_error "check '#{message}' return value or use '#{message}!'"
             end

data/lib/rails_best_practices/reviews/default_scope_is_evil_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review model files to make sure not use default_scope

data/lib/rails_best_practices/reviews/dry_bundler_in_capistrano_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review config/deploy.rb file to make sure using the bundler's capistrano recipe.

data/lib/rails_best_practices/reviews/hash_syntax_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Check ruby 1.8 style hash and suggest to change hash syntax to 1.9.

data/lib/rails_best_practices/reviews/isolate_seed_data_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Make sure not to insert data in migration, move them to seed file.
@@ -23,7 +24,7 @@ module RailsBestPractices
       interesting_files MIGRATION_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/'
 
-      def initialize(options={})
+      def initialize(options = {})
         super(options)
         @new_variables = []
       end

data/lib/rails_best_practices/reviews/keep_finders_on_their_own_model_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review model files to make sure finders are on their own model.
@@ -19,7 +20,7 @@ module RailsBestPractices
       interesting_files MODEL_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/'
 
-      FINDERS = %w(find all first last)
+      FINDERS = %w[find all first last].freeze
 
       # check all the call nodes to see if there is a finder for other model.
       #

data/lib/rails_best_practices/reviews/law_of_demeter_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review to make sure not to avoid the law of demeter.
@@ -18,7 +19,7 @@ module RailsBestPractices
       interesting_files ALL_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/'
 
-      ASSOCIATION_METHODS = %w(belongs_to has_one)
+      ASSOCIATION_METHODS = %w[belongs_to has_one].freeze
 
       # check the call node,
       #

data/lib/rails_best_practices/reviews/move_code_into_controller_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a view file to make sure there is no finder, finder should be moved to controller.
@@ -14,7 +15,7 @@ module RailsBestPractices
       interesting_files VIEW_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/'
 
-      FINDERS = %w(find all first last)
+      FINDERS = %w[find all first last].freeze
 
       # check method_add_arg nodes.
       #

data/lib/rails_best_practices/reviews/move_code_into_helper_review.rb

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

data/lib/rails_best_practices/reviews/move_code_into_model_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a view file to make sure there is no complex logic call for model.
@@ -15,7 +16,7 @@ module RailsBestPractices
       interesting_files VIEW_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/24/move-code-into-model/'
 
-      def initialize(options={})
+      def initialize(options = {})
         super(options)
         @use_count = options['use_count'] || 2
       end

data/lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review a controller file to make sure there are no complex finder.
@@ -17,7 +18,7 @@ module RailsBestPractices
       interesting_files CONTROLLER_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/'
 
-      FINDERS = %w(find all first last)
+      FINDERS = %w[find all first last].freeze
 
       # check method_add_ag node if its message is one of find, all, first or last,
       # and it has a hash argument,

data/lib/rails_best_practices/reviews/move_model_logic_into_model_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 logic should not exist in controller, should be moved into a model.
@@ -29,7 +30,7 @@ module RailsBestPractices
       # and the receiver is a variable,
       # then these method calls and attribute assignments should be moved into model.
       add_callback :start_def do |node|
-        node.grep_nodes(sexp_type: [:call, :assign]) do |child_node|
+        node.grep_nodes(sexp_type: %i[call assign]) do |child_node|
           remember_variable_use_count(child_node)
         end
 

data/lib/rails_best_practices/reviews/needless_deep_nesting_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review config/routes.rb file to make sure not to use too deep nesting routes.
@@ -61,16 +62,16 @@ module RailsBestPractices
         # if so, it is the needless deep nesting.
         def recursively_check(node)
           shallow = @shallow_nodes.include? node
-          if [:command_call, :command].include?(node[1].sexp_type) && ['resources', 'resource'].include?(node[1].message.to_s)
+          if %i[command_call command].include?(node[1].sexp_type) && %w[resources resource].include?(node[1].message.to_s)
             hash_node = node[1].arguments.grep_node(sexp_type: :bare_assoc_hash)
-            shallow = (hash_node && 'true' == hash_node.hash_value('shallow').to_s) unless shallow
+            shallow ||= (hash_node && 'true' == hash_node.hash_value('shallow').to_s)
             @counter += 1
             node.block_node.statements.each do |stmt_node|
               @shallow_nodes << stmt_node if shallow
               recursively_check(stmt_node)
             end
             @counter -= 1
-          elsif [:command_call, :command].include?(node.sexp_type) && ['resources', 'resource'].include?(node.message.to_s)
+          elsif %i[command_call command].include?(node.sexp_type) && %w[resources resource].include?(node.message.to_s)
             add_error "needless deep nesting (nested_count > #{@nested_count})", @file, node.line_number if @counter >= @nested_count && !@shallow_nodes.include?(node)
           end
         end

data/lib/rails_best_practices/reviews/not_rescue_exception_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review all code to make sure we don't rescue Exception

data/lib/rails_best_practices/reviews/not_use_default_route_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review config/routes file to make sure not use default route that rails generated.

data/lib/rails_best_practices/reviews/not_use_time_ago_in_words_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 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.

data/lib/rails_best_practices/reviews/overuse_route_customizations_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review config/routes.rb file to make sure there are no overuse route customizations.
@@ -19,7 +20,7 @@ module RailsBestPractices
       interesting_files ROUTE_FILES
       url 'https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/'
 
-      VERBS = %w(get post update delete)
+      VERBS = %w[get post update delete].freeze
 
       def initialize(options = {})
         super(options)

data/lib/rails_best_practices/reviews/protect_mass_assignment_review.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module RailsBestPractices
   module Reviews
     # Review model files to make sure to use attr_accessible, attr_protected or strong_parameters to protect mass assignment.
@@ -16,7 +17,7 @@ module RailsBestPractices
       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|
+      add_callback :start_class do |_node|
         @mass_assignement = true
         check_activerecord_version
         check_whitelist_attributes_config
@@ -72,7 +73,7 @@ module RailsBestPractices
         end
 
         def check_rails_builtin(node)
-          if @whitelist_attributes || [node.to_s, node.message.to_s].any? { |str| %w(attr_accessible attr_protected).include? str }
+          if @whitelist_attributes || [node.to_s, node.message.to_s].any? { |str| %w[attr_accessible attr_protected].include? str }
             @mass_assignement = false
           end
         end