Class: RuboCop::Cop::Registry

# File 'lib/rubocop/cop/registry.rb', line 44

def self.qualified_cop?(name)
  badge = Badge.parse(name)
  global.qualify_badge(badge).first == badge
end

# File 'lib/rubocop/cop/registry.rb', line 26

def self.qualified_cop_name(name, origin)
  global.qualified_cop_name(name, origin)
end

# File 'lib/rubocop/cop/registry.rb', line 40

def self.reset!
  @global = new
end

# File 'lib/rubocop/cop/registry.rb', line 32

def self.with_temporary_global(temp_global = global.dup)
  previous = @global
  @global = temp_global
  yield
ensure
  @global = previous
end

# File 'lib/rubocop/cop/registry.rb', line 283

def clear_enrollment_queue
  return if @enrollment_queue.empty?

  @enrollment_queue.each do |cop|
    @registry[cop.badge] = cop
    @departments[cop.department] ||= []
    @departments[cop.department] << cop
    @cops_by_cop_name[cop.cop_name] << cop
  end
  @enrollment_queue = []
end

# File 'lib/rubocop/cop/registry.rb', line 97

def contains_cop_matching?(names)
  cops.any? { |cop| cop.match?(names) }
end

# File 'lib/rubocop/cop/registry.rb', line 179

def cops
  clear_enrollment_queue
  @registry.values
end

# File 'lib/rubocop/cop/registry.rb', line 224

def cops_for_department(department)
  cops.select { |cop| cop.department == department.to_sym }
end

# File 'lib/rubocop/cop/registry.rb', line 93

def department?(name)
  departments.include?(name.to_sym)
end

# File 'lib/rubocop/cop/registry.rb', line 147

def department_missing?(badge, name)
  !badge.qualified? && unqualified_cop_names.include?(name)
end

# File 'lib/rubocop/cop/registry.rb', line 72

def departments
  clear_enrollment_queue
  @departments.keys
end

# File 'lib/rubocop/cop/registry.rb', line 193

def disabled(config)
  @disabled_cache[config] ||= reject { |cop| enabled?(cop, config) }
end

# File 'lib/rubocop/cop/registry.rb', line 67

def dismiss(cop)
  raise "Cop #{cop} could not be dismissed" unless @enrollment_queue.delete(cop)
end

# File 'lib/rubocop/cop/registry.rb', line 247

def each(&block)
  cops.each(&block)
end

# File 'lib/rubocop/cop/registry.rb', line 189

def enabled(config)
  @enabled_cache[config] ||= select { |cop| enabled?(cop, config) }
end

# File 'lib/rubocop/cop/registry.rb', line 197

def enabled?(cop, config)
  return true if options[:only]&.include?(cop.cop_name)

  # We need to use `cop_name` in this case, because `for_cop` uses caching
  # which expects cop names or cop classes as keys.
  cfg = config.for_cop(cop.cop_name)

  cop_enabled = cfg.fetch('Enabled') == true || enabled_pending_cop?(cfg, config)

  if options.fetch(:safe, false)
    cop_enabled && cfg.fetch('Safe', true)
  else
    cop_enabled
  end
end

# File 'lib/rubocop/cop/registry.rb', line 213

def enabled_pending_cop?(cop_cfg, config)
  return false if @options[:disable_pending_cops]

  cop_cfg.fetch('Enabled') == 'pending' &&
    (@options[:enable_pending_cops] || config.enabled_new_cops?)
end

# File 'lib/rubocop/cop/registry.rb', line 63

def enlist(cop)
  @enrollment_queue << cop
end

# File 'lib/rubocop/cop/registry.rb', line 253

def find_by_cop_name(cop_name)
  to_h[cop_name].first
end

# File 'lib/rubocop/cop/registry.rb', line 260

def find_cops_by_directive(directive)
  cop = find_by_cop_name(directive)
  cop ? [cop] : cops_for_department(directive)
end

# File 'lib/rubocop/cop/registry.rb', line 265

def freeze
  clear_enrollment_queue
  unqualified_cop_names # build cache
  super
end

# File 'lib/rubocop/cop/registry.rb', line 279

def initialize_copy(reg)
  initialize(reg.cops, reg.options)
end

# File 'lib/rubocop/cop/registry.rb', line 184

def length
  clear_enrollment_queue
  @registry.size
end

# File 'lib/rubocop/cop/registry.rb', line 220

def names
  cops.map(&:cop_name)
end

# File 'lib/rubocop/cop/registry.rb', line 228

def names_for_department(department)
  cops_for_department(department).map(&:cop_name)
end

# File 'lib/rubocop/cop/registry.rb', line 151

def print_warning(name, path)
  message = "#{path}: Warning: no department given for #{name}."
  if path.end_with?('.rb')
    message += ' Run `rubocop -a --only Migration/DepartmentName` to fix.'
  end
  warn message
end

# File 'lib/rubocop/cop/registry.rb', line 133

def qualified_cop_name(name, path, warn: true)
  badge = Badge.parse(name)
  print_warning(name, path) if warn && department_missing?(badge, name)
  return name if registered?(badge)

  potential_badges = qualify_badge(badge)

  case potential_badges.size
  when 0 then name # No namespace found. Deal with it later in caller.
  when 1 then resolve_badge(badge, potential_badges.first, path)
  else raise AmbiguousCopName.new(badge, path, potential_badges)
  end
end

# File 'lib/rubocop/cop/registry.rb', line 166

def qualify_badge(badge)
  clear_enrollment_queue
  @departments
    .map { |department, _| badge.with_department(department) }
    .select { |potential_badge| registered?(potential_badge) }
end

# File 'lib/rubocop/cop/registry.rb', line 309

def registered?(badge)
  clear_enrollment_queue
  @registry.key?(badge)
end

# File 'lib/rubocop/cop/registry.rb', line 299

def resolve_badge(given_badge, real_badge, source_path)
  unless given_badge.match?(real_badge)
    path = PathUtil.smart_path(source_path)
    warn "#{path}: #{given_badge} has the wrong namespace - " \
         "replace it with #{given_badge.with_department(real_badge.department)}"
  end

  real_badge.to_s
end

# File 'lib/rubocop/cop/registry.rb', line 243

def select(&block)
  cops.select(&block)
end

# File 'lib/rubocop/cop/registry.rb', line 236

def sort!
  clear_enrollment_queue
  @registry = @registry.sort_by { |badge, _| badge.cop_name }.to_h

  self
end

# File 'lib/rubocop/cop/registry.rb', line 174

def to_h
  clear_enrollment_queue
  @cops_by_cop_name
end

# File 'lib/rubocop/cop/registry.rb', line 159

def unqualified_cop_names
  clear_enrollment_queue
  @unqualified_cop_names ||=
    Set.new(@cops_by_cop_name.keys.map { |qn| File.basename(qn) }) <<
    'RedundantCopDisableDirective'
end

# File 'lib/rubocop/cop/registry.rb', line 295

def with(cops)
  self.class.new(cops)
end

# File 'lib/rubocop/cop/registry.rb', line 78

def with_department(department)
  clear_enrollment_queue
  with(@departments.fetch(department, []))
end

# File 'lib/rubocop/cop/registry.rb', line 84

def without_department(department)
  clear_enrollment_queue
  without_department = @departments.dup
  without_department.delete(department)

  with(without_department.values.flatten)
end