Spec-Zone.ru › Ruby on Rails 5.0

класс Rails::Application

Родитель:
Engine

Класс Engine с задачей координации всего процесса запуска.

Инициализация

Rails::Application отвечает за выполнение всех инициализаторов railties и engines. Также он выполняет некоторые инициализаторы запуска (проверьте Rails::Application::Bootstrap) и завершающие инициализаторы после выполнения всех остальных (проверьте Rails::Application::Finisher).

Конфигурация

Помимо предоставления той же конфигурации, что и Rails::Engine и Rails::Railtie, объект приложения имеет несколько специфических конфигураций, например, “cache_classes”, “consider_all_requests_local”, “filter_parameters”, “logger” и так далее.

Проверьте Rails::Application::Configuration, чтобы увидеть их все.

Маршруты

Объект приложения также отвечает за хранение маршрутов и их перезагрузку всякий раз, когда файлы меняются в режиме разработки.

Средства промежуточного слоя

Класс Application также отвечает за построение стека middleware.

Процесс запуска

Приложение также отвечает за настройку и выполнение процесса запуска. С момента требования «config/application.rb» в вашем приложении процесс запуска происходит следующим образом:

1)  require "config/boot.rb" to setup load paths
2)  require railties and engines
3)  Define Rails.application as "class MyApp::Application < Rails::Application"
4)  Run config.before_configuration callbacks
5)  Load config/environments/ENV.rb
6)  Run config.before_initialize callbacks
7)  Run Railtie#initializer defined by railties, engines and application.
    One by one, each engine sets up its load paths, routes and runs its config/initializers/* files.
8)  Custom Railtie#initializers added by railties, engines and applications are executed
9)  Build the middleware stack and run to_prepare callbacks
10) Run config.before_eager_load and eager_load! if eager_load is true
11) Run config.after_initialize callbacks

Несколько приложений

Если вы решите определить несколько приложений, то первое инициализированное приложение будет установлено в Rails.application, если вы не переопределите его другим приложением.

Чтобы создать новое приложение, можно создать новый экземпляр класса, который уже был создан:

class Application < Rails::Application
end

first_application  = Application.new
second_application = Application.new(config: first_application.config)

В приведенном выше примере для инициализации второго приложения использовалась конфигурация первого приложения. Также можно использовать initialize_copy в одном из приложений для создания копии приложения, которая разделяет конфигурацию.

Если вы решите определить задачи rake, исполнители или инициализаторы в приложении, отличном от Rails.application, то вам нужно будет выполнить их вручную.

Атрибуты

assets[RW]
executor[R]
reloader[R]
reloaders[R]
sandbox[RW]
sandbox?[RW]

Методы публичного класса

create(initial_variable_values = {}, &block) Показать исходный код
# File railties/lib/rails/application.rb, line 97
def create(initial_variable_values = {}, &block)
  new(initial_variable_values, &block).run_load_hooks!
end
find_root(from) Показать исходный код
# File railties/lib/rails/application.rb, line 101
def find_root(from)
  find_root_with_flag "config.ru", from, Dir.pwd
end
inherited(base) Показать исходный код
# File railties/lib/rails/application.rb, line 86
def inherited(base)
  super
  Rails.app_class = base
  add_lib_to_load_path!(find_root(base.called_from))
  ActiveSupport.run_load_hooks(:before_configuration, base)
end
Вызывает метод суперкласса
instance() Показать исходный код
# File railties/lib/rails/application.rb, line 93
def instance
  super.run_load_hooks!
end
Вызывает метод суперкласса
new(initial_variable_values = {}, &block) Показать исходный код
# File railties/lib/rails/application.rb, line 122
def initialize(initial_variable_values = {}, &block)
  super()
  @initialized       = false
  @reloaders         = []
  @routes_reloader   = nil
  @app_env_config    = nil
  @ordered_railties  = nil
  @railties          = nil
  @message_verifiers = {}
  @ran_load_hooks    = false

  @executor          = Class.new(ActiveSupport::Executor)
  @reloader          = Class.new(ActiveSupport::Reloader)
  @reloader.executor = @executor

  # are these actually used?
  @initial_variable_values = initial_variable_values
  @block = block
end
Вызывает метод суперкласса

Методы публичного экземпляра

config_for(name, env: Rails.env) Показать исходный код
# File railties/lib/rails/application.rb, line 223
def config_for(name, env: Rails.env)
  if name.is_a?(Pathname)
    yaml = name
  else
    yaml = Pathname.new("#{paths["config"].existent.first}/#{name}.yml")
  end

  if yaml.exist?
    require "erb"
    (YAML.load(ERB.new(yaml.read).result) || {})[env] || {}
  else
    raise "Could not load configuration. No such file - #{yaml}"
  end
rescue Psych::SyntaxError => e
  raise "YAML syntax error occurred while parsing #{yaml}. "          "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. "          "Error: #{e.message}"
end

Удобный способ загрузки конфигурации config/foo.yml для текущей среды Rails.

Пример:

# config/exception_notification.yml:
production:
  url: http://127.0.0.1:8080
  namespace: my_app_production
development:
  url: http://localhost:3001
  namespace: my_app_development

# config/environments/production.rb
Rails.application.configure do
  config.middleware.use ExceptionNotifier, config_for(:exception_notification)
end
console(&blk) Показать исходный код
# File railties/lib/rails/application.rb, line 289
def console(&blk)
  self.class.console(&blk)
end

Передает любой вызов консоли в экземпляре нового приложения методу console, определённому в Rails::Railtie.

env_config() Показать исходный код
# File railties/lib/rails/application.rb, line 244
def env_config
  @app_env_config ||= begin
    validate_secret_key_config!

    super.merge(
      "action_dispatch.parameter_filter" => config.filter_parameters,
      "action_dispatch.redirect_filter" => config.filter_redirect,
      "action_dispatch.secret_token" => secrets.secret_token,
      "action_dispatch.secret_key_base" => secrets.secret_key_base,
      "action_dispatch.show_exceptions" => config.action_dispatch.show_exceptions,
      "action_dispatch.show_detailed_exceptions" => config.consider_all_requests_local,
      "action_dispatch.logger" => Rails.logger,
      "action_dispatch.backtrace_cleaner" => Rails.backtrace_cleaner,
      "action_dispatch.key_generator" => key_generator,
      "action_dispatch.http_auth_salt" => config.action_dispatch.http_auth_salt,
      "action_dispatch.signed_cookie_salt" => config.action_dispatch.signed_cookie_salt,
      "action_dispatch.encrypted_cookie_salt" => config.action_dispatch.encrypted_cookie_salt,
      "action_dispatch.encrypted_signed_cookie_salt" => config.action_dispatch.encrypted_signed_cookie_salt,
      "action_dispatch.cookies_serializer" => config.action_dispatch.cookies_serializer,
      "action_dispatch.cookies_digest" => config.action_dispatch.cookies_digest
    )
  end
end

Хранит некоторые параметры начальной среды Rails, которые будут использоваться посредниками и движками для их конфигурирования.

Вызывает метод суперкласса
generators(&blk) Показать исходный код
# File railties/lib/rails/application.rb, line 295
def generators(&blk)
  self.class.generators(&blk)
end

Передает любые вызовы генераторов в экземпляре нового приложения методу generators , определённому в Rails::Railtie.

initialized?() Показать исходный код
# File railties/lib/rails/application.rb, line 143
def initialized?
  @initialized
end

Возвращает true, если приложение инициализировано.

initializer(name, opts={}, &block) Показать исходный код
# File railties/lib/rails/application.rb, line 277
def initializer(name, opts={}, &block)
  self.class.initializer(name, opts, &block)
end

Отправляет инициализаторы методу initializer, определённому в модуле Rails::Initializable. Каждый класс Rails::Application имеет свой набор инициализаторов, как определено модулем Initializable.

isolate_namespace(mod) Показать исходный код
# File railties/lib/rails/application.rb, line 300
def isolate_namespace(mod)
  self.class.isolate_namespace(mod)
end

Отправляет метод isolate_namespace на метод класса.

key_generator() Показать исходный код
# File railties/lib/rails/application.rb, line 167
def key_generator
  # number of iterations selected based on consultation with the google security
  # team. Details at https://github.com/rails/rails/pull/6952#issuecomment-7661220
  @caching_key_generator ||=
    if secrets.secret_key_base
      unless secrets.secret_key_base.kind_of?(String)
        raise ArgumentError, "`secret_key_base` for #{Rails.env} environment must be a type of String, change this value in `config/secrets.yml`"
      end
      key_generator = ActiveSupport::KeyGenerator.new(secrets.secret_key_base, iterations: 1000)
      ActiveSupport::CachingKeyGenerator.new(key_generator)
    else
      ActiveSupport::LegacyKeyGenerator.new(secrets.secret_token)
    end
end

Возвращает генератор ключей приложения.

message_verifier(verifier_name) Показать исходный код
# File railties/lib/rails/application.rb, line 200
def message_verifier(verifier_name)
  @message_verifiers[verifier_name] ||= begin
    secret = key_generator.generate_key(verifier_name.to_s)
    ActiveSupport::MessageVerifier.new(secret)
  end
end

Возвращает объект верификатора сообщений.

Этот верификатор может использоваться для генерации и проверки подписанных сообщений в приложении.

Рекомендуется не использовать один и тот же верификатор для разных целей, поэтому вы можете получить разные верификаторы, передавая аргумент verifier_name.

Параметры

  • verifier_name - имя верификатора сообщений.

Примеры

message = Rails.application.message_verifier('sensitive_data').generate('my sensible data')
Rails.application.message_verifier('sensitive_data').verify(message)
# => 'my sensible data'

См. документацию по ActiveSupport::MessageVerifier для получения дополнительной информации.

rake_tasks(&block) Показать исходный код
# File railties/lib/rails/application.rb, line 270
def rake_tasks(&block)
  self.class.rake_tasks(&block)
end

Если вы пытаетесь определить набор задач rake в экземпляре, они будут переданы задачам rake, определённым в классе приложения.

reload_routes!() Показать исходный код
# File railties/lib/rails/application.rb, line 162
def reload_routes!
  routes_reloader.reload!
end

Перезагрузить маршруты приложения независимо от того, изменились ли они или нет.

runner(&blk) Показать исходный код
# File railties/lib/rails/application.rb, line 283
def runner(&blk)
  self.class.runner(&blk)
end

Передает любой вызов runner в экземпляре нового приложения методу runner , определённому в Rails::Railtie.

secrets() Показать исходный код
# File railties/lib/rails/application.rb, line 385
def secrets
  @secrets ||= begin
    secrets = ActiveSupport::OrderedOptions.new
    yaml = config.paths["config/secrets"].first
    if File.exist?(yaml)
      require "erb"
      all_secrets = YAML.load(ERB.new(IO.read(yaml)).result) || {}
      env_secrets = all_secrets[Rails.env]
      secrets.merge!(env_secrets.symbolize_keys) if env_secrets
    end

    # Fallback to config.secret_key_base if secrets.secret_key_base isn't set
    secrets.secret_key_base ||= config.secret_key_base
    # Fallback to config.secret_token if secrets.secret_token isn't set
    secrets.secret_token ||= config.secret_token

    secrets
  end
end

Возвращает секреты, добавленные в config/secrets.yml.

Пример:

development:
  secret_key_base: 836fa3665997a860728bcb9e9a1e704d427cfc920e79d847d79c8a9a907b9e965defa4154b2b86bdec6930adbe33f21364523a6f6ce363865724549fdfc08553
test:
  secret_key_base: 5a37811464e7d378488b0f073e2193b093682e4e21f5d6f3ae0a4e1781e61a351fdc878a843424e81c73fb484a40d23f92c8dafac4870e74ede6e5e174423010
production:
  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
  namespace: my_app_production

Rails.application.secrets.namespace возвращает my_app_production в среде производства.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API