Class: YARD::APIPlugin::Verifier

Inherits:
Verifier
  • Object
show all
Defined in:
lib/yard-api/verifier.rb

Instance Method Summary collapse

Constructor Details

#initialize(verbose = false) ⇒ Verifier

Returns a new instance of Verifier.



4
5
6
7
 
# File 'lib/yard-api/verifier.rb', line 4

def initialize(verbose=false)
  @verbose = verbose
  super()
end

Instance Method Details

#log(*args) ⇒ Object 



40
41
42
 
# File 'lib/yard-api/verifier.rb', line 40

def log(*args)
  ::YARD::APIPlugin.log(*args)
end

#relevant_object?(object) ⇒ Boolean

Returns:

  • (Boolean) 


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/yard-api/verifier.rb', line 23

def relevant_object?(object)
  case object.type
  when :root, :module, :constant
    false
  when :method, :class
    return false if object.tags('internal').any?

    object.tags('API').any?.tap do |is_api|
      if @verbose && !is_api
        log "Resource #{object} will be ignored as it contains no @API tag."
      end
    end
  else
    object.parent.nil? && relevant_object?(object.parent)
  end
end

#run(list) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/yard-api/verifier.rb', line 9

def run(list)
  relevant = list.select { |o| relevant_object?(o) }

  if @verbose && relevant.any?
    log "#{relevant.length}/#{list.length} objects are relevant:"

    relevant.each do |object|
      log "\t- #{object.path}"
    end
  end

  relevant
end