og 0.31.0 → 0.40.0

data/lib/glue/revisable.rb

@@ -3,9 +3,9 @@ module Glue
 # Revision support for Og-managed classes.
 #
 # class Article
-#  is Revisable
-#  property :body, String, :revisable => true
-#  property :title, String
+#   is Revisable
+#   property :body, String, :revisable => true
+#   property :title, String
 # end
 #
 # Generates the Revision class:
@@ -24,7 +24,7 @@ module Glue
 module Revisable
   # The revision of the revisable object.
   
-  property :revision, Fixnum
+  attr_accessor :revision, Fixnum
   
   # This mixin is injected into the dynamically generated
   # Revision class. You can customize this in your application
@@ -37,38 +37,36 @@ module Revisable
   
     # Override to handle your options.
     
-    def initialize(obj, 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) 
+    def revision_from obj
+      for a in obj.class.serializable_attributes
+        unless a == obj.class.primary_key
+          instance_variable_set "@#{a}", obj.send(a.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) 
+    def revision_to obj
+      for a in obj.class.serializable_attributes
+        unless a == obj.class.primary_key
+          obj.instance_variable_set "@#{a}", self.send(a.to_s)
         end
       end
     end    
     alias_method :apply_to, :revision_to
   end
 
-  def self.included(base)
+  def self.included base
     super
     
     base.module_eval %{
       class Revision < #{base}
         include Revisable::Mixin
-        belongs_to #{base}
+        refers_to #{base}
       end
     }
     
@@ -78,7 +76,7 @@ module Revisable
   # Can accept options like owner or a comment.
   # You can specialize this in your app.
   
-  def revise(options = {})
+  def revise options = {}
     if self.revision.nil? 
       self.revision = 1 
     else
@@ -92,13 +90,13 @@ module Revisable
 
   # Rollback to an older revision.
   
-  def rollback(rev, options = {})
+  def rollback rev, options = {}
     self.revise(options) { |obj| get_revision(rev).apply_to(obj) }
   end
 
   # Return a revision.
-  
-  def get_revision(rev)
+ 
+  def get_revision rev
     return self if rev.to_i == self.revision
     self.revisions.find_one(:condition => "revision=#{rev}")
   end
@@ -119,6 +117,3 @@ module Revisable
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>
-# * Dirk Barnikel <dirk.barnikel@gmx.de>

data/lib/glue/searchable.rb

@@ -24,5 +24,3 @@ module Searchable
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/taggable.rb

@@ -12,7 +12,7 @@ require 'facet/inflect'
 #++
 
 class Tag
-  property :name, String, :uniq => true
+  property :name, String, :uniq => true, :key => true
   property :count, Fixnum
   
   # An alias for count.
@@ -97,10 +97,10 @@ module Glue
 #    ..
 #  end
 #
-# article.tag('navel', 'gmosx', 'nitro')
+# article.tag('great', 'gmosx', 'nitro')
 # article.tags
 # article.tag_names
-# Article.find_with_tags('navel', 'gmosx')
+# Article.find_with_tags('great', 'gmosx')
 # Article.find_with_any_tag('name', 'gmosx')
 #
 # Tag.find_by_name('ruby').articles
@@ -142,6 +142,7 @@ module Taggable
   
   def delete_all_tags
     for tag in tags
+      tag.reload
       tag.unlink
     end
     tags.clear
@@ -160,6 +161,13 @@ module Taggable
     tags.collect { |t| t.name }.join(separator)    
   end
 
+  # Return the linked tag string.
+  # Typically you will overrie this in your application.
+  
+  def tag_string_linked(separator = Taggable.separator)
+    tags.collect { |t| %|<a href="/tags/#{t.name}">#{t.name}</a>| }.join(separator)    
+  end
+
   # Checks to see if this object has been tagged 
   # with +tag_name+.
   
@@ -173,7 +181,24 @@ module Taggable
     # INTERSECTION (AND)
   
     def find_with_tags(*names)
-      return find_request(:all, names)
+      relation = relations.reject{|r| r.name != :tags}.first
+      info = ogmanager.store.join_table_info(relation)
+      count = names.size
+      names = names.map { |n| ogmanager.store.quote(n) }.join(',')
+      sql = %{
+        SELECT *
+        FROM #{info[:owner_table]} AS o
+        WHERE o.oid IN (
+          SELECT j.#{info[:owner_key]}
+          FROM #{info[:target_table]} AS t
+          JOIN #{info[:table]} AS j
+          ON t.oid = j.#{info[:target_key]}
+          WHERE (t.name IN (#{names}))
+          GROUP BY j.#{info[:owner_key]}
+          HAVING COUNT(j.#{info[:owner_key]}) = #{count}
+        )
+      }
+      return self.select(sql)
     end
     alias_method :find_with_tag, :find_with_tags
   
@@ -181,29 +206,9 @@ module Taggable
     # UNION (OR)
   
     def find_with_any_tag(*names)
-      return find_request(:any, names)
-    end
-
-    private
-
-    def find_request(request_type, names)
-      condition = ""
-      opt = names.last
-      if opt.is_a?(Hash)
-	names.pop
-	escaped_condition = ogmanager.store.prepare_statement(opt[:condition])
-	#escaped_condition = ogmanager.store.escape_condition(opt[:condition])
-        condition = "AND #{escaped_condition}"
-      end
-
-      relation = relations.detect {|r| r.name == :tags}
+      relation = relations.reject{|r| r.name != :tags}.first
       info = ogmanager.store.join_table_info(relation)
-
-      if request_type == :all
-        count = names.size
-        additionnal_code = "HAVING COUNT(j.#{info[:owner_key]}) = #{count}"
-      end
-
+      count = names.size
       names = names.map { |n| ogmanager.store.quote(n) }.join(',')
       sql = %{        
         SELECT *
@@ -215,7 +220,6 @@ module Taggable
           ON t.oid = j.#{info[:target_key]}
           WHERE (t.name IN (#{names}))
           GROUP BY j.#{info[:owner_key]}
-	  #{additionnal_code}
           )
       }
       return self.select(sql)
@@ -250,5 +254,3 @@ module Taggable
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/glue/timestamped.rb

@@ -4,6 +4,10 @@ require 'facets/more/aspects'
 module Glue
 
 # Adds timestamping functionality.
+#--
+# TODO: add an initialize method that inits times 
+# before saving?
+#++
 
 module Timestamped
   include ::Aspects
@@ -32,5 +36,3 @@ module TimestampedOnCreate
 end
 
 end
-
-# * George Moschovitis <gm@navel.gr>

data/lib/og.rb

@@ -1,12 +1,11 @@
 # = Og
 #
 # Copyright (c) 2004-2006, George Moschovitis (http://www.gmosx.com)
-# Copyright (c) 2004-2006, Navel Ltd (http://www.navel.gr)
 #
 # Og (http://www.nitroproject.org) is copyrighted free software 
-# created and maintained by George Moschovitis (mailto:gm@navel.gr) 
-# and released under the standard BSD Licence. For details 
-# consult the file doc/LICENCE.
+# created and maintained by George Moschovitis 
+# (mailto:george.moschovitis@gmail.com) and released under the 
+# standard BSD Licence. For details consult the file doc/LICENCE.
 
 require 'facet/synchash'
 require 'facet/syncarray'
@@ -35,7 +34,7 @@ require 'glue/configuration'
 # === Design
 #
 # Og allows the serialization of arbitrary Ruby objects. Just
-# mark them as Object (or Array or Hash) in the prop_accessor
+# mark them as Object (or Array or Hash) in the attr_accessor
 # and the engine will serialize a YAML dump of the object.
 # Arbitrary object graphs are supported too.
 
@@ -43,12 +42,16 @@ module Og
 
   # The version.
 
-  Version = '0.31.0'
+  Version = '0.40.0'
 
   # Library path.
 
   LibPath = File.dirname(__FILE__)
 
+  # The default setup for Og managers.
+  
+  setting :manager_options, :default => { :adapter => :sqlite }, :doc => 'The default setup for Og managers'
+
   # If true, check for implicit changes in the object 
   # graph. For example when you add an object to a parent
   # the object might be removed from his previous parent.
@@ -85,6 +88,11 @@ module Og
 
   setting :create_schema, :default => true, :doc => 'If true, Og tries to create/update the schema in the data store'
 
+  # If true, Og destroys the schema on startup. Useful while
+  # developing / debugging.
+  
+  setting :destroy_schema, :default => false, :doc => 'If true, Og destroys the schema on startup'
+  
   # If true raises exceptions on store errors, usefull when
   # debugging. For production environments it should probably be 
   # set to false to make the application more fault tolerant.
@@ -125,32 +133,47 @@ module Og
     # If no options are passed, sqlite is selected
     # as the default store.
 
-    def setup(options = {})
-        options={:store => :sqlite}.update(options)
-        # 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.
+    def start(options = Og.manager_options)
+      # Use sqlite as the default adapter.
+      
+      unless options[:adapter] || options[:store]
+        options[:adapter] = :sqlite
+      end
 
-        options[:called_by_og_setup] = true if options[:called_by_og_setup].nil?
+      # 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.
 
-        @thread_safe = options.fetch(:thread_safe, true)
+      options[:called_by_og_setup] = true if options[:called_by_og_setup].nil?
 
-        m = @manager = Manager.new(options)        
-        m.manage_classes
+      @thread_safe = true
 
-        # 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]
+      m = @manager = Manager.new(options)        
+      m.manage_classes(options[:classes])
+
+      # Allows functionality that requires an initialized 
+      # store 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]
+      
       return m
+    rescue Exception => ex 
+      Logger.error "#{ex.class} in Og.setup:"
+      Logger.error ex.message
+      if $DBG
+        Logger.error ex.backtrace.join("\n")          
+        exit 
+      end
     end
-    alias_method :connect, :setup
-    alias_method :options=, :setup
-    alias_method :setup=, :setup
-    alias_method :start, :setup
+    
+    alias run start
+    alias connect start
+    # The following is deprecated, used for compatibility.
+    alias setup start
+    alias setup= start
 
     # Helper method.
 
@@ -169,7 +192,7 @@ module Og
     def thread_safe=(bool)
       @thread_safe = bool
 #      @manager and @manager.class.managers.each { |m| m.initialize_store }
-      @thread_safe
+      return @thread_safe
     end
   end
 
@@ -184,5 +207,3 @@ require 'og/errors'
 require 'og/types'
 require 'og/validation'
 require 'og/markers'
-
-# * George Moschovitis <gm@navel.gr>

data/lib/og/adapter.rb

@@ -0,0 +1,19 @@
+require 'og/store'
+
+module Og
+
+# A specialization of a Store.
+
+class Adapter < Store
+
+  # Load the store for the given name.
+
+  def self.for_name name
+    Logger.info "Og uses the #{name.to_s.capitalize} store."
+    require('og/adapter/' + name.to_s)
+    return Og.const_get("#{name.to_s.capitalize}Adapter")
+  end
+
+end
+
+end

data/lib/og/adapter/mysql.rb

@@ -0,0 +1,212 @@
+begin
+  require 'mysql'
+rescue Object => ex
+  Logger.error 'Ruby-Mysql bindings are not installed!'
+  Logger.error 'Trying to use the pure-Ruby binding included in Og'
+  begin
+    # Attempt to use the included pure ruby version.
+    require 'og/vendor/mysql'
+  rescue Object => ex
+    Logger.error ex
+  end
+end
+
+require 'og/store/sql'
+require 'og/adapter/mysql/override'
+require 'og/adapter/mysql/utils'
+
+module Og
+
+# A Store that persists objects into a MySQL database.
+# To read documentation about the methods, consult 
+# the documentation for SqlStore and Store.
+#
+# Here is some useful code to initialize your MySQL 
+# RDBMS for development. You probably want to be
+# more careful with provileges on your production
+# environment.
+#
+# mysql> GRANT ALL PRIVELEGES 
+# ON keystone.*
+# TO <$sys_dbuser name>@localhost
+# IDENTIFIED BY '(password)'
+# WITH GRANT OPTION;
+
+class MysqlAdapter < SqlStore
+  include MysqlUtils; extend MysqlUtils
+
+  # Initialize the MySQL store.
+  #
+  # === Options
+  #
+  # * :name, the name of the database.
+  # * :user, the username for using the database.
+  # * :password, the password of the database user.
+  # * :address, the addres where the server is listening.
+  # * :port, the port where the server is listening.
+  # * :socket, is useful when the pure ruby driver is used.
+  #    this is the location of mysql.sock. For Ubuntu/Debian 
+  #    this is '/var/run/mysqld/mysqld.sock'. You can find
+  #    the location for your system in my.cnf
+
+  def initialize(options)
+    super
+
+    @typemap.update(TrueClass => 'tinyint', Time => 'datetime')
+
+    @conn = Mysql.connect(
+      options[:address] || options[:host] || 'localhost', 
+      options[:user],
+      options[:password], 
+      options[:name],
+      options[:port],
+      options[:socket]
+    )
+
+    # You should set recconect to true to avoid MySQL has
+    # gone away errors.
+
+    if @conn.respond_to? :reconnect
+      options[:reconnect] = true unless options.has_key?(:reconnect)
+      @conn.reconnect = options[:reconnect]
+    end
+
+  rescue Object => ex
+    if database_does_not_exist_exception? ex
+      Logger.info "Database '#{options[:name]}' not found!"
+      create_db(options)
+      retry
+    end
+    
+    raise
+  end
+
+  def close
+    @conn.close
+    super
+  end
+
+  # Create a database.
+  
+  def create_db(options)
+    # gmosx: system is used to avoid shell expansion.
+    system 'mysqladmin', '-f', "--user=#{options[:user]}", 
+        "--password=#{options[:password]}", 
+        "--host=#{options[:address]}",
+        "--port=#{options.fetch(:port, 3306)}" ,        
+        'create', options[:name]    
+    super        
+  end
+
+  # Drop a database.
+  
+  def destroy_db(options)
+    system 'mysqladmin', '-f', "--user=#{options[:user]}", 
+        "--password=#{options[:password]}",
+        "--host=#{options[:address]}",
+        "--port=#{options.fetch(:port, 3306)}" ,        
+        'drop', options[:name]
+    super
+  end
+  
+  # The type used for default primary keys.
+  
+  def primary_key_type
+    'integer AUTO_INCREMENT PRIMARY KEY'
+  end
+
+  def query_statement(sql)
+    @conn.query_with_result = true 
+    return @conn.query(sql)
+  end
+
+  def exec_statement(sql)
+    @conn.query_with_result = false
+    @conn.query(sql)
+  end
+
+  # Perform an sql update, return the number of updated rows.
+  
+  def sql_update(sql)
+    exec(sql)
+    @conn.affected_rows
+  end
+
+  # Return the last inserted row id.
+  
+  def last_insert_id(klass = nil) 
+    @conn.insert_id
+  end
+  
+  # Start a transaction.
+  
+  def start
+    # nop
+    # FIXME: InnoDB supports transactions.
+  end
+
+  # Commit a transaction.
+
+  def commit
+    # nop, not supported?
+    # FIXME: InnoDB supports transactions.
+  end
+
+  # Rollback a transaction.
+
+  def rollback
+    # nop, not supported?
+    # FIXME: InnoDB supports transactions.
+  end
+
+  def write_attr(s, a)
+    store = self.class
+    
+    if a.class.ancestor? Integer
+      "#\{@#{s} || 'NULL'\}"
+    
+    elsif a.class.ancestor? Float
+      "#\{@#{s} || 'NULL'\}"    
+    
+    elsif a.class.ancestor? String
+      %|#\{@#{s} ? "'#\{#{store}.escape(@#{s})\}'" : 'NULL'\}|
+    
+    elsif a.class.ancestor? Time
+      %|#\{@#{s} ? "'#\{#{store}.timestamp(@#{s})\}'" : 'NULL'\}|
+    
+    elsif a.class.ancestor? Date 
+      %|#\{@#{s} ? "'#\{#{store}.date(@#{s})\}'" : 'NULL'\}|
+    
+    elsif a.class.ancestor? TrueClass
+      "#\{@#{s} ? \"'1'\" : 'NULL' \}"
+    
+    elsif a.class.ancestor? Og::Blob 
+      %|#\{@#{s} ? "'#\{#{store}.escape(#{store}.blob(@#{s}))\}'" : 'NULL'\}|      
+    
+    else 
+      # keep the '' for nil symbols.
+      %|#\{@#{s} ? "'#\{#{store}.escape(@#{s}.to_yaml)\}'" : "''"\}|
+    end
+  end    
+
+  # Returns the MySQL information of a table within the database or
+  # nil if it doesn't exist. Mostly for internal usage.
+
+  def table_info(table)
+    r = query_statement("SHOW TABLE STATUS FROM #{@options[:name]} LIKE '#{self.class.escape(table.to_s)}'")
+    return r && r.blank? ? nil : r.next
+  end
+
+private
+
+  def database_does_not_exist_exception?(ex)
+    ex.errno == 1049
+  end
+  
+  def table_already_exists_exception?(ex)
+    ex.errno == 1050 # table already exists.
+  end    
+  
+end
+
+end