Class: Jdoc::Property

Inherits:

Object

• Object
• Jdoc::Property

Defined in:

lib/jdoc/property.rb

Instance Attribute Summary

• #name ⇒ Object readonly

  Returns the value of attribute name.

Instance Method Summary

• #description ⇒ String^?

  Description text, defined in description property.

• #example ⇒ String^?

  Example value, defined in example property.

• #format ⇒ Stirng^?

  Format constraint, defined in format property.

• #initialize(name: nil, schema: nil) ⇒ Property constructor

  A new instance of Property.

• #options ⇒ Hash

  Key-Value pair of metadata of this property.

• #pattern ⇒ String^?

  Pattern constraint, defined in pattern property.

• #read_only ⇒ true^?

  True if readOnly property is defined and it’s true.

• #type ⇒ String^?

  Possible types defined in type property.

Constructor Details

#initialize(name: nil, schema: nil) ⇒ Property

# File 'lib/jdoc/property.rb', line 7

def initialize(name: nil, schema: nil)
  @name = name
  @schema = schema
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.

# File 'lib/jdoc/property.rb', line 3

def name
  @name
end

Instance Method Details

#description ⇒ String^?

# File 'lib/jdoc/property.rb', line 24

def description
  @schema.description
end

#example ⇒ String^?

# File 'lib/jdoc/property.rb', line 29

def example
  if @schema.data.has_key?("example")
    %<`#{@schema.data["example"].inspect}`>
  end
end

#format ⇒ Stirng^?

# File 'lib/jdoc/property.rb', line 43

def format
  @schema.format
end

#options ⇒ Hash

# File 'lib/jdoc/property.rb', line 13

def options
  {
    Example: example,
    Type: type,
    Format: format,
    Patern: pattern,
    ReadOnly: read_only,
  }.reject {|key, value| value.nil? }
end

#pattern ⇒ String^?

# File 'lib/jdoc/property.rb', line 36

def pattern
  if str = @schema.pattern
    "`#{str}`"
  end
end

#read_only ⇒ true^?

# File 'lib/jdoc/property.rb', line 48

def read_only
  true if @schema.read_only == true
end

#type ⇒ String^?

# File 'lib/jdoc/property.rb', line 53

def type
  if @schema.type
    @schema.type.join(", ")
  end
end