Class: Weblate::Project

Inherits:
Object
  • Object
show all
Defined in:
lib/weblate/models/project.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Project

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/weblate/models/project.rb', line 137

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Weblate::Project` 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 `Weblate::Project`. 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']
  else
    self.name = nil
  end

  if attributes.key?(:'slug')
    self.slug = attributes[:'slug']
  else
    self.slug = nil
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

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

  if attributes.key?(:'web_url')
    self.web_url = attributes[:'web_url']
  else
    self.web_url = nil
  end

  if attributes.key?(:'url')
    self.url = attributes[:'url']
  else
    self.url = nil
  end

  if attributes.key?(:'components_list_url')
    self.components_list_url = attributes[:'components_list_url']
  else
    self.components_list_url = nil
  end

  if attributes.key?(:'repository_url')
    self.repository_url = attributes[:'repository_url']
  else
    self.repository_url = nil
  end

  if attributes.key?(:'statistics_url')
    self.statistics_url = attributes[:'statistics_url']
  else
    self.statistics_url = nil
  end

  if attributes.key?(:'categories_url')
    self.categories_url = attributes[:'categories_url']
  else
    self.categories_url = nil
  end

  if attributes.key?(:'changes_list_url')
    self.changes_list_url = attributes[:'changes_list_url']
  else
    self.changes_list_url = nil
  end

  if attributes.key?(:'languages_url')
    self.languages_url = attributes[:'languages_url']
  else
    self.languages_url = nil
  end

  if attributes.key?(:'labels_url')
    self.labels_url = attributes[:'labels_url']
  else
    self.labels_url = nil
  end

  if attributes.key?(:'credits_url')
    self.credits_url = attributes[:'credits_url']
  else
    self.credits_url = nil
  end

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

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

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

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

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

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

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

Instance Attribute Details

#categories_url ⇒ Object

Returns the value of attribute categories_url.



39
40
41
 
# File 'lib/weblate/models/project.rb', line 39

def categories_url
  @categories_url
end

#changes_list_url ⇒ Object

Returns the value of attribute changes_list_url.



41
42
43
 
# File 'lib/weblate/models/project.rb', line 41

def changes_list_url
  @changes_list_url
end

#components_list_url ⇒ Object

Returns the value of attribute components_list_url.



33
34
35
 
# File 'lib/weblate/models/project.rb', line 33

def components_list_url
  @components_list_url
end

#credits_url ⇒ Object

Returns the value of attribute credits_url.



47
48
49
 
# File 'lib/weblate/models/project.rb', line 47

def credits_url
  @credits_url
end

#enable_hooks ⇒ Object

Whether to allow updating this repository by remote hooks.



62
63
64
 
# File 'lib/weblate/models/project.rb', line 62

def enable_hooks
  @enable_hooks
end

#enforced_2fa ⇒ Object

Requires contributors to have two-factor authentication configured before being able to contribute.



68
69
70
 
# File 'lib/weblate/models/project.rb', line 68

def enforced_2fa
  @enforced_2fa
end

#id ⇒ Object

Returns the value of attribute id.



24
25
26
 
# File 'lib/weblate/models/project.rb', line 24

def id
  @id
end

#instructions ⇒ Object

You can use Markdown and mention users by @username.



59
60
61
 
# File 'lib/weblate/models/project.rb', line 59

def instructions
  @instructions
end

#labels_url ⇒ Object

Returns the value of attribute labels_url.



45
46
47
 
# File 'lib/weblate/models/project.rb', line 45

def labels_url
  @labels_url
end

#language_aliases ⇒ Object

Comma-separated list of language code mappings, for example: en_GB:en,en_US:en



65
66
67
 
# File 'lib/weblate/models/project.rb', line 65

def language_aliases
  @language_aliases
end

#languages_url ⇒ Object

Returns the value of attribute languages_url.



43
44
45
 
# File 'lib/weblate/models/project.rb', line 43

def languages_url
  @languages_url
end

#name ⇒ Object

Display name



19
20
21
 
# File 'lib/weblate/models/project.rb', line 19

def name
  @name
end

#repository_url ⇒ Object

Returns the value of attribute repository_url.



35
36
37
 
# File 'lib/weblate/models/project.rb', line 35

def repository_url
  @repository_url
end

#set_language_team ⇒ Object

Lets Weblate update the "Language-Team" file header of your project.



56
57
58
 
# File 'lib/weblate/models/project.rb', line 56

def set_language_team
  @set_language_team
end

#slug ⇒ Object

Name used in URLs and filenames.



22
23
24
 
# File 'lib/weblate/models/project.rb', line 22

def slug
  @slug
end

#source_review ⇒ Object

Requires dedicated reviewers to approve source strings.



53
54
55
 
# File 'lib/weblate/models/project.rb', line 53

def source_review
  @source_review
end

#statistics_url ⇒ Object

Returns the value of attribute statistics_url.



37
38
39
 
# File 'lib/weblate/models/project.rb', line 37

def statistics_url
  @statistics_url
end

#translation_review ⇒ Object

Requires dedicated reviewers to approve translations.



50
51
52
 
# File 'lib/weblate/models/project.rb', line 50

def translation_review
  @translation_review
end

#url ⇒ Object

Returns the value of attribute url.



31
32
33
 
# File 'lib/weblate/models/project.rb', line 31

def url
  @url
end

#web ⇒ Object

Main website of translated project.



27
28
29
 
# File 'lib/weblate/models/project.rb', line 27

def web
  @web
end

#web_url ⇒ Object

Returns the value of attribute web_url.



29
30
31
 
# File 'lib/weblate/models/project.rb', line 29

def web_url
  @web_url
end

Class Method Details

._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



476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/weblate/models/project.rb', line 476

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.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
    # models (e.g. Pet) or oneOf
    klass = Weblate.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/weblate/models/project.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/weblate/models/project.rb', line 71

def self.attribute_map
  {
    :'name' => :'name',
    :'slug' => :'slug',
    :'id' => :'id',
    :'web' => :'web',
    :'web_url' => :'web_url',
    :'url' => :'url',
    :'components_list_url' => :'components_list_url',
    :'repository_url' => :'repository_url',
    :'statistics_url' => :'statistics_url',
    :'categories_url' => :'categories_url',
    :'changes_list_url' => :'changes_list_url',
    :'languages_url' => :'languages_url',
    :'labels_url' => :'labels_url',
    :'credits_url' => :'credits_url',
    :'translation_review' => :'translation_review',
    :'source_review' => :'source_review',
    :'set_language_team' => :'set_language_team',
    :'instructions' => :'instructions',
    :'enable_hooks' => :'enable_hooks',
    :'language_aliases' => :'language_aliases',
    :'enforced_2fa' => :'enforced_2fa'
  }
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



452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/weblate/models/project.rb', line 452

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



130
131
132
133
 
# File 'lib/weblate/models/project.rb', line 130

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

.openapi_types ⇒ Object

Attribute type mapping.



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/weblate/models/project.rb', line 103

def self.openapi_types
  {
    :'name' => :'String',
    :'slug' => :'String',
    :'id' => :'Integer',
    :'web' => :'String',
    :'web_url' => :'String',
    :'url' => :'String',
    :'components_list_url' => :'String',
    :'repository_url' => :'String',
    :'statistics_url' => :'String',
    :'categories_url' => :'String',
    :'changes_list_url' => :'String',
    :'languages_url' => :'String',
    :'labels_url' => :'String',
    :'credits_url' => :'String',
    :'translation_review' => :'Boolean',
    :'source_review' => :'Boolean',
    :'set_language_team' => :'Boolean',
    :'instructions' => :'String',
    :'enable_hooks' => :'Boolean',
    :'language_aliases' => :'String',
    :'enforced_2fa' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/weblate/models/project.rb', line 411

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      slug == o.slug &&
      id == o.id &&
      web == o.web &&
      web_url == o.web_url &&
      url == o.url &&
      components_list_url == o.components_list_url &&
      repository_url == o.repository_url &&
      statistics_url == o.statistics_url &&
      categories_url == o.categories_url &&
      changes_list_url == o.changes_list_url &&
      languages_url == o.languages_url &&
      labels_url == o.labels_url &&
      credits_url == o.credits_url &&
      translation_review == o.translation_review &&
      source_review == o.source_review &&
      set_language_team == o.set_language_team &&
      instructions == o.instructions &&
      enable_hooks == o.enable_hooks &&
      language_aliases == o.language_aliases &&
      enforced_2fa == o.enforced_2fa
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



547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/weblate/models/project.rb', line 547

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


439
440
441
 
# File 'lib/weblate/models/project.rb', line 439

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



445
446
447
 
# File 'lib/weblate/models/project.rb', line 445

def hash
  [name, slug, id, web, web_url, url, components_list_url, repository_url, statistics_url, categories_url, changes_list_url, languages_url, labels_url, credits_url, translation_review, source_review, set_language_team, instructions, enable_hooks, language_aliases, enforced_2fa].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



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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/weblate/models/project.rb', line 263

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length > 60
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 60.')
  end

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

  if @slug.to_s.length > 60
    invalid_properties.push('invalid value for "slug", the character length must be smaller than or equal to 60.')
  end

  pattern = Regexp.new(/^[-a-zA-Z0-9_]+$/)
  if @slug !~ pattern
    invalid_properties.push("invalid value for \"slug\", must conform to the pattern #{pattern}.")
  end

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

  if !@web.nil? && @web.to_s.length > 200
    invalid_properties.push('invalid value for "web", the character length must be smaller than or equal to 200.')
  end

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

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

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

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

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

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

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

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

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

  if @credits_url.nil?
    invalid_properties.push('invalid value for "credits_url", credits_url 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



523
524
525
 
# File 'lib/weblate/models/project.rb', line 523

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



529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'lib/weblate/models/project.rb', line 529

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



517
518
519
 
# File 'lib/weblate/models/project.rb', line 517

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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/weblate/models/project.rb', line 340

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @name.to_s.length > 60
  return false if @slug.nil?
  return false if @slug.to_s.length > 60
  return false if @slug !~ Regexp.new(/^[-a-zA-Z0-9_]+$/)
  return false if @id.nil?
  return false if !@web.nil? && @web.to_s.length > 200
  return false if @web_url.nil?
  return false if @url.nil?
  return false if @components_list_url.nil?
  return false if @repository_url.nil?
  return false if @statistics_url.nil?
  return false if @categories_url.nil?
  return false if @changes_list_url.nil?
  return false if @languages_url.nil?
  return false if @labels_url.nil?
  return false if @credits_url.nil?
  true
end