dynamic_find_by_spec.rb

# frozen_string_literal: true

RSpec.describe RuboCop::Cop::Rails::DynamicFindBy, :config do
  let(:cop_config) do
    { 'AllowedMethods' => %w[find_by_sql] }
  end

  context 'with dynamic find_by_*' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name(name)
        ^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by(name: name)
      RUBY
    end
  end

  context 'with dynamic find_by_*_and_*' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email(name, email)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name_and_email`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by(name: name, email: email)
      RUBY
    end
  end

  context 'with dynamic find_by_*!' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name!(name)
        ^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by!` instead of dynamic `find_by_name!`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by!(name: name)
      RUBY
    end
  end

  context 'with dynamic find_by_*_and_*_and_*' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email_and_token(name, email, token)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name_and_email_and_token`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by(name: name, email: email, token: token)
      RUBY
    end
  end

  context 'with dynamic find_by_*_and_*_and_*!' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email_and_token!(name, email, token)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by!` instead of dynamic `find_by_name_and_email_and_token!`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by!(name: name, email: email, token: token)
      RUBY
    end
  end

  context 'with dynamic find_by_*_and_*_and_* with newline' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email_and_token(
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name_and_email_and_token`.
          name,
          email,
          token
        )
      RUBY

      expect_correction(<<~RUBY)
        User.find_by(
          name: name,
          email: email,
          token: token
        )
      RUBY
    end
  end

  context 'with column includes underscore' do
    it 'registers an offense and corrects' do
      expect_offense(<<~RUBY)
        User.find_by_first_name(name)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_first_name`.
      RUBY

      expect_correction(<<~RUBY)
        User.find_by(first_name: name)
      RUBY
    end
  end

  context 'with too much arguments' do
    it 'registers an offense and no corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email(name, email, token)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name_and_email`.
      RUBY

      expect_no_corrections
    end
  end

  context 'with too few arguments' do
    it 'registers an offense and no corrects' do
      expect_offense(<<~RUBY)
        User.find_by_name_and_email(name)
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name_and_email`.
      RUBY

      expect_no_corrections
    end
  end

  it 'accepts' do
    expect_no_offenses('User.find_by(name: name)')
  end

  it 'accepts splat argument' do
    expect_no_offenses('User.find_by_scan(*args)')
  end

  it 'accepts any of the arguments are splat argument' do
    expect_no_offenses('User.find_by_foo_and_bar(arg, *args)')
  end

  it 'accepts dynamic finder with single hash argument' do
    expect_no_offenses('Post.find_by_id(limit: 1)')
  end

  it 'accepts dynamic finder with multiple arguments including hash' do
    expect_no_offenses('Post.find_by_title_and_id("foo", limit: 1)')
  end

  it 'accepts method in whitelist' do
    expect_no_offenses(<<~RUBY)
      User.find_by_sql(["select * from users where name = ?", name])
    RUBY
  end

  context 'with no receiver' do
    it 'does not register an offense when not inheriting any class' do
      expect_no_offenses(<<~RUBY)
        class C
          def do_something
            find_by_name(name)
          end
        end
      RUBY
    end

    it 'does not register an offense when not inheriting `ApplicationRecord`' do
      expect_no_offenses(<<~RUBY)
        class C < Foo
          def do_something
            find_by_name(name)
          end
        end
      RUBY
    end

    it 'registers an offense when inheriting `ApplicationRecord`' do
      expect_offense(<<~RUBY)
        class C < ApplicationRecord
          def do_something
            find_by_name(name)
            ^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
          end
        end
      RUBY
    end

    it 'registers an offense when inheriting `ActiveRecord::Base`' do
      expect_offense(<<~RUBY)
        class C < ActiveRecord::Base
          def do_something
            find_by_name(name)
            ^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
          end
        end
      RUBY
    end
  end

  context 'with allowed receiver name' do
    let(:cop_config) do
      { 'AllowedReceivers' => %w[Gem::Specification] }
    end

    it 'accepts dynamic find_by for receiver names in whitelist' do
      expect_no_offenses(<<~RUBY)
        Gem::Specification.find_by_name("backend").gem_dir
      RUBY
    end

    it 'registers offense for receiver name with no namespace' do
      expect_offense(<<~RUBY)
        Specification.find_by_name("backend").gem_dir
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
      RUBY
    end

    it 'registers offense for receiver name with different namespace' do
      expect_offense(<<~RUBY)
        RubyGems::Specification.find_by_name("backend").gem_dir
        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
      RUBY
    end
  end

  context 'when using safe navigation operator' do
    context 'with dynamic find_by_*' do
      it 'registers an offense and corrects' do
        expect_offense(<<~RUBY)
          user&.find_by_name(name)
          ^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
        RUBY

        expect_correction(<<~RUBY)
          user&.find_by(name: name)
        RUBY
      end
    end
  end

  # Whitelisted config will be deprecated.
  context 'with WhiteListed config' do
    context 'allowed class-names' do
      let(:cop_config) do
        { 'Whitelist' => %w[Specification] }
      end

      # `Whitelist` should not allow receivers for API compatibility.
      # New API `AllowedReceivers` should be used to add a receiver
      # to the allowed receivers.
      it 'registers offense for class methods in whitelist' do
        expect_offense(<<~RUBY)
          Specification.find_by_name("backend").gem_dir
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `find_by` instead of dynamic `find_by_name`.
        RUBY
      end
    end

    context 'allowed method-names' do
      let(:cop_config) do
        { 'Whitelist' => %w[find_by_name] }
      end

      it 'allows for class methods in whitelist' do
        expect_no_offenses(<<~RUBY)
          User.find_by_name("backend").gem_dir
        RUBY
      end
    end
  end
end