Class: JsDuck::ExternalClasses

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/external_classes.rb

Overview

Handles patterns of external classes.

A pattern can be a simple classname or a one with a wildcard “*”.

Also one can use a special keyword “@browser” to include all common browser web API class names.

Instance Method Summary collapse

Constructor Details

#initialize(classnames = []) ⇒ ExternalClasses

Returns a new instance of ExternalClasses.



11
12
13
14
15
 
# File 'lib/jsduck/external_classes.rb', line 11

def initialize(classnames = [])
  @class_names = {}
  @patterns = []
  classnames.each {|name| add(name) }
end

Instance Method Details

#add(name) ⇒ Object

Adds a classname or pattern to list of external classes.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/jsduck/external_classes.rb', line 18

def add(name)
  if name =~ /\*/
    @patterns << make_pattern(name)
  elsif name =~ /^@browser$/i
    WEB_APIS.each do |cls|
      @class_names[cls] = true
    end
  else
    @class_names[name] = true
  end
end

#is?(classname) ⇒ Boolean

True if the classname matches an external class pattern.

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/jsduck/external_classes.rb', line 31

def is?(classname)
  @class_names[classname] || @patterns.any? {|p| classname =~ p }
end