Sha256: 7cdd06ac18b0490f18edd49b2ca155d520ab27cb01899639ab30cf2621a156ed

Contents?: true

Size: 1.27 KB

Versions: 10

Compression:

Stored size: 1.27 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:'.freeze
      FROZEN_STRING_LITERAL_ENABLED = '# frozen_string_literal: true'.freeze
      FROZEN_STRING_LITERAL_TYPES = %i[str dstr].freeze

      def frozen_string_literal_comment_exists?
        leading_comment_lines.any? do |line|
          MagicComment.parse(line).frozen_string_literal_specified?
        end
      end

      private

      def frozen_string_literals_enabled?
        ruby_version = processed_source.ruby_version
        return false unless ruby_version
        # TODO: Whether frozen string literals will be the default in Ruby 3.0
        # or not is still unclear as of February 2018.
        # It may be necessary to change this code in the future.
        # See https://bugs.ruby-lang.org/issues/8976#note-41 for details.
        return true if ruby_version >= 3.0
        return false unless ruby_version >= 2.3

        leading_comment_lines.any? do |line|
          MagicComment.parse(line).frozen_string_literal?
        end
      end

      def leading_comment_lines
        processed_source[0..2].compact
      end
    end
  end
end

Version data entries

10 entries across 10 versions & 2 rubygems

Version Path
rubocop-0.58.1 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.58.0 lib/rubocop/cop/mixin/frozen_string_literal.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.4.0/gems/rubocop-0.57.2/lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.57.2 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.57.1 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.57.0 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.56.0 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.55.0 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.54.0 lib/rubocop/cop/mixin/frozen_string_literal.rb
rubocop-0.53.0 lib/rubocop/cop/mixin/frozen_string_literal.rb