abbey 0.1.0.beta

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+gem "multi_json"
+
+group :development do
+  gem "minitest", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Pavel Kalvoda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+todo

data/Rakefile

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'lib/version'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "abbey"
+  gem.homepage = "http://github.com/PJK/abbey"
+  gem.license = "MIT"
+  gem.summary = "Primitive JSON data store"
+  gem.description = %Q{Primitive JSON data store. Key-value structure with namespaces.}
+  gem.email = "me@pavelkalvoda.com"
+  gem.authors = ["Pavel Kalvoda"]
+  gem.version = Abbey::Version::STRING
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+desc "Run the unit tests in test/unit"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "abbey #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/abbey.rb

@@ -0,0 +1,7 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'version'
+require 'errors'
+require 'entity_storage'
+require 'settings'
+require 'multi_json'

data/lib/entity_storage.rb

@@ -0,0 +1,88 @@
+module Abbey
+  class EntityStorage
+    attr_accessor :settings
+
+    def initialize(settings)
+      @settings = settings
+    end
+
+    def set_up?
+      ready = true
+      dirs = [settings.path]
+      settings.namespaces.each {|x| dirs << make_path(x)}
+      dirs.each do |dir|
+        existent, writable = Dir.exists?(dir), File.writable?(dir)
+        settings.logger.debug("#{dir} -- exists: #{existent}, writable: #{writable}")
+        ready &&= existent && writable
+      end
+      ready
+    end
+
+    def set_up!
+      settings.namespaces.each do |ns|
+        path = make_path(ns)
+        if !Dir.exists?(path) then
+          settings.logger.debug("Creating dir #{path}")
+          FileUtils.mkdir_p(path)
+        end
+      end
+    end
+
+    def save(namespace, key, data)
+      path = make_path(namespace, key)
+      raise ItemAlreadyPresentError.new if File.exist?(path)
+      f = File.new(path, File::CREAT | File::RDWR)
+      size = f.write(MultiJson.encode(data))
+      f.close
+      settings.logger.info("Written #{make_key(namespace, key)} (size: #{size})")
+    end
+
+    def get(namespace, key)
+      path = make_path(namespace, key)
+      raise ItemNotFoundError.new unless exists?(namespace, key)
+      settings.logger.info("Read #{make_key(namespace, key)}")
+      MultiJson.decode(File.read(path))
+    end
+
+    def exists?(namespace, key)
+      exists = File.exist?(make_path(namespace, key))
+      settings.logger.info("Queried #{make_key(namespace, key)}, found: #{exists}")
+      exists
+    end
+
+    def update(namespace, key, data)
+      delete(namespace, key)
+      save(namespace, key, data)
+    end
+
+    def delete(namespace, key)
+      path = make_path(namespace, key)
+      raise ItemNotFoundError.new unless exists?(namespace, key)
+      File.delete(path)
+      settings.logger.info("Deleted #{make_key(namespace,key)}")
+    end
+
+    def list(namespace)
+      list = Dir.entries(make_path(namespace)) - %w{. ..}
+      list.map! {|item| File.split(item)[1].to_sym}
+      list.to_set
+    end
+
+    def get_all(namespace)
+      result = {}
+      list(namespace).each {|key| result[key] = get(namespace, key)}
+      result
+    end
+
+    private
+
+    def make_path(namespace, key = nil)
+      dir = File.join(settings.path, namespace.to_s)
+      key ? File.join(dir, key.to_s) : dir
+    end
+
+    def make_key(namespace, key)
+      namespace.to_s + ':' + key.to_s
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,7 @@
+module Abbey
+  class ItemAlreadyPresentError < RuntimeError
+  end
+
+  class ItemNotFoundError < RuntimeError
+  end
+end

data/lib/settings.rb

@@ -0,0 +1,13 @@
+require 'logger'
+
+module Abbey
+  class Settings
+    attr_accessor :namespaces, :logger,  :path
+
+    def initialize(path, namespaces = [], logger = nil)
+      @path = path
+      @namespaces = namespaces
+      @logger = (logger || Logger.new('/dev/null'))
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,10 @@
+module Abbey
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = 'beta'
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/test/entity_storage_test.rb

@@ -0,0 +1,80 @@
+require "helper"
+
+class AbbeyTest < Test::Unit::TestCase
+
+  def setup
+    @settings = Abbey::Settings.new('/tmp/abbey', [:ns1, :ns2], Logger.new(STDOUT))
+    @abbey = Abbey::EntityStorage.new(@settings)
+  end
+
+  def teardown
+    FileUtils.rm_r('/tmp/abbey')
+  end
+
+  def test_it_will_check_for_readiness
+    assert !@abbey.set_up?
+    FileUtils.mkdir_p('/tmp/abbey/ns1')
+    FileUtils.mkdir('/tmp/abbey/ns2')
+    assert Dir.exists?('/tmp/abbey/ns1')
+    assert @abbey.set_up?
+
+  end
+
+  def test_it_will_create_directories
+    assert !@abbey.set_up?
+    @abbey.set_up!
+    assert @abbey.set_up?
+  end
+
+  def test_it_will_save_data
+    @abbey.set_up!
+    data = {"a" => "some string, man", "b" => [1, 2, 3]}
+    @abbey.save(:ns1, :key, data)
+    assert_equal data, @abbey.get(:ns1, :key)
+  end
+
+  def test_it_wont_accept_bad_ns
+    @abbey.set_up!
+    begin
+      @abbey.save(:bullshit, :key, {})
+      assert false, "Errno::ENOENT not thrown"
+    rescue Errno::ENOENT
+    end
+  end
+
+  def test_exists_works
+    @abbey.set_up!
+    @abbey.save(:ns1, :key, {})
+    assert @abbey.exists?(:ns1, :key)
+    assert !@abbey.exists?(:ns1, :bleeee)
+  end
+
+  def test_it_deletes_items
+    @abbey.set_up!
+    @abbey.save(:ns1, :key, {})
+    assert @abbey.exists?(:ns1, :key)
+    @abbey.delete(:ns1, :key)
+    assert !@abbey.exists?(:ns1, :key)
+  end
+
+  def test_it_lists_items
+    @abbey.set_up!
+    @abbey.save(:ns1, :key, {:a => :b})
+    @abbey.save(:ns1, :key2, ["a"])
+    assert_equal Set.new([:key, :key2]), @abbey.list(:ns1)
+  end
+
+  def test_it_gets_all_items
+    @abbey.set_up!
+    @abbey.save(:ns1, :key, {"a" => 1})
+    @abbey.save(:ns1, :key2, %w{a b c})
+    assert_equal({:key => {"a" => 1}, :key2 => %w{a b c}}, @abbey.get_all(:ns1))
+  end
+
+  def test_it_updates_items
+    @abbey.set_up!
+    @abbey.save(:ns1, :key, {"a" => 1})
+    @abbey.update(:ns1, :key, {"a" => 2})
+    assert_equal({"a" => 2}, @abbey.get(:ns1,:key))
+  end
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'abbey'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: abbey
+version: !ruby/object:Gem::Version
+  version: 0.1.0.beta
+  prerelease: 6
+platform: ruby
+authors:
+- Pavel Kalvoda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &10668260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *10668260
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &10667720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10667720
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &10667160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *10667160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &10666560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *10666560
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &10666040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10666040
+description: Primitive JSON data store. Key-value structure with namespaces.
+email: me@pavelkalvoda.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/abbey.rb
+- lib/entity_storage.rb
+- lib/errors.rb
+- lib/settings.rb
+- lib/version.rb
+- test/entity_storage_test.rb
+- test/helper.rb
+homepage: http://github.com/PJK/abbey
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4270260212443157671
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Primitive JSON data store
+test_files: []