Railties – Gluing the Engine to the Rails (original) (raw)

Namespace

• MODULE Rails::API
• MODULE Rails::Command
• MODULE Rails::Configuration
• MODULE Rails::Generators
• MODULE Rails::Info
• MODULE Rails::Initializable
• MODULE Rails::Paths
• MODULE Rails::Rack
• MODULE Rails::VERSION
• CLASS Rails::AppBuilder
• CLASS Rails::Application
• CLASS Rails::CodeStatistics
• CLASS Rails::Console
• CLASS Rails::DBConsole
• CLASS Rails::Engine
• CLASS Rails::HealthController
• CLASS Rails::PluginBuilder
• CLASS Rails::Railtie
• CLASS Rails::Server
• CLASS Rails::SourceAnnotationExtractor

Methods

A

• application,
• autoloaders

B

• backtrace_cleaner

C

• configuration

E

• env,
• env=,
• error

G

• gem_version,
• groups

P

• public_path

R

• root

V

• version

Attributes

Class Public methods

application()Link

Source: show | on GitHub

def application @application ||= (app_class.instance if app_class) end

autoloaders()Link

Source: show | on GitHub

def autoloaders application.autoloaders end

backtrace_cleaner()Link

Source: show | on GitHub

def backtrace_cleaner @backtrace_cleaner ||= Rails::BacktraceCleaner.new end

configuration()Link

The Configuration instance used to configure the Rails environment

Source: show | on GitHub

def configuration application.config end

env()Link

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

Source: show | on GitHub

def env @_env ||= ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development") end

env=(environment)Link

Sets the Rails environment.

Rails.env = "staging" # => "staging"

Source: show | on GitHub

def env=(environment) @_env = ActiveSupport::EnvironmentInquirer.new(environment) end

error()Link

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)

Source: show | on GitHub

def error ActiveSupport.error_reporter end

gem_version()Link

Returns the currently loaded version of Rails as a Gem::Version.

Source: show | on GitHub

def self.gem_version Gem::Version.new VERSION::STRING end

groups(*groups)Link

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"

Source: show | on GitHub

def groups(*groups) hash = groups.extract_options! env = Rails.env groups.unshift(:default, env) groups.concat ENV["RAILS_GROUPS"].to_s.split(",") groups.concat hash.map { |k, v| k if v.map(&:to_s).include?(env) } groups.compact! groups.uniq! groups end

public_path()Link

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>

Source: show | on GitHub

def public_path application && Pathname.new(application.paths["public"].first) end

root()Link

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>

Source: show | on GitHub

def root application && application.config.root end

version()Link

Returns the currently loaded version of Rails as a string.