Module: ActiveSupport::Autoload
- Included in:
- AbstractController, AbstractController::Caching, ActionCable, ActionCable::Channel, ActionCable::Connection, ActionCable::Server, ActionCable::SubscriptionAdapter, ActionController, ActionController::Caching, ActionDispatch, ActionDispatch::Http, ActionDispatch::Routing, ActionMailbox, ActionMailer, ActionText, ActionText::Attachables, ActionText::Attachments, ActionView, ActionView::Helpers, ActionView::Helpers::Tags, ActionView::Template, ActionView::Template::Sources, ActiveJob, ActiveJob::QueueAdapters, ActiveJob::Serializers, ActiveModel, ActiveModel::Serializers, ActiveRecord, ActiveRecord::Associations, ActiveRecord::Associations::Preloader, ActiveRecord::AttributeMethods, ActiveRecord::ConnectionAdapters, ActiveRecord::Locking, ActiveRecord::Middleware, ActiveRecord::Scoping, ActiveRecord::Tasks, ActiveStorage, ActiveStorage::Attached::Changes, ActiveStorage::Service, ActiveStorage::Transformers, ActiveSupport, NumberHelper, Rails, Rails::Command
- Defined in:
- activesupport/lib/active_support/dependencies/autoload.rb
Overview
Autoload and eager load conveniences for your library.
This module allows you to define autoloads based on Rails conventions (i.e. no need to define the path it is automatically guessed based on the filename) and also define a set of constants that needs to be eager loaded:
module MyLib
extend ActiveSupport::Autoload
autoload :Model
eager_autoload do
autoload :Cache
end
end
Then your library can be eager loaded by simply calling:
MyLib.eager_load!
Class Method Summary collapse
-
.extended(base) ⇒ Object
:nodoc:.
Instance Method Summary collapse
- #autoload(const_name, path = @_at_path) ⇒ Object
- #autoload_at(path) ⇒ Object
- #autoload_under(path) ⇒ Object
- #autoloads ⇒ Object
- #eager_autoload ⇒ Object
- #eager_load! ⇒ Object
Class Method Details
.extended(base) ⇒ Object
:nodoc:
28 29 30 31 32 33 34 35 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 28 def self.extended(base) # :nodoc: base.class_eval do @_autoloads = {} @_under_path = nil @_at_path = nil @_eager_autoload = false end end |
Instance Method Details
#autoload(const_name, path = @_at_path) ⇒ Object
37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 37 def autoload(const_name, path = @_at_path) unless path full = [name, @_under_path, const_name.to_s].compact.join("::") path = Inflector.underscore(full) end if @_eager_autoload @_autoloads[const_name] = path end super const_name, path end |
#autoload_at(path) ⇒ Object
57 58 59 60 61 62 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 57 def autoload_at(path) @_at_path, old_path = path, @_at_path yield ensure @_at_path = old_path end |
#autoload_under(path) ⇒ Object
50 51 52 53 54 55 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 50 def autoload_under(path) @_under_path, old_path = path, @_under_path yield ensure @_under_path = old_path end |
#autoloads ⇒ Object
75 76 77 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 75 def autoloads @_autoloads end |
#eager_autoload ⇒ Object
64 65 66 67 68 69 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 64 def eager_autoload old_eager, @_eager_autoload = @_eager_autoload, true yield ensure @_eager_autoload = old_eager end |
#eager_load! ⇒ Object
71 72 73 |
# File 'activesupport/lib/active_support/dependencies/autoload.rb', line 71 def eager_load! @_autoloads.each_value { |file| require file } end |