Sha256: 8de360e32ebd0923a74b1baa9b495a1fc38102f4c237d49616a7b49b2f4fcc2e

Contents?: true

Size: 1.02 KB

Versions: 18

Compression:

Stored size: 1.02 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Style
      # This cop checks for non-ascii (non-English) characters
      # in comments.
      class AsciiComments < Cop
        MSG = 'Use only ascii symbols in comments.'.freeze

        def investigate(processed_source)
          processed_source.comments.each do |comment|
            unless comment.text.ascii_only?
              add_offense(comment, first_offense_range(comment))
            end
          end
        end

        private

        def first_offense_range(comment)
          expression    = comment.loc.expression
          first_offense = first_non_ascii_chars(comment.text)

          start_position = expression.begin_pos +
                           comment.text.index(first_offense)
          end_position   = start_position + first_offense.length

          range_between(start_position, end_position)
        end

        def first_non_ascii_chars(string)
          string.match(/[^[:ascii:]]+/).to_s
        end
      end
    end
  end
end

Version data entries

18 entries across 18 versions & 2 rubygems

Version Path
dirwatch-0.0.9 vendor/bundle/ruby/2.5.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.8 vendor/bundle/ruby/2.5.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.6 vendor/bundle/ruby/2.3.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.5 vendor/bundle/ruby/2.3.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.4 vendor/bundle/ruby/2.3.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.3 vendor/bundle/ruby/2.3.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
dirwatch-0.0.2 vendor/bundle/ruby/2.3.0/gems/rubocop-0.46.0/lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.50.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.49.1 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.49.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.48.1 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.48.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.47.1 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.47.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.46.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.45.0 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.44.1 lib/rubocop/cop/style/ascii_comments.rb
rubocop-0.44.0 lib/rubocop/cop/style/ascii_comments.rb