machu-appengine-pstore 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,11 +1,42 @@
 = appengine-pstore
 
- * http://github.com/machu/appengine-pstore
+* http://github.com/machu/appengine-pstore
 
 == DESCRIPTION:
 
 The PStore interfaces for the Google App Engine Datastore.
 
+== SYNOPSIS
+
+You can use the Google App Engine Datastore like PStore.
+
+ db = AppEngine::PStore.new('database.pstore')
+ db.transaction do |db|
+   db[:key1] = "value1"
+   db[:key2] = "value2"
+ end
+ 
+ db.transaction do |db|
+   puts db[:key1]   # => "value1"
+ end
+
+== NOTE
+
+A database has following limits.
+
+* maximum key count: 1,000 keys
+* maximum value size: 1MB
+
+== INSTALL
+
+This module is hosted by gems.github.com. 
+
+ sudo gem install machu-appengine-pstore --source http://gems.github.com
+
+== DEPENDENCIES
+
+This library depends on appengine-apis.
+
 == Copyright
 
 Copyright (c) 2009 MATSUOKA Kohei. See LICENSE for details.

data/Rakefile

@@ -5,12 +5,13 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "appengine-pstore"
-    gem.summary = %Q{PStore compatible interface for Google Apps Engine.}
-    gem.description = %Q{PStore compatible interface for Google Apps Engine.}
+    gem.summary = %Q{The PStore interfaces for the Google App Engine Datastore.}
+    gem.description = %Q{The PStore interfaces for the Google App Engine Datastore.}
     gem.email = "kohei@machu.jp"
     gem.homepage = "http://github.com/machu/appengine-pstore"
     gem.authors = ["MATSUOKA Kohei"]
     gem.add_development_dependency "rspec"
+    gem.add_dependency "appengine-apis"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/appengine-pstore.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{appengine-pstore}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["MATSUOKA Kohei"]
-  s.date = %q{2009-09-27}
-  s.description = %q{PStore compatible interface for Google Apps Engine.}
+  s.date = %q{2009-09-28}
+  s.description = %q{The PStore interfaces for the Google App Engine Datastore.}
   s.email = %q{kohei@machu.jp}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{PStore compatible interface for Google Apps Engine.}
+  s.summary = %q{The PStore interfaces for the Google App Engine Datastore.}
   s.test_files = [
     "spec/appengine-pstore_spec.rb",
      "spec/spec_helper.rb"
@@ -44,10 +44,13 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_runtime_dependency(%q<appengine-apis>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<appengine-apis>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<appengine-apis>, [">= 0"])
   end
 end

data/lib/appengine-pstore.rb

@@ -37,27 +37,45 @@ module AppEngine
     end
   end
 
+  # The PStore compatible interface for Google App Engine Datastore.
+  # 
+  #  db = AppEngine::PStore.new(dbname)
+  #  db.transaction do |db|
+  #    db[key] = value
+  #  end
+  # 
+  # A data is stored to the Datastore as AppEngine::Entity.
+  # The stracture of Datastore has following schema.
+  #
+  #  * dbname: a root key for the Datastore.
+  #  * key: A child of the root key.
+  #  * value: AppEngine::Entity that contains the value object.
+  #
+  # Note: 'key' and 'value' are marshalled before putting Datastore.
+  #
   class PStore
+    # Create a database identified by dbname.
     def initialize(dbname)
       @kind = self.class.name
       @parent_key = AppEngine::Datastore::Key.from_path(@kind, dbname)
       @transaction = nil
     end
 
+    # Raises PStore::Error unless in a transaction.
     def in_transaction
       if @transaction == nil || @transaction.active? == false
-      #unless transaction && transaction.active
-      #unless AppEngine::Datastore.current_transaction(nil)
         raise ::PStore::Error, "not in transaction"
       end
     end
 
+    # Raises PStore::Error unless in a writable transaction.
     def in_transaction_wr
       in_transaction
       raise ::PStore::Error, "in read-only transaction" if @rdonly
     end
     private :in_transaction, :in_transaction_wr
 
+    # Begins a new transaction for the AppEngine::Datastore.
     def transaction(readonly = false)
       raise ::PStore::Error, "nested transaction" if @transaction
       @rdonly = readonly
@@ -81,18 +99,21 @@ module AppEngine
       end
     end
 
+    # Commit the transaction.
     def commit
       in_transaction
       @transaction.commit
       throw :pstore_abort_transaction
     end
 
+    # Abort the transaction.
     def abort
       in_transaction
       @transaction.rollback
       throw :pstore_abort_transaction
     end
 
+    # Retrieves a stored value from the Datastore by the name.
     def [](name)
       in_transaction
       # return uncommited data if exist
@@ -108,6 +129,7 @@ module AppEngine
       end
     end
 
+    # Stores a value to the Datastore by the name.
     def []=(name, value)
       in_transaction_wr
       entity = AppEngine::Datastore::Entity.new(@kind, dump(name), @parent_key)
@@ -118,6 +140,7 @@ module AppEngine
       value
     end
 
+    # Delete a value from the Datastore by the name.
     def delete(name)
       in_transaction_wr
       key = AppEngine::Datastore::Key.from_path(@parent_key, @kind, dump(name))
@@ -137,6 +160,7 @@ module AppEngine
       Marshal::dump(content)
     end
 
+    # Returns all keys of this database.
     def roots
       in_transaction
       query = AppEngine::Datastore::Query.new(@kind, @parent_key)
@@ -146,11 +170,13 @@ module AppEngine
       (db_keys + @uncommited[:added].keys - @uncommited[:deleted].keys).uniq
     end
 
+    # Whether the database has key.
     def root?(key)
       in_transaction
       self.roots.include?(key)
     end
 
+    # Returns the database's name
     def path
       @parent_key.name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: machu-appengine-pstore
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - MATSUOKA Kohei
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-27 00:00:00 -07:00
+date: 2009-09-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,17 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: PStore compatible interface for Google Apps Engine.
+- !ruby/object:Gem::Dependency 
+  name: appengine-apis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The PStore interfaces for the Google App Engine Datastore.
 email: kohei@machu.jp
 executables: []
 
@@ -68,7 +78,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: PStore compatible interface for Google Apps Engine.
+summary: The PStore interfaces for the Google App Engine Datastore.
 test_files: 
 - spec/appengine-pstore_spec.rb
 - spec/spec_helper.rb