persist 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6686f9e03bc568726a4b310ebb2cb12c693880c5
-  data.tar.gz: 291a2145c4a8f9f55e2899c47685bda5192c75e5
+  metadata.gz: 3f1c70f2b195711a276e56d584a1f295b2f631a5
+  data.tar.gz: e2c7509fb56d7dcdd7f48e818f0d3736b2bf9523
 SHA512:
-  metadata.gz: de36b300b6aefb79592d977c0889ae5710084bc762212794a9d459c1dfb19ea8f4eb1c87c5e2f548aec937df22a963d139f8e917c58ca4bba3057c89e8ee3962
-  data.tar.gz: 8c00b35d60532253eba60127a0144de0686f7775a7cd5c116c3dfaa30670e259e451d91288025f4f3d07b0172c8afb7bfbd28331d319ebf77c15a0b675b3b6a7
+  metadata.gz: ea2768e1355af8ac7dc0dd98deaa7d3900695bc52e4b02e56b45b389c21039e782fa03833172ce146a03bd2b150860edd9cebb7344face0ad4c187a82cd2cdb2
+  data.tar.gz: a899d08b24c0c0192e1227cf247937d241b62f357c73427906c9d8b83a82332cf000c3483c61e507113a79031bff6fe8304da2eb6e55cf5c90ac39c17cf92871

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
+  - ruby-head
+  - 2.1
   - 2.0.0
   - 1.9.3
   - jruby-19mode
-  - rbx-19mode

data/README.md

@@ -3,66 +3,84 @@
 
 The Persist gem makes it really, really simple to persist Ruby objects to disk. Persist uses Ruby's PStore class to serialize Ruby objects with Marshal and transactionally save them for retrieval later.
 
-## Installation
-Install the gem from the command line:
-`gem install persist`
-
 ## Usage
 Example in irb or [Pry](http://pryrepl.org):
 ```ruby
 require 'persist'
-Persist[:pie] = ['Key Lime', 'Strawberry Rhubarb', 'Blackberry Cobbler']
+
+store = Persist.new
+store[:pie] = ['Key Lime', 'Strawberry Rhubarb', 'Blackberry Cobbler']
   # => ["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]
 ```
 
 You can now exit irb or [Pry](http://pryrepl.org) and your Ruby objects are still there:
 ```ruby
 require 'persist'
-Persist[:pie]
+
+store = Persist.new
+store[:pie]
   #=> ["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]
 ```
 
 ## Transactions
 Transactions succeed or fail together to ensure that data is not left in a transitory state:
 ```ruby
-Persist.transaction do |db|
+store.transaction do |db|
   db[:ice_cream] = ['chocolate', 'vanilla']
   db.delete :pie
 end
 ```
 
 ## Helper Methods
-Tables are treated as Hash keys:
+Look up table keys:
 ```ruby
-Persist.keys
+store.keys
   #=> [:pie, :ice_cream]
 
-Persist.key? :pie
+store.key? :pie
   #=> true
 
-Persist.key? :cake
+store.key? :cake
   #=> false
 ```
 
-Easily delete tables:
+Delete tables:
 ```ruby
-Persist.delete :pie
+store.delete :pie
   #=> nil
 ```
 
-Check the location of the persistant file on disk:
+## File Store Path
+Set the path to the persistant store file upon initialization:
+```ruby
+store = Persist.new "../.db.pstore"
+store.path
+  #=> "../.db.pstore"
+```
+
+The default path is ".db.pstore" if one is not otherwise specified:
 ```ruby
-Persist.path
+store = Persist.new
+store.path
   #=> ".db.pstore"
 ```
 
-[Additional documentation](https://github.com/Havenwood/persist/blob/master/lib/persist/persist.rb) in the code.
+## Installation
+Install the gem from the command line:
+```bash
+gem install persist
+```
+
+Or add the gem to your app's Gemfile and `bundle install`:
+```ruby
+gem 'persist'
+```
 
 ## Supported Platforms
 
 Persist takes advantage of PStore's [ultra_safe attribute](http://ruby-doc.org/stdlib-2.0/libdoc/pstore/rdoc/PStore.html#ultra_safe-attribute-method), which requires:
 
-1. Ruby 1.9+ compatibility (tested on Ruby 2.0.0, 1.9.3, JRuby and Rubinius).
+1. Ruby 1.9 or higher.
 2. A POSIX compliant platform (such as OS X, GNU/Linux or a BSD).
 
 ## Contributing

data/lib/persist.rb

@@ -1,2 +1,190 @@
-require 'persist/persist'
-require 'persist/version'
+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.
+class Persist
+  # Public: Returns the persistant store Object if initialized.
+  attr_reader :db
+
+  # Public: Returns the path to the persistent store file.
+  attr_reader :path
+
+  # Initializes the PStore Object and sets thread_safe and ultra_safe to true.
+  # Creates the file store at the specified path if it does not exist. 
+  #
+  # path - An optional String representing the relative path of the file.
+  #
+  # Examples
+  #
+  #   store = Persist.new
+  #   # => #<Persist:0x007f97b1b1b930
+  #     @db=
+  #       #<PStore:0x007f97b1b1b8e0
+  #        @abort=false,
+  #        @filename=".db.pstore",
+  #        @lock=#<Mutex:0x007f97b1b1b7c8>,
+  #        @rdonly=true,
+  #        @table=
+  #         {:trees=>["oak", "pine", "cedar"],
+  #          :one=>"first",
+  #          :two=>"second",
+  #          :author=>{:first_name=>"Shannon", :last_name=>"Skipper"},
+  #          :aim=>true,
+  #          :pie=>["Key Lime", "Strawberry Rhubarb", "Blackberry Cobbler"]},
+  #        @thread_safe=true,
+  #        @ultra_safe=true>,
+  #      @path=".db.pstore">
+  #
+  # Returns the entire persistent store Object.
+  def initialize path = '.db.pstore'
+    @path = path
+    @db = PStore.new path, true
+    @db.ultra_safe = true
+    @db.transaction(true) {}
+    @db
+  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
+  #
+  #   store.transaction do |db|
+  #     db[:weather] = 'sunny'
+  #     db.delete[:author]
+  #   end
+  #   # => nil
+  #
+  # Returns nothing.
+  def transaction
+    @db.transaction do
+      yield @db
+      @db.commit
+    end
+  end
+
+  # Public: Fetch a list of persistent store root tables.
+  #
+  # Examples
+  #
+  #   store.keys
+  #   # => [:author]
+  #
+  # Returns an Array containing the persistent store root tables.
+  def keys
+    @db.transaction true do
+      @db.roots
+    end
+  end
+
+  # Public: Determine whether a particular persistent store root table
+  # exists.
+  #
+  # table - A Symbol.
+  #
+  # Examples
+  #
+  #   store.key? :author
+  #   # => true
+  #
+  #   store.key? :this_does_not_exist
+  #   # => false
+  #
+  # Returns true or false.
+  def key? table
+    @db.transaction true do
+      @db.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
+  #
+  #   store[:author]
+  #   # => {:first_name => "Shannon", :last_name => "Skipper"}
+  #
+  #   store[:author][:first_name]
+  #   # => "Shannon"
+  #
+  # Returns the value stored in the fetched table.
+  def [] table
+    @db.transaction true do
+      @db[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.
+  #
+  # default - An optional value that is returned if the table is not found.
+  #
+  # Examples
+  #
+  #   store.fetch :author
+  #   # => {:first_name => "Shannon", :last_name => "Skipper"}
+  #
+  #   store.fetch :snowman
+  #   # => nil
+  #
+  #   store.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.
+  #
+  # value - Any Ruby Object that is marshallable.
+  #
+  # Examples
+  #
+  #   store[:sky] = 'blue'
+  #   # => "blue"
+  #
+  # Returns the value of the table.
+  def []= table, value
+    @db.transaction do
+      @db[table] = value
+    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
+  #
+  #   store.delete :author
+  #   # => nil
+  #
+  #   store.delete :author, :clients, :rentals
+  #   # => nil
+  #
+  # Returns nothing.
+  def delete *tables
+    @db.transaction do
+      tables.each do |table|
+        @db.delete table
+      end
+      @db.commit
+    end
+  end
+end

data/lib/persist/version.rb

@@ -1,3 +1,3 @@
-module Persist
-  VERSION = '0.1.3'
+class Persist
+  VERSION = '1.0.0'
 end

data/test/helper.rb

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

data/test/persist_test.rb

@@ -2,109 +2,105 @@ require_relative 'helper'
 
 describe Persist do
   before do
-    Persist.pull
-    Persist[:author] = {first_name: 'Shannon', last_name: 'Skipper'}
+    @store = Persist.new
   end
-  
-  describe "initializing the persistent store with Persist.db" do
-    it "returns a PStore object" do
-      assert_equal PStore, Persist.db.class
-    end
-  end
-  
+
   describe "getting a list of root keys with Persist.keys" do
     it "returns an Array" do
-      assert_kind_of Array, Persist.keys
+      assert_kind_of Array, @store.keys
     end
   end
-  
+
   describe "getting true or false if key exists with Persist.key?" do
     it "returns true if key exists" do
-      assert Persist.key?(:author)
+      @store[:author] = {first_name: 'Shannon', last_name: 'Skipper'}
+      assert @store.key?(:author)
     end
-    
+
     it "returns false if the key doesn't exist" do
-      refute Persist.key?(:this_does_not_exist)
+      refute @store.key?(:this_does_not_exist)
     end
   end
-  
+
   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]
+      @store[:author] = {first_name: 'Shannon', last_name: 'Skipper'}
+      assert_equal "Shannon", @store[:author][:first_name]
     end
-    
+
     it "returns nil if the key doesn't exist" do
-      assert_nil Persist[:this_does_not_exist]
+      assert_nil @store[:this_does_not_exist]
     end
   end
-  
+
   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]
+      @store[:author] = {first_name: 'Shannon', last_name: 'Skipper'}
+      assert_equal "Shannon", @store.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)
+      assert_nil @store.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")
+      default = @store.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']
+      @store[:trees] = ['oak', 'pine', 'cedar']
     end
-    
-    it "should add the key to the persistent store" do
-      assert Persist.key?(:trees)
+
+    it "should add the key to the persistent @store" do
+      assert @store.key?(:trees)
     end
-    
+
     it "should be set to the expected value" do
-      assert_equal ["oak", "pine", "cedar"], Persist[:trees]
+      assert_equal ["oak", "pine", "cedar"], @store[:trees]
     end
   end
-  
+
   describe "a Persist.transaction do" do
     it "sets multiple keys when commited" do
-      Persist.transaction do |db|
+      @store.transaction do |db|
         db[:one] = 'first'
         db[:two] = 'second'
       end
-      assert_equal 'first', Persist[:one]
-      assert_equal 'second', Persist[:two]
+      assert_equal 'first', @store[:one]
+      assert_equal 'second', @store[:two]
     end
-    
+
     it "sets no keys when aborted" do
-      Persist.transaction do |db|
+      @store.transaction do |db|
         db[:pre] = 'before'
         db.abort
         db[:post] = 'after'
       end
-      assert_nil Persist[:pre]
-      assert_nil Persist[:post]
+      assert_nil @store[:pre]
+      assert_nil @store[:post]
     end
   end
-  
+
   describe "deleting a root key with Persist.delete" do
     before do
-      Persist.delete :author
+      @store.delete :author
     end
     
     it "returns nil because the key no longer exists" do
-      assert_nil Persist[:author]
+      assert_nil @store[:author]
     end
   end
-  
+
   describe "check path with Persist.path" do
     it "returns a String" do
-      assert_kind_of String, Persist.path
+      assert_kind_of String, @store.path
     end
-    
-    it "includes the data store file name" do
-      assert_includes ".db.pstore", Persist.path
+
+    it "includes the data @store file name" do
+      assert_includes ".db.pstore", @store.path
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: persist
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Shannon Skipper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-17 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: The Persist gem makes it really, really simple to persist Ruby objects
@@ -46,14 +46,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/persist.rb
-- lib/persist/persist.rb
 - lib/persist/version.rb
 - persist.gemspec
 - test/helper.rb
@@ -68,17 +67,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Persist Ruby objects to a transactional file store using Ruby's Pstore.

data/lib/persist/persist.rb

@@ -1,211 +0,0 @@
-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. All methods are module methods and should be called on the Persist
-# module.
-module Persist
-  class << self
-    # Public: Returns the persistant store Object if initialized.
-    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)--
-    # and set thread_safe and ultra_safe to true.
-    #
-    # Examples
-    #
-    #   Persist.pull
-    #   # => #<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 pull
-      @db = PStore.new '.db.pstore', true
-      @db.ultra_safe = true
-      @db.transaction(true) {}
-      @db
-    end
-    
-    def initialize_db
-      @db || pull
-    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 |db|
-    #     db[:weather] = 'sunny'
-    #     db.delete[:author]
-    #   end
-    #   # => nil
-    #
-    # Returns nothing.
-    def transaction
-      initialize_db
-      
-      @db.transaction do
-        yield @db
-        @db.commit
-      end
-    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
-      initialize_db
-
-      @db.transaction true do
-        @db.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
-      initialize_db
-      
-      @db.transaction true do
-        @db.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
-      initialize_db
-      
-      @db.transaction true do
-        @db[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.
-    #
-    # 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
-      initialize_db
-      
-      @db.transaction true do
-        @db.fetch table, default
-      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
-      initialize_db
-      
-      @db.transaction do
-        @db[table] = value
-      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
-      initialize_db
-      
-      @db.transaction do
-        tables.each do |table|
-          @db.delete table
-        end
-        @db.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
-      initialize_db
-      
-      @db.path
-    end
-  end
-end