目次
- 設定ファイルについて
- データベースの設定ファイル(database.yml)
- アプリケーションで共通の変数を設定
- 初期化の最後に実行する処理の設定(config.after_initialize)
- アセットのホスト設定(config.asset_host)
- 起動時のみロードする設定ファイルを追加(config.autoload_once_paths)
- アプリケーションクラスのリロードをするかの設定(config.cache_classes)
- テンプレートのレンダリングのキャッシュするかの設定(config.action_view.cache_template_loading)
- キャッシュストアの設定(config.cache_store)
- エラー情報をブラウザに表示をするかの設定(config.consider_all_requests_local)
- 使用するコンソールを設定(config.console)
- 設定のオートロードをするかの設定(config.dependency_loading)
- Eager Loadingの設定(config.eager_load)
- Eager Loadingで使用するネームスペースの設定(config.eager_load_namespaces)
- eager_loadのパスを設定(config.eager_load_paths)
- アプリケーション全体のエンコーディングを設定(config.encoding)
- 例外処理アプリケーションを設定(config.exceptions_app)
- ファイルシステム内の変更を検知をするかの設定(config.file_watcher)
- ログファイルにパラメータ情報を出力しない(config.filter_parameters)
- 強制的にHTTPSプロトコルを使用するかの設定(config.force_ssl)
- ログレベルの指定(config.log_level)
- タグ付きログの設定(config.log_tags)
- 使用するログオブジェクトの種類(config.logger)
- ファイルの変更検知の設定(config.reload_classes_only_on_change)
- シークレットキーの設定(config.secret_key_base)
- assetsの静的ファイルの設定(config.serve_static_assets)
- ログを出力するときにカラーにするか(config.colorize_logging)
- セッションストアの設定(config.session_store)
- タイムゾーンの設定(config.time_zone)
- 週の始まりの曜日の設定(config.beginning_of_week)
- 初期化されていないオブジェクトの警告(config.whiny_nils)
- アセットパイプラインを有効にするかの設定(config.assets.enabled)
- assetsでコンパイルする設定(config.assets.compress)
- CSSコンパイラーの設定(config.assets.css_compressor)
- JavaScriptのコンパイラーの設定(config.assets.js_compressor)
- assetsへのパス(config.assets.paths)
- assetでプリコンパイルする設定(config.assets.precompile)
- アセットパイプラインでprefix(config.assets.prefix)
- assetにMD5フィンガープリントを使用(config.assets.digest)
- オートロード対象となるパスの追加(config.autoload_paths)
- Assetの結合と圧縮の設定(config.assets.debug)
- キャッシュストアの設定(config.assets.cache_store)
- Assetのバージョンを指定(config.assets.version)
- ファイルがないときにファイルを探して自動コンパイル(config.assets.compile)
- Assetロガーの設定(config.assets.logger)
- アプリケーションのミドルウェアの設定(config.middleware)
- ミドルウェアを独自に追加(config.middleware.use)
- 既存のミドルウェアの後に新しいミドルウェアを追加(config.middleware.insert_after)
- ミドルウェアスタックを入れ替える(config.middleware.swap)
- ミドルウェアスタックを削除(config.middleware.delete)
- 国際化対応のためのデフォルトのロケール(config.i18n.default_locale)
- ロケールファイルへのパス(config.i18n.load_path)
- ログオブジェクト(config.active_record.logger)
- テーブルの主キーの設定(config.active_record.primary_key_prefix_type)
- テーブルを生成するときに指定した文字列を先頭に追加(config.active_record.table_name_prefix)
- テーブルを生成するときに指定した文字列を最後に追加(config.active_record.table_name_suffix)
- テーブル名を生成するときに複数形への変換をするかの設定(config.active_record.pluralize_table_names)
- データベースの処理の際に使うタイムゾーン(config.active_record.default_timezone)
- スキーマの形式を変更(config.active_record.schema_format)
- マイグレーションファイルの識別子を設定(config.active_record.timestamped_migrations)
- 楽観的ロックの設定(config.active_record.lock_optimistically)
- アセットファイルへのホストの設定(config.action_controller.asset_host)
- コントローラのキャッシュ設定をするかの設定(config.action_controller.perform_caching)
- キャッシュされたページに使用される拡張子の設定(config.action_controller.default_static_extension)
- コントローラのデフォルト文字コード(config.action_controller.default_charset)
- RequestForgeryのトークンパラメータを設定(config.action_controller.request_forgery_protection_token)
- CSRF保護をするかの設定(config.action_controller.allow_forgery_protection)
- サブディレクトリ(config.action_controller.relative_url_root)
- デフォルトで許可されるmass assignmentのパラメータの設定(config.action_controller.permit_all_parameters)
- アクションコントローラのロガー(config.action_controller.logger)
- 許可されていないパラメータの例外処理について(config.action_controller.action_on_unpermitted_params)
- Active Recordでのエラーを表示するためのHTMLジェネレーターの設定(config.action_view.field_error_proc)
- デフォルトで使用するビルダー形式(config.action_view.default_form_builder)
- ERBの処理方法(config.action_view.erb_trim_mode)
- Fromでのauthenticity_tokenの付与について(config.action_view.embed_authenticity_token_in_remote_forms)
- サブディレクトリの名前空間について(config.action_view.prefix_partial_path_with_controller_namespace)
- ビューのロガーの設定(config.action_view.logger)
- 電子メールで使用するデフォルトのロガーの設定(config.action_mailer.logger)
- SMTPの設定(config.action_mailer.smtp_settings)
- センドメールの設定(config.action_mailer.sendmail_settings)
- 電子メールが配信完了できない場合にエラーを発生させるかの設定(config.action_mailer.raise_delivery_errors)
- 電子メールの配信方法を設定(config.action_mailer.delivery_method)
- 電子メールの使用をするかの設定(config.action_mailer.perform_deliveries)
- 電子メールのデフォルトオプション(config.action_mailer.default_options)
- メールが配信されたときに通知されオブザーバーを登録(config.action_mailer.observers)
- 電子メールが送信される前に呼び出させるインタープリタを登録(config.action_mailer.interceptors)
- セッションストアの名前の設定(config.action_dispatch.session_store)
- デフォルトで設定されたHTMLヘッダを持つハッシュ(config.action_dispatch.default_headers)
- アプリケーションのトップドメインの長さを設定(config.action_dispatch.tld_length)
- リクエストの前に実行する処理(ActionDispatch::Callbacks.before)
- ActionDispatch::Callbacks.beforeの後に実行する処理(ActionDispatch::Callbacks.to_prepare)
- リクエストの後に実行する処理(ActionDispatch::Callbacks.after)
- アクティブサポートのロードの設定(config.active_support.bare)
- JSONのシリアル化でHTMLエンティティのエスケープ処理をするかの設定(config.active_support.escape_html_entities_in_json)
- ISO8601形式に日時をシリアライズ(config.active_support.use_standard_json_time_format)
- キャッシュストアで使用するロガーの設定(ActiveSupport::Cache::Store.logger)
- 非推奨の警告の動作を設定(ActiveSupport::Deprecation.behavior)
- 指定されたブロックで警告が表示されるか(ActiveSupport::Deprecation.silence)
- 非推奨の警告を標示するかの設定(ActiveSupport::Deprecation.silenced)
- サイレンサーのブロックをするかの設定(ActiveSupport::Logger.silencer)
設定ファイル(config)
設定ファイルについて
設定ファイルについて
Railsでは、config/以下の設定ファイルによって設定を変更できる。
特徴
- 「config.パラメータ名 = 値」の形式で設定
- 設定を反映するには、サーバの再起動が必要
- 文字コードは、UTF-8
主な設定ファイル
| 説明 | ||
|---|---|---|
| application.rb | すべての環境で共通の設定ファイル | |
| environment/ | 環境ごとの設定ファイルを格納するディレクトリ | |
| development.rb | 開発環境での設定ファイル | |
| test.rb | テスト環境での設定ファイル | |
| production.rb | 本番環境での設定ファイル | |
| initializers/ | その他の初期化処理や設定情報などを格納するディレクトリ | |
| infiections.rb | 単数形・複数形のルールを設定 | |
| mime_types.rb | アプリケーションで利用できるコンテンツタイプ | |
| secret_token.rb | クッキーを署名とするためのトークン情報 | |
| session_store.rb | セッションを保存するための設定ファイル | |
| locales/ | 国際化対応のためのリソースファイルを格納するディレクトリ |
データベースの設定ファイル(database.yml)
説明
Railsで使うデータベースの設定を記述
特徴
- YAML形式で記述
- 開発(development)、テスト(test)、本番(production)の3つの環境
接続できるデータベース
- DB2
- Firebird
- Frontbase
- MySQL
- Openbase
- Oracle
- PostgreSQL
- SQLite
- SQL Server
- Sybase
SQLite3
設定項目
| 設定項目 | 説明 | デフォルト |
|---|---|---|
| adapter | 接続するデータベースの種類 | sqlite3 |
| database | データベースファイルまでのパス | db/環境名.sqlite3 |
| pool | 接続のブール数 | 5 |
| timeout | タイムアウト時間 | 5000 |
例
development:
adapter: sqlite3
database: db/development.sqlite3
timeout: 5000
test:
adapter: sqlite3
database: db/test.sqlite3
timeout: 5000
production:
adapter: sqlite3
database: db/production.sqlite3
timeout: 5000
MySQL
設定項目
| 設定項目 | 説明 | デフォルト |
|---|---|---|
| adapter | 接続するデータベースの種類 | mysql2 |
| database | 接続先のデータベース名 | db/アプリケーション名_環境名 |
| host | 接続先のサーバ名またはIPアドレス。socketを指定した場合には無効 | localhost |
| post | 接続先のポート番号。socketを指定した場合には無効 | 3306 |
| socket | Unixソケットのパス | /tmp/mysql.sock |
| username | データベースに接続するユーザ名 | root |
| password | DBに接続するパスワード | |
| encoding | 文字エンコーディングを明示的に指定 | utf8 |
| pool | 接続のブール数 | 5 |
| timeout | タイムアウト時間 | false |
アプリケーションで共通の変数を設定
説明
サイトの名前などのアプリケーションで共通の名前を変数として設定する
使い方
config/application.rb
module モジュール名
class Application < Rails::Application
config.変数名 = 値
例
サイトの名前を変数に設定
設定
module Mysite
class Application < Rails::Application
config.title = "サイトの名前"
参照
Mysite::Application.config.title
初期化の最後に実行する処理の設定(config.after_initialize)
説明
初期化の最後に実行する処理を追加する。
主に環境ごとに設定が異なる場合などに使われる。
使い方
config.after_initialize do
処理の内容
end
例
config.after_initialize do
ActionView::Base.sanitized_allowed_tags.delete 'div'
end
アセットのホスト設定(config.asset_host)
説明
アセットのホスト設定する
使い方
config.asset_host = "ホスト名"
config.action_controller.asset_host = "ホスト名"
例
config.asset_host = "http://railsdoc.com/"
起動時のみロードする設定ファイルを追加(config.autoload_once_paths)
説明
起動時のみロードするコンテンツを配列に含める
使い方
config.autoload_once_path += %W(#{config.root}/ディレクトリ名)]
例
config.autoload_once_path += %W(#{config.root}/lib)
アプリケーションクラスのリロードをするかの設定(config.cache_classes)
説明
アクセスのたびにアプリケーションクラスのリロードするかの設定を行います。
使い方
リロードしない
cache_classes = true
リロードする
cache_classes = false
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | cache_classes = false |
| test | cache_classes = false |
| production | cache_classes = true |
テンプレートのレンダリングのキャッシュするかの設定(config.action_view.cache_template_loading)
説明
テンプレートのレンダリングのキャッシュするかの設定を行います。
使い方
config.action_view.cache_template_loading = ( true | false )
例
config.action_view.cache_template_loading = true
キャッシュストアの設定(config.cache_store)
説明
キャッシュストアを設定する
使い方
config.cache_store = キャッシュの種類
キャッシュの種類
| キャッシュの種類 | 説明 |
|---|---|
| :memory_store | |
| :file_store | |
| :mem_cache_store | |
| :null_store |
例
memcachedに保存
config.cache_store = :mem_cache_store
エラー情報をブラウザに表示をするかの設定(config.consider_all_requests_local)
説明
「true」のとき、すべてのエラーをブラウザに表示をするかの設定を行います。
使い方
config.consider_all_requests_local = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | true |
| test | true |
| production | false |
例
config.consider_all_requests_local = true
使用するコンソールを設定(config.console)
説明
使用するコンソールを設定する。ブロックで指定するのがよい。
console do # this block is called only when running console, # so we can safely require pry here require "pry" config.console = Pry end</p> <h4>使い方</h4> <pre>config.console do 設定 end
例
console do
require "pry"
config.console = Pry
end
設定のオートロードをするかの設定(config.dependency_loading)
説明
「false」を設定すると、設定のオートロードを無効にする。config.cache_classesが「true」のときにのみ有効。
使い方
config.dependency_loading = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | false |
| test | false |
| production | true |
例
config.dependency_loading = true
Eager Loadingの設定(config.eager_load)
説明
「true」のとき、eager_loadを使用する。
使い方
config.eager_load = ( true | false )
例
config.eager_load = true
Eager Loadingで使用するネームスペースの設定(config.eager_load_namespaces)
説明
config.eager_loadが「true」のときに、eager_loadされるネームスペースを設定する。
使い方
config.eager_load_namespaces
例
config.eager_load_namespaces << SimpleForm
eager_loadのパスを設定(config.eager_load_paths)
説明
eager_loadのパスを設定する。
使い方
config.eager_load_paths
例
config.eager_load_paths += %W( #{RAILS_ROOT}/app/workers )
アプリケーション全体のエンコーディングを設定(config.encoding)
説明
アプリケーション全体のエンコーディングを設定する。デフォルトは、「UTF-8」
使い方
config.encoding = 文字コード
例
config.encoding = euc-jp
例外処理アプリケーションを設定(config.exceptions_app)
説明
例外発生時にShowException middlewareから呼ばれる例外処理アプリケーションを設定する。
デフォルトは、「ActionDispatch::PublicExceptions.new(Rails.public_path)」
使い方
config.exceptions_app
例
config.exceptions_app = self.routes
ファイルシステム内の変更を検知をするかの設定(config.file_watcher)
説明
「ture」の場合、ファイルシステム内のファイルの更新を検知するためのクラス。
ActiveSupport::FileUpdateCheckerに準拠する必要がある。
使い方
config.file_watcher
例
ログファイルにパラメータ情報を出力しない(config.filter_parameters)
説明
パスワードやカードナンバーなどの出力したくないパラメータなどを、出力しないようにする
使い方
config.filter_parameters += [パラメータ]
例
パスワードのパラメータをログに出力しない
config.filter_parameters += [:password]
強制的にHTTPSプロトコルを使用するかの設定(config.force_ssl)
説明
ActionDispatch::SSLを使用して、強制的にHTTPSプロトコルを使用する。
使い方
config.force_ssl = ( true | false )
例
config.force_ssl = true
ログレベルの指定(config.log_level)
説明
アプリケーションのログレベルを指定する。
使い方
config.log_level = ( :debug | :info | :error | :fatal )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | log_leval = :debug |
| test | log_leval = :debug |
| production | log_leval = :info |
例
config.log_level = :info
タグ付きログの設定(config.log_tags)
説明
タグ付きログの設定をする
使い方
config.log_tags
例
config.log_tags = [:uuid, :remote_ip]
使用するログオブジェクトの種類(config.logger)
説明
使用するログオブジェクトの種類を指定する。デフォルトでは、ActiveSupport::Loggerのインスタンスを使用する。
使い方
config.logger = Logger.new(<ログのパス>, <条件>)
例
毎日ローテート
config.logger = Logger.new(config.log_path, 'daily')
10MBごとに10ファイルまで作成
config.logger = Logger.new(config.log_path, 10, 10.megabytes)
ログを無効にする
config.logger =nil
ファイルの変更検知の設定(config.reload_classes_only_on_change)
説明
ファイルの変更検知の設定をする。
依存関係のあるファイルに変更があった場合に、クラスを再読み込みするようになる。
config.cache_classesが「true」の場合は、無視される。
使い方
config.reload_classes_only_on_change = ( true | false )
例
config.reload_classes_only_on_change = false
シークレットキーの設定(config.secret_key_base)
説明
アプリケーションのセッションの改ざんを防止するために、キーの設定。
デフォルトは、ランダムキーを使用する。
使い方
config.secret_key_base
例
config.secret_key_base = 'myapp1234'
assetsの静的ファイルの設定(config.serve_static_assets)
説明
assetsの静的ファイルの設定。
使い方
config.serve_static_assets = ( true | false )
例
config.serve_static_assets = false
ログを出力するときにカラーにするか(config.colorize_logging)
説明
ログを出力する時に、ANSIカラーコードを使用するかどうかを指定する。デフォルトはtrue。
使い方
config.colorize_logging = (true or false)
例
config.active_record.colorize_logging = false
セッションストアの設定(config.session_store)
説明
セッションストアの設定
使い方
config.session_store
例
config.session_store :cookie_store, :key => '_your_app_session'
タイムゾーンの設定(config.time_zone)
説明
アプリケーションやアクティブレコードで使用するデフォルトのタイムゾーンの設定をする。
使い方
# config/application.rb
config.time_zone = 'タイムゾーンの設定'
タイムゾーン一覧
例
タイムゾーンを東京に設定
config.time_zone = 'Tokyo'
その他
設定できるタイムゾーンの確認
$ rake time:zones:all
現在のタイムゾーンの確認
$ rake time:zones:local
週の始まりの曜日の設定(config.beginning_of_week)
説明
アプリケーションで使用する週の始まるの曜日の設定
使い方
config.beginning_of_week = :曜日
例
config.beginning_of_week = :monday
初期化されていないオブジェクトの警告(config.whiny_nils)
説明
初期化されていないオブジェクトが呼び出させたときに、警告を表示する。デフォルトでは、開発環境、テスト環境で有効。
使い方
config.whiny_nils = ( true | false )
例
config.whiny_nils = true
アセットパイプラインを有効にするかの設定(config.assets.enabled)
説明
アセットパイプラインを有効にするかの設定を行います。
使い方
config.assets.enabled = ( true | false )
例
config.assets.enabled = false
assetsでコンパイルする設定(config.assets.compress)
説明
assetsでコンパイルする設定
使い方
config.assets.compress = ( true | false )
例
config.assets.compress = true
CSSコンパイラーの設定(config.assets.css_compressor)
説明
CSSコンパイラーの設定。デフォルトは、「sass-rails」
使い方
config.assets.css_compressor
例
config.assets.css_compressor = :yui
JavaScriptのコンパイラーの設定(config.assets.js_compressor)
説明
JavaScriptのコンパイラーの設定
使い方
config.assets.js_compressor
例
config.assets.js_compressor = :uglifier
assetsへのパス(config.assets.paths)
説明
assetsへのパス
使い方
config.assets.paths
例
config.assets.paths << Rails.root.join("app", "assets", "flash")
assetでプリコンパイルする設定(config.assets.precompile)
説明
assetでプリコンパイルする設定
使い方
config.assets.precompile
例
config.assets.precompile += ['admin.js', 'admin.css', 'swfObject.js']
アセットパイプラインでprefix(config.assets.prefix)
説明
アセットパイプラインでprefix
使い方
config.assets.prefix
例
config.assets.prefix = "/some_other_path"
assetにMD5フィンガープリントを使用(config.assets.digest)
説明
assetにMD5フィンガープリントを使用
使い方
config.assets.digest = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | false |
| test | false |
| production | true |
例
config.assets.digest = true
オートロード対象となるパスの追加(config.autoload_paths)
説明
オートロード対象となるパスを追加する。Rails3からautoload_pathsの設定はデフォルトでは無効になっている。
使い方
config.autoload_paths += %W(#{config.root}/ディレクトリ名)
例
/libファイル以下を自動でロード
config.autoload_paths += %W(#{config.root}/lib)
Assetの結合と圧縮の設定(config.assets.debug)
説明
Assetの結合と圧縮の設定
使い方
config.assets.debug = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | false |
| test | false |
| production | true |
例
config.assets.debug = true
キャッシュストアの設定(config.assets.cache_store)
説明
キャッシュストアの設定。デフォルトは、「Rails file store」
使い方
config.assets.cache_store
例
config.assets.cache_store = [ :file_store, "/tmp/rails-cache/assets/#{Rails.env}/" ]
Assetのバージョンを指定(config.assets.version)
説明
Assetのバージョンを指定
使い方
config.assets.version = バージョン
例
config.assets.version = '1.0'
ファイルがないときにファイルを探して自動コンパイル(config.assets.compile)
説明
「true」の場合は、public/assetsのなかに必要なファイルを見つからなかった時に、app/assetsなどからファイルを探しコンパイルを行う。
使い方
config.assets.compile = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | false |
| test | false |
| production | true |
例
config.assets.compile = true
Assetロガーの設定(config.assets.logger)
説明
Assetロガーの設定
使い方
config.assets.logger
例
アプリケーションのミドルウェアの設定(config.middleware)
説明
アプリケーションのミドルウェアの設定する。
使い方
config.middleware
例
ミドルウェアを独自に追加(config.middleware.use)
説明
ミドルウェアを独自に追加
使い方
config.middleware.use
例
既存のミドルウェアの後に新しいミドルウェアを追加(config.middleware.insert_after)
説明
既存のミドルウェアの後に、新しいミドルウェアを追加する。
使い方
config.middleware.insert_after
例
ミドルウェアスタックを入れ替える(config.middleware.swap)
説明
ミドルウェアスタックを入れ替える
使い方
config.middleware.swap
例
ミドルウェアスタックを削除(config.middleware.delete)
説明
ミドルウェアスタックを削除する
使い方
config.middleware.delete
例
国際化対応のためのデフォルトのロケール(config.i18n.default_locale)
説明
国際化対応のためのデフォルトのロケール。デフォルトは「:en」
使い方
i18n.default_locale = 国コード
例
i18n.default_locale = :ja
ロケールファイルへのパス(config.i18n.load_path)
説明
ロケールファイルへのパス。デフォルトは、「config/locales/*.{yml,rb}」
使い方
config.i18n.load_path
例
config.i18n.load_path += Dir[Rails.root.join('config/locales/**/*.yml').to_s]
ログオブジェクト(config.active_record.logger)
説明
ログオブジェクト。
ログオブジェクトは、Log4Rインターフェース、またはRubyログオブジェクトクラスとの互換性が必要。
「nil」を設定すると、無効になる。
使い方
config.active_record.logger = logger
例
config.active_record.logger = Logger.new("log/development_sql.log")
テーブルの主キーの設定(config.active_record.primary_key_prefix_type)
説明
テーブルの主キーのカラムを指定する。デフォルトは、「id」
使い方
config.active_record.primary_key_prefix_type = 主キー名
例
config.active_record.primary_key_prefix_type = :table_name_with_underscore
テーブルを生成するときに指定した文字列を先頭に追加(config.active_record.table_name_prefix)
説明
テーブルを生成するときに、指定した文字列を先頭に追加する。
使い方
config.active_record.table_name_prefix = "prefix"
例
config.active_record.table_name_prefix = "northwest_"
テーブルを生成するときに指定した文字列を最後に追加(config.active_record.table_name_suffix)
説明
テーブルを生成するときに、指定した文字列を最後に追加する。
使い方
config.active_record.table_name_suffix = suffix
例
config.active_record.table_name_suffix = "_northwest"
テーブル名を生成するときに複数形への変換をするかの設定(config.active_record.pluralize_table_names)
説明
クラス名からテーブル名を生成するときに、複数形への変換の有無。デフォルトは、「true」
使い方
config.active_record.pluralize_table_names = ( true | false )
例
config.active_record.pluralize_table_names = false
データベースの処理の際に使うタイムゾーン(config.active_record.default_timezone)
説明
データベースの処理の際に使うタイムゾーンを指定する。「:utc」を設定すると、データベースに保存したりする時刻がUTCとなる。デフォルトでは、「:local」が設定されている。
使い方
config.active_record.default_timezone = ( :local | :utc )
例
config.active_record.default_timezone = :utc
スキーマの形式を変更(config.active_record.schema_format)
説明
データベーススキーマの出力形式を変更する。デフォルトは、「:ruby」
使い方
config.active_record.schema_format = 形式
形式
| 形式 | 説明 |
|---|---|
| :ruby | Ruby形式 |
| :sql | SQL形式 |
例
config.active_record.schema_format = :sql
マイグレーションファイルの識別子を設定(config.active_record.timestamped_migrations)
説明
マイグレーションファイルの識別子を設定する。falseを設定すると、タイムスタンプの代わりに昇降の整数を使用する。
使い方
config.active_record.timestamped_migrations = "識別子"
例
config.active_record.timestamped_migrations = false
楽観的ロックの設定(config.active_record.lock_optimistically)
説明
楽観的ロックの設定をする。デフォルトは、「true」
使い方
config.active_record.lock_optimistically = ( true | false )
例
config.active_record.lock_optimistically = false
アセットファイルへのホストの設定(config.action_controller.asset_host)
説明
アセットファイルへのホストやパスを設定する。
使い方
config.action_controller.asset_host = URL
例
config.action_controller.asset_host = "http://railsdoc.com"
コントローラのキャッシュ設定をするかの設定(config.action_controller.perform_caching)
説明
アプリケーションのキャッシュの有無。
使い方
config.action_controller.perform_caching = ( true | false )
デフォルトの設定
| 環境 | 設定 |
|---|---|
| development | false |
| test | false |
| production | true |
例
config.action_controller.perform_caching = true
キャッシュされたページに使用される拡張子の設定(config.action_controller.default_static_extension)
説明
キャッシュされたページに使用される拡張子の設定。デフォルトは、「.html」
使い方
config.action_controller.default_static_extension
例
config.action_controller.default_static_extension = '.php'
コントローラのデフォルト文字コード(config.action_controller.default_charset)
説明
コントローラのデフォルトの文字コートを設定する。デフォルトは、「utd-8」
使い方
config.action_controller.default_charset = 文字コード
例
config.action_controller.default_charset = "euc-jp"
RequestForgeryのトークンパラメータを設定(config.action_controller.request_forgery_protection_token)
説明
RequestForgeryのトークンパラメータを設定する。デフォルトは、「:authenticity_token」
使い方
config.action_controller.request_forgery_protection_token = "名前"
例
config.action_controller.request_forgery_protection_token = '_xsrf_token_here'
CSRF保護をするかの設定(config.action_controller.allow_forgery_protection)
説明
CSRF保護を有効にするかデフォルトは、「false」
使い方
config.action_controller.allow_forgery_protection = ( true | false )
例
config.action_controller.allow_forgery_protection = true
サブディレクトリ(config.action_controller.relative_url_root)
説明
サブディレクトリについて。デフォルトは、「ENV['RAILS_RELATIVE_URL_ROOT」
使い方
config.action_controller.relative_url_root
例
config.action_controller.relative_url_root = "/myapp"
デフォルトで許可されるmass assignmentのパラメータの設定(config.action_controller.permit_all_parameters)
説明
デフォルトで許可されるmass assignmentのパラメータの設定。デフォルトは、「false」
使い方
config.action_controller.permit_all_parameters = ( true | false )
例
config.action_controller.permit_all_parameters = true
アクションコントローラのロガー(config.action_controller.logger)
説明
アクションコントローラのロガー。「nil」を設定することで、無効になる。
使い方
config.action_controller.logger
例
許可されていないパラメータの例外処理について(config.action_controller.action_on_unpermitted_params)
説明
明示的に許可されていないパラメータが検出された場合に、例外をログに記録するか
使い方
config.action_controller.action_on_unpermitted_params
例
config.action_controller.action_on_unpermitted_params = :raise
Active Recordでのエラーを表示するためのHTMLジェネレーターの設定(config.action_view.field_error_proc)
説明
Active Recordでのエラーを表示するためのHTMLジェネレーター。デフォルトは、
Proc.new do |html_tag, instance|
%Q(<div class="field_with_errors">#{html_tag}</div>).html_safe
end
使い方
config.action_view.field_error_proc
例
config.action_view.field_error_proc = Proc.new { |html_tag, instance|
"#{html_tag}".html_safe
}
デフォルトで使用するビルダー形式(config.action_view.default_form_builder)
説明
デフォルトで使用するビルダー形式
使い方
config.action_view.default_form_builder
例
config.action_view.default_form_builder = "ApplicationHelper::TestFormBuilder"
ERBの処理方法(config.action_view.erb_trim_mode)
説明
ERBの処理方法。デフォルトは、「-」。詳細は、ERB documentation
使い方
config.action_view.erb_trim_mode = "区切り文字"
例
config.action_view.erb_trim_mode = -"
Fromでのauthenticity_tokenの付与について(config.action_view.embed_authenticity_token_in_remote_forms)
説明
「:remote=>true」オプションが指定されたform_tagでauthenticity_tokenを付与するか
使い方
config.action_view.embed_authenticity_token_in_remote_forms = ( true | false )
例
config.action_view.embed_authenticity_token_in_remote_forms = false
サブディレクトリの名前空間について(config.action_view.prefix_partial_path_with_controller_namespace)
説明
サブディレクトリの名前空間について
使い方
config.action_view.prefix_partial_path_with_controller_namespace = ( true | false )
例
config.action_view.prefix_partial_path_with_controller_namespace = false
ビューのロガーの設定(config.action_view.logger)
説明
ビューのロガーの設定
使い方
config.action_view.logger
例
config.action_view.logger = nil
電子メールで使用するデフォルトのロガーの設定(config.action_mailer.logger)
説明
電子メールで使用するデフォルトのロガーの設定をする。「nil」を設定するとログを出力しない。
使い方
config.action_mailer.logger = logger
例
config.action_mailer.logger = ActiveSupport::BufferedLogger.new("mailer.log")
SMTPの設定(config.action_mailer.smtp_settings)
説明
SMTPの設定
使い方
config.action_mailer.smtp_settings
オプション
| オプション | 説明 | デフォルト |
|---|---|---|
| :address | Allows you to use a remote mail server. Just change it from its default "localhost" setting. | localhost |
| :port | On the off chance that your mail server doesn't run on port 25, you can change it. | 25 |
| :domain | If you need to specify a HELO domain, you can do it here. | |
| :user_name | If your mail server requires authentication, set the username in this setting. | |
| :password | If your mail server requires authentication, set the password in this setting. | |
| :authentication | If your mail server requires authentication, you need to specify the authentication type here. This is a symbol and one of `:plain`, `:login`, `:cram_md5` |
例
config.action_mailer.smtp_settings = {
:address => 'railsdoc.com',
:domain => 'railsdoc.com',
:port => 80,
:user_name => 'example@example.com',
:password => 'yourpassword',
:authentication => :plain
}
センドメールの設定(config.action_mailer.sendmail_settings)
説明
センドメールの設定をする。
使い方
config.action_mailer.sendmail_settings = オプション
オプション
| オプション | 説明デフォルト |
|---|---|
| :location | 実行可能なsendmailのパス。/usr/sbin/sendmail |
| :arguments | コマンドラインの引数-i -t |
例
config.action_mailer.sendmail_settings = {
:location => '/usr/sbin/sendmail',
:arguments => '-i -t'
}
電子メールが配信完了できない場合にエラーを発生させるかの設定(config.action_mailer.raise_delivery_errors)
説明
電子メールが配信完了できない場合に、エラーを発生させるか。デフォルトは、「true」
使い方
config.action_mailer.raise_delivery_errors = ( true | false )
例
config.action_mailer.raise_delivery_errors = false
電子メールの配信方法を設定(config.action_mailer.delivery_method)
説明
電子メールの配信方法を設定する。デフォルトは、「:smtp」
使い方
config.action_mailer.delivery_method = ( :smtp | :sendmail | :test )
例
config.action_mailer.delivery_method = :sendmail
電子メールの使用をするかの設定(config.action_mailer.perform_deliveries)
説明
電子メールを使用するか。デフォルトは、「ture」
使い方
config.action_mailer.perform_deliveries = ( true | false )
例
config.action_mailer.perform_deliveries = false
電子メールのデフォルトオプション(config.action_mailer.default_options)
説明
電子メールのデフォルトオプション
使い方
config.action_mailer.default_options
例
config.action_mailer.default_options = {
:from => "example@example.com"
}
メールが配信されたときに通知されオブザーバーを登録(config.action_mailer.observers)
説明
メールが配信されたときに通知され、オブザーバーを登録
使い方
config.action_mailer.observers
例
config.action_mailer.observers = ["MailObserver"]
電子メールが送信される前に呼び出させるインタープリタを登録(config.action_mailer.interceptors)
説明
電子メールが送信される前に呼び出させるインタープリタを登録する
使い方
config.action_mailer.interceptors
例
config.action_mailer.interceptors = ["MailInterceptor"]
セッションストアの名前の設定(config.action_dispatch.session_store)
説明
セッションストアの名前の設定
使い方
config.action_dispatch.session_store
例
config.action_dispatch.session_store = :active_record_store
デフォルトで設定されたHTMLヘッダを持つハッシュ(config.action_dispatch.default_headers)
説明
デフォルトで設定されたHTMLヘッダを持つハッシュ。デフォルトで下記の設定が定義されている。
config.action_dispatch.default_headers = {
'X-Frame-Options' => 'SAMEORIGIN',
'X-XSS-Protection' => '1; mode=block',
'X-Content-Type-Options' => 'nosniff'
}
使い方
config.action_dispatch.default_headers
例
config.action_dispatch.default_headers = {
'X-Frame-Options' => 'DENY',
'X-XSS-Protection' => '0',
'X-Content-Type-Options' => 'nosniff',
'X-UA-Compatible' => 'IE=EmulateIE7'
}
アプリケーションのトップドメインの長さを設定(config.action_dispatch.tld_length)
説明
アプリケーションのトップドメインの長さを設定する。デフォルトは、「1」
使い方
config.action_dispatch.tld_length
例
config.action_dispatch.tld_length = 2
リクエストの前に実行する処理(ActionDispatch::Callbacks.before)
説明
リクエストの前に実行する処理
使い方
ActionDispatch::Callbacks.before
例
ActionDispatch::Callbacks.before do
if Object.const_defined?(:Example)
if Example.const_defined?(:MyClass)
Example.send(:remove_const, :MyClass)
end
end
require 'example/my_class'
end
ActionDispatch::Callbacks.beforeの後に実行する処理(ActionDispatch::Callbacks.to_prepare)
説明
ActionDispatch::Callbacks.beforeの後に実行する処理
使い方
ActionDispatch::Callbacks.to_prepare = ( true | false )
例
ActionDispatch::Callbacks.to_prepare = true
リクエストの後に実行する処理(ActionDispatch::Callbacks.after)
説明
リクエストの後に実行する処理
使い方
ActionDispatch::Callbacks.after
例
ActionDispatch::Callbacks.after do
load 'filename_in_lib'
# or
Dir.entries("#{Rails.root}/lib").each do |entry|
load entry if entry =~ /.rb$/
end
end
アクティブサポートのロードの設定(config.active_support.bare)
説明
Railsの起動時に、全アクティブサポートのロードを有効、または無効にする。
デフォルトは、「nil」で、その際は全アクティブサポートが呼びこまれる。
使い方
config.active_support.bare
例
config.active_support.bare = true
JSONのシリアル化でHTMLエンティティのエスケープ処理をするかの設定(config.active_support.escape_html_entities_in_json)
説明
JSONのシリアル化でHTMLエンティティのエスケープ処理を有効、または無効にする。デフォルトは、「false」
使い方
config.active_support.escape_html_entities_in_json = ( true | false )
例
config.active_support.escape_html_entities_in_json = true
ISO8601形式に日時をシリアライズ(config.active_support.use_standard_json_time_format)
説明
ISO8601形式に日時をシリアライズするか。デフォルトは、「true」
使い方
config.active_support.use_standard_json_time_format = ( true | false )
例
config.active_support.use_standard_json_time_format = false
キャッシュストアで使用するロガーの設定(ActiveSupport::Cache::Store.logger)
説明
キャッシュストアで使用するロガーの設定
使い方
ActiveSupport::Cache::Store.logger
例
ActiveSupport::Cache::Store.logger = Logger.new(STDOUT)
非推奨の警告の動作を設定(ActiveSupport::Deprecation.behavior)
説明
非推奨の警告の動作を設定。「config.active_support.deprecation」の代わりになるもの。
使い方
ActiveSupport::Deprecation.behavior
例
ActiveSupport::Deprecation.behavior = :notify
指定されたブロックで警告が表示されるか(ActiveSupport::Deprecation.silence)
説明
指定されたブロックで警告が表示されるか
使い方
ActiveSupport::Deprecation.silence
例
ActiveSupport::Deprecation.silence { extend ActiveSupport::Memoizable }
非推奨の警告を標示するかの設定(ActiveSupport::Deprecation.silenced)
説明
非推奨の警告を表示するかどうかの設定
使い方
ActiveSupport::Deprecation.silenced = ( true | false )
例
ActiveSupport::Deprecation.silenced = true
サイレンサーのブロックをするかの設定(ActiveSupport::Logger.silencer)
説明
サイレンサー(バックトレースを完全に取り除く)のブロックを有効にするか、無効にするか。
「false」を設定する場合、silence loggingのブロックを無効にする。デフォルトは、「true」
使い方
ActiveSupport::Logger.silencer = ( true | false )
例
ActiveSupport::Logger.silencer = false