Sha256: 855ae273b947e885f36cd47c4c4194ef8051ab61131d23319f02bf7923976244
Contents?: true
Size: 1.99 KB
Versions: 19
Compression:
Stored size: 1.99 KB
Contents
module GovukPublishingComponents
# @private
class ComponentDocs
def initialize(gem_components: false, limit_to: false)
@limit_to = limit_to
@documentation_directory = gem_components ? gem_documentation_directory : app_documentation_directory
end
def get(id)
component = fetch_component_doc(id)
build(component)
end
def all
fetch_component_docs.map { |component| build(component) }.sort_by(&:name)
end
def used_in_this_app
fetch_component_docs.map { |component| build(component) if component_in_use(component[:id]) }.compact.sort_by(&:name)
end
private
def build(component)
ComponentDoc.new(component)
end
def fetch_component_docs
doc_files = Rails.root.join(@documentation_directory, "*.yml")
Dir[doc_files].sort.map { |file| parse_documentation(file) }
end
def component_in_use(component)
true if @limit_to.include?(component)
end
def fetch_component_doc(id)
file = Rails.root.join(@documentation_directory, "#{id}.yml")
if !file.exist?
file = gem_documentation_directory.join("#{id}.yml")
parse_documentation(file).merge(source: "gem")
else
parse_documentation(file).merge(source: "application")
end
end
def parse_documentation(file)
# Psych 4's YAML.unsafe_load_file === Psych 3's YAML.load_file
# but until we drop support for Ruby 2.7 and Ruby 3.0, we need to support both major versions of Psych
yaml = YAML.respond_to?(:unsafe_load_file) ? YAML.unsafe_load_file(file) : YAML.load_file(file)
{ id: File.basename(file, ".yml") }.merge(yaml).with_indifferent_access
end
def app_documentation_directory
Rails.root.join("app", "views", GovukPublishingComponents::Config.component_directory_name, "docs")
end
def gem_documentation_directory
Pathname.new(GovukPublishingComponents::Config.gem_directory).join("app", "views", "govuk_publishing_components", "components", "docs")
end
end
end
Version data entries
19 entries across 19 versions & 1 rubygems