JsonRemedy.Layer1.ContentCleaning (json_remedy v0.1.3)

View Source

Layer 1: Content Cleaning - Removes non-JSON content and normalizes encoding.

This layer handles:

  • Code fence removal (json ...)
  • Comment stripping (// and / /)
  • Wrapper text extraction (HTML, prose)
  • Encoding normalization

Uses direct string methods instead of regex for better performance and clearer code.

Summary

Types

layer_result()
repair_action()
repair_context()

Functions

extract_json_content(input)

Extract JSON from wrapper text (HTML, prose, etc.). Public API version that takes string input directly.

extract_json_content_internal(arg)

Extract JSON from wrapper text (HTML, prose, etc.).

name()

Return a human-readable name for this layer.

normalize_encoding(input)

Normalize text encoding to UTF-8. Public API version that takes string input directly.

normalize_encoding_internal(arg)

Normalize text encoding to UTF-8.

priority()

Return the priority order for this layer. Layer 1 (Content Cleaning) should run first in the pipeline.

process(input, context)

Process input string and apply Layer 1 content cleaning repairs.

remove_code_fences(input)

Remove code fences from input while preserving fence content in strings.

remove_comments(arg)

Strip comments while preserving comment-like content in strings.

strip_comments(input)

Strip comments while preserving comment-like content in strings. Public API version that takes string input directly.

supports?(input)

Check if this layer can handle the given input. Layer 1 can handle any text input that may contain JSON with wrapping content.

validate_options(options)

Validate layer configuration and options. Layer 1 accepts options for enabling/disabling specific cleaning features.

Types

layer_result()

@type layer_result() :: JsonRemedy.LayerBehaviour.layer_result()

repair_action()

@type repair_action() :: JsonRemedy.LayerBehaviour.repair_action()

repair_context()

@type repair_context() :: JsonRemedy.LayerBehaviour.repair_context()

Functions

extract_json_content(input)

@spec extract_json_content(input :: String.t()) :: {String.t(), [repair_action()]}

Extract JSON from wrapper text (HTML, prose, etc.). Public API version that takes string input directly.

extract_json_content_internal(arg)

@spec extract_json_content_internal(input :: {String.t(), [repair_action()]}) ::
  {String.t(), [repair_action()]}

Extract JSON from wrapper text (HTML, prose, etc.).

name()

@spec name() :: String.t()

Return a human-readable name for this layer.

normalize_encoding(input)

@spec normalize_encoding(input :: String.t()) :: {String.t(), [repair_action()]}

Normalize text encoding to UTF-8. Public API version that takes string input directly.

normalize_encoding_internal(arg)

@spec normalize_encoding_internal(input :: {String.t(), [repair_action()]}) ::
  {String.t(), [repair_action()]}

Normalize text encoding to UTF-8.

priority()

@spec priority() :: 1

Return the priority order for this layer. Layer 1 (Content Cleaning) should run first in the pipeline.

process(input, context)

@spec process(input :: String.t(), context :: repair_context()) :: layer_result()

Process input string and apply Layer 1 content cleaning repairs.

Returns:

  • {:ok, processed_input, updated_context} - Layer completed successfully
  • {:continue, input, context} - Layer doesn't apply, pass to next layer
  • {:error, reason} - Layer failed, stop pipeline

remove_code_fences(input)

@spec remove_code_fences(input :: String.t()) :: {String.t(), [repair_action()]}

Remove code fences from input while preserving fence content in strings.

remove_comments(arg)

@spec remove_comments(input :: {String.t(), [repair_action()]}) ::
  {String.t(), [repair_action()]}

Strip comments while preserving comment-like content in strings.

strip_comments(input)

@spec strip_comments(input :: String.t()) :: {String.t(), [repair_action()]}

Strip comments while preserving comment-like content in strings. Public API version that takes string input directly.

supports?(input)

@spec supports?(input :: String.t()) :: boolean()

Check if this layer can handle the given input. Layer 1 can handle any text input that may contain JSON with wrapping content.

validate_options(options)

@spec validate_options(options :: keyword()) :: :ok | {:error, String.t()}

Validate layer configuration and options. Layer 1 accepts options for enabling/disabling specific cleaning features.