abbey 0.1.0.beta → 0.1.0.beta2

data/README.md

@@ -1 +1,51 @@
-todo
+# Abbey
+
+A primitive JSON data store
+
+## Description
+
+A simple persistence library with human-readable representation. Uses good 'ol filesystem. Features: basic operations & namespaces. To be used for prototyping and as a backend of more sophisticated/specific implementations.
+
+## Usage
+
+Warning: Abbey intentionally uses JSON, therefore it inherits its' caveats. Most notably, symbols are serialized to strings.
+
+```ruby
+require 'abbey'
+
+abbey = Abbey::EntityStorage.new(Abbey::Settings.new('/var/myapp/data', [:users, :books]))
+
+abbey.set_up! unless abbey.set_up? # will prepare directories and shit
+
+abbey.save(:users, :admin, {:name => "John Smith"})
+
+abbey.save(:users, :admin, {:name => "John Smith"}) # => Abbey::ItemAlreadyExistsError
+
+abbey.get(:users, :admin) # => {"name" => "John Smith"}
+
+abbey.update(:users, :admin, {:name => "John C. Smith"})
+
+abbey.update(:users, :nonexistent, {:name => "Joe Black"}) # => Abbey::ItemNotFoundError
+
+abbey.list(:users) # => #<Set: {:admin}>
+
+abbey.get_all(:users) # => {"admin" => {"name" => "John Smith"}}
+
+abbey.delete(:users, :admin)
+
+abbey.drop(:users) # will delete all data in the namespace
+
+abbey.exists?(:users, :admin) # => false
+
+abbey.settings.namespaces # => [:users, :books]
+
+abbey.settings.logger # => #<Loger....>
+```
+
+## License
+
+MIT. See LICENSE.txt
+
+## Author
+
+Pavel Kalvoda <me@pavelkalvoda.com>

data/abbey.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "abbey"
+  s.version = "0.1.0.beta2"
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Pavel Kalvoda"]
+  s.date = "2011-11-12"
+  s.description = "Primitive JSON data store. Key-value structure with namespaces."
+  s.email = "me@pavelkalvoda.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "abbey.gemspec",
+    "lib/abbey.rb",
+    "lib/entity_storage.rb",
+    "lib/errors.rb",
+    "lib/settings.rb",
+    "lib/version.rb",
+    "test/entity_storage_test.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = "http://github.com/PJK/abbey"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Primitive JSON data store"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<multi_json>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<multi_json>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<multi_json>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/entity_storage.rb

@@ -1,11 +1,19 @@
 module Abbey
+
+  # Represents the store. Manages the data for you.
+  # JSON serialization under the hood.
   class EntityStorage
+
+    # @return [Settings]
     attr_accessor :settings
 
+    # @param settings [Settings]
     def initialize(settings)
       @settings = settings
     end
 
+    # Is everything ready?
+    # @return void
     def set_up?
       ready = true
       dirs = [settings.path]
@@ -18,6 +26,8 @@ module Abbey
       ready
     end
 
+    # Set up the directory structure
+    # @return void
     def set_up!
       settings.namespaces.each do |ns|
         path = make_path(ns)
@@ -28,6 +38,11 @@ module Abbey
       end
     end
 
+    # Save an item
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param data [Object]
+    # @return void
     def save(namespace, key, data)
       path = make_path(namespace, key)
       raise ItemAlreadyPresentError.new if File.exist?(path)
@@ -37,6 +52,10 @@ module Abbey
       settings.logger.info("Written #{make_key(namespace, key)} (size: #{size})")
     end
 
+    # Fetch an item
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return [Object]
     def get(namespace, key)
       path = make_path(namespace, key)
       raise ItemNotFoundError.new unless exists?(namespace, key)
@@ -44,17 +63,30 @@ module Abbey
       MultiJson.decode(File.read(path))
     end
 
+    # Does the item exist?
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return [Boolean]
     def exists?(namespace, key)
       exists = File.exist?(make_path(namespace, key))
       settings.logger.info("Queried #{make_key(namespace, key)}, found: #{exists}")
       exists
     end
 
+    # Update an item. Shorthand for delete & save
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param data [Object]
+    # @return void
     def update(namespace, key, data)
       delete(namespace, key)
       save(namespace, key, data)
     end
 
+    # Delete an item
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @param key [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return void
     def delete(namespace, key)
       path = make_path(namespace, key)
       raise ItemNotFoundError.new unless exists?(namespace, key)
@@ -62,12 +94,17 @@ module Abbey
       settings.logger.info("Deleted #{make_key(namespace,key)}")
     end
 
+    # Get keys of all entries in the namespace
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return [Set] List of all keys in the namespace
     def list(namespace)
       list = Dir.entries(make_path(namespace)) - %w{. ..}
       list.map! {|item| File.split(item)[1].to_sym}
       list.to_set
     end
 
+    # @param namespace [String, Fixnum, Symbol or any other object whose #to_s method returns string]
+    # @return [Hash] Hash of all items in the namespace, indexed by items' keys
     def get_all(namespace)
       result = {}
       list(namespace).each {|key| result[key] = get(namespace, key)}

data/lib/errors.rb

@@ -1,4 +1,6 @@
 module Abbey
+
+  # Thrown when trying to overwrite an item
   class ItemAlreadyPresentError < RuntimeError
   end
 

data/lib/settings.rb

@@ -4,6 +4,9 @@ module Abbey
   class Settings
     attr_accessor :namespaces, :logger,  :path
 
+    # @param path [String] Filesystem path to store the data in
+    # @param namespaces [Array] Namespaces to create
+    # @param logger [Logger]
     def initialize(path, namespaces = [], logger = nil)
       @path = path
       @namespaces = namespaces

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abbey
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta
+  version: 0.1.0.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-11 00:00:00.000000000 Z
+date: 2011-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &10668260 !ruby/object:Gem::Requirement
+  requirement: &20358020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10668260
+  version_requirements: *20358020
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10667720 !ruby/object:Gem::Requirement
+  requirement: &20357420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10667720
+  version_requirements: *20357420
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &10667160 !ruby/object:Gem::Requirement
+  requirement: &20356840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *10667160
+  version_requirements: *20356840
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &10666560 !ruby/object:Gem::Requirement
+  requirement: &20372660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *10666560
+  version_requirements: *20372660
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &10666040 !ruby/object:Gem::Requirement
+  requirement: &20372100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10666040
+  version_requirements: *20372100
 description: Primitive JSON data store. Key-value structure with namespaces.
 email: me@pavelkalvoda.com
 executables: []
@@ -79,6 +79,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- abbey.gemspec
 - lib/abbey.rb
 - lib/entity_storage.rb
 - lib/errors.rb
@@ -101,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4270260212443157671
+      hash: -1920122007598384642
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: