Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # This module encapsulates the ability to ignore certain lines when
    # parsing.
    module AllowedPattern
      private

      def allowed_line?(line)
        line = if line.respond_to?(:source_line)
                 line.source_line
               elsif line.respond_to?(:node)
                 line.node.source_range.source_line
               end

        matches_allowed_pattern?(line)
      end

      # @deprecated Use allowed_line? instead
      def ignored_line?
        warn Rainbow(<<~WARNING).yellow, uplevel: 1
          `ignored_line?` is deprecated. Use `allowed_line?` instead.
        WARNING

        allowed_line?
      end

      def matches_allowed_pattern?(line)
        allowed_patterns.any? { |pattern| Regexp.new(pattern).match?(line) }
      end

      # @deprecated Use matches_allowed_pattern? instead
      def matches_ignored_pattern?
        warn Rainbow(<<~WARNING).yellow, uplevel: 1
          `matches_ignored_pattern?` is deprecated. Use `matches_allowed_pattern?` instead.
        WARNING

        matches_allowed_pattern?
      end

      def allowed_patterns
        # Since there could be a pattern specified in the default config, merge the two
        # arrays together.
        if cop_config_deprecated_methods_values.any?(Regexp)
          cop_config_patterns_values + cop_config_deprecated_methods_values
        else
          cop_config_patterns_values
        end
      end

      def cop_config_patterns_values
        @cop_config_patterns_values ||=
          Array(cop_config.fetch('AllowedPatterns', [])) +
          Array(cop_config.fetch('IgnoredPatterns', []))
      end

      def cop_config_deprecated_methods_values
        @cop_config_deprecated_methods_values ||=
          Array(cop_config.fetch('IgnoredMethods', [])) +
          Array(cop_config.fetch('ExcludedMethods', []))
      end
    end

    # @deprecated IgnoredPattern class has been replaced with AllowedPattern.
    IgnoredPattern = AllowedPattern
  end
end

Version data entries

10 entries across 10 versions & 1 rubygems

Version	Path
rubocop-1.70.0	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.69.2	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.69.1	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.69.0	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.68.0	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.67.0	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.66.1	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.66.0	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.65.1	lib/rubocop/cop/mixin/allowed_pattern.rb
rubocop-1.65.0	lib/rubocop/cop/mixin/allowed_pattern.rb