Class: Forgejo::TimelineComment

Inherits:
Object
  • Object
show all
Defined in:
lib/forgejo/models/timeline_comment.rb

Overview

TimelineComment represents a timeline comment (comment of any type) on a commit or issue

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimelineComment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
290
291
292
293
294
295
296
 
# File 'lib/forgejo/models/timeline_comment.rb', line 167

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#assignee ⇒ Object

Returns the value of attribute assignee.



19
20
21
 
# File 'lib/forgejo/models/timeline_comment.rb', line 19

def assignee
  @assignee
end

#assignee_team ⇒ Object

Returns the value of attribute assignee_team.



21
22
23
 
# File 'lib/forgejo/models/timeline_comment.rb', line 21

def assignee_team
  @assignee_team
end

#body ⇒ Object

Returns the value of attribute body.



23
24
25
 
# File 'lib/forgejo/models/timeline_comment.rb', line 23

def body
  @body
end

#created_at ⇒ Object

Returns the value of attribute created_at.



25
26
27
 
# File 'lib/forgejo/models/timeline_comment.rb', line 25

def created_at
  @created_at
end

#dependent_issue ⇒ Object

Returns the value of attribute dependent_issue.



27
28
29
 
# File 'lib/forgejo/models/timeline_comment.rb', line 27

def dependent_issue
  @dependent_issue
end

#html_url ⇒ Object

Returns the value of attribute html_url.



29
30
31
 
# File 'lib/forgejo/models/timeline_comment.rb', line 29

def html_url
  @html_url
end

#id ⇒ Object

Returns the value of attribute id.



31
32
33
 
# File 'lib/forgejo/models/timeline_comment.rb', line 31

def id
  @id
end

#issue_url ⇒ Object

Returns the value of attribute issue_url.



33
34
35
 
# File 'lib/forgejo/models/timeline_comment.rb', line 33

def issue_url
  @issue_url
end

#label ⇒ Object

Returns the value of attribute label.



35
36
37
 
# File 'lib/forgejo/models/timeline_comment.rb', line 35

def label
  @label
end

#milestone ⇒ Object

Returns the value of attribute milestone.



37
38
39
 
# File 'lib/forgejo/models/timeline_comment.rb', line 37

def milestone
  @milestone
end

#new_ref ⇒ Object

Returns the value of attribute new_ref.



39
40
41
 
# File 'lib/forgejo/models/timeline_comment.rb', line 39

def new_ref
  @new_ref
end

#new_title ⇒ Object

Returns the value of attribute new_title.



41
42
43
 
# File 'lib/forgejo/models/timeline_comment.rb', line 41

def new_title
  @new_title
end

#old_milestone ⇒ Object

Returns the value of attribute old_milestone.



43
44
45
 
# File 'lib/forgejo/models/timeline_comment.rb', line 43

def old_milestone
  @old_milestone
end

#old_project_id ⇒ Object

Returns the value of attribute old_project_id.



45
46
47
 
# File 'lib/forgejo/models/timeline_comment.rb', line 45

def old_project_id
  @old_project_id
end

#old_ref ⇒ Object

Returns the value of attribute old_ref.



47
48
49
 
# File 'lib/forgejo/models/timeline_comment.rb', line 47

def old_ref
  @old_ref
end

#old_title ⇒ Object

Returns the value of attribute old_title.



49
50
51
 
# File 'lib/forgejo/models/timeline_comment.rb', line 49

def old_title
  @old_title
end

#project_id ⇒ Object

Returns the value of attribute project_id.



51
52
53
 
# File 'lib/forgejo/models/timeline_comment.rb', line 51

def project_id
  @project_id
end

#pull_request_url ⇒ Object

Returns the value of attribute pull_request_url.



53
54
55
 
# File 'lib/forgejo/models/timeline_comment.rb', line 53

def pull_request_url
  @pull_request_url
end

#ref_action ⇒ Object

Returns the value of attribute ref_action.



55
56
57
 
# File 'lib/forgejo/models/timeline_comment.rb', line 55

def ref_action
  @ref_action
end

#ref_comment ⇒ Object

Returns the value of attribute ref_comment.



57
58
59
 
# File 'lib/forgejo/models/timeline_comment.rb', line 57

def ref_comment
  @ref_comment
end

#ref_commit_sha ⇒ Object

commit SHA where issue/PR was referenced



60
61
62
 
# File 'lib/forgejo/models/timeline_comment.rb', line 60

def ref_commit_sha
  @ref_commit_sha
end

#ref_issue ⇒ Object

Returns the value of attribute ref_issue.



62
63
64
 
# File 'lib/forgejo/models/timeline_comment.rb', line 62

def ref_issue
  @ref_issue
end

#removed_assignee ⇒ Object

whether the assignees were removed or added



65
66
67
 
# File 'lib/forgejo/models/timeline_comment.rb', line 65

def removed_assignee
  @removed_assignee
end

#resolve_doer ⇒ Object

Returns the value of attribute resolve_doer.



67
68
69
 
# File 'lib/forgejo/models/timeline_comment.rb', line 67

def resolve_doer
  @resolve_doer
end

#review_id ⇒ Object

Returns the value of attribute review_id.



69
70
71
 
# File 'lib/forgejo/models/timeline_comment.rb', line 69

def review_id
  @review_id
end

#tracked_time ⇒ Object

Returns the value of attribute tracked_time.



71
72
73
 
# File 'lib/forgejo/models/timeline_comment.rb', line 71

def tracked_time
  @tracked_time
end

#type ⇒ Object

Returns the value of attribute type.



73
74
75
 
# File 'lib/forgejo/models/timeline_comment.rb', line 73

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



75
76
77
 
# File 'lib/forgejo/models/timeline_comment.rb', line 75

def updated_at
  @updated_at
end

#user ⇒ Object

Returns the value of attribute user.



77
78
79
 
# File 'lib/forgejo/models/timeline_comment.rb', line 77

def user
  @user
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/forgejo/models/timeline_comment.rb', line 388

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 = Forgejo.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



115
116
117
 
# File 'lib/forgejo/models/timeline_comment.rb', line 115

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



120
121
122
 
# File 'lib/forgejo/models/timeline_comment.rb', line 120

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/forgejo/models/timeline_comment.rb', line 80

def self.attribute_map
  {
    :'assignee' => :'assignee',
    :'assignee_team' => :'assignee_team',
    :'body' => :'body',
    :'created_at' => :'created_at',
    :'dependent_issue' => :'dependent_issue',
    :'html_url' => :'html_url',
    :'id' => :'id',
    :'issue_url' => :'issue_url',
    :'label' => :'label',
    :'milestone' => :'milestone',
    :'new_ref' => :'new_ref',
    :'new_title' => :'new_title',
    :'old_milestone' => :'old_milestone',
    :'old_project_id' => :'old_project_id',
    :'old_ref' => :'old_ref',
    :'old_title' => :'old_title',
    :'project_id' => :'project_id',
    :'pull_request_url' => :'pull_request_url',
    :'ref_action' => :'ref_action',
    :'ref_comment' => :'ref_comment',
    :'ref_commit_sha' => :'ref_commit_sha',
    :'ref_issue' => :'ref_issue',
    :'removed_assignee' => :'removed_assignee',
    :'resolve_doer' => :'resolve_doer',
    :'review_id' => :'review_id',
    :'tracked_time' => :'tracked_time',
    :'type' => :'type',
    :'updated_at' => :'updated_at',
    :'user' => :'user'
  }
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



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/forgejo/models/timeline_comment.rb', line 364

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



160
161
162
163
 
# File 'lib/forgejo/models/timeline_comment.rb', line 160

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
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
 
# File 'lib/forgejo/models/timeline_comment.rb', line 125

def self.openapi_types
  {
    :'assignee' => :'User',
    :'assignee_team' => :'Team',
    :'body' => :'String',
    :'created_at' => :'Time',
    :'dependent_issue' => :'Issue',
    :'html_url' => :'String',
    :'id' => :'Integer',
    :'issue_url' => :'String',
    :'label' => :'Label',
    :'milestone' => :'Milestone',
    :'new_ref' => :'String',
    :'new_title' => :'String',
    :'old_milestone' => :'Milestone',
    :'old_project_id' => :'Integer',
    :'old_ref' => :'String',
    :'old_title' => :'String',
    :'project_id' => :'Integer',
    :'pull_request_url' => :'String',
    :'ref_action' => :'String',
    :'ref_comment' => :'Comment',
    :'ref_commit_sha' => :'String',
    :'ref_issue' => :'Issue',
    :'removed_assignee' => :'Boolean',
    :'resolve_doer' => :'User',
    :'review_id' => :'Integer',
    :'tracked_time' => :'TrackedTime',
    :'type' => :'String',
    :'updated_at' => :'Time',
    :'user' => :'User'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/forgejo/models/timeline_comment.rb', line 315

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      assignee == o.assignee &&
      assignee_team == o.assignee_team &&
      body == o.body &&
      created_at == o.created_at &&
      dependent_issue == o.dependent_issue &&
      html_url == o.html_url &&
      id == o.id &&
      issue_url == o.issue_url &&
      label == o.label &&
      milestone == o.milestone &&
      new_ref == o.new_ref &&
      new_title == o.new_title &&
      old_milestone == o.old_milestone &&
      old_project_id == o.old_project_id &&
      old_ref == o.old_ref &&
      old_title == o.old_title &&
      project_id == o.project_id &&
      pull_request_url == o.pull_request_url &&
      ref_action == o.ref_action &&
      ref_comment == o.ref_comment &&
      ref_commit_sha == o.ref_commit_sha &&
      ref_issue == o.ref_issue &&
      removed_assignee == o.removed_assignee &&
      resolve_doer == o.resolve_doer &&
      review_id == o.review_id &&
      tracked_time == o.tracked_time &&
      type == o.type &&
      updated_at == o.updated_at &&
      user == o.user
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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/forgejo/models/timeline_comment.rb', line 459

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


351
352
353
 
# File 'lib/forgejo/models/timeline_comment.rb', line 351

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



357
358
359
 
# File 'lib/forgejo/models/timeline_comment.rb', line 357

def hash
  [assignee, assignee_team, body, created_at, dependent_issue, html_url, id, issue_url, label, milestone, new_ref, new_title, old_milestone, old_project_id, old_ref, old_title, project_id, pull_request_url, ref_action, ref_comment, ref_commit_sha, ref_issue, removed_assignee, resolve_doer, review_id, tracked_time, type, updated_at, user].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



300
301
302
303
304
 
# File 'lib/forgejo/models/timeline_comment.rb', line 300

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



435
436
437
 
# File 'lib/forgejo/models/timeline_comment.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/forgejo/models/timeline_comment.rb', line 441

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



429
430
431
 
# File 'lib/forgejo/models/timeline_comment.rb', line 429

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



308
309
310
311
 
# File 'lib/forgejo/models/timeline_comment.rb', line 308

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end