Sha256: 7d4c0490a5e8249e311f83fde546e87d4e612baef69ffa84029ce12ccb8aa0b1

Contents?: true

Size: 1.67 KB

Versions: 23

Compression:

Stored size: 1.67 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # Checks for interpolation in a single quoted string.
      #
      # @safety
      #   This cop is generally safe, but is marked as unsafe because
      #   it is possible to actually intentionally have text inside
      #   `#{...}` in a single quoted string.
      #
      # @example
      #
      #   # bad
      #
      #   foo = 'something with #{interpolation} inside'
      #
      # @example
      #
      #   # good
      #
      #   foo = "something with #{interpolation} inside"
      class InterpolationCheck < Base
        extend AutoCorrector

        MSG = 'Interpolation in single quoted string detected. ' \
              'Use double quoted strings if you need interpolation.'

        def on_str(node)
          return if node.parent&.regexp_type?
          return unless /(?<!\\)#\{.*\}/.match?(node.source)
          return if heredoc?(node)
          return unless node.loc.begin && node.loc.end

          add_offense(node) { |corrector| autocorrect(corrector, node) }
        end

        private

        def autocorrect(corrector, node)
          starting_token, ending_token = if node.source.include?('"')
                                           ['%{', '}']
                                         else
                                           ['"', '"']
                                         end

          corrector.replace(node.loc.begin, starting_token)
          corrector.replace(node.loc.end, ending_token)
        end

        def heredoc?(node)
          node.loc.is_a?(Parser::Source::Map::Heredoc) || (node.parent && heredoc?(node.parent))
        end
      end
    end
  end
end

Version data entries

23 entries across 19 versions & 3 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/interpolation_check.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/interpolation_check.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/interpolation_check.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.36.0/lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.39.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.38.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.37.1 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.37.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.36.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.35.1 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.35.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.34.1 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.34.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.33.0 lib/rubocop/cop/lint/interpolation_check.rb
rubocop-1.32.0 lib/rubocop/cop/lint/interpolation_check.rb