hypostasis 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dbac3fb199bc4d6edf4065159d9ec92e41b071b
-  data.tar.gz: 06a5045d627c2b6a0e3e9d95f14ca106c0b95ce7
+  metadata.gz: 3ef5cc8995a6ef7a748862673f907a6b5fb95e43
+  data.tar.gz: bfa8febeae9d58a04764948cde524fea4172b706
 SHA512:
-  metadata.gz: 4e378bc61f2ffd706f4a3824292cdc55b14712beab90a7e4bfd5210ca1623047599e34643039edf9700dd4b96bf2e56dd61fcb0c3f59ec16318be10fa477000f
-  data.tar.gz: e6d76b2b7160982607a608a75ab966d59575d3bd53422d142a78145988752f1fbe06f645e2b5c97b01c6762557f22c3503f70bc7a73ba7ac9e344cbb215a854d
+  metadata.gz: afd6b2484b51d26be937f3152f0bfae13e2f5739ce8e0608f3aaadffbc4c70d53e2c6b08acfde1558aab8b7f81d0fd513f08f5cbe9cb3e1cb074bbc53431696b
+  data.tar.gz: af7539814a855d5ff6845fb136051a162757da126fe7547d3948d2508c1c0a6d97bf0bad8ce3f05ba6dfcea1445a83c40c38c978177751ce81ae446fdaeea308

data/README.md

@@ -50,6 +50,29 @@ the project matures and the APIs stabilize.
 
 Until then, we suggest reading the code and the tests.
 
+### Key-Value Data Model
+
+    require 'hypostasis'
+
+    ns = Hypostasis::Connection.create_namespace('keystore', {data_model: :key_value})
+    ns.set('keyname', 10)
+
+    ns.get('keyname')     #=> 10
+
+The Key-Value data model provides some simple enhancements on top of
+FoundationDB's core key-value capabilities, including automatic reconstitution
+of basic language types and support for namespacing where keys are stored. The
+basic language types currently suported include the following:
+
+* String
+* Fixnum
+* Bignum
+* Float
+* Date
+* DateTime
+* Time
+* Boolean
+
 ## Contributing
 
 1. Fork it

data/lib/hypostasis/connection.rb

@@ -1,50 +1,28 @@
+require 'singleton'
 require 'fdb'
 
 FDB.api_version 100
 
 class Hypostasis::Connection
-  attr_reader :database
+  include ::Singleton
 
-  @@config_key = Hypostasis::KeyPath.new('hypostasis', 'config', 'namespaces')
-
-  def initialize
-    @database = FDB.open
-  end
-
-  def self.config_path
-    @@config_key
-  end
-
-  def get(key)
-    database[key.to_s]
-  end
-
-  def set(key, value)
-    (database[key.to_s] = value.to_s) == value.to_s
+  def self.open
+    self
   end
 
-  def unset(key)
-    database.clear(key).nil?
+  def self.database
+    @@database ||= FDB.open
   end
 
-  def create_namespace(name, options = {data_model: :key_value})
-    path = @@config_key.extend_path(name.to_s).to_s
-    raise Hypostasis::Errors::NamespaceAlreadyCreated unless database[path].nil?
-    database[path] = Marshal.dump(options)
-    Hypostasis::Namespace.new(name, options[:data_model])
+  def self.create_namespace(name, options = {})
+    Hypostasis::Namespace.create(name, options)
   end
 
-  def open_namespace(name)
-    path = @@config_key.extend_path(name.to_s).to_s
-    raise Hypostasis::Errors::NonExistentNamespace if database[path].nil?
-    options = Marshal.load(database[path])
-    Hypostasis::Namespace.new(name, options[:data_model])
+  def self.open_namespace(name)
+    Hypostasis::Namespace.open(name)
   end
 
-  def destroy_namespace(name)
-    path = @@config_key.extend_path(name.to_s).to_s
-    raise Hypostasis::Errors::NonExistentNamespace if database[path].nil?
-    database.clear_range_start_with(path)
+  def self.destroy_namespace(name)
     database.clear_range_start_with(name.to_s)
     true
   end

data/lib/hypostasis/data_models/document.rb

@@ -0,0 +1,3 @@
+module Hypostasis::DataModels::Document
+
+end

data/lib/hypostasis/data_models/key_value.rb

@@ -0,0 +1,37 @@
+require 'date'
+
+module Hypostasis::DataModels::KeyValue
+  def set(key, value)
+    key_path = "#{name}\\#{Hypostasis::Tuple.new(key.to_s, value.class.to_s).to_s}"
+    database.set(key_path, value.to_s)
+  end
+
+  def get(key)
+    key_path = "#{name}\\#{Hypostasis::Tuple.new(key.to_s).to_s}"
+    key = database.get_range_start_with(key_path).first.key
+    value = database.get_range_start_with(key_path).first.value
+    data_type = Hypostasis::Tuple.unpack(key.to_s.split('\\').last).to_a.last
+    case data_type
+      when 'Fixnum'
+        Integer(value)
+      when 'Bignum'
+        Integer(value)
+      when 'Float'
+        Float(value)
+      when 'String'
+        value
+      when 'Date'
+        Date.parse(value)
+      when 'DateTime'
+        DateTime.parse(value)
+      when 'Time'
+        Time.parse(value)
+      when 'TrueClass'
+        true
+      when 'FalseClass'
+        false
+      else
+        raise Hypostasis::Errors::UnknownValueType
+    end
+  end
+end

data/lib/hypostasis/data_models.rb

@@ -1,4 +1,4 @@
-module Hypostasis::DataModel; end
+module Hypostasis::DataModels; end
 
-require 'hypostasis/data_model/document'
-require 'hypostasis/data_model/key_value'
+require 'hypostasis/data_models/key_value'
+require 'hypostasis/data_models/document'

data/lib/hypostasis/errors.rb

@@ -1,8 +1,11 @@
 module Hypostasis::Errors
   class NamespaceAlreadyCreated < StandardError; end
   class NonExistentNamespace < StandardError; end
+  class CanNotReadNamespaceConfig < StandardError; end
+  class UnknownNamespaceDataModel < StandardError; end
   class InvalidKeyPath < StandardError; end
   class KeyPathExhausted < StandardError; end
   class InvalidTuple < StandardError; end
   class TupleExhausted < StandardError; end
+  class UnknownValueType < StandardError; end
 end

data/lib/hypostasis/namespace.rb

@@ -1,16 +1,55 @@
 class Hypostasis::Namespace
   attr_reader :name, :data_model
 
-  def initialize(name, data_model)
+  def initialize(name, data_model = :key_value)
     @name = name.to_s
     @data_model = data_model.to_sym
+
+    load_data_model
+  end
+
+  def destroy
+    database.clear_range_start_with(@name)
+    true
+  end
+
+  def self.create(name, options = {})
+    raise Hypostasis::Errors::NamespaceAlreadyCreated unless database[name].nil?
+    merged_options = { data_model: :key_value }.merge(options)
+
+    database.transact do |tr|
+      tr.set(name.to_s, 'true')
+      tr.set(name.to_s + '\\' + Hypostasis::Tuple.new('config','data_model').to_s, merged_options[:data_model].to_s)
+    end
+
+    Hypostasis::Namespace.new(name, merged_options[:data_model])
+  end
+
+  def self.open(name)
+    raise Hypostasis::Errors::NonExistentNamespace if database[name].nil?
+    data_model = database.get(name + '\\' + Hypostasis::Tuple.new('config','data_model').to_s)
+    raise Hypostasis::Errors::CanNotReadNamespaceConfig if data_model.nil?
+    Hypostasis::Namespace.new(name, data_model)
+  end
+
+private
+
+  def self.database
+    Hypostasis::Connection.database
   end
 
-  def key_path
-    @key_path ||= Hypostasis::KeyPath.new(name)
+  def database
+    Hypostasis::Namespace.database
   end
 
-  def config_path
-    @config_path ||= Hypostasis::Connection.config_path.extend_path(name)
+  def load_data_model
+    case @data_model
+      when :key_value
+        self.extend Hypostasis::DataModels::KeyValue
+      when :document
+        self.extend Hypostasis::DataModels::Document
+      else
+        raise Hypostasis::Errors::UnknownNamespaceDataModel, "#{@data_model} unknown"
+    end
   end
 end

data/lib/hypostasis/version.rb

@@ -1,3 +1,3 @@
 module Hypostasis
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

data/lib/hypostasis.rb

@@ -5,6 +5,5 @@ require 'hypostasis/errors'
 require 'hypostasis/tuple'
 require 'hypostasis/key_path'
 require 'hypostasis/connection'
-require 'hypostasis/namespace'
-
 require 'hypostasis/data_models'
+require 'hypostasis/namespace'

data/test/connection_spec.rb

@@ -1,62 +1,45 @@
 require 'minitest_helper'
 
 describe Hypostasis::Connection do
-  let(:subject) { Hypostasis::Connection.new }
-
-  it { subject.must_respond_to :get }
-  it { subject.must_respond_to :set }
-  it { subject.must_respond_to :unset }
-
-  describe '#get and #set' do
-    before :each do
-      subject.set('preset_key', 'preset_value')
-    end
-
-    after :each do
-      subject.unset('preset_key')
-    end
-
-    it { subject.get('invalid_key').nil?.must_equal true }
-    it { subject.get('preset_key').must_equal 'preset_value' }
-  end
-
-  describe '#unset' do
-    it 'unsets a previously set key' do
-      subject.set('preset_key', 'preset_value')
-      subject.get('preset_key').must_equal 'preset_value'
-      subject.unset('preset_key').must_equal true
-      subject.get('preset_key').nil?.must_equal true
-    end
-
-    it 'returns true for an unset key' do
-      subject.get('preset_key').nil?.must_equal true
-      subject.unset('preset_key').must_equal true
-    end
-  end
+  let(:subject) { Hypostasis::Connection.open }
 
   describe '#create_namespace' do
-    before :each do
+    before do
+      subject.destroy_namespace('already_created')
       subject.create_namespace('already_created')
     end
 
+    after do
+      subject.destroy_namespace('already_created')
+      subject.destroy_namespace('newly_created')
+    end
+
     it { subject.create_namespace('newly_created').is_a?(Hypostasis::Namespace).must_equal true }
     it { lambda { subject.create_namespace('already_created') }.must_raise Hypostasis::Errors::NamespaceAlreadyCreated }
   end
 
   describe '#open_namespace' do
-    before :each do
+    before do
       subject.create_namespace('already_created')
     end
 
+    after do
+      subject.destroy_namespace('already_created')
+    end
+
     it { subject.open_namespace('already_created').is_a?(Hypostasis::Namespace).must_equal true }
   end
 
   describe '#destroy_namespace' do
-    before :each do
+    before do
       subject.create_namespace('already_created')
     end
 
+    after do
+      subject.destroy_namespace('already_created')
+    end
+
     it { subject.destroy_namespace('already_created').must_equal true }
-    it { lambda { subject.destroy_namespace('not_created') }.must_raise Hypostasis::Errors::NonExistentNamespace }
+    it { subject.destroy_namespace('not_created').must_equal true }
   end
 end

data/test/minitest_helper.rb

@@ -15,17 +15,6 @@ require 'minitest/autorun'
 
 class Minitest::Spec
 
-  after do
-    database.get_range_start_with("hypostasis\\config\\namespaces") do |kv|
-      namespace = kv.key.gsub("hypostasis\\config\\namespaces\\", '')
-      database.clear_range_start_with(namespace)
-    end
-
-    database.clear_range_start_with('hypostasis')
-  end
-
-private
-
   def database
     @database ||= FDB.open
   end

data/test/namespace_spec.rb

@@ -1,19 +1,169 @@
 require 'minitest_helper'
 
 describe Hypostasis::Namespace do
-  let(:subject) { Hypostasis::Namespace.new('demonstration', :document) }
+  let(:subject) { Hypostasis::Namespace.new('demonstration') }
 
   it { subject.must_respond_to :name }
   it { subject.name.must_equal 'demonstration' }
 
   it { subject.must_respond_to :data_model }
-  it { subject.data_model.must_equal :document }
+  it { subject.data_model.must_equal :key_value }
 
-  it { subject.must_respond_to :key_path }
-  it { subject.key_path.is_a?(Hypostasis::KeyPath).must_equal true }
-  it { subject.key_path.to_a.must_equal %w{demonstration} }
+  it { subject.must_respond_to :destroy }
 
-  it { subject.must_respond_to :config_path }
-  it { subject.config_path.is_a?(Hypostasis::KeyPath).must_equal true }
-  it { subject.config_path.to_a.must_equal %w{hypostasis config namespaces demonstration} }
+  describe '#destroy' do
+    before do
+      Hypostasis::Connection.destroy_namespace('destroy_demo')
+    end
+
+    it {
+      ns = Hypostasis::Namespace.create('destroy_demo')
+      database.get('destroy_demo').must_equal 'true'
+      ns.destroy
+      database.get('destroy_demo').nil?.must_equal true
+    }
+  end
+
+  describe 'for a Key-Value namespace' do
+    before do
+      subject
+    end
+
+    after do
+      subject.destroy
+    end
+
+    let(:subject) { Hypostasis::Namespace.create('keyvalue_space', { data_model: :key_value }) }
+
+    it { database.get('keyvalue_space\\' + Hypostasis::Tuple.new(['config','data_model']).to_s).must_equal 'key_value' }
+    it { subject.must_respond_to :get }
+    it { subject.must_respond_to :set }
+
+    describe '#set' do
+      before do
+        subject.set('fixnum', 5)
+      end
+
+      it { database.get('keyvalue_space\\' + Hypostasis::Tuple.new('fixnum'.to_s, Fixnum.to_s).to_s).must_equal '5' }
+    end
+
+    describe '#get' do
+      describe 'for Fixnums' do
+        before do
+          subject.set('fixnum', 5)
+        end
+
+        it { subject.get('fixnum').must_equal 5 }
+      end
+
+      describe 'for Bignum' do
+        before do
+          subject.set('bignum', 12333333333333333333)
+        end
+
+        it { subject.get('bignum').must_equal 12333333333333333333 }
+      end
+
+      describe 'for Float' do
+        before do
+          subject.set('float', 1.2345)
+        end
+
+        it { subject.get('float').must_equal 1.2345 }
+      end
+
+      describe 'for String' do
+        before do
+          subject.set('string', 'a string')
+        end
+
+        it { subject.get('string').must_equal 'a string' }
+      end
+
+      describe 'for Date' do
+        before do
+          @date = Date.today
+          subject.set('date', @date)
+        end
+
+        it { subject.get('date').must_equal @date }
+      end
+
+      describe 'for DateTime' do
+        before do
+          @date = DateTime.now
+          subject.set('datetime', @date)
+        end
+
+        it { subject.get('datetime').year.must_equal @date.year }
+        it { subject.get('datetime').month.must_equal @date.month }
+        it { subject.get('datetime').day.must_equal @date.day }
+        it { subject.get('datetime').hour.must_equal @date.hour }
+        it { subject.get('datetime').minute.must_equal @date.minute }
+        it { subject.get('datetime').second.must_equal @date.second }
+        it { subject.get('datetime').zone.must_equal @date.zone }
+      end
+
+      describe 'for Time' do
+        before do
+          @time = Time.now
+          subject.set('time', @time)
+        end
+
+        it { subject.get('time').hour.must_equal @time.hour }
+        it { subject.get('time').min.must_equal @time.min }
+        it { subject.get('time').sec.must_equal @time.sec }
+        it { subject.get('time').zone.must_equal @time.zone }
+      end
+
+      describe 'for Bolean' do
+        before do
+          subject.set('true', true)
+          subject.set('false', false)
+        end
+
+        it { subject.get('true').must_equal true }
+        it { subject.get('false').must_equal false }
+      end
+
+      describe 'for unknown type' do
+        before do
+          class Unknown; end
+          database.set('keyvalue_space\\' + Hypostasis::Tuple.new('unknown'.to_s, Unknown.to_s).to_s, '1')
+        end
+
+        it { lambda { subject.get('unknown') }.must_raise Hypostasis::Errors::UnknownValueType }
+      end
+    end
+  end
+
+  describe 'for a Document namespace' do
+    before do
+      subject
+    end
+
+    after do
+      subject.destroy
+    end
+
+    let(:subject) { Hypostasis::Namespace.create('document_space', { data_model: :document }) }
+
+    it { database.get('document_space\\' + Hypostasis::Tuple.new(['config','data_model']).to_s).must_equal 'document' }
+  end
+
+  describe 'for an unknown namespace type' do
+    after do
+      Hypostasis::Connection.destroy_namespace('unknown_space')
+    end
+
+    it { lambda { Hypostasis::Namespace.create('unknown_space', { data_model: :unknown }) }.must_raise Hypostasis::Errors::UnknownNamespaceDataModel }
+    it {
+      database.set('unknown_space', 'true')
+      database.set('unknown_space\\' + Hypostasis::Tuple.new(['config','data_model']).to_s, 'unknown')
+
+      lambda {
+        Hypostasis::Namespace.open('unknown_space')
+      }.must_raise Hypostasis::Errors::UnknownNamespaceDataModel
+    }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hypostasis
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-16 00:00:00.000000000 Z
+date: 2014-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fdb
@@ -83,17 +83,15 @@ files:
 - hypostasis.gemspec
 - lib/hypostasis.rb
 - lib/hypostasis/connection.rb
-- lib/hypostasis/data_model/document.rb
-- lib/hypostasis/data_model/key_value.rb
 - lib/hypostasis/data_models.rb
+- lib/hypostasis/data_models/document.rb
+- lib/hypostasis/data_models/key_value.rb
 - lib/hypostasis/errors.rb
 - lib/hypostasis/key_path.rb
 - lib/hypostasis/namespace.rb
 - lib/hypostasis/tuple.rb
 - lib/hypostasis/version.rb
 - test/connection_spec.rb
-- test/data_models/document/document_spec.rb
-- test/data_models/key_value/key_value_spec.rb
 - test/key_path_spec.rb
 - test/minitest_helper.rb
 - test/namespace_spec.rb
@@ -124,8 +122,6 @@ specification_version: 4
 summary: A layer for FoundationDB providing multiple data models for Ruby.
 test_files:
 - test/connection_spec.rb
-- test/data_models/document/document_spec.rb
-- test/data_models/key_value/key_value_spec.rb
 - test/key_path_spec.rb
 - test/minitest_helper.rb
 - test/namespace_spec.rb

data/lib/hypostasis/data_model/document.rb

@@ -1,3 +0,0 @@
-module Hypostasis::DataModel::Document
-
-end

data/lib/hypostasis/data_model/key_value.rb

@@ -1,3 +0,0 @@
-module Hypostasis::DataModel::KeyValue
-
-end

data/test/data_models/document/document_spec.rb

@@ -1,5 +0,0 @@
-require 'minitest_helper'
-
-describe Hypostasis::DataModel::Document do
-
-end

data/test/data_models/key_value/key_value_spec.rb

@@ -1,5 +0,0 @@
-require 'minitest_helper'
-
-describe Hypostasis::DataModel::KeyValue do
-
-end