View Source Sourceror.Patch (Sourceror v1.5.0)

Functions that generate patches for common operations.

Functions in this module assume that the AST was parsed using Sourceror functions and that it wasn't modified. If you changed the tree before calling Sourceror.Patch functions, then the patch ranges are not guaranteed to match 1:1 with the original source code.

Summary

Types

change()

t()

Functions

new(range, change, preserve_indentation \\ true)

Creates a new patch.

rename_call(arg, new_name)

Renames a qualified or unqualified function call.

rename_identifier(arg, new_name)

Renames an identifier(ie a variable name).

rename_kw_keys(arg, replacements)

Generates patches that rename the keys of a keyword list.

replace(zipper, replacement)

Generates a patch that replaces the node with the given replacement.

Types

change()

@type change() :: String.t() | (String.t() -> String.t())

t()

@type t() :: %Sourceror.Patch{
  change: change(),
  preserve_indentation: boolean() | nil,
  range: map()
}

Functions

new(range, change, preserve_indentation \\ true)

@spec new(range :: map(), change :: change(), preserve_indentation :: boolean()) ::
  t()

Creates a new patch.

rename_call(arg, new_name)

@spec rename_call(call :: Macro.t(), new_name :: atom() | String.t()) :: t()

Renames a qualified or unqualified function call.

iex> original = "String.to_atom(foo)"
iex> ast = Sourceror.parse_string!(original)
iex> patch = Sourceror.Patch.rename_call(ast, :to_existing_atom)
iex> Sourceror.patch_string(original, [patch])
"String.to_existing_atom(foo)"

If the call is a sigil, you only need to provide the replacement letter:

iex> original = "~H(foo)"
iex> ast = Sourceror.parse_string!(original)
iex> patch = Sourceror.Patch.rename_call(ast, :F)
iex> Sourceror.patch_string(original, [patch])
"~F(foo)"

rename_identifier(arg, new_name)

@spec rename_identifier(identifier :: Macro.t(), new_name :: atom() | String.t()) ::
  t()

Renames an identifier(ie a variable name).

Examples

iex> original = "foo"
iex> ast = Sourceror.parse_string!(original)
iex> patch = Sourceror.Patch.rename_identifier(ast, :bar)
iex> Sourceror.patch_string(original, [patch])
"bar"

rename_kw_keys(arg, replacements)

@spec rename_kw_keys(keyword :: Macro.t(), replacements :: keyword()) :: [t()]

Generates patches that rename the keys of a keyword list.

The replacements is a keyword list, with the keys to replace as keys, and the replacement as the value.

Examples

iex> original = "[a: b, c: d, e: f]"
iex> ast = Sourceror.parse_string!(original)
iex> patches = Sourceror.Patch.rename_kw_keys(ast, a: :foo, e: :bar)
iex> Sourceror.patch_string(original, patches)
"[foo: b, c: d, bar: f]"

replace(zipper, replacement)

@spec replace(zipper :: Sourceror.Zipper.t(), replacement :: String.t()) :: t()

Generates a patch that replaces the node with the given replacement.

Examples

iex> original = "foo"
iex> ast = Sourceror.parse_string!(original)
iex> patch = Sourceror.Patch.replace(ast, "bar")
iex> Sourceror.patch_string(original, [patch])
"bar"