og 0.25.0 → 0.26.0

data/ProjectInfo

@@ -2,7 +2,7 @@
 
 TITLE    : &title Og
 NAME     : &pkg og
-VERSION  : '0.25.0'
+VERSION  : '0.26.0'
 STATUS   : beta
 
 AUTHOR   : George Moschovitis
@@ -17,7 +17,7 @@ DESCRIPTION: >
   KirbyBase, Filesystem and more.
 
 DEPENDENCIES:
- - [ glue, '= 0.25.0' ]
+ - [ glue, '= 0.26.0' ]
 
 DISTRIBUTE: [ gem, tgz, zip ]
 

data/README

@@ -1,4 +1,4 @@
-= Og 0.24.0 README
+= Og 0.26.0 README
 
 Og (ObjectGraph) is a powerful and elegant object-relational mapping 
 library. Og manages the lifecycle of Ruby objects and  provides 

data/doc/RELEASES

@@ -1,3 +1,81 @@
+== Version 0.26.0
+
+This is the release with the most community contributions. Check 
+out the great new stuff. Download now!
+
+Most notable changes:
+
+* New CacheSweeper mixin. Using this mixin allows you to keep
+  the cache cleaning logic in one place. This logic is called
+  automagically by many default Nitro/Og methods (for example
+  Og insert/update, scaffolding, etc). You can fully customize
+  the behaviour.
+  
+  class Article
+    include CacheSweeper
+    
+    def expire_affected(action = :all)
+      expire_affected_output('articles/view')
+      ...
+    end
+  end
+  
+  a = Article[1]
+  a.title = 'New'
+  a.save # => calls expire_affected.
+  
+* Searchable mixin. Include this mixin to your classes to make
+  them searchable by the auto administration system.
+  
+* Better validations implementation. Cleaner code, less evals,
+  more flexible and easier to extend.
+   
+* New scaffolding / auto administration system. The implementation
+  is much cleaner and easier to customize. It leverages the latest
+  advancements (dispatcher, sweeper, etc) and adds search support,
+  pager, breadcrumps and more. You can define your own controls 
+  to handle properties and relations. Stay tuned for more stuff 
+  in the near future.
+
+* New Og revisable mixin. Just include this mixin in your classes
+  and get db backed revision support for free. Here comes an
+  example:
+  
+  class Article
+   is Revisable
+   property :body, String, :revisable => true
+   property :title, String
+  end
+
+  Automatically generates the Revision class (and the 
+  backend schema):
+ 
+  class Article::Revision
+ 
+  article.revisions
+ 
+  article.revise do |a|
+    a.title = 'hello'
+    a.body = 'world'
+  end
+ 
+  article.rollback(4)
+
+* Bug fixed KirbyBase Og adapter. This works great with the
+  new 2.5 gem.
+
+* Added more rational defaults, and many predefined options to
+  minimize the amount of setup needed to get your app running. Of
+  course you can still customize just about everything in Nitro.
+
+* Improvements to PostgreSQL automatic generation of foreign key 
+  constraints.
+
+* Added evolution support to the MySql store.
+
+* Many, many, many bug fixes and smaller improvements.
+
+
 == Version 0.25.0
 
 This is the first in a series of releases focused on stability 

data/lib/glue/revisable.rb

@@ -1,2 +1,124 @@
+module Glue
 
-raise 'This is not working yet, do not require this file.'
+# Revision support for Og-managed classes.
+#
+# class Article
+#  is Revisable
+#  property :body, String, :revisable => true
+#  property :title, String
+# end
+#
+# Generates the Revision class:
+#
+# class Article::Revision
+#
+# article.revisions
+#
+# article.revise do |a|
+#   a.title = 'hello'
+#   a.body = 'world'
+# end
+#
+# article.rollback(4)
+
+module Revisable
+  # The revision of the revisable object.
+  
+  property :revision, Fixnum
+  
+  # This mixin is injected into the dynamically generated
+  # Revision class. You can customize this in your application
+  # to store extra fields per revision.
+  
+  module Mixin
+    # The create time for the revision.
+    
+    property :create_time, Time
+  
+    # Override to handle your options.
+    
+    def initialize(obj, options = {})
+      revision_from(obj)
+      @create_time = Time.now
+    end
+    
+    def revision_from(obj)
+      for prop in obj.class.properties.values
+        # gmosx, FIXME: test against primary key, not oid.
+        unless prop.symbol == :oid
+          instance_variable_set "@#{prop}", obj.send(prop.to_s) 
+        end
+      end
+    end
+    
+    def revision_to(obj)
+      for prop in obj.class.properties.values
+        # gmosx, FIXME: test against primary key, not oid.
+        unless prop.symbol == :oid
+          obj.instance_variable_set "@#{prop}", self.send(prop.to_s) 
+        end
+      end
+    end    
+    alias_method :apply_to, :revision_to
+  end
+
+  def self.included(base)
+    super
+    
+    base.module_eval %{
+      class Revision < #{base}
+        include Revisable::Mixin
+        belongs_to #{base}
+      end
+    }
+    
+    base.has_many :revisions, base::Revision
+  end
+
+  # Can accept options like owner or a comment.
+  # You can specialize this in your app.
+  
+  def revise(options = {})
+    if self.revision.nil? 
+      self.revision = 1 
+    else
+      self.revision += 1
+    end
+    self.revisions << self.class::Revision.new(self, options)
+    yield(self) if block_given?
+    self.save
+  end
+  alias_method :revise!, :revise
+
+  # Rollback to an older revision.
+  
+  def rollback(rev, options = {})
+    self.revise(options) { |obj| get_revision(rev).apply_to(obj) }
+  end
+
+  # Return a revision.
+  
+  def get_revision(rev)
+    return self if rev.to_i == self.revision
+    self.revisions.find_one(:condition => "revision=#{rev}")
+  end
+
+  # Return the last revision.
+  
+  def last_revision
+    self.revisions(:order => 'revision DESC', :limit => 1).first
+  end
+
+  # The number of revisions.
+  
+  def revision_count
+    self.revisions.count
+  end
+  alias_method :revisions_count, :revision_count
+  
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>
+# * Dirk Barnikel <dirk.barnikel@gmx.de>

data/lib/glue/searchable.rb

@@ -0,0 +1,28 @@
+module Glue
+
+# Search support for Og managed classes.
+
+module Searchable
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    # Override this method in your class to customize the
+    # search. This is a nice default method.
+    
+    def search(query)
+      search_props = properties.values.select { |p| p.searchable }
+      condition = search_props.collect { |p| "#{p} LIKE '%#{query}%'" }.join(' OR ') 
+      all(:condition => condition)
+    end
+  
+  end
+  
+end
+
+end
+
+# * George Moschovitis <gm@navel.gr>

data/lib/glue/taggable.rb

@@ -41,6 +41,10 @@ class Tag
   def self.total_frequency(tags = Tag.all)
     tags.inject(1) { |total, t| total += t.count }
   end
+  
+  def to_s
+    @name
+  end
 end
 
 module Glue
@@ -65,7 +69,12 @@ module Glue
 # Tag.find_by_name('ruby').articles
 
 module Taggable
+  # The tag string separator.
+  
+  setting :separator, :default => ' ', :doc => 'The tag string separator'
+
   include Og::EntityMixin
+  
   many_to_many Tag
   
   # Add a tag for this object.
@@ -78,7 +87,7 @@ module Taggable
     self.tags.clear if options[:clear]
     
     for name in Taggable.tags_to_names(the_tags)
-      Tag.find_or_create_by_name(name).tag(self)
+      Tag.find_or_create_by_name(name).tag(self) unless self.tagged_with?(name)
     end    
   end
   alias_method :tag!, :tag  
@@ -89,6 +98,12 @@ module Taggable
     tags.collect { |t| t.name }
   end
 
+  # Return the tag string
+  
+  def tag_string(separator = Taggable.separator)
+    tags.collect { |t| t.name }.join(separator)    
+  end
+
   # Checks to see if this object has been tagged 
   # with +tag_name+.
   
@@ -125,7 +140,7 @@ module Taggable
     # UNION (OR)
   
     def find_with_any_tag(*names)
-      info = ogmanager.store.join_table_info(self, tag)
+      info = ogmanager.store.join_table_info(self, Tag)
       count = names.size
       names = names.map { |n| "'#{n}'" }.join(',')
       sql = %{        
@@ -158,7 +173,7 @@ module Taggable
   
   # Helper.
   
-  def self.tags_to_names(the_tags, separator = ' ')
+  def self.tags_to_names(the_tags, separator = Taggable.separator)
     if the_tags.is_a? Array
       names = the_tags 
     elsif the_tags.is_a? String

data/lib/glue/timestamped.rb

@@ -9,9 +9,9 @@ module Glue
 module Timestamped
   include Aspects
 
-  property :create_time, Time, :editor => :none
-  property :update_time, Time, :editor => :none
-  property :access_time, Time, :editor => :none
+  property :create_time, Time, :control => :none
+  property :update_time, Time, :control => :none
+  property :access_time, Time, :control => :none
 
   before "@create_time = @update_time = Time.now", :on => :og_insert
   before "@update_time = Time.now", :on => :og_update
@@ -28,8 +28,8 @@ end
 
 module TimestampedOnCreate
   include Aspects
-  property :create_time, Time, :editor => :none
-  before "@create_time = @update_time = Time.now", :on => :og_insert
+  property :create_time, Time, :control => :none
+  before "@create_time = Time.now", :on => :og_insert
 end
 
 end

data/lib/og.rb

@@ -43,7 +43,7 @@ module Og
 
   # The version.
 
-  Version = '0.24.0'
+  Version = '0.26.0'
 
   # Library path.
 
@@ -110,8 +110,32 @@ module Og
     # as the default store.
 
     def setup(options = {:store => :sqlite})
-      m = @@manager = Manager.new(options)
-      m.manage_classes
+      begin
+        # This is a flag a store or manager can use to determine
+        # if it was being called by Og.setup to provide
+        # additional, faster or enhanced functionality.
+
+        puts options[:called_by_og_setup]
+        options[:called_by_og_setup] = true if options[:called_by_og_setup].nil?
+        
+        m = @@manager = Manager.new(options)        
+        m.manage_classes
+        
+        # Allows functionality that requires a store is finalized
+        # to be implemented. A vastly superior method of constructing
+        # foreign key constraints is an example of functionality
+        # this provides. Currently only used by the PostgreSQL store.
+        
+        m.post_setup if options[:called_by_og_setup]
+      rescue Exception => ex 
+        Logger.error "Og.setup had problems: #{ex.class} => #{ex.message}"
+        if $DBG
+          Logger.error ex.inspect 
+          Logger.error ex.backtrace.join("\n")          
+          exit 
+        end
+      end
+
       return m
     end
     alias_method :connect, :setup
@@ -138,4 +162,4 @@ require 'og/types'
 require 'og/validation'
 require 'og/markers'
 
-# * George Moschovitis <gm@navel.gr>
+# * George Moschovitis <gm@navel.gr>

data/lib/og/collection.rb

@@ -113,8 +113,11 @@ class Collection
   end
   
   # Add a new member to the collection.
+  # this method will overwrite any objects already
+  # existing in the collection
   
   def push(obj, options = nil)
+    remove(obj) if members.include?(obj)
     @members.push(obj)
     unless @building or owner.unsaved?
       @owner.send(@insert_proc, obj, options)
@@ -125,6 +128,9 @@ class Collection
 
   # Remove a member from the collection, the actual object
   # is not deleted.
+  #--
+  # TODO: add remove by oid!
+  #++
   
   def remove(*objects)
     objects = objects.flatten
@@ -141,6 +147,9 @@ class Collection
   end
 
   # Delete a member from the collection AND the store.
+  #--
+  # TODO: add delete by oid!
+  #++
   
   def delete(*objects)
     objects = objects.flatten
@@ -213,6 +222,12 @@ class Collection
     end
   end
 
+  # Find one object.
+  
+  def find_one(options = {})
+    find(options).first
+  end
+
   # Redirect all other methods to the members array.
   
   def method_missing(symbol, *args, &block)

data/lib/og/entity.rb

@@ -12,9 +12,13 @@ module EntityMixin
 
   def save(options = nil)
     self.class.ogmanager.store.save(self, options)
-    # return self
   end
   alias_method :save!, :save
+  alias_method :validate_and_save, :save
+
+  def force_save!(options = nil)
+    self.class.ogmanager.store.force_save(self, options)
+  end
 
   def insert
     self.class.ogmanager.store.insert(self)
@@ -70,6 +74,16 @@ module EntityMixin
   end
   alias_method :assign, :assign_properties
 
+  # Returns a symbol => value hash of the object's 
+  # properties.
+  
+  def properties_to_hash
+    hash = {}
+    for sym, prop in self.class.properties
+      hash[sym] = instance_variable_get("@#{sym}")
+    end
+  end
+
   include RelationDSL
 
   class_inherit do
@@ -106,10 +120,16 @@ module EntityMixin
     alias_method :[], :load
     alias_method :exist?, :load
 
+    # Update the representation of this class in the 
+    # store.
+    
     def update(set, options = nil)
       ogmanager.store.update_by_sql(self, set, options)
     end
 
+    # Find a specific instance of this class according
+    # to the given conditions.
+    
     def find(options = {})
       if find_options = self.ann.self[:find_options]
         options = find_options.dup.update(options)
@@ -122,6 +142,8 @@ module EntityMixin
     end
     alias_method :all, :find
 
+    # Find a single instance of this class.
+    
     def find_one(options = {})
       options[:class] = self
       ogmanager.store.find_one(options)
@@ -137,6 +159,8 @@ module EntityMixin
       ogmanager.store.select_one(sql, self)
     end
 
+    # Perform a count query.
+    
     def count(options = {})
       options[:class] = self
       ogmanager.store.count(options)
@@ -177,8 +201,13 @@ module EntityMixin
       ogmanager.store
     end
 
+    # Returns the primary key for this class.
+    
     def primary_key
-      unless pk = ann.self[:primary_key]
+      # gmosx: LEAVE as is, seems to be a workaround for a
+      # nasty bug in the current facets version.
+      pk = ann.self.primary_key
+      if pk.nil?
         pk = Entity.resolve_primary_key(self)
         ann :self, :primary_key => pk
       end
@@ -246,7 +275,8 @@ module EntityMixin
     # Set the primary key.
 
     def set_primary_key(pk, pkclass = Fixnum)
-      ann self, :primary_key => Property.new(:symbol => pk, :klass => pkclass)
+      #ann self, :primary_key => Property.new(:symbol => pk, :klass => pkclass)
+      ann self, :primary_key => properties[pk].dup
     end
 
     # Is this entity a polymorphic parent?
@@ -323,52 +353,18 @@ module EntityMixin
     
     def method_missing(sym, *args)
       if match = /find_(all_by|by)_([_a-zA-Z]\w*)/.match(sym.to_s)    
-        finder = (match.captures.first == 'all_by' ? :find : :find_one)
-        attrs = match.captures.last.split('_and_')
-        
-        if args.last.is_a?(Hash)
-          options = args.pop
-        else
-          options = {}
-        end
-        
-        condition = []
-        attrs.each_with_index do |a, idx| 
-          condition << %|#{a} #{options.delete("#{a}_op".to_sym) || '='} #{ogmanager.store.quote(args[idx])}|
-        end
-
-        options.update(
-          :class => self,
-          :condition => condition.join(' AND ')
-        )
-        
-        return ogmanager.store.send(finder, options)
+        return finder(match, args)
       elsif match = /find_or_create_by_([_a-zA-Z]\w*)/.match(sym.to_s)
-        finder = (match.captures.first == 'all_by' ? :find : :find_one)
-        attrs = match.captures.last.split('_and_')
-        
-        if args.last.is_a?(Hash)
-          options = args.pop
-        else
-          options = {}
-        end
+        obj = finder(match, args)
         
-        condition = []
-        attrs.each_with_index do |a, idx| 
-          condition << %|#{a} #{options.delete("#{a}_op".to_sym) || '='} #{ogmanager.store.quote(args[idx])}|
-        end
-
-        options.update(
-          :class => self,
-          :condition => condition.join(' AND ')
-        )
-        
-        unless obj = ogmanager.store.send(finder, options)
+        unless obj
+          attrs = match.captures.last.split('_and_')
           obj = self.create do |obj|
-            attrs.each_with_index do |a, idx| 
-              obj.instance_variable_set "@#{a}", args[idx]
+            attrs.zip(args).map do |name, value|
+              obj.instance_variable_set "@#{name}", value
             end
           end 
+          yield(obj) if block_given?
         end
         
         return obj          
@@ -376,6 +372,30 @@ module EntityMixin
         super
       end
     end
+
+private
+
+    # Helper method for dynamic finders. Finds the object dynamically parsed 
+    # method name is after.
+
+    def finder(match, args)
+      finder = (match.captures.first == 'all_by' ? :find : :find_one)
+      attrs = match.captures.last.split('_and_')
+        
+      options = {}
+      options = args.pop if args.last.is_a?(Hash)
+
+      condition = attrs.zip(args).map do |name, value|
+        %|#{name} #{options.delete("#{name}_op".to_sym) || '='} #{ogmanager.store.quote(value)}|
+      end.join(' AND ')
+
+      options.update(
+        :class => self,
+        :condition => condition
+      )
+
+      return ogmanager.store.send(finder, options)
+    end
     
   end