hypostasis 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f4adf685f294fec93972358ba0f44f733ca1711
-  data.tar.gz: 0430fec44b635d781d0d6a576cf4013afb7f0824
+  metadata.gz: 1c80aa68763652e26b5530ce3a5edae29146fe5b
+  data.tar.gz: 67ea0fe2e5b19379894a8ac743e9d8e3d5d4bb3c
 SHA512:
-  metadata.gz: c44ccc9c76c56b257e3f86782995efbe96e01ad400fb1f098861c1bb31482cb774539f9a35edeb6759c30bc7e60637205c918750a0294a29d3fb793020b8349c
-  data.tar.gz: 4651931a11a248d52845b6c57c8f697211983c28e6bb72fe2f1ae5b2319e8bfad43b778d20c7a74e4c8698e49985251e78a2df4264352082aa997b7c746cd8ce
+  metadata.gz: 5032721bdb5e7077d73150fab9c93c8a81a4c2b31ebe5d94ad3551b0628d5c2e814e24dff04dab9f6fcd378ff76a783614b2b7f0af0b8797b628f595a393d8f1
+  data.tar.gz: 81b5fdc2b7ad080af654c889be5956ad48e7e5dbcb2a833e29bdb797439b00643de14582d1fbd8e5d145204b32a780a58098b077eaaa3e311ab4b6630c5af0fb

data/hypostasis.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w{lib}
 
-  spec.add_dependency 'fdb', '= 1.0.1'
+  spec.add_dependency 'fdb', '~> 1.0.1'
+  spec.add_dependency 'activesupport', '>= 3.2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'

data/lib/hypostasis/data_models/document.rb

@@ -14,4 +14,16 @@ module Hypostasis::DataModels::Document
   def for_field(document, field, type)
     for_document(document) + '\\' + Hypostasis::Tuple.new(field.to_s, type.to_s).to_s
   end
+
+  def for_index(document, field_name, value)
+    class_name = document.is_a?(Class) ? document.to_s : document.class.to_s
+    index_path = Hypostasis::Tuple.new('indexes', class_name).to_s
+    value = value.to_s unless value.is_a?(Fixnum) || value.is_a?(Bignum)
+    if document.is_a?(Class)
+      field_path = Hypostasis::Tuple.new(field_name.to_s, value).to_s
+    else
+      field_path = Hypostasis::Tuple.new(field_name.to_s, value, document.id.to_s).to_s
+    end
+    name.to_s + '\\' + index_path + '\\' + field_path
+  end
 end

data/lib/hypostasis/document.rb

@@ -1,11 +1,19 @@
+require 'active_support/concern'
+
+require 'hypostasis/document/fields'
+require 'hypostasis/document/indexes'
+require 'hypostasis/document/persistence'
+require 'hypostasis/document/findable'
+
 module Hypostasis::Document
-  def self.included(base)
-    base.extend ClassMethods
-    base.class_eval do
-      attr_reader :id
-      # Register somewhere?
-    end
-  end
+  extend ActiveSupport::Concern
+
+  include Hypostasis::Document::Fields
+  include Hypostasis::Document::Indexes
+  include Hypostasis::Document::Persistence
+  include Hypostasis::Document::Findable
+
+  attr_reader :id
 
   def initialize(*attributes)
     self.class.namespace.open
@@ -15,24 +23,6 @@ module Hypostasis::Document
     attributes.each {|hsh| hsh.each {|name, value| @fields[name.to_sym] = value}}
   end
 
-  def save
-    generate_id
-    self.class.namespace.transact do |tr|
-      tr.set(self.class.namespace.for_document(self), true.to_s)
-
-      @fields.each do |field_name, value|
-        tr.set(self.class.namespace.for_field(self, field_name, value.class.to_s), value.to_s)
-      end
-    end
-    self
-  end
-
-  def destroy
-    self.class.namespace.transact do |tr|
-      tr.clear_range_start_with(self.class.namespace.for_document(self))
-    end
-  end
-
   def generate_id
     @id ||= SecureRandom.uuid
   end
@@ -55,50 +45,5 @@ module Hypostasis::Document
     def supported_field_types
       @@supported_field_types ||= %w{Fixnum Bignum String Integer Float Date DateTime Time Boolean}
     end
-
-    def field(name, options = {})
-      register_field(name.to_sym)
-      create_accessors(name.to_s, options)
-    end
-
-    def fields
-      @@fields
-    end
-
-    def register_field(name)
-      @@fields = [] unless defined?(@@fields)
-      @@fields << name.to_sym
-    end
-
-    def create_accessors(name, options)
-      self.class_eval do
-        define_method(name) { @fields[name.to_sym] || nil }
-        define_method("#{name}=") {|value| @fields[name.to_sym] = value}
-      end
-    end
-
-    def create(*attributes)
-      self.new(*attributes).save
-    end
-
-    def find(id)
-      document_keys = []
-      namespace.transact do |tr|
-        document_keys = tr.get_range_start_with(namespace.for_document(self, id))
-      end
-      #raise Hypostasis::Errors::DocumentNotFound if document_keys.empty?
-      attributes = {}
-      id = Hypostasis::Tuple.unpack(document_keys.first.key.split('\\')[1]).to_a[1]
-      document_keys.each do |key|
-        attribute_tuple = key.key.split('\\')[2]
-        next if attribute_tuple.nil?
-        unpacked_key = Hypostasis::Tuple.unpack(attribute_tuple)
-        raw_value = key.value
-        attributes[unpacked_key.to_a[0].to_sym] = reconstitute_value(unpacked_key, raw_value)
-      end
-      document = self.new(attributes)
-      document.set_id(id)
-      document
-    end
   end
 end

data/lib/hypostasis/document/fields.rb

@@ -0,0 +1,28 @@
+module Hypostasis::Document
+  module Fields
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def field(name, options = {})
+        register_field(name.to_sym)
+        create_accessors(name.to_s, options)
+      end
+
+      def fields
+        @@fields
+      end
+
+      def register_field(name)
+        @@fields = [] unless defined?(@@fields)
+        @@fields << name.to_sym
+      end
+
+      def create_accessors(name, options)
+        self.class_eval do
+          define_method(name) { @fields[name.to_sym] || nil }
+          define_method("#{name}=") {|value| @fields[name.to_sym] = value}
+        end
+      end
+    end
+  end
+end

data/lib/hypostasis/document/findable.rb

@@ -0,0 +1,41 @@
+module Hypostasis::Document
+  module Findable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def find(id)
+        document_keys = []
+        namespace.transact do |tr|
+          document_keys = tr.get_range_start_with(namespace.for_document(self, id))
+        end
+        #raise Hypostasis::Errors::DocumentNotFound if document_keys.empty?
+        attributes = {}
+        id = Hypostasis::Tuple.unpack(document_keys.first.key.split('\\')[1]).to_a[1]
+        document_keys.each do |key|
+          attribute_tuple = key.key.split('\\')[2]
+          next if attribute_tuple.nil?
+          unpacked_key = Hypostasis::Tuple.unpack(attribute_tuple)
+          raw_value = key.value
+          attributes[unpacked_key.to_a[0].to_sym] = reconstitute_value(unpacked_key, raw_value)
+        end
+        document = self.new(attributes)
+        document.set_id(id)
+        document
+      end
+
+      def find_where(field_value_pairs)
+        results = []
+        namespace.transact do |tr|
+          field_value_pairs.each do |field, value|
+            results << tr.get_range_start_with(namespace.for_index(self, field, value)).to_a
+          end
+        end
+        results.flatten!
+        results.collect! {|result| Hypostasis::Tuple.unpack(result.key.split('\\').last).to_a.last }.compact!
+        results.select! {|e| results.count(e) == field_value_pairs.size}
+        results.uniq!
+        results.collect! {|result| find(result) }
+      end
+    end
+  end
+end

data/lib/hypostasis/document/indexes.rb

@@ -0,0 +1,22 @@
+module Hypostasis::Document
+  module Indexes
+    extend ActiveSupport::Concern
+
+    def indexed_fields_to_commit
+      self.class.indexed_fields.collect do |field_name|
+        self.class.namespace.for_index(self, field_name, @fields[field_name])
+      end
+    end
+
+    module ClassMethods
+      def index(field_name, options = {})
+        @@indexed_fields = [] unless defined? @@indexed_fields
+        @@indexed_fields << field_name.to_sym
+      end
+
+      def indexed_fields
+        @@indexed_fields
+      end
+    end
+  end
+end

data/lib/hypostasis/document/persistence.rb

@@ -0,0 +1,33 @@
+module Hypostasis::Document
+  module Persistence
+    extend ActiveSupport::Concern
+
+    def save
+      generate_id
+      self.class.namespace.transact do |tr|
+        tr.set(self.class.namespace.for_document(self), true.to_s)
+
+        @fields.each do |field_name, value|
+          tr.set(self.class.namespace.for_field(self, field_name, value.class.to_s), value.to_s)
+        end
+
+        indexed_fields_to_commit.each do |key|
+          tr.set(key, 'true')
+        end
+      end
+      self
+    end
+
+    def destroy
+      self.class.namespace.transact do |tr|
+        tr.clear_range_start_with(self.class.namespace.for_document(self))
+      end
+    end
+
+    module ClassMethods
+      def create(*attributes)
+        self.new(*attributes).save
+      end
+    end
+  end
+end

data/lib/hypostasis/errors.rb

@@ -3,6 +3,7 @@ module Hypostasis::Errors
   class NonExistentNamespace < StandardError; end
   class CanNotReadNamespaceConfig < StandardError; end
   class UnknownNamespaceDataModel < StandardError; end
+  class NamespaceDataModelMismatch < StandardError; end
   class InvalidKeyPath < StandardError; end
   class KeyPathExhausted < StandardError; end
   class InvalidTuple < StandardError; end

data/lib/hypostasis/namespace.rb

@@ -19,6 +19,10 @@ class Hypostasis::Namespace
     true
   end
 
+  def to_s
+    @name
+  end
+
   def self.create(name, options = {})
     raise Hypostasis::Errors::NamespaceAlreadyCreated unless database[name].nil?
     merged_options = { data_model: :key_value }.merge(options)

data/lib/hypostasis/version.rb

@@ -1,3 +1,3 @@
 module Hypostasis
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/test/document_spec.rb

@@ -5,10 +5,12 @@ describe Hypostasis::Document do
 
   before do
     Hypostasis::Connection.create_namespace 'sample_docs', data_model: :document
+    Hypostasis::Connection.create_namespace 'indexed_docs', data_model: :document
   end
 
   after do
     Hypostasis::Connection.destroy_namespace 'sample_docs'
+    Hypostasis::Connection.destroy_namespace 'indexed_docs'
   end
 
   it { subject.must_respond_to :name }
@@ -27,46 +29,78 @@ describe Hypostasis::Document do
 
   describe '#create' do
     let(:subject) { SampleDocument.create(name: 'John', age: 21, dob: Date.today.prev_year(21)) }
-    let(:document_tuple) { Hypostasis::Tuple.new(SampleDocument.to_s, subject.id.to_s).to_s }
-
-    def field_path(name, type)
-      'sample_docs\\' + document_tuple + '\\' + Hypostasis::Tuple.new(name.to_s, type.to_s).to_s
-    end
 
     after do
       subject.destroy
     end
 
     it { subject.id.wont_be_nil }
-    it { database.get(field_path(:name, String)).must_equal 'John' }
-    it { database.get(field_path(:age, Fixnum)).must_equal '21' }
-    it { database.get(field_path(:dob, Date)).must_equal Date.today.prev_year(21).to_s }
+    it { database.get(document_path(subject)).must_equal 'true' }
+    it { database.get(field_path(subject, :name, String)).must_equal 'John' }
+    it { database.get(field_path(subject, :age, Fixnum)).must_equal '21' }
+    it { database.get(field_path(subject, :dob, Date)).must_equal Date.today.prev_year(21).to_s }
   end
 
   describe '#save' do
-    let(:document_tuple) { Hypostasis::Tuple.new(SampleDocument.to_s, @document.id.to_s).to_s }
+    let(:subject) { SampleDocument.new(name: 'John', age: 21, dob: Date.today.prev_year(21)) }
 
-    def field_path(name, type)
-      'sample_docs\\' + document_tuple + '\\' + Hypostasis::Tuple.new(name.to_s, type.to_s).to_s
+    before do
+      subject.save
     end
 
-    before do
-      @document = subject.save
+    after do
+      subject.destroy
     end
 
-    it { database.get(field_path(:name, String)).must_equal 'John' }
-    it { database.get(field_path(:age, Fixnum)).must_equal '21' }
-    it { database.get(field_path(:dob, Date)).must_equal Date.today.prev_year(21).to_s }
+    it { subject.id.wont_be_nil }
+    it { database.get(document_path(subject)).must_equal 'true' }
+    it { database.get(field_path(subject, :name, String)).must_equal 'John' }
+    it { database.get(field_path(subject, :age, Fixnum)).must_equal '21' }
+    it { database.get(field_path(subject, :dob, Date)).must_equal Date.today.prev_year(21).to_s }
   end
 
   describe '.find' do
     let(:document_id) { subject.save.id }
 
+    after do
+      subject.destroy
+    end
+
     it { SampleDocument.find(document_id).is_a?(SampleDocument).must_equal true }
     it { SampleDocument.find(document_id).id.must_equal document_id }
   end
 
   describe 'indexing' do
+    before do
+      IndexedDocument.create(name: 'John', age: 21, dob: Date.today.prev_year(21))
+      IndexedDocument.create(name: 'Jane', age: 21, dob: Date.today.prev_year(21))
+      IndexedDocument.create(name: 'John', age: 23, dob: Date.today.prev_year(23))
+      IndexedDocument.create(name: 'Tom', age: 20, dob: Date.today.prev_year(20))
+    end
+
+    it { database.get_range_start_with(index_path(IndexedDocument, :name)).size.must_equal 4 }
+    it { database.get_range_start_with(index_path(IndexedDocument, :age)).size.must_equal 4 }
+
+    it { database.get_range_start_with(index_path(IndexedDocument, :name, 'John')).size.must_equal 2 }
+    it { database.get_range_start_with(index_path(IndexedDocument, :name, 'Jane')).size.must_equal 1 }
+
+    it { database.get_range_start_with(index_path(IndexedDocument, :age, 21)).size.must_equal 2 }
+  end
+
+  describe '.find_where' do
+    before do
+      IndexedDocument.create(name: 'John', age: 21, dob: Date.today.prev_year(21))
+      IndexedDocument.create(name: 'Jane', age: 21, dob: Date.today.prev_year(21))
+      IndexedDocument.create(name: 'John', age: 23, dob: Date.today.prev_year(23))
+      IndexedDocument.create(name: 'Tom', age: 20, dob: Date.today.prev_year(20))
+    end
+
+    it { IndexedDocument.find_where(name: 'John').size.must_equal 2 }
+    it { IndexedDocument.find_where(age: 21).size.must_equal 2 }
+    it { IndexedDocument.find_where(name: 'Tom').size.must_equal 1 }
+    it { IndexedDocument.find_where(name: 'Tom').first.is_a?(IndexedDocument).must_equal true }
 
+    it { IndexedDocument.find_where(name: 'John', age: 23).size.must_equal 1 }
+    it { IndexedDocument.find_where(name: 'John', age: 23).first.is_a?(IndexedDocument).must_equal true }
   end
 end

data/test/minitest_helper.rb

@@ -14,6 +14,7 @@ require 'hypostasis'
 require 'minitest/autorun'
 
 require 'support/sample_document'
+require 'support/indexed_document'
 
 class Minitest::Spec
 
@@ -21,4 +22,29 @@ class Minitest::Spec
     @database ||= FDB.open
   end
 
+  def document_path(document)
+    document_namespace = document.class.namespace.to_s
+    document_tuple = Hypostasis::Tuple.new(document.class.to_s, document.id.to_s).to_s
+    document_namespace + '\\' + document_tuple
+  end
+
+  def field_path(document, name, type)
+    document_namespace = document.class.namespace.to_s
+    document_tuple = Hypostasis::Tuple.new(document.class.to_s, document.id.to_s).to_s
+    field_tuple = Hypostasis::Tuple.new(name.to_s, type.to_s).to_s
+    document_namespace + '\\' + document_tuple + '\\' + field_tuple
+  end
+
+  def index_path(klass, field_name, value = nil)
+    namespace = klass.namespace.to_s
+    indexes_tuple = Hypostasis::Tuple.new('indexes', klass.to_s).to_s
+    if value.nil?
+      indexed_value_tuple = Hypostasis::Tuple.new(field_name.to_s).to_s
+    else
+      value = value.to_s unless value.is_a?(Fixnum) || value.is_a?(Bignum)
+      indexed_value_tuple = Hypostasis::Tuple.new(field_name.to_s, value).to_s
+    end
+    namespace + '\\' + indexes_tuple + '\\' + indexed_value_tuple
+  end
+
 end

data/test/support/indexed_document.rb

@@ -0,0 +1,12 @@
+class IndexedDocument
+  include Hypostasis::Document
+
+  use_namespace 'indexed_docs'
+
+  field :name
+  field :age
+  field :dob
+
+  index :name
+  index :age
+end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hypostasis
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fdb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +102,10 @@ files:
 - lib/hypostasis/data_models/key_value.rb
 - lib/hypostasis/data_models/utilities.rb
 - lib/hypostasis/document.rb
+- lib/hypostasis/document/fields.rb
+- lib/hypostasis/document/findable.rb
+- lib/hypostasis/document/indexes.rb
+- lib/hypostasis/document/persistence.rb
 - lib/hypostasis/errors.rb
 - lib/hypostasis/key_path.rb
 - lib/hypostasis/namespace.rb
@@ -98,6 +116,7 @@ files:
 - test/key_path_spec.rb
 - test/minitest_helper.rb
 - test/namespace_spec.rb
+- test/support/indexed_document.rb
 - test/support/sample_document.rb
 - test/tuple_spec.rb
 homepage: ''
@@ -120,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: A layer for FoundationDB providing multiple data models for Ruby.
@@ -130,5 +149,6 @@ test_files:
 - test/key_path_spec.rb
 - test/minitest_helper.rb
 - test/namespace_spec.rb
+- test/support/indexed_document.rb
 - test/support/sample_document.rb
 - test/tuple_spec.rb