treestore 0.1.0

data/lib/backend/backend.rb

@@ -0,0 +1,38 @@
+class Backend
+  def initialize
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def retrieve(key)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def addblob(value)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def addtree(keys)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def ref(name)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def make_ref(name, key)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def delete(key)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def exists?(key)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+
+  def type(key)
+    raise NotImplementedError, "must instantiate a specific type of backend"
+  end
+end
+

data/lib/backend/redis.rb

@@ -0,0 +1,54 @@
+require 'redis'
+require File.expand_path(File.dirname(__FILE__)) + '/backend'
+
+class RedisBackend < Backend
+  def initialize(redis=nil)
+    @redis = redis || Redis.new
+  end
+
+  def retrieve(key)
+    type = @redis.type(key)
+
+    case type
+    when "string"
+      @redis.get(key)
+    when "set"
+      @redis.smembers(key)
+    end
+  end
+
+  def addblob(key, value)
+    @redis.set(key, value)
+  end
+
+  def addtree(treekey, keys)
+    @redis.sadd(treekey, keys)
+  end
+  
+  def ref(name)
+    @redis.get(name)
+  end
+
+  def make_ref(name, key)
+    @redis.set(name, key)
+  end
+
+  def delete(key)
+    @redis.del(key)
+  end
+
+  def exists?(key)
+    @redis.exists(key)
+  end
+
+  def type(key)
+    case @redis.type(key)
+    when "string"
+      :blob
+    when "set"
+      :tree
+    end
+  end
+end
+
+

data/lib/treestore.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'digest/sha1'
+require 'backend/redis'
+
+class TreeStore
+  def initialize(backend=RedisBackend.new)
+    raise RuntimeError, "#{backend} is not an appropriate backend" if not backend.kind_of? Backend
+    @backend = backend
+    @namespace = "tree-store"
+  end
+
+  def add(item)
+    key = Digest::SHA1.hexdigest(item)
+    @backend.addblob(make_object_key(key), item)
+    key
+  end
+  
+  def retrieve(key)
+    realkey = make_object_key(ref(key) || key)
+    @backend.retrieve(realkey)
+  end
+
+  def make_tree(keys)
+    realkeys = {}
+    keys.each do |key|
+      realkey = ref(key) || key
+      unless exists?(realkey)
+        raise RuntimeError, "Can't make tree, no item with key of #{key} or #{realkey} exists, make it first"
+      end
+      realkeys[realkey] = true
+    end
+
+    realkeys = realkeys.keys
+    treekey = Digest::SHA1.hexdigest(realkeys.join)
+    @backend.addtree(make_object_key(treekey), realkeys)
+    treekey
+  end
+
+  def ref(name)
+    @backend.ref(make_ref_key(name))
+  end
+
+  def make_ref(name, key)
+    realkey = ref(key) || key
+    @backend.make_ref(make_ref_key(name), realkey)
+    name
+  end
+
+  def delete(key)
+    ref = ref(key)
+    if ref.nil?
+      @backend.delete(make_object_key(key))
+    else
+      @backend.delete(make_ref_key(key))
+    end
+  end
+
+  def type(key)
+    @backend.type(make_object_key(ref(key) || key))
+  end
+
+  def exists?(key)
+    @backend.exists?(make_object_key(ref(key) || key))
+  end
+
+  private
+  
+  def make_object_key(key)
+    "#{@namespace}:object:#{key}"
+  end
+
+  def make_ref_key(key)
+    "#{@namespace}:ref:#{key}"
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: treestore
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthew Curry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'treestore stores two different types of data:
+
+  1) values, which are stored according to their SHA-1 hashcode
+
+  2) trees, which are sets of values and/or other trees, stored via a SHA-1 hashcode
+
+
+  In addition, there are references that allow you to ''bookmark'' a SHA-1 hashcode
+  for easier lookup.
+
+
+  If you think of the core git, but on any key-value backend store (like the included
+  Redis one), you''ve got the right idea.
+
+'
+email: mjcurry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/treestore.rb
+- lib/backend/backend.rb
+- lib/backend/redis.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Immutable storage of key values arranged in trees
+test_files: []