abbey 0.1.0.beta
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/Gemfile +15 -0
- data/LICENSE.txt +20 -0
- data/README.md +1 -0
- data/Rakefile +60 -0
- data/lib/abbey.rb +7 -0
- data/lib/entity_storage.rb +88 -0
- data/lib/errors.rb +7 -0
- data/lib/settings.rb +13 -0
- data/lib/version.rb +10 -0
- data/test/entity_storage_test.rb +80 -0
- data/test/helper.rb +2 -0
- metadata +117 -0
data/.document
ADDED
data/Gemfile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
source "http://rubygems.org"
|
2
|
+
# Add dependencies required to use your gem here.
|
3
|
+
# Example:
|
4
|
+
# gem "activesupport", ">= 2.3.5"
|
5
|
+
|
6
|
+
# Add dependencies to develop your gem here.
|
7
|
+
# Include everything needed to run rake, tests, features, etc.
|
8
|
+
gem "multi_json"
|
9
|
+
|
10
|
+
group :development do
|
11
|
+
gem "minitest", ">= 0"
|
12
|
+
gem "bundler", "~> 1.0.0"
|
13
|
+
gem "jeweler", "~> 1.6.4"
|
14
|
+
gem "rcov", ">= 0"
|
15
|
+
end
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2011 Pavel Kalvoda
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
todo
|
data/Rakefile
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
require 'rubygems'
|
4
|
+
require 'bundler'
|
5
|
+
begin
|
6
|
+
Bundler.setup(:default, :development)
|
7
|
+
rescue Bundler::BundlerError => e
|
8
|
+
$stderr.puts e.message
|
9
|
+
$stderr.puts "Run `bundle install` to install missing gems"
|
10
|
+
exit e.status_code
|
11
|
+
end
|
12
|
+
require 'rake'
|
13
|
+
|
14
|
+
$:.unshift File.dirname(__FILE__)
|
15
|
+
|
16
|
+
require 'lib/version'
|
17
|
+
|
18
|
+
require 'jeweler'
|
19
|
+
Jeweler::Tasks.new do |gem|
|
20
|
+
# gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
|
21
|
+
gem.name = "abbey"
|
22
|
+
gem.homepage = "http://github.com/PJK/abbey"
|
23
|
+
gem.license = "MIT"
|
24
|
+
gem.summary = "Primitive JSON data store"
|
25
|
+
gem.description = %Q{Primitive JSON data store. Key-value structure with namespaces.}
|
26
|
+
gem.email = "me@pavelkalvoda.com"
|
27
|
+
gem.authors = ["Pavel Kalvoda"]
|
28
|
+
gem.version = Abbey::Version::STRING
|
29
|
+
# dependencies defined in Gemfile
|
30
|
+
end
|
31
|
+
Jeweler::RubygemsDotOrgTasks.new
|
32
|
+
|
33
|
+
require 'rake/testtask'
|
34
|
+
desc "Run the unit tests in test/unit"
|
35
|
+
Rake::TestTask.new do |t|
|
36
|
+
t.libs << "test"
|
37
|
+
t.test_files = FileList['test/*_test.rb']
|
38
|
+
t.verbose = true
|
39
|
+
end
|
40
|
+
|
41
|
+
|
42
|
+
require 'rcov/rcovtask'
|
43
|
+
Rcov::RcovTask.new do |test|
|
44
|
+
test.libs << 'test'
|
45
|
+
test.pattern = 'test/**/test_*.rb'
|
46
|
+
test.verbose = true
|
47
|
+
test.rcov_opts << '--exclude "gems/*"'
|
48
|
+
end
|
49
|
+
|
50
|
+
task :default => :test
|
51
|
+
|
52
|
+
require 'rdoc/task'
|
53
|
+
Rake::RDocTask.new do |rdoc|
|
54
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
55
|
+
|
56
|
+
rdoc.rdoc_dir = 'rdoc'
|
57
|
+
rdoc.title = "abbey #{version}"
|
58
|
+
rdoc.rdoc_files.include('README*')
|
59
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
60
|
+
end
|
data/lib/abbey.rb
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
module Abbey
|
2
|
+
class EntityStorage
|
3
|
+
attr_accessor :settings
|
4
|
+
|
5
|
+
def initialize(settings)
|
6
|
+
@settings = settings
|
7
|
+
end
|
8
|
+
|
9
|
+
def set_up?
|
10
|
+
ready = true
|
11
|
+
dirs = [settings.path]
|
12
|
+
settings.namespaces.each {|x| dirs << make_path(x)}
|
13
|
+
dirs.each do |dir|
|
14
|
+
existent, writable = Dir.exists?(dir), File.writable?(dir)
|
15
|
+
settings.logger.debug("#{dir} -- exists: #{existent}, writable: #{writable}")
|
16
|
+
ready &&= existent && writable
|
17
|
+
end
|
18
|
+
ready
|
19
|
+
end
|
20
|
+
|
21
|
+
def set_up!
|
22
|
+
settings.namespaces.each do |ns|
|
23
|
+
path = make_path(ns)
|
24
|
+
if !Dir.exists?(path) then
|
25
|
+
settings.logger.debug("Creating dir #{path}")
|
26
|
+
FileUtils.mkdir_p(path)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
def save(namespace, key, data)
|
32
|
+
path = make_path(namespace, key)
|
33
|
+
raise ItemAlreadyPresentError.new if File.exist?(path)
|
34
|
+
f = File.new(path, File::CREAT | File::RDWR)
|
35
|
+
size = f.write(MultiJson.encode(data))
|
36
|
+
f.close
|
37
|
+
settings.logger.info("Written #{make_key(namespace, key)} (size: #{size})")
|
38
|
+
end
|
39
|
+
|
40
|
+
def get(namespace, key)
|
41
|
+
path = make_path(namespace, key)
|
42
|
+
raise ItemNotFoundError.new unless exists?(namespace, key)
|
43
|
+
settings.logger.info("Read #{make_key(namespace, key)}")
|
44
|
+
MultiJson.decode(File.read(path))
|
45
|
+
end
|
46
|
+
|
47
|
+
def exists?(namespace, key)
|
48
|
+
exists = File.exist?(make_path(namespace, key))
|
49
|
+
settings.logger.info("Queried #{make_key(namespace, key)}, found: #{exists}")
|
50
|
+
exists
|
51
|
+
end
|
52
|
+
|
53
|
+
def update(namespace, key, data)
|
54
|
+
delete(namespace, key)
|
55
|
+
save(namespace, key, data)
|
56
|
+
end
|
57
|
+
|
58
|
+
def delete(namespace, key)
|
59
|
+
path = make_path(namespace, key)
|
60
|
+
raise ItemNotFoundError.new unless exists?(namespace, key)
|
61
|
+
File.delete(path)
|
62
|
+
settings.logger.info("Deleted #{make_key(namespace,key)}")
|
63
|
+
end
|
64
|
+
|
65
|
+
def list(namespace)
|
66
|
+
list = Dir.entries(make_path(namespace)) - %w{. ..}
|
67
|
+
list.map! {|item| File.split(item)[1].to_sym}
|
68
|
+
list.to_set
|
69
|
+
end
|
70
|
+
|
71
|
+
def get_all(namespace)
|
72
|
+
result = {}
|
73
|
+
list(namespace).each {|key| result[key] = get(namespace, key)}
|
74
|
+
result
|
75
|
+
end
|
76
|
+
|
77
|
+
private
|
78
|
+
|
79
|
+
def make_path(namespace, key = nil)
|
80
|
+
dir = File.join(settings.path, namespace.to_s)
|
81
|
+
key ? File.join(dir, key.to_s) : dir
|
82
|
+
end
|
83
|
+
|
84
|
+
def make_key(namespace, key)
|
85
|
+
namespace.to_s + ':' + key.to_s
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
data/lib/errors.rb
ADDED
data/lib/settings.rb
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
require 'logger'
|
2
|
+
|
3
|
+
module Abbey
|
4
|
+
class Settings
|
5
|
+
attr_accessor :namespaces, :logger, :path
|
6
|
+
|
7
|
+
def initialize(path, namespaces = [], logger = nil)
|
8
|
+
@path = path
|
9
|
+
@namespaces = namespaces
|
10
|
+
@logger = (logger || Logger.new('/dev/null'))
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
data/lib/version.rb
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
require "helper"
|
2
|
+
|
3
|
+
class AbbeyTest < Test::Unit::TestCase
|
4
|
+
|
5
|
+
def setup
|
6
|
+
@settings = Abbey::Settings.new('/tmp/abbey', [:ns1, :ns2], Logger.new(STDOUT))
|
7
|
+
@abbey = Abbey::EntityStorage.new(@settings)
|
8
|
+
end
|
9
|
+
|
10
|
+
def teardown
|
11
|
+
FileUtils.rm_r('/tmp/abbey')
|
12
|
+
end
|
13
|
+
|
14
|
+
def test_it_will_check_for_readiness
|
15
|
+
assert !@abbey.set_up?
|
16
|
+
FileUtils.mkdir_p('/tmp/abbey/ns1')
|
17
|
+
FileUtils.mkdir('/tmp/abbey/ns2')
|
18
|
+
assert Dir.exists?('/tmp/abbey/ns1')
|
19
|
+
assert @abbey.set_up?
|
20
|
+
|
21
|
+
end
|
22
|
+
|
23
|
+
def test_it_will_create_directories
|
24
|
+
assert !@abbey.set_up?
|
25
|
+
@abbey.set_up!
|
26
|
+
assert @abbey.set_up?
|
27
|
+
end
|
28
|
+
|
29
|
+
def test_it_will_save_data
|
30
|
+
@abbey.set_up!
|
31
|
+
data = {"a" => "some string, man", "b" => [1, 2, 3]}
|
32
|
+
@abbey.save(:ns1, :key, data)
|
33
|
+
assert_equal data, @abbey.get(:ns1, :key)
|
34
|
+
end
|
35
|
+
|
36
|
+
def test_it_wont_accept_bad_ns
|
37
|
+
@abbey.set_up!
|
38
|
+
begin
|
39
|
+
@abbey.save(:bullshit, :key, {})
|
40
|
+
assert false, "Errno::ENOENT not thrown"
|
41
|
+
rescue Errno::ENOENT
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
def test_exists_works
|
46
|
+
@abbey.set_up!
|
47
|
+
@abbey.save(:ns1, :key, {})
|
48
|
+
assert @abbey.exists?(:ns1, :key)
|
49
|
+
assert !@abbey.exists?(:ns1, :bleeee)
|
50
|
+
end
|
51
|
+
|
52
|
+
def test_it_deletes_items
|
53
|
+
@abbey.set_up!
|
54
|
+
@abbey.save(:ns1, :key, {})
|
55
|
+
assert @abbey.exists?(:ns1, :key)
|
56
|
+
@abbey.delete(:ns1, :key)
|
57
|
+
assert !@abbey.exists?(:ns1, :key)
|
58
|
+
end
|
59
|
+
|
60
|
+
def test_it_lists_items
|
61
|
+
@abbey.set_up!
|
62
|
+
@abbey.save(:ns1, :key, {:a => :b})
|
63
|
+
@abbey.save(:ns1, :key2, ["a"])
|
64
|
+
assert_equal Set.new([:key, :key2]), @abbey.list(:ns1)
|
65
|
+
end
|
66
|
+
|
67
|
+
def test_it_gets_all_items
|
68
|
+
@abbey.set_up!
|
69
|
+
@abbey.save(:ns1, :key, {"a" => 1})
|
70
|
+
@abbey.save(:ns1, :key2, %w{a b c})
|
71
|
+
assert_equal({:key => {"a" => 1}, :key2 => %w{a b c}}, @abbey.get_all(:ns1))
|
72
|
+
end
|
73
|
+
|
74
|
+
def test_it_updates_items
|
75
|
+
@abbey.set_up!
|
76
|
+
@abbey.save(:ns1, :key, {"a" => 1})
|
77
|
+
@abbey.update(:ns1, :key, {"a" => 2})
|
78
|
+
assert_equal({"a" => 2}, @abbey.get(:ns1,:key))
|
79
|
+
end
|
80
|
+
end
|
data/test/helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,117 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: abbey
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0.beta
|
5
|
+
prerelease: 6
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Pavel Kalvoda
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2011-11-11 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: multi_json
|
16
|
+
requirement: &10668260 !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: *10668260
|
25
|
+
- !ruby/object:Gem::Dependency
|
26
|
+
name: minitest
|
27
|
+
requirement: &10667720 !ruby/object:Gem::Requirement
|
28
|
+
none: false
|
29
|
+
requirements:
|
30
|
+
- - ! '>='
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '0'
|
33
|
+
type: :development
|
34
|
+
prerelease: false
|
35
|
+
version_requirements: *10667720
|
36
|
+
- !ruby/object:Gem::Dependency
|
37
|
+
name: bundler
|
38
|
+
requirement: &10667160 !ruby/object:Gem::Requirement
|
39
|
+
none: false
|
40
|
+
requirements:
|
41
|
+
- - ~>
|
42
|
+
- !ruby/object:Gem::Version
|
43
|
+
version: 1.0.0
|
44
|
+
type: :development
|
45
|
+
prerelease: false
|
46
|
+
version_requirements: *10667160
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: jeweler
|
49
|
+
requirement: &10666560 !ruby/object:Gem::Requirement
|
50
|
+
none: false
|
51
|
+
requirements:
|
52
|
+
- - ~>
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 1.6.4
|
55
|
+
type: :development
|
56
|
+
prerelease: false
|
57
|
+
version_requirements: *10666560
|
58
|
+
- !ruby/object:Gem::Dependency
|
59
|
+
name: rcov
|
60
|
+
requirement: &10666040 !ruby/object:Gem::Requirement
|
61
|
+
none: false
|
62
|
+
requirements:
|
63
|
+
- - ! '>='
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: '0'
|
66
|
+
type: :development
|
67
|
+
prerelease: false
|
68
|
+
version_requirements: *10666040
|
69
|
+
description: Primitive JSON data store. Key-value structure with namespaces.
|
70
|
+
email: me@pavelkalvoda.com
|
71
|
+
executables: []
|
72
|
+
extensions: []
|
73
|
+
extra_rdoc_files:
|
74
|
+
- LICENSE.txt
|
75
|
+
- README.md
|
76
|
+
files:
|
77
|
+
- .document
|
78
|
+
- Gemfile
|
79
|
+
- LICENSE.txt
|
80
|
+
- README.md
|
81
|
+
- Rakefile
|
82
|
+
- lib/abbey.rb
|
83
|
+
- lib/entity_storage.rb
|
84
|
+
- lib/errors.rb
|
85
|
+
- lib/settings.rb
|
86
|
+
- lib/version.rb
|
87
|
+
- test/entity_storage_test.rb
|
88
|
+
- test/helper.rb
|
89
|
+
homepage: http://github.com/PJK/abbey
|
90
|
+
licenses:
|
91
|
+
- MIT
|
92
|
+
post_install_message:
|
93
|
+
rdoc_options: []
|
94
|
+
require_paths:
|
95
|
+
- lib
|
96
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
97
|
+
none: false
|
98
|
+
requirements:
|
99
|
+
- - ! '>='
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
segments:
|
103
|
+
- 0
|
104
|
+
hash: -4270260212443157671
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
none: false
|
107
|
+
requirements:
|
108
|
+
- - ! '>'
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: 1.3.1
|
111
|
+
requirements: []
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 1.8.10
|
114
|
+
signing_key:
|
115
|
+
specification_version: 3
|
116
|
+
summary: Primitive JSON data store
|
117
|
+
test_files: []
|