Sha256: 0b21494aed9bdc432056ea6e6e4a153850e4d1428276a677f3593fe0af4e8489
Contents?: true
Size: 1.93 KB
Versions: 13
Compression:
Stored size: 1.93 KB
Contents
require 'jsduck/logger'
require 'jsduck/util/json'
module JsDuck
module Categories
# Reads categories info from config file
class File
def initialize(filename, relations)
@filename = filename
@relations = relations
end
# Parses categories in JSON file
def generate
@categories = Util::Json.read(@filename)
# Perform expansion on all class names containing * wildcard
@categories.each do |cat|
cat["groups"].each do |group|
group["classes"] = group["classes"].map do |name|
expand(name)
end.flatten
end
end
validate
@categories
end
# Expands class name like 'Foo.*' into multiple class names.
def expand(name)
re = Regexp.new("^" + name.split(/\*/, -1).map {|part| Regexp.escape(part) }.join('.*') + "$")
classes = @relations.to_a.find_all do |cls|
re =~ cls[:name] && !cls[:private] && !cls[:deprecated]
end.map {|cls| cls[:name] }.sort
if classes.length == 0
Logger.warn(:cat_no_match, "No class found matching a pattern '#{name}' in categories file", @filename)
end
classes
end
# Prints warnings for missing classes in categories file
def validate
# Build a map of all classes listed in categories
listed_classes = {}
@categories.each do |cat|
cat["groups"].each do |group|
group["classes"].each do |cls_name|
listed_classes[cls_name] = true
end
end
end
# Check that each existing non-private & non-deprecated class is listed
@relations.each do |cls|
unless listed_classes[cls[:name]] || cls[:private] || cls[:deprecated]
Logger.warn(:cat_class_missing, "Class '#{cls[:name]}' not found in categories file", @filename)
end
end
end
end
end
end
Version data entries
13 entries across 13 versions & 1 rubygems