ztore 1.0.0

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christian MICHON
+
+MIT License
+
+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.md

@@ -0,0 +1,58 @@
+# Ztore
+
+This gem allows easy creation of in-memory hashes and persists them into a pstore file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ztore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ztore
+
+## Usage
+
+Use case 1: initial data creation
+
+~~~ ruby
+
+require 'ztore'
+db = Ztore::DB.new(:db) # => will create file 'db.pstore'
+db.tree :People # this will derive a class 'People' from Ztore::Tree, usable as a Hash
+
+People[0] = 'CM'
+p People[0]
+
+People[1] = { :name => 'CM', :features => { :developer => true } }
+p People[1]
+
+db.save # this is needed at the end of your script to store
+
+~~~
+
+Use case 2: use a previously created Ztore::DB
+
+~~~ ruby
+
+require 'ztore'
+db = Ztore::DB.new(:db) # => will load file 'db.pstore' and recreate all Ztore::Tree
+
+p People[0] # 'CM'
+p People[1] # { :name => 'CM', :features => { :developer => true } }
+
+~~~
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+%w[rubygems rake rake/testtask].map &method(:require) 
+
+desc 'Run tests'
+Rake::TestTask.new 'test' do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/lib/ztore.rb

@@ -0,0 +1,48 @@
+%w[forwardable ztore/version pstore].map &method(:require)
+
+module Ztore
+  module ClassMethods
+    extend Forwardable
+    def_delegators :@tree, *%w[
+      [] []= clear count each entries first key? keys last map select size value? values
+    ].map(&:to_sym)
+    def regexp(pattern)
+      re = Regexp.new "#{pattern}", Regexp::EXTENDED | Regexp::IGNORECASE
+      keys.select{ |k,v| "#{k}" =~ re }
+    end
+  end
+  class DB
+    def initialize(dbname=nil)
+      @pstore = PStore.new("#{dbname}.pstore")
+      @pstore.transaction do
+        @trees = @pstore.roots
+        @trees.map &method(:tree)
+      end
+    end
+    def tree(treename)
+      unless Object.const_defined?(treename)
+        Object.const_set treename, Class.new(Tree)
+        if @trees.include?(treename)
+          Object.const_get(treename).instance_variable_set :@tree, @pstore[treename]
+        else
+          Object.const_get(treename).instance_variable_set :@tree, Hash.new
+          @trees << treename
+        end
+      end
+      Object.const_get treename
+    end
+    def trees
+      @trees
+    end
+    def save
+      @pstore.transaction do
+        @trees.each do |treename|
+          @pstore[treename] = Object.const_get(treename).instance_variable_get :@tree
+        end
+      end
+    end
+  end
+  class Tree
+    extend ClassMethods
+  end
+end

data/lib/ztore/version.rb

@@ -0,0 +1,3 @@
+module Ztore
+  VERSION = "1.0.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+$: << File.expand_path('../lib', __FILE__)
+%w[rubygems tempfile test/unit ztore].map &method(:require)

data/test/zstore_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+module MyTest
+  def runner(type)
+    db = @db
+    assert_instance_of Ztore::DB, db
+
+    db.tree :People
+    assert_equal Ztore::Tree, People.superclass
+    assert_equal [:People], db.trees
+    assert_equal [], People.entries
+
+    People[0] = 'CM'
+    People[1] = {
+      :name => 'CM',
+      :features => {
+        :developer => true
+      }
+    }
+
+    assert People.key?(0)
+    assert People.key?(1)
+    assert_equal [1], People.regexp('^1$')
+    assert_equal 2, People.size
+    assert_equal 2, People.count
+    assert_equal [0,1], People.keys
+
+    assert_instance_of String, People[0]
+    assert_equal 'CM', People[0]
+
+    assert_instance_of Hash, People[1]
+    assert_equal 'CM', People[1][:name]
+    assert_instance_of Hash, People[1][:features]
+    assert People[1][:features][:developer]
+
+    People.clear
+    assert_equal 0, People.count
+
+    Object.send(:remove_const, :People)
+  end
+end
+
+class ZtoreDBTest < Test::Unit::TestCase
+  include MyTest
+  def setup
+    @file = Tempfile.new('testdb')
+  end
+  def teardown
+  end 
+  def test_ztore_db
+    @db = Ztore::DB.new(@file.path)
+    runner(:FileDB)
+    File.delete "#{@file.path}.pstore"
+  end
+end

data/ztore.gemspec

@@ -0,0 +1,17 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ztore/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ztore'
+  spec.version       = Ztore::VERSION
+  spec.authors       = ['Christian MICHON']
+  spec.email         = ['christian.michon@gmail.com']
+  spec.description   = %q{This gem allows easy creation of in-memory hashes and persists them into a pstore file.}
+  spec.summary       = %q{Easy persistence of hashes into pstore}
+  spec.homepage      = 'http://github.com/cmichon/ztore'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir['{**/*}']
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ztore
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Christian MICHON
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-12-04 00:00:00 Z
+dependencies: []
+
+description: This gem allows easy creation of in-memory hashes and persists them into a pstore file.
+email: 
+- christian.michon@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ztore/version.rb
+- lib/ztore.rb
+- LICENSE.txt
+- Rakefile
+- README.md
+- test/test_helper.rb
+- test/zstore_test.rb
+- ztore.gemspec
+homepage: http://github.com/cmichon/ztore
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Easy persistence of hashes into pstore
+test_files: []
+