relaxo 1.2.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0001153bcb2843832dc1f6ad29e49885db98729d
-  data.tar.gz: 0e065a359e1ae3f0ff21ecc1848b2189f3f5345e
+SHA256:
+  metadata.gz: ee389a32f25fdf49c2a4ce9e347b8f75f865e99027836fe960029a97b614886c
+  data.tar.gz: 7fb8ea8ad158e7cd244dba5ab7ef5b0b94b02a4207a5be4090a131ccf4b0a51b
 SHA512:
-  metadata.gz: 768562aeadc873bdd50df1a49ef3a455f64d9a6bc56d2edb4fcf5fe0876e46b6a83f137a677df3faac8cac46aa3da8dc4b6eff91157fc152f0478e621e93922b
-  data.tar.gz: f88b84ef0e018606ef3696688755315d6fd0092fb201de2e76186b5cd1606b8162f72cadf32650dad2513767850e36eadd8af7028722b74aef5ae4d5c9c98ec4
+  metadata.gz: 549af3e6849d9a99a86415201e2b6126f0a76f2fa8f7b27ebc7e2af0a9b1750be40efb24b14fdc8fa04fb4a49a1daaa5f6b9dbcb395e960d18fc0c3308a1c6ff
+  data.tar.gz: 50ab5e3e2f2fde0643c276729e9954da0ade6027e597490e950f3fdc95849d9c208b32da1139fb218c49198444b6147311e6e9c7a8b0937dc7e142a6fe92e293

data/lib/relaxo.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,18 +20,35 @@
 
 require 'relaxo/database'
 
-require 'pry'
+require 'etc'
+require 'socket'
 
 module Relaxo
-	def self.connect(path, metadata = {})
+	MASTER = 'master'.freeze
+	
+	def self.connect(path, branch: nil, sync: nil, **metadata)
 		unless File.exist?(path)
 			repository = Rugged::Repository.init_at(path, true)
 			
-			if metadata[:sync] || ENV['RELAXO_SYNC']
+			if sync || ENV['RELAXO_SYNC']
 				repository.config['core.fsyncObjectFiles'] = true
 			end
 		end
 		
-		return Database.new(path, metadata)
+		branch ||= MASTER
+		
+		database = Database.new(path, branch, metadata)
+		
+		if config = database.config
+			unless config['user.name']
+				login = Etc.getlogin
+				hostname = Socket.gethostname
+				
+				config['user.name'] = login
+				config['user.email'] = "#{login}@#{hostname}"
+			end
+		end
+		
+		return database
 	end
 end

data/lib/relaxo/changeset.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/relaxo/database.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,8 +19,8 @@
 # THE SOFTWARE.
 
 require 'rugged'
-require 'logger'
 
+require_relative 'logger'
 require_relative 'dataset'
 require_relative 'changeset'
 
@@ -28,29 +28,48 @@ module Relaxo
 	HEAD = 'HEAD'.freeze
 	
 	class Database
-		def initialize(path, metadata = {})
+		def initialize(path, branch, metadata = {})
 			@path = path
 			@metadata = metadata
 			
-			@logger = metadata[:logger] || Logger.new($stderr).tap{|logger| logger.level = Logger::INFO}
-			
 			@repository = Rugged::Repository.new(path)
+			# @repository.config['core.fsyncObjectFiles'] = fsync
+			
+			@branch = branch
+		end
+		
+		def config
+			@repository.config
 		end
 		
 		attr :path
 		attr :metadata
 		attr :repository
 		
+		# Completely clear out the database.
+		def clear!
+			if head = @repository.branches[@branch]
+				@repository.references.delete(head)
+			end
+		end
+		
 		def empty?
 			@repository.empty?
 		end
 		
+		def head
+			@repository.branches[@branch]
+		end
+		
 		def [] key
 			@metadata[key]
 		end
 		
 		# During the execution of the block, changes don't get stored immediately, so reading from the dataset (from outside the block) will continue to return the values that were stored in the configuration when the transaction was started.
+		# @return the result of the block.
 		def commit(**options)
+			result = nil
+			
 			track_time(options[:message]) do
 				catch(:abort) do
 					begin
@@ -58,10 +77,12 @@ module Relaxo
 						
 						changeset = Changeset.new(@repository, tree)
 						
-						yield changeset
+						result = yield changeset
 					end until apply(parent, changeset, **options)
 				end
 			end
+			
+			return result
 		end
 		
 		# Efficient point-in-time read-only access.
@@ -113,7 +134,7 @@ module Relaxo
 			end_time = Time.now
 			elapsed_time = end_time - start_time
 			
-			@logger.debug("time") {"#{message.inspect}: %0.3fs" % elapsed_time}
+			Relaxo.logger.debug(self) {"#{message.inspect}: %0.3fs" % elapsed_time}
 		end
 		
 		def apply(parent, changeset, **options)
@@ -121,7 +142,7 @@ module Relaxo
 			
 			options[:tree] = changeset.write_tree
 			options[:parents] ||= [parent]
-			options[:update_ref] ||= HEAD
+			options[:update_ref] ||= "refs/heads/#{@branch}"
 			
 			begin
 				Rugged::Commit.create(@repository, options)
@@ -131,13 +152,11 @@ module Relaxo
 		end
 		
 		def latest_commit
-			if head = @repository.head
+			if head = self.head
 				return head.target, head.target.tree
 			else
 				return nil, empty_tree
 			end
-		rescue Rugged::ReferenceError
-			return nil, empty_tree
 		end
 		
 		def empty_tree

data/lib/relaxo/dataset.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/relaxo/{schema.rb → logger.rb}

@@ -1,4 +1,4 @@
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -18,32 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require 'yaml'
+require 'console'
 
 module Relaxo
-	class Schema
-		def initialize(document)
-			@document = document
-		end
-		
-		def self.load_file(schema_path)
-			self.new(YAML.load_file(schema_path))
-		end
-		
-		def id
-			@document[ID]
-		end
-		
-		def migrate(db)
-			if db.id?(self.id)
-				if existing_document = GeoZone::DB.get(self.id)
-					@document[Relaxo::REV] = existing_document[Relaxo::REV]
-				end
-			end
-
-			if existing_document != @document
-				db.save(@document)
-			end
-		end
-	end
+	extend Console
 end

data/lib/relaxo/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Relaxo
-	VERSION = "1.2.0"
+	VERSION = "1.6.1"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: relaxo
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2020-06-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -25,35 +39,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bake-bundler
+  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: bake-modernize
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: covered
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,44 +108,53 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\t\tRelaxo provides a set of tools and interfaces for interacting with
-  CouchDB.\n\t\tIt aims to be as simple and efficient as possible while still improving
-  the\n\t\tusability of various CouchDB features.\n"
-email:
-- samuel.williams@oriontransfer.co.nz
-executables:
-- relaxo
-- relaxo-admin
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  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: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: 
+email: 
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
-- bin/relaxo
-- bin/relaxo-admin
+- lib/.DS_Store
 - lib/relaxo.rb
 - lib/relaxo/changeset.rb
 - lib/relaxo/database.rb
 - lib/relaxo/dataset.rb
 - lib/relaxo/directory.rb
-- lib/relaxo/schema.rb
+- lib/relaxo/logger.rb
 - lib/relaxo/version.rb
-- relaxo.gemspec
-- spec/relaxo/changeset_spec.rb
-- spec/relaxo/concurrency_spec.rb
-- spec/relaxo/database_spec.rb
-- spec/relaxo/enumeration_spec.rb
-- spec/relaxo/performance_spec.rb
-- spec/relaxo/test_records.rb
-- spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/ioquatix/relaxo
 licenses:
 - MIT
-metadata: {}
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,23 +163,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Relaxo is a helper for loading and working with CouchDB.
-test_files:
-- spec/relaxo/changeset_spec.rb
-- spec/relaxo/concurrency_spec.rb
-- spec/relaxo/database_spec.rb
-- spec/relaxo/enumeration_spec.rb
-- spec/relaxo/performance_spec.rb
-- spec/relaxo/test_records.rb
-- spec/spec_helper.rb
+summary: Relaxo is versioned document database built on top of git.
+test_files: []

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,4 +0,0 @@
---format documentation
---backtrace
---warnings
---require spec_helper

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-sudo: false
-dist: trusty
-cache: bundler
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - ruby-head
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: "ruby-head"
-    - rvm: "jruby-head"

data/Gemfile

@@ -1,20 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in relaxo.gemspec
-gemspec
-
-gem 'rugged', git: 'https://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!

data/relaxo.gemspec

@@ -1,30 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'relaxo/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "relaxo"
-	spec.version       = Relaxo::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	spec.description   = <<-EOF
-		Relaxo provides a set of tools and interfaces for interacting with CouchDB.
-		It aims to be as simple and efficient as possible while still improving the
-		usability of various CouchDB features.
-	EOF
-	spec.summary       = %q{Relaxo is a helper for loading and working with CouchDB.}
-	spec.homepage      = ""
-	spec.license       = "MIT"
-
-	spec.files         = `git ls-files`.split($/)
-	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_dependency "rugged"
-	
-	spec.add_development_dependency "rspec", "~> 3.6"
-	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rake"
-end

data/spec/relaxo/changeset_spec.rb

@@ -1,39 +0,0 @@
-
-require_relative 'test_records'
-
-RSpec.describe Relaxo::Changeset do
-	include_context "test records"
-	
-	it "should enumerate all documents including writes" do
-		records = []
-		
-		database.commit(message: "Testing Enumeration") do |dataset|
-			5.times do |i|
-				object = dataset.append("extra-#{i}")
-				dataset.write("#{prefix}/extra-#{i}", object)
-			end
-			
-			expect(dataset.exist?("#{prefix}/extra-0")).to be_truthy
-			
-			records = dataset.each(prefix).to_a
-		end
-		
-		expect(records.count).to be 25
-	end
-	
-	it "should enumerate all documents excluding deletes" do
-		records = []
-		
-		database.commit(message: "Testing Enumeration") do |dataset|
-			5.times do |i|
-				dataset.delete("#{prefix}/#{i}")
-			end
-			
-			expect(dataset.exist?("#{prefix}/0")).to be_falsey
-			
-			records = dataset.each(prefix).to_a
-		end
-		
-		expect(records.count).to be 15
-	end
-end

data/spec/relaxo/concurrency_spec.rb

@@ -1,39 +0,0 @@
-
-require_relative 'test_records'
-
-RSpec.describe Relaxo::Changeset do
-	include_context "test records"
-	
-	it "should detect conflicts" do
-		events = []
-		
-		alice = Fiber.new do
-			database.commit(message: "Alice Data") do |changeset|
-				events << :alice
-				
-				object = changeset.append("sample-data-1")
-				changeset.write("conflict-path", object)
-				
-				Fiber.yield
-			end
-		end
-		
-		bob = Fiber.new do
-			database.commit(message: "Bob Data") do |changeset|
-				events << :bob
-				
-				object = changeset.append("sample-data-1")
-				changeset.write("conflict-path", object)
-				
-				Fiber.yield
-			end
-		end
-		
-		alice.resume
-		bob.resume
-		alice.resume
-		bob.resume
-		
-		expect(events).to be == [:alice, :bob, :bob]
-	end
-end

data/spec/relaxo/database_spec.rb

@@ -1,103 +0,0 @@
-
-require 'relaxo'
-
-RSpec.describe Relaxo::Database do
-	let(:database_path) {File.join(__dir__, 'test')}
-	
-	let(:database) {Relaxo.connect(database_path, test_key: "test_value")}
-	
-	let(:document_path) {'test/document.json'}
-	let(:sample_json) {'[1, 2, 3]'}
-	
-	before(:each) {FileUtils.rm_rf(database_path)}
-	
-	it "should be initially empty" do
-		expect(database).to be_empty
-	end
-	
-	it "should not be empty with one document" do
-		database.commit(message: "Create test document") do |dataset|
-			oid = dataset.append(sample_json)
-			dataset.write(document_path, oid)
-		end
-		
-		expect(database).to_not be_empty
-	end
-	
-	it "should have metadata" do
-		expect(database[:test_key]).to be == "test_value"
-	end
-	
-	it "should create a document" do
-		database.commit(message: "Create test document") do |dataset|
-			oid = dataset.append(sample_json)
-			dataset.write(document_path, oid)
-		end
-		
-		database.current do |dataset|
-			expect(dataset[document_path].data).to be == sample_json
-		end
-	end
-	
-	it "should erase a document" do
-		database.commit(message: "Create test document") do |dataset|
-			oid = dataset.append(sample_json)
-			dataset.write(document_path, oid)
-		end
-		
-		database.commit(message: "Delete test document") do |dataset|
-			dataset.delete(document_path)
-		end
-		
-		database.current do |dataset|
-			expect(dataset[document_path]).to be nil
-		end
-	end
-	
-	it "should create multiple documents" do
-		database.commit(message: "Create first document") do |dataset|
-			oid = dataset.append(sample_json)
-			dataset.write(document_path, oid)
-		end
-		
-		database.commit(message: "Create second document") do |dataset|
-			oid = dataset.append(sample_json)
-			dataset.write(document_path + '2', oid)
-		end
-		
-		database.current do |dataset|
-			expect(dataset[document_path].data).to be == sample_json
-			expect(dataset[document_path + '2'].data).to be == sample_json
-		end
-	end
-	
-	it "can enumerate documents" do
-		database.commit(message: "Create first document") do |dataset|
-			oid = dataset.append(sample_json)
-			
-			10.times do |id|
-				dataset.write(document_path + "-#{id}", oid)
-			end
-		end
-		
-		database.current do |dataset|
-			expect(dataset.each('test').count).to be == 10
-		end
-	end
-	
-	it "can enumerate commit history of a document" do
-		10.times do |id|
-			database.commit(message: "revising the document #{id}") do |changeset|
-				oid = changeset.append("revision \##{id} of this document")
-				changeset.write('test/doot.txt', oid)
-			end
-		end
-		
-		database.commit(message: "unrelated commit") do |changeset|
-			oid = changeset.append("unrelated document")
-			changeset.write('test/unrelated.txt', oid)
-		end
-		
-		expect(database.history('test/doot.txt').count).to be == 10
-	end
-end

data/spec/relaxo/enumeration_spec.rb

@@ -1,30 +0,0 @@
-
-require_relative 'test_records'
-
-RSpec.describe Relaxo::Dataset do
-	include_context "test records"
-	
-	it "should enumerate all documents" do
-		records = []
-		
-		database.current do |dataset|
-			records = dataset.each(prefix).to_a
-		end
-		
-		expect(records.count).to be 20
-	end
-end
-
-RSpec.describe Relaxo::Changeset do
-	include_context "test records"
-	
-	it "should enumerate all documents" do
-		records = []
-		
-		database.commit(message: "Testing Enumeration") do |dataset|
-			records = dataset.each(prefix).to_a
-		end
-		
-		expect(records.count).to be 20
-	end
-end

data/spec/relaxo/performance_spec.rb

@@ -1,78 +0,0 @@
-
-require 'benchmark/ips' if ENV['BENCHMARK']
-require 'ruby-prof' if ENV['PROFILE']
-require 'flamegraph' if ENV['FLAMEGRAPH']
-
-RSpec.describe "Relaxo Performance" do
-	let(:database_path) {File.join(__dir__, 'test')}
-	let(:database) {Relaxo.connect(database_path)}
-	
-	if defined? Benchmark
-		def benchmark(name = nil)
-			Benchmark.ips do |benchmark|
-				# Collect more data for benchmark:
-				benchmark.time = 20
-				benchmark.warmup = 10
-				
-				benchmark.report(name) do |i|
-					yield i
-				end
-				
-				benchmark.compare!
-			end
-		end
-	elsif defined? RubyProf
-		def benchmark(name)
-			result = RubyProf.profile do
-				yield 1000
-			end
-			
-			#result.eliminate_methods!([/^((?!Utopia).)*$/])
-			printer = RubyProf::FlatPrinter.new(result)
-			printer.print($stderr, min_percent: 1.0)
-			
-			printer = RubyProf::GraphHtmlPrinter.new(result)
-			filename = name.gsub('/', '_') + '.html'
-			File.open(filename, "w") do |file|
-				printer.print(file)
-			end
-		end
-	elsif defined? Flamegraph
-		def benchmark(name)
-			filename = name.gsub('/', '_') + '.html'
-			Flamegraph.generate(filename) do
-				yield 1
-			end
-		end
-	else
-		def benchmark(name)
-			yield 1
-		end
-	end
-	
-	before(:each) do
-		FileUtils.rm_rf(database_path)
-	end
-	
-	it "single transaction should be fast" do
-		benchmark("single") do |iterations|
-			database.commit(message: "Some Documents") do |dataset|
-				iterations.times do |i|
-					object = dataset.append("good-#{i}")
-					dataset.write("#{i%100}/#{i}", object)
-				end
-			end
-		end
-	end
-	
-	it "multiple transactions should be fast" do
-		benchmark("multiple") do |iterations|
-			iterations.times do |i|
-				database.commit(message: "Some Documents") do |dataset|
-					object = dataset.append("good-#{i}")
-					dataset.write("#{i%100}/#{i}", object)
-				end
-			end
-		end
-	end
-end

data/spec/relaxo/test_records.rb

@@ -1,25 +0,0 @@
-
-require 'relaxo'
-
-RSpec.shared_context "test records" do
-	let(:database_path) {File.join(__dir__, 'test')}
-	let(:database) {Relaxo.connect(database_path)}
-	
-	let(:prefix) {"records"}
-	
-	before(:each) do
-		FileUtils.rm_rf(database_path)
-		
-		database.commit(message: "Create Sample Data") do |dataset|
-			20.times do |i|
-				object = dataset.append("good-#{i}")
-				dataset.write("#{prefix}/#{i}", object)
-			end
-			
-			10.times do |i|
-				object = dataset.append("bad-#{i}")
-				dataset.write("#{prefix}/subdirectory/#{i}", object)
-			end
-		end
-	end
-end

data/spec/spec_helper.rb

@@ -1,29 +0,0 @@
-
-if ENV['COVERAGE'] || ENV['TRAVIS']
-	begin
-		require 'simplecov'
-		
-		SimpleCov.start do
-			add_filter "/spec/"
-		end
-		
-		if ENV['TRAVIS']
-			require 'coveralls'
-			Coveralls.wear!
-		end
-	rescue LoadError
-		warn "Could not load simplecov: #{$!}"
-	end
-end
-
-require "bundler/setup"
-require "relaxo"
-
-RSpec.configure do |config|
-	# Enable flags like --only-failures and --next-failure
-	config.example_status_persistence_file_path = ".rspec_status"
-
-	config.expect_with :rspec do |c|
-		c.syntax = :expect
-	end
-end