Class: RTFDoc::ResourceDesc

Inherits:
Object
  • Object
show all
Includes:
Anchorable, RenderAsSection
Defined in:
lib/rtfdoc.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Anchorable

#anchor

Methods included from RenderAsSection

#content_to_html, included

Constructor Details

#initialize(resource_name, content) ⇒ ResourceDesc

Returns a new instance of ResourceDesc.



286
287
288
289
 
# File 'lib/rtfdoc.rb', line 286

def initialize(resource_name, content)
  @resource_name  = resource_name
  @content        = content
end

Instance Attribute Details

#resource_name ⇒ Object (readonly)

Returns the value of attribute resource_name.



284
285
286
 
# File 'lib/rtfdoc.rb', line 284

def resource_name
  @resource_name
end

Instance Method Details

#anchor_id ⇒ Object 



295
296
297
 
# File 'lib/rtfdoc.rb', line 295

def anchor_id
  "#{resource_name}-desc"
end

#example_to_html ⇒ Object 



315
316
317
 
# File 'lib/rtfdoc.rb', line 315

def example_to_html
  @example
end

#generate_example(sections) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/rtfdoc.rb', line 299

def generate_example(sections)
  endpoints   = sections.reject { |s| s.is_a?(Scope) || s.name == 'desc' || s.name == 'object' }
  signatures  = endpoints.each_with_object("") do |e, res|
    res << %(<div class="resource-sig">#{e.signature}</div>)
  end
  scopes = sections.select { |s| s.is_a?(Scope) }.map!(&:generate_example).join("\n")

  @example = <<-HTML
  <div class="section-response">
    <div class="response-topbar">ENDPOINTS</div>
    <div class="section-endpoints">#{signatures}</div>
  </div>
  #{scopes}
  HTML
end

#name ⇒ Object 



291
292
293
 
# File 'lib/rtfdoc.rb', line 291

def name
  'desc'
end