README.md
# Gkv
[](https://gitter.im/ybur-yug/gkv?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
<a href="https://codeclimate.com/github/ybur-yug/gkv"><img src="https://codeclimate.com/github/ybur-yug/gkv/badges/gpa.svg" /></a>
[](http://badge.fury.io/rb/gkv)
[](https://travis-ci.org/ybur-yug/gkv)
Gkv is a simple git wrapper that allows you to use it as a kv store
The documentation says thats what it does. So why not yo?
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'gkv'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install gkv
## API
Types are implicitly understood, and are automatically set/loaded. Only symbols are excluded.
There are 4 main functions:
### Set
db[*key*] = *value*
```ruby
db = Gkv::Database.new
db['Pants'] = 'red leather'
# => 'red leather'
```
This allows a shorthand notation using operator overloading to set without invoking `set` directly.
set(*key*, *value*)
```ruby
db = Gkv::Database.new
db.set('key', '12')
# => 'key'
db.set('test', 12)
# => 'test'
```
### Get
db[*key*]
```ruby
db = Gkv::Database.new
db['Pants']
# => 'red leather'
```
This allows a shorthand notation using operator overloading to get without invoking `get` directly.
get(*key*)
```ruby
db = Gkv::Database.new
db.set('apples', '10')
# => 'apples'
db.get('apples')
# => '10'
```
The type is inferred from when you initially set the value. Note that saving the string `'1'` will
return the integer `1` due to the naive nature of the implementation. Hashes, arrays and booleans
behave as expected when saved.
### Get Version
get_version(*version*, *key*)
```ruby
db = Gkv::Database.new
db.set('apples', '20')
# => 'apples'
db.set('apples', '50')
# => 'apples'
db.get_version(1, 'apples')
# => '20'
db.get_version(2, 'apples')
# => '50'
```
### All
all
```ruby
db.set('apples', 20.0)
db.set('ants', 'pants')
db.set('things', {})
db.all
# =>[{ 'apples': 20.0 }, { 'ants': 'pants'}, { 'things': {} }]
```
all_versions(*key*)
```ruby
db.set('apples', 5)
db.set('apples', 'pants')
db.set('apples', 5.0)
db.all_versions('apples')
# => [ 5, 'pants', 5.0]
```
### Destroy
```ruby
db.set('apples', 20.0)
db.set('ants', 'pants')
db.set('things', {})
db.destroy!
db['apples']
# => KeyError
db['ants']
# => KeyError
db['things']
# => KeyError
```
## Usage
```ruby
db = Gkv::Database.new
db.set('Apples', '10')
# => 'Apples'
db.get('Apples')
# => '10'
# update some values
db.set('Apples', '12')
# => 'Apples'
db.get('Apples')
# => '12'
db.get_version(1, 'Apples')
#=> '10'
# keys that do not exist return KeyError
db.get('magic')
# => KeyError
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the
tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
It is a typical bundle install to get things running. We use Guard for testing. To initialize it simply
run
`$ guard`
And you will be good to go!
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).
### Dev Roadmap
#### 0.3
- Remote synchronization & Backup []
- Persistance & Dump Loading [x]
- Stop wrapping git via it's CLI []
## Contributing
Feel free to check out the gitter room and ask whats on the agenda.
Bug reports and pull requests are welcome on GitHub at https://github.com/ybur-yug/gkv.
## License
See [this](http://www.wtfpl.net/about/).