rufus-cloche 0.1.0 → 0.1.1

data/CHANGELOG.txt

@@ -2,5 +2,5 @@
 = rufus-cloche CHANGELOG.txt
 
 
-== rufus-cloche - 0.1.0    released 2009/11/16
+== rufus-cloche - 0.1.1    released 2009/11/16
 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+
+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/TODO.txt

@@ -0,0 +1,12 @@
+
+[x] !! test for type change. Not covered. Have to delete + put.
+[x] use 1! lock for put. It's OK for now
+[o] fall back on regular json
+[o] thread-safe
+[o] readme : get_many example
+[o] subdir for types (2 last ascii chars argh)
+
+[ ] LRU ?
+
+[ ] need for a purge mecha
+

data/lib/rufus-cloche.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/cloche'
+

data/lib/rufus/cloche.rb

@@ -0,0 +1,246 @@
+#--
+# Copyright (c) 2009-2009, John Mettraux, jmettraux@gmail.com
+#
+# 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.
+#
+# Made in Japan.
+#++
+
+require 'thread'
+require 'fileutils'
+
+begin
+  require 'yajl'
+rescue LoadError
+  require 'json'
+end
+
+
+module Rufus
+
+  #
+  # A cloche is a local JSON hashes store.
+  #
+  # Warning : cloches are process-safe but not thread-safe.
+  #
+  class Cloche
+
+    if defined?(Yajl)
+      def self.json_decode (s)
+        Yajl::Parser.parse(s)
+      end
+      def self.json_encode (o)
+        Yajl::Encoder.encode(o)
+      end
+    else
+      def self.json_decode (s)
+        ::JSON.parse(s)
+      end
+      def self.json_encode (o)
+        o.to_json
+      end
+    end
+
+    VERSION = '0.1.1'
+
+    attr_reader :dir
+
+    # Currently, the only known option is :dir
+    #
+    def initialize (opts={})
+
+      @dir = File.expand_path(opts[:dir] || 'cloche')
+      @mutex = Mutex.new
+    end
+
+    # Puts a document (Hash) under the cloche.
+    #
+    # If the document is brand new, it will be given a revision number '_rev'
+    # of 0.
+    #
+    # If the document already exists in the cloche and the version to put
+    # has an older (different) revision number than the one currently stored,
+    # put will fail and return the current version of the doc.
+    #
+    # If the put is successful, nil is returned.
+    #
+    def put (doc)
+
+      type, key = doc['type'], doc['_id']
+
+      raise(
+        ArgumentError.new("missing values for keys 'type' and/or '_id'")
+      ) if type.nil? || key.nil?
+
+      d, f = path_for(type, key)
+      fn = File.join(d, f)
+
+      rev = (doc['_rev'] ||= -1)
+
+      raise(
+        ArgumentError.new("values for '_rev' must be positive integers")
+      ) if rev.class != Fixnum && rev.class != Bignum
+
+      FileUtils.mkdir_p(d) unless File.exist?(d)
+      FileUtils.touch(fn) unless File.exist?(fn)
+
+      lock(fn) do |f|
+
+        cur = do_get(f)
+
+        return cur if cur && cur['_rev'] != doc['_rev']
+
+        doc['_rev'] = doc['_rev'] + 1
+
+        File.open(f, 'wb') { |io| io.write(Cloche.json_encode(doc)) }
+      end
+
+      nil
+    end
+
+    # Gets a document (or nil if not found (or corrupted)).
+    #
+    def get (type, key)
+
+      r = lock(type, key) { |f| do_get(f) }
+      r == true ? nil : r
+    end
+
+    # Attempts at deleting a document. You have to pass the current version
+    # or at least the { '_id' => i, 'type' => t, '_rev' => r }.
+    #
+    # Will return nil if the deletion is successful.
+    #
+    # If the deletion failed because the given doc has an older revision number
+    # that the one currently stored, the doc in its freshest version will be
+    # returned.
+    #
+    # Returns true if the deletion failed.
+    #
+    def delete (doc)
+
+      type, key = doc['type'], doc['_id']
+
+      lock(type, key) do |f|
+
+        cur = do_get(f)
+
+        return nil unless cur
+        return cur if cur['_rev'] != doc['_rev']
+
+        begin
+          File.delete(f.path)
+          nil
+        rescue
+          true
+        end
+      end
+    end
+
+    # Given a type, this method will return an array of all the documents for
+    # that type.
+    #
+    # A optional second parameter may be used to select, based on a regular
+    # expression, which documents to include (match on the key '_id').
+    #
+    # Will return an empty Hash if there is no documents for a given type.
+    #
+    def get_many (type, key_match=nil)
+
+      d = dir_for(type)
+
+      return [] unless File.exist?(d)
+
+      Dir[File.join(d, '**', '*.json')].inject([]) { |a, fn|
+
+        key = File.basename(fn, '.json')
+
+        if (not key_match) || key.match(key_match)
+
+          doc = get(type, key)
+          a << doc if doc
+        end
+
+        a
+      }.sort { |doc0, doc1|
+        doc0['_id'] <=> doc1['_id']
+      }
+    end
+
+    protected
+
+    def self.neutralize (s)
+
+      s.to_s.strip.gsub(/[ \/:;\*\\\+\?]/, '_')
+    end
+
+    def do_get (file)
+
+      Cloche.json_decode(file.read) rescue nil
+    end
+
+    def dir_for (type)
+
+      File.join(@dir, Cloche.neutralize(type || 'no_type'))
+    end
+
+    def path_for (type, key)
+
+      nkey = Cloche.neutralize(key)
+
+      [
+        File.join(dir_for(type), nkey[-2, 2] || nkey),
+        "#{nkey}.json"
+      ]
+    end
+
+    def file_for (type_or_doc, key)
+
+      fn = if key
+        File.join(*path_for(type_or_doc, key))
+      elsif type_or_doc.is_a?(String)
+        type_or_doc
+      else # it's a doc (Hash)
+        File.join(*path_for(type_or_doc['type'], type_or_doc['_id']))
+      end
+
+      File.exist?(fn) ? (File.new(fn) rescue nil) : nil
+    end
+
+    def lock (type_or_doc, key=nil, &block)
+
+      file = file_for(type_or_doc, key)
+
+      return true if file.nil?
+
+      begin
+        file.flock(File::LOCK_EX)
+        @mutex.synchronize { block.call(file) }
+      ensure
+        begin
+          file.flock(File::LOCK_UN)
+        rescue Exception => e
+          #p [ :lock, @fpath, e ]
+          #e.backtrace.each { |l| puts l }
+        end
+      end
+    end
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-cloche
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - John Mettraux
@@ -27,9 +27,13 @@ extra_rdoc_files:
 - CHANGELOG.txt
 - CREDITS.txt
 files: 
-- README.rdoc
+- lib/rufus/cloche.rb
+- lib/rufus-cloche.rb
 - CHANGELOG.txt
 - CREDITS.txt
+- LICENSE.txt
+- TODO.txt
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/jmettraux/rufus-cloche/
 licenses: []