Class: Forgejo::CreateRepoOption

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

Overview

CreateRepoOption options when creating repository

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateRepoOption

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
158
159
160
161
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
 
# File 'lib/forgejo/models/create_repo_option.rb', line 131

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auto_init ⇒ Object

Whether the repository should be auto-initialized?



20
21
22
 
# File 'lib/forgejo/models/create_repo_option.rb', line 20

def auto_init
  @auto_init
end

#default_branch ⇒ Object

DefaultBranch of the repository (used when initializes and in template)



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

def default_branch
  @default_branch
end

#description ⇒ Object

Description of the repository to create



26
27
28
 
# File 'lib/forgejo/models/create_repo_option.rb', line 26

def description
  @description
end

#gitignores ⇒ Object

Gitignores to use



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

def gitignores
  @gitignores
end

#issue_labels ⇒ Object

Label-Set to use



32
33
34
 
# File 'lib/forgejo/models/create_repo_option.rb', line 32

def issue_labels
  @issue_labels
end

#license ⇒ Object

License to use



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

def license
  @license
end

#name ⇒ Object

Name of the repository to create



38
39
40
 
# File 'lib/forgejo/models/create_repo_option.rb', line 38

def name
  @name
end

#object_format_name ⇒ Object

ObjectFormatName of the underlying git repository



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

def object_format_name
  @object_format_name
end

#private ⇒ Object

Whether the repository is private



44
45
46
 
# File 'lib/forgejo/models/create_repo_option.rb', line 44

def private
  @private
end

#readme ⇒ Object

Readme of the repository to create



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

def readme
  @readme
end

#template ⇒ Object

Whether the repository is template



50
51
52
 
# File 'lib/forgejo/models/create_repo_option.rb', line 50

def template
  @template
end

#trust_model ⇒ Object

TrustModel of the repository



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

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



308
309
310
311
312
313
314
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
 
# File 'lib/forgejo/models/create_repo_option.rb', line 308

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



96
97
98
 
# File 'lib/forgejo/models/create_repo_option.rb', line 96

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/forgejo/models/create_repo_option.rb', line 101

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/forgejo/models/create_repo_option.rb', line 78

def self.attribute_map
  {
    :'auto_init' => :'auto_init',
    :'default_branch' => :'default_branch',
    :'description' => :'description',
    :'gitignores' => :'gitignores',
    :'issue_labels' => :'issue_labels',
    :'license' => :'license',
    :'name' => :'name',
    :'object_format_name' => :'object_format_name',
    :'private' => :'private',
    :'readme' => :'readme',
    :'template' => :'template',
    :'trust_model' => :'trust_model'
  }
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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/forgejo/models/create_repo_option.rb', line 284

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



124
125
126
127
 
# File 'lib/forgejo/models/create_repo_option.rb', line 124

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

.openapi_types ⇒ Object

Attribute type mapping.



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/forgejo/models/create_repo_option.rb', line 106

def self.openapi_types
  {
    :'auto_init' => :'Boolean',
    :'default_branch' => :'String',
    :'description' => :'String',
    :'gitignores' => :'String',
    :'issue_labels' => :'String',
    :'license' => :'String',
    :'name' => :'String',
    :'object_format_name' => :'String',
    :'private' => :'Boolean',
    :'readme' => :'String',
    :'template' => :'Boolean',
    :'trust_model' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/forgejo/models/create_repo_option.rb', line 252

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_init == o.auto_init &&
      default_branch == o.default_branch &&
      description == o.description &&
      gitignores == o.gitignores &&
      issue_labels == o.issue_labels &&
      license == o.license &&
      name == o.name &&
      object_format_name == o.object_format_name &&
      private == o.private &&
      readme == o.readme &&
      template == o.template &&
      trust_model == o.trust_model
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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/forgejo/models/create_repo_option.rb', line 379

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


271
272
273
 
# File 'lib/forgejo/models/create_repo_option.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/forgejo/models/create_repo_option.rb', line 277

def hash
  [auto_init, default_branch, description, gitignores, issue_labels, license, name, object_format_name, private, readme, template, trust_model].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



198
199
200
201
202
203
204
205
206
 
# File 'lib/forgejo/models/create_repo_option.rb', line 198

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name 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



355
356
357
 
# File 'lib/forgejo/models/create_repo_option.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/forgejo/models/create_repo_option.rb', line 361

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



349
350
351
 
# File 'lib/forgejo/models/create_repo_option.rb', line 349

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



210
211
212
213
214
215
216
217
218
 
# File 'lib/forgejo/models/create_repo_option.rb', line 210

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  object_format_name_validator = EnumAttributeValidator.new('String', ["sha1", "sha256"])
  return false unless object_format_name_validator.valid?(@object_format_name)
  trust_model_validator = EnumAttributeValidator.new('String', ["default", "collaborator", "committer", "collaboratorcommitter"])
  return false unless trust_model_validator.valid?(@trust_model)
  true
end