Class: Forgejo::ChangeFileOperation

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

Overview

ChangeFileOperation for creating, updating or deleting a file

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChangeFileOperation

Initializes the object



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

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

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

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

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

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

Instance Attribute Details

#content ⇒ Object

new or updated file content, must be base64 encoded



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

def content
  @content
end

#from_path ⇒ Object

old path of the file to move



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

def from_path
  @from_path
end

#operation ⇒ Object

indicates what to do with the file



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

def operation
  @operation
end

#path ⇒ Object

path to the existing or new file



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

def path
  @path
end

#sha ⇒ Object

sha is the SHA for the file that already exists, required for update or delete



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

def sha
  @sha
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/forgejo/models/change_file_operation.rb', line 233

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



68
69
70
 
# File 'lib/forgejo/models/change_file_operation.rb', line 68

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/forgejo/models/change_file_operation.rb', line 73

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/forgejo/models/change_file_operation.rb', line 57

def self.attribute_map
  {
    :'content' => :'content',
    :'from_path' => :'from_path',
    :'operation' => :'operation',
    :'path' => :'path',
    :'sha' => :'sha'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/forgejo/models/change_file_operation.rb', line 209

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



89
90
91
92
 
# File 'lib/forgejo/models/change_file_operation.rb', line 89

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
 
# File 'lib/forgejo/models/change_file_operation.rb', line 78

def self.openapi_types
  {
    :'content' => :'String',
    :'from_path' => :'String',
    :'operation' => :'String',
    :'path' => :'String',
    :'sha' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



184
185
186
187
188
189
190
191
192
 
# File 'lib/forgejo/models/change_file_operation.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      from_path == o.from_path &&
      operation == o.operation &&
      path == o.path &&
      sha == o.sha
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/forgejo/models/change_file_operation.rb', line 304

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

See Also:

  • `==` method


196
197
198
 
# File 'lib/forgejo/models/change_file_operation.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



202
203
204
 
# File 'lib/forgejo/models/change_file_operation.rb', line 202

def hash
  [content, from_path, operation, path, sha].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/forgejo/models/change_file_operation.rb', line 137

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @operation.nil?
    invalid_properties.push('invalid value for "operation", operation cannot be nil.')
  end

  if @path.nil?
    invalid_properties.push('invalid value for "path", path cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



280
281
282
 
# File 'lib/forgejo/models/change_file_operation.rb', line 280

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/forgejo/models/change_file_operation.rb', line 286

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



274
275
276
 
# File 'lib/forgejo/models/change_file_operation.rb', line 274

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



153
154
155
156
157
158
159
160
 
# File 'lib/forgejo/models/change_file_operation.rb', line 153

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @operation.nil?
  operation_validator = EnumAttributeValidator.new('String', ["create", "update", "delete"])
  return false unless operation_validator.valid?(@operation)
  return false if @path.nil?
  true
end