Sha256: 24447e55f9f452efbfdd2af3b693dd44f575680b4e818c5d1dce20aa57140c30
Contents?: true
Size: 1.97 KB
Versions: 50
Compression:
Stored size: 1.97 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
# Common functionality for dealing with frozen string literals.
module FrozenStringLiteral
module_function
FROZEN_STRING_LITERAL = '# frozen_string_literal:'
FROZEN_STRING_LITERAL_ENABLED = '# frozen_string_literal: true'
FROZEN_STRING_LITERAL_TYPES = %i[str dstr].freeze
def frozen_string_literal_comment_exists?
leading_comment_lines.any? do |line|
MagicComment.parse(line).valid_literal_value?
end
end
private
def frozen_string_literals_enabled?
ruby_version = processed_source.ruby_version
return false unless ruby_version
# TODO: Ruby officially abandon making frozen string literals default
# for Ruby 3.0.
# https://bugs.ruby-lang.org/issues/11473#note-53
# Whether frozen string literals will be the default after Ruby 3.0
# or not is still unclear as of January 2019.
# It may be necessary to add this code in the future.
#
# return true if ruby_version >= 3.1
#
# And the above `ruby_version >= 3.1` is undecided whether it will be
# Ruby 3.1, 3.2, 4.0 or others.
# See https://bugs.ruby-lang.org/issues/8976#note-41 for details.
leading_comment_lines.any? do |line|
MagicComment.parse(line).frozen_string_literal?
end
end
def frozen_string_literal_specified?
leading_comment_lines.any? do |line|
MagicComment.parse(line).frozen_string_literal_specified?
end
end
def leading_comment_lines
first_non_comment_token = processed_source.tokens.find do |token|
!token.comment?
end
if first_non_comment_token
# `line` is 1-indexed so we need to subtract 1 to get the array index
processed_source.lines[0...first_non_comment_token.line - 1]
else
processed_source.lines
end
end
end
end
end
Version data entries
50 entries across 50 versions & 5 rubygems