rufus-cloche 0.1.0

data/CHANGELOG.txt

@@ -0,0 +1,6 @@
+
+= rufus-cloche CHANGELOG.txt
+
+
+== rufus-cloche - 0.1.0    released 2009/11/16
+

data/CREDITS.txt

@@ -0,0 +1,4 @@
+
+many thanks to Brian Lopez for yajl-ruby
+  http://github.com/brianmario
+

data/README.rdoc

@@ -0,0 +1,91 @@
+
+= rufus-cloche
+
+A very stupid local JSON store.
+
+It's built on top of yajl-ruby and File.lock. Defaults to 'json' (or 'json_pure') if yajl-ruby is not present (it's probably just a "gem install yajl-ruby" away.
+
+Strives to be process-safe and thread-safe.
+
+The philosophy here is : every document has a revision number. You have to provide the latest revision number in order to update sucessfully a document (else the 'put' will fail and you'll return the latest version of the document (as a new starting point)).
+
+A cloche assumes your documents have a 'type' and it stores documents in separate dirs, one per type.
+
+
+== usage
+
+Basic operations :
+
+  require 'rubygems'
+  require 'rufus-cloche' # gem install rufus-cloche
+
+  c = Rufus::Cloche.new(:dir => 'my_cloche')
+
+  doc = { '_id' => 'invitation05', 'type' => 'letter', 'to' => 'The Duke' }
+    # documents are Hash instances, with an '_id' and a 'type' key.
+
+  d = c.put(doc)
+
+  p d
+    # => nil
+    # #put returned nil, the 'insertion' was successful
+
+  p doc['_rev']
+    # => 0
+    # Cloche added the '_rev' key and set its value to 0.
+
+  # ... meanwhile, someone in another process upated the document
+  # we're trying to put an updated version ...
+
+  doc['body'] = "Dear Monty, it's been a while since El Alamein..."
+
+  d = c.put(doc)
+
+  p d
+    # => { "_id" => "invitation05", "type"=>"letter", "to" => "The Count", "_rev" => 1 }
+    #
+    # the update failed, the method returned the current version of the document
+
+It's OK to get a document, but it's sometimes better to get many of them :
+
+  docs = get_many('letter')
+    # returns an array containing *all* the documents with the type 'letter'
+
+  docs = get_many('letter', /^invitation/)
+    # returns all the documents whose _id begins with "invitation"
+
+  docs = get_many('letter', /\/2009\//)
+    # returns all the 2009 letters (assuming their _id contains the string "/2009/"
+
+
+== mailing list
+
+On the rufus-ruby list :
+
+http://groups.google.com/group/rufus-ruby
+
+
+== issue tracker
+
+http://github.com/jmettraux/rufus-cloche/issues
+
+
+== irc
+
+  irc.freenode.net #ruote
+
+
+== the rest of Rufus
+
+http://rufus.rubyforge.org
+
+
+== authors
+
+* John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
+
+
+== license
+
+MIT
+

data/test/test.rb

@@ -0,0 +1,152 @@
+
+#
+# testing cloche
+#
+# Fri Nov 13 09:09:58 JST 2009
+#
+
+ROOT = File.join(File.dirname(__FILE__), '..')
+
+require 'test/unit'
+require File.join(ROOT, %w[ lib rufus cloche.rb ])
+
+class ClocheTest < Test::Unit::TestCase
+
+  def setup
+    @c_dir = File.join(ROOT, 'tcloche')
+    FileUtils.rm_rf(@c_dir) rescue nil
+    @c = Rufus::Cloche.new(:dir => @c_dir)
+  end
+  #def teardown
+  #end
+
+  def test_put
+
+    r = @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    assert_nil r
+
+    h = fetch('person', 'john')
+    assert_equal 0, h['_rev']
+  end
+
+  def test_depth
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    assert_equal(
+      "test/../tcloche/person/hn/john.json",
+      Dir[File.join(@c_dir, %w[ ** *.json ])].first)
+  end
+
+  def test_small_id
+
+    r = @c.put({ '_id' => '0', 'type' => 'person', 'eyes' => 'green' })
+
+    assert_nil r
+  end
+
+  def test_put_insufficient_doc
+
+    assert_raise ArgumentError do
+      @c.put({ '_id' => 'john', 'eyes' => 'shut' })
+    end
+  end
+
+  def test_put_fail
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+    r = @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'brown' })
+
+    assert_equal 0, r['_rev']
+
+    h = fetch('person', 'john')
+    assert_equal 'green', h['eyes']
+  end
+
+  def test_re_put
+
+    @c.put(
+      { '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    r = @c.put(
+      { '_id' => 'john', 'type' => 'person', 'eyes' => 'blue', '_rev' => 0 })
+
+    assert_nil r
+
+    h = fetch('person', 'john')
+    assert_equal 1, h['_rev']
+  end
+
+  def test_delete_missing
+
+    r = @c.delete({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    assert_not_nil r
+  end
+
+  def test_delete
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    r = @c.delete({ '_id' => 'john', 'type' => 'person', '_rev' => 0 })
+
+    assert_nil r
+    assert_equal false, File.exist?(File.join(ROOT, 'person', 'john'))
+  end
+
+  def test_delete_fail
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    r = @c.delete({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+
+    assert_not_nil r
+  end
+
+  def test_get_many
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+    @c.put({ '_id' => 'jami', 'type' => 'person', 'eyes' => 'blue' })
+    @c.put({ '_id' => 'minehiko', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'hiro', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'chicko-chan', 'type' => 'animal', 'eyes' => 'black' })
+
+    assert_equal(
+      %w[ blue brown brown green ],
+      @c.get_many('person').collect { |e| e['eyes'] }.sort)
+  end
+
+  def test_get_many_with_key_match
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+    @c.put({ '_id' => 'jami', 'type' => 'person', 'eyes' => 'blue' })
+    @c.put({ '_id' => 'minehiko', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'hiro', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'chicko-chan', 'type' => 'animal', 'eyes' => 'black' })
+
+    assert_equal 2, @c.get_many('person', /^j/).size
+  end
+
+  def test_get_many_key_order
+
+    @c.put({ '_id' => 'john', 'type' => 'person', 'eyes' => 'green' })
+    @c.put({ '_id' => 'jami', 'type' => 'person', 'eyes' => 'blue' })
+    @c.put({ '_id' => 'minehiko', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'hiro', 'type' => 'person', 'eyes' => 'brown' })
+    @c.put({ '_id' => 'chicko-chan', 'type' => 'animal', 'eyes' => 'black' })
+
+    assert_equal(
+      %w[ hiro jami john minehiko ],
+      @c.get_many('person').collect { |e| e['_id'] })
+  end
+
+  protected
+
+  def fetch (type, key)
+
+    s = File.read(File.join(ROOT, 'tcloche', type, key[-2, 2], "#{key}.json"))
+    Rufus::Cloche.json_decode(s)
+  end
+end
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rufus-cloche
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: "\n\
+  A very stupid JSON hash store.\n\n\
+  It's built on top of yajl-ruby and File.lock. Defaults to 'json' (or 'json_pure') if yajl-ruby is not present (it's probably just a \"gem install yajl-ruby\" away.\n\n\
+  Strives to be process-safe and thread-safe.\n  "
+email: jmettraux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- CHANGELOG.txt
+- CREDITS.txt
+files: 
+- README.rdoc
+- CHANGELOG.txt
+- CREDITS.txt
+has_rdoc: true
+homepage: http://github.com/jmettraux/rufus-cloche/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: rufus
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: a very stupid JSON hash store
+test_files: 
+- test/test.rb