Railties – Gluing the Engine to the Rails

Railties is responsible for gluing all frameworks together. Overall, it:

  • handles the bootstrapping process for a Rails application;

  • manages the rails command line interface;

  • and provides the Rails generators core.

Download

The latest version of Railties can be installed with RubyGems:

  • gem install railties

Source code can be downloaded as part of the Rails project on GitHub

License

Railties is released under the MIT license:

Support

API documentation is at

Bug reports can be filed for the Ruby on Rails project here:

Feature requests should be discussed on the rubyonrails-core forum here:

Namespace

Module

Class

Methods

Attributes

[RW] app_class
[W] application
[RW] cache
[RW] logger

Class Public methods

application()

📝 Source code 
# File railties/lib/rails.rb, line 44
def application
  @application ||= (app_class.instance if app_class)
end
🔎 See on GitHub

autoloaders()

📝 Source code 
# File railties/lib/rails.rb, line 133
def autoloaders
  application.autoloaders
end
🔎 See on GitHub

backtrace_cleaner()

📝 Source code 
# File railties/lib/rails.rb, line 55
def backtrace_cleaner
  @backtrace_cleaner ||= Rails::BacktraceCleaner.new
end
🔎 See on GitHub

configuration()

The Configuration instance used to configure the Rails environment

📝 Source code 
# File railties/lib/rails.rb, line 51
def configuration
  application.config
end
🔎 See on GitHub

env()

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 code 
# File railties/lib/rails.rb, line 74
def env
  @_env ||= ActiveSupport::EnvironmentInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development")
end
🔎 See on GitHub

env=(environment)

Sets the Rails environment.

Rails.env = "staging" # => "staging"
📝 Source code 
# File railties/lib/rails.rb, line 81
def env=(environment)
  @_env = ActiveSupport::EnvironmentInquirer.new(environment)
end
🔎 See on GitHub

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)
📝 Source code 
# File railties/lib/rails.rb, line 92
def error
  ActiveSupport.error_reporter
end
🔎 See on GitHub

event()

Returns the ActiveSupport::EventReporter of the current Rails project, otherwise it returns nil if there is no project.

Rails.event.notify("my_event", { message: "Hello, world!" })
📝 Source code 
# File railties/lib/rails.rb, line 100
def event
  ActiveSupport.event_reporter
end
🔎 See on GitHub

gem_version()

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

📝 Source code 
# File railties/lib/rails/gem_version.rb, line 5
def self.gem_version
  Gem::Version.new VERSION::STRING
end
🔎 See on GitHub

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"
📝 Source code 
# File railties/lib/rails.rb, line 113
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
🔎 See on GitHub

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>
📝 Source code 
# File railties/lib/rails.rb, line 129
def public_path
  application && Pathname.new(application.paths["public"].first)
end
🔎 See on GitHub

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>
📝 Source code 
# File railties/lib/rails.rb, line 64
def root
  application && application.config.root
end
🔎 See on GitHub

version()

Returns the currently loaded version of Rails as a string.

📝 Source code 
# File railties/lib/rails/version.rb, line 7
def self.version
  VERSION::STRING
end
🔎 See on GitHub

Definition files