Sha256: ac9c9f114d4922e033b5e5d10d7fcc0ccb823c23fcea12afe110e9e6dd7ad4bb

Contents?: true

Size: 1.36 KB

Versions: 60

Compression:

Stored size: 1.36 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Naming
      # This cop 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 < Cop
        include Heredoc
        include ConfigurableEnforcedStyle

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

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

          add_offense(node, location: :heredoc_end)
        end

        private

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

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

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

Version data entries

60 entries across 41 versions & 5 rubygems

Version Path
grape-extra_validators-2.0.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.79.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.88.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rbhint-0.87.1.rc1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.87.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.87.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.86.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
files.com-1.0.1 vendor/bundle/ruby/2.5.0/gems/rubocop-0.85.1/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rbhint-0.85.1.rc2 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rbhint-0.85.1.rc1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.85.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rbhint-0.8.5.rc1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.85.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.84.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.83.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.82.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.81.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.80.1 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
rubocop-0.80.0 lib/rubocop/cop/naming/heredoc_delimiter_case.rb
grape-extra_validators-1.0.0 vendor/bundle/ruby/2.4.0/gems/rubocop-0.79.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb
grape-extra_validators-1.0.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.79.0/lib/rubocop/cop/naming/heredoc_delimiter_case.rb