Sha256: 054471b44341545918b8d919d9608843abd3902018aa0afb87f1521eddfa219e

Contents?: true

Size: 1.53 KB

Versions: 27

Compression:

Stored size: 1.53 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # Identifier of all cops containing a department and cop name.
    #
    # All cops are identified by their badge. For example, the badge for
    # `RuboCop::Cop::Layout::IndentationStyle` is `Layout/IndentationStyle`.
    # Badges can be parsed as either `Department/CopName` or just `CopName` to
    # allow for badge references in source files that omit the department for
    # RuboCop to infer.
    class Badge
      attr_reader :department, :cop_name

      def self.for(class_name)
        parts = class_name.split('::')
        name_deep_enough = parts.length >= 4
        new(name_deep_enough ? parts[2..-1] : parts.last(2))
      end

      def self.parse(identifier)
        new(identifier.split('/'))
      end

      def initialize(class_name_parts)
        department_parts = class_name_parts[0...-1]
        @department = (department_parts.join('/').to_sym unless department_parts.empty?)
        @cop_name = class_name_parts.last
      end

      def ==(other)
        hash == other.hash
      end
      alias eql? ==

      def hash
        [department, cop_name].hash
      end

      def match?(other)
        cop_name == other.cop_name && (!qualified? || department == other.department)
      end

      def to_s
        @to_s ||= qualified? ? "#{department}/#{cop_name}" : cop_name
      end

      def qualified?
        !department.nil?
      end

      def with_department(department)
        self.class.new([department.to_s.split('/'), cop_name].flatten)
      end
    end
  end
end

Version data entries

27 entries across 27 versions & 4 rubygems

Version Path
rubocop-1.17.0 lib/rubocop/cop/badge.rb
rubocop-1.16.1 lib/rubocop/cop/badge.rb
rubocop-1.16.0 lib/rubocop/cop/badge.rb
rubocop-1.15.0 lib/rubocop/cop/badge.rb
cocRb-0.1.0 .bundle/ruby/3.0.0/gems/rubocop-1.14.0/lib/rubocop/cop/badge.rb
rubocop-1.14.0 lib/rubocop/cop/badge.rb
rubocop-1.13.0 lib/rubocop/cop/badge.rb