relaxo-model 0.3.0

data/README.md

@@ -0,0 +1,31 @@
+Relaxo Model
+============
+
+* Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
+* Copyright (C) 2010, 2011 Samuel G. D. Williams.
+* Released under the MIT license.
+
+Relaxo Model provides a framework for business logic on top of Relaxo/CouchDB. While it supports some traditional ORM style patterns, it is primary focus is to model business processes and logic.
+
+License
+-------
+
+Copyright (c) 2010, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+
+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/lib/relaxo/model/base.rb

@@ -0,0 +1,212 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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
+		module ClassMethods
+			DEFAULT_VIEW_OPTIONS = {:include_docs => true}
+			
+			def self.extended(child)
+				child.instance_variable_set(:@properties, {})
+				child.instance_variable_set(:@relationships, {})
+				
+				default_type = child.name.split('::').last.gsub(/(.)([A-Z])/,'\1_\2').downcase!
+				child.instance_variable_set(:@type, default_type)
+			end
+			
+			def metaclass
+				class << self; self; end
+			end
+			
+			attr :properties
+			attr :relationships
+			
+			def view(name, path, *args)
+				options = Hash === args.last ? args.pop : DEFAULT_VIEW_OPTIONS
+				klass = args.pop || options[:class]
+
+				self.metaclass.send(:define_method, name) do |database, query = {}|
+					records = database.view(path, query.merge(options))
+					Recordset.new(database, records, klass)
+				end
+			end
+
+			def relationship(name, path, *args)
+				options = Hash === args.last ? args.pop : {}
+				klass = args.pop || options[:class]
+
+				@relationships[name] = options
+
+				self.send(:define_method, name) do |query = {}|
+					query = query.merge(options)
+
+					unless query.include? :key
+						query[:key] = self.id
+					end
+
+					Recordset.new(@database, @database.view(path, query), klass)
+				end
+			end
+
+			def property(name, klass = nil)
+				name = name.to_s
+
+				@properties[name] = klass
+
+				self.send(:define_method, name) do
+					if @changed.include? name
+						return @changed[name]
+					elsif @document.include? name
+						if klass
+							@changed[name] = klass.convert_from_document(@database, @document[name])
+						else
+							@changed[name] = @document[name]
+						end
+					else
+						nil
+					end
+				end
+
+				self.send(:define_method, "#{name}=") do |value|
+					@changed[name] = value
+				end
+			end
+			
+			def create(database, properties)
+				instance = self.new(database, {'type' => @type})
+
+				properties.each do |key, value|
+					instance[key] = value
+				end
+
+				instance.after_create
+
+				return instance
+			end
+			
+			def fetch(database, id)
+				instance = self.new(database, database.get(id).to_hash)
+
+				instance.after_fetch
+
+				return instance
+			end
+		end
+		
+		module Base
+			def initialize(database, document = {})
+				# Raw key-value database
+				@document = document
+				@database = database
+				@changed = {}
+			end
+
+			attr :database
+
+			def id
+				@document[ID]
+			end
+
+			def rev
+				@document[REV]
+			end
+
+			def clear(key)
+				@changed.delete(key)
+				@document.delete(key)
+			end
+
+			def [] name
+				name = name.to_s
+
+				if self.class.properties.include? name
+					self.send(name)
+				else
+					raise KeyError.new(name)
+				end
+			end
+
+			def []= name, value
+				name = name.to_s
+
+				if self.class.properties.include? name
+					self.send("#{name}=", value)
+				else
+					raise KeyError.new(name)
+				end
+			end
+
+			# Update any calculations:
+			def before_save
+			end
+
+			def after_save
+			end
+
+			def save
+				before_save
+
+				return if @changed.size == 0 && self.id
+
+				# Flatten changed properties:
+				self.class.properties.each do |key, klass|
+					if @changed.include? key
+						if klass
+							@document[key] = klass.convert_to_document(@changed.delete(key))
+						else
+							@document[key] = @changed.delete(key)
+						end
+					end
+				end
+
+				# Non-specific properties, serialised by JSON:
+				@changed.each do |key, value|
+					@document[key] = value
+				end
+
+				@changed = {}
+				@database.save(@document)
+
+				after_save
+			end
+
+			def before_delete
+			end
+
+			def after_delete
+			end
+
+			def delete
+				before_delete
+
+				@database.delete(@document)
+
+				after_delete
+			end
+
+			def after_fetch
+			end
+
+			# Set any default values:
+			def after_create
+			end
+		end
+	end
+end

data/lib/relaxo/model/version.rb

@@ -0,0 +1,31 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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
+		module VERSION
+			MAJOR = 0
+			MINOR = 3
+			TINY  = 0
+
+			STRING = [MAJOR, MINOR, TINY].join('.')
+		end
+	end
+end

data/lib/relaxo/model.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+require 'relaxo/model/base'
+require 'relaxo/recordset'
+require 'relaxo/properties'
+
+module Relaxo
+	module Model
+		def self.included(child)
+			# Include all available properties
+			child.send(:include, Relaxo::Properties)
+			child.send(:include, Relaxo::Model::Base)
+			
+			child.send(:extend, Relaxo::Model::ClassMethods)
+		end
+	end
+end

data/lib/relaxo/properties/money.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+require 'money'
+
+module Relaxo
+	module Properties
+		Attribute.for_class(Money) do
+			def convert_to_document(value)
+				[value.cents, value.currency.to_s]
+			end
+
+			def convert_from_document(database, value)
+				Money.new(value[0], value[1])
+			end
+		end
+	end
+end

data/lib/relaxo/properties.rb

@@ -0,0 +1,129 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+require 'date'
+
+module Relaxo
+	module Properties
+		class Attribute
+			@@attributes = {}
+			
+			def self.for_class(klass, &block)
+				@@attributes[klass] = Proc.new(&block)
+			end
+			
+			def self.[] klass
+				self.new(klass)
+			end
+			
+			def initialize(klass)
+				@klass = klass
+				
+				self.instance_eval &@@attributes[klass]
+			end
+		end
+		
+		Attribute.for_class(Integer) do
+			def convert_to_document(value)
+				value.to_i
+			end
+
+			def convert_from_document(database, value)
+				value.to_i
+			end
+		end
+		
+		Attribute.for_class(Float) do
+			def convert_to_document(value)
+				value.to_f
+			end
+
+			def convert_from_document(database, value)
+				value.to_f
+			end
+		end
+		
+		Attribute.for_class(Date) do
+			def convert_to_document(value)
+				value.iso8601
+			end
+
+			def convert_from_document(database, string)
+				Date.parse(string)
+			end
+		end
+
+		Attribute.for_class(DateTime) do
+			def convert_to_document(value)
+				value.iso8601
+			end
+
+			def convert_from_document(database, string)
+				DateTime.parse(string)
+			end
+		end
+
+		Attribute.for_class(String) do
+			def convert_to_document(value)
+				value.to_s
+			end
+
+			def convert_from_document(database, string)
+				string.to_s
+			end
+		end
+
+		class BelongsTo
+			def self.[] klass
+				self.new(klass)
+			end
+			
+			def initialize(klass)
+				@klass = klass
+			end
+
+			def convert_to_document(value)
+				unless value.id
+					value.save
+				end
+
+				value.id
+			end
+
+			def convert_from_document(database, string)
+				@klass.fetch(database, string)
+			end
+		end
+		
+		class Lookup
+			def self.[] klass
+				self.class.new(klass)
+			end
+
+			def initialize(klass)
+				@klass = klass
+			end
+
+			def new(database, id)
+				@klass.fetch(database, id)
+			end
+		end
+	end
+end

data/lib/relaxo/recordset.rb

@@ -0,0 +1,61 @@
+
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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
+	class Recordset
+		include Enumerable
+		
+		def initialize(database, view, klass = nil)
+			@database = database
+			@view = view
+			
+			@klass = klass
+		end
+		
+		attr :klass
+		attr :database
+		
+		def count
+			@view["total_rows"]
+		end
+		
+		def offset
+			@view["offset"]
+		end
+		
+		def rows
+			@view["rows"]
+		end
+		
+		def each(klass = nil, &block)
+			klass ||= @klass
+			
+			if klass
+				rows.each do |row|
+					# If user specified :include_docs => true, row['doc'] contains the primary value:
+					yield klass.new(@database, row['doc'] || row['value'])
+				end
+			else
+				rows.each &block
+			end
+		end
+	end
+end

data/lib/relaxo-model.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+require 'relaxo/model'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: relaxo-model
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: relaxo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/relaxo/model/base.rb
+- lib/relaxo/model/version.rb
+- lib/relaxo/model.rb
+- lib/relaxo/properties/money.rb
+- lib/relaxo/properties.rb
+- lib/relaxo/recordset.rb
+- lib/relaxo-model.rb
+- README.md
+homepage: http://www.oriontransfer.co.nz/gems/relaxo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Relaxo Model is a high level business logic framework for CouchDB/Relaxo.
+test_files: []