class ObjectPatch::Operations::Add
A representation of a JSON pointer add operation.
Public Class Methods
Setup the add operation with any required arguments.
@param [Hash] patch_data Parameters necessary to build the operation. @option patch_data [String] path The location in the target document to
add.
@option patch_data [Object] value The value to insert into the target. @return [void]
# File lib/object_patch/operations/add.rb, line 36 def initialize(patch_data) @path = patch_data.fetch('path') @value = patch_data.fetch('value') end
Public Instance Methods
Apply this operation to the provided document and return the updated document. Please note that the changes will be reflected not only in the returned value but the original document that was passed in as well.
@param [Object] target_doc The document that will be modified by this
patch.
@return [Object] The modified document
# File lib/object_patch/operations/add.rb, line 14 def apply(target_doc) key = processed_path.last inner_obj = ObjectPatch::Pointer.eval(processed_path[0...-1], target_doc) raise MissingTargetException, @path unless inner_obj if key ObjectPatch::Operations.add_op(inner_obj, key, @value) else inner_obj.replace(@value) end target_doc end
Returns the path after being expanded by the JSON pointer semantics.
@return [Array<String>] Expanded pointer path
# File lib/object_patch/operations/add.rb, line 44 def processed_path ObjectPatch::Pointer.parse(@path) end
Covert this operation to a format that can be built into a full on JSON patch.
@return [Hash<String => String>] JSON patch add operation
# File lib/object_patch/operations/add.rb, line 52 def to_patch { 'op' => 'add', 'path' => @path, 'value' => @value } end