Module: Parse::Core::Actions
- Included in:
- Object
- Defined in:
- lib/parse/model/core/actions.rb
Overview
Defines some of the save, update and destroy operations for Parse objects.
Defined Under Namespace
Modules: ClassMethods
Class Method Summary collapse
-
.dup_for_snapshot(value) ⇒ Object
Copy a property value deeply enough that later in-place mutation of the live value cannot reach the snapshot.
-
.restore_property_values(obj, snapshot) ⇒ void
Restore the values captured by Actions.snapshot_property_values.
-
.rollback_object_state(state) ⇒ void
Roll a single tracked object back to the state captured when it was added to the transaction.
-
.snapshot_property_values(obj) ⇒ Hash
Capture the property values a transaction rollback must restore.
Instance Method Summary collapse
-
#_deleted? ⇒ Boolean
Returns true if this object has been fetched and found to be deleted from the server.
-
#change_requests(force = false) ⇒ Array<Parse::Request>
Creates an array of all possible operations that need to be performed on this object.
-
#changes_applied! ⇒ Object
Clears changes information on all collections (array and relations) and all local attributes.
-
#changes_payload ⇒ Hash
(also: #update_payload)
A hash of the list of changes made to this instance.
-
#create ⇒ Boolean
Save the object as a new record, running all callbacks.
-
#destroy(session: nil) ⇒ Boolean
Delete this record from the Parse collection.
-
#destroy_request ⇒ Parse::Request
A destroy_request for the current object.
-
#op_add!(field, objects) ⇒ Boolean
Perform an atomic add operation to the array field.
-
#op_add_relation!(field, objects = []) ⇒ Boolean
Perform an atomic add operation on this relational field.
-
#op_add_unique!(field, objects) ⇒ Boolean
Perform an atomic add unique operation to the array field.
-
#op_destroy!(field) ⇒ Boolean
Perform an atomic delete operation on this field.
-
#op_increment!(field, amount = 1) ⇒ Object
Atomically increment or decrement a specific field.
-
#op_remove!(field, objects) ⇒ Boolean
Perform an atomic remove operation to the array field.
-
#op_remove_relation!(field, objects = []) ⇒ Boolean
Perform an atomic remove operation on this relational field.
-
#operate_field!(field, op_hash) ⇒ Boolean
Perform an atomic operation on this field.
-
#prepare_save! ⇒ Boolean
Back-compat alias for Object#run_before_save_callbacks.
-
#relation_change_operations ⇒ Array
Generates an array with two entries for addition and removal operations.
-
#save(session: nil, autoraise: false, force: false, validate: true) ⇒ Boolean
saves the object.
-
#save!(session: nil, force: false) ⇒ Boolean
Save this object and raise an exception if it fails.
-
#set_attributes!(hash, dirty_track = false) ⇒ Hash
Performs mass assignment using a hash with the ability to modify dirty tracking.
-
#update(force: false) ⇒ Boolean
Save all the changes related to this object.
-
#update!(raw: false, force: false) ⇒ Boolean
This methods sends an update request for this object with the any change information based on its local attributes.
-
#update_relations ⇒ Boolean
Saves and updates all the relational changes for made to this object.
-
#uri_path ⇒ String
The API uri path for this class.
Class Method Details
.dup_for_snapshot(value) ⇒ Object
Copy a property value deeply enough that later in-place mutation of the live value cannot reach the snapshot.
A plain dup is not sufficient for collection-backed properties:
:array and association properties hold a Parse::CollectionProxy,
and duplicating the proxy still shares the underlying @collection
array, so widget.tags << "b" would mutate the snapshot too. The
proxy's inner array is duplicated as well.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/parse/model/core/actions.rb', line 154 def self.dup_for_snapshot(value) copy = begin value.dup rescue TypeError # Symbols, Integers, true/false/nil and other immediates are not # duplicable on older rubies; they are also immutable, so sharing # the reference is safe. return value end if copy.instance_variable_defined?(:@collection) inner = copy.instance_variable_get(:@collection) copy.instance_variable_set(:@collection, inner.dup) if inner.is_a?(Array) end copy end |
.restore_property_values(obj, snapshot) ⇒ void
This method returns an undefined value.
Restore the values captured by snapshot_property_values.
Writes ivars directly rather than going through the property setters, since the setters mark the object dirty and the caller restores the dirty state itself immediately afterwards.
180 181 182 183 184 185 |
# File 'lib/parse/model/core/actions.rb', line 180 def self.restore_property_values(obj, snapshot) return unless snapshot.is_a?(Hash) snapshot.each do |ivar, value| obj.instance_variable_set(ivar, value) end end |
.rollback_object_state(state) ⇒ void
This method returns an undefined value.
Roll a single tracked object back to the state captured when it was added to the transaction.
192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/parse/model/core/actions.rb', line 192 def self.rollback_object_state(state) obj = state[:object] return if obj.nil? restore_property_values(obj, state[:property_values]) obj.instance_variable_set(:@changed_attributes, state[:changed_attributes]) obj.instance_variable_set(:@id, state[:id]) # Restore change tracking state. Leaving `@mutations_from_database` # nil is fine: `ActiveModel::Dirty` lazily rebuilds it, and with # `@attributes` no longer defined on the object it correctly rebuilds # a `ForcedMutationTracker`. obj.instance_variable_set(:@mutations_from_database, state[:mutations_from_database]) obj.instance_variable_set(:@mutations_before_last_save, state[:mutations_before_last_save]) end |
.snapshot_property_values(obj) ⇒ Hash
Capture the property values a transaction rollback must restore.
Property values live in @<field> instance variables (see
Properties::ClassMethods#property), so those are what gets
snapshotted. Object#attributes is deliberately NOT captured:
it returns a SCHEMA map (field name to type symbol), not values, so
restoring it never rolled anything back.
Restoring it was also actively harmful. @attributes is the ivar
ActiveModel::Dirty keys its behavior on: mutations_from_database
builds an AttributeMutationTracker over @attributes the moment
that ivar is defined (and a ForcedMutationTracker otherwise), while
forget_attribute_assignments calls map(&:forgetting_assignment)
on it. Handing either one a schema Hash raised NoMethodError on a
type symbol and on the [key, value] pair Hash#map yields. Both
sites rescue and warn, so every rollback silently downgraded the
object to broken change tracking instead of failing.
134 135 136 137 138 139 140 141 |
# File 'lib/parse/model/core/actions.rb', line 134 def self.snapshot_property_values(obj) fields = obj.class.respond_to?(:fields) ? obj.class.fields.keys : [] fields.each_with_object({}) do |key, snapshot| ivar = :"@#{key}" next unless obj.instance_variable_defined?(ivar) snapshot[ivar] = dup_for_snapshot(obj.instance_variable_get(ivar)) end end |
Instance Method Details
#_deleted? ⇒ Boolean
Returns true if this object has been fetched and found to be deleted from the server. Deleted objects cannot be saved.
1253 1254 1255 |
# File 'lib/parse/model/core/actions.rb', line 1253 def _deleted? @_deleted == true end |
#change_requests(force = false) ⇒ Array<Parse::Request>
Creates an array of all possible operations that need to be performed on this object. This includes all property and relational operation changes.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 |
# File 'lib/parse/model/core/actions.rb', line 1025 def change_requests(force = false) requests = [] # get the URI path for this object. uri = self.uri_path # generate the request to update the object (PUT) if attribute_changes? || force # if it's new, then we should call :post for creating the object. method = new? ? :post : :put r = Request.new(method, uri, body: attribute_updates) r.tag = object_id requests << r end # if the object is not new, then we can also add all the relational changes # we need to perform. if @id.present? && relation_changes? relation_change_operations.each do |ops| next if ops.empty? r = Request.new(:put, uri, body: ops) r.tag = object_id requests << r end end requests end |
#changes_applied! ⇒ Object
Clears changes information on all collections (array and relations) and all local attributes.
1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 |
# File 'lib/parse/model/core/actions.rb', line 1384 def changes_applied! # find all fields that are of type :array fields(:array) do |key, v| proxy = send(key) # clear changes proxy.changes_applied! if proxy.respond_to?(:changes_applied!) end # for all relational fields, relations.each do |key, v| proxy = send(key) # clear changes if they support the method. proxy.changes_applied! if proxy.respond_to?(:changes_applied!) end changes_applied end |
#changes_payload ⇒ Hash Also known as: update_payload
Returns a hash of the list of changes made to this instance.
1292 1293 1294 1295 1296 1297 1298 1299 1300 |
# File 'lib/parse/model/core/actions.rb', line 1292 def changes_payload h = attribute_updates if relation_changes? r = relation_change_operations.select { |s| s.present? }.first h.merge!(r) if r.present? end #h.merge!(className: parse_class) unless h.empty? h.as_json end |
#create ⇒ Boolean
Save the object as a new record, running all callbacks.
1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 |
# File 'lib/parse/model/core/actions.rb', line 1109 def create run_callbacks :create do body = attribute_updates # Forward a client-assigned objectId when a `before_create` callback # set it (e.g. `parse_reference precompute: true`). attribute_updates # excludes BASE_KEYS, so @id must be merged explicitly. Parse Server # accepts an objectId in the create POST body and rejects duplicates # with a typed error rather than silently overwriting. body[Parse::Model::OBJECT_ID] = @id if @id.present? res = client.create_object(parse_class, body, session_token: _session_token) # Retain the response so wrappers (e.g. synchronize_create) can # inspect the Parse error code on failure (notably 137 DuplicateValue). @_last_response = res unless res.error? result = res.result @id = result[Parse::Model::OBJECT_ID] || @id @created_at = result["createdAt"] || @created_at #if the object is created, updatedAt == createdAt @updated_at = result["updatedAt"] || result["createdAt"] || @updated_at # Because beforeSave hooks can change the fields we are saving, any items that were # changed, are returned to us and we should apply those locally to be in sync. set_attributes!(result) end puts "Error creating #{self.parse_class}: #{res.error}" if res.error? res.success? end end |
#destroy(session: nil) ⇒ Boolean
Delete this record from the Parse collection. Only valid if this object has an id.
This will run all the destroy callbacks.
1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 |
# File 'lib/parse/model/core/actions.rb', line 1262 def destroy(session: nil) @_session_token = _validate_session_token! session, :destroy return false if new? success = false run_callbacks :destroy do res = client.delete_object parse_class, id, session_token: _session_token success = res.success? if success @id = nil changes_applied! elsif self.class.raise_on_save_failure raise Parse::RecordNotSaved.new(self), "Failed to create or save attributes. #{self.parse_class} was not saved." end # Your create action methods here end @_session_token = nil success end |
#destroy_request ⇒ Parse::Request
Returns a destroy_request for the current object.
1007 1008 1009 1010 1011 1012 1013 |
# File 'lib/parse/model/core/actions.rb', line 1007 def destroy_request return nil unless @id.present? uri = self.uri_path r = Request.new(:delete, uri) r.tag = object_id r end |
#op_add!(field, objects) ⇒ Boolean
Perform an atomic add operation to the array field.
913 914 915 |
# File 'lib/parse/model/core/actions.rb', line 913 def op_add!(field, objects) operate_field! field, { __op: :Add, objects: objects } end |
#op_add_relation!(field, objects = []) ⇒ Boolean
Perform an atomic add operation on this relational field.
963 964 965 966 967 968 |
# File 'lib/parse/model/core/actions.rb', line 963 def op_add_relation!(field, objects = []) objects = [objects] unless objects.is_a?(Array) return false if objects.empty? relation_action = Parse::RelationAction.new(field, polarity: true, objects: objects) operate_field! field, relation_action end |
#op_add_unique!(field, objects) ⇒ Boolean
Perform an atomic add unique operation to the array field. The objects will only be added if they don't already exists in the array for that particular field.
923 924 925 |
# File 'lib/parse/model/core/actions.rb', line 923 def op_add_unique!(field, objects) operate_field! field, { __op: :AddUnique, objects: objects } end |
#op_destroy!(field) ⇒ Boolean
Perform an atomic delete operation on this field.
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 |
# File 'lib/parse/model/core/actions.rb', line 940 def op_destroy!(field) result = operate_field! field, { __op: :Delete }.freeze if result # Also update the local state to reflect the deletion field_sym = field.to_sym if self.class.fields[field_sym].present? set_attribute_method = "#{field}_set_attribute!" if respond_to?(set_attribute_method) send(set_attribute_method, nil, true) # Set to nil with dirty tracking else instance_variable_set(:"@#{field}", nil) send("#{field}_will_change!") if respond_to?("#{field}_will_change!") end end end result end |
#op_increment!(field, amount = 1) ⇒ Object
Atomically increment or decrement a specific field.
986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 |
# File 'lib/parse/model/core/actions.rb', line 986 def op_increment!(field, amount = 1) unless amount.is_a?(Numeric) raise ArgumentError, "Amount should be numeric" end result = operate_field! field, { __op: :Increment, amount: amount.to_i }.freeze if result # Also update the local state to reflect the increment field_sym = field.to_sym current_value = self[field_sym] || 0 new_value = current_value + amount.to_i set_attribute_method = "#{field}_set_attribute!" if respond_to?(set_attribute_method) send(set_attribute_method, new_value, true) # Set new value with dirty tracking else self[field_sym] = new_value end end result end |
#op_remove!(field, objects) ⇒ Boolean
Perform an atomic remove operation to the array field.
932 933 934 |
# File 'lib/parse/model/core/actions.rb', line 932 def op_remove!(field, objects) operate_field! field, { __op: :Remove, objects: objects } end |
#op_remove_relation!(field, objects = []) ⇒ Boolean
Perform an atomic remove operation on this relational field.
975 976 977 978 979 980 |
# File 'lib/parse/model/core/actions.rb', line 975 def op_remove_relation!(field, objects = []) objects = [objects] unless objects.is_a?(Array) return false if objects.empty? relation_action = Parse::RelationAction.new(field, polarity: false, objects: objects) operate_field! field, relation_action end |
#operate_field!(field, op_hash) ⇒ Boolean
Perform an atomic operation on this field. This operation is done on the Parse server which guarantees the atomicity of the operation. This is the low-level API on performing atomic operations on properties for classes. These methods do not update the current instance with any changes the server may have made to satisfy this operation.
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 |
# File 'lib/parse/model/core/actions.rb', line 888 def operate_field!(field, op_hash) field = field.to_sym field = self.field_map[field] || field if op_hash.is_a?(Parse::RelationAction) op_hash = op_hash.as_json else op_hash = { field => op_hash }.as_json end # If the object hasn't been saved yet (no id), we can't make field operations # Return true to indicate the operation was "successful" locally return true if id.nil? response = client.update_object(parse_class, id, op_hash, session_token: _session_token) if response.error? puts "[#{parse_class}:#{field} Operation] #{response.error}" end response.success? end |
#prepare_save! ⇒ Boolean
Back-compat alias for Object#run_before_save_callbacks. The
canonical name spells out exactly what runs (the before_save callbacks,
before phase only) and is symmetric with run_after_save_callbacks /
run_before_create_callbacks / run_after_create_callbacks. Retained so
existing callers of prepare_save! keep working.
1287 1288 1289 |
# File 'lib/parse/model/core/actions.rb', line 1287 def prepare_save! run_before_save_callbacks end |
#relation_change_operations ⇒ Array
Generates an array with two entries for addition and removal operations. The first entry of the array will contain a hash of all the change operations regarding adding new relational objects. The second entry in the array is a hash of all the change operations regarding removing relation objects from this field.
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'lib/parse/model/core/actions.rb', line 1310 def relation_change_operations return [{}, {}] unless relation_changes? additions = [] removals = [] # go through all the additions of a collection and generate an action to add. relation_updates.each do |field, collection| if collection.additions.count > 0 additions.push Parse::RelationAction.new(field, objects: collection.additions, polarity: true) end # go through all the additions of a collection and generate an action to remove. if collection.removals.count > 0 removals.push Parse::RelationAction.new(field, objects: collection.removals, polarity: false) end end # merge all additions and removals into one large hash additions = additions.reduce({}) { |m, v| m.merge! v.as_json } removals = removals.reduce({}) { |m, v| m.merge! v.as_json } [additions, removals] end |
#save(session: nil, autoraise: false, force: false, validate: true) ⇒ Boolean
saves the object. If the object has not changed, it is a noop. If it is new, we will create the object. If the object has an id, we will update the record.
You may pass a session token to the session argument to perform this actions
with the privileges of a certain user.
Callback order:
- before_validation / around_validation / after_validation
- before_save / around_save
- before_create or before_update / around_create or around_update
- [actual save operation]
- after_create or after_update
- after_save
You can define before and after :save callbacks autoraise: set to true will automatically raise an exception if the save fails
1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 |
# File 'lib/parse/model/core/actions.rb', line 1176 def save(session: nil, autoraise: false, force: false, validate: true) # Prevent saving objects that have been fetched and found to be deleted if _deleted? error_msg = "Cannot save deleted object. Object with id '#{@id}' no longer exists on the server." raise Parse::Error::ProtocolError, error_msg end @_session_token = _validate_session_token! session, :save return true unless changed? || force # Run validations (validation callbacks are now triggered by valid? method) # Pass context so `on: :create` and `on: :update` options work with callbacks if validate validation_context = new? ? :create : :update validation_passed = valid?(validation_context) unless validation_passed if self.class.raise_on_save_failure || autoraise.present? raise Parse::RecordNotSaved.new(self), "Validation failed: #{errors..join(", ")}" end return false end end success = false # Track if callbacks are halted by a before_save hook returning false callback_executed = false run_callbacks :save do callback_executed = true #first process the create/update action if any #then perform any relation changes that need to be performed success = new? ? create : perform_update(force: force) # if the save was successful and we have relational changes # let's update send those next. if success if relation_changes? # get the list of changed keys changed_attribute_keys = changed - relations.keys.map(&:to_s) clear_attribute_changes(changed_attribute_keys) success = update_relations if success changes_applied! clear_partial_fetch_state! elsif self.class.raise_on_save_failure || autoraise.present? raise Parse::RecordNotSaved.new(self), "Failed updating relations. #{self.parse_class} partially saved." end else changes_applied! clear_partial_fetch_state! end elsif self.class.raise_on_save_failure || autoraise.present? raise Parse::RecordNotSaved.new(self), "Failed to create or save attributes. #{self.parse_class} was not saved." end end #callbacks # If callbacks were halted (before_save returned false), return false return false unless callback_executed @_session_token = nil success end |
#save!(session: nil, force: false) ⇒ Boolean
Save this object and raise an exception if it fails.
1246 1247 1248 |
# File 'lib/parse/model/core/actions.rb', line 1246 def save!(session: nil, force: false) save(autoraise: true, session: session, force: force) end |
#set_attributes!(hash, dirty_track = false) ⇒ Hash
Performs mass assignment using a hash with the ability to modify dirty tracking.
This is an internal method used to set properties on the object while controlling
whether they are dirty tracked. Each defined property has a method defined with the
suffix _set_attribute! that can will be called if it is contained in the hash.
1373 1374 1375 1376 1377 1378 1379 1380 |
# File 'lib/parse/model/core/actions.rb', line 1373 def set_attributes!(hash, dirty_track = false) return unless hash.is_a?(Hash) hash.each do |k, v| next if k == Parse::Model::OBJECT_ID || k == Parse::Model::ID method = "#{k}_set_attribute!" send(method, v, dirty_track) if respond_to?(method) end end |
#update(force: false) ⇒ Boolean
Save all the changes related to this object.
1090 1091 1092 1093 |
# File 'lib/parse/model/core/actions.rb', line 1090 def update(force: false) return true unless attribute_changes? || force update!(force: force) end |
#update!(raw: false, force: false) ⇒ Boolean
This methods sends an update request for this object with the any change information based on its local attributes. The bang implies that it will send the request even though it is possible no changes were performed. This is useful in kicking-off an beforeSave / afterSave hooks Save the object regardless of whether there are changes. This would call any beforeSave and afterSave cloud code hooks you have registered for this class.
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 |
# File 'lib/parse/model/core/actions.rb', line 1059 def update!(raw: false, force: false) if valid? == false errors..each do |msg| warn "[#{parse_class}] warning: #{msg}" end end if force == true && attribute_changes?.blank? && !new? # if we are forcing an update, but there are no attribute changes, # we should still mark the updated_at field as changed so that # the server updates it. if self.class.fields[:updated_at].present? self.updated_at = Time.now.utc self.updated_at_will_change! if respond_to?(:updated_at_will_change!) end end response = client.update_object(parse_class, id, attribute_updates, session_token: _session_token) @_last_response = response if response.success? result = response.result # Because beforeSave hooks can change the fields we are saving, any items that were # changed, are returned to us and we should apply those locally to be in sync. set_attributes!(result) end puts "Error updating #{self.parse_class}: #{response.error}" if response.error? return response if raw response.success? end |
#update_relations ⇒ Boolean
Saves and updates all the relational changes for made to this object.
1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 |
# File 'lib/parse/model/core/actions.rb', line 1333 def update_relations # relational saves require an id return false unless @id.present? # verify we have relational changes before we do work. return true unless relation_changes? raise "Unable to update relations for a new object." if new? # get all the relational changes (both additions and removals) additions, removals = relation_change_operations responses = [] # Send parallel Parse requests for each of the items to update. # since we will have multiple responses, we will track it in array [removals, additions].threaded_each do |ops| next if ops.empty? #if no operations to be performed, then we are done responses << client.update_object(parse_class, @id, ops, session_token: _session_token) end # check if any of them ended up in error has_error = responses.any? { |response| response.error? } # if everything was ok, find the last response to be returned and update #their fields in case beforeSave made any changes. unless has_error || responses.empty? result = responses.last.result #last result to come back set_attributes!(result) end #unless has_error == false end |