Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks ensures source files have no utf-8 encoding comments.
      # @example
      #   # bad
      #   # encoding: UTF-8
      #   # coding: UTF-8
      #   # -*- coding: UTF-8 -*-
      class Encoding < Cop
        include RangeHelp

        MSG_UNNECESSARY = 'Unnecessary utf-8 encoding comment.'
        ENCODING_PATTERN = /#.*coding\s?[:=]\s?(?:UTF|utf)-8/.freeze
        SHEBANG = '#!'

        def investigate(processed_source)
          return if processed_source.buffer.source.empty?

          line_number = encoding_line_number(processed_source)
          return unless (@message = offense(processed_source, line_number))

          range = processed_source.buffer.line_range(line_number + 1)
          add_offense(range, location: range, message: @message)
        end

        def autocorrect(range)
          lambda do |corrector|
            corrector.remove(range_with_surrounding_space(range: range,
                                                          side: :right))
          end
        end

        private

        def offense(processed_source, line_number)
          line = processed_source[line_number]

          MSG_UNNECESSARY if encoding_omitable?(line)
        end

        def encoding_omitable?(line)
          ENCODING_PATTERN.match?(line)
        end

        def encoding_line_number(processed_source)
          line_number = 0
          line_number += 1 if processed_source[line_number].start_with?(SHEBANG)
          line_number
        end
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 2 rubygems

Version	Path
rubocop-0.89.0	lib/rubocop/cop/style/encoding.rb
rubocop-0.88.0	lib/rubocop/cop/style/encoding.rb
rbhint-0.87.1.rc1	lib/rubocop/cop/style/encoding.rb
rubocop-0.87.1	lib/rubocop/cop/style/encoding.rb
rubocop-0.87.0	lib/rubocop/cop/style/encoding.rb
rubocop-0.86.0	lib/rubocop/cop/style/encoding.rb
rbhint-0.85.1.rc2	lib/rubocop/cop/style/encoding.rb