Class: Forgejo::Branch

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

Overview

Branch represents a repository branch

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Branch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#commit ⇒ Object

Returns the value of attribute commit.



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

def commit
  @commit
end

#effective_branch_protection_name ⇒ Object

Returns the value of attribute effective_branch_protection_name.



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

def effective_branch_protection_name
  @effective_branch_protection_name
end

#enable_status_check ⇒ Object

Returns the value of attribute enable_status_check.



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

def enable_status_check
  @enable_status_check
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#protected ⇒ Object

Returns the value of attribute protected.



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

def protected
  @protected
end

#required_approvals ⇒ Object

Returns the value of attribute required_approvals.



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

def required_approvals
  @required_approvals
end

#status_check_contexts ⇒ Object

Returns the value of attribute status_check_contexts.



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

def status_check_contexts
  @status_check_contexts
end

#user_can_merge ⇒ Object

Returns the value of attribute user_can_merge.



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

def user_can_merge
  @user_can_merge
end

#user_can_push ⇒ Object

Returns the value of attribute user_can_push.



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

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



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

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



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/forgejo/models/branch.rb', line 58

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/forgejo/models/branch.rb', line 38

def self.attribute_map
  {
    :'commit' => :'commit',
    :'effective_branch_protection_name' => :'effective_branch_protection_name',
    :'enable_status_check' => :'enable_status_check',
    :'name' => :'name',
    :'protected' => :'protected',
    :'required_approvals' => :'required_approvals',
    :'status_check_contexts' => :'status_check_contexts',
    :'user_can_merge' => :'user_can_merge',
    :'user_can_push' => :'user_can_push'
  }
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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/forgejo/models/branch.rb', line 184

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



78
79
80
81
 
# File 'lib/forgejo/models/branch.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/forgejo/models/branch.rb', line 63

def self.openapi_types
  {
    :'commit' => :'PayloadCommit',
    :'effective_branch_protection_name' => :'String',
    :'enable_status_check' => :'Boolean',
    :'name' => :'String',
    :'protected' => :'Boolean',
    :'required_approvals' => :'Integer',
    :'status_check_contexts' => :'Array<String>',
    :'user_can_merge' => :'Boolean',
    :'user_can_push' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/forgejo/models/branch.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commit == o.commit &&
      effective_branch_protection_name == o.effective_branch_protection_name &&
      enable_status_check == o.enable_status_check &&
      name == o.name &&
      protected == o.protected &&
      required_approvals == o.required_approvals &&
      status_check_contexts == o.status_check_contexts &&
      user_can_merge == o.user_can_merge &&
      user_can_push == o.user_can_push
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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/forgejo/models/branch.rb', line 279

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


171
172
173
 
# File 'lib/forgejo/models/branch.rb', line 171

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/forgejo/models/branch.rb', line 177

def hash
  [commit, effective_branch_protection_name, enable_status_check, name, protected, required_approvals, status_check_contexts, user_can_merge, user_can_push].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



140
141
142
143
144
 
# File 'lib/forgejo/models/branch.rb', line 140

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



255
256
257
 
# File 'lib/forgejo/models/branch.rb', line 255

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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/forgejo/models/branch.rb', line 261

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



249
250
251
 
# File 'lib/forgejo/models/branch.rb', line 249

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



148
149
150
151
 
# File 'lib/forgejo/models/branch.rb', line 148

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