volatiledb 0.0.3 → 0.0.4

data/lib/volatiledb/version.rb

@@ -1,3 +1,7 @@
 module Volatile
-  VERSION = "0.0.3"
+
+  #
+  # Ye olde version number.
+  #
+  VERSION = "0.0.4"
 end

data/lib/volatiledb.rb

@@ -1,9 +1,19 @@
 require "volatiledb/version"
 require 'digest/sha1'
 
+#
+# Main module. See DB class.
+#
 module Volatile
   
+  #
+  # The main DB class. This is the public API for the library.
+  #
   class DB
+
+    #
+    # Constructor, nothing fancy.
+    #    
     def initialize
       @raw ||= Volatile::Raw.new
       @db  ||= {}
@@ -13,8 +23,6 @@ module Volatile
     # Define an action for a given key. The action should return a String.
     # A timeout in seconds may optionally be defined. Default is 3 seconds.
     #
-    # This method should be called before using any of the read operations.
-    #
     def put(key, timeout=3, &action)
       populate_db key, timeout, action
       raw_put key
@@ -22,13 +30,15 @@ module Volatile
     end
 
     #
-    # Read the data for the given key from storage. If the underlying storage
-    # has disappeared, it will be re-initialized by calling the action defined
-    # for that key again. After the storage has been re-initialized, its value
-    # will be read and returned.
+    # Read the data for the given key from storage. If the underlying 
+    # storage has disappeared, it will be re-initialized by calling
+    # the action defined for that key again. After the storage has
+    # been re-initialized, its value will be read and returned.
+    #
+    # Returns nil for a key which has not had any action defined for it yet.
     #
     def get(key)
-      data = @raw.get key
+      data = raw_get key
       if data.nil?
         sync key
       else
@@ -40,6 +50,8 @@ module Volatile
     # Works the same as get, but will fire the action defined for the given key
     # after the timeout defined for that key has elapsed.
     #
+    # Returns nil for a key which has not had any action defined for it yet.
+    #
     def fetch(key)
       checking key do |k|
         item = @db[k]
@@ -50,7 +62,10 @@ module Volatile
 
     #
     # Works the same as fetch, but ignores timeout and calls the defined action
-    # every time.
+    # every time. Should be used sparingly as it re-initializes storage on every
+    # call.
+    #
+    # Returns nil for a key which has not had any action defined for it yet.
     #
     def pull(key)
       sync key
@@ -100,11 +115,21 @@ module Volatile
     end
   end
   
+  #
+  # Implementation detail. Not intended for direct instantiation.
+  #
   class Raw
+
+    #
+    # Implementation detail.
+    #
     def initialize
       @db ||= {}
     end
 
+    #
+    # Implementation detail.
+    #
     def put(key, data)
       handle = handle_from key
       File.open("/tmp/#{handle}", "w") {|f| f << data}
@@ -112,6 +137,9 @@ module Volatile
       key
     end
 
+    #
+    # Implementation detail.
+    #
     def get(key)
       handle = @db[key]
       f = "/tmp/#{handle}"

metadata

@@ -2,7 +2,7 @@
 name: volatiledb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Sebastian Wittenkamp (bitops)
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-10 00:00:00 Z
+date: 2012-01-11 00:00:00 Z
 dependencies: []
 
 description: "  The VolatileDB gem allows you to specify a key and an action yielding a particular piece of data.\n  \n  This data will be stored in the /tmp folder of the file system you are currently running on. Data is accessible\n  by key. Data will be read and written to storage using File.read() and File.open() -- that's it. It's up to the\n  consuming application to serialize and deserialize data correctly. All VolatileDB does is push and pull data to\n  the FS. \n  \n  If the underlying file supporting the data is found to be missing, it will be re-initialized.\n  \n  This gets to the main idea behind VolatileDB: use it to persist data that is transient and can be re-seeded \n  periodically as conditions change. \n"
@@ -28,6 +28,40 @@ files:
 - README.md
 - Rakefile
 - TODO.md
+- doc/Gemfile.html
+- doc/Rakefile.html
+- doc/Volatile.html
+- doc/Volatile/DB.html
+- doc/Volatile/Raw.html
+- doc/created.rid
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/volatiledb/version_rb.html
+- doc/lib/volatiledb_rb.html
+- doc/rdoc.css
 - lib/volatiledb.rb
 - lib/volatiledb/version.rb
 - volatiledb.gemspec