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
8
 
# File 'lib/yard-api/verifier.rb', line 4

def initialize(verbose=false)
  @verbose = verbose
  @routes = {}
  super()
end

Instance Method Details

#logger ⇒ Object 



53
54
55
 
# File 'lib/yard-api/verifier.rb', line 53

def logger
  ::YARD::APIPlugin.logger
end

#relevant_object?(object) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/yard-api/verifier.rb', line 24

def relevant_object?(object)
  case object.type
  when :root, :module, :constant
    false
  when :api
    true
  when :method
    return false if object.has_tag?(:internal) || !object.has_tag?(:API)
    routes = @routes[object.object_id]
    routes ||= begin
      @routes[object.object_id] = YARD::Templates::Helpers::RouteHelper.routes_for_yard_object(object)
    end

    if routes.empty?
      logger.warn (
        "API Endpoint #{object.path}# has no routes defined " +
        "ib routes.rb and will be ignored."
      )
    end

    routes.any?
  when :class
    return false if object.has_tag?(:internal) || !object.has_tag?(:API)
    true
  else
    object.parent.nil? && relevant_object?(object.parent)
  end
end

#run(list) ⇒ Object 



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

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

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

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

  relevant
end