Module: Rails
Overview
Class Attribute Summary
- .app_class rw
- .application rw
- .application=(value) rw
- .cache rw
-
.env
rw
Returns the current Rails environment.
-
.env=(environment)
rw
Sets the Rails environment.
- .logger rw
Class Method Summary
- .autoloaders
- .backtrace_cleaner
-
.configuration
The Configuration instance used to configure the Rails environment.
-
.error
Returns the
::ActiveSupport::ErrorReporter
of the current Rails project, otherwise it returnsnil
if there is no project. -
.gem_version
Returns the currently loaded version of Rails as a
Gem::Version
. -
.groups(*groups)
Returns all Rails groups for loading based on:
-
.public_path
Returns a
::Pathname
object of the public folder of the current Rails project, otherwise it returnsnil
if there is no project: -
.root
Returns a
::Pathname
object of the current Rails project, otherwise it returnsnil
if there is no project: -
.version
Returns the currently loaded version of Rails as a string.
- .deprecator Internal use only
::ActiveSupport::Benchmarkable
- Extended
benchmark | Allows you to measure the execution time of a block in a template and records the result to the log. |
::ActiveSupport::Autoload
- Extended
Instance Method Summary
Class Attribute Details
.app_class (rw)
[ GitHub ].application (rw)
[ GitHub ].application=(value) (rw)
[ GitHub ]# File 'railties/lib/rails.rb', line 43
attr_writer :application
.cache (rw)
[ GitHub ].env (rw)
Returns the current Rails environment.
Rails.env # => "development"
Rails.env.development? # => true
Rails.env.production? # => false
Rails.env.local? # => true true for "development" and "test", false for anything else
# File 'railties/lib/rails.rb', line 75
def env @_env ||= ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development") end
.env=(environment) (rw)
Sets the Rails environment.
Rails.env = "staging" # => "staging"
# File 'railties/lib/rails.rb', line 82
def env=(environment) @_env = ActiveSupport::EnvironmentInquirer.new(environment) end
.logger (rw)
[ GitHub ]Class Method Details
.autoloaders
[ GitHub ]# File 'railties/lib/rails.rb', line 126
def autoloaders application.autoloaders end
.backtrace_cleaner
[ GitHub ]# File 'railties/lib/rails.rb', line 56
def backtrace_cleaner @backtrace_cleaner ||= Rails::BacktraceCleaner.new end
.configuration
The Configuration instance used to configure the Rails environment
# File 'railties/lib/rails.rb', line 52
def configuration application.config end
.deprecator
# File 'railties/lib/rails/deprecator.rb', line 4
def self.deprecator # :nodoc: @deprecator ||= ActiveSupport::Deprecation.new end
.error
Returns the ::ActiveSupport::ErrorReporter
of the current Rails project, otherwise it returns nil
if there is no project.
Rails.error.handle(IOError) do
# ...
end
Rails.error.report(error)
# File 'railties/lib/rails.rb', line 93
def error ActiveSupport.error_reporter end
.gem_version
Returns the currently loaded version of Rails as a Gem::Version
.
.groups(*groups)
Returns all Rails groups for loading based on:
-
The Rails environment;
-
The environment variable RAILS_GROUPS;
-
The optional envs given as argument and the hash with group dependencies;
Rails.groups assets: [:development, :test]
# => [:default, "development", :assets] for Rails.env == "development"
# => [:default, "production"] for Rails.env == "production"
.public_path
Returns a ::Pathname
object of the public folder of the current Rails project, otherwise it returns nil
if there is no project:
Rails.public_path
# => #<Pathname:/Users/someuser/some/path/project/public>
# File 'railties/lib/rails.rb', line 122
def public_path application && Pathname.new(application.paths["public"].first) end
.root
Returns a ::Pathname
object of the current Rails project, otherwise it returns nil
if there is no project:
Rails.root
# => #<Pathname:/Users/someuser/some/path/project>
# File 'railties/lib/rails.rb', line 65
def root application && application.config.root end
.version
Returns the currently loaded version of Rails as a string.
Instance Method Details
#initialize!
[ GitHub ]# File 'railties/lib/rails.rb', line 49
delegate :initialize!, :initialized?, to: :application
#initialized? ⇒ Boolean
# File 'railties/lib/rails.rb', line 49
delegate :initialize!, :initialized?, to: :application