relaxo-model 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85f3d648fadd1ad073b9ba8b19c4bc343022143f
-  data.tar.gz: 6da3f03fcdcfcae4a6ada3e1a856649e135c407d
+  metadata.gz: b1ae3a29f77dae4356693e9b75175407e1c6d867
+  data.tar.gz: 432e8decdccadbfeacb067439e918256183b6f68
 SHA512:
-  metadata.gz: 73c64d7d6b81ba525e7348205e400213876f5b7c675f8c299c55497fae3f8eb6125f21fc7297dfb70d721dc598287df73678538a663ae6e5a07a855dba53d778
-  data.tar.gz: ab3091e7dd54e8fceec551486522e8822368109b57a684c6c769374ebb9d713135ac51c2014b19c71cd099f0c1fa95145022ac6dfbc9db80f8020efd6605aa30
+  metadata.gz: 204332daa91dcf3887f22fe3d2e0e597616a6d944af12c44887812245188f2315b540dae775d9f1f044999a3b1a2c7c33d7f215a9e9f3ad85262db738bbe3cb8
+  data.tar.gz: b76b115b30e5b612b5ef974660e51463fca035a235e88fca2462371b80b4097f740e10ab103d9f813ddc5b69221e2a2f7553287a00bedf9bef39dc9632c5047a

data/.gitignore

@@ -12,6 +12,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/relaxo/model/test
 test/tmp
 test/version_tmp
 tmp

data/README.md

@@ -10,41 +10,82 @@ Relaxo Model provides a framework for business logic on top of Relaxo, a documen
 
 Here is a simple example of a traditional ORM style model:
 
-	require 'relaxo/model'
+```ruby
+require 'relaxo/model'
 
-	database = Relaxo.connect("test")
+database = Relaxo.connect("test")
 
-	trees = [
+trees = [
+	{:name => 'Hinoki', :planted => Date.parse("2013/11/17")},
+	{:name => 'Keyaki', :planted => Date.parse("2016/9/24")}
+]
+
+class Tree
+	include Relaxo::Model
+	
+	property :id, UUID
+	property :name
+	property :planted, Attribute[Date]
+	
+	view :all, [:type], index: [:id]
+end
+
+database.commit(message: "Create trees") do |changeset|
+	trees.each do |tree|
+		Tree.insert(changeset, tree)
+	end
+end
+
+database.current do |dataset|
+	Tree.all(dataset).each do |tree|
+		puts "A #{tree.name} was planted on #{tree.planted.to_s}."
+
+		# Expected output:
+		# A Hinoki was planted on 2013-11-17.
+		# A Keyaki was planted on 2016-09-24.
+	end
+end
+```
+
+### Non-UUID Primary Key
+
+```ruby
+#!/usr/bin/env ruby
+
+gem 'relaxo'
+
+require 'relaxo/model'
+
+database = Relaxo.connect("test")
+
+trees = [
 		{:name => 'Hinoki', :planted => Date.parse("2013/11/17")},
 		{:name => 'Keyaki', :planted => Date.parse("2016/9/24")}
-	]
+]
 
-	class Tree
+class Tree
 		include Relaxo::Model
-		
-		property :id, UUID
+
 		property :name
 		property :planted, Attribute[Date]
-		
-		view :all, [:type], index: [:id]
-	end
 
-	database.commit(message: "Create trees") do |changeset|
+		view :all, [:type], index: [:name]
+end
+
+database.commit(message: "Create trees") do |changeset|
 		trees.each do |tree|
-			Tree.insert(changeset, tree)
+				Tree.insert(changeset, tree)
 		end
-	end
-
-	database.current do |dataset|
-		Tree.all(dataset).each do |tree|
-			puts "A #{tree.name} was planted on #{tree.planted.to_s}."
+end
 
-			# Expected output:
-			# A Hinoki was planted on 2013-11-17.
-			# A Keyaki was planted on 2016-09-24.
-		end
+database.current do |dataset|
+	trees.each do |tree|
+		object = Tree.fetch_all(dataset, name: tree[:name])
+		puts object
 	end
-	
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/relaxo/model/base.rb

@@ -19,6 +19,7 @@
 # THE SOFTWARE.
 
 require_relative 'recordset'
+require 'uri'
 
 module Relaxo
 	module Model
@@ -39,11 +40,19 @@ module Relaxo
 			end
 			
 			def object_path(model, **arguments)
-				resolve(self.prefix + self.index, model, **arguments).join('/')
+				encode resolve(self.prefix + self.index, model, **arguments)
 			end
 			
 			def prefix_path(model, **arguments)
-				resolve(self.prefix, model, **arguments).join('/')
+				encode resolve(self.prefix, model, **arguments)
+			end
+			
+			private
+			
+			ENCODE = {'/' => '%2F', '%' => '%25'}
+			
+			def encode(path)
+				path.collect{|part| part.to_s.gsub(/[\/%]/, ENCODE)}.join('/')
 			end
 		end
 		

data/lib/relaxo/model/component.rb

@@ -44,6 +44,11 @@ module Relaxo
 				end
 			end
 			
+			def reload
+				@changed.clear
+				self.load_object
+			end
+			
 			def dump
 				flatten!
 				

data/lib/relaxo/model/document.rb

@@ -191,10 +191,6 @@ module Relaxo
 				return self
 			end
 
-			def reload(dataset)
-				@dataset = dataset
-			end
-
 			def before_delete
 			end
 
@@ -207,7 +203,7 @@ module Relaxo
 				@changed.clear
 				
 				paths.each do |path|
-					@dataset.delete(path)
+					dataset.delete(path)
 				end
 
 				after_delete

data/lib/relaxo/model/recordset.rb

@@ -29,9 +29,9 @@ module Relaxo
 				@model = model
 			end
 		
-			attr :klass
-			attr :database
-			attr :view
+			attr :dataset
+			attr :path
+			attr :model
 			
 			def empty?
 				!@dataset.each(@path).any?

data/lib/relaxo/model/version.rb

@@ -20,6 +20,6 @@
 
 module Relaxo
 	module Model
-		VERSION = "0.9.0"
+		VERSION = "0.10.0"
 	end
 end

data/relaxo-model.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 	spec.description   = <<-EOF
 		Relaxo Model provides a framework for business logic on top of
-		Relaxo/CouchDB. While it supports some traditional ORM style patterns, it is
+		Relaxo. While it supports some traditional ORM style patterns, it is
 		primary focus is to model business processes and logic.
 	EOF
 	spec.summary       = "A model layer for CouchDB with minimal global state."

data/spec/relaxo/model/attribute_spec.rb

@@ -0,0 +1,36 @@
+
+require 'relaxo/model'
+
+class Aggregate
+	include Relaxo::Model
+	
+	property :id, UUID
+	property :array_value
+	property :hash_value
+end
+
+RSpec.describe Relaxo::Model::Document do
+	let(:database_path) {File.join(__dir__, 'test')}
+	let(:database) {Relaxo.connect(database_path)}
+	
+	let(:document_path) {'test/document.json'}
+	
+	before(:each) {FileUtils.rm_rf(database_path)}
+	
+	it "should create and save document" do
+		model = Aggregate.create(database.current,
+			array_value: [1, 2, 3],
+			hash_value: {x: 10, y: 20}
+		)
+		
+		database.commit(message: "Adding test model") do |dataset|
+			model.save(dataset)
+		end
+		
+		# Force all attributes to be reloaded from the object store:
+		model.reload
+		
+		expect(model.array_value).to be_kind_of Array
+		expect(model.hash_value).to be_kind_of Hash
+	end
+end

data/spec/relaxo/model/document_spec.rb

@@ -33,6 +33,18 @@ class Invoice::Transaction
 	view :by_invoice, [:type, 'by_invoice', :invoice], index: [[:date, :id]]
 end
 
+class User
+	include Relaxo::Model
+	
+	property :email, Attribute[String]
+	property :name
+	property :intro
+	
+	view :all, [:type], index: [:email]
+	
+	view :by_name, [:type, 'by_name'], index: [:name]
+end
+
 RSpec.describe Relaxo::Model::Document do
 	let(:database_path) {File.join(__dir__, 'test')}
 	let(:database) {Relaxo.connect(database_path)}
@@ -96,9 +108,38 @@ RSpec.describe Relaxo::Model::Document do
 			transaction.save(dataset)
 		end
 		
+		transactions = Invoice::Transaction.all(database.current)
+		
 		database.commit(message: "Adding test model") do |dataset|
 			transaction.date = Date.today - 1
 			transaction.save(dataset)
 		end
+		
+		transactions = Invoice::Transaction.all(database.current)
+	end
+	
+	it "can query by index" do
+		database.commit(message: 'Adding new users.') do |changes|
+			User.insert(changes, email: 'john.doe@aol.com', name: 'John Doe')
+			User.insert(changes, email: 'jane.doe@aol.com', name: 'Jane Doe')
+		end
+		
+		expect(User.fetch_all(database.current, email: 'john.doe@aol.com').name).to be == 'John Doe'
+	end
+	
+	it "can handle indexes with reserved characters" do
+		database.commit(message: "Add new user") do |changeset|
+			User.insert(changeset, email: "its@complicated.com", name: "/John/James/")
+		end
+		
+		expect(User.fetch_all(database.current, email: 'its@complicated.com').name).to be == '/John/James/'
+	end
+	
+	it "can handle indexes with unicode" do
+		database.commit(message: "Add new user") do |changeset|
+			User.insert(changeset, email: "its@complicated.com", name: "こんにちは")
+		end
+		
+		expect(User.fetch_by_name(database.current, name: "こんにちは")).to_not be nil
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaxo-model
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: relaxo
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\t\tRelaxo Model provides a framework for business logic on top of\n\t\tRelaxo/CouchDB.
+description: "\t\tRelaxo Model provides a framework for business logic on top of\n\t\tRelaxo.
   While it supports some traditional ORM style patterns, it is\n\t\tprimary focus
   is to model business processes and logic.\n"
 email:
@@ -109,6 +109,7 @@ files:
 - lib/relaxo/model/recordset.rb
 - lib/relaxo/model/version.rb
 - relaxo-model.gemspec
+- spec/relaxo/model/attribute_spec.rb
 - spec/relaxo/model/document_spec.rb
 homepage: http://www.codeotaku.com/projects/relaxo/model
 licenses:
@@ -130,9 +131,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A model layer for CouchDB with minimal global state.
 test_files:
+- spec/relaxo/model/attribute_spec.rb
 - spec/relaxo/model/document_spec.rb