relaxo 1.0.1 → 1.6.0

data/.gitignore

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

data/.rspec

@@ -1,3 +0,0 @@
---color 
---format documentation 
---warnings

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-sudo: false
-before_install:
-  # For testing purposes:
-  - git config --global user.name "Samuel Williams"
-  - git config --global user.email "samuel@oriontransfer.net"
-rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.1
-  - 2.4.0
-  - rbx-2
-env: COVERAGE=true BENCHMARK=true
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: "rbx-2"

data/Gemfile

@@ -1,20 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in relaxo.gemspec
-gemspec
-
-gem 'rugged', git: 'git://github.com/libgit2/rugged.git', submodules: true
-
-group :development do
-	gem "pry"
-	gem "msgpack"
-end
-
-group :test do
-	gem 'benchmark-ips'
-	gem 'ruby-prof'
-	
-	gem 'rack-test'
-	gem 'simplecov'
-	gem 'coveralls', require: false
-end

data/README.md

@@ -1,150 +0,0 @@
-# Relaxo
-
-Relaxo is a transactional database built on top of git. It's aim is to provide a robust interface for document storage and sorted indexes.
-
-[![Build Status](https://secure.travis-ci.org/ioquatix/relaxo.svg)](http://travis-ci.org/ioquatix/relaxo)
-[![Code Climate](https://codeclimate.com/github/ioquatix/relaxo.svg)](https://codeclimate.com/github/ioquatix/relaxo)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/relaxo/badge.svg)](https://coveralls.io/r/ioquatix/relaxo)
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-	gem 'relaxo'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install relaxo
-
-## Usage
-
-Connect to a local database and manipulate some documents.
-
-	require 'relaxo'
-	require 'msgpack'
-	
-	DB = Relaxo.connect("test")
-	
-	DB.commit(message: "Create test data") do |dataset|
-		object = dataset.append(MessagePack.dump({bob: 'dole'}))
-		dataset.write("doc1.json", object)
-	end
-	
-	DB.commit(message: "Update test data") do |dataset|
-		doc = MessagePack.load dataset.read('doc1.json').data
-		doc[:foo] = 'bar'
-		
-		object = dataset.append(MessagePack.dump(doc))
-		dataset.write("doc2.json", object)
-	end
-	
-	doc = MessagePack.load DB.current['doc2.json'].data
-	puts doc
-	# => {"bob"=>"dole", "foo"=>"bar"}
-
-### Document Storage
-
-Relaxo uses the git persistent data structure for storing documents. This data structure exposes a file-system like interface, which stores any kind of data. This means that you are free to use JSON, or BSON, or MessagePack, or JPEG, or XML, or any combination of those.
-
-Relaxo has a transactional model for both reading and writing.
-
-#### Reading Files
-
-	path = "path/to/document"
-	
-	DB.current do |dataset|
-		object = dataset.read(path)
-		
-		puts "The object id: #{object.oid}"
-		puts "The object data size: #{object.size}"
-		puts "The object data: #{object.data.inspect}"
-	end
-
-#### Writing Files
-
-	path = "path/to/document"
-	data = MessagePack.dump(document)
-	
-	DB.commit(message: "Adding document") do |changeset|
-		object = changeset.append(data)
-		changeset.write(path, object)
-	end
-	
-### Datasets and Transactions
-
-`Dataset`s and `Changeset`s are important concepts. Relaxo doesn't allow arbitrary access to data, but instead exposes the git persistent model for both reading and writing. The implications of this are that when reading or writing, you always see a consistent snapshot of the data store.
-
-### Suitability
-
-Relaxo is designed to scale to the hundreds of thousands of documents. It's designed around the git persistent data store, and therefore has some performance and concurrency limitations due to the underlying implementation.
-
-Because it maintains a full history of all changes, the repository would continue to grow over time by default, but there are mechanisms to deal with that.
-
-#### Performance
-
-Relaxo can do anywhere from 1000-10,000 inserts per second depending on how you structure the workload.
-
-	Relaxo Performance
-	Warming up --------------------------------------
-	              single   129.000  i/100ms
-	Calculating -------------------------------------
-	              single      6.224k (±14.7%) i/s -    114.036k in  20.000025s
-	  single transaction should be fast
-	Warming up --------------------------------------
-	            multiple   152.000  i/100ms
-	Calculating -------------------------------------
-	            multiple      1.452k (±15.2%) i/s -     28.120k in  20.101831s
-	  multiple transactions should be fast
-
-Reading data is lighting fast as it's loaded directly from disk and cached.
-
-### Loading Data
-
-As Relaxo is unapologetically based on git, you can use git directly with a non-bare working directory to add any files you like. You can even point Relaxo at an existing git repository.
-
-### Durability
-
-Relaxo is based on `libgit2` and asserts that it is a transactional database. We base this assertion on:
-
-- All writes into the object store using `libgit2` are atomic and synchronized to disk.
-- All updates to refs are atomic and synchronized to disk.
-
-Provided these two invariants are maintained, the operation of Relaxo will be safe, even if there are unexpected interruptions to the program.
-
-The durability guarantees of Relaxo depend on [`libgit2` calling `fsync`](https://github.com/libgit2/libgit2/pull/4030), and [this being respected by the underlying hardware](http://www.evanjones.ca/intel-ssd-durability.html). Otherwise, durability cannot be guaranteed.
-
-## Contributing
-
-1. Fork it
-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
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2015, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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/Rakefile

@@ -1,20 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-	task.rspec_opts = ["--require", "simplecov"] if ENV['COVERAGE']
-end
-
-task :default => :spec
-
-task :console do
-	require 'pry'
-	require 'msgpack'
-	require 'securerandom'
-	
-	require_relative 'lib/relaxo'
-	
-	DB = Relaxo.connect(File.join(__dir__, '/tmp/relaxo-test-db'))
-	
-	Pry.start
-end

data/bin/relaxo

@@ -1,142 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'relaxo'
-require 'relaxo/version'
-require 'optparse'
-require 'yaml'
-require 'csv'
-
-OPTIONS = {
-	:existing => :update, # :merge, :replace
-	:format => :yaml,
-	:transaction => true,
-}
-
-module Formats
-	def self.yaml(io, &block)
-		documents = YAML::load(io)
-
-		unless Array === documents
-			documents = [documents]
-		end
-		
-		documents.each &block
-	end
-	
-	def self.csv(io, &block)
-		csv = CSV.new(io, :headers => :first_row)
-		
-		csv.each do |row|
-			yield row.to_hash
-		end
-	end
-end
-
-ARGV.options do |o|
-	script_name = File.basename($0)
-	
-	o.banner = "Usage: #{script_name} [options] [server-url] [files]"
-	o.define_head "This script can be used to import data to CouchDB."
-
-	o.separator ""
-	o.separator "Document creation:"
-
-	o.on("--existing [mode]", "Control whether to 'update (new document attributes takes priority), 'merge' (existing document attributes takes priority) or replace (old document attributes discarded) existing documents.") do |mode|
-		OPTIONS[:existing] = mode.to_sym
-	end
-
-	o.on("--format [type]", "Control the input format. 'yaml' files are imported as a single document or array of documents. 'csv' files are imported as records using the first row as attribute keys.") do |format|
-		OPTIONS[:format] = format.to_sym
-	end
-
-	o.on("--[no-]transaction", "Controls whether data is saved using the batch save operation. Not suitable for huge amounts of data.")
-
-	o.separator ""
-	o.separator "Help and Copyright information:"
-
-	o.on_tail("--copy", "Display copyright and warranty information") do
-		$stderr.puts "#{script_name} v#{Relaxo::VERSION}. Copyright (c) 2012 Samuel Williams."
-		$stderr.puts "This software is released under the MIT license and comes with ABSOLUTELY NO WARRANTY."
-		exit
-	end
-
-	o.on_tail("-h", "--help", "Show this help message.") do
-		$stderr.puts o
-		exit
-	end
-end.parse!
-
-url = ARGV.shift
-
-$stderr.puts "Connecting to #{url}..."
-database = Relaxo.connect(url)
-
-begin
-	info = database.info
-	
-	$stderr.puts "Connected to #{info['db_name']} which contains #{info['doc_count']} document(s)."
-rescue StandardError => error
-	$stderr.puts "Could not fetch info from database server!"
-	
-	throw
-end
-
-
-format = Formats.method(OPTIONS[:format])
-
-@stats = {
-	:saved => 0,
-	:errors => 0,
-	:total => 0
-}
-
-def process_document(database, document)
-	begin
-		existing_document = nil
-		
-		if document && document[Relaxo::ID]
-			$stderr.puts "Loading #{document[Relaxo::ID]}"
-			existing_document = database.get(document[Relaxo::ID]) rescue nil
-		end
-		
-		if existing_document
-			if OPTIONS[:existing] == :replace
-				$stderr.puts "Replacing existing document..."
-				# The document is replaced entirely with the incoming data.
-				document[Relaxo::REV] = existing_document[Relaxo::REV]
-			elsif OPTIONS[:existing] == :update
-				$stderr.puts "Updating existing document..."
-				# Values in `existing_document` take priority
-				document.update(existing_document)
-			elsif OPTIONS[:existing] == :merge
-				$stderr.puts "Merging existing document..."
-				# Values in `document` take priority, except for `_rev`.
-				document.update(existing_document) do |key, oldval, newval|
-					key == Relaxo::REV ? newval : oldval
-				end
-			end
-		end
-		
-		$stderr.puts "Saving #{document.inspect}"
-		result = database.save(document)
-		
-		@stats[:saved] += 1
-	rescue RestClient::BadRequest => ex
-		$stderr.puts ex.inspect
-		
-		@stats[:errors] += 1
-	end
-	
-	@stats[:total] += 1
-end
-
-begin
-	format.call(ARGF) do |document|
-		process_document(database, document)
-	end
-ensure
-	$stderr.puts "#{@stats[:saved]} document(s) saved out of #{@stats[:total]}."
-	if @stats[:errors] > 0
-		$stderr.puts "#{@stats[:errors]} errors occurred!"
-	end
-end

data/bin/relaxo-admin

@@ -1,61 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'relaxo'
-require 'relaxo/version'
-require 'optparse'
-require 'digest/sha1'
-
-$url = ARGV.shift unless ARGV[0] =~ /^-/
-$connection = Relaxo::Connection.new($url)
-
-OPTIONS = {
-	:roles => [],
-	:password => nil
-}
-
-ARGV.options do |o|
-	script_name = File.basename($0)
-	
-	o.banner = "Usage: #{script_name} [server-url] [options]"
-	o.define_head "This script can be used to import data to CouchDB."
-
-	o.on("--password password", "Specify the password for a new user") do |password|
-		OPTIONS[:password] = password
-	end
-
-	o.on("--roles reader,writer", Array, "Specify the roles for a new user") do |roles|
-		OPTIONS[:roles] = roles
-	end
-
-	o.on("--create-user name", "Create a new (non-admin) user") do |name|
-		password = OPTIONS[:password]
-		
-		salt = Digest::SHA1.hexdigest(rand.to_s + name + Time.now.to_s + password)
-		
-		user = {
-			Relaxo::ID => "org.couchdb.user:#{name}",
-			:type => "user",
-			:name => name,
-			:roles => OPTIONS[:roles],
-			:salt => salt,
-			:password_sha => Digest::SHA1.hexdigest(password + salt)
-		}
-		
-		database = Relaxo::Database.new($connection, "_users")
-		puts database.save(user).inspect
-	end
-
-	o.separator ""
-	o.separator "Help and Copyright information:"
-
-	o.on_tail("--copy", "Display copyright and warranty information") do
-		$stderr.puts "#{script_name} v#{Relaxo::VERSION}. Copyright (c) 2012 Samuel Williams."
-		$stderr.puts "This software is released under the MIT license and comes with ABSOLUTELY NO WARRANTY."
-		exit
-	end
-
-	o.on_tail("-h", "--help", "Show this help message.") do
-		$stderr.puts o
-		exit
-	end
-end.parse!