Class: Athenian::ForSetPullRequests

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/models/for_set_pull_requests.rb

Overview

Filter for ‘/metrics/pull_requests` and `/histograms/pull_requests`. Achieve the best performance by packing all your filters in a single `ForSetPullRequests` instead of sending multiple `ForSetPullRequests`-s. For example, use `repogroups` and `withgroups` to request separate metrics for several repository sets and teams.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ForSetPullRequests

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Athenian::ForSetPullRequests` 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 `Athenian::ForSetPullRequests`. 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?(:'repositories')
    self.repositories = attributes[:'repositories']
  end

  if attributes.key?(:'repogroups')
    if (value = attributes[:'repogroups']).is_a?(Array)
      self.repogroups = value
    end
  end

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

  if attributes.key?(:'withgroups')
    if (value = attributes[:'withgroups']).is_a?(Array)
      self.withgroups = value
    end
  end

  if attributes.key?(:'labels_include')
    if (value = attributes[:'labels_include']).is_a?(Array)
      self.labels_include = value
    end
  end

  if attributes.key?(:'labels_exclude')
    if (value = attributes[:'labels_exclude']).is_a?(Array)
      self.labels_exclude = value
    end
  end

  if attributes.key?(:'lines')
    if (value = attributes[:'lines']).is_a?(Array)
      self.lines = value
    end
  end

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

  if attributes.key?(:'jiragroups')
    if (value = attributes[:'jiragroups']).is_a?(Array)
      self.jiragroups = value
    end
  end

  if attributes.key?(:'environments')
    if (value = attributes[:'environments']).is_a?(Array)
      self.environments = value
    end
  end
end

Instance Attribute Details

#environments ⇒ Object

Calculate deployment metrics separately for each environment in the list. Required if any deployment metrics were requested. Histograms are only implemented for single environments.



41
42
43
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 41

def environments
  @environments
end

#jira ⇒ Object

Returns the value of attribute jira.



35
36
37
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 35

def jira
  @jira
end

#jiragroups ⇒ Object

Calculate metrics separately for each JIRA Filter in the list. Not compatible with ‘jira` field.



38
39
40
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 38

def jiragroups
  @jiragroups
end

#labels_exclude ⇒ Object

None of these labels must be present in each analyzed PR.



30
31
32
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 30

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

At least one of these labels must be present in each analyzed PR.



27
28
29
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 27

def labels_include
  @labels_include
end

#lines ⇒ Object

Split by changed number of lines (inserted + removed).



33
34
35
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 33

def lines
  @lines
end

#repogroups ⇒ Object

Lists of indexes in ‘repositories` or `developers` that define independent groups that must be processed individually. The groups may have intersections.



19
20
21
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 19

def repogroups
  @repogroups
end

#repositories ⇒ Object

Returns the value of attribute repositories.



16
17
18
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 16

def repositories
  @repositories
end

#with ⇒ Object

Returns the value of attribute with.



21
22
23
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 21

def with
  @with
end

#withgroups ⇒ Object

Aggregate by groups of PR contributors. Currently, only the groupings by ‘author`, `merger`, and `releaser` are supported. People do not have to be mentioned in `with` in contrast to `repogroups`. We treat `with` as another group, if specified.



24
25
26
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 24

def withgroups
  @withgroups
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 44

def self.attribute_map
  {
    :'repositories' => :'repositories',
    :'repogroups' => :'repogroups',
    :'with' => :'with',
    :'withgroups' => :'withgroups',
    :'labels_include' => :'labels_include',
    :'labels_exclude' => :'labels_exclude',
    :'lines' => :'lines',
    :'jira' => :'jira',
    :'jiragroups' => :'jiragroups',
    :'environments' => :'environments'
  }
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



255
256
257
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 255

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 65

def self.openapi_types
  {
    :'repositories' => :'Array',
    :'repogroups' => :'Array<Array<Integer>>',
    :'with' => :'PullRequestWith',
    :'withgroups' => :'Array<PullRequestWith>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'lines' => :'Array<Integer>',
    :'jira' => :'JIRAFilter',
    :'jiragroups' => :'Array<JIRAFilter>',
    :'environments' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 225

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      repositories == o.repositories &&
      repogroups == o.repogroups &&
      with == o.with &&
      withgroups == o.withgroups &&
      labels_include == o.labels_include &&
      labels_exclude == o.labels_exclude &&
      lines == o.lines &&
      jira == o.jira &&
      jiragroups == o.jiragroups &&
      environments == o.environments
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



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
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 286

def _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 = Athenian.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 357

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 262

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 248

def hash
  [repositories, repogroups, with, withgroups, labels_include, labels_exclude, lines, jira, jiragroups, environments].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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  if !@repogroups.nil? && @repogroups.length < 1
    invalid_properties.push('invalid value for "repogroups", number of items must be greater than or equal to 1.')
  end

  if !@lines.nil? && @lines.length < 2
    invalid_properties.push('invalid value for "lines", number of items must be greater than or equal to 2.')
  end

  if !@environments.nil? && @environments.length > 64
    invalid_properties.push('invalid value for "environments", number of items must be less than or equal to 64.')
  end

  if !@environments.nil? && @environments.length < 1
    invalid_properties.push('invalid value for "environments", number of items must be greater than or equal to 1.')
  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



333
334
335
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 333

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 339

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



327
328
329
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 327

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



181
182
183
184
185
186
187
 
# File 'lib/athenian/models/for_set_pull_requests.rb', line 181

def valid?
  return false if !@repogroups.nil? && @repogroups.length < 1
  return false if !@lines.nil? && @lines.length < 2
  return false if !@environments.nil? && @environments.length > 64
  return false if !@environments.nil? && @environments.length < 1
  true
end