Sha256: b59e4b608163481f8a5f69baae1ccb4d1be24a6723dac01990726bd93c027251

Contents?: true

Size: 1.59 KB

Versions: 156

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

156 entries across 155 versions & 16 rubygems

Version Path
rubocop-1.63.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
bison-0.1.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.62.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.62.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.62.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.61.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
mlh-rubocop-config-1.0.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.2/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.60.2 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.7 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.6 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.5 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.4 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.60.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
study_line-0.2.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.60.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-1.60.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
harbr-0.2.10 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
harbr-0.2.9 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
harbr-0.2.8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/naming/heredoc_delimiter_case.rb