Module: Fog::Attributes::InstanceMethods

Included in:
Collection, Model
Defined in:
lib/fog/core/attributes.rb

Instance Method Summary collapse

Instance Method Details

#_dump(_level) ⇒ Object 



72
73
74
 
# File 'lib/fog/core/attributes.rb', line 72

def _dump(_level)
  Marshal.dump(attributes)
end

#all_associations ⇒ Object 



101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/fog/core/attributes.rb', line 101

def all_associations
  self.class.associations.keys.reduce({}) do |hash, association|
    if masks[association].nil?
      Fog::Logger.deprecation("Please define #{association} using the Fog DSL")
      hash[association] = associations[association] || send(association)
    else
      hash[masks[association]] = associations[association] || send(association)
    end

    hash
  end
end

#all_associations_and_attributes ⇒ Object 



114
115
116
 
# File 'lib/fog/core/attributes.rb', line 114

def all_associations_and_attributes
  all_attributes.merge(all_associations)
end

#all_attributes ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/fog/core/attributes.rb', line 88

def all_attributes
  self.class.attributes.reduce({}) do |hash, attribute|
    if masks[attribute].nil?
      Fog::Logger.deprecation("Please define #{attribute} using the Fog DSL")
      hash[attribute] = send(attribute)
    else
      hash[masks[attribute]] = send(attribute)
    end

    hash
  end
end

#associations ⇒ Object 



80
81
82
 
# File 'lib/fog/core/attributes.rb', line 80

def associations
  @associations ||= {}
end

#attributes ⇒ Object 



76
77
78
 
# File 'lib/fog/core/attributes.rb', line 76

def attributes
  @attributes ||= {}
end

#dup ⇒ Object 



118
119
120
121
122
 
# File 'lib/fog/core/attributes.rb', line 118

def dup
  copy = super
  copy.dup_attributes!
  copy
end

#filter_attributes(*selected) ⇒ Hash

Note:

In some cases we want to easily get subset of model attributes

Note:

Hash#slice requires Ruby >= 2.5.0

Filters attributes by selected attribute names

Parameters:

  • selected (Symbol) —

    attribute names

Returns:

  • (Hash) —

    new hash with selected attributes



159
160
161
162
163
164
 
# File 'lib/fog/core/attributes.rb', line 159

def filter_attributes(*selected)
  filtered = attributes.select { |a, _| selected.include?(a) }

  # we should use getters instead of direct accessing attributes hash
  filtered.each_key { |k| filtered[k] = send(k) }
end

#identity ⇒ Object 



128
129
130
 
# File 'lib/fog/core/attributes.rb', line 128

def identity
  send(identity_name)
end

#identity=(new_identity) ⇒ Object 



132
133
134
 
# File 'lib/fog/core/attributes.rb', line 132

def identity=(new_identity)
  send("#{identity_name}=", new_identity)
end

#identity_name ⇒ Object 



124
125
126
 
# File 'lib/fog/core/attributes.rb', line 124

def identity_name
  self.class.instance_variable_get("@identity")
end

#masks ⇒ Object 



84
85
86
 
# File 'lib/fog/core/attributes.rb', line 84

def masks
  self.class.masks
end

#merge_attributes(new_attributes = {}) ⇒ self

Note:

Ignored attributes are not merged (see ClassMethods#ignored_attributes)

Merges attributes into self

Returns:

  • (self) 


139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/fog/core/attributes.rb', line 139

def merge_attributes(new_attributes = {})
  new_attributes.each_pair do |key, value|
    next if self.class.ignored_attributes.include?(key)

    if self.class.aliases[key]
      send("#{self.class.aliases[key]}=", value)
    elsif self.respond_to?("#{key}=", true)
      send("#{key}=", value)
    else
      attributes[key] = value
    end
  end
  self
end

#new_record? ⇒ Boolean

Deprecated.

Use inverted form of #persisted?

Returns true if a remote resource has not been assigned an identity.

This was added for a ActiveRecord like feel but has been outdated by ActiveModel API using #persisted?

Returns:



182
183
184
185
 
# File 'lib/fog/core/attributes.rb', line 182

def new_record?
  Fog::Logger.deprecation("#new_record? is deprecated, use !persisted? instead [light_black](#{caller.first})[/]")
  !persisted?
end

#persisted? ⇒ Boolean

Returns true if a remote resource has been assigned an identity and we can assume it has been persisted.

Returns:



170
171
172
 
# File 'lib/fog/core/attributes.rb', line 170

def persisted?
  !!identity
end

#requires(*args) ⇒ Object

check that the attributes specified in args exist and is not nil



188
189
190
191
192
193
194
195
 
# File 'lib/fog/core/attributes.rb', line 188

def requires(*args)
  missing = missing_attributes(args)
  if missing.length == 1
    raise(ArgumentError, "#{missing.first} is required for this operation")
  elsif missing.any?
    raise(ArgumentError, "#{missing[0...-1].join(', ')} and #{missing[-1]} are required for this operation")
  end
end

#requires_one(*args) ⇒ Object

Raises:

  • (ArgumentError) 


197
198
199
200
201
202
 
# File 'lib/fog/core/attributes.rb', line 197

def requires_one(*args)
  missing = missing_attributes(args)
  return unless missing.length == args.length

  raise(ArgumentError, "#{missing[0...-1].join(', ')} or #{missing[-1]} are required for this operation")
end