Class: ObjectPatch::Operations::Replace

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

Overview

A representation of a JSON pointer replace operation.

Instance Method Summary collapse

Constructor Details

#initialize(patch_data) ⇒ void

Setup the replace 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 replace with the provided data.

  • value (String) —

    The value that should be written over whatever is at the provided path.



38
39
40
41
 
# File 'lib/object_patch/operations/replace.rb', line 38

def initialize(patch_data)
  @path  = patch_data.fetch('path')
  @value = patch_data.fetch('value')
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
22
23
24
25
26
27
28
 
# File 'lib/object_patch/operations/replace.rb', line 14

def apply(target_doc)
  return @value if processed_path.empty?

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

  if inner_obj.is_a?(Array)
    raise ObjectPatch::InvalidIndexError unless key =~ /\A\d+\Z/
    inner_obj[key.to_i] = @value
  else
    inner_obj[key] = @value
  end

  target_doc
end

#processed_path ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    Expanded pointer path



46
47
48
 
# File 'lib/object_patch/operations/replace.rb', line 46

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 replace operation



54
55
56
 
# File 'lib/object_patch/operations/replace.rb', line 54

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