Class: ObjectPatch::Operations::Remove

Inherits:
Object
  • Object
show all
Defined in:
lib/object_patch/operations/remove.rb

Overview

A representation of a JSON pointer remove operation.

Instance Method Summary collapse

Constructor Details

#initialize(patch_data) ⇒ void

Setup the remove operation with any required arguments.

Parameters:

  • patch_data (Hash) —

    Parameters necessary to build the operation.

Options Hash (patch_data):

  • path (String) —

    The location in the target document to remove.



29
30
31
 
# File 'lib/object_patch/operations/remove.rb', line 29

def initialize(patch_data)
  @path = patch_data.fetch('path')
end

Instance Method Details

#apply(target_doc) ⇒ Object

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.

Parameters:

  • target_doc (Object) —

    The document that will be modified by this patch.

Returns:

  • (Object) —

    The modified document



14
15
16
17
18
19
20
21
 
# File 'lib/object_patch/operations/remove.rb', line 14

def apply(target_doc)
  key = processed_path.last
  inner_obj = ObjectPatch::Pointer.eval(processed_path[0...-1], target_doc)

  ObjectPatch::Operations.rm_op(inner_obj, key)

  target_doc
end

#processed_path ⇒ Array<String>

Returns the path after being expanded by the JSON pointer semantics.

Returns:

  • (Array<String>) —

    Expanded pointer path



36
37
38
 
# File 'lib/object_patch/operations/remove.rb', line 36

def processed_path
  ObjectPatch::Pointer.parse(@path)
end

#to_patch ⇒ Hash<String => String>

Covert this operation to a format that can be built into a full on JSON patch.

Returns:

  • (Hash<String => String>) —

    JSON patch remove operation



44
45
46
 
# File 'lib/object_patch/operations/remove.rb', line 44

def to_patch
  { 'op' => 'remove', 'path' => @path }
end