hypostasis-repository 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 41927b984be679c93c5d3fd125c05aa56ba2fa7a
+  data.tar.gz: a54fe008d3bf333acd1759fd6db8a4a58177d166
+SHA512:
+  metadata.gz: 5c45b815f9f85f6e503e1680d2c7dedbcd03a4a6e22562aaf5c21629a109e4ac3c447eea313a79a7a683ee3922ec8bdf3b53078cfbba7a4d8b61a7a1a0e74208
+  data.tar.gz: cb24913d08fcbad16598067b0a94465f98218313ed7f882b25f813784d550cc4407a12db6386faa99cdd23eb4a45153308faa9c3bdf494039bb36366353ff2d6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+branches:
+  only:
+    - master
+    - /^feature\/.*/
+    - /-stable$/
+before_install:
+  - wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/2.0.5/foundationdb-clients_2.0.5-1_amd64.deb
+  - wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/2.0.5/foundationdb-server_2.0.5-1_amd64.deb
+  - sudo dpkg -i foundationdb-clients_2.0.5-1_amd64.deb
+  - sudo dpkg -i foundationdb-server_2.0.5-1_amd64.deb
+addons:
+   code_climate:
+     repo_token: 5d610888b8cd96749841452722fbdb2e50f2f3a469ca0febff9e8bd2a5dd22bc

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hypostasis-repository.gemspec
+gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil
+gem 'simplecov', '~> 0.7.1', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jamesthompson
+
+MIT License
+
+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/README.md

@@ -0,0 +1,37 @@
+# Hypostasis::Repository
+
+[![Build Status](https://travis-ci.org/hypostasis/repository.svg)](https://travis-ci.org/hypostasis/repository)
+[![Code Climate](https://codeclimate.com/github/hypostasis/repository.png)](https://codeclimate.com/github/hypostasis/repository)
+[![Code Coverage](https://codeclimate.com/github/hypostasis/repository/coverage.png)](https://codeclimate.com/github/hypostasis/repository/code)
+
+The Hypostasis::Repository project is intended to implement the Repository
+pattern from Martin Fowler's "Patterns of Enterprise Application Architecture"
+on top of FoundationDB. It includes two different storage strategies for the
+domain models it stores: sparse and messagepack. It also includes support for
+indexing and provides a means to customize mapping.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hypostasis-repository'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hypostasis-repository
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/hypostasis-repository/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+if system('vagrant --version > /dev/null 2>&1') && system('vagrant exec -h > /dev/null 2>&1')
+  desc 'Run specs within Vagrant'
+  task :vagrant_spec do
+    system 'vagrant exec rake spec'
+  end
+
+  task :default => :vagrant_spec
+else
+  task :default => :spec
+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, override|
+    override.vm.box_url = 'http://files.vagrantup.com/precise64.box'
+    #vb.memory = 4096
+  end
+
+  config.vm.provider :vmware_fusion do |vw, override|
+    override.vm.box = 'precise64_vmware'
+    override.vm.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/hypostasis-repository.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hypostasis/repository/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hypostasis-repository"
+  spec.version       = Hypostasis::Repository::VERSION
+  spec.authors       = ["James Thompson"]
+  spec.email         = ["james@plainprograms.com"]
+  spec.summary       = %q{Implements the Repository pattern on top of FoundationDB}
+  spec.description   = %q{Implements the Repository pattern on top of FoundationDB}
+  spec.homepage      = "https://github.com/hypostasis/repository"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "fdb", "~> 2.0.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+end

data/lib/hypostasis/repository.rb

@@ -0,0 +1,87 @@
+require "active_support/concern"
+require "fdb"
+require "securerandom"
+
+require "hypostasis/repository/version"
+
+module Hypostasis
+  module Repository
+    extend ActiveSupport::Concern
+
+    included do
+      # ...
+    end
+
+    def initialize
+      setup_hypostasis_configuration
+      open_hypostasis_directory
+      super
+    end
+
+    def store(object)
+      repo_id = generate_repository_id
+      object_space = @hypostasis_directory[object.class.to_s][repo_id]
+      object.instance_variable_set(:@hypostasis_repository_id, repo_id)
+      @hypostasis[:database].transact do |tr|
+        tr.clear_range_start_with(object_space)
+        object.instance_variables.each do |ivar|
+          next if ivar == :@hypostasis_repository_id
+          tr.set(object_space[ivar.to_s], object.instance_variable_get(ivar))
+        end
+      end
+      object
+    end
+
+    def find(klass, criteria)
+      if criteria.is_a?(String)
+        find_by_id(klass, criteria)
+      elsif criteria.is_a?(Hash)
+        # ...
+      else
+        raise ArgumentError, 'criteria must be a String or Hash'
+      end
+    end
+
+    private
+
+    def setup_hypostasis_configuration
+      ::FDB.api_version 200
+      instance_variable_set(:@hypostasis, {
+        database:  ::FDB.open,
+        namespace: self.class.class_variable_get(:@@namespace)
+      })
+    end
+
+    def open_hypostasis_directory
+      directory = ::FDB.directory.create_or_open(@hypostasis[:database], @hypostasis[:namespace])
+      instance_variable_set(:@hypostasis_directory, directory)
+    end
+
+    def generate_repository_id
+      SecureRandom.hex(16)
+    end
+
+    def find_by_id(klass, id)
+      object_id = id.encode(Encoding::US_ASCII)
+      object_space = @hypostasis_directory[klass.to_s][object_id]
+      results = @hypostasis[:database].get_range_start_with(object_space)
+      return nil if results.empty? || results.nil?
+
+      object = klass.new
+      object.instance_variable_set(:@hypostasis_repository_id, object_id)
+      results.each do |key|
+        ivar = object_space.unpack(key.key)[0].to_sym
+        object.instance_variable_set(ivar, key.value)
+      end
+
+      object
+    end
+
+    module ClassMethods
+      def use_namespace(namespace)
+        namespace = namespace.is_a?(Array) ? namespace : namespace.split('/')
+        class_variable_set(:@@namespace, namespace)
+      end
+    end
+  end
+end

data/lib/hypostasis/repository/version.rb

@@ -0,0 +1,5 @@
+module Hypostasis
+  module Repository
+    VERSION = "0.0.1"
+  end
+end

data/provision.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+apt-get update && apt-get upgrade
+apt-get -y install curl git
+
+wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/2.0.5/foundationdb-clients_2.0.5-1_amd64.deb
+wget https://foundationdb.com/downloads/I_accept_the_FoundationDB_Community_License_Agreement/2.0.5/foundationdb-server_2.0.5-1_amd64.deb
+
+sudo dpkg -i foundationdb-clients_2.0.5-1_amd64.deb foundationdb-server_2.0.5-1_amd64.deb
+
+sudo su - vagrant
+cd /home/vagrant
+\curl -sSL https://get.rvm.io | bash -s stable --ruby
+source /usr/local/rvm/scripts/rvm
+
+cd /vagrant; bundle install

data/spec/examples/simple_repository.rb

@@ -0,0 +1,15 @@
+class Simple
+  attr_accessor :name, :dob, :notes
+
+  def initialize(attributes = {})
+    @name = attributes[:name] unless attributes[:name].nil?
+    @dob = attributes[:dob] unless attributes[:dob].nil?
+    @notes = attributes[:notes] unless attributes[:notes].nil?
+  end
+end
+
+class SimpleRepository
+  include Hypostasis::Repository
+
+  use_namespace 'simple/repository'
+end

data/spec/hypostasis/repository_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Hypostasis::Repository do
+  it 'should have a version number' do
+    Hypostasis::Repository::VERSION.should_not be_nil
+  end
+end

data/spec/hypostasis/simple_repository_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'examples/simple_repository'
+
+describe SimpleRepository do
+  let(:database) { ::FDB.open }
+  let(:directory) { ::FDB.directory.open(database, %w{simple repository}) }
+
+  let(:subject) { SimpleRepository.new }
+  let(:object) { Simple.new(name: 'John', dob: '1982-05-19', notes: 'An example') }
+
+  before :each do
+    subject
+  end
+
+  after :each do
+    ::FDB.directory.remove_if_exists(database, %w{simple repository})
+  end
+
+  it 'opening directory should not raise exception' do
+    expect { directory }.not_to raise_exception
+  end
+
+  it 'directory should exist' do
+    ::FDB.directory.exists?(database, %w{simple repository}).should be_true
+  end
+
+  describe 'storage' do
+    let(:result) { subject.store(object) }
+
+    before :each do
+      result
+      @id = object.instance_variable_get(:@hypostasis_repository_id).encode(Encoding::US_ASCII)
+    end
+
+    it { database.get(directory[object.class.to_s][@id][:@name.to_s]).value.should eq 'John' }
+    it { database.get(directory[object.class.to_s][@id][:@dob.to_s]).value.should eq '1982-05-19' }
+    it { database.get(directory[object.class.to_s][@id][:@notes.to_s]).value.should eq 'An example' }
+    it { database.get(directory[object.class.to_s][@id][:@hypostasis_repository_id.to_s]).should be_nil }
+    it { result.should eq object }
+  end
+
+  describe 'find with id' do
+    let(:result) { subject.find(Simple, @id) }
+
+    before :each do
+      subject.store(object)
+      @id = object.instance_variable_get(:@hypostasis_repository_id).encode(Encoding::US_ASCII)
+    end
+
+    it { result.class.should eq Simple }
+    it { result.instance_variable_get(:@hypostasis_repository_id).should eq @id }
+    it { result.name.should eq 'John' }
+    it { result.dob.should eq '1982-05-19' }
+    it { result.notes.should eq 'An example' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+if ENV['CI']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hypostasis/repository'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: hypostasis-repository
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  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: fdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Implements the Repository pattern on top of FoundationDB
+email:
+- james@plainprograms.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- hypostasis-repository.gemspec
+- lib/hypostasis/repository.rb
+- lib/hypostasis/repository/version.rb
+- provision.sh
+- spec/examples/simple_repository.rb
+- spec/hypostasis/repository_spec.rb
+- spec/hypostasis/simple_repository_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/hypostasis/repository
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Implements the Repository pattern on top of FoundationDB
+test_files:
+- spec/examples/simple_repository.rb
+- spec/hypostasis/repository_spec.rb
+- spec/hypostasis/simple_repository_spec.rb
+- spec/spec_helper.rb