【Railsフレームワーク】各ファイルの置き場のまとめ【ディレクトリ構成】

あれ、あのファイルはどこだっけ？と迷ってしまうことが多いので、
Railsの各ファイルの置き場をまとめました。

rails初学者の方等に、参考していただければ幸いです。

Railsフレームワークのディレクトリ構成

/（アプリフォルダ　web系なら　/var/www/hogeApi/）
config.ru :アプリケーションのエントリポイント
Gemfile :必要なgemファイルを定義
Rakefile :ターミナルから実行可能なジョブ
README :readmeファイル
├ app/ ※アプリケーションのメインフォルダ
│ ├ assets/
│ │ ├ images/ :画像ファイル
│ │ ├ javascripts/ :jsファイル
│ │ └ sytlesheets/ :cssファイル
│ ├ controllers/ :リクエストのコントロール
│ │ └ conserns/ :共通コードの置き場所。Railsのデフォルトのロー ドパスに含まれる
│ ├ helpers/ :各種メソッド
│ ├ mailers/ 
│ ├ models/ :データベースへのアクセス、その他必要なデータの集積
│ │ └ conserns/ :共通コードの置き場所。Railsのデフォルトのロードパスに含まれる
│ └ views/ :テンプレートファイル置き場（HTML、JavaScript、JSON等の生成）
│ │ └ layouts/
│ │   └ application.html.erb :アプリケーション共通レイアウトテンプレート
├ bin/ ※コード生成や開発サーバの起動に関するヘルパー
├ config/ ※各種設定
│ ├ environments/ :環境毎の設定ファイルを格納
│ ├ initilizers/ :初期化処理を定義したファイルを格納
│ │ ├ backtrace_silencers.rb :例外バックトレースのフィルタ
│ │ ├ filter_parameter_logging.rb :ロギングから除外するパラメータ情報の条件
│ │ ├ inflections.rb :単数形／複数形の変換ルール
│ │ ├ mime_types.rb :アプリケーションで使用できるコンテンツタイプ
│ │ ├ secret_token.rb :クッキーを署名するためのトークン情報とかAPIのトークンを記載
│ │ │                    * v4.1以降は「config/secrets.yml」に移行
│ │ └ session_store.rb :セッション保存のためのリソースファイル
│ ├ locales/ :辞書ファイルを格納
│ ├ secrets.yml 
│ └ routes.rb :ルーティグ設定ファイル
├ db/ ※DBの構成
│ ├ migrate/ :マイグレーションファイルを格納
│ ├ schema.rb:スキーマ情報を定義したファイル
│ └ seeds.rb :初期データを定義するファイル
├ lib/ ※自作のライブラリ(appやmodelの部品置き場)
│ └ task/ :タスク
├ log/ :アプリケーションのログファイル
├ public/ :静的なファイル、コンパイルされたアセットファイル
├ test/　※テストスクリプト等
│ ├ fixtures/ :フィクスチャファイルを格納
│ ├ 
│ └ 
├ temp/　※一時ファイル
├ vendor/　※サードパーティーのコード
  └ assets :サードパーティから提供されるアセット

記載方法は以下のようにしています。

※・・大事なところにつけています。基本1層目のフォルダ
:　・・そのファイルであったり、フォルダの説明

参考文献

パーフェクト Ruby on Rails

パーフェクト Ruby on Rails 【増補改訂版】 (Perfect series)

実践的なサンプルコードがあり、お勧め

リーダブルコード
―より良いコードを書くためのシンプルで実践的なテクニック

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

保守性・可読性が高いソースを書きたい方は、必見。

参考URL

Rakeタスクの実装

RubyでWebフレームワークを自作する

Ruby on Railsとは

今さら人に聞けなくなってきた時のRailsのキホン

Ruby on Railsのディレクトリ構造を詳しく解説します!

忘備録