ging/social_stream

module SocialStream #:nodoc:
  module Models
    # Common methods for models that have a {SocialStream::Models::Supertype}
    #
    # Examples of subtypes are {User} and {Group}, which have {Actor} as supertype,
    # or {Post} and {Comment}, which have {ActivityObject} as supertype
    #
    # Methods are documented taking User as example of {SocialStream::Models::Subtype}
    module Subtype
      extend ActiveSupport::Concern

      include SocialStream::ActivityStreams::Subtype

      included do
        class << self
          attr_reader :supertype_name, :supertype_options
        end

        belongs_to supertype_name, {                          # belongs_to :actor, {
                    :validate  => true,                       #   :validate => true
                    :autosave  => true,                       #   :autosave => true
                    :dependent => :destroy,                   #   :dependent => :destroy
                    :inverse_of => name.underscore.to_sym     #   :inverse_of => :user,
                  }.merge(supertype_options[:belongs] || {})  #   }.merge(supertype_options[:belongs] || {})

        class_eval <<-EOS
          def #{ supertype_name }!                                              # def actor!
            #{ supertype_name } ||                                              #   actor ||
              # FIXME: ruby1.9 remove .inspect
              build_#{ supertype_name }(#{ supertype_options[:build].inspect }) #     build_actor(:subject_type => "User")
          end                                                                   # end

        EOS

        alias_method :supertype!, "#{ supertype_name }!" # alias_method :supertype!, :actor!

        # Load the supertype to ensure it is saved along with this instance
        before_validation :supertype! # before_validation :actor!
      end

      module ClassMethods
        def supertype_sym
          supertype_name.to_sym
        end

        def supertype_foreign_key
          "#{ supertype_name }_id" # "actor_id"
        end 
      end

      # Delegate missing methods to supertype, if they exist there
      def method_missing(method, *args, &block)
        super
      rescue NameError => subtype_error
        raise subtype_error unless _delegate_to_supertype?(:method)

        begin
          res = supertype!.__send__(method, *args, &block)

          # Cache method
          self.class.class_eval <<-STR, __FILE__, __LINE__ + 1
            def #{ method } *args, &block
              supertype!.__send__ :#{ method }, *args, &block
            end
          STR

          res

        # We rescue supertype's NameErrors so methods not defined are raised from
        # the subtype. Example: user.foo should raise "foo is not defined in user"
        # and not "in actor"
        rescue NameError => supertype_error
          if supertype_error.name == subtype_error.name &&
               supertype_error.message =~ /#{ self.class.supertype_name.to_s.classify }/
            raise subtype_error
          else
            raise supertype_error
          end
        end
      end

      # {SocialStream::Models::Supertype} handles some methods
      def respond_to? *args
        super || _delegate_to_supertype?(:method) && supertype!.respond_to?(*args)
      end 

      def _delegate_to_supertype?(method)
        # These methods must not be delegated to avoid loops
        # (the @supertype_name association (e.g. :actor) calls here again)
        exceptions = [ "_#{ self.class.supertype_foreign_key }".to_sym ] # [ :_actor_id ]

        ! exceptions.include?(method)
      end

      # Add the class method {#subtype_of} to ActiveRecord::Base
      module ActiveRecord
        extend ActiveSupport::Concern

        module ClassMethods
          # This class is a subtype. Its supertype class is name
          def subtype_of name, options = {}
            @supertype_name = name
            @supertype_options = options
            include SocialStream::Models::Subtype
          end
        end
      end
    end
  end
end