Sha256: f3f9753576978c4fbe3bdbf6fa5828aa047cfbf619751f64ef1bd4bf8ff06424

Contents?: true

Size: 1.77 KB

Versions: 33

Compression:

Stored size: 1.77 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Rails
      # Checks that ActiveSupport aliases to core ruby methods
      # are not used.
      #
      # @example
      #   # good
      #   'some_string'.start_with?('prefix')
      #   'some_string'.end_with?('suffix')
      #   [1, 2, 'a'] << 'b'
      #   [1, 2, 'a'].unshift('b')
      #
      #   # bad
      #   'some_string'.starts_with?('prefix')
      #   'some_string'.ends_with?('suffix')
      #   [1, 2, 'a'].append('b')
      #   [1, 2, 'a'].prepend('b')
      #
      class ActiveSupportAliases < Base
        extend AutoCorrector

        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
        RESTRICT_ON_SEND = %i[starts_with? ends_with? append prepend].freeze

        ALIASES = {
          starts_with?: {
            original: :start_with?, matcher: '(send str :starts_with? _)'
          },
          ends_with?: {
            original: :end_with?, matcher: '(send str :ends_with? _)'
          },
          append: { original: :<<, matcher: '(send array :append _)' },
          prepend: { original: :unshift, matcher: '(send array :prepend _)' }
        }.freeze

        ALIASES.each do |aliased_method, options|
          def_node_matcher aliased_method, options[:matcher]
        end

        def on_send(node)
          ALIASES.each_key do |aliased_method|
            next unless public_send(aliased_method, node)

            preferred_method = ALIASES[aliased_method][:original]
            message = format(MSG, prefer: preferred_method, current: aliased_method)

            add_offense(node, message: message) do |corrector|
              next if append(node)

              corrector.replace(node.loc.selector, preferred_method)
            end
          end
        end
      end
    end
  end
end

Version data entries

33 entries across 30 versions & 5 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/active_support_aliases.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/active_support_aliases.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/active_support_aliases.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/active_support_aliases.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-rails-2.20.0/lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.22.2 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.22.1 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.22.0 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.21.2 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.21.1 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.21.0 lib/rubocop/cop/rails/active_support_aliases.rb
mlh-rubocop-config-1.0.2 vendor/bundle/ruby/3.2.0/gems/rubocop-rails-2.20.2/lib/rubocop/cop/rails/active_support_aliases.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-rails-2.19.1/lib/rubocop/cop/rails/active_support_aliases.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-rails-2.20.2/lib/rubocop/cop/rails/active_support_aliases.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-rails-2.15.2/lib/rubocop/cop/rails/active_support_aliases.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-rails-2.20.0/lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.20.2 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.20.1 lib/rubocop/cop/rails/active_support_aliases.rb
rubocop-rails-2.20.0 lib/rubocop/cop/rails/active_support_aliases.rb
fablicop-1.10.2 vendor/bundle/ruby/3.2.0/gems/rubocop-rails-2.19.1/lib/rubocop/cop/rails/active_support_aliases.rb