og 0.16.0 → 0.17.0

data/lib/og/{mixins → mixin}/orderable.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: orderable.rb 1 2005-04-11 11:04:30Z gmosx $
-
 require 'glue/dynamic_include'
 
 module Og
@@ -11,34 +7,36 @@ module Og
 module Orderable
 
 	def self.append_dynamic_features(base, options)
-		c = { 
+		o = { 
 			:position => 'position', 
 			:type => Fixnum, 
-			:scope => '"1 = 1"' 
 		}
-		c.update(options) if options
+		o.update(options) if options
 
-		if c[:scope].is_a?(Symbol) && c[:scope].to_s !~ /_oid$/		
-			c[:scope] = "#{c[:scope]}_oid".intern 
+		if o[:scope].is_a?(Symbol) && o[:scope].to_s !~ /_oid$/		
+			o[:scope] = "#{o[:scope]}_oid".intern 
 		end
 
-		position = c[:position]
-		scope = c[:scope]
-
-		if scope.is_a?(Symbol)
-			scope = %{(#{scope} ? "#{scope} = \#{@#{scope}}" : "#{scope} IS NULL")}
-		end
-		
-		base.module_eval <<-EOE, __FILE__, __LINE__		
-			property :#{position}, #{c[:type]}
-		
-			def og_pre_insert(conn)
-				add_to_bottom
-			end
+		position = o[:position]
+		scope = o[:scope]
 
-			def self.og_pre_delete(conn, obj)
-				obj.decrement_position_of_lower_items
+		if scope
+			if scope.is_a?(Symbol)
+				scope = %{(#{scope} ? "#{scope} = \#{@#{scope}}" : "#{scope} IS NULL")}
 			end
+		
+			cond = 'condition => ' + scope
+			cond_and = ':condition => ' + scope + ' + " AND " +'
+		else
+			cond = ':condition => nil'
+			cond_and = ':condition => '
+		end		
+
+		code = %{		
+			property :#{position}, #{o[:type]}
+
+			pre "add_to_bottom", :on => :og_insert	
+			pre "decrement_position_of_lower_items", :on => :og_delete
 			
 			def move_higher
 				if higher = higher_item
@@ -87,12 +85,12 @@ module Orderable
 			end
 
 			def higher_item
-				#{base}.one(#{scope} + " AND #{position}=\#\{@#{position} - 1\}")
+				#{base}.one(#{cond_and}"#{position}=\#\{@#{position} - 1\}")
 			end
 			alias_method :previous_item, :higher_item
 
 			def lower_item
-				#{base}.one(#{scope} + " AND #{position}=\#\{@#{position} + 1\}")
+				#{base}.one(#{cond_and}"#{position}=\#\{@#{position} + 1\}")
 			end
 			alias_method :next_item, :lower_item
 
@@ -101,7 +99,7 @@ module Orderable
 			alias_method :first_item, :top_item
 
 			def bottom_item
-				#{base}.one(#{scope} + " ORDER BY #{position} DESC")
+				#{base}.one(#{cond}, :order => "#{position} DESC", :limit => 1)
 			end
 			alias_method :last_item, :last_item
 
@@ -117,12 +115,12 @@ module Orderable
 
 			def increment_position
 				@#{position} += 1
-				set_property('#{position}', @#{position})
+				update(:#{position})
 			end
 		
 			def decrement_position
 				@#{position} -= 1
-				set_property('#{position}', @#{position})
+				update(:#{position})
 			end
 
 			def bottom_position
@@ -132,26 +130,28 @@ module Orderable
 
 			def set_top_position
 				@#{position} = 1
-				set_property('#{position}', 1)
+				update(:#{position})
 			end
 
 			def set_bottom_position
 				@#{position} = bottom_position + 1
-				set_property('#{position}', @#{position})
+				update(:#{position})
 			end
 
 			def increment_position_of_higher_items
-				#{base}.update("#{position}=(#{position} + 1)", "WHERE " + #{scope} + " AND #{position} < \#\{@#{position}\}")
+				#{base}.update_property("#{position}=(#{position} + 1)", #{cond_and}"#{position} < \#\{@#{position}\}")
 			end
 
 			def increment_position_of_all_items
-				#{base}.update("#{position}=(#{position} + 1)", "WHERE " + #{scope})
+				#{base}.update_property("#{position}=(#{position} + 1)", #{cond})
 			end
 			
 			def decrement_position_of_lower_items
-				#{base}.update("#{position}=(#{position} - 1)", "WHERE " + #{scope} + " AND #{position} > \#\{@#{position}\}")
+				#{base}.update_property("#{position}=(#{position} - 1)", #{cond_and}"#{position} > \#\{@#{position}\}")
 			end
-		EOE
+		}		
+		
+		base.module_eval(code)
 	end
 	
 

data/lib/og/{mixins → mixin}/timestamped.rb

@@ -1,13 +1,8 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2005 Navel, all rights reserved.
-# $Id: timestamped.rb 23 2005-04-16 18:20:00Z gmosx $
-
 module Og
 
 # Adds timestamping functionality.
 
 module Timestamped
-
 	property :create_time, Time
 	property :update_time, Time
 	property :access_time, Time
@@ -18,7 +13,6 @@ module Timestamped
 	def touch!
 		@access_time = Time.now
 	end
-	
 end
 
 end 

data/lib/og/{mixins → mixin}/tree.rb

@@ -1,7 +1,3 @@
-# * George Moschovitis  <gm@navel.gr>
-# (c) 2004-2005 Navel, all rights reserved.
-# $Id: tree.rb 1 2005-04-11 11:04:30Z gmosx $
-
 # NOT WORKING YET !!!
 
 raise 'This is not working yet, do not require this file.'

data/lib/og/relation.rb

@@ -0,0 +1,178 @@
+require 'facet/object/constant'
+require 'facet/string/plural'
+require 'facet/string/demodulize'
+require 'facet/string/underscore'
+
+module Og
+
+# A relation between Entities.
+
+class Relation
+
+	attr_accessor :options
+	
+	def initialize(args, options = {})
+		@options = options
+		@options.update(args.pop) if args.last.is_a?(Hash)
+
+		if args.empty? or (not (args.last.is_a?(Class) or args.last.is_a?(Symbol)))
+			raise 'Class of target not defined' 
+		end
+
+		@options[:target_class] = args.pop
+
+		target_name = if collection
+			:target_plural_name
+		else 
+			:target_singular_name 
+		end
+		
+		unless args.empty?
+			@options[target_name] = args.first
+		else
+			@options[target_name] = if collection
+				target_class.to_s.demodulize.underscore.downcase.plural.intern 
+			else
+				target_class.to_s.demodulize.underscore.downcase.intern
+			end				
+		end
+
+		@options[:name] = options[target_name]		
+	end
+
+	def [](key)
+		@options[key]
+	end
+
+	def []=(key, val)
+		@options[key] = val
+	end
+
+	def resolve_options
+		@options[:owner_pk], @options[:owner_pkclass] = owner_class.primary_key
+		@options[:target_pk], @options[:target_pkclass] = target_class.primary_key
+	end
+
+	# To avoid forward declarations, references to undefined 
+	# (at the time of the creation of the relation) classes are
+	# stored as symbols. These symbols are resolved by this 
+	# method.
+	#--
+	# FIXME: do something more elegant here.
+	#++
+	
+	def resolve_target
+		if target_class.is_a?(Symbol)
+			c = owner_class.name.dup
+			c = "::" + c unless c =~ /::/
+			c.gsub!(/::.*$/, '::')
+			c << target_class.to_s
+			begin
+				klass = constant(c)
+			rescue
+				c = target_class
+				retry
+			end
+			@options[:target_class] = klass
+		end				
+	end
+	
+	def enchant 
+	end
+
+	# Access the hash values as methods.
+
+	def method_missing(sym, *args)
+		return @options[sym]
+	end
+
+	class << self
+
+		def enchant(klass)
+			if klass.__meta[:relations]
+				for relation in klass.__meta[:relations]
+					relation.resolve_target
+					relation.resolve_options
+					relation.enchant
+				end
+			end
+		end
+
+	end
+
+end
+
+# Relation macros. These macros are used to define Entity
+# relations.
+
+module RelationMacros
+	def self.append_features(base)
+		super
+		base.extend(ClassMethods)
+	end
+
+	module ClassMethods
+
+		# === Examples
+		#
+		# belongs_to Article
+		# belongs_to :article, Article
+		# belongs_to :article, Article, :view => 'lala'
+		
+		def belongs_to(*args)
+			require 'og/relation/belongs_to'
+			meta :relations, Og::BelongsTo.new(args, :owner_class => self)
+		end
+
+		# === Examples
+		#
+		#	refers_to Topic
+		
+		def refers_to(*args)
+			require 'og/relation/refers_to'
+			meta :relations, Og::RefersTo.new(args, :owner_class => self)
+		end
+
+		# === Examples
+		#
+		#	has_one User
+		
+		def has_one(*args)
+			require 'og/relation/has_one'
+			meta :relations, Og::HasOne.new(args, :owner_class => self)
+		end
+	
+		# === Examples
+		#
+		# has_many Comment
+		# has_many :comments, Comment
+		
+		def has_many(*args)
+			require 'og/relation/has_many'
+			meta :relations, Og::HasMany.new(args, :owner_class => self, :collection => true)
+		end
+
+		def joins_many(*args)
+			require 'og/relation/joins_many'
+			meta :relations, Og::JoinsMany.new(args, :owner_class => self, :collection => true)
+		end
+		
+		def many_to_many(*args)
+			require 'og/relation/many_to_many'
+			meta :relations, Og::ManyToMany.new(args, :owner_class => self, :collection => true)
+		end
+
+		def inspect_relations
+			__meta[:relations]
+		end				
+		alias_method :relations, :inspect_relations
+
+		def inspect_relation(name)
+			__meta[:relations].find { |r| r[:name] == name }
+		end
+		alias_method :relation, :inspect_relation
+		
+	end
+end
+
+end

data/lib/og/relation/belongs_to.rb

@@ -0,0 +1,14 @@
+require 'og/relation/refers_to'
+
+module Og
+
+class BelongsTo < RefersTo
+
+	def enchant
+		super
+		target_class.meta :descendants, [owner_class, foreign_key]
+	end
+	
+end
+
+end

data/lib/og/relation/has_many.rb

@@ -0,0 +1,62 @@
+require 'facet/string/singular'
+require 'facet/string/demodulize'
+require 'facet/string/underscore'
+
+require 'og/relation'
+require 'og/collection'
+
+module Og
+
+class HasManyCollection < Collection
+end
+
+# A 'has_many' relation. There should be a respective
+# 'belongs_to' relation.
+#
+# === Examples
+#
+# article.comments << Comment.new
+# article.comments.size
+
+class HasMany < Relation
+
+	def enchant
+		self[:owner_singular_name] = owner_class.to_s.demodulize.underscore.downcase 
+		self[:target_singular_name] = target_plural_name.to_s.singular
+		self[:foreign_key] = "#{foreign_name || owner_singular_name}_#{owner_pk}"
+		
+		owner_class.module_eval %{ 
+			attr_accessor :#{target_plural_name}
+
+			def #{target_plural_name}(options = nil)
+				unless @#{target_plural_name}
+					@#{target_plural_name} = HasManyCollection.new(
+						self, 
+						:add_#{target_singular_name},
+						:find_#{target_plural_name},
+						options
+					)
+				end
+
+				@#{target_plural_name}.reload(options) if options and options[:reload]
+				@#{target_plural_name}
+			end
+
+			def add_#{target_singular_name}(obj)
+				obj.#{foreign_key} = @#{owner_pk}
+				obj.save
+			end
+			
+			def find_#{target_plural_name}(options = {})
+				find_options = {
+					:condition => "#{foreign_key} = \#\{@#{owner_pk}\}"
+				}
+				find_options.update(options) if options
+				#{target_class}.find(find_options)
+			end
+		}
+	end
+
+end
+
+end

data/lib/og/relation/has_one.rb

@@ -0,0 +1,17 @@
+require 'og/relation/refers_to'
+
+module Og
+
+# A 'has_one' relation.
+#
+# === Examples
+#
+# user.profile = Profile.new
+# user.profile
+# user.profile(true) # reload
+# user.profile(:reload => true)
+
+class HasOne < RefersTo
+end
+
+end

data/lib/og/relation/joins_many.rb

@@ -0,0 +1,69 @@
+require 'facet/string/singular'
+require 'facet/string/demodulize'
+require 'facet/string/underscore'
+
+require 'og/relation'
+require 'og/collection'
+
+module Og
+
+class JoinsManyCollection < Collection
+end
+
+# A 'joins_many' relation.
+# This objects is associated with an other using an intermediate 
+# join table.
+#
+# === Examples
+#
+# joins_many Category
+# joins_many :categories, Category
+
+class JoinsMany < Relation
+
+	def enchant
+		self[:owner_singular_name] = owner_class.to_s.demodulize.underscore.downcase 
+		self[:target_singular_name] = target_plural_name.to_s.singular
+
+		store = owner_class.ogmanager.store
+		join_table, oidx, tidx = store.join_table(owner_class, target_class)
+		owner_class.meta :join_tables, join_table
+
+		owner_class.module_eval %{ 
+			attr_accessor :#{target_plural_name}
+
+			def #{target_plural_name}(options = nil)
+				reload = options and options[:reload]
+
+				unless @#{target_plural_name}
+					@#{target_plural_name} = JoinsManyCollection.new(
+						self, 
+						:add_#{target_singular_name},
+						:find_#{target_plural_name}
+					)
+				end
+
+				@#{target_plural_name}.reload(options) if options and options[:reload]
+				@#{target_plural_name}
+			end
+
+			def add_#{target_singular_name}(obj)
+				obj.save
+				obj.class.ogmanager.store.join(self, obj, "#{join_table}")
+			end
+
+			def find_#{target_plural_name}(options = {})
+				find_options = {
+					:join_table => "#{join_table}",
+					:join_condition => "#{join_table}.key#{tidx}=#{store.table(target_class)}.oid",
+					:condition => "#{join_table}.key#{oidx}=\#\{@#{owner_pk}\}"
+				}
+				find_options.update(options) if options
+				#{target_class}.find(find_options)
+			end			
+		}
+	end
+
+end
+
+end