Sha256: b59e4b608163481f8a5f69baae1ccb4d1be24a6723dac01990726bd93c027251

Contents?: true

Size: 1.59 KB

Versions: 162

Compression:

Stored size: 1.59 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Naming
      # Checks that your heredocs are using the configured case.
      # By default it is configured to enforce uppercase heredocs.
      #
      # @example EnforcedStyle: uppercase (default)
      #   # bad
      #   <<-sql
      #     SELECT * FROM foo
      #   sql
      #
      #   # good
      #   <<-SQL
      #     SELECT * FROM foo
      #   SQL
      #
      # @example EnforcedStyle: lowercase
      #   # bad
      #   <<-SQL
      #     SELECT * FROM foo
      #   SQL
      #
      #   # good
      #   <<-sql
      #     SELECT * FROM foo
      #   sql
      class HeredocDelimiterCase < Base
        include Heredoc
        include ConfigurableEnforcedStyle
        extend AutoCorrector

        MSG = 'Use %<style>s heredoc delimiters.'

        def on_heredoc(node)
          return if correct_case_delimiters?(node)

          add_offense(node.loc.heredoc_end) do |corrector|
            expr = node.source_range

            corrector.replace(expr, correct_delimiters(expr.source))
            corrector.replace(node.loc.heredoc_end, correct_delimiters(delimiter_string(expr)))
          end
        end

        private

        def message(_node)
          format(MSG, style: style)
        end

        def correct_case_delimiters?(node)
          delimiter_string(node) == correct_delimiters(delimiter_string(node))
        end

        def correct_delimiters(source)
          if style == :uppercase
            source.upcase
          else
            source.downcase
          end
        end
      end
    end
  end
end

Version data entries

162 entries across 161 versions & 17 rubygems

Version Path
rubocop-1.54.2 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
mlh-rubocop-config-1.0.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.54.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.54.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.52.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.54.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.54.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.53.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.53.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.52.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
fablicop-1.10.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.52.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.52.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.52.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.51.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
fluent-plugin-google-cloud-logging-on-prem-0.1.0 vendor/ruby/3.1.0/gems/rubocop-1.50.2/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.50.2 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.50.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.50.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.49.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
call_your_name-0.1.0 vendor/bundle/ruby/3.1.0/gems/rubocop-1.48.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.48.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb