https://github.com/folkengine/yamlable

Ruby YAML module I like to add to Classes.
https://github.com/folkengine/yamlable

Last synced: 3 months ago
JSON representation

Ruby YAML module I like to add to Classes.

• Host: GitHub
• URL: https://github.com/folkengine/yamlable
• Owner: folkengine
• License: mit
• Created: 2016-04-23T15:11:58.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-30T15:34:04.000Z (about 9 years ago)
• Last Synced: 2025-03-06T00:52:46.137Z (3 months ago)
• Language: Ruby
• Size: 10.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Yamlable

[![Gem Version](https://badge.fury.io/rb/yamlable.svg)](https://badge.fury.io/rb/yamlable)

[![Build Status](https://travis-ci.org/folkengine/yamlable.svg?branch=master)](https://travis-ci.org/folkengine/yamlable)

Simple Ruby Module that adds to_yaml to any Object that includes it.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'yamlable'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install yamlable

## Usage

```ruby

class Example

  include Yamlable

  ...

```

```ruby

ex = Example.new

ex_yaml = ex.to_yaml

ex_again = Yamlable.from_yaml(ex_yaml)

```

  

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/folkengine/yamlable.