Skip to content

Commit

Permalink
simplifies the RDoc of AR::RuntimeRegistry
Browse files Browse the repository at this point in the history
The previous version was kind of duplicating the documentation of
AS::PerThreadRegistry. Just say how to use it, the thread locals
registry is know part of our vocabulary (though a pointer to
Active Support is added for reference).
  • Loading branch information
fxn committed Apr 13, 2013
1 parent 2d42fe7 commit a548c45
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions activerecord/lib/active_record/runtime_registry.rb
Original file line number Original file line Diff line number Diff line change
@@ -1,29 +1,14 @@
require 'active_support/per_thread_registry' require 'active_support/per_thread_registry'


module ActiveRecord module ActiveRecord
# This is a registry class for storing local variables in Active Record. The # This is a thread locals registry for Active Record. For example
# class allows you to access variables that are local to the current thread.
# These thread local variables are stored as attributes in the
# +RuntimeRegistry+ class.
#
# You can access the thread local variables by calling a variable's name on
# the +RuntimeRegistry+ class. For example, if you wanted to obtain the
# connection handler for the current thread, you would invoke:
#
# ActiveRecord::RuntimeRegistry.instance.connection_handler
#
# The +PerThreadRegistry+ module will make a new +RuntimeRegistry+ instance
# and store it in +Thread.current+. Whenever you make a call for an attribute
# on the +RuntimeRegistry+ class, the call will be sent to the instance that
# is stored in +Thread.current+.
#
# Note that you can also make the following call which would provide an
# equivalent result as the previous code:
# #
# ActiveRecord::RuntimeRegistry.connection_handler # ActiveRecord::RuntimeRegistry.connection_handler
# #
# However, this is less performant because it makes a call to +method_missing+ # returns the connection handler local to the current thread.
# before it sends the method call to the +instance+. #
# See the documentation of <tt>ActiveSupport::PerThreadRegistry</tt>
# for further details.
class RuntimeRegistry class RuntimeRegistry
extend ActiveSupport::PerThreadRegistry extend ActiveSupport::PerThreadRegistry


Expand Down

0 comments on commit a548c45

Please sign in to comment.