filekv 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.yardopts +1 -0
- data/LICENSE +16 -0
- data/README.md +41 -0
- data/Rakefile +13 -0
- data/lib/filekv/version.rb +6 -0
- data/spec/filekv_spec.rb +16 -0
- metadata +53 -0
data/.yardopts
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
--markup markdown
|
data/LICENSE
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
Copyright (c) 2013, Autumn Perrault <autumn@destellae.net>
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this
|
4
|
+
software and associated documentation files (the "Software"), to deal in the Software
|
5
|
+
without restriction, including without limitation the rights to use, copy, modify, merge,
|
6
|
+
publish, distribute, sublicense, and/or sell copies of the Software, and to permit
|
7
|
+
persons to whom the Software is furnished to do so, subject to the following conditions:
|
8
|
+
|
9
|
+
The above copyright notice and this permission notice shall be included in all copies or
|
10
|
+
substantial portions of the Software.
|
11
|
+
|
12
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
|
13
|
+
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
14
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
15
|
+
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
16
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,41 @@
|
|
1
|
+
filekv
|
2
|
+
======
|
3
|
+
|
4
|
+
Synopsis
|
5
|
+
--------
|
6
|
+
|
7
|
+
**filekv** is a simple, file-based key-value store which uses **csv** from the
|
8
|
+
Ruby standard library to store data on a key-value model in a file.
|
9
|
+
|
10
|
+
It is modeled as a drop-in replacement for [redis-rb](https://github.com/redis/redis-rb).
|
11
|
+
In other words, it can be used, to some extent, as an alternative data storage
|
12
|
+
means by applications designed for Redis.
|
13
|
+
|
14
|
+
Naturally, it does not replicate the entire featureset of Redis, and so
|
15
|
+
applications should bear this in mind.
|
16
|
+
|
17
|
+
Usage
|
18
|
+
-----
|
19
|
+
|
20
|
+
Some basic usage:
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'filekv'
|
24
|
+
|
25
|
+
db = FileKV.new 'moo.db'
|
26
|
+
|
27
|
+
db.set 'foo', 'bar'
|
28
|
+
db.get 'foo'
|
29
|
+
# => "bar"
|
30
|
+
```
|
31
|
+
|
32
|
+
Author
|
33
|
+
------
|
34
|
+
|
35
|
+
**filekv** was written by [Autumn Perrault](https://github.com/noxgirl).
|
36
|
+
|
37
|
+
License
|
38
|
+
-------
|
39
|
+
|
40
|
+
**filekv** is distributed under the terms of the MIT license. Please see the
|
41
|
+
`LICENSE` file.
|
data/Rakefile
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Copyright (c) 2013, Autumn Perrault
|
2
|
+
# This free software is distributed under the terms of the MIT license (see LICENSE).
|
3
|
+
|
4
|
+
require 'rake/testtask'
|
5
|
+
|
6
|
+
task :default => [:test]
|
7
|
+
|
8
|
+
desc 'Test the gem.'
|
9
|
+
Rake::TestTask.new do |t|
|
10
|
+
t.libs.push 'lib'
|
11
|
+
t.pattern = 'spec/*_spec.rb'
|
12
|
+
t.verbose = true
|
13
|
+
end
|
data/spec/filekv_spec.rb
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
# Copyright (c) 2013, Autumn Perrault
|
2
|
+
# This free software is distributed under the terms of the MIT license (see LICENSE).
|
3
|
+
require 'minitest/spec'
|
4
|
+
require 'minitest/autorun'
|
5
|
+
|
6
|
+
require 'filekv'
|
7
|
+
|
8
|
+
describe FileKV do
|
9
|
+
|
10
|
+
describe '#new' do
|
11
|
+
it 'takes a file path' do
|
12
|
+
FileKV.new
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
end
|
metadata
ADDED
@@ -0,0 +1,53 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: filekv
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Autumn Perrault
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-01-23 00:00:00.000000000 Z
|
13
|
+
dependencies: []
|
14
|
+
description: A file-based key-value store.
|
15
|
+
email: autumn@destellae.net
|
16
|
+
executables: []
|
17
|
+
extensions: []
|
18
|
+
extra_rdoc_files: []
|
19
|
+
files:
|
20
|
+
- lib/filekv/version.rb
|
21
|
+
- .yardopts
|
22
|
+
- README.md
|
23
|
+
- LICENSE
|
24
|
+
- spec/filekv_spec.rb
|
25
|
+
- Rakefile
|
26
|
+
homepage: https://github.com/noxgirl/filekv
|
27
|
+
licenses:
|
28
|
+
- MIT
|
29
|
+
post_install_message:
|
30
|
+
rdoc_options: []
|
31
|
+
require_paths:
|
32
|
+
- lib
|
33
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
34
|
+
none: false
|
35
|
+
requirements:
|
36
|
+
- - ! '>='
|
37
|
+
- !ruby/object:Gem::Version
|
38
|
+
version: '0'
|
39
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
40
|
+
none: false
|
41
|
+
requirements:
|
42
|
+
- - ! '>='
|
43
|
+
- !ruby/object:Gem::Version
|
44
|
+
version: '0'
|
45
|
+
requirements: []
|
46
|
+
rubyforge_project:
|
47
|
+
rubygems_version: 1.8.23
|
48
|
+
signing_key:
|
49
|
+
specification_version: 3
|
50
|
+
summary: A file-based key-value store.
|
51
|
+
test_files:
|
52
|
+
- spec/filekv_spec.rb
|
53
|
+
- Rakefile
|