hypostasis 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c80aa68763652e26b5530ce3a5edae29146fe5b
-  data.tar.gz: 67ea0fe2e5b19379894a8ac743e9d8e3d5d4bb3c
+  metadata.gz: 2e9fbd57ef0554f4b251ba9e9f0a93bfe87e06b5
+  data.tar.gz: e8b6b94f4a7dc94715f3738c6cb84083731b2d79
 SHA512:
-  metadata.gz: 5032721bdb5e7077d73150fab9c93c8a81a4c2b31ebe5d94ad3551b0628d5c2e814e24dff04dab9f6fcd378ff76a783614b2b7f0af0b8797b628f595a393d8f1
-  data.tar.gz: 81b5fdc2b7ad080af654c889be5956ad48e7e5dbcb2a833e29bdb797439b00643de14582d1fbd8e5d145204b32a780a58098b077eaaa3e311ab4b6630c5af0fb
+  metadata.gz: 7063a5209d6b7e529314c3918474a05b289e19bee7f0801468c9793e5ebb68605ce37b304cf94fa67f3056ca9bcaa97b078b6e5dd4d8f43f725d8b24d4b456d5
+  data.tar.gz: c328c728d3f64e507cbba577350b1a294555e41bc647154b24a2de60c4636eb8f59deeb091c21807219495a298c20f453dca2542c80a6a9edf7a64ca1494f726

data/.ruby-version

@@ -1 +1 @@
-ruby-2.0.0
+ruby

data/README.md

@@ -2,8 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/hypostasis.png)](http://badge.fury.io/rb/hypostasis)
 [![Build Status](https://travis-ci.org/hypostasis/hypostasis.png)](https://travis-ci.org/hypostasis/hypostasis)
-[![Coverate](https://codeclimate.com/repos/52d192fa6956802453000df7/badges/0e37d2069e868f797adc/coverage.png)](https://codeclimate.com/repos/52d192fa6956802453000df7/feed)
-[![Code Climate](https://codeclimate.com/repos/52d192fa6956802453000df7/badges/0e37d2069e868f797adc/gpa.png)](https://codeclimate.com/repos/52d192fa6956802453000df7/feed)
+[![Code Climate](https://codeclimate.com/github/hypostasis/hypostasis.png)](https://codeclimate.com/github/hypostasis/hypostasis)
 [![Dependency Status](https://gemnasium.com/hypostasis/hypostasis.png)](https://gemnasium.com/hypostasis/hypostasis)
 
 Hypostasis is a layer for FoundationDB that supports multiple data models on
@@ -20,12 +19,8 @@ variety of data models while using the same underlying storage system, provided
 by FoundationDB. The data models Hypostasis currently aims to support are the
 following:
 
-* Document-Oriented
-* Simple Key-Value (Wrapper for naked FoundationDB)
-* Relational (an RDBMS without SQL)
-* Column-Oriented (like Cassandra without CQL)
-
-The initial focus will be on the Document-Oriented and simple Key-Value models.
+* Document
+* Key-Value
 
 ## Installation
 
@@ -43,10 +38,10 @@ Or install it yourself as:
 
 ## Usage
 
-Hypostasis is still very much Alpha quality software, only suitable for
-experimentation. But, feel free to play around with it. Documentation will be
-written to define how to use the various data models provided by Hypostasis as
-the project matures and the APIs stabilize.
+Hypostasis is beta quality software, please keep this in mind. Until the first
+major version is released the API is not to be considered stable. Feel free to
+play around with it and open issues for anything you find that causes a problem
+or for any features you want to see added.
 
 Until then, we suggest reading the code and the tests.
 
@@ -73,6 +68,44 @@ basic language types currently suported include the following:
 * Time
 * Boolean
 
+### Document Data Model
+
+    require 'hypostasis'
+
+    ns = Hypostasis::Connection.create_namespace('keystore', {data_model: :document})
+
+    class SampleDocument
+      include Hypostasis::Document
+
+      field :name
+      field :age
+      field :dob
+
+      index :name
+      index :age
+    end
+
+    SampleDocument.create(name: 'John', age: 21, dob: Date.today.prev_year(21))
+
+    SampleDocument.find(<<id>>)
+
+    SampleDocument.find_where(name: 'John')
+    SampleDocument.find_where(age: 21)
+
+The Document data model provides a simple document-oriented data model on top
+of FoundationDB, including simple indexing. Like the Key-Value data model the
+document-oriented model is able to automatically encode and reconstitute
+certain basic Ruby data types, including the following:
+
+* String
+* Fixnum
+* Bignum
+* Float
+* Date
+* DateTime
+* Time
+* Boolean
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -7,4 +7,13 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-task :default => :test
+if system('vagrant --version > /dev/null 2>&1') && system('vagrant exec -h > /dev/null 2>&1')
+  desc 'Run tests within Vagrant'
+  task :vagrant_test do
+    system 'vagrant exec rake test'
+  end
+
+  task :default => :vagrant_test
+else
+  task :default => :test
+end

data/Vagrantfile

@@ -0,0 +1,22 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure('2') do |config|
+  config.vm.box = 'precise64'
+
+  config.vm.provider :virtualbox do |vb|
+    vb.box_url = 'http://files.vagrantup.com/precise64.box'
+    vb.memory = 4096
+  end
+
+  config.vm.provider :vmware_fusion do |vw|
+    vw.box = 'precise64_vmware'
+    vw.box_url = 'http://files.vagrantup.com/precise64_vmware.box'
+    vw.memory = 4096
+  end
+
+  config.vm.provision 'shell', path: 'provision.sh'
+
+  config.exec.root = '/vagrant'
+  config.exec.prepend_with 'bundle exec'
+end

data/lib/hypostasis/data_models/utilities.rb

@@ -20,6 +20,8 @@ module Hypostasis::DataModels::Utilities
         true
       when 'FalseClass'
         false
+      when 'NilClass'
+        nil
       else
         raise Hypostasis::Errors::UnknownValueType
     end

data/lib/hypostasis/document/belongs_to.rb

@@ -0,0 +1,18 @@
+module Hypostasis::Document
+  module BelongsTo
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def belongs_to(klass)
+        field_name = "#{klass.to_s}_id"
+        accessor_name = klass.to_s
+        parent_klass = klass.to_s.classify
+        self.class_eval do
+          field field_name.to_sym
+          index field_name.to_sym
+          define_method(accessor_name) { parent_klass.constantize.find(self.send(field_name.to_sym)) }
+        end
+      end
+    end
+  end
+end

data/lib/hypostasis/document/fields.rb

@@ -9,12 +9,16 @@ module Hypostasis::Document
       end
 
       def fields
-        @@fields
+        self.class_eval { class_variable_get(:@@fields) }
       end
 
       def register_field(name)
-        @@fields = [] unless defined?(@@fields)
-        @@fields << name.to_sym
+        self.class_eval do
+          class_variable_set(:@@fields, []) unless class_variable_defined?(:@@fields)
+          registered_fields = class_variable_get(:@@fields)
+          registered_fields << name.to_sym
+          class_variable_set(:@@fields, registered_fields)
+        end
       end
 
       def create_accessors(name, options)

data/lib/hypostasis/document/findable.rb

@@ -6,9 +6,9 @@ module Hypostasis::Document
       def find(id)
         document_keys = []
         namespace.transact do |tr|
-          document_keys = tr.get_range_start_with(namespace.for_document(self, id))
+          document_keys = tr.get_range_start_with(namespace.for_document(self, id)).to_a
         end
-        #raise Hypostasis::Errors::DocumentNotFound if document_keys.empty?
+        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|

data/lib/hypostasis/document/has_one.rb

@@ -0,0 +1,16 @@
+module Hypostasis::Document
+  module HasOne
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_one(klass)
+        accessor_name = klass.to_s
+        child_klass = klass.to_s.classify
+        self_klass = "#{self.to_s.underscore}_id".to_sym
+        self.class_eval do
+          define_method(accessor_name) { child_klass.constantize.find_where(self_klass => @id).first }
+        end
+      end
+    end
+  end
+end

data/lib/hypostasis/document/indexes.rb

@@ -3,6 +3,7 @@ module Hypostasis::Document
     extend ActiveSupport::Concern
 
     def indexed_fields_to_commit
+      self.class.class_eval { class_variable_set(:@@indexed_fields, []) unless class_variable_defined?(:@@indexed_fields) }
       self.class.indexed_fields.collect do |field_name|
         self.class.namespace.for_index(self, field_name, @fields[field_name])
       end
@@ -10,12 +11,16 @@ module Hypostasis::Document
 
     module ClassMethods
       def index(field_name, options = {})
-        @@indexed_fields = [] unless defined? @@indexed_fields
-        @@indexed_fields << field_name.to_sym
+        self.class_eval do
+          class_variable_set(:@@indexed_fields, []) unless class_variable_defined?(:@@indexed_fields)
+          registered_indexed_fields = class_variable_get(:@@indexed_fields)
+          registered_indexed_fields << field_name.to_sym
+          class_variable_set(:@@indexed_fields, registered_indexed_fields)
+        end
       end
 
       def indexed_fields
-        @@indexed_fields
+        self.class_eval { class_variable_get(:@@indexed_fields) }
       end
     end
   end

data/lib/hypostasis/document/namespaced.rb

@@ -0,0 +1,19 @@
+module Hypostasis::Document
+  module Namespaced
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def use_namespace(namespace)
+        data_model = :key_value
+        data_model = :document if self.included_modules.include?(Hypostasis::Document)
+        self.class_eval do
+          class_variable_set(:@@namespace, Hypostasis::Namespace.new(namespace.to_s, data_model))
+        end
+      end
+
+      def namespace
+        self.class_eval { class_variable_get(:@@namespace) }
+      end
+    end
+  end
+end

data/lib/hypostasis/document.rb

@@ -1,18 +1,26 @@
 require 'active_support/concern'
+require 'active_support/inflector'
 
+require 'hypostasis/document/namespaced'
 require 'hypostasis/document/fields'
 require 'hypostasis/document/indexes'
 require 'hypostasis/document/persistence'
 require 'hypostasis/document/findable'
+require 'hypostasis/document/belongs_to'
+require 'hypostasis/document/has_one'
 
 module Hypostasis::Document
   extend ActiveSupport::Concern
 
+  include Hypostasis::Document::Namespaced
   include Hypostasis::Document::Fields
   include Hypostasis::Document::Indexes
   include Hypostasis::Document::Persistence
   include Hypostasis::Document::Findable
 
+  include Hypostasis::Document::BelongsTo
+  include Hypostasis::Document::HasOne
+
   attr_reader :id
 
   def initialize(*attributes)
@@ -21,6 +29,7 @@ module Hypostasis::Document
     @fields = {}
     self.class.fields.each {|name| @fields[name] = nil}
     attributes.each {|hsh| hsh.each {|name, value| @fields[name.to_sym] = value}}
+    self
   end
 
   def generate_id
@@ -33,17 +42,5 @@ module Hypostasis::Document
 
   module ClassMethods
     include Hypostasis::DataModels::Utilities
-
-    def use_namespace(namespace)
-      @@namespace = Hypostasis::Namespace.new(namespace.to_s, :document)
-    end
-
-    def namespace
-      @@namespace
-    end
-
-    def supported_field_types
-      @@supported_field_types ||= %w{Fixnum Bignum String Integer Float Date DateTime Time Boolean}
-    end
   end
 end

data/lib/hypostasis/errors.rb

@@ -10,4 +10,5 @@ module Hypostasis::Errors
   class TupleExhausted < StandardError; end
   class UnknownValueType < StandardError; end
   class MustDefineFieldType < StandardError; end
+  class DocumentNotFound < StandardError; end
 end

data/lib/hypostasis/version.rb

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

data/provision.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+apt-get -y install curl git
+
+wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/1.0.1/foundationdb-clients_1.0.1-1_amd64.deb
+wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/1.0.1/foundationdb-server_1.0.1-1_amd64.deb
+
+sudo dpkg -i foundationdb-clients_1.0.1-1_amd64.deb foundationdb-server_1.0.1-1_amd64.deb
+
+sudo su - vagrant
+cd /home/vagrant
+\curl -sSL https://get.rvm.io | bash -s stable --ruby --gems=fdb
+source /usr/local/rvm/scripts/rvm
+
+cd /vagrant; bundle

data/test/document/has_one_spec.rb

@@ -0,0 +1,44 @@
+require 'minitest_helper'
+
+class HasOneOwnerDocument
+  include Hypostasis::Document
+
+  use_namespace 'hasone_docs'
+
+  field :name
+  field :age
+
+  has_one :has_one_child_document
+end
+
+class HasOneChildDocument
+  include Hypostasis::Document
+
+  use_namespace 'hasone_docs'
+
+  field :name
+  field :age
+
+  belongs_to :has_one_owner_document
+end
+
+describe 'Document has_one Relationship' do
+  before do
+    Hypostasis::Connection.create_namespace 'hasone_docs', data_model: :document
+    @owner = HasOneOwnerDocument.create(name: 'John', age: '25')
+    @child = HasOneChildDocument.create(name: 'James', age: '6', has_one_owner_document_id: @owner.id)
+  end
+
+  after do
+    Hypostasis::Connection.destroy_namespace 'hasone_docs'
+  end
+
+  it { @owner.must_respond_to :has_one_child_document }
+  it { @child.must_respond_to :has_one_owner_document }
+
+  it { @owner.has_one_child_document.is_a?(HasOneChildDocument).must_equal true }
+  it { @owner.has_one_child_document.id.must_equal @child.id }
+
+  it { @child.has_one_owner_document.is_a?(HasOneOwnerDocument).must_equal true }
+  it { @child.has_one_owner_document.id.must_equal @owner.id }
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: hypostasis
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - James Thompson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-25 00:00:00.000000000 Z
+date: 2014-01-28 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
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 5.2.0
 description: A layer for FoundationDB providing multiple data models for Ruby.
@@ -87,13 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- Vagrantfile
 - hypostasis.gemspec
 - lib/hypostasis.rb
 - lib/hypostasis/connection.rb
@@ -102,16 +103,21 @@ files:
 - lib/hypostasis/data_models/key_value.rb
 - lib/hypostasis/data_models/utilities.rb
 - lib/hypostasis/document.rb
+- lib/hypostasis/document/belongs_to.rb
 - lib/hypostasis/document/fields.rb
 - lib/hypostasis/document/findable.rb
+- lib/hypostasis/document/has_one.rb
 - lib/hypostasis/document/indexes.rb
+- lib/hypostasis/document/namespaced.rb
 - lib/hypostasis/document/persistence.rb
 - lib/hypostasis/errors.rb
 - lib/hypostasis/key_path.rb
 - lib/hypostasis/namespace.rb
 - lib/hypostasis/tuple.rb
 - lib/hypostasis/version.rb
+- provision.sh
 - test/connection_spec.rb
+- test/document/has_one_spec.rb
 - test/document_spec.rb
 - test/key_path_spec.rb
 - test/minitest_helper.rb
@@ -129,22 +135,23 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A layer for FoundationDB providing multiple data models for Ruby.
 test_files:
 - test/connection_spec.rb
+- test/document/has_one_spec.rb
 - test/document_spec.rb
 - test/key_path_spec.rb
 - test/minitest_helper.rb