No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
spec
src
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
shard.yml

README.md

nya_serializable

Build Status

Serializable module for Nya Engine

Installation

Add this to your application's shard.yml:

dependencies:
  nya_serializable:
    github: nya-engine/nya_serializable

Usage

require "nya_serializable"

class Foo
  include Nya::Serializable

  property foo = Bar.new
  property bar = ["foo", "foo bar"]
  property fubar = "unn4m3d"

  serializable foo : Bar, bar : Array(String)
  attribute fubar : String
end

Then you can #serialize it to something like that

<Foo fubar="unn4m3d">
  <foo>
    <Bar>
      ...
    </Bar>
  </foo>
  <bar>
    <item>foo</item>
    <item>foo bar</item>
  </bar>
</Foo>

And deserialize that XML into structure above with Nya::Serializable.deserialize(Foo)

Type name translation

Due to XML specifications, some complex names cannot be serialized as is, so some transformations are applied before.

  • Last double colon (::) is translated into single colon (:)
  • Other double colons are translated into underscores (_)
  • Type vars list of a generic class starts with double period ('..')
  • Names in type vars list are separated with single period ('.')
  • Type vars list ends with hyphen ('-')
  • Named args are not supported

Contributing

  1. Fork it ( https://github.com/nya-engine/nya_serializable/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors