persist 0.0.5 → 0.0.6

data/README.md

@@ -26,7 +26,7 @@ Example in Pry (or IRB if you must):
 require 'persist'
   #=> true
 
-Persist.db
+Persist.pull
  # => #<PStore:0x007f8c199c9698
    @abort=false,
    @filename=".db.pstore",
@@ -45,12 +45,53 @@ You can now quit IRB and your store will persist!
 ```ruby
 require 'persist'
   #=> true
-
+  
+Persist.pull
+  #=> #<PStore:0x007f8c199c9698 ... >
+  
 Persist[:pie]
   #=> ["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]
 ```
 
-TODO: Document Persist.db's other public methods such as #transaction, #delete, #path, #key? and #keys. The best documentation in the meanwhile is in the code itself: https://github.com/Havenwood/persist/blob/master/lib/persist/persist.rb
+## Helper Methods
+
+Each of Persist.db's tables is stored as a key:
+
+```ruby
+Persist.keys
+  #=> [:pie]
+
+Persist.key? :pie
+  #=> true
+
+Persist.key? :nope
+  #=> false
+```
+
+Tables can be clobbered:
+
+```ruby
+Persist.delete :pie
+  #=> nil
+```
+
+To check the location of your persistent store file:
+
+```ruby
+Persist.path
+  #=> ".db.pstore"
+```
+
+Transactions:
+
+```ruby
+Persist.transaction do
+  Persist.db[:new_key] = 'value'
+  Persist.db.delete :pie
+end # If all transactions are succesful, they are commited, otherwise aborted.
+```
+
+TODO: Better README. In the meanwhile, documentation is better in the code itself: https://github.com/Havenwood/persist/blob/master/lib/persist/persist.rb
 
 ## Is It Production Ready™?
 No. Persist.db is early Alpha, but please try it out and let me know if you find any bugs or real-world performance problems.

data/lib/persist/persist.rb

@@ -4,7 +4,7 @@
 module Persist
   class << self
     # Public: Returns the persistant store Object if initialized.
-    attr_reader :store
+    attr_reader :db
     
     # Public: Initialize the PStore Object--deserializing the marshalled Hash
     # stored in the '.db.pstore' file (creating the file if it does't exist)--
@@ -12,7 +12,7 @@ module Persist
     #
     # Examples
     #
-    #   Persist.db
+    #   Persist.pull
     #   # => #<PStore:0x007f8c199c9698
     #     @abort=false,
     #     @filename=".db.pstore",
@@ -23,11 +23,11 @@ module Persist
     #     @ultra_safe=true>
     #
     # Returns the entire persistent store Object.
-    def db
-      @store = PStore.new '.db.pstore', true
-      @store.ultra_safe = true
-      @store.transaction(true) {}
-      @store
+    def pull
+      @db = PStore.new '.db.pstore', true
+      @db.ultra_safe = true
+      @db.transaction(true) {}
+      @db
     end
     
     # Public: Fetch a list of persistent store root tables.
@@ -39,8 +39,8 @@ module Persist
     #
     # Returns an Array containing the persistent store root tables.
     def keys
-      @store.transaction true do
-        @store.roots
+      @db.transaction true do
+        @db.roots
       end
     end
     
@@ -59,8 +59,8 @@ module Persist
     #
     # Returns true or false.
     def key? table
-      @store.transaction true do
-        @store.root? table
+      @db.transaction true do
+        @db.root? table
       end
     end
     
@@ -79,8 +79,8 @@ module Persist
     #
     # Returns the value stored in the fetched table.
     def [] table
-      @store.transaction true do
-        @store[table]
+      @db.transaction true do
+        @db[table]
       end
     end
     
@@ -97,8 +97,8 @@ module Persist
     #
     # Returns the value of the table.
     def []= table, value
-      @store.transaction do
-        @store[table] = value
+      @db.transaction do
+        @db[table] = value
       end
     end
     
@@ -112,16 +112,16 @@ module Persist
     # Examples
     #
     #   Persist.transaction do
-    #     Persist.store[:weather] = 'sunny'
-    #     Persist.store[:hour] = 'midday'
+    #     Persist.db[:weather] = 'sunny'
+    #     Persist.db.delete[:author]
     #   end
     #   # => nil
     #
     # Returns nothing.
     def transaction &block
-      @store.transaction do
+      @db.transaction do
         yield
-        @store.commit
+        @db.commit
       end
     end
     
@@ -140,11 +140,11 @@ module Persist
     #
     # Returns nothing.
     def delete *tables
-      @store.transaction do
+      @db.transaction do
         tables.each do |table|
-          @store.delete table
+          @db.delete table
         end
-        @store.commit
+        @db.commit
       end
     end
     
@@ -157,7 +157,7 @@ module Persist
     #
     # Returns the path to the data file as a String.
     def path
-      @store.path
+      @db.path
     end
   end
 end

data/lib/persist/version.rb

@@ -1,3 +1,3 @@
 module Persist
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/test/test_persist.rb

@@ -2,13 +2,13 @@ require_relative 'helper'
 
 describe Persist do
   before do
-    @db = Persist.db
+    Persist.pull
     Persist[:author] = {first_name: 'Shannon', last_name: 'Skipper'}
   end
   
   describe "initializing the persistent store with Persist.db" do
     it "returns a PStore object" do
-      assert_equal PStore, @db.class
+      assert_equal PStore, Persist.db.class
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: persist
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-22 00:00:00.000000000 Z
+date: 2012-05-23 00:00:00.000000000 Z
 dependencies: []
 description: A DSL for storing Ruby Objects transactionally in a persistent NoSQL
   database