rubocop-rails 2.17.4 → 2.19.0

data/lib/rubocop/cop/rails/response_parsed_body.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Prefer `response.parsed_body` to `JSON.parse(response.body)`.
+      #
+      # @safety
+      #   This cop is unsafe because Content-Type may not be `application/json`. For example, the proprietary
+      #   Content-Type provided by corporate entities such as `application/vnd.github+json` is not supported at
+      #   `response.parsed_body` by default, so you still have to use `JSON.parse(response.body)` there.
+      #
+      # @example
+      #   # bad
+      #   JSON.parse(response.body)
+      #
+      #   # good
+      #   response.parsed_body
+      class ResponseParsedBody < Base
+        extend AutoCorrector
+        extend TargetRailsVersion
+
+        MSG = 'Prefer `response.parsed_body` to `JSON.parse(response.body)`.'
+
+        RESTRICT_ON_SEND = %i[parse].freeze
+
+        minimum_target_rails_version 5.0
+
+        # @!method json_parse_response_body?(node)
+        def_node_matcher :json_parse_response_body?, <<~PATTERN
+          (send
+            (const {nil? cbase} :JSON)
+            :parse
+            (send
+              (send nil? :response)
+              :body
+            )
+          )
+        PATTERN
+
+        def on_send(node)
+          return unless json_parse_response_body?(node)
+
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, node)
+          corrector.replace(node, 'response.parsed_body')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/reversible_migration.rb

@@ -16,23 +16,15 @@ module RuboCop
       #
       #   # good
       #   def change
-      #     create_table :users do |t|
-      #       t.string :name
+      #     change_table :users do |t|
+      #       t.remove :name, :string
       #     end
       #   end
       #
       #   # good
       #   def change
-      #     reversible do |dir|
-      #       change_table :users do |t|
-      #         dir.up do
-      #           t.column :name, :string
-      #         end
-      #
-      #         dir.down do
-      #           t.remove :name
-      #         end
-      #       end
+      #     create_table :users do |t|
+      #       t.string :name
       #     end
       #   end
       #
@@ -114,21 +106,6 @@ module RuboCop
       #     end
       #   end
       #
-      #   # good
-      #   def change
-      #     reversible do |dir|
-      #       change_table :users do |t|
-      #         dir.up do
-      #           t.change :price, :string
-      #         end
-      #
-      #         dir.down do
-      #           t.change :price, :integer
-      #         end
-      #       end
-      #     end
-      #   end
-      #
       # @example
       #   # remove_columns
       #
@@ -173,8 +150,6 @@ module RuboCop
       #   def change
       #     remove_index :users, column: :email
       #   end
-      #
-      # @see https://api.rubyonrails.org/classes/ActiveRecord/Migration/CommandRecorder.html
       class ReversibleMigration < Base
         include MigrationsHelper
 

data/lib/rubocop/cop/rails/root_join_chain.rb

@@ -39,7 +39,7 @@ module RuboCop
         def on_send(node)
           evidence(node) do |rails_node, args|
             add_offense(node, message: format(MSG, root: rails_node.source)) do |corrector|
-              range = range_between(rails_node.loc.selector.end_pos, node.loc.expression.end_pos)
+              range = range_between(rails_node.loc.selector.end_pos, node.source_range.end_pos)
               replacement = ".join(#{args.map(&:source).join(', ')})"
 
               corrector.replace(range, replacement)

data/lib/rubocop/cop/rails/root_pathname_methods.rb

@@ -184,7 +184,7 @@ module RuboCop
         end
 
         def build_path_glob_replacement(path, method)
-          receiver = range_between(path.loc.expression.begin_pos, path.children.first.loc.selector.end_pos).source
+          receiver = range_between(path.source_range.begin_pos, path.children.first.loc.selector.end_pos).source
 
           argument = path.arguments.one? ? path.first_argument.source : join_arguments(path.arguments)
 

data/lib/rubocop/cop/rails/safe_navigation.rb

@@ -73,7 +73,7 @@ module RuboCop
           method = method_node.source[1..]
 
           range = if node.receiver
-                    range_between(node.loc.dot.begin_pos, node.loc.expression.end_pos)
+                    range_between(node.loc.dot.begin_pos, node.source_range.end_pos)
                   else
                     corrector.insert_before(node, 'self')
                     node

data/lib/rubocop/cop/rails/squished_sql_heredocs.rb

@@ -48,6 +48,7 @@ module RuboCop
         SQL = 'SQL'
         SQUISH = '.squish'
         MSG = 'Use `%<expect>s` instead of `%<current>s`.'
+        SQL_IDENTIFIER_MARKERS = /(".+?")|('.+?')|(\[.+?\])/.freeze
 
         def on_heredoc(node)
           return unless offense_detected?(node)
@@ -60,7 +61,7 @@ module RuboCop
         private
 
         def offense_detected?(node)
-          sql_heredoc?(node) && !using_squish?(node)
+          sql_heredoc?(node) && !using_squish?(node) && !singleline_comments_present?(node)
         end
 
         def sql_heredoc?(node)
@@ -71,6 +72,12 @@ module RuboCop
           node.parent&.send_type? && node.parent&.method?(:squish)
         end
 
+        def singleline_comments_present?(node)
+          sql = node.children.map { |c| c.is_a?(String) ? c : c.source }.join('\n')
+
+          sql.gsub(SQL_IDENTIFIER_MARKERS, '').include?('--')
+        end
+
         def message(node)
           format(MSG, expect: "#{node.source}#{SQUISH}", current: node.source)
         end

data/lib/rubocop/cop/rails/three_state_boolean_column.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Enforces that boolean columns are created with default values (`false` or `true`) and
+      # `NOT NULL` constraint.
+      #
+      # @example
+      #   # bad
+      #   add_column :users, :active, :boolean
+      #   t.column :active, :boolean
+      #   t.boolean :active
+      #
+      #   # good
+      #   add_column :users, :active, :boolean, default: true, null: false
+      #   t.column :active, :boolean, default: true, null: false
+      #   t.boolean :active, default: true, null: false
+      #
+      class ThreeStateBooleanColumn < Base
+        MSG = 'Boolean columns should always have a default value and a `NOT NULL` constraint.'
+
+        RESTRICT_ON_SEND = %i[add_column column boolean].freeze
+
+        def_node_matcher :three_state_boolean?, <<~PATTERN
+          {
+            (send nil? :add_column _ $_ {(sym :boolean) (str "boolean")} $_ ?)
+            (send !nil? :column $_ {(sym :boolean) (str "boolean")} $_ ?)
+            (send !nil? :boolean $_ $_ ?)
+          }
+        PATTERN
+
+        def_node_matcher :required_options?, <<~PATTERN
+          (hash <(pair (sym :default) !nil?) (pair (sym :null) false) ...>)
+        PATTERN
+
+        def_node_search :change_column_null?, <<~PATTERN
+          (send nil? :change_column_null {(sym %1) (str %1)} {(sym %2) (str %2)} false)
+        PATTERN
+
+        def on_send(node)
+          three_state_boolean?(node) do |column_node, options_node|
+            options_node = options_node.first
+
+            return if required_options?(options_node)
+
+            def_node = node.each_ancestor(:def, :defs).first
+            table_node = table_node(node)
+            return if def_node && change_column_null?(def_node, table_node.value, column_node.value)
+
+            add_offense(node)
+          end
+        end
+
+        private
+
+        def table_node(node)
+          case node.method_name
+          when :add_column
+            node.first_argument
+          when :column, :boolean
+            ancestor = node.each_ancestor(:block).find do |n|
+              n.method?(:create_table) || n.method?(:change_table)
+            end
+            ancestor&.send_node&.first_argument
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/time_zone.rb

@@ -70,7 +70,7 @@ module RuboCop
 
         def autocorrect(corrector, node)
           # add `.zone`: `Time.at` => `Time.zone.at`
-          corrector.insert_after(node.children[0].source_range, '.zone')
+          corrector.insert_after(node.children[0], '.zone')
 
           case node.method_name
           when :current
@@ -81,7 +81,7 @@ module RuboCop
           end
 
           # prefer `Time` over `DateTime` class
-          corrector.replace(node.children.first.source_range, 'Time') if strict?
+          corrector.replace(node.children.first, 'Time') if strict?
           remove_redundant_in_time_zone(corrector, node)
         end
 

data/lib/rubocop/cop/rails/transaction_exit_statement.rb

@@ -45,8 +45,6 @@ module RuboCop
       #     # Commit
       #     next if user.active?
       #   end
-      #
-      # @see https://github.com/rails/rails/commit/15aa4200e083
       class TransactionExitStatement < Base
         MSG = <<~MSG.chomp
           Exit statement `%<statement>s` is not allowed. Use `raise` (rollback) or `next` (commit).

data/lib/rubocop/cop/rails/unique_validation_without_index.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Rails
       # When you define a uniqueness validation in Active Record model,
-      # you also should add a unique index for the column. There are two reasons
+      # you also should add a unique index for the column. There are two reasons.
       # First, duplicated records may occur even if Active Record's validation
       # is defined.
       # Second, it will cause slow queries. The validation executes a `SELECT`

data/lib/rubocop/cop/rails/unused_ignored_columns.rb

@@ -28,12 +28,16 @@ module RuboCop
           (send self :ignored_columns= $array)
         PATTERN
 
+        def_node_matcher :appended_ignored_columns, <<~PATTERN
+          (op-asgn (send self :ignored_columns) :+ $array)
+        PATTERN
+
         def_node_matcher :column_name, <<~PATTERN
           ({str sym} $_)
         PATTERN
 
         def on_send(node)
-          return unless (columns = ignored_columns(node))
+          return unless (columns = ignored_columns(node) || appended_ignored_columns(node))
           return unless schema
 
           table = table(node)
@@ -43,6 +47,7 @@ module RuboCop
             check_column_existence(column_node, table)
           end
         end
+        alias on_op_asgn on_send
 
         private
 

data/lib/rubocop/cop/rails/validation.rb

@@ -102,7 +102,7 @@ module RuboCop
         end
 
         def correct_validate_type_for_hash(corrector, node, arguments)
-          corrector.replace(arguments.loc.expression, "#{validate_type(node)}: #{braced_options(arguments)}")
+          corrector.replace(arguments, "#{validate_type(node)}: #{braced_options(arguments)}")
         end
 
         def correct_validate_type_for_array(corrector, node, arguments, loc)

data/lib/rubocop/cop/rails/where_equals.rb

@@ -65,7 +65,7 @@ module RuboCop
         private
 
         def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
         def extract_column_and_value(template_node, value_node)

data/lib/rubocop/cop/rails/where_exists.rb

@@ -105,7 +105,7 @@ module RuboCop
           if exists_style?
             node.receiver.loc.selector.join(node.loc.selector)
           elsif where_style?
-            node.loc.selector.with(end_pos: node.loc.expression.end_pos)
+            node.loc.selector.with(end_pos: node.source_range.end_pos)
           end
         end
 

data/lib/rubocop/cop/rails/where_missing.rb

@@ -43,7 +43,7 @@ module RuboCop
             next unless root_receiver == root_receiver(where_node)
             next unless same_relationship?(where_argument, node.first_argument)
 
-            range = range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+            range = range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
             register_offense(node, where_node, where_argument, range)
             break
           end
@@ -83,9 +83,9 @@ module RuboCop
 
         def replace_range(child)
           if (right_sibling = child.right_sibling)
-            range_between(child.loc.expression.begin_pos, right_sibling.loc.expression.begin_pos)
+            range_between(child.source_range.begin_pos, right_sibling.source_range.begin_pos)
           else
-            range_between(child.left_sibling.loc.expression.end_pos, child.loc.expression.end_pos)
+            range_between(child.left_sibling.source_range.end_pos, child.source_range.end_pos)
           end
         end
 

data/lib/rubocop/cop/rails/where_not.rb

@@ -64,7 +64,7 @@ module RuboCop
         private
 
         def offense_range(node)
-          range_between(node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          range_between(node.loc.selector.begin_pos, node.source_range.end_pos)
         end
 
         def extract_column_and_value(template_node, value_node)

data/lib/rubocop/cop/rails/where_not_with_multiple_conditions.rb

@@ -32,10 +32,10 @@ module RuboCop
 
         def on_send(node)
           where_not_call?(node) do |args|
-            next unless args[0].hash_type?
+            next unless args[0]&.hash_type?
             next unless multiple_arguments_hash? args[0]
 
-            range = node.receiver.loc.selector.with(end_pos: node.loc.expression.end_pos)
+            range = node.receiver.loc.selector.with(end_pos: node.source_range.end_pos)
 
             add_offense(range)
           end

data/lib/rubocop/cop/rails_cops.rb

@@ -99,6 +99,7 @@ require_relative 'rails/render_inline'
 require_relative 'rails/render_plain_text'
 require_relative 'rails/request_referer'
 require_relative 'rails/require_dependency'
+require_relative 'rails/response_parsed_body'
 require_relative 'rails/reversible_migration'
 require_relative 'rails/reversible_migration_method_definition'
 require_relative 'rails/root_join_chain'
@@ -114,6 +115,7 @@ require_relative 'rails/skips_model_validations'
 require_relative 'rails/squished_sql_heredocs'
 require_relative 'rails/strip_heredoc'
 require_relative 'rails/table_name_assignment'
+require_relative 'rails/three_state_boolean_column'
 require_relative 'rails/time_zone'
 require_relative 'rails/time_zone_assignment'
 require_relative 'rails/to_formatted_s'

data/lib/rubocop/rails/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.17.4'
+      STRING = '2.19.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/lib/rubocop/rails.rb

@@ -5,7 +5,7 @@ module RuboCop
   module Rails
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read, permitted_classes: [Regexp, Symbol]).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
 

data/lib/rubocop-rails.rb

@@ -3,6 +3,7 @@
 require 'rubocop'
 require 'rack/utils'
 require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
 
 require_relative 'rubocop/rails'
 require_relative 'rubocop/rails/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.17.4
+  version: 2.19.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -173,6 +173,7 @@ files:
 - lib/rubocop/cop/rails/render_plain_text.rb
 - lib/rubocop/cop/rails/request_referer.rb
 - lib/rubocop/cop/rails/require_dependency.rb
+- lib/rubocop/cop/rails/response_parsed_body.rb
 - lib/rubocop/cop/rails/reversible_migration.rb
 - lib/rubocop/cop/rails/reversible_migration_method_definition.rb
 - lib/rubocop/cop/rails/root_join_chain.rb
@@ -188,6 +189,7 @@ files:
 - lib/rubocop/cop/rails/squished_sql_heredocs.rb
 - lib/rubocop/cop/rails/strip_heredoc.rb
 - lib/rubocop/cop/rails/table_name_assignment.rb
+- lib/rubocop/cop/rails/three_state_boolean_column.rb
 - lib/rubocop/cop/rails/time_zone.rb
 - lib/rubocop/cop/rails/time_zone_assignment.rb
 - lib/rubocop/cop/rails/to_formatted_s.rb
@@ -217,7 +219,7 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-rails/
   changelog_uri: https://github.com/rubocop/rubocop-rails/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.17/
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/2.19/
   bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
   rubygems_mfa_required: 'true'
 post_install_message:
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.