W3cubDocs

/Ruby on Rails 5.1

module Rails

require_relative “generator”

Attributes

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

Public Class Methods

application() Show source
# File railties/lib/rails.rb, line 37
def application
  @application ||= (app_class.instance if app_class)
end
backtrace_cleaner() Show source
# File railties/lib/rails.rb, line 48
def backtrace_cleaner
  @backtrace_cleaner ||= begin
    # Relies on Active Support, so we have to lazy load to postpone definition until Active Support has been loaded
    require "rails/backtrace_cleaner"
    Rails::BacktraceCleaner.new
  end
end
configuration() Show source

The Configuration instance used to configure the Rails environment

# File railties/lib/rails.rb, line 44
def configuration
  application.config
end
env() Show source

Returns the current Rails environment.

Rails.env # => "development"
Rails.env.development? # => true
Rails.env.production? # => false
# File railties/lib/rails.rb, line 70
def env
  @_env ||= ActiveSupport::StringInquirer.new(ENV["RAILS_ENV"].presence || ENV["RACK_ENV"].presence || "development")
end
env=(environment) Show source

Sets the Rails environment.

Rails.env = "staging" # => "staging"
# File railties/lib/rails.rb, line 77
def env=(environment)
  @_env = ActiveSupport::StringInquirer.new(environment)
end
gem_version() Show source

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

# File railties/lib/rails/gem_version.rb, line 3
def self.gem_version
  Gem::Version.new VERSION::STRING
end
groups(*groups) Show source

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;

    groups assets: [:development, :test]

    # Returns # => [:default, :development, :assets] for ::env == “development” # => [:default, :production] for ::env == “production”

# File railties/lib/rails.rb, line 92
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() Show source

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 108
def public_path
  application && Pathname.new(application.paths["public"].first)
end
root() Show source

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 61
def root
  application && application.config.root
end
version() Show source

Returns the version of the currently loaded Rails as a string.

# File railties/lib/rails/version.rb, line 5
def self.version
  VERSION::STRING
end

© 2004–2017 David Heinemeier Hansson
Licensed under the MIT License.