relaxo 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9717e7374491be200281a28c52e54779a227015
-  data.tar.gz: b35bd9c406790b3660bb74865d481a5c4eefa42e
+  metadata.gz: 64d93992b8989b3da2ea1d3538d65bec9803a556
+  data.tar.gz: e559ca748c9c1b13acf35980fa31d8152a2a456d
 SHA512:
-  metadata.gz: 20fd23a6cb298e4fcfe8fff4d85e7fa1723f58c6ccad262086d61b55c574dfa94ae70c989257378a0ec2f7332861e0bc1c7fde56e28265c4a70adb20718f9dd2
-  data.tar.gz: cffb68a2e4db2c1b3a7345f2016b9910a2e61264bbd211385af2beeb37f6390c3a68321ee1d7269f62e8926c657b9bbd91ca4402ad9fc09e1d8bb15d2247761a
+  metadata.gz: efd8db9bc3dc670ff3db9f44a517bb2c64a786b9a07363bcb2f232c49060fef0b1b393d8e37437a3cbc7f554238486e1dd9ef0a2945a0942965c60308b1e2ddd
+  data.tar.gz: 7d37db1c92596301d4ef68121b05cd162c20fb2d9ab6fe46a93117f3b7a79fa6e0ca1bcc70c0649a80d4f2cbb3a6c4f5159126f6b95455a2c23d535ad96f947e

data/.simplecov

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

data/README.md

@@ -3,7 +3,8 @@
 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.
 
 [![Build Status](https://secure.travis-ci.org/ioquatix/relaxo.png)](http://travis-ci.org/ioquatix/relaxo)
-
+[![Code Climate](https://codeclimate.com/github/ioquatix/relaxo.png)](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:
@@ -57,7 +58,7 @@ Sessions support a very similar interface to the main database class and can for
 
 All documents will allocated UUIDs appropriately and at the end of the session block they will be updated (saved or deleted) using CouchDB `_bulk_save`. The Transactions interface doesn't support any kind of interaction with the server and thus views won't be updated until after the transaction is complete.
 
-To abort the session, either raise an exception or call `session.abort!` which is equivalent to `throw :abort`.
+To abort the session, either raise an exception or call `transaction.abort!` which is equivalent to `throw :abort`.
 
 ### Loading Data
 
@@ -110,7 +111,7 @@ If your requirements are more complex, consider writing a custom script either t
 
 Released under the MIT license.
 
-Copyright, 2012, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+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

data/Rakefile

@@ -0,0 +1,8 @@
+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

data/lib/relaxo/attachments.rb

@@ -20,11 +20,7 @@
 
 require 'relaxo/database'
 
-if RUBY_VERSION < "1.9"
-	require 'relaxo/base64-1.8'
-else
-	require 'base64'
-end
+require 'base64'
 
 module Relaxo
 	ATTACHMENTS = '_attachments'

data/lib/relaxo/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Relaxo
-	VERSION = "0.4.3"
+	VERSION = "0.4.4"
 end

data/relaxo.gemspec

@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
 	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.3"
-	spec.add_development_dependency "rake"
 	
-	spec.add_dependency "json", "~> 1.7.3"
+	spec.add_dependency "json", "~> 1.8"
 	spec.add_dependency "rest-client"
+	
+	spec.add_development_dependency "rspec", "~> 3.1.0"
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
 end

data/spec/relaxo/connection_spec.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+require_relative 'spec_helper'
+
+require 'relaxo'
+
+RSpec.describe Relaxo::Connection do
+	before :all do
+		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
+	end
+	
+	it "should provide connection information hash" do
+		expect(@connection.info).to be_kind_of Hash
+	end
+	
+	it "should create test database" do
+		database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
+		
+		if database.exist?
+			expect(database.delete!).to be == Relaxo::SUCCESS
+		end
+		
+		expect(database.create!).to be == Relaxo::SUCCESS
+		
+		expect(@connection.databases).to be_include TEST_DATABASE_NAME
+		
+		expect(database.delete!).to be == Relaxo::SUCCESS
+	end
+end

data/spec/relaxo/database_spec.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'relaxo'
+require 'relaxo/attachments'
+
+require_relative 'spec_helper'
+
+RSpec.describe Relaxo::Database do
+	before :all do
+		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
+		@database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
+		
+		if @database.exist?
+			@database.delete!
+		end
+		
+		@database.create!
+	end
+	
+	it "should connect and add a document" do
+		expect(@database.id?('foobar')).to be false
+		
+		document = {'animal' => 'Cat', 'name' => 'Seifa'}
+		
+		@database.save(document)
+		
+		id = document[Relaxo::ID]
+		expect(@database.id?(id)).to be true
+		
+		copy = @database.get(id)
+		document.each do |key, value|
+			expect(copy[key]).to be == value
+		end
+	end
+	
+	it "should save an attachment" do
+		document = {
+			Relaxo::ATTACHMENTS => {
+				"foo.txt" => {
+					"content_type" => "text\/plain",
+					"data" => "VGhpcyBpcyBhIGJhc2U2NCBlbmNvZGVkIHRleHQ="
+				}
+			}
+		}
+		
+		result = @database.save(document)
+		expect(result['ok']).to be true
+		
+		document = @database.get(document[Relaxo::ID])
+		expect(document[Relaxo::ATTACHMENTS].size).to be == 1
+	end
+end

data/spec/relaxo/spec_helper.rb

@@ -0,0 +1,4 @@
+
+# Avoid running these tests on a live server if you have a valuable database as named below:
+TEST_DATABASE_NAME = 'relaxo-test-database'
+TEST_DATABASE_HOST = 'localhost:5984'

data/{test/test_transactions.rb → spec/relaxo/transaction_spec.rb}

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 
-require 'helper'
+require_relative 'spec_helper'
 
 require 'relaxo'
 require 'relaxo/transaction'
 
-class TransactionTest < Test::Unit::TestCase
-	def setup
+RSpec.describe Relaxo::Transaction do
+	before :all do
 		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
 		@database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
 		
@@ -17,7 +17,7 @@ class TransactionTest < Test::Unit::TestCase
 		@database.create!
 	end
 	
-	def test_adding_documents
+	it "should create some documents" do
 		documents = @database.transaction do |txn|
 			10.times do |i|
 				txn.save({:i => i})
@@ -25,10 +25,10 @@ class TransactionTest < Test::Unit::TestCase
 		end
 		
 		# We got 10 document IDs back
-		assert_equal 10, documents.size
+		expect(documents.size).to be == 10
 	end
 	
-	def test_abortion
+	it "should abort transaction" do
 		all_documents = @database.documents
 		
 		documents = @database.transaction do |txn|
@@ -39,11 +39,11 @@ class TransactionTest < Test::Unit::TestCase
 			end
 		end
 		
-		assert_equal nil, documents
-		assert_equal all_documents, @database.documents
+		expect(documents).to be nil
+		expect(all_documents).to be == @database.documents
 	end
 	
-	def test_deletion
+	it "should delete some documents" do
 		documents = @database.transaction do |txn|
 			3.times do |i|
 				txn.save({:i => i})
@@ -57,7 +57,7 @@ class TransactionTest < Test::Unit::TestCase
 		end
 		
 		documents.each do |document|
-			assert_equal false, @database.id?(document[Relaxo::ID])
+			expect(@database.id?(document[Relaxo::ID])).to be false
 		end
 	end
 end

metadata

@@ -1,69 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: relaxo
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2015-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '1.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.3
-  type: :runtime
+        version: 3.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  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: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "\t\tRelaxo provides a set of tools and interfaces for interacting with
@@ -77,29 +91,27 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
 - Gemfile
 - README.md
+- Rakefile
 - bin/relaxo
 - bin/relaxo-admin
 - lib/relaxo.rb
 - lib/relaxo/attachments.rb
-- lib/relaxo/base64-1.8.rb
 - lib/relaxo/client.rb
 - lib/relaxo/connection.rb
 - lib/relaxo/database.rb
 - lib/relaxo/json.rb
 - lib/relaxo/transaction.rb
 - lib/relaxo/version.rb
-- rakefile.rb
 - relaxo.gemspec
-- test/README.md
-- test/helper.rb
-- test/test_attachments.rb
-- test/test_connection.rb
-- test/test_database.rb
-- test/test_transactions.rb
+- spec/relaxo/connection_spec.rb
+- spec/relaxo/database_spec.rb
+- spec/relaxo/spec_helper.rb
+- spec/relaxo/transaction_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -110,24 +122,22 @@ 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.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Relaxo is a helper for loading and working with CouchDB.
 test_files:
-- test/README.md
-- test/helper.rb
-- test/test_attachments.rb
-- test/test_connection.rb
-- test/test_database.rb
-- test/test_transactions.rb
+- spec/relaxo/connection_spec.rb
+- spec/relaxo/database_spec.rb
+- spec/relaxo/spec_helper.rb
+- spec/relaxo/transaction_spec.rb

data/lib/relaxo/base64-1.8.rb

@@ -1,8 +0,0 @@
-
-require 'base64'
-
-module Base64
-	def self.strict_encode64(data)
-		encode64(data).gsub(/\s/, '')
-	end
-end

data/rakefile.rb

@@ -1,9 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-	t.libs << 'test'
-end
-
-desc "Run tests"
-task :default => :test

data/test/README.md

@@ -1,5 +0,0 @@
-# Relaxo Unit Tests #
-
-Warning: DO NOT RUN THESE UNIT TESTS ON A LIVE SERVER.
-
-The unit tests will create and drop databases with the details within `helper.rb`.

data/test/helper.rb

@@ -1,19 +0,0 @@
-
-$LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
-
-require 'rubygems'
-require 'test/unit'
-
-TEST_DATABASE_NAME = 'relaxo-test-database'
-TEST_DATABASE_HOST = 'localhost:5984'
-
-class Test::Unit::TestCase
-	# Why isn't this in rails?
-	def assert_includes(elem, array, message = nil)
-		message = build_message message, '<?> is not found in <?>.', elem, array
-		
-		assert_block message do
-			array.include? elem
-		end
-	end
-end

data/test/test_attachments.rb

@@ -1,36 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'helper'
-
-require 'relaxo'
-require 'relaxo/attachments'
-
-class DatabaseTest < Test::Unit::TestCase
-	def setup
-		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
-		@database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
-		
-		if @database.exist?
-			@database.delete!
-		end
-		
-		@database.create!
-	end
-	
-	def test_attachments
-		document = {
-			Relaxo::ATTACHMENTS => {
-				"foo.txt" => {
-					"content_type" => "text\/plain",
-					"data" => "VGhpcyBpcyBhIGJhc2U2NCBlbmNvZGVkIHRleHQ="
-				}
-			}
-		}
-		
-		result = @database.save(document)
-		assert result['ok']
-		
-		document = @database.get(document[Relaxo::ID])
-		assert_equal 1, document[Relaxo::ATTACHMENTS].size
-	end
-end

data/test/test_connection.rb

@@ -1,29 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'helper'
-
-require 'relaxo'
-
-class ConnectionTest < Test::Unit::TestCase
-	def setup
-		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
-	end
-	
-	def test_info
-		assert_equal Hash, @connection.info.class
-	end
-	
-	def test_create_database
-		database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
-		
-		if database.exist?
-			assert_equal Relaxo::SUCCESS, database.delete!
-		end
-		
-		assert_equal Relaxo::SUCCESS, database.create!
-		
-		assert_includes TEST_DATABASE_NAME, @connection.databases
-		
-		assert_equal Relaxo::SUCCESS, database.delete!
-	end
-end

data/test/test_database.rb

@@ -1,34 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'helper'
-
-require 'relaxo'
-
-class DatabaseTest < Test::Unit::TestCase
-	def setup
-		@connection = Relaxo::Connection.new(TEST_DATABASE_HOST)
-		@database = Relaxo::Database.new(@connection, TEST_DATABASE_NAME)
-		
-		if @database.exist?
-			@database.delete!
-		end
-		
-		@database.create!
-	end
-	
-	def test_adding_document
-		assert_equal false, @database.id?('foobar')
-		
-		document = {'animal' => 'Cat', 'name' => 'Seifa'}
-		
-		@database.save(document)
-		
-		id = document[Relaxo::ID]
-		assert_equal true, @database.id?(id)
-		
-		copy = @database.get(id)
-		document.each do |key, value|
-			assert_equal value, copy[key]
-		end
-	end
-end