module UiComponents::DocuCop

Public Instance Methods

description() click to toggle source
# File lib/ui_components/docu_cop.rb, line 21
def description
  documentation[:description].presence ||
    raise("No description provided for '#{name}' component")
end
documentation() click to toggle source
# File lib/ui_components/docu_cop.rb, line 26
def documentation
  file = Engine.root.join('app', 'cells', name, "#{name}.yml")
  YAML.safe_load(File.read(file)).deep_symbolize_keys
end
examples() click to toggle source
# File lib/ui_components/docu_cop.rb, line 16
def examples
  documentation[:examples].presence ||
    raise("No examples provided for #{name} component")
end
name() click to toggle source
# File lib/ui_components/docu_cop.rb, line 8
def name
  to_s.underscore.sub(/_cell\Z/, '')
end
title() click to toggle source
# File lib/ui_components/docu_cop.rb, line 12
def title
  name.titleize
end