activerecord_authorails 1.0.0

data/lib/active_record/observer.rb

@@ -0,0 +1,178 @@
+require 'singleton'
+require 'set'
+
+module ActiveRecord
+  module Observing # :nodoc:
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      # Activates the observers assigned. Examples:
+      #
+      #   # Calls PersonObserver.instance
+      #   ActiveRecord::Base.observers = :person_observer
+      #
+      #   # Calls Cacher.instance and GarbageCollector.instance
+      #   ActiveRecord::Base.observers = :cacher, :garbage_collector
+      #
+      #   # Same as above, just using explicit class references
+      #   ActiveRecord::Base.observers = Cacher, GarbageCollector
+      #
+      # Note: Setting this does not instantiate the observers yet.  #instantiate_observers is
+      # called during startup, and before each development request.  
+      def observers=(*observers)
+        @observers = observers.flatten
+      end
+
+      # Gets the current observers.
+      def observers
+        @observers ||= []
+      end
+
+      # Instantiate the global ActiveRecord observers
+      def instantiate_observers
+        return if @observers.blank?
+        @observers.each do |observer|
+          if observer.respond_to?(:to_sym) # Symbol or String
+            observer.to_s.camelize.constantize.instance
+          elsif observer.respond_to?(:instance)
+            observer.instance
+          else
+            raise ArgumentError, "#{observer} must be a lowercase, underscored class name (or an instance of the class itself) responding to the instance method. Example: Person.observers = :big_brother # calls BigBrother.instance"
+          end
+        end
+      end
+
+      protected
+        # Notify observers when the observed class is subclassed.
+        def inherited(subclass)
+          super
+          changed
+          notify_observers :observed_class_inherited, subclass
+        end
+    end
+  end
+
+  # Observer classes respond to lifecycle callbacks to implement trigger-like
+  # behavior outside the original class. This is a great way to reduce the
+  # clutter that normally comes when the model class is burdened with
+  # functionality that doesn't pertain to the core responsibility of the
+  # class. Example:
+  #
+  #   class CommentObserver < ActiveRecord::Observer
+  #     def after_save(comment)
+  #       Notifications.deliver_comment("admin@do.com", "New comment was posted", comment)
+  #     end
+  #   end
+  #
+  # This Observer sends an email when a Comment#save is finished.
+  #
+  #   class ContactObserver < ActiveRecord::Observer
+  #     def after_create(contact)
+  #       contact.logger.info('New contact added!')
+  #     end
+  #
+  #     def after_destroy(contact)
+  #       contact.logger.warn("Contact with an id of #{contact.id} was destroyed!")
+  #     end
+  #   end
+  #
+  # This Observer uses logger to log when specific callbacks are triggered.
+  #
+  # == Observing a class that can't be inferred
+  #
+  # Observers will by default be mapped to the class with which they share a name. So CommentObserver will
+  # be tied to observing Comment, ProductManagerObserver to ProductManager, and so on. If you want to name your observer
+  # differently than the class you're interested in observing, you can use the Observer.observe class method:
+  #
+  #   class AuditObserver < ActiveRecord::Observer
+  #     observe Account
+  #
+  #     def after_update(account)
+  #       AuditTrail.new(account, "UPDATED")
+  #     end
+  #   end
+  #
+  # If the audit observer needs to watch more than one kind of object, this can be specified with multiple arguments:
+  #
+  #   class AuditObserver < ActiveRecord::Observer
+  #     observe Account, Balance
+  #
+  #     def after_update(record)
+  #       AuditTrail.new(record, "UPDATED")
+  #     end
+  #   end
+  #
+  # The AuditObserver will now act on both updates to Account and Balance by treating them both as records.
+  #
+  # == Available callback methods
+  #
+  # The observer can implement callback methods for each of the methods described in the Callbacks module.
+  #
+  # == Storing Observers in Rails
+  #
+  # If you're using Active Record within Rails, observer classes are usually stored in app/models with the
+  # naming convention of app/models/audit_observer.rb.
+  #
+  # == Configuration
+  #
+  # In order to activate an observer, list it in the <tt>config.active_record.observers</tt> configuration setting in your
+  # <tt>config/environment.rb</tt> file.
+  #
+  #   config.active_record.observers = :comment_observer, :signup_observer
+  #
+  # Observers will not be invoked unless you define these in your application configuration.
+  #
+  class Observer
+    include Singleton
+
+    # Observer subclasses should be reloaded by the dispatcher in Rails
+    # when Dependencies.mechanism = :load.
+    include Reloadable::Deprecated
+
+    class << self
+      # Attaches the observer to the supplied model classes.
+      def observe(*models)
+        define_method(:observed_classes) { Set.new(models) }
+      end
+
+      # The class observed by default is inferred from the observer's class name:
+      #   assert_equal [Person], PersonObserver.observed_class
+      def observed_class
+        name.scan(/(.*)Observer/)[0][0].constantize
+      end
+    end
+
+    # Start observing the declared classes and their subclasses.
+    def initialize
+      Set.new(observed_classes + observed_subclasses).each { |klass| add_observer! klass }
+    end
+
+    # Send observed_method(object) if the method exists.
+    def update(observed_method, object) #:nodoc:
+      send(observed_method, object) if respond_to?(observed_method)
+    end
+
+    # Special method sent by the observed class when it is inherited.
+    # Passes the new subclass.
+    def observed_class_inherited(subclass) #:nodoc:
+      self.class.observe(observed_classes + [subclass])
+      add_observer!(subclass)
+    end
+
+    protected
+      def observed_classes
+        Set.new([self.class.observed_class].flatten)
+      end
+
+      def observed_subclasses
+        observed_classes.sum(&:subclasses)
+      end
+
+      def add_observer!(klass)
+        klass.add_observer(self)
+        klass.class_eval 'def after_find() end' unless klass.respond_to?(:after_find)
+      end
+  end
+end

data/lib/active_record/query_cache.rb

@@ -0,0 +1,64 @@
+module ActiveRecord
+  class QueryCache #:nodoc:
+    def initialize(connection)
+      @connection = connection
+      @query_cache = {}
+    end
+
+    def clear_query_cache
+      @query_cache = {}
+    end
+
+    def select_all(sql, name = nil)
+      (@query_cache[sql] ||= @connection.select_all(sql, name)).dup
+    end
+
+    def select_one(sql, name = nil)
+      @query_cache[sql] ||= @connection.select_one(sql, name)
+    end
+
+    def columns(table_name, name = nil)
+      @query_cache["SHOW FIELDS FROM #{table_name}"] ||= @connection.columns(table_name, name)
+    end
+
+    def insert(sql, name = nil, pk = nil, id_value = nil)
+      clear_query_cache
+      @connection.insert(sql, name, pk, id_value)
+    end
+
+    def update(sql, name = nil)
+      clear_query_cache
+      @connection.update(sql, name)
+    end
+
+    def delete(sql, name = nil)
+      clear_query_cache
+      @connection.delete(sql, name)
+    end
+    
+    private
+      def method_missing(method, *arguments, &proc)
+        @connection.send(method, *arguments, &proc)
+      end
+  end
+  
+  class Base
+    # Set the connection for the class with caching on
+    class << self
+      alias_method :connection_without_query_cache=, :connection=
+
+      def connection=(spec)
+        if spec.is_a?(ConnectionSpecification) and spec.config[:query_cache]
+          spec = QueryCache.new(self.send(spec.adapter_method, spec.config))
+        end
+        self.connection_without_query_cache = spec
+      end
+    end
+  end
+  
+  class AbstractAdapter #:nodoc:
+    # Stub method to be able to treat the connection the same whether the query cache has been turned on or not
+    def clear_query_cache
+    end
+  end
+end

data/lib/active_record/reflection.rb

@@ -0,0 +1,222 @@
+module ActiveRecord
+  module Reflection # :nodoc:
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Reflection allows you to interrogate Active Record classes and objects about their associations and aggregations.
+    # This information can, for example, be used in a form builder that took an Active Record object and created input
+    # fields for all of the attributes depending on their type and displayed the associations to other objects.
+    #
+    # You can find the interface for the AggregateReflection and AssociationReflection classes in the abstract MacroReflection class.
+    module ClassMethods
+      def create_reflection(macro, name, options, active_record)
+        case macro
+          when :has_many, :belongs_to, :has_one, :has_and_belongs_to_many
+            reflection = AssociationReflection.new(macro, name, options, active_record)
+          when :composed_of
+            reflection = AggregateReflection.new(macro, name, options, active_record)
+        end
+        write_inheritable_hash :reflections, name => reflection
+        reflection
+      end
+      
+      # Returns a hash containing all AssociationReflection objects for the current class
+      # Example:
+      #
+      #   Invoice.reflections
+      #   Account.reflections
+      #
+      def reflections
+        read_inheritable_attribute(:reflections) || write_inheritable_attribute(:reflections, {})
+      end
+       
+      # Returns an array of AggregateReflection objects for all the aggregations in the class.
+      def reflect_on_all_aggregations
+        reflections.values.select { |reflection| reflection.is_a?(AggregateReflection) }
+      end
+
+      # Returns the AggregateReflection object for the named +aggregation+ (use the symbol). Example:
+      #
+      #   Account.reflect_on_aggregation(:balance) # returns the balance AggregateReflection
+      #
+      def reflect_on_aggregation(aggregation)
+        reflections[aggregation].is_a?(AggregateReflection) ? reflections[aggregation] : nil
+      end
+
+      # Returns an array of AssociationReflection objects for all the aggregations in the class. If you only want to reflect on a
+      # certain association type, pass in the symbol (:has_many, :has_one, :belongs_to) for that as the first parameter. 
+      # Example:
+      #
+      #   Account.reflect_on_all_associations             # returns an array of all associations
+      #   Account.reflect_on_all_associations(:has_many)  # returns an array of all has_many associations
+      #
+      def reflect_on_all_associations(macro = nil)
+        association_reflections = reflections.values.select { |reflection| reflection.is_a?(AssociationReflection) }
+        macro ? association_reflections.select { |reflection| reflection.macro == macro } : association_reflections
+      end
+
+      # Returns the AssociationReflection object for the named +aggregation+ (use the symbol). Example:
+      #
+      #   Account.reflect_on_association(:owner) # returns the owner AssociationReflection
+      #   Invoice.reflect_on_association(:line_items).macro  # returns :has_many
+      #
+      def reflect_on_association(association)
+        reflections[association].is_a?(AssociationReflection) ? reflections[association] : nil
+      end
+    end
+
+
+    # Abstract base class for AggregateReflection and AssociationReflection that describes the interface available for both of
+    # those classes. Objects of AggregateReflection and AssociationReflection are returned by the Reflection::ClassMethods.
+    class MacroReflection
+      attr_reader :active_record
+      def initialize(macro, name, options, active_record)
+        @macro, @name, @options, @active_record = macro, name, options, active_record
+      end
+
+      # Returns the name of the macro, so it would return :balance for "composed_of :balance, :class_name => 'Money'" or
+      # :clients for "has_many :clients".
+      def name
+        @name
+      end
+
+      # Returns the name of the macro, so it would return :composed_of for
+      # "composed_of :balance, :class_name => 'Money'" or :has_many for "has_many :clients".
+      def macro
+        @macro
+      end
+
+      # Returns the hash of options used for the macro, so it would return { :class_name => "Money" } for
+      # "composed_of :balance, :class_name => 'Money'" or {} for "has_many :clients".
+      def options
+        @options
+      end
+
+      # Returns the class for the macro, so "composed_of :balance, :class_name => 'Money'" would return the Money class and
+      # "has_many :clients" would return the Client class.
+      def klass() end
+        
+      def class_name
+        @class_name ||= name_to_class_name(name.id2name)
+      end
+
+      def ==(other_aggregation)
+        name == other_aggregation.name && other_aggregation.options && active_record == other_aggregation.active_record
+      end
+    end
+
+
+    # Holds all the meta-data about an aggregation as it was specified in the Active Record class.
+    class AggregateReflection < MacroReflection #:nodoc:
+      def klass
+        @klass ||= Object.const_get(options[:class_name] || class_name)
+      end
+
+      private
+        def name_to_class_name(name)
+          name.capitalize.gsub(/_(.)/) { |s| $1.capitalize }
+        end
+    end
+
+    # Holds all the meta-data about an association as it was specified in the Active Record class.
+    class AssociationReflection < MacroReflection #:nodoc:
+      def klass
+        @klass ||= active_record.send(:compute_type, class_name)
+      end
+
+      def table_name
+        @table_name ||= klass.table_name
+      end
+
+      def primary_key_name
+        return @primary_key_name if @primary_key_name
+        case
+          when macro == :belongs_to
+            @primary_key_name = options[:foreign_key] || class_name.foreign_key
+          when options[:as]
+            @primary_key_name = options[:foreign_key] || "#{options[:as]}_id"
+          else
+            @primary_key_name = options[:foreign_key] || active_record.name.foreign_key
+        end
+      end
+      
+      def association_foreign_key
+        @association_foreign_key ||= @options[:association_foreign_key] || class_name.foreign_key
+      end
+
+      def counter_cache_column
+        if options[:counter_cache] == true
+          "#{active_record.name.underscore.pluralize}_count"
+        elsif options[:counter_cache]
+          options[:counter_cache]
+        end
+      end
+
+      def through_reflection
+        @through_reflection ||= options[:through] ? active_record.reflect_on_association(options[:through]) : false
+      end
+
+      # Gets an array of possible :through source reflection names
+      #
+      #   [singularized, pluralized]
+      #
+      def source_reflection_names
+        @source_reflection_names ||= (options[:source] ? [options[:source]] : [name.to_s.singularize, name]).collect { |n| n.to_sym }
+      end
+
+      # Gets the source of the through reflection.  It checks both a singularized and pluralized form for :belongs_to or :has_many.
+      # (The :tags association on Tagging below)
+      # 
+      #   class Post
+      #     has_many :tags, :through => :taggings
+      #   end
+      #
+      def source_reflection
+        return nil unless through_reflection
+        @source_reflection ||= source_reflection_names.collect { |name| through_reflection.klass.reflect_on_association(name) }.compact.first
+      end
+
+      def check_validity!
+        if options[:through]
+          if through_reflection.nil?
+            raise HasManyThroughAssociationNotFoundError.new(active_record.name, self)
+          end
+          
+          if source_reflection.nil?
+            raise HasManyThroughSourceAssociationNotFoundError.new(self)
+          end
+
+          if options[:source_type] && source_reflection.options[:polymorphic].nil?
+            raise HasManyThroughAssociationPointlessSourceTypeError.new(active_record.name, self, source_reflection)
+          end
+          
+          if source_reflection.options[:polymorphic] && options[:source_type].nil?
+            raise HasManyThroughAssociationPolymorphicError.new(active_record.name, self, source_reflection)
+          end
+          
+          unless [:belongs_to, :has_many].include?(source_reflection.macro) && source_reflection.options[:through].nil?
+            raise HasManyThroughSourceAssociationMacroError.new(self)
+          end
+        end
+      end
+
+      private
+        def name_to_class_name(name)
+          if name =~ /::/
+            name
+          else
+            if options[:class_name]
+              options[:class_name]
+            elsif through_reflection # get the class_name of the belongs_to association of the through reflection
+              options[:source_type] || source_reflection.class_name
+            else
+              class_name = name.to_s.camelize
+              class_name = class_name.singularize if [ :has_many, :has_and_belongs_to_many ].include?(macro)
+              class_name
+            end
+          end
+        end
+    end
+  end
+end