Project

sunstore

0.0
No commit activity in last 3 years
No release in over 3 years
Sometimes you just want to quickly save something and retrieve it. This is a lightweight gem for doing so using YAML or JSON serialization
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0
 Project Readme

Sunstore

SunStore is a Simple UNscalable storage mechanism for saving very simple key value pairs like preferences, config parameters, etc. It's really just a wrapper for JSON or YAML.

Installation

Add this line to your application's Gemfile:

gem 'sunstore'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sunstore

Usage

The simplest way is to say:

Sustore.put("myKey",someSerializableObject)

and to later retrieve it as

Sunstore.get("myKey")

Configuration

There are a couple of configuration parameters invoked via the config message prior to using:

Sunstore.config(params)

where the params can be:

:format: :json or :yaml (default)
:basename: the basename for the storage file (sunstore by default)
:basedir: the default location to put the file (Rails/tmp if used in Rails context, else current working directory)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake false 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.

Contributing

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

License

The gem is available as open source under the terms of the MIT License.