persistent 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ismael Celis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,78 @@
+## Basic persistence functionality for your Ruby objects
+
+This is a drop-in thin persistence layer for your Ruby objects. I wrote it for some toy Sinatra apps I'm writing because I can't be bothered with using DataMapper, CouchDB and the rest for something so small.
+
+The store can be anything that looks like a Hash.
+
+From the code comments:
+
+    class Person
+      include Persistent
+      attr_accessor :name, :last_name
+    end
+    
+    Person.store = Persistent::Store.new('/path/to/store_file.store') # or anything that looks like a Hash.
+    
+    o = Person.new
+    
+    o.name = 'Ismael'
+    o.last_name = 'Celis'
+    
+    # == Save and namespace unique ID by class name
+    
+    o.persist! 'some_unique_id'
+    
+    o2 = Person.find( 'some_unique_id' )
+    
+    o2.name # => 'Ismael'
+    
+    o2 == o # => true
+    
+    o.destroy!
+
+    Person.find( 'some_unique_id' ) # => nil
+
+
+## Usage
+
+You can persist individual objects by key
+
+    o = SomeObject.new
+    o.persist! 'some_key'
+
+Keys are internally prefixed with the object's class name so you can store objects of different types using the same keys.
+
+... But after conversation with Martyn (http://github.com/mloughran) I'm planning to store one big object with the whole domain object space in it, so I can store the whole thing at once and forget about persistance and have fun with pure Ruby objects (look ma, no database!).
+
+I know. That only works because my particular domain is tiny.
+
+
+## Object store
+
+Persistent::Store wraps Standard library's PStore to save objects to the filesystem in a transaction.
+
+Persistent::Store itself quacks like a Hash (:[], :[]=, :fetch, :delete and :each) so you can use a Hash, Memcached, another wrapper like Moneta (http://github.com/wycats/moneta/tree/master) or you own object store.
+
+## Installation
+
+This is so tiny that you can just copy the lib/persistent.rb and lib/persistent/store.rb files in you project (or clone them of course).
+
+You can also use it as a gem:
+
+    sudo gem install ismasan-persistent
+
+And then in your code:
+
+    require 'rubygems'
+    require 'persistent'
+
+    class SomeClass
+      include Persistent
+      ...
+    end
+
+## Other alternatives
+
+This library is meant for simple use cases. If you want serious object persistence please check solutions such as CouchDB (http://couchdb.apache.org/), DataMapper (http://github.com/datamapper/dm-core/tree/master) or the similarly named Persistable gem (http://github.com/andykent/persistable/tree/master).
+
+Also, Stone (http://github.com/ndemonner/stone/tree/master) looks pretty neat!

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "persistent"
+    gem.summary = %Q{TODO: one-line summary of your gem}
+    gem.description = %Q{TODO: longer description of your gem}
+    gem.email = "ismaelct@gmail.com"
+    gem.homepage = "http://github.com/ismasan/persistent"
+    gem.authors = ["Ismael Celis"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "persistent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/persistent.rb

@@ -0,0 +1,88 @@
+module Persistent
+  
+  autoload :Store, 'lib/persistent/store'
+  
+  # This module gives you objects:
+  #
+  #    class Person
+  #      include Persistent
+  #
+  #       attr_accessor :name, :last_name
+  #    end
+  #
+  #    Person.store = Persistent::Store.new('/path/to/store_file.store') # or anything that looks like a Hash.
+  #
+  #    o = Person.new
+  #
+  #    o.name = 'Ismael'
+  #    o.last_name = 'Celis'
+  #
+  #    # == Save and namespace unique ID by class name
+  #
+  #    o.persist! 'some_unique_id'
+  #
+  #    o2 = Person.find( 'some_unique_id' )
+  #
+  #    o2.name # => 'Ismael'
+  #
+  #    o2 == o # => true
+  #
+  #    o.destroy!
+  #
+  def self.included(base)
+    base.extend ClassMethods
+    class << base
+      attr_accessor :store
+    end
+    
+    # The only reason an instance wants to know about their persistence id is so we can call destroy! on it.
+    # Why not use auto-generated ID's? Because I might want to use them as URL permalinks, for example
+    #
+    base.class_eval do
+      attr_accessor :_persisted_id
+    end
+  end
+  
+  def persist!(id)
+    self._persisted_id = id
+    store[persistent_key(id)] = self
+  end
+  
+  def destroy!
+    return false unless self._persisted_id
+    store.delete(persistent_key(_persisted_id))
+  end
+  
+  protected
+  
+  def store
+    self.class.store
+  end
+  
+  def persistent_key(id)
+    self.class.persistent_key(id)
+  end
+  
+  # Class methods ::::::::::::::::::::::::::::::::::::::::::::
+  #
+  module ClassMethods
+    
+    def find(id)
+      o = store[persistent_key(id)]
+      o._persisted_id = id
+      o
+    end
+    
+    def exists?(id)
+      !store[persistent_key(id)].nil?
+    end
+    
+    # 'Person/abc'
+    #
+    def persistent_key(id)
+      File.join(self.name.to_s, id.to_s)
+    end
+    
+  end
+  
+end

data/lib/persistent/store.rb

@@ -0,0 +1,31 @@
+require 'pstore'
+module Persistent
+  class Store
+    include Enumerable
+    
+    def initialize(key)
+      @store = PStore.new(key)
+    end
+    
+    def [](key)
+      @store.transaction{@store[key]}
+    end
+    
+    def []=(key, value)
+      @store.transaction{@store[key] = value}
+    end
+    
+    def fetch(key, default)
+      @store.transaction{@store.fetch(key, default)}
+    end
+    
+    def delete(key)
+      @store.transaction{@store.delete(key)}
+    end
+    
+    def each(&block)
+      roots = @store.transaction{@store.roots}
+      roots.each(&block)
+    end
+  end
+end

data/persistent.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{persistent}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ismael Celis"]
+  s.date = %q{2009-10-05}
+  s.description = %q{Tiny plug & play persistence layer for your Ruby objects}
+  s.email = %q{ismaelct@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "lib/persistent.rb",
+     "lib/persistent/store.rb",
+     "persistent.gemspec",
+     "spec/persistent_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/store_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/ismasan/persistent}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Tiny plug & play persistence layer for your Ruby objects}
+  s.test_files = [
+    "spec/persistent_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/store_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/spec/persistent_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class PersistentPerson
+  include Persistent
+  
+  include Comparable
+  
+  attr_accessor :name, :last_name, :email
+  
+  def initialize(name, last_name, email)
+    @name, @last_name, @meail = name, last_name, email
+  end
+  
+  
+  def <=>(other)
+    self.name <=> other.name
+  end
+end
+
+PersistentPerson.store = Hash.new # Persistent::Store.new('test.store')
+
+describe Persistent do
+  
+  before do
+    @person = PersistentPerson.new('ismael', 'celis', nil)
+  end
+  
+  describe 'saving' do
+    it "should persists" do
+      @person.name = 'foo'
+      @person.last_name = 'bar'
+      @person.persist! 'abc'
+      
+      p2 = PersistentPerson.find('abc')
+      p2.should == @person
+      p2.name.should == 'foo'
+      p2.last_name.should == 'bar'
+      p2.email.should be_nil
+    end
+
+    it "should check it exists" do
+      @person.persist! 'abc'
+      PersistentPerson.exists?('abc').should be_true
+      PersistentPerson.exists?('zzz').should_not be_true
+    end
+    
+    it "should destroy" do
+      @person.persist! 'abc'
+      PersistentPerson.exists?('abc').should be_true
+      @person.destroy!
+      PersistentPerson.exists?('abc').should be_false
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'persistent'
+require 'spec'
+require 'spec/autorun'
+
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/store_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Persistent::Store do
+  
+  before do
+    @file_path = File.dirname(__FILE__)+'/test.store'
+    @store = Persistent::Store.new(@file_path)
+  end
+  
+  describe "hash interface" do
+    %w([] []= fetch delete each).each do |m|
+      it "should respond to :#{m}" do
+        @store.respond_to?(m.to_sym).should be_true
+      end
+    end
+  end
+  
+  describe 'setting' do
+    
+    after do
+      FileUtils.rm(@file_path) if File.exists?(@file_path)
+    end
+    
+    it "should persist data" do
+      @store[:foo] = 'bar'
+      second_store = Persistent::Store.new(@file_path)
+      second_store[:foo].should == 'bar'
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: persistent
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ismael Celis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Tiny plug & play persistence layer for your Ruby objects
+email: ismaelct@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- lib/persistent.rb
+- lib/persistent/store.rb
+- persistent.gemspec
+- spec/persistent_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+has_rdoc: true
+homepage: http://github.com/ismasan/persistent
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Tiny plug & play persistence layer for your Ruby objects
+test_files: 
+- spec/persistent_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb