rubocop-rails 2.4.2 → 2.7.0

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # This cop enforces the use of `exists?(...)` over `where(...).exists?`.
+      #
+      # @example
+      #   # bad
+      #   User.where(name: 'john').exists?
+      #   User.where(['name = ?', 'john']).exists?
+      #   User.where('name = ?', 'john').exists?
+      #   user.posts.where(published: true).exists?
+      #
+      #   # good
+      #   User.exists?(name: 'john')
+      #   User.where('length(name) > 10').exists?
+      #   user.posts.exists?(published: true)
+      #
+      class WhereExists < Cop
+        MSG = 'Prefer `%<good_method>s` over `%<bad_method>s`.'
+
+        def_node_matcher :where_exists_call?, <<~PATTERN
+          (send (send _ :where $...) :exists?)
+        PATTERN
+
+        def on_send(node)
+          where_exists_call?(node) do |args|
+            return unless convertable_args?(args)
+
+            range = correction_range(node)
+            message = format(MSG, good_method: build_good_method(args), bad_method: range.source)
+            add_offense(node, location: range, message: message)
+          end
+        end
+
+        def autocorrect(node)
+          args = where_exists_call?(node)
+
+          lambda do |corrector|
+            corrector.replace(
+              correction_range(node),
+              build_good_method(args)
+            )
+          end
+        end
+
+        private
+
+        def convertable_args?(args)
+          args.size > 1 || args[0].hash_type? || args[0].array_type?
+        end
+
+        def correction_range(node)
+          node.receiver.loc.selector.join(node.loc.selector)
+        end
+
+        def build_good_method(args)
+          if args.size > 1
+            "exists?([#{args.map(&:source).join(', ')}])"
+          else
+            "exists?(#{args[0].source})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails_cops.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require_relative 'mixin/active_record_helper'
+require_relative 'mixin/index_method'
 require_relative 'mixin/target_rails_version'
 
 require_relative 'rails/action_filter'
 require_relative 'rails/active_record_aliases'
+require_relative 'rails/active_record_callbacks_order'
 require_relative 'rails/active_record_override'
 require_relative 'rails/active_support_aliases'
 require_relative 'rails/application_controller'
@@ -14,8 +17,10 @@ require_relative 'rails/assert_not'
 require_relative 'rails/belongs_to'
 require_relative 'rails/blank'
 require_relative 'rails/bulk_change_table'
+require_relative 'rails/content_tag'
 require_relative 'rails/create_table_with_timestamps'
 require_relative 'rails/date'
+require_relative 'rails/default_scope'
 require_relative 'rails/delegate'
 require_relative 'rails/delegate_allow_blank'
 require_relative 'rails/dynamic_find_by'
@@ -25,6 +30,7 @@ require_relative 'rails/environment_comparison'
 require_relative 'rails/exit'
 require_relative 'rails/file_path'
 require_relative 'rails/find_by'
+require_relative 'rails/find_by_id'
 require_relative 'rails/find_each'
 require_relative 'rails/has_and_belongs_to_many'
 require_relative 'rails/has_many_or_has_one_dependent'
@@ -32,30 +38,46 @@ require_relative 'rails/helper_instance_variable'
 require_relative 'rails/http_positional_arguments'
 require_relative 'rails/http_status'
 require_relative 'rails/ignored_skip_action_filter_option'
+require_relative 'rails/index_by'
+require_relative 'rails/index_with'
+require_relative 'rails/inquiry'
 require_relative 'rails/inverse_of'
 require_relative 'rails/lexically_scoped_action_filter'
 require_relative 'rails/link_to_blank'
+require_relative 'rails/mailer_name'
+require_relative 'rails/match_route'
+require_relative 'rails/negate_include'
 require_relative 'rails/not_null_column'
 require_relative 'rails/output'
 require_relative 'rails/output_safety'
+require_relative 'rails/pick'
+require_relative 'rails/pluck'
+require_relative 'rails/pluck_id'
+require_relative 'rails/pluck_in_where'
 require_relative 'rails/pluralization_grammar'
 require_relative 'rails/presence'
 require_relative 'rails/present'
 require_relative 'rails/rake_environment'
 require_relative 'rails/read_write_attribute'
 require_relative 'rails/redundant_allow_nil'
+require_relative 'rails/redundant_foreign_key'
 require_relative 'rails/redundant_receiver_in_with_options'
 require_relative 'rails/reflection_class_name'
 require_relative 'rails/refute_methods'
 require_relative 'rails/relative_date_constant'
+require_relative 'rails/render_inline'
+require_relative 'rails/render_plain_text'
 require_relative 'rails/request_referer'
 require_relative 'rails/reversible_migration'
 require_relative 'rails/safe_navigation'
 require_relative 'rails/safe_navigation_with_blank'
 require_relative 'rails/save_bang'
 require_relative 'rails/scope_args'
+require_relative 'rails/short_i18n'
 require_relative 'rails/skips_model_validations'
 require_relative 'rails/time_zone'
 require_relative 'rails/uniq_before_pluck'
+require_relative 'rails/unique_validation_without_index'
 require_relative 'rails/unknown_env'
 require_relative 'rails/validation'
+require_relative 'rails/where_exists'

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 @schema if defined?(@schema)
+
+        @schema = load!(target_ruby_version)
+      end
+
+      def reset!
+        return unless instance_variable_defined?(:@schema)
+
+        remove_instance_variable(:@schema)
+      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/schema_loader/schema.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Rails
+    module SchemaLoader
+      # Represent db/schema.rb
+      class Schema
+        attr_reader :tables, :add_indicies
+
+        def initialize(ast)
+          @tables = []
+          @add_indicies = []
+
+          build!(ast)
+        end
+
+        def table_by(name:)
+          tables.find do |table|
+            table.name == name
+          end
+        end
+
+        def add_indicies_by(table_name:)
+          add_indicies.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|
+            @tables << Table.new(table_def)
+          end
+
+          # Compatibility for Rails 4.2.
+          each_add_index(ast) do |add_index_def|
+            @add_indicies << 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 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)
+          return enum_for(__method__, node) unless block_given?
+
+          case node.body&.type
+          when :begin
+            node.body.children.each do |child|
+              yield(child)
+            end
+          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.value
+          @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|
+            if k.value == :null
+              @not_null = v.true_type? ? false : true
+            end
+          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)
+          @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/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Rails
     # This module holds the RuboCop Rails version information.
     module Version
-      STRING = '2.4.2'
+      STRING = '2.7.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-rails
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.7.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,8 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-26 00:00:00.000000000 Z
+date: 2020-07-20 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,14 +46,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.87.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.72.0
+        version: 0.87.0
 description: |
   Automatic Rails code style checking tool.
   A RuboCop extension focused on enforcing Rails best practices and coding conventions.
@@ -55,9 +69,12 @@ files:
 - bin/setup
 - config/default.yml
 - lib/rubocop-rails.rb
+- lib/rubocop/cop/mixin/active_record_helper.rb
+- lib/rubocop/cop/mixin/index_method.rb
 - lib/rubocop/cop/mixin/target_rails_version.rb
 - lib/rubocop/cop/rails/action_filter.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/application_controller.rb
@@ -68,8 +85,10 @@ files:
 - 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/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/dynamic_find_by.rb
@@ -79,6 +98,7 @@ files:
 - lib/rubocop/cop/rails/exit.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/has_and_belongs_to_many.rb
 - lib/rubocop/cop/rails/has_many_or_has_one_dependent.rb
@@ -86,45 +106,63 @@ files:
 - lib/rubocop/cop/rails/http_positional_arguments.rb
 - lib/rubocop/cop/rails/http_status.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/negate_include.rb
 - lib/rubocop/cop/rails/not_null_column.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_receiver_in_with_options.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/reversible_migration.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/scope_args.rb
+- lib/rubocop/cop/rails/short_i18n.rb
 - lib/rubocop/cop/rails/skips_model_validations.rb
 - lib/rubocop/cop/rails/time_zone.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/validation.rb
+- lib/rubocop/cop/rails/where_exists.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
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://docs.rubocop.org/projects/rails
+  homepage_uri: https://docs.rubocop.org/rubocop-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
+  documentation_uri: https://docs.rubocop.org/rubocop-rails/
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop-rails/issues
 post_install_message: 
 rdoc_options: []
@@ -134,14 +172,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Automatic Rails code style checking tool.