class ApipieDSL::ClassDescription
Attributes
deprecated[R]
full_description[R]
klass[R]
methods[R]
refs[R]
sections[R]
short_description[R]
show[R]
Public Class Methods
new(klass, class_name, dsl_data = nil, version = nil)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 8 def initialize(klass, class_name, dsl_data = nil, version = nil) @klass = klass @name = class_name @methods = {} @properties = [] @version = version || ApipieDSL.configuration.default_version @parent = ApipieDSL.get_class_description(ApipieDSL.superclass_for(klass), version) @refs = [@name] @sections = [] @show = true update_from_dsl_data(dsl_data) if dsl_data end
Public Instance Methods
add_method_description(method_description)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 54 def add_method_description(method_description) ApipieDSL.debug "@resource_descriptions[#{version}][#{@name}].methods[#{method_description.name}] = #{method_description}" @methods[method_description.name.to_sym] = method_description end
doc_url(section = nil)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 73 def doc_url(section = nil) crumbs = [] crumbs << version if ApipieDSL.configuration.version_in_url crumbs << section if section crumbs << id ApipieDSL.full_url(crumbs.join('/')) end
docs(section = nil, method_name = nil, lang = nil)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 85 def docs(section = nil, method_name = nil, lang = nil) raise "Method #{method_name} not found for class #{id}" if method_name && !valid_method_name?(method_name) methods = if method_name.nil? @methods.map { |_key, method_desc| method_desc.docs(section, lang) } else [@methods[method_name.to_sym].docs(section, lang)] end short_desc = @short_description || ApipieDSL.configuration.default_class_description&.call(@klass) { id: id, name: @name, doc_url: doc_url(section), short_description: ApipieDSL.translate(short_desc, lang), full_description: ApipieDSL.translate(@full_description, lang), version: version, metadata: @metadata, properties: @properties.map { |prop_desc| prop_desc.docs(section, lang) }.sort_by { |p| p[:name] }, methods: methods.sort_by { |m| m[:name] }, deprecated: @deprecated, show: @show } end
id()
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 44 def id return @klass.name if ApipieDSL.configuration.class_full_names? @name end
method_description(method_name)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 59 def method_description(method_name) @methods[method_name.to_sym] end
method_descriptions()
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 69 def method_descriptions @methods.values end
remove_method_description(method_name)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 63 def remove_method_description(method_name) return unless @methods.key?(method_name) @methods.delete(method_name) end
update_from_dsl_data(dsl_data)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 21 def update_from_dsl_data(dsl_data) @name = dsl_data[:class_name] if dsl_data[:class_name] @full_description = ApipieDSL.markup_to_html(dsl_data[:description]) if dsl_data[:description] @short_description = dsl_data[:short_description] || @short_description @tag_list = dsl_data[:tag_list] if dsl_data[:meta].is_a?(Hash) @metadata&.merge!(dsl_data[:meta]) elsif dsl_data[:meta] @metadata = dsl_data[:meta] end @deprecated = dsl_data[:deprecated] || false @show = dsl_data[:show] || @show prop_names = @properties.map(&:name) (dsl_data[:properties] || []).each do |args| @properties << ApipieDSL::MethodDescription.from_dsl_data(self, args) unless prop_names.include?(args.first.to_s) end @refs = (@refs + dsl_data[:refs]).uniq if dsl_data[:refs] @sections = (@sections + dsl_data[:sections]).uniq if dsl_data[:sections] return unless dsl_data[:app_info] ApipieDSL.configuration.app_info[version] = dsl_data[:app_info] end
valid_method_name?(method_name)
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 81 def valid_method_name?(method_name) @methods.keys.map(&:to_s).include?(method_name.to_s) end
version()
click to toggle source
# File lib/apipie_dsl/class_description.rb, line 50 def version @version || @parent.try(:version) || ApipieDSL.configuration.default_version end