activerecord 3.0.0 → 4.0.0

data/lib/active_record/observer.rb

@@ -1,140 +0,0 @@
-require 'active_support/core_ext/class/attribute'
-
-module ActiveRecord
-  # = Active Record Observer
-  #
-  # Observer classes respond to life cycle 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 which takes
-  # either the concrete class (Product) or a symbol for that class (:product):
-  #
-  #   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/application.rb</tt> file.
-  #
-  #   config.active_record.observers = :comment_observer, :signup_observer
-  #
-  # Observers will not be invoked unless you define these in your application configuration.
-  #
-  # == Loading
-  #
-  # Observers register themselves in the model class they observe, since it is the class that
-  # notifies them of events when they occur. As a side-effect, when an observer is loaded its
-  # corresponding model class is loaded.
-  #
-  # Up to (and including) Rails 2.0.2 observers were instantiated between plugins and
-  # application initializers. Now observers are loaded after application initializers,
-  # so observed models can make use of extensions.
-  #
-  # If by any chance you are using observed models in the initialization you can still
-  # load their observers by calling <tt>ModelObserver.instance</tt> before. Observers are
-  # singletons and that call instantiates and registers them.
-  #
-  class Observer < ActiveModel::Observer
-    class_attribute :observed_methods
-    self.observed_methods = [].freeze
-
-    def initialize
-      super
-      observed_descendants.each { |klass| add_observer!(klass) }
-    end
-
-    def self.method_added(method)
-      method = method.to_sym
-
-      if ActiveRecord::Callbacks::CALLBACKS.include?(method)
-        self.observed_methods += [method]
-        self.observed_methods.freeze
-      end
-    end
-
-    protected
-
-      def observed_descendants
-        observed_classes.sum([]) { |klass| klass.descendants }
-      end
-
-      def observe_callbacks?
-        self.class.observed_methods.any?
-      end
-
-      def add_observer!(klass)
-        super
-        define_callbacks klass if observe_callbacks?
-      end
-
-      def define_callbacks(klass)
-        existing_methods = klass.instance_methods.map { |m| m.to_sym }
-        observer = self
-        observer_name = observer.class.name.underscore.gsub('/', '__')
-
-        self.class.observed_methods.each do |method|
-          callback = :"_notify_#{observer_name}_for_#{method}"
-          unless existing_methods.include? callback
-            klass.send(:define_method, callback) do  # def _notify_user_observer_for_before_save
-              observer.update(method, self)          #   observer.update(:before_save, self)
-            end                                      # end
-            klass.send(method, callback)             # before_save :_notify_user_observer_for_before_save
-          end
-        end
-      end
-  end
-end

data/lib/active_record/session_store.rb

@@ -1,340 +0,0 @@
-module ActiveRecord
-  # = Active Record Session Store
-  #
-  # A session store backed by an Active Record class.  A default class is
-  # provided, but any object duck-typing to an Active Record Session class
-  # with text +session_id+ and +data+ attributes is sufficient.
-  #
-  # The default assumes a +sessions+ tables with columns:
-  #   +id+ (numeric primary key),
-  #   +session_id+ (text, or longtext if your session data exceeds 65K), and
-  #   +data+ (text or longtext; careful if your session data exceeds 65KB).
-  #
-  # The +session_id+ column should always be indexed for speedy lookups.
-  # Session data is marshaled to the +data+ column in Base64 format.
-  # If the data you write is larger than the column's size limit,
-  # ActionController::SessionOverflowError will be raised.
-  #
-  # You may configure the table name, primary key, and data column.
-  # For example, at the end of <tt>config/application.rb</tt>:
-  #
-  #   ActiveRecord::SessionStore::Session.table_name = 'legacy_session_table'
-  #   ActiveRecord::SessionStore::Session.primary_key = 'session_id'
-  #   ActiveRecord::SessionStore::Session.data_column_name = 'legacy_session_data'
-  #
-  # Note that setting the primary key to the +session_id+ frees you from
-  # having a separate +id+ column if you don't want it.  However, you must
-  # set <tt>session.model.id = session.session_id</tt> by hand!  A before filter
-  # on ApplicationController is a good place.
-  #
-  # Since the default class is a simple Active Record, you get timestamps
-  # for free if you add +created_at+ and +updated_at+ datetime columns to
-  # the +sessions+ table, making periodic session expiration a snap.
-  #
-  # You may provide your own session class implementation, whether a
-  # feature-packed Active Record or a bare-metal high-performance SQL
-  # store, by setting
-  #
-  #   ActiveRecord::SessionStore.session_class = MySessionClass
-  #
-  # You must implement these methods:
-  #
-  #   self.find_by_session_id(session_id)
-  #   initialize(hash_of_session_id_and_data)
-  #   attr_reader :session_id
-  #   attr_accessor :data
-  #   save
-  #   destroy
-  #
-  # The example SqlBypass class is a generic SQL session store.  You may
-  # use it as a basis for high-performance database-specific stores.
-  class SessionStore < ActionDispatch::Session::AbstractStore
-    module ClassMethods # :nodoc:
-      def marshal(data)
-        ActiveSupport::Base64.encode64(Marshal.dump(data)) if data
-      end
-
-      def unmarshal(data)
-        Marshal.load(ActiveSupport::Base64.decode64(data)) if data
-      end
-
-      def drop_table!
-        connection.drop_table table_name
-      end
-
-      def create_table!
-        connection.create_table(table_name) do |t|
-          t.string session_id_column, :limit => 255
-          t.text data_column_name
-        end
-        connection.add_index table_name, session_id_column, :unique => true
-      end
-    end
-
-    # The default Active Record class.
-    class Session < ActiveRecord::Base
-      extend ClassMethods
-
-      ##
-      # :singleton-method:
-      # Customizable data column name.  Defaults to 'data'.
-      cattr_accessor :data_column_name
-      self.data_column_name = 'data'
-
-      before_save :marshal_data!
-      before_save :raise_on_session_data_overflow!
-
-      class << self
-        def data_column_size_limit
-          @data_column_size_limit ||= columns_hash[data_column_name].limit
-        end
-
-        # Hook to set up sessid compatibility.
-        def find_by_session_id(session_id)
-          setup_sessid_compatibility!
-          find_by_session_id(session_id)
-        end
-
-        private
-          def session_id_column
-            'session_id'
-          end
-
-          # Compatibility with tables using sessid instead of session_id.
-          def setup_sessid_compatibility!
-            # Reset column info since it may be stale.
-            reset_column_information
-            if columns_hash['sessid']
-              def self.find_by_session_id(*args)
-                find_by_sessid(*args)
-              end
-
-              define_method(:session_id)  { sessid }
-              define_method(:session_id=) { |session_id| self.sessid = session_id }
-            else
-              class << self; remove_method :find_by_session_id; end
-
-              def self.find_by_session_id(session_id)
-                find :first, :conditions => {:session_id=>session_id}
-              end
-            end
-          end
-      end
-
-      def initialize(attributes = nil)
-        @data = nil
-        super
-      end
-
-      # Lazy-unmarshal session state.
-      def data
-        @data ||= self.class.unmarshal(read_attribute(@@data_column_name)) || {}
-      end
-
-      attr_writer :data
-
-      # Has the session been loaded yet?
-      def loaded?
-        @data
-      end
-
-      private
-        def marshal_data!
-          return false unless loaded?
-          write_attribute(@@data_column_name, self.class.marshal(data))
-        end
-
-        # Ensures that the data about to be stored in the database is not
-        # larger than the data storage column. Raises
-        # ActionController::SessionOverflowError.
-        def raise_on_session_data_overflow!
-          return false unless loaded?
-          limit = self.class.data_column_size_limit
-          if limit and read_attribute(@@data_column_name).size > limit
-            raise ActionController::SessionOverflowError
-          end
-        end
-    end
-
-    # A barebones session store which duck-types with the default session
-    # store but bypasses Active Record and issues SQL directly.  This is
-    # an example session model class meant as a basis for your own classes.
-    #
-    # The database connection, table name, and session id and data columns
-    # are configurable class attributes.  Marshaling and unmarshaling
-    # are implemented as class methods that you may override.  By default,
-    # marshaling data is
-    #
-    #   ActiveSupport::Base64.encode64(Marshal.dump(data))
-    #
-    # and unmarshaling data is
-    #
-    #   Marshal.load(ActiveSupport::Base64.decode64(data))
-    #
-    # This marshaling behavior is intended to store the widest range of
-    # binary session data in a +text+ column.  For higher performance,
-    # store in a +blob+ column instead and forgo the Base64 encoding.
-    class SqlBypass
-      extend ClassMethods
-
-      ##
-      # :singleton-method:
-      # Use the ActiveRecord::Base.connection by default.
-      cattr_accessor :connection
-
-      ##
-      # :singleton-method:
-      # The table name defaults to 'sessions'.
-      cattr_accessor :table_name
-      @@table_name = 'sessions'
-
-      ##
-      # :singleton-method:
-      # The session id field defaults to 'session_id'.
-      cattr_accessor :session_id_column
-      @@session_id_column = 'session_id'
-
-      ##
-      # :singleton-method:
-      # The data field defaults to 'data'.
-      cattr_accessor :data_column
-      @@data_column = 'data'
-
-      class << self
-        alias :data_column_name :data_column
-
-        remove_method :connection
-        def connection
-          @@connection ||= ActiveRecord::Base.connection
-        end
-
-        # Look up a session by id and unmarshal its data if found.
-        def find_by_session_id(session_id)
-          if record = connection.select_one("SELECT * FROM #{@@table_name} WHERE #{@@session_id_column}=#{connection.quote(session_id)}")
-            new(:session_id => session_id, :marshaled_data => record['data'])
-          end
-        end
-      end
-
-      attr_reader :session_id, :new_record
-      alias :new_record? :new_record
-
-      attr_writer :data
-
-      # Look for normal and marshaled data, self.find_by_session_id's way of
-      # telling us to postpone unmarshaling until the data is requested.
-      # We need to handle a normal data attribute in case of a new record.
-      def initialize(attributes)
-        @session_id     = attributes[:session_id]
-        @data           = attributes[:data]
-        @marshaled_data = attributes[:marshaled_data]
-        @new_record     = @marshaled_data.nil?
-      end
-
-      # Lazy-unmarshal session state.
-      def data
-        unless @data
-          if @marshaled_data
-            @data, @marshaled_data = self.class.unmarshal(@marshaled_data) || {}, nil
-          else
-            @data = {}
-          end
-        end
-        @data
-      end
-
-      def loaded?
-        @data
-      end
-
-      def save
-        return false unless loaded?
-        marshaled_data = self.class.marshal(data)
-        connect        = connection
-
-        if @new_record
-          @new_record = false
-          connect.update <<-end_sql, 'Create session'
-            INSERT INTO #{table_name} (
-              #{connect.quote_column_name(session_id_column)},
-              #{connect.quote_column_name(data_column)} )
-            VALUES (
-              #{connect.quote(session_id)},
-              #{connect.quote(marshaled_data)} )
-          end_sql
-        else
-          connect.update <<-end_sql, 'Update session'
-            UPDATE #{table_name}
-            SET #{connect.quote_column_name(data_column)}=#{connect.quote(marshaled_data)}
-            WHERE #{connect.quote_column_name(session_id_column)}=#{connect.quote(session_id)}
-          end_sql
-        end
-      end
-
-      def destroy
-        return if @new_record
-
-        connect = connection
-        connect.delete <<-end_sql, 'Destroy session'
-          DELETE FROM #{table_name}
-          WHERE #{connect.quote_column_name(session_id_column)}=#{connect.quote(session_id)}
-        end_sql
-      end
-    end
-
-    # The class used for session storage.  Defaults to
-    # ActiveRecord::SessionStore::Session
-    cattr_accessor :session_class
-    self.session_class = Session
-
-    SESSION_RECORD_KEY = 'rack.session.record'
-
-    private
-      def get_session(env, sid)
-        Base.silence do
-          sid ||= generate_sid
-          session = find_session(sid)
-          env[SESSION_RECORD_KEY] = session
-          [sid, session.data]
-        end
-      end
-
-      def set_session(env, sid, session_data)
-        Base.silence do
-          record = get_session_model(env, sid)
-          record.data = session_data
-          return false unless record.save
-
-          session_data = record.data
-          if session_data && session_data.respond_to?(:each_value)
-            session_data.each_value do |obj|
-              obj.clear_association_cache if obj.respond_to?(:clear_association_cache)
-            end
-          end
-        end
-
-        sid
-      end
-
-      def destroy(env)
-        if sid = current_session_id(env)
-          Base.silence do
-            get_session_model(env, sid).destroy
-          end
-        end
-      end
-
-      def get_session_model(env, sid)
-        if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
-          env[SESSION_RECORD_KEY] = find_session(sid)
-        else
-          env[SESSION_RECORD_KEY] ||= find_session(sid)
-        end
-      end
-
-      def find_session(id)
-        @@session_class.find_by_session_id(id) ||
-          @@session_class.new(:session_id => id, :data => {})
-      end
-  end
-end

data/lib/rails/generators/active_record/model/templates/migration.rb

@@ -1,16 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-  def self.up
-    create_table :<%= table_name %> do |t|
-<% for attribute in attributes -%>
-      t.<%= attribute.type %> :<%= attribute.name %>
-<% end -%>
-<% if options[:timestamps] %>
-      t.timestamps
-<% end -%>
-    end
-  end
-
-  def self.down
-    drop_table :<%= table_name %>
-  end
-end

data/lib/rails/generators/active_record/observer/observer_generator.rb

@@ -1,15 +0,0 @@
-require 'rails/generators/active_record'
-
-module ActiveRecord
-  module Generators
-    class ObserverGenerator < Base
-      check_class_collision :suffix => "Observer"
-
-      def create_observer_file
-        template 'observer.rb', File.join('app/models', class_path, "#{file_name}_observer.rb")
-      end
-
-      hook_for :test_framework
-    end
-  end
-end

data/lib/rails/generators/active_record/observer/templates/observer.rb

@@ -1,2 +0,0 @@
-class <%= class_name %>Observer < ActiveRecord::Observer
-end

data/lib/rails/generators/active_record/session_migration/session_migration_generator.rb

@@ -1,24 +0,0 @@
-require 'rails/generators/active_record'
-
-module ActiveRecord
-  module Generators
-    class SessionMigrationGenerator < Base
-      argument :name, :type => :string, :default => "add_sessions_table"
-
-      def create_migration_file
-        migration_template "migration.rb", "db/migrate/#{file_name}.rb"
-      end
-
-      protected
-
-        def session_table_name
-          current_table_name = ActiveRecord::SessionStore::Session.table_name
-          if ["sessions", "session"].include?(current_table_name)
-            current_table_name = (ActiveRecord::Base.pluralize_table_names ? 'session'.pluralize : 'session')
-          end
-          current_table_name
-        end
-
-    end
-  end
-end

data/lib/rails/generators/active_record/session_migration/templates/migration.rb

@@ -1,16 +0,0 @@
-class <%= migration_class_name %> < ActiveRecord::Migration
-  def self.up
-    create_table :<%= session_table_name %> do |t|
-      t.string :session_id, :null => false
-      t.text :data
-      t.timestamps
-    end
-
-    add_index :<%= session_table_name %>, :session_id
-    add_index :<%= session_table_name %>, :updated_at
-  end
-
-  def self.down
-    drop_table :<%= session_table_name %>
-  end
-end