persist 0.0.4 → 0.0.5

data/README.md

@@ -15,6 +15,8 @@ And then execute:
 Or install it yourself:
 
     $ gem install persist
+    
+*Requires Ruby 1.9 or newer.
 
 ## Usage
 
@@ -48,7 +50,10 @@ Persist[:pie]
   #=> ["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]
 ```
 
-TODO: Document Persist.db's other public methods such as #transaction, #delete, #key? and #keys. The best documentation in the meanwhile is in the code itself: https://github.com/Havenwood/persist/blob/master/lib/persist.rb
+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
+
+## 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.
 
 ## Contributing
 

data/lib/persist/persist.rb

@@ -0,0 +1,163 @@
+# Public: Implements a DSL around Ruby Standard Library's PStore to facilitate
+# simple file-persistant storage of Ruby objects in a transactional NoSQL
+# database.
+module Persist
+  class << self
+    # Public: Returns the persistant store Object if initialized.
+    attr_reader :store
+    
+    # Public: Initialize the PStore Object--deserializing the marshalled Hash
+    # stored in the '.db.pstore' file (creating the file if it does't exist)--
+    # and set thread_safe and ultra_safe to true.
+    #
+    # Examples
+    #
+    #   Persist.db
+    #   # => #<PStore:0x007f8c199c9698
+    #     @abort=false,
+    #     @filename=".db.pstore",
+    #     @lock=#<Mutex:0x007f8c199c9580>,
+    #     @rdonly=true,
+    #     @table={},
+    #     @thread_safe=true,
+    #     @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
+    end
+    
+    # Public: Fetch a list of persistent store root tables.
+    #
+    # Examples
+    #
+    #   Persist.keys
+    #   # => [:author]
+    #
+    # Returns an Array containing the persistent store root tables.
+    def keys
+      @store.transaction true do
+        @store.roots
+      end
+    end
+    
+    # Public: Determine whether a particular persistent store root table
+    # exists.
+    #
+    # table - A Symbol.
+    #
+    # Examples
+    #
+    #   Persist.key? :author
+    #   # => true
+    #
+    #   Persist.key? :this_does_not_exist
+    #   # => false
+    #
+    # Returns true or false.
+    def key? table
+      @store.transaction true do
+        @store.root? table
+      end
+    end
+    
+    # Public: Fetch a particular table from the persistent store.
+    #
+    # table - A Symbol corresponding to a root table key in the persistent 
+    #         store.
+    #
+    # Examples
+    #
+    #   Persist[:author]
+    #   # => {:first_name => "Shannon", :last_name => "Skipper"}
+    #
+    #   Persist[:author][:first_name]
+    #   # => "Shannon"
+    #
+    # Returns the value stored in the fetched table.
+    def [] table
+      @store.transaction true do
+        @store[table]
+      end
+    end
+    
+    # Public: Use a single transaction to set a table value.
+    #
+    # table - A Symbol.
+    #
+    # value - Any Ruby Object that is marshallable.
+    #
+    # Examples
+    #
+    #   Persist[:sky] = 'blue'
+    #   # => "blue"
+    #
+    # Returns the value of the table.
+    def []= table, value
+      @store.transaction do
+        @store[table] = value
+      end
+    end
+    
+    # Public: Process multiple transactions to set table values and commit if
+    # all transactions are successful.
+    #
+    # block - A required block that processes multiple transactions that 
+    #         succeed or fail together to ensure that data is not left in a 
+    #         transitory state.
+    #
+    # Examples
+    #
+    #   Persist.transaction do
+    #     Persist.store[:weather] = 'sunny'
+    #     Persist.store[:hour] = 'midday'
+    #   end
+    #   # => nil
+    #
+    # Returns nothing.
+    def transaction &block
+      @store.transaction do
+        yield
+        @store.commit
+      end
+    end
+    
+    # Public: Delete one or more entire root tables from the persistent store.
+    #
+    # tables - One or more Symbols corresponding to root table keys in the
+    #          persistent store.
+    #
+    # Examples
+    #
+    #   Persist.delete :author
+    #   # => nil
+    #
+    #   Persist.delete :author, :clients, :rentals
+    #   # => nil
+    #
+    # Returns nothing.
+    def delete *tables
+      @store.transaction do
+        tables.each do |table|
+          @store.delete table
+        end
+        @store.commit
+      end
+    end
+    
+    # Public: Determine location of the persistent store file.
+    #
+    # Examples
+    #
+    #   Persist.path
+    #   # => ".db.pstore"
+    #
+    # Returns the path to the data file as a String.
+    def path
+      @store.path
+    end
+  end
+end

data/lib/persist/version.rb

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

data/lib/persist.rb

@@ -1,158 +1,3 @@
 require 'pstore'
-require 'persist/version'
-
-# Public: Implements a DSL around Ruby Standard Library's PStore to facilitate
-# simple file-persistant storage of Ruby objects in a transactional NoSQL
-# database.
-module Persist
-  class << self
-    # Returns the persistant store Object if one has been initialized.
-    attr_reader :store
-    
-    # Public: Initialize the PStore Object, deserializing the marshalled Hash
-    # stored in the '.db.pstore' file (creating the file if it does't exist).
-    #
-    # Examples
-    #
-    #   Persist.db
-    #   # => #<PStore:0x007f8c199c9698
-    #     @abort=false,
-    #     @filename=".db.pstore",
-    #     @lock=#<Mutex:0x007f8c199c9580>,
-    #     @rdonly=true,
-    #     @table={},
-    #     @thread_safe=true,
-    #     @ultra_safe=true>
-    #
-    # Returns the entire persistent store Object.
-    def db
-      # Initialize a persistent store in the file '.db.pstore' and set
-      # thread_safe to true.
-      @store = PStore.new('.db.pstore', true)
-      
-      # Set ultru_safe to true for extra safety checks regarding full disk, etc.
-      @store.ultra_safe = true
-      
-      # Open a read-only transaction to fetch latest store.
-      @store.transaction(true) {}
-      
-      # Return the entire fetched store Object.
-      @store
-    end
-    
-    # Public: Fetch a list of persistent store root tables.
-    #
-    # Examples
-    #
-    #   Persist.keys
-    #   # => [:author]
-    #
-    # Returns an Array containing the persistent store root tables.
-    def keys
-      # Open a read-only transaction.
-      @store.transaction(true) do
-        #Return a list of all tables in the persistent store.
-        @store.roots
-      end
-    end
-    
-    # Public: Determine whether a particular persistent store root table exists.
-    #
-    # Examples
-    #
-    #   Persist.key? :author
-    #   # => true
-    #
-    #   Persist.key? :this_does_not_exist
-    #   # => false
-    #
-    # Returns true or false.
-    def key? table
-      # Open a read-only transaction.
-      @store.transaction(true) do
-        #Return a list of all tables in the persistent store.
-        @store.root? table
-      end
-    end
-    
-    # Public: Fetch a particular table from the persistent store.
-    #
-    # table - A Symbol.
-    #
-    # Examples
-    #
-    #   Persist[:author]
-    #   # => {:first_name => "Shannon", :last_name => "Skipper"}
-    #
-    #   Persist[:author][:first_name]
-    #   # => "Shannon"
-    #
-    # Returns the value stored in the fetched table.
-    def [] table
-      # Open a read-only transaction.
-      @store.transaction(true) do
-        # Return a particular table from the persistent store.
-        @store[table]
-      end
-    end
-    
-    # Public: Use a single transaction to set a table value.
-    #
-    # table - A Symbol.
-    #
-    # value - Any Ruby Object that is marshallable.
-    #
-    # Examples
-    #
-    #   Persist[:sky] = 'blue'
-    #   # => "blue"
-    #
-    # Returns the value of the table.
-    def []= table, value
-      # Open a writable transaction.
-      @store.transaction do
-        # Process the single transaction.
-        @store[table] = value
-      end # Commit transaction.
-    end
-    
-    # Public: Process multiple transactions to set table values and commit if
-    # all are transactions are successful.
-    #
-    # block - A required block that processes multiple transactions that 
-    #         succeed or fail together to ensure that data is not left in a 
-    #         transitory state.
-    #
-    # Examples
-    #
-    #   Persist.transaction do
-    #     Persist.store[:weather] = 'sunny'
-    #     Persist.store[:hour] = 'midday'
-    #   end
-    #   # => nil
-    #
-    # Returns nothing.
-    def transaction &block
-      @store.transaction do
-        yield
-        @store.commit
-      end
-    end
-    
-    # Public: Delete an entire root table from the persistent store.
-    #
-    # Examples
-    #
-    #   Persist.delete :author
-    #   # => nil
-    #
-    # Returns nothing.
-    def delete table
-      # Open a writable transaction.
-      @store.transaction do
-        # Delete a particular table from the persistent store.
-        @store.delete table
-      end
-    end
-  end
-end
+require 'persist/persist'
+require 'persist/version'

data/persist.gemspec

@@ -12,6 +12,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^test/})
   gem.name          = 'persist'
-  gem.require_paths = ['lib', 'test']
+  gem.require_paths = ['lib']
   gem.version       = Persist::VERSION
 end

data/test/helper.rb

@@ -1,3 +1,3 @@
 require 'minitest/autorun'
 require 'minitest/pride'
-require_relative '../lib/persist.rb'
+require 'persist'

data/test/test_persist.rb

@@ -58,7 +58,7 @@ describe Persist do
     end
   end
   
-  describe "deleting a root key" do
+  describe "deleting a root key with Persist.delete(:key)" do
     before do
       Persist.delete :author
     end
@@ -67,4 +67,14 @@ describe Persist do
       assert_nil Persist[:author]
     end
   end
+  
+  describe "check path with Persist.path" do
+    it "returns a String" do
+      assert_kind_of String, Persist.path
+    end
+    
+    it "includes the data store file name" do
+      assert_includes ".db.pstore", Persist.path
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: persist
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -24,6 +24,7 @@ files:
 - LICENSE
 - README.md
 - lib/persist.rb
+- lib/persist/persist.rb
 - lib/persist/version.rb
 - persist.gemspec
 - test/helper.rb
@@ -34,7 +35,6 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- test
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements: