Rails

Namespace

Module

Class

Methods

application
backtrace_cleaner
configuration
env
env=
gem_version
groups
public_path
root
version

Attributes

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

Class Public methods

application()

📝 Source code

# File railties/lib/rails.rb, line 39
    def application
      @application ||= (app_class.instance if app_class)
    end

🔎 See on GitHub

backtrace_cleaner()

📝 Source code

# File railties/lib/rails.rb, line 50
    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

🔎 See on GitHub

configuration()

The Configuration instance used to configure the Rails environment

📝 Source code

# File railties/lib/rails.rb, line 46
    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

📝 Source code

# File railties/lib/rails.rb, line 72
    def env
      @_env ||= ActiveSupport::StringInquirer.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 79
    def env=(environment)
      @_env = ActiveSupport::StringInquirer.new(environment)
    end

🔎 See on GitHub

gem_version()

Returns the version of the currently loaded 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;

groups assets: [:development, :test]

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

📝 Source code

# File railties/lib/rails.rb, line 94
    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 110
    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 63
    def root
      application && application.config.root
    end

🔎 See on GitHub

version()

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

📝 Source code

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

🔎 See on GitHub