Class: Phrase::Format

Inherits:
Object
  • Object
show all
Defined in:
lib/phrase/models/format.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Format

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/phrase/models/format.rb', line 75

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Phrase::Format` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Phrase::Format`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'api_name')
    self.api_name = attributes[:'api_name']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'extension')
    self.extension = attributes[:'extension']
  end

  if attributes.key?(:'default_encoding')
    self.default_encoding = attributes[:'default_encoding']
  end

  if attributes.key?(:'importable')
    self.importable = attributes[:'importable']
  end

  if attributes.key?(:'exportable')
    self.exportable = attributes[:'exportable']
  end

  if attributes.key?(:'default_file')
    self.default_file = attributes[:'default_file']
  end

  if attributes.key?(:'renders_default_locale')
    self.renders_default_locale = attributes[:'renders_default_locale']
  end

  if attributes.key?(:'includes_locale_information')
    self.includes_locale_information = attributes[:'includes_locale_information']
  end
end

Instance Attribute Details

#api_name ⇒ Object

Identifier used to reference this format in API requests, such as the file_format parameter on the uploads and downloads endpoints.



9
10
11
 
# File 'lib/phrase/models/format.rb', line 9

def api_name
  @api_name
end

#default_encoding ⇒ Object

Default character encoding used when reading or writing files in this format.



18
19
20
 
# File 'lib/phrase/models/format.rb', line 18

def default_encoding
  @default_encoding
end

#default_file ⇒ Object

Conventional file path pattern for this format. Contains locale_name as a placeholder for the locale identifier.



27
28
29
 
# File 'lib/phrase/models/format.rb', line 27

def default_file
  @default_file
end

#description ⇒ Object

Human-readable summary of the format and its typical use case.



12
13
14
 
# File 'lib/phrase/models/format.rb', line 12

def description
  @description
end

#exportable ⇒ Object

Whether locale files can be exported using this format.



24
25
26
 
# File 'lib/phrase/models/format.rb', line 24

def exportable
  @exportable
end

#extension ⇒ Object

Default file extension associated with this format.



15
16
17
 
# File 'lib/phrase/models/format.rb', line 15

def extension
  @extension
end

#importable ⇒ Object

Whether locale files can be imported using this format.



21
22
23
 
# File 'lib/phrase/models/format.rb', line 21

def importable
  @importable
end

#includes_locale_information ⇒ Object

When true, files in this format embed locale information so Phrase can detect the locale automatically on import.



33
34
35
 
# File 'lib/phrase/models/format.rb', line 33

def includes_locale_information
  @includes_locale_information
end

#name ⇒ Object

Human-readable display name of the format.



6
7
8
 
# File 'lib/phrase/models/format.rb', line 6

def name
  @name
end

#renders_default_locale ⇒ Object

When true, exported files contain the default locale’s content for any key that has no translation in the target locale.



30
31
32
 
# File 'lib/phrase/models/format.rb', line 30

def renders_default_locale
  @renders_default_locale
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/phrase/models/format.rb', line 36

def self.attribute_map
  {
    :'name' => :'name',
    :'api_name' => :'api_name',
    :'description' => :'description',
    :'extension' => :'extension',
    :'default_encoding' => :'default_encoding',
    :'importable' => :'importable',
    :'exportable' => :'exportable',
    :'default_file' => :'default_file',
    :'renders_default_locale' => :'renders_default_locale',
    :'includes_locale_information' => :'includes_locale_information'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



224
225
226
 
# File 'lib/phrase/models/format.rb', line 224

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
 
# File 'lib/phrase/models/format.rb', line 68

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/phrase/models/format.rb', line 52

def self.openapi_types
  {
    :'name' => :'String',
    :'api_name' => :'String',
    :'description' => :'String',
    :'extension' => :'String',
    :'default_encoding' => :'String',
    :'importable' => :'Boolean',
    :'exportable' => :'Boolean',
    :'default_file' => :'String',
    :'renders_default_locale' => :'Boolean',
    :'includes_locale_information' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/phrase/models/format.rb', line 194

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      api_name == o.api_name &&
      description == o.description &&
      extension == o.extension &&
      default_encoding == o.default_encoding &&
      importable == o.importable &&
      exportable == o.exportable &&
      default_file == o.default_file &&
      renders_default_locale == o.renders_default_locale &&
      includes_locale_information == o.includes_locale_information
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/phrase/models/format.rb', line 252

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :Time
    Time.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    Phrase.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/phrase/models/format.rb', line 323

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/phrase/models/format.rb', line 231

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/phrase/models/format.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/phrase/models/format.rb', line 217

def hash
  [name, api_name, description, extension, default_encoding, importable, exportable, default_file, renders_default_locale, includes_locale_information].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/phrase/models/format.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @api_name.nil?
    invalid_properties.push('invalid value for "api_name", api_name cannot be nil.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @extension.nil?
    invalid_properties.push('invalid value for "extension", extension cannot be nil.')
  end

  if @default_encoding.nil?
    invalid_properties.push('invalid value for "default_encoding", default_encoding cannot be nil.')
  end

  if @importable.nil?
    invalid_properties.push('invalid value for "importable", importable cannot be nil.')
  end

  if @exportable.nil?
    invalid_properties.push('invalid value for "exportable", exportable cannot be nil.')
  end

  if @default_file.nil?
    invalid_properties.push('invalid value for "default_file", default_file cannot be nil.')
  end

  if @renders_default_locale.nil?
    invalid_properties.push('invalid value for "renders_default_locale", renders_default_locale cannot be nil.')
  end

  if @includes_locale_information.nil?
    invalid_properties.push('invalid value for "includes_locale_information", includes_locale_information cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
 
# File 'lib/phrase/models/format.rb', line 299

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/phrase/models/format.rb', line 305

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



293
294
295
 
# File 'lib/phrase/models/format.rb', line 293

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/phrase/models/format.rb', line 178

def valid?
  return false if @name.nil?
  return false if @api_name.nil?
  return false if @description.nil?
  return false if @extension.nil?
  return false if @default_encoding.nil?
  return false if @importable.nil?
  return false if @exportable.nil?
  return false if @default_file.nil?
  return false if @renders_default_locale.nil?
  return false if @includes_locale_information.nil?
  true
end