Class: RuboCop::MagicComment::SimpleComment

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, MagicComment
Instance Chain: self, MagicComment
Inherits:	MagicComment Object MagicComment RuboCop::MagicComment::SimpleComment
Defined in:	lib/rubocop/magic_comment.rb

Overview

Wrapper for regular magic comments not bound to an editor.

Simple comments can only specify one setting per comment.

Examples:

frozen string literal comments

comment1 = RuboCop::MagicComment.parse('# frozen_string_literal: true')
comment1.frozen_string_literal # => true
comment1.encoding              # => nil

encoding comments

comment2 = RuboCop::MagicComment.parse('# encoding: utf-8')
comment2.frozen_string_literal # => nil
comment2.encoding              # => 'utf-8'

Constant Summary

FSTRING_LITERAL_COMMENT =
# File 'lib/rubocop/magic_comment.rb', line 282
```
'frozen_string_literal:\s*(true|false)'
```

Instance Method Summary

#encoding

Match #encoding or coding.
#new_frozen_string_literal(value)
#without(type)

Rewrite the comment without a given token type.
#extract_frozen_string_literal private

Extract #frozen_string_literal.
#extract_rbs_inline_value private
#extract_shareable_constant_value private
#extract_typed private

Instance Method Details

#encoding

Match encoding or coding

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 285


def encoding
  extract(/\A\s*\#\s*(#{FSTRING_LITERAL_COMMENT})?\s*#{KEYWORDS[:encoding]}: (#{TOKEN})/io)
end

#extract_frozen_string_literal (private)

Extract RuboCop::MagicComment#frozen_string_literal.

The RuboCop::MagicComment#frozen_string_literal magic comment only works if it is the only text in the comment.

Case-insensitive and dashes/underscores are acceptable.

#extract_rbs_inline_value (private)

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 315


def extract_rbs_inline_value
  extract(/\A\s*#\s*#{KEYWORDS[:rbs_inline]}:\s*#{TOKEN}\s*\z/io)
end

#extract_shareable_constant_value (private)

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 319


def extract_shareable_constant_value
  extract(/\A\s*#\s*#{KEYWORDS[:shareable_constant_value]}:\s*#{TOKEN}\s*\z/io)
end

#extract_typed (private)

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 323


def extract_typed
  extract(/\A\s*#\s*#{KEYWORDS[:typed]}:\s*#{TOKEN}\s*\z/io)
end

#new_frozen_string_literal(value)

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 298


def new_frozen_string_literal(value)
  "# frozen_string_literal: #{value}"
end

#without(type)

Rewrite the comment without a given token type

[ GitHub ]

# File 'lib/rubocop/magic_comment.rb', line 290


def without(type)
  if @comment.match?(/\A#\s*#{self.class::KEYWORDS[type.to_sym]}/io)
    ''
  else
    @comment
  end
end