relaxo-model 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2ad57e6711f00c73b9c202ead6b83a74487d3c6
-  data.tar.gz: 4415ddf243915e589262fabd95710bd87f4ca37f
+  metadata.gz: b0c3186186902c2608d53e8f866364aba7dbc958
+  data.tar.gz: e35738b1d5643f40b8454bcb1d787f199faf0686
 SHA512:
-  metadata.gz: 2002c6a843e9faa0d161ec038746e14e7e62b1510913ce2a58a6d526a43d89cccca8df7ce0f452ce1d6783d2b841d07b0a94102e954a5ea8a49d5a457e41bb37
-  data.tar.gz: 70345816de27d90a95239d35254de896938fb36f2200bb98b4d6dadb1d7ef675b15488ef78286276047e1d4ccd2203655a615a7a8505f8dd3f3f8f88bf431d2b
+  metadata.gz: 01f037f4d5c92d57442ba8232d3afe64410770ac7fc62aacb4e18a391295ef1f1ad6c1c6fab1881fc24457aaa7161a71e74470587434166fc2ecbc1de9802566
+  data.tar.gz: 91287d51707af0a469dda51139ad8c8efb61228619b52ca7a3a84905f3f44472da1fcbe99e2ecc92a42a3f101d541ad74176750a51f1bd62c52998e33648c1bd

data/lib/relaxo/model/base.rb

@@ -19,37 +19,10 @@
 # THE SOFTWARE.
 
 require_relative 'recordset'
-require 'uri'
+require_relative 'path'
 
 module Relaxo
 	module Model
-		# A string that won't be escaped when concatenating with a path:
-		class Path < String
-			ENCODE = {'/' => '%2F', '%' => '%25'}
-			
-			def to_s
-				self
-			end
-			
-			def to_str
-				self
-			end
-			
-			def self.join(path)
-				joined_path = path.map do |part|
-					part = part.to_s
-					
-					if part.is_a? Path
-						part
-					else
-						part.to_s.gsub(/[\/%]/, ENCODE)
-					end
-				end.join('/')
-				
-				return self.new(joined_path)
-			end
-		end
-		
 		Key = Struct.new(:prefix, :index) do
 			def resolve(key_path, model, **arguments)
 				key_path.collect do |component|
@@ -67,11 +40,11 @@ module Relaxo
 			end
 			
 			def object_path(model, **arguments)
-				Path.join resolve(self.prefix + self.index, model, **arguments)
+				resolve(self.prefix + self.index, model, **arguments).join('/')
 			end
 			
 			def prefix_path(model, **arguments)
-				Path.join resolve(self.prefix, model, **arguments)
+				resolve(self.prefix, model, **arguments).join('/')
 			end
 		end
 		
@@ -100,11 +73,20 @@ module Relaxo
 			attr :primary_key
 			
 			def parent_type klass
-				@type = Path.join([klass.type, self.type])
+				@type = [klass.type, self.type].join('/')
 			end
 			
-			def view(name, path = nil, klass: self, index: nil)
-				key = Key.new(path, index)
+			def view(name, *path, klass: self, index: nil)
+				# Support array as 2nd argument, e.g.
+				# view :by_owner, [:type, 'by_owner', ]
+				if path.empty?
+					path = [:type, name.to_s, name.to_s.split('_', 2).last.to_sym]
+				elsif path.count == 1 and path.first.is_a? Array
+					warn "Legacy view for #{self}: #{name} -> #{path}"
+					path = path.first
+				end
+				
+				key = Key.new(path, Array(index))
 				
 				if index
 					@keys[name] = key
@@ -124,6 +106,12 @@ module Relaxo
 				end
 			end
 			
+			def unique(*keys)
+				lambda do |arguments|
+					Path.escape keys.map{|key| arguments[key] || self[key] || 'null'}
+				end
+			end
+			
 			def property(name, klass = nil)
 				if @properties.key? name
 					raise ArgumentError.new("Property #{name.inspect} already defined!")

data/lib/relaxo/model/component.rb

@@ -22,6 +22,7 @@ require 'relaxo/model/base'
 
 module Relaxo
 	module Model
+		# Represents an underlying object with changes which can be persisted.
 		module Component
 			def self.included(child)
 				# $stderr.puts "#{self} included -> #{child} extend Base"
@@ -30,35 +31,31 @@ module Relaxo
 			
 			def initialize(dataset, object = nil, changed = {}, **attributes)
 				@dataset = dataset
+				
+				# The object from the dataset:
 				@object = object
-				@changed = changed
+				
+				# Underlying attributes from the dataset:
 				@attributes = attributes
+				
+				# Contains non-primitve attributes and changes:
+				@changed = changed
 			end
 			
-			def load_object
-				if @object
-					attributes = MessagePack.load(@object.data, symbolize_keys: true)
-					
-					# We prefer existing @attributes over ones loaded from data. This allows the API to load from an object, but specify new attributes.
-					@attributes = attributes.merge(@attributes)
-				end
-			end
+			# The dataset this document is currently bound to:
+			attr :dataset
+			
+			# The attributes specified/loaded from the dataset:
+			attr :attributes
+			
+			# Attributes that have been changed or de-serialized from the dataset:
+			attr :changed
 			
 			def reload
 				@changed.clear
 				self.load_object
 			end
 			
-			def dump
-				flatten!
-				
-				MessagePack.dump(@attributes)
-			end
-
-			attr :attributes
-			attr :dataset
-			attr :changed
-
 			def clear(key)
 				@changed.delete(key)
 				@attributes.delete(key)
@@ -108,9 +105,31 @@ module Relaxo
 			def validate
 				# Do nothing :)
 			end
-
+			
+			def to_hash
+				@attributes
+			end
+			
+			def load_object
+				if @object
+					attributes = MessagePack.load(@object.data, symbolize_keys: true)
+					
+					# We prefer existing @attributes over ones loaded from data. This allows the API to load from an object, but specify new attributes.
+					@attributes = attributes.merge(@attributes)
+				end
+			end
+			
+			protected
+			
+			# Flatten all changes and return a serialized version of the object.
+			def dump
+				flatten!
+				
+				MessagePack.dump(@attributes)
+			end
+			
+			# Moves values from `@changed` into `@attributes`.
 			def flatten!
-				# Flatten changed properties:
 				self.class.properties.each do |key, klass|
 					if @changed.include?(key)
 						if klass
@@ -130,10 +149,6 @@ module Relaxo
 
 				@changed = {}
 			end
-			
-			def to_hash
-				@attributes
-			end
 		end
 	end
 end

data/lib/relaxo/model/document.rb

@@ -105,7 +105,7 @@ module Relaxo
 			end
 
 			def type
-				Path.new @attributes[:type]
+				@attributes[:type]
 			end
 
 			def valid_type?
@@ -119,6 +119,7 @@ module Relaxo
 			def after_save
 			end
 
+			# The canonical path to the object in the data store, assuming there is some unique way to identify the object.
 			def to_s
 				if primary_key = self.class.primary_key
 					primary_key.object_path(self)
@@ -127,6 +128,10 @@ module Relaxo
 				end
 			end
 
+			def inspect
+				"\#<#{self.class}:#{self.id} #{self.attributes.inspect}>"
+			end
+
 			# Duplicate the model object, and possibly change the dataset it is connected to. You will potentially have two objects referring to the same record.
 			def dup
 				clone = self.class.new(@dataset, @object, @changed, **@attributes.dup)

data/lib/relaxo/model/path.rb

@@ -0,0 +1,50 @@
+# Copyright, 2018, by Samuel G. D. Williams. <https://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
+# 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.
+
+module Relaxo
+	module Model
+		# A string that won't be escaped when concatenating with a path:
+		class Path < String
+			ENCODE = {'/' => '%2F', '%' => '%25'}
+			
+			def to_s
+				self
+			end
+			
+			def to_str
+				self
+			end
+			
+			def self.escape(values)
+				escaped_path = values.map do |part|
+					part = part.to_s
+					
+					if part.is_a? Path
+						part
+					else
+						part.to_s.gsub(/[\/%]/, ENCODE)
+					end
+				end.join('-')
+				
+				return self.new(escaped_path)
+			end
+		end
+	end
+end

data/lib/relaxo/model/version.rb

@@ -20,6 +20,6 @@
 
 module Relaxo
 	module Model
-		VERSION = "0.11.0"
+		VERSION = "0.12.0"
 	end
 end

data/spec/relaxo/model/document_spec.rb

@@ -29,8 +29,17 @@ RSpec.describe Relaxo::Model::Document do
 		expect(Invoice.all(database.current).count).to be == 3
 	end
 	
+	it "should have valid type" do
+		expect(Invoice.type).to be == "invoice"
+		expect(Invoice::Transaction.type).to be == "invoice/transaction"
+	end
+	
 	it "should have resolved type" do
-		expect(Invoice::Transaction.type).to be_a Relaxo::Model::Path
+		transaction = Invoice::Transaction.create(database.current, {id: 'test'})
+		
+		transaction.attributes[:type] = ["Invoice", "Transaction"]
+		
+		expect(transaction.paths.first).to be == "Invoice/Transaction/test"
 	end
 	
 	it "should create model indexes" do
@@ -56,6 +65,26 @@ RSpec.describe Relaxo::Model::Document do
 		expect(transaction.to_s).to be == "invoice/transaction/#{transaction.id}"
 	end
 	
+	it "can edit model objects" do
+		invoice = nil
+		
+		database.commit(message: "Adding test model") do |dataset|
+			invoice = Invoice.create(dataset, name: "Software Development")
+			invoice.save(dataset)
+		end
+		
+		# Fetch the invoice from the database:
+		invoice = Invoice.fetch_all(database.current, id: invoice.id)
+		invoice.name = "Software Engineering"
+		
+		database.commit(message: "Editing test model") do |dataset|
+			invoice.save(dataset)
+		end
+		
+		invoice = Invoice.fetch_all(database.current, id: invoice.id)
+		expect(invoice.name).to be == "Software Engineering"
+	end
+	
 	it "updates indexes correctly" do
 		transaction = nil
 		

data/spec/relaxo/model/model_context.rb

@@ -12,7 +12,7 @@ class Invoice
 	
 	property :date, Attribute[Date]
 	
-	view :all, [:type], index: [:id]
+	view :all, :type, index: :id
 	
 	def transactions
 		Invoice::Transaction.by_invoice(@dataset, invoice: self)
@@ -28,9 +28,9 @@ class Invoice::Transaction
 	property :invoice, BelongsTo[Invoice]
 	property :date, Attribute[Date]
 	
-	view :all, [:type], index: [:id]
+	view :all, :type, index: :id
 	
-	view :by_invoice, [:type, 'by_invoice', :invoice], index: [[:date, :id]]
+	view :by_invoice, index: unique(:date, :id)
 end
 
 class User
@@ -40,9 +40,9 @@ class User
 	property :name
 	property :intro
 	
-	view :all, [:type], index: [:email]
+	view :all, :type, index: unique(:email)
 	
-	view :by_name, [:type, 'by_name'], index: [:name]
+	view :by_name, :type, 'by_name', index: unique(:name)
 end
 
 RSpec.shared_context "model" do

data/spec/relaxo/model/recordset_spec.rb

@@ -7,9 +7,9 @@ RSpec.describe Relaxo::Model::Recordset do
 	context "with several invoices" do
 		before(:each) do
 			database.commit(message: "Adding test model") do |dataset|
-				@first = Invoice.insert(dataset, name: "Software Development")
-				@middle = Invoice.insert(dataset, name: "Website Hosting")
-				@last = Invoice.insert(dataset, name: "Backup Services")
+				@first = Invoice.insert(dataset, id: "a", name: "Software Development")
+				@middle = Invoice.insert(dataset, id: "b", name: "Website Hosting")
+				@last = Invoice.insert(dataset, id: "c", name: "Backup Services")
 			end
 		end
 		

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: relaxo-model
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -99,6 +99,7 @@ files:
 - lib/relaxo/model/base.rb
 - lib/relaxo/model/component.rb
 - lib/relaxo/model/document.rb
+- lib/relaxo/model/path.rb
 - lib/relaxo/model/properties.rb
 - lib/relaxo/model/properties/attribute.rb
 - lib/relaxo/model/properties/bcrypt.rb