Class: Athenian::CalculatedPullRequestMetricsItem

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

Overview

Series of calculated metrics for a specific set of repositories and developers.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CalculatedPullRequestMetricsItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 55

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

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

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

Instance Attribute Details

#_for ⇒ Object

Returns the value of attribute _for.



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

def _for
  @_for
end

#granularity ⇒ Object

How often the metrics are reported. The value must satisfy the following regular expression: /^all|((\d* )?(aligned )?(day|week|month|year))$/. "all" produces a single interval [‘date_from`, `date_to`]. "aligned week/month/year" produces intervals cut by calendar week/month/year borders, for example, when `date_from` is `2020-01-15` and `date_to` is `2020-03-10`, the intervals will be `2020-01-15` - `2020-02-01` - `2020-03-01` - `2020-03-10`.



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

def granularity
  @granularity
end

#values ⇒ Object

The sequence steps from ‘date_from` till `date_to` by `granularity`.



22
23
24
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 22

def values
  @values
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 25

def self.attribute_map
  {
    :'_for' => :'for',
    :'granularity' => :'granularity',
    :'values' => :'values'
  }
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



131
132
133
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 131

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
51
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 39

def self.openapi_types
  {
    :'_for' => :'ForSetPullRequests',
    :'granularity' => :'String',
    :'values' => :'Array<CalculatedLinearMetricValues>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 108

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _for == o._for &&
      granularity == o.granularity &&
      values == o.values
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



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

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 233

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 138

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


118
119
120
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 118

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



124
125
126
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 124

def hash
  [_for, granularity, values].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



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 85

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

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



209
210
211
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 209

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



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 215

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



203
204
205
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 203

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



100
101
102
103
104
 
# File 'lib/athenian/models/calculated_pull_request_metrics_item.rb', line 100

def valid?
  return false if @_for.nil?
  return false if @values.nil?
  true
end