og 0.20.0 → 0.21.0

data/lib/og/collection.rb

@@ -6,171 +6,214 @@ module Og
 
 class Collection
 
-	# The owner of this collection.
-	
-	attr_accessor :owner
-	
-	# The members of this collection. Keeps the objects
-	# that belong to this collection.
-	
-	attr_accessor :members
-
-	# A method used to add insert objects in the collection.
-	 
-	attr_accessor :insert_proc
-
-	# A method used to remove objects from the collection.
-	
-	attr_accessor :remove_proc
-	
-	# A method used to find the objects that belong to the
-	# collection.
-	
-	attr_accessor :find_proc
-	
-	# The default find options.
-	
-	attr_accessor :find_options
-	
-	# Is the collection in build mode?
-	
-	attr_accessor :building
-	
-	# Is the collection loaded?
-	
-	attr_accessor :loaded
-
-	# Initialize the collection.
-		
-	def initialize(owner = nil, insert_proc = nil, remove_proc = nil, find_proc = nil, find_options = {})
-		@owner = owner
-		@insert_proc = insert_proc
-		@remove_proc = remove_proc
-		@find_proc = find_proc
-		@find_options = find_options
-		@members = []
-		@loaded = false
-		@building = false
-	end
-
-	# Load the members of the collection.	
-
-	def load_members
-		unless @loaded
-			@members = @owner.send(@find_proc, @find_options)
-			@loaded = true
-		end
-		@members
-	end
-	
-	# Reload the collection.
-	
-	def reload(options)
-# gmosx, NOOO: this was a bug! it corrupts the default options.
-#		@find_options = options
-		@members = @owner.send(@find_proc, options)
-	end
-
-	# Convert the collection to an array.
-		
-	def to_ary
-		load_members
-		@members
-	end
-
-	# Defined to avoid the method missing overhead.
-	
-	def each(&block)
-		load_members
-		@members.each(&block)
-	end
-	
-	# Defined to avoid the method missing overhead.
-	
-	def [](idx)
-		load_members
-		@members[idx]
-	end
-	
-	# Add a new member to the collection.
-	
-	def push(obj)
-		@members.push(obj)
-		unless @building or owner.unsaved?
-			@owner.send(@insert_proc, obj)
-		end
-	end
-	alias_method :<<, :push
-	alias_method :add, :push
-
-	# Remove a member from the collection, the actual object
-	# is not deleted.
-	
-	def remove(*objects)
-		objects = objects.flatten
-
-		objects.reject! { |obj| @members.delete(obj) if obj.unsaved? }
-		return if objects.empty?
-
-		@owner.transaction do
-			objects.each do |obj| 
-				@owner.send(@remove_proc, obj)
-				@members.delete(obj) 
-			end
-		end
-	end
-
-	# Delete a member from the collection AND the store.
-	
-	def delete(*objects)
-		objects = objects.flatten
-
-		objects.reject! { |obj| @members.delete(obj) if obj.unsaved? }
-		return if objects.empty?
-
-		@owner.transaction do
-			objects.each do |obj| 
-				obj.delete
-				@members.delete(obj) 
-			end
-		end
-	end
-
-	# Remove all members from the collection.
-	
-	def remove_all
-		@owner.transaction do
-			@members.each { |obj| @owner.send(@remove_proc, obj) }
-		end
-		@members.clear
-	end
-	alias_method :clear, :remove_all
-
-	# Delete all members of the collection. Also delete from the
-	# store.
-	
-	def delete_all
-		@owner.transaction do
-			@members.each { |obj| obj.delete }
-		end
-		@members.clear
-	end
-
-	# Redirect all other methods to the members array.
-	
-	def method_missing(symbol, *args, &block)
-		load_members
-		@members.send(symbol, *args, &block)
-	end
+  # The owner of this collection.
+  
+  attr_accessor :owner
+  
+  # The members of this collection. Keeps the objects
+  # that belong to this collection.
+  
+  attr_accessor :members
+
+  # A method used to add insert objects in the collection.
+   
+  attr_accessor :insert_proc
+
+  # A method used to remove objects from the collection.
+  
+  attr_accessor :remove_proc
+  
+  # A method used to find the objects that belong to the
+  # collection.
+  
+  attr_accessor :find_proc
+
+  # A method used to count the objects that belong to the
+  # collection.
+  
+  attr_accessor :count_proc
+  
+  # The default find options.
+  
+  attr_accessor :find_options
+  
+  # Is the collection in build mode?
+  
+  attr_accessor :building
+  
+  # Is the collection loaded?
+  
+  attr_accessor :loaded
+
+  # Initialize the collection.
+    
+  def initialize(owner = nil, insert_proc = nil, 
+      remove_proc = nil, find_proc = nil, 
+      count_proc = nil, find_options = {})
+    @owner = owner
+    @insert_proc = insert_proc
+    @remove_proc = remove_proc
+    @find_proc = find_proc
+    @count_proc = count_proc
+    @find_options = find_options
+    @members = []
+    @loaded = false
+    @building = false
+  end
+
+  # Load the members of the collection.  
+
+  def load_members
+    unless @loaded
+      @members = @owner.send(@find_proc, @find_options)
+      @loaded = true
+    end
+    @members
+  end
+  
+  # Reload the collection.
+  
+  def reload(options)
+    # gmosx, NOOO: this was a bug! it corrupts the default options.
+    #  @find_options = options
+    @members = @owner.send(@find_proc, options)
+  end
+
+  # Unload the members (clear the cache).
+  
+  def unload
+    @members.clear
+    @loaded = false
+  end
+  
+  # Convert the collection to an array.
+    
+  def to_ary
+    load_members
+    @members
+  end
+
+  # Defined to avoid the method missing overhead.
+  
+  def each(&block)
+    load_members
+    @members.each(&block)
+  end
+  
+  # Defined to avoid the method missing overhead.
+  
+  def [](idx)
+    load_members
+    @members[idx]
+  end
+  
+  # Add a new member to the collection.
+  
+  def push(obj, options = nil)
+    @members.push(obj)
+    unless @building or owner.unsaved?
+      @owner.send(@insert_proc, obj, options)
+    end
+  end
+  alias_method :<<, :push
+  alias_method :add, :push
+
+  # Remove a member from the collection, the actual object
+  # is not deleted.
+  
+  def remove(*objects)
+    objects = objects.flatten
+
+    objects.reject! { |obj| @members.delete(obj) if obj.unsaved? }
+    return if objects.empty?
+
+    @owner.transaction do
+      objects.each do |obj| 
+        @owner.send(@remove_proc, obj)
+        @members.delete(obj) 
+      end
+    end
+  end
+
+  # Delete a member from the collection AND the store.
+  
+  def delete(*objects)
+    objects = objects.flatten
+
+    objects.reject! { |obj| @members.delete(obj) if obj.unsaved? }
+    return if objects.empty?
+
+    @owner.transaction do
+      objects.each do |obj| 
+        obj.delete
+        @members.delete(obj) 
+      end
+    end
+  end
+
+  # Delete a member from the collection AND the store, if the
+  # condition block evaluates to true.
+
+  def delete_if(&block)
+    objects = @members.select(&block)
+
+    objects.reject! { |obj| @members.delete(obj) if obj.unsaved? }
+    return if objects.empty?
+
+    @owner.transaction do
+      objects.each do |obj|
+        obj.delete
+        @members.delete(obj)
+      end
+    end
+  end
+
+  # Remove all members from the collection.
+  
+  def remove_all
+    @owner.transaction do
+      @members.each { |obj| @owner.send(@remove_proc, obj) }
+    end
+    @members.clear
+  end
+  alias_method :clear, :remove_all
+
+  # Delete all members of the collection. Also delete from the
+  # store.
+  
+  def delete_all
+    @owner.transaction do
+      @members.each { |obj| obj.delete }
+    end
+    @members.clear
+  end
+
+  # Return the size of a collection.
+  
+  def size(reload = false)
+    if @loaded and !reload
+      return @members.size
+    else
+      return @owner.send(@count_proc)
+    end
+  end
+  alias_method :count, :size
+
+  # Redirect all other methods to the members array.
+  
+  def method_missing(symbol, *args, &block)
+    load_members
+    @members.send(symbol, *args, &block)
+  end
 
 private
 
-	def check_type(obj)
-	end
-	
+  def check_type(obj)
+  end
+  
 end
 
 end
 
 # * George Moschovitis <gm@navel.gr>
-# *	Julien Perrot <jperrot@exosec.fr>
+# *  Julien Perrot <jperrot@exosec.fr>

data/lib/og/entity.rb

@@ -6,180 +6,179 @@ module Og
 
 module EntityMixin
 
-	def self.append_features(base)
-		super
-
-		base.extend(ClassMethods)
-
-		base.module_eval <<-end_eval, __FILE__, __LINE__ 
-			def save(options = nil)
-				self.class.ogmanager.store.save(self, options)
-#				return self
-			end
-			alias_method :save!, :save
-
-			def insert
-				self.class.ogmanager.store.insert(self)
-				return self
-			end
-						
-			def update(options = nil)
-				self.class.ogmanager.store.update(self, options)
-			end
-			
-			def update_properties(set)
-				self.class.ogmanager.store.update_properties(self, set)
-			end
-			
-			# Reload this entity instance from the store.
-			
-			def reload
-				self.class.ogmanager.store.reload(self, self.pk)
-			end
-			alias_method :reload!, :reload
-
-			# Delete this entity instance from the store.
-			
-			def delete
-				self.class.ogmanager.store.delete(self)
-			end
-			alias_method :delete!, :delete
-
-			def transaction(&block)
-				self.class.ogmanager.store.transaction(&block)
-			end
-		end_eval
-
-		base.send(:include, RelationMacros)
-	end
-
-	module ClassMethods
-		def create(*args)
-			obj = self.new(*args)
-			yield(obj) if block_given?
-			ogmanager.store.save(obj)
-			return obj
-		end
-
-		# Load an instance of this Entity class using the primary
-		# key.
-						
-		def load(pk)
-			ogmanager.store.load(pk, self)
-		end
-		alias_method :[], :load
-		alias_method :exist?, :load
-
-		def update_properties(set, options = nil)
-			ogmanager.store.update_properties(self, set, options)
-		end
-		alias_method :pupdate, :update_properties
-		alias_method :update_property, :update_properties
-		alias_method :batch_update, :update_properties
-		
-		def find(options = {})
-			# gmosx, FIXME: this code seems too complex, 
-			# improve this!
-			
-			if find_options = self.__meta[:find_options]
-				options = find_options.first.dup.update(options)
-			end
-			options[:class] = self
-			if self.metadata.superclass
-				options[:type] = self
-			end
-			ogmanager.store.find(options)
-		end
-		alias_method :all, :find
-
-		def find_one(options = {})
-			options[:class] = self
-			ogmanager.store.find_one(options)
-		end
-		alias_method :one, :find_one
-		alias_method :first, :find_one
-
-		def select(sql)
-			ogmanager.store.select(sql, self)
-		end
-
-		def select_one(sql)
-			ogmanager.store.select_one(sql, self)
-		end
-		
-		def count(options = {})
-			options[:class] = self
-			ogmanager.store.count(options)
-		end
-
-		# Delete an instance of this Entity class using the actual
-		# instance or the primary key.
-		
-		def delete(obj_or_pk)
-			ogmanager.store.delete(obj_or_pk, self)
-		end
-		alias_method :delete!, :delete
-
-		def transaction(&block)
-			ogmanager.store.transaction(&block)
-		end
-		
-		def primary_key
-			unless @__meta and @__meta[:primary_key]
-				self.meta :primary_key, Entity.resolve_primary_key(self)
-			end
-			@__meta[:primary_key].flatten
-		end
-		
-		# Set the default find options for this entity.
-		
-		def find_options(options)
-			meta :find_options, options
-		end
-		
-		# Set the default order option for this entity.
-		
-		def order(order_str)
-			meta :find_options, :order => order_str
-		end
-
-		# Enable schema inheritance for this Entity class.
-		# The Single Table Inheritance pattern is used.
-				
-		def schema_inheritance
-			meta :schema_inheritance
-		end
-
-		# Is this entity a polymorphic parent?
-				
-		def polymorphic_parent?
-			self.to_s == self.metadata.polymorphic.to_s
-		end
-
-		# :nodoc:
-		# Used internally to fix the forward reference problem.
-				
-		def const_missing(sym)
-			return sym
-		end		
-	end
+  def self.append_features(base)
+    super
+
+    base.extend(ClassMethods)
+
+    base.module_eval <<-end_eval, __FILE__, __LINE__ 
+      def save(options = nil)
+        self.class.ogmanager.store.save(self, options)
+#        return self
+      end
+      alias_method :save!, :save
+
+      def insert
+        self.class.ogmanager.store.insert(self)
+        return self
+      end
+            
+      def update(options = nil)
+        self.class.ogmanager.store.update(self, options)
+      end
+      
+      def update_properties(set)
+        self.class.ogmanager.store.update_properties(self, set)
+      end
+      
+      # Reload this entity instance from the store.
+      
+      def reload
+        self.class.ogmanager.store.reload(self, self.pk)
+      end
+      alias_method :reload!, :reload
+
+      # Delete this entity instance from the store.
+      
+      def delete
+        self.class.ogmanager.store.delete(self)
+      end
+      alias_method :delete!, :delete
+
+      def transaction(&block)
+        self.class.ogmanager.store.transaction(&block)
+      end
+    end_eval
+
+    base.send(:include, RelationMacros)
+  end
+
+  module ClassMethods
+    def create(*args)
+      obj = self.new(*args)
+      yield(obj) if block_given?
+      ogmanager.store.save(obj)
+      return obj
+    end
+
+    # Load an instance of this Entity class using the primary
+    # key.
+            
+    def load(pk)
+      ogmanager.store.load(pk, self)
+    end
+    alias_method :[], :load
+    alias_method :exist?, :load
+
+    def update_properties(set, options = nil)
+      ogmanager.store.update_properties(self, set, options)
+    end
+    alias_method :pupdate, :update_properties
+    alias_method :update_property, :update_properties
+    alias_method :batch_update, :update_properties
+    
+    def find(options = {})
+      # gmosx, FIXME: this code seems too complex, 
+      # improve this!
+      
+      if find_options = self.__meta[:find_options]
+        options = find_options.first.dup.update(options)
+      end
+      options[:class] = self
+      if self.metadata.superclass
+        options[:type] = self
+      end
+      ogmanager.store.find(options)
+    end
+    alias_method :all, :find
+
+    def find_one(options = {})
+      options[:class] = self
+      ogmanager.store.find_one(options)
+    end
+    alias_method :one, :find_one
+    alias_method :first, :find_one
+
+    def select(sql)
+      ogmanager.store.select(sql, self)
+    end
+
+    def select_one(sql)
+      ogmanager.store.select_one(sql, self)
+    end
+    
+    def count(options = {})
+      options[:class] = self
+      ogmanager.store.count(options)
+    end
+
+    # Delete an instance of this Entity class using the actual
+    # instance or the primary key.
+    
+    def delete(obj_or_pk)
+      ogmanager.store.delete(obj_or_pk, self)
+    end
+    alias_method :delete!, :delete
+
+    def transaction(&block)
+      ogmanager.store.transaction(&block)
+    end
+    
+    def primary_key
+      unless @__meta and @__meta[:primary_key]
+        self.meta :primary_key, Entity.resolve_primary_key(self)
+      end
+      @__meta[:primary_key].flatten
+    end
+    
+    # Set the default find options for this entity.
+    
+    def find_options(options)
+      meta :find_options, options
+    end
+    
+    # Set the default order option for this entity.
+    
+    def order(order_str)
+      meta :find_options, :order => order_str
+    end
+
+    # Enable schema inheritance for this Entity class.
+    # The Single Table Inheritance pattern is used.
+        
+    def schema_inheritance
+      meta :schema_inheritance
+    end
+
+    # Is this entity a polymorphic parent?
+        
+    def polymorphic_parent?
+      self.to_s == self.metadata.polymorphic.to_s
+    end
+
+    # Used internally to fix the forward reference problem.
+        
+    def const_missing(sym) # :nodoc: all
+      return sym
+    end    
+  end
 end
 
 # A helper class.
 
 class Entity 
-	class << self
-		def resolve_primary_key(klass)
-			for p in klass.properties
-				if p.meta[:primary_key]
-					return p.symbol, p.klass
-				end
-			end
-			return :oid, Fixnum
-		end
-	end
-	
-	include EntityMixin
+  class << self
+    def resolve_primary_key(klass)
+      for p in klass.properties
+        if p.meta[:primary_key]
+          return p.symbol, p.klass
+        end
+      end
+      return :oid, Fixnum
+    end
+  end
+  
+  include EntityMixin
 end
 
 end