Sha256: e011b8f04ccad00799811a9f31fc089f9bb58324653dad294989f6fb04a8b40a
Contents?: true
Size: 1.32 KB
Versions: 6
Compression:
Stored size: 1.32 KB
Contents
# frozen_string_literal: true
require 'puppet-strings/markdown/base'
module PuppetStrings::Markdown
# Generates Markdown for a Puppet Resource Type.
class ResourceType < Base
group_name 'Resource types'
yard_types [:puppet_type]
def initialize(registry)
@template = 'resource_type.erb'
super(registry, 'type')
end
def render
super(@template)
end
def properties
return nil unless @registry[:properties]
@registry[:properties].sort_by { |p| p[:name] }
end
def checks
return nil unless @registry[:checks]
@registry[:checks].sort_by { |p| p[:name] }
end
# "checks" (such as "onlyif" or "creates") are another type of property
def properties_and_checks
return nil if properties.nil? && checks.nil?
((properties || []) + (checks || [])).sort_by { |p| p[:name] }.map do |prop|
prop[:link] = clean_link("$#{name}::#{prop[:name]}")
prop
end
end
def parameters
return nil unless @registry[:parameters]
@registry[:parameters].sort_by { |p| p[:name] }.map do |param|
param[:link] = clean_link("$#{name}::#{param[:name]}")
param
end
end
def regex_in_data_type?(data_type)
m = data_type.match(%r{\w+\[/.*/\]})
m unless m.nil? || m.to_a.empty?
end
end
end
Version data entries
6 entries across 6 versions & 1 rubygems