Class: Jdoc::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/jdoc/resource.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema) ⇒ Resource

Returns a new instance of Resource.

Parameters:

  • schema (JsonSchema::Schema) 


6
7
8
 
# File 'lib/jdoc/resource.rb', line 6

def initialize(schema)
  @schema = schema
end

Instance Attribute Details

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



3
4
5
 
# File 'lib/jdoc/resource.rb', line 3

def schema
  @schema
end

Instance Method Details

#anchor ⇒ String

Returns Href anchor for putting link in ToC.

Examples:

resource.anchor #=> "#app"

Returns:

  • (String) —

    Href anchor for putting link in ToC



20
21
22
 
# File 'lib/jdoc/resource.rb', line 20

def anchor
  "#" + title.gsub(" ", "-").gsub(/[:\/]/, "").downcase
end

#description ⇒ String

Returns Description for this schema, defined in description property.

Examples:

resource.description #=> "An app is a program to be deployed."

Returns:

  • (String) —

    Description for this schema, defined in description property



13
14
15
 
# File 'lib/jdoc/resource.rb', line 13

def description
  @schema.description
end

#eql?(other) ⇒ Boolean

Defined to change uniqueness in Hash key

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/jdoc/resource.rb', line 51

def eql?(other)
  @schema.eql?(other.schema)
end

#hash ⇒ Object

Defined to change uniqueness in Hash key



46
47
48
 
# File 'lib/jdoc/resource.rb', line 46

def hash
  @schema.hash
end

#hyperlink ⇒ String

Returns Markdown styled link text for this resource.

Examples:

resource.hyperlink #=> "[App](#apps)"

Returns:

  • (String) —

    Markdown styled link text for this resource



27
28
29
 
# File 'lib/jdoc/resource.rb', line 27

def hyperlink
  "[#{title}](#{anchor})"
end

#properties ⇒ Array<Jdoc::Property>

Returns:



39
40
41
42
43
 
# File 'lib/jdoc/resource.rb', line 39

def properties
  @schema.properties.map do |name, schema|
    Property.new(name: name, schema: schema)
  end
end

#title ⇒ String

Returns Title defined in title property.

Examples:

resource.title #=> "App"

Returns:

  • (String) —

    Title defined in title property



34
35
36
 
# File 'lib/jdoc/resource.rb', line 34

def title
  @schema.title
end