https://github.com/darashi/gimlet

Document-oriented, Text-based and Read-only data storage
https://github.com/darashi/gimlet

Last synced: 28 days ago
JSON representation

Document-oriented, Text-based and Read-only data storage

• Host: GitHub
• URL: https://github.com/darashi/gimlet
• Owner: darashi
• License: mit
• Created: 2013-07-18T09:08:38.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-08-15T13:42:04.000Z (over 11 years ago)
• Last Synced: 2024-12-26T03:32:00.803Z (29 days ago)
• Language: Ruby
• Homepage:
• Size: 115 KB
• Stars: 5
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Gimlet

Document-oriented, Text-based and Read-only data storage

Gimlet is strongly inspired by [Local Data](http://middlemanapp.com/advanced/local-data/) of [Middleman](http://middlemanapp.com/). It is so handy, but it is built in middleman.

Gimlet let us to use this feature for general purposes that do not fit middleman with.

## Installation

Add this line to your application's Gemfile:

    gem 'gimlet'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install gimlet

## Usage

Put `data/people/homuhomu.yaml`,

    ---

    first_name: Homura

    last_name: Akemi

Then you can access the data:

    require 'gimlet'

    data = Gimlet::DataStore.new('data')

    p data.to_h                 #=> {"people"=>{"homuhomu"=>{"first_name"=>"Homura", "last_name"=>"Akemi"}}}

    p data.people.homuhomu      #=> {"first_name"=>"Homura", "last_name"=>"Akemi"}

    p data.people[:homuhomu].first_name #=> "Homura"

## Contributing

1. Fork it

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 new Pull Request