Active Yaml - model interfaces for yaml files

Framework that allows you to use model classes for mapping Yaml files.

Installation

gem 'activeyaml'

And then execute:

bundle install

Or install it yourself as:

gem install activeyaml

Require if necessary:

require 'active_yaml'

Usage with model

You can create models that will take data from your Yaml files. Suppose you have the following Yaml file: examples/example.yaml. With the following content:

start:
  kek:
    lol: 'text'
    cheburek: 'cheburek'
    users:
      first: '1'

(This and all subsequent examples will use this yaml file)

Then, you could do the following:

require 'active_yaml'

class User < ActiveYaml::BaseModel
  yaml 'examples/example.yaml'
end

You can then create instances of your model and use call chains to retrieve data from the Yaml file.

user = User.new
user.start.kek.lol # output: 'text'
user.start.kek.users.first # output: '1'

If you complete the chain not to the final value. You will get an object like a hash. It won't respond to []. However, you can use a dot to go through the values further. This object also has a “hash” method, which returns the current received hash.

h = user.start.kek.hash
h == {'lok' => 'text'} # true
h.is_a?(Hash) # true

You can also use data from Yaml files inside your model.

class User < ActiveYaml::BaseModel
  yaml 'examples/example.yaml'

  # The method will return "text"
  def test_method
    start.kek.lol
  end
end

There is also method yaml_data which will return the contents of the Yaml file as a regular hash.

user.yaml_data # will return a hash with the contents from the Yaml file

Usage without model

You can add class methods to your class to work with Yaml files directly without creating class instances

class User
  extend ActiveYaml::ClassMethods
  yaml 'examples/example.yaml'
end

After this, you can use class methods to make chains of calls.

User.start.kek.lol # output: 'text'

With this use case, method yaml_data is also supported.

You also don't have to create models to use this framework. After that, an object will be instantiated in the user variable, allowing chains of calls to be made. To do this you can do the following:

user = ActiveYaml.create('examples/example.yaml')
user.start.kek.lol # output: 'text'

Contribution

If you would like to contribute to the development, submit a pull request with your changes. We welcome any contributions that improve the service. You can also view the current project board here. You can also contribute by reporting bugs or suggesting new features. Please use the GitHub issues for that.