はじめに
今回は、Ruby on Railsでよく使用するコマンドを整理しておきたいと思います。
私自身、仕事でRailsを使用しているわけでもないので、正直、Rails特有のコマンドなどは忘れがちです。なので、自分用に備忘録的に残しておこうというわけです。
また、その他のtipsも併せて記載しておこうと思います。
汎用的なコマンド
コマンド | 説明 |
---|---|
rails new アプリケーション名 | 新しい Rails アプリケーションを作成します。 |
rails server または rails s | ローカルサーバーを起動します。 |
rails console または rails c | Rails コンソールを起動します。 |
rails generate controller コントローラー名 または rails g controller コントローラー名 | コントローラーを生成します。 |
rails generate model モデル名 項目名:データ型 項目名:データ型 または rails g model モデル名 項目名:データ型 項目名:データ型 | モデルを生成します。 |
rails generate uploader uploader名 または rails g uploader uploader名 | uploaderを生成します。 |
rails db:migrate | マイグレーションを実行します。 |
rails db:rollback | 直近のマイグレーションをロールバックします。 |
rails routes | ルーティング一覧を表示します。 |
コマンドの具体例
- コントローラー生成: 上記のコマンドは、Posts コントローラーを作成し、index, show などの一般的なアクションを生成します。
rails generate controller Posts index show new create edit update destroy
- モデル生成: User モデルを作成し、name、email、password_digest というカラムを持つマイグレーションファイルも生成します。
rails generate model User name:string email:string password_digest:string
- マイグレーション実行: データベースに、直近のマイグレーションで定義された変更を適用します。
rails db:migrate
- サーバー起動: ローカルサーバーを起動し、他の端末からもアクセスできるようにします。
rails server -b 0.0.0.0
各コマンドのオプションや引数
- h, –help: コマンドのヘルプを表示します。
- f, –force: 既存のファイルがあっても上書きします。
- d, –database: データベースの種類を指定します(例: sqlite3, postgresql)。
コマンド実行後の動作
- コントローラー生成: app/controllers ディレクトリにコントローラーファイルが生成され、routes.rb にルートが追加されます。
- モデル生成: app/models ディレクトリにモデルファイルが生成され、db/migrate ディレクトリにマイグレーションファイルが生成されます。
- マイグレーション実行: データベースのスキーマが変更されます。
Rails コンソール内でのコマンド
Rails コンソールでは、モデルやデータベースに関する操作を直接行うことができます。
- モデルに関する操作
User.all
:User モデルのすべてのレコードを取得user = User.find(1)
:ID が 1 の User レコードを取得user.save
:user オブジェクトをデータベースに保存user.destroy
:user オブジェクトをデータベースから削除
- データベースに関する操作
User.count
:User モデルのレコード数をカウントUser.where(name: 'hoge')
:name が ‘hoge’ の User レコードを取得
User.all
については、以下を実行することで、ユーザーごとに改行して標準出力できます。
User.all.each do |user|
puts "ID: #{user.id}, Name: #{user.name}, Email: #{user.email}"
end
便利なショートカット
- bundle exec の省略: .zshrc や .bashrc に以下の行を追加することで、bundle exec を省略できます。
eval "$(rbenv init -)"
- Rails コンソールでのショートカット:
exit
: コンソールを終了します。reload!
: アプリケーションを再読み込みします。quit
: コンソールを終了し、アプリケーションも終了します。
その他
- Rspec や Capybara などのテストツール:
- Rspec は、テストを書くためのフレームワークです。
- Capybara は、Web アプリケーションの動作をテストするためのツールです。
- これらのツールを使うことで、コードの品質を向上させることができます。
- Rails のバージョンアップ:
- Rails のバージョンアップガイドを参照し、変更点を確認する必要があります。
- Gemfile の Rails のバージョンを更新し、bundle install を実行します。
- マイグレーションを実行し、データベースを更新します。
まとめ
今回は、Railsで開発を進めるうえでのtipsをまとめました。
他にも有用なものがあれば追記していきたいと思います。
コメント