Class: Athenian::ForSetCodeChecks

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

Overview

Filters for ‘/metrics/code_checks` and `/histograms/code_checks`. Achieve the best performance by packing all your filters in a single `ForSetCodeChecks` instead of sending multiple `ForSetCodeChecks`-s. For example, use `repogroups` and `pushers` 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 = {}) ⇒ ForSetCodeChecks

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 80

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

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

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

  if attributes.key?(:'pusher_groups')
    if (value = attributes[:'pusher_groups']).is_a?(Array)
      self.pusher_groups = 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?(:'jira')
    self.jira = attributes[:'jira']
  end

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

Instance Attribute Details

#jira ⇒ Object

Returns the value of attribute jira.



34
35
36
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 34

def jira
  @jira
end

#labels_exclude ⇒ Object

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



32
33
34
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 32

def labels_exclude
  @labels_exclude
end

#labels_include ⇒ Object

At least one of these labels must be present in the checked PRs.



29
30
31
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 29

def labels_include
  @labels_include
end

#lines ⇒ Object

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



37
38
39
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 37

def lines
  @lines
end

#pusher_groups ⇒ Object

Check runs must be triggered by commits authored by these people. We aggregate by each group so that you can request metrics of several teams at once. We treat ‘pushers` as another group, if specified.



26
27
28
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 26

def pusher_groups
  @pusher_groups
end

#pushers ⇒ Object

Check runs must be triggered by commits pushed by these people. When it is impossible to determine who pushed, e.g. in legacy API based checks, they are committers. It is possible to mention whole teams using the syntax ‘id` where `id` is a team identifier (see `/teams`).



23
24
25
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 23

def pushers
  @pushers
end

#repogroups ⇒ Object

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



20
21
22
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 20

def repogroups
  @repogroups
end

#repositories ⇒ Object

Set of repositories. An empty list raises a bad response 400. Duplicates are automatically ignored.



17
18
19
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 17

def repositories
  @repositories
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



54
55
56
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 40

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



218
219
220
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 218

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



73
74
75
76
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 73

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

.openapi_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 59

def self.openapi_types
  {
    :'repositories' => :'Array<String>',
    :'repogroups' => :'Array<Array<Integer>>',
    :'pushers' => :'Array<String>',
    :'pusher_groups' => :'Array<Array>',
    :'labels_include' => :'Array<String>',
    :'labels_exclude' => :'Array<String>',
    :'jira' => :'ForSetCodeChecksJira',
    :'lines' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 190

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



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

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



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 320

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 225

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


205
206
207
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 205

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



211
212
213
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 211

def hash
  [repositories, repogroups, pushers, pusher_groups, labels_include, labels_exclude, jira, lines].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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 142

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

  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

  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



296
297
298
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 296

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 302

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



290
291
292
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 290

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



161
162
163
164
165
166
 
# File 'lib/athenian/models/for_set_code_checks.rb', line 161

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