rubocop-rails 2.0.1 → 2.19.1

data/lib/rubocop/rails/schema_loader/schema.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    module SchemaLoader
+      # Represent db/schema.rb
+      class Schema
+        attr_reader :tables, :add_indices
+
+        def initialize(ast)
+          @tables = []
+          @add_indices = []
+
+          build!(ast)
+        end
+
+        def table_by(name:)
+          tables.find do |table|
+            table.name == name
+          end
+        end
+
+        def add_indices_by(table_name:)
+          add_indices.select do |add_index|
+            add_index.table_name == table_name
+          end
+        end
+
+        private
+
+        def build!(ast)
+          raise "Unexpected type: #{ast.type}" unless ast.block_type?
+
+          each_table(ast) do |table_def|
+            next unless table_def.method?(:create_table)
+
+            @tables << Table.new(table_def)
+          end
+
+          # Compatibility for Rails 4.2.
+          each_add_index(ast) do |add_index_def|
+            @add_indices << AddIndex.new(add_index_def)
+          end
+        end
+
+        def each_table(ast)
+          case ast.body.type
+          when :begin
+            ast.body.children.each do |node|
+              next unless node.block_type? && node.method?(:create_table)
+
+              yield(node)
+            end
+          else
+            yield ast.body
+          end
+        end
+
+        def each_add_index(ast)
+          ast.body.children.each do |node|
+            next unless node.respond_to?(:send_type?)
+            next if !node&.send_type? || !node.method?(:add_index)
+
+            yield(node)
+          end
+        end
+      end
+
+      # Represent a table
+      class Table
+        attr_reader :name, :columns, :indices
+
+        def initialize(node)
+          @name = node.send_node.first_argument.value
+          @columns = build_columns(node)
+          @indices = build_indices(node)
+        end
+
+        def with_column?(name:)
+          @columns.any? { |c| c.name == name }
+        end
+
+        private
+
+        def build_columns(node)
+          each_content(node).map do |child|
+            next unless child&.send_type?
+            next if child.method?(:index)
+
+            Column.new(child)
+          end.compact
+        end
+
+        def build_indices(node)
+          each_content(node).map do |child|
+            next unless child&.send_type?
+            next unless child.method?(:index)
+
+            Index.new(child)
+          end.compact
+        end
+
+        def each_content(node, &block)
+          return enum_for(__method__, node) unless block
+
+          case node.body&.type
+          when :begin
+            node.body.children.each(&block)
+          else
+            yield(node.body)
+          end
+        end
+      end
+
+      # Represent a column
+      class Column
+        attr_reader :name, :type, :not_null
+
+        def initialize(node)
+          @name = node.first_argument.str_content
+          @type = node.method_name
+          @not_null = nil
+
+          analyze_keywords!(node)
+        end
+
+        private
+
+        def analyze_keywords!(node)
+          pairs = node.arguments.last
+          return unless pairs.hash_type?
+
+          pairs.each_pair do |k, v|
+            @not_null = !v.true_type? if k.value == :null
+          end
+        end
+      end
+
+      # Represent an index
+      class Index
+        attr_reader :name, :columns, :expression, :unique
+
+        def initialize(node)
+          @columns, @expression = build_columns_or_expr(node.first_argument)
+          @unique = nil
+
+          analyze_keywords!(node)
+        end
+
+        private
+
+        def build_columns_or_expr(columns)
+          if columns.array_type?
+            [columns.values.map(&:value), nil]
+          else
+            [[], columns.value]
+          end
+        end
+
+        def analyze_keywords!(node)
+          pairs = node.arguments.last
+          return unless pairs.hash_type?
+
+          pairs.each_pair do |k, v|
+            case k.value
+            when :name
+              @name = v.value
+            when :unique
+              @unique = true
+            end
+          end
+        end
+      end
+
+      # Represent an `add_index`
+      class AddIndex < Index
+        attr_reader :table_name
+
+        def initialize(node)
+          super(node)
+
+          @table_name = node.first_argument.value
+          @columns, @expression = build_columns_or_expr(node.arguments[1])
+          @unique = nil
+
+          analyze_keywords!(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/rails/schema_loader.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    # It loads db/schema.rb and return Schema object.
+    # Cops refers database schema information with this module.
+    module SchemaLoader
+      extend self
+
+      # It parses `db/schema.rb` and return it.
+      # It returns `nil` if it can't find `db/schema.rb`.
+      # So a cop that uses the loader should handle `nil` properly.
+      #
+      # @return [Schema, nil]
+      def load(target_ruby_version)
+        return @load if defined?(@load)
+
+        @load = load!(target_ruby_version)
+      end
+
+      def reset!
+        return unless instance_variable_defined?(:@load)
+
+        remove_instance_variable(:@load)
+      end
+
+      def db_schema_path
+        path = Pathname.pwd
+        until path.root?
+          schema_path = path.join('db/schema.rb')
+          return schema_path if schema_path.exist?
+
+          path = path.join('../').cleanpath
+        end
+
+        nil
+      end
+
+      private
+
+      def load!(target_ruby_version)
+        path = db_schema_path
+        return unless path
+
+        ast = parse(path, target_ruby_version)
+        Schema.new(ast)
+      end
+
+      def parse(path, target_ruby_version)
+        klass_name = :"Ruby#{target_ruby_version.to_s.sub('.', '')}"
+        klass = ::Parser.const_get(klass_name)
+        parser = klass.new(RuboCop::AST::Builder.new)
+
+        buffer = Parser::Source::Buffer.new(path, 1)
+        buffer.source = path.read
+
+        parser.parse(buffer)
+      end
+    end
+  end
+end

data/lib/rubocop/rails/version.rb

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

data/lib/rubocop/rails.rb

@@ -5,8 +5,10 @@ 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)
+
+    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

data/lib/rubocop-rails.rb

@@ -2,11 +2,33 @@
 
 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'
 require_relative 'rubocop/rails/inject'
+require_relative 'rubocop/rails/schema_loader'
+require_relative 'rubocop/rails/schema_loader/schema'
 
 RuboCop::Rails::Inject.defaults!
 
 require_relative 'rubocop/cop/rails_cops'
+
+RuboCop::Cop::Style::HashExcept.minimum_target_ruby_version(2.0)
+
+RuboCop::Cop::Style::MethodCallWithArgsParentheses.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::Rails::EagerEvaluationLogMessage)
+    end
+  end
+)
+
+RuboCop::Cop::Style::RedundantSelf.singleton_class.prepend(
+  Module.new do
+    def autocorrect_incompatible_with
+      super.push(RuboCop::Cop::Rails::SafeNavigation)
+    end
+  end
+)

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.19.1
 platform: ruby
 authors:
 - Bozhidar Batsov
 - Jonas Arvidsson
 - Yuji Nakayama
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2023-04-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -32,17 +46,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.70.0
+        version: 1.33.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.70.0
-description: |2
-      Automatic Rails code style checking tool.
-      A RuboCop extension focused on enforcing Rails best practices and coding conventions.
+        version: 1.33.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Automatic Rails code style checking tool.
+  A RuboCop extension focused on enforcing Rails best practices and coding conventions.
 email: rubocop@googlegroups.com
 executables: []
 extensions: []
@@ -52,76 +72,157 @@ extra_rdoc_files:
 files:
 - LICENSE.txt
 - README.md
-- bin/setup
 - config/default.yml
+- config/obsoletion.yml
 - lib/rubocop-rails.rb
+- lib/rubocop/cop/mixin/active_record_helper.rb
+- lib/rubocop/cop/mixin/active_record_migrations_helper.rb
+- lib/rubocop/cop/mixin/class_send_node_helper.rb
+- lib/rubocop/cop/mixin/enforce_superclass.rb
+- lib/rubocop/cop/mixin/index_method.rb
+- lib/rubocop/cop/mixin/migrations_helper.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
+- lib/rubocop/cop/rails/action_controller_flash_before_render.rb
+- lib/rubocop/cop/rails/action_controller_test_case.rb
 - lib/rubocop/cop/rails/action_filter.rb
+- lib/rubocop/cop/rails/action_order.rb
 - lib/rubocop/cop/rails/active_record_aliases.rb
+- lib/rubocop/cop/rails/active_record_callbacks_order.rb
 - lib/rubocop/cop/rails/active_record_override.rb
 - lib/rubocop/cop/rails/active_support_aliases.rb
+- lib/rubocop/cop/rails/active_support_on_load.rb
+- lib/rubocop/cop/rails/add_column_index.rb
+- lib/rubocop/cop/rails/after_commit_override.rb
+- lib/rubocop/cop/rails/application_controller.rb
 - lib/rubocop/cop/rails/application_job.rb
+- lib/rubocop/cop/rails/application_mailer.rb
 - lib/rubocop/cop/rails/application_record.rb
+- lib/rubocop/cop/rails/arel_star.rb
 - lib/rubocop/cop/rails/assert_not.rb
+- lib/rubocop/cop/rails/attribute_default_block_value.rb
 - lib/rubocop/cop/rails/belongs_to.rb
 - lib/rubocop/cop/rails/blank.rb
 - lib/rubocop/cop/rails/bulk_change_table.rb
+- lib/rubocop/cop/rails/compact_blank.rb
+- lib/rubocop/cop/rails/content_tag.rb
 - lib/rubocop/cop/rails/create_table_with_timestamps.rb
 - lib/rubocop/cop/rails/date.rb
+- lib/rubocop/cop/rails/default_scope.rb
 - lib/rubocop/cop/rails/delegate.rb
 - lib/rubocop/cop/rails/delegate_allow_blank.rb
+- lib/rubocop/cop/rails/deprecated_active_model_errors_methods.rb
+- lib/rubocop/cop/rails/dot_separated_keys.rb
+- lib/rubocop/cop/rails/duplicate_association.rb
+- lib/rubocop/cop/rails/duplicate_scope.rb
+- lib/rubocop/cop/rails/duration_arithmetic.rb
 - lib/rubocop/cop/rails/dynamic_find_by.rb
+- lib/rubocop/cop/rails/eager_evaluation_log_message.rb
+- lib/rubocop/cop/rails/enum_hash.rb
 - lib/rubocop/cop/rails/enum_uniqueness.rb
 - lib/rubocop/cop/rails/environment_comparison.rb
+- lib/rubocop/cop/rails/environment_variable_access.rb
 - lib/rubocop/cop/rails/exit.rb
+- lib/rubocop/cop/rails/expanded_date_range.rb
 - lib/rubocop/cop/rails/file_path.rb
 - lib/rubocop/cop/rails/find_by.rb
+- lib/rubocop/cop/rails/find_by_id.rb
 - lib/rubocop/cop/rails/find_each.rb
+- lib/rubocop/cop/rails/freeze_time.rb
 - lib/rubocop/cop/rails/has_and_belongs_to_many.rb
 - lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb
 - lib/rubocop/cop/rails/helper_instance_variable.rb
 - lib/rubocop/cop/rails/http_positional_arguments.rb
 - lib/rubocop/cop/rails/http_status.rb
+- lib/rubocop/cop/rails/i18n_lazy_lookup.rb
+- lib/rubocop/cop/rails/i18n_locale_assignment.rb
+- lib/rubocop/cop/rails/i18n_locale_texts.rb
+- lib/rubocop/cop/rails/ignored_columns_assignment.rb
 - lib/rubocop/cop/rails/ignored_skip_action_filter_option.rb
+- lib/rubocop/cop/rails/index_by.rb
+- lib/rubocop/cop/rails/index_with.rb
+- lib/rubocop/cop/rails/inquiry.rb
 - lib/rubocop/cop/rails/inverse_of.rb
 - lib/rubocop/cop/rails/lexically_scoped_action_filter.rb
 - lib/rubocop/cop/rails/link_to_blank.rb
+- lib/rubocop/cop/rails/mailer_name.rb
+- lib/rubocop/cop/rails/match_route.rb
+- lib/rubocop/cop/rails/migration_class_name.rb
+- lib/rubocop/cop/rails/negate_include.rb
 - lib/rubocop/cop/rails/not_null_column.rb
+- lib/rubocop/cop/rails/order_by_id.rb
 - lib/rubocop/cop/rails/output.rb
 - lib/rubocop/cop/rails/output_safety.rb
+- lib/rubocop/cop/rails/pick.rb
+- lib/rubocop/cop/rails/pluck.rb
+- lib/rubocop/cop/rails/pluck_id.rb
+- lib/rubocop/cop/rails/pluck_in_where.rb
 - lib/rubocop/cop/rails/pluralization_grammar.rb
 - lib/rubocop/cop/rails/presence.rb
 - lib/rubocop/cop/rails/present.rb
+- lib/rubocop/cop/rails/rake_environment.rb
 - lib/rubocop/cop/rails/read_write_attribute.rb
 - lib/rubocop/cop/rails/redundant_allow_nil.rb
+- lib/rubocop/cop/rails/redundant_foreign_key.rb
+- lib/rubocop/cop/rails/redundant_presence_validation_on_belongs_to.rb
 - lib/rubocop/cop/rails/redundant_receiver_in_with_options.rb
+- lib/rubocop/cop/rails/redundant_travel_back.rb
 - lib/rubocop/cop/rails/reflection_class_name.rb
 - lib/rubocop/cop/rails/refute_methods.rb
 - lib/rubocop/cop/rails/relative_date_constant.rb
+- lib/rubocop/cop/rails/render_inline.rb
+- 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
+- lib/rubocop/cop/rails/root_pathname_methods.rb
+- lib/rubocop/cop/rails/root_public_path.rb
 - lib/rubocop/cop/rails/safe_navigation.rb
+- lib/rubocop/cop/rails/safe_navigation_with_blank.rb
 - lib/rubocop/cop/rails/save_bang.rb
+- lib/rubocop/cop/rails/schema_comment.rb
 - lib/rubocop/cop/rails/scope_args.rb
+- lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
+- 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
+- lib/rubocop/cop/rails/to_s_with_argument.rb
+- lib/rubocop/cop/rails/top_level_hash_with_indifferent_access.rb
+- lib/rubocop/cop/rails/transaction_exit_statement.rb
 - lib/rubocop/cop/rails/uniq_before_pluck.rb
+- lib/rubocop/cop/rails/unique_validation_without_index.rb
 - lib/rubocop/cop/rails/unknown_env.rb
+- lib/rubocop/cop/rails/unused_ignored_columns.rb
 - lib/rubocop/cop/rails/validation.rb
+- lib/rubocop/cop/rails/where_equals.rb
+- lib/rubocop/cop/rails/where_exists.rb
+- lib/rubocop/cop/rails/where_missing.rb
+- lib/rubocop/cop/rails/where_not.rb
+- lib/rubocop/cop/rails/where_not_with_multiple_conditions.rb
 - lib/rubocop/cop/rails_cops.rb
 - lib/rubocop/rails.rb
 - lib/rubocop/rails/inject.rb
+- lib/rubocop/rails/schema_loader.rb
+- lib/rubocop/rails/schema_loader/schema.rb
 - lib/rubocop/rails/version.rb
-homepage: https://github.com/rubocop-hq/rubocop-rails
+homepage: https://github.com/rubocop/rubocop-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://docs.rubocop.org/projects/rails
-  changelog_uri: https://github.com/rubocop-hq/rubocop-rails/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/rubocop-hq/rubocop-rails/
-  documentation_uri: https://docs.rubocop.org/projects/rails
-  bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
-post_install_message: 
+  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.19/
+  bug_tracker_uri: https://github.com/rubocop/rubocop-rails/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,15 +230,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.0.dev
+signing_key:
 specification_version: 4
 summary: Automatic Rails code style checking tool.
 test_files: []

data/bin/setup

@@ -1,7 +0,0 @@
-#!/usr/bin/env bash
-
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install