https://github.com/j8r/crystalizer

(De)serialize any Crystal object - out of the box. Supports JSON, YAML and Byte format.
https://github.com/j8r/crystalizer

crystal-lang json serialization yaml

Last synced: about 2 months ago
JSON representation

(De)serialize any Crystal object - out of the box. Supports JSON, YAML and Byte format.

• Host: GitHub
• URL: https://github.com/j8r/crystalizer
• Owner: j8r
• License: isc
• Created: 2020-05-25T17:10:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T01:41:18.000Z (almost 2 years ago)
• Last Synced: 2024-10-02T06:02:29.607Z (2 months ago)
• Topics: crystal-lang, json, serialization, yaml
• Language: Crystal
• Homepage: https://j8r.github.io/crystalizer
• Size: 140 KB
• Stars: 39
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - Crystalizer - (De)serialize any Crystal object; supporting JSON, YAML, and Byte formats out of the box (Data Formats)

README

        
# Crystalizer

[![CI](https://github.com/j8r/crystalizer/workflows/CI/badge.svg)](https://github.com/j8r/crystalizer/actions?query=workflow%3ACI)

[![Documentation](https://github.com/j8r/crystalizer/workflows/Documentation/badge.svg)](https://j8r.github.io/crystalizer)

[![ISC](https://img.shields.io/badge/License-ISC-blue.svg?style=flat-square)](https://en.wikipedia.org/wiki/ISC_license)

[De]serialize any Crystal object - out of the box. Supports JSON, YAML and Byte format.

## Features

- [De]serialize anything, "out-of-the-box"

- Advanced serialization with annotations, but **not required**

- Shared annotations for all formats (JSON, YAML...)

Implementation bonus: no monkey patching involved :) (no method pollution on objects)

## Installation

Add the dependency to your `shard.yml`:

```yaml

dependencies:

  crystalizer:

    github: j8r/crystalizer

```

## Documentation

https://j8r.github.io/crystalizer

## Usage

### Basic

```crystal

require "crystalizer/json"

require "crystalizer/yaml"

struct Point

  getter x : Int32

  @[Crystalizer::Field(key: "Y")]

  getter y : String

  def initialize(@x, @y)

  end

end

point = Point.new 1, "a"

{Crystalizer::YAML, Crystalizer::JSON}.each do |format|

  puts format

  string = format.serialize point

  puts string

  puts format.deserialize string, to: Point

end

```

Result:

```

Crystalizer::YAML

---

x: 1

Y: a

Point(@x=1, @y="a")

Crystalizer::JSON

{

  "x": 1,

  "Y": "a"

}

Point(@x=1, @y="a")

```

### Any

Parsing any type, and converting to JSON/YAML.

```cr

require "crystalizer/json"

require "crystalizer/yaml"

yaml_string = <<-E

one: 1

two: 2

sub:

  ary:

  - one

  - 2

E

yaml_any = Crystalizer::YAML.parse yaml_string

puts yaml_any

json_string = Crystalizer::JSON.serialize yaml_any

puts json_string

json_any = Crystalizer::JSON.parse json_string

puts Crystalizer::YAML.serialize json_any

```

Result:

```yaml

{"one" => 1, "two" => 2, "sub" => {"ary" => ["one", 2]}}

{

  "one": 1,

  "two": 2,

  "sub": {

    "ary": [

      "one",

      2

    ]

  }

}

---

one: 1

two: 2

sub:

  ary:

  - one

  - 2

```

### User-defined serialization

Allows to define custom serialization and deserialization for a given type.

```crystal

struct MyType

  include Crystalizer::Type

  def initialize(@i : Int32)

  end

  def self.deserialize(deserializer : Crystalizer::Deserializer)

    new deserializer.deserialize to: Int32

  end

  def serialize(serializer : Crystalizer::Serializer) : Nil

    serializer.serialize @i

  end

end

```

### Note

Annotations are similar to the stdlib's `Serializable`, but all features are not yet fully implemented.

## License

Copyright (c) 2020-2023 Julien Reichardt - ISC License