Class: WordsApi::SyllableDetails

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/words_api/models/syllable_details.rb

Overview

This custom type contains the syllable details for word API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(count = SKIP, list = SKIP) ⇒ SyllableDetails

Returns a new instance of SyllableDetails.



41
42
43
44
 
# File 'lib/words_api/models/syllable_details.rb', line 41

def initialize(count = SKIP, list = SKIP)
  @count = count unless count == SKIP
  @list = list unless list == SKIP
end

Instance Attribute Details

#count ⇒ Integer

The count of syllables.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/words_api/models/syllable_details.rb', line 14

def count
  @count
end

#list ⇒ Array[String]

The list of syllables.

Returns:

  • (Array[String]) 


18
19
20
 
# File 'lib/words_api/models/syllable_details.rb', line 18

def list
  @list
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/words_api/models/syllable_details.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  count = hash.key?('count') ? hash['count'] : SKIP
  list = hash.key?('list') ? hash['list'] : SKIP

  # Create object from extracted values.
  SyllableDetails.new(count,
                      list)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/words_api/models/syllable_details.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['count'] = 'count'
  @_hash['list'] = 'list'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/words_api/models/syllable_details.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/words_api/models/syllable_details.rb', line 29

def self.optionals
  %w[
    count
    list
  ]
end