persist 0.0.6 → 0.0.7

data/README.md

@@ -1,6 +1,6 @@
 # Persist.db
 
-Persist.db is a simple gem that allows you to painlessly save Ruby Objects in a NoSQL persistent file store.
+Persist.db implements a DSL around Ruby Standard Library's PStore to facilitate simple file-persistant storage of Ruby objects in a transactional NoSQL database.
 
 ## Installation
 
@@ -15,8 +15,6 @@ And then execute:
 Or install it yourself:
 
     $ gem install persist
-    
-*Requires Ruby 1.9 or newer.
 
 ## Usage
 
@@ -38,9 +36,12 @@ Persist.pull
   
 Persist[:pie] = ['Key Lime', 'Strawberry Rhubarb', 'Blackberry Cobbler']
   # => ["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]
+
+Persist[:ice_cream] = ['chocolate', 'vanilla']
+  # => ["chocolate", "vanilla"]
 ```
 
-You can now quit IRB and your store will persist!
+You can now exit Pry/IRB and your store will persist!
 
 ```ruby
 require 'persist'
@@ -59,12 +60,12 @@ Each of Persist.db's tables is stored as a key:
 
 ```ruby
 Persist.keys
-  #=> [:pie]
+  #=> [:pie, :ice_cream]
 
 Persist.key? :pie
   #=> true
 
-Persist.key? :nope
+Persist.key? :cake
   #=> false
 ```
 
@@ -82,22 +83,27 @@ Persist.path
   #=> ".db.pstore"
 ```
 
-Transactions:
+Transactions succeed or fail together to ensure that data is not left in a transitory state:
 
 ```ruby
 Persist.transaction do
-  Persist.db[:new_key] = 'value'
+  Persist.db[:cake] = 'pie is better!'
   Persist.db.delete :pie
-end # If all transactions are succesful, they are commited, otherwise aborted.
+end
 ```
 
-TODO: Better README. In the meanwhile, documentation is better in the code itself: https://github.com/Havenwood/persist/blob/master/lib/persist/persist.rb
+[Additional documentation](https://github.com/Havenwood/persist/blob/master/lib/persist/persist.rb) in the code.
+
+## Supported Platforms
+
+Persist.db makes use of PStore's ultra_safe attribute, which requires:
 
-## 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.
+1. Ruby 1.9 (tested on `ruby-1.9.3` and `rbx --1.9` thus far)
+2. A POSIX platform (such as OS X, GNU/Linux or FreeBSD)
 
 ## Contributing
 
 1. Fork it
-2. Commit your changes (`git commit -am 'Did something'`)
-3. Create new Pull Request
+2. Commit changes (`git commit -am 'did something'`)
+3. Submit a Pull Request
+4. :cake:

data/lib/persist/persist.rb

@@ -1,3 +1,5 @@
+require 'pstore'
+
 # Public: Implements a DSL around Ruby Standard Library's PStore to facilitate
 # simple file-persistant storage of Ruby objects in a transactional NoSQL
 # database.
@@ -84,6 +86,31 @@ module Persist
       end
     end
     
+    # Public: Fetch a particular table from the persistent store.
+    #
+    # table   - A Symbol corresponding to a root table key in the persistent 
+    #           store.
+    #
+    # default - An optional value that is returned if the table is not found.
+    #
+    # Examples
+    #
+    #   Persist.fetch :author
+    #   # => {:first_name => "Shannon", :last_name => "Skipper"}
+    #
+    #   Persist.fetch :snowman
+    #   # => nil
+    #
+    #   Persist.fetch :snowman, 'default value instead of nil'
+    #   # => "default value instead of nil"
+    #
+    # Returns the value stored in the fetched table.
+    def fetch table, default = nil
+      @db.transaction true do
+        @db.fetch table, default
+      end
+    end
+    
     # Public: Use a single transaction to set a table value.
     #
     # table - A Symbol.

data/lib/persist/version.rb

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

data/lib/persist.rb

@@ -1,3 +1,2 @@
-require 'pstore'
 require 'persist/persist'
 require 'persist/version'

data/test/test_persist.rb

@@ -18,17 +18,17 @@ describe Persist do
     end
   end
   
-  describe "getting true or false if key exists with Persist.key?(:key)" do
+  describe "getting true or false if key exists with Persist.key?" do
     it "returns true if key exists" do
       assert Persist.key?(:author)
     end
     
-    it "returns false if the key does't exist" do
+    it "returns false if the key doesn't exist" do
       refute Persist.key?(:this_does_not_exist)
     end
   end
   
-  describe "getting a particular key's value with Persist[:key]" do
+  describe "getting a particular key's value with Persist.[]" do
     it "returns a value if the key exists" do
       assert_equal "Shannon", Persist[:author][:first_name]
     end
@@ -38,7 +38,22 @@ describe Persist do
     end
   end
   
-  describe "setting a perticular key's value with Persist[:key] = value" do
+  describe "getting a particular key or default value with Persist.fetch" do
+    it "returns a value if the key exists" do
+      assert_equal "Shannon", Persist.fetch(:author)[:first_name]
+    end
+    
+    it "returns nil if the key doesn't exist and no default is given" do
+      assert_nil Persist.fetch(:this_does_not_exist)
+    end
+    
+    it "returns the default value if the key doesn't exist" do
+      default = Persist.fetch(:this_does_not_exist, "default value")
+      assert_equal "default value", default
+    end
+  end
+  
+  describe "setting a particular key's value with Persist.[]=" do
     before do
       Persist[:trees] = ['oak', 'pine', 'cedar']
     end
@@ -52,13 +67,13 @@ describe Persist do
     end
   end
   
-  describe "setting multiple key's values with Persist.transaction do ..." do
+  describe "setting multiple key's values with Persist.transaction do" do
     it "blends" do
-      assert true #TODO: test.
+      assert false #TODO: test.
     end
   end
   
-  describe "deleting a root key with Persist.delete(:key)" do
+  describe "deleting a root key with Persist.delete" do
     before do
       Persist.delete :author
     end

metadata

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