Summary

This PR introduces convenience overloads to encode plain JSON strings directly to TOON, updates documentation with examples, centralizes JSON parsing, and adds tests. Version is bumped to 0.1.1.

Motivation

• Simplify workflows where inputs are already JSON (strings), avoiding callers needing to parse into JsonNode first.
• Keep parsing concerns out of JToon by delegating to a centralized utility.

Changes

• Added:
  • JToon.encodeJson(String json): String
  • JToon.encodeJson(String json, EncodeOptions options): String
  • Centralized parsing: JsonNormalizer.parse(String) with consistent validation and error handling.
  • Unit tests covering:
    • Objects, primitive arrays, tabular arrays
    • Custom EncodeOptions (indent, delimiter, lengthMarker)
    • Error cases (blank/invalid JSON)
  • README examples for encodeJson, including Java text block usage.
  • Changelog for 0.1.1.
• Updated:
  • README API section to document new overloads.
  • Version: 0.1.1.

API

• New methods in JToon:
  • encodeJson(String json)
  • encodeJson(String json, EncodeOptions options)
• Internally delegates parsing to JsonNormalizer.parse(String) and encoding to ValueEncoder.encodeValue(...).

Behavior and Validation

• Blank or invalid JSON results in IllegalArgumentException from JsonNormalizer.parse(String).
• Output format remains identical to encode(...) of equivalent structures.

Breaking Changes

• None. Purely additive.

Documentation

• README:
  • Adds Encode a plain JSON string example and explains delimiter options and length markers in context.
  • API list now includes both encodeJson overloads.
• CHANGELOG:
  • Adds 0.1.1 entry detailing new APIs, docs, and tests.

Testing

• New tests validate:
  • Encoding JSON objects, primitive arrays, and tabular arrays via string inputs.
  • Custom delimiter and length marker options.
  • Error handling for invalid/blank JSON.
• Test reports are present under build/reports/tests/test.

Versioning

• Bumps to 0.1.1 as per CHANGELOG. Artifacts and README badges remain consistent with release automation.

Migration Guide

• For existing JSON-string-based callers:
  • Replace manual parsing + encode(JsonNode) with the new entry points:

// Before
JsonNode node = objectMapper.readTree(jsonString);
String toon = JToon.encode(node);

// After
String toon = JToon.encodeJson(jsonString);

• For custom options:

String toon = JToon.encodeJson(jsonString, new EncodeOptions(2, Delimiter.PIPE, true));

Checklist

• API additions documented in README
• CHANGELOG updated to 0.1.1
• Tests added and passing
• No breaking changes introduced

Summary by CodeRabbit

• New Features

  • Added encodeJson() methods to encode JSON strings directly to TOON format with optional encoding options and input validation.

• Documentation

  • Added CHANGELOG tracking version history and release notes.
  • Updated README with new API documentation and usage examples.

• Tests

  • Added unit tests covering JSON string encoding scenarios and error handling.