Ruby on Rails Study Note

環境構築（docker）

docker environment

以下を準備する

docker-compose.yaml
Dockerfile
Gemfile
Gemfile.lock

docker-compose.yaml

version: '3'

services:
  service:
    build: .           #buildから実施
    ports:             #-p ポートフォワーディング
      - 3000:3000
    volumes:
      - .:/usr/src/app
    tty: true          #-t ttyを割り当てます。
    stdin_open: true   #-i STDINを開きます。

Dockerfile

FROM ruby:3.0

# throw errors if Gemfile has been modified since Gemfile.lock
# RUN bundle config --global frozen 1

WORKDIR /usr/src/app

# copy Gemfile Gemfile.lock
COPY Gemfile Gemfile.lock ./
# install the Gems written in the Gemfile 
RUN bundle install

COPY . .

# CMD ["./your-daemon-or-script.rb"]

Gemfile

source 'https://rubygems.org'
gem 'rails', '7.0.4'

Gemfile.lock

(空)

コンテナ操作

# build
docker-compose build
# build & start
docker-compose up -d
# in container
docker exec -it my_helloworld bash
# make new hello_app in container
rails new hello_app

余談

以下は必要に応じてコメントアウト/インする

# Gemfile.lock に変更は行われないし、行われるような変更を許容しなくなる
RUN bundle config --global frozen 1

# 1. Gemfile.lockのGemをインストール
# 2. Gemfileのみ記載があるGemをインストール
# 3. 2の内容をGemfile.lockへ追記
RUN bundle install

# 1. GemfileのGemをインストール
# 2. 1の内容をGemfile.lockへ追記
RUN bundle update

フォルダ構成

{アプリケーション名}/
  ├── app/           　　　　　　　　 // メインフォルダ
  |    ├── assets/    　　　　　　　  // リソースフォルダ
  |    |　　├── images/
  |    |　　├── javascript/
  |    |　　└── stylesheets/
  |    |　　   └── home.scss        // ■
  |    ├── models/    　　　　　　　  // モデルに関するフォルダ
  |    |　　   └── post.rb          // ▲
  |    ├── views/    　　　　　　　　 // ビュー（見た目）フォルダ
  |    |　　├── layout/
  |    |　　|  └── application.html.erb // 共通HTML
  |    |　　└── home/               // ■
  |    |　　   └── top.html.erb     // ■
  |    └── controllers/    　　　　　// コントロールフォルダ
  |     　　└── home_controller.rb  // ■
  ├── config/ 　　　　　　　　　　　　 // 設定情報に関するフォルダ
  |    └── routes.rb               // 
  ├── db/     　　　　　　　　　　　　 // データベースに関するフォルダ
  |    └── migrate/
  |     　　└── YYYYMMDDHHMMSS_create_posts.rb // ▲
  ├── public/                      // 静的コンテンツフォルダ
  ├── spec/                        // XXXXフォルダ
  |    └── posts_spec.rb           // ▲
  └── …/      　　　　　　　　　　　　 // その他

■：例）rails g controller home topで作成されるもの ▲：例）rails g model Post content:textで作成されるもの

Railsルーター

URLを実際のコードに振り分ける

GET ./patients/17というリクエストを受け取ったとき、特定のコントローラ内アクションにマッチさせる

get '/patients/:id', to: 'patients#show'

このリクエストはpatientsコントローラのshowアクションに割り当てられ、paramsには{ id: 17 }ハッシュが含まれます。 また、resourcesを宣言するだけで、コントローラのindex、show、new、edit、create、update、destroyアクションを個別に宣言しなくても1行で宣言が完了します。 このアクションはRailsのデフォルトで、それ以外のtopアクションを作りたいなどの場合は使えません。

resources :patients

// 限定したい場合
resource :patients, only: [:show]

collectionとmemberを使う

resources :patients [:show] do
  collection do
    get :import // URLは、#GET /patients/import
  end
  member do
    put :renew // URLは、#PUT /patients/:id/renew
  end
end

参考：https://railsguides.jp/routing.html

各種操作

アプリケーション作成

rails new {アプリケーション名}
rails _7.0.4_ new {アプリケーション名} --skip-bundle

サーバー起動

docker内の場合、--binding=0.0.0.0でないと外部のアクセスがリッスンできない

cd {アプリケーション名}
rails server --binding=0.0.0.0

作成されるURL：http://localhost:3000

アクションの作成

rails generate controller {コントローラ名} {アクション名}
// 例　rails generate controller home top

もしくは

rails g controller {コントローラ名} {アクション名}

作成されるURL：http://localhost:3000/home/top

ページを構成するのに必要なもの

• routing
  Rails内ではコントローラを経由してビューを返していますが、ブラウザとコントローラを繋ぐ役割を担うのがルーティングです。 ページが表示されるまでに、ルーティング→コントローラ→ビューという順で処理が行われている

  Rails.application.routes.draw do
  get "home/top" => "home#top" # GET /home/topというrequestがマッチ
  end
  

• controller
  コントローラと同じ名前のビューフォルダから、アクションと同じ名前のHTMLファイルを探してブラウザに返します。

  class HomeController < ApplicationController
  def top
  end
  end
  

  class A < Bは、クラスAがクラスBを継承している状態。

• views
  *.erbは、HTMLなどの文章の中にRubyスクリプトを埋め込むためのライブラリファイル ```

Home#top

Find me in app/views/home/top.html.erb

### ページの追加（既存のコントローラにアクションを追加する場合）
ルーティングとアクションを追加することで可能
```:routes.rb 
Rails.application.routes.draw do
  get "top" => "home#top"
  get "about" => "home#about"
end

class HomeController < ApplicationController
  def top
  end

  def about
  end
end

ファイルは手動で追加：app/views/home/about.html.erb

ページの追加（既存のコントローラとは別にアクションを追加する場合）

例えば既存のhomeとは別の機能を有するためコントロールを分ける

// 例 rails generate controller posts index

posts：投稿コントローラの意。
index：一覧ページの意。

erb ファイル

erbとは、Embedded Ruby(埋め込みRuby)の略。

Rubyコードの埋め込み方の基本

// Rubyコードの埋め込み（変数の定義）
<% post1 = "XXXXX" %>
<% posts = [
    "XXXXX",
    "YYYYY"
    ]
%>

// Rubyコードをブラウザに表示したい場合（変数の参照）
<%= post1 %>

// each文
<% posts.each do | post | %>
    <p>
        <%= post %>
    </p>
<% end %>

変数をコントローラ内のアクションで定義する

変数を直接ビューに定義するのは一般的ではなく、通常アクションに記載する。 なお、アクションで定義した変数をビューで参照できるようにするには、@をつける。

class PostsController < ApplicationController
  def index
    @posts = [
        "XXXXX",
        "YYYYY"
        ]
  end
end

ビュー側でも@をつけないと参照ができない。

// each文
<% @posts.each do | post | %>
    <p>
        <%= post %>
    </p>
<% end %>

共通レイアウト

個別のビューの記述は、共通HTMLのapplication.html.erbの<%= yield %>の部分に代入されるため、views/layout/application.html.erbにヘッダー部などの共通のHTMLをまとめることができる。

link_toメソッド

ビューでlink_toメソッドを使うと、<a href="{URL"}>{リンクテキスト}</a>に変換される。

<%= link_to("{リンクテキスト}", "{URL}") %>
// 例 <%= link_to("About", "/about") %>

データベース

テーブル作成の準備

まずは、マイグレーションファイルを作成。

rails generate model {テーブル名} {カラム名}:{データ型}
// 例 rails g model Post content:text

generate：gに略すことが可能。 Post：モデル名。postsテーブルを作成する際、単数形にする。 text：長い文字列

作成されるファイル：

• app/db/migrate/YYYYMMDDHHMMSS_create_posts.rb
• app/models/post.rd

データモデルとWebインターフェースを組み合わせてリソースとみなすと、HTTPプロトコル経由で自由に作成/取得/更新/削除できるオブジェクトとみなすことができるようになります。 scaffoldジェネレータでリソースを作成することができます。

rails generate scaffold User name:string email:string
      invoke  active_record
      create    db/migrate/20230108040646_create_users.rb
      create    app/models/user.rb
      invoke    test_unit
      create      test/models/user_test.rb
      create      test/fixtures/users.yml
      invoke  resource_route
       route    resources :users
      invoke  scaffold_controller
      create    app/controllers/users_controller.rb
      invoke    erb
      create      app/views/users
      create      app/views/users/index.html.erb
      create      app/views/users/edit.html.erb
      create      app/views/users/show.html.erb
      create      app/views/users/new.html.erb
      create      app/views/users/_form.html.erb
      create      app/views/users/_user.html.erb
      invoke    resource_route
      invoke    test_unit
      create      test/controllers/users_controller_test.rb
      create      test/system/users_test.rb
      invoke    helper
      create      app/helpers/users_helper.rb
      invoke      test_unit
      invoke    jbuilder
      create      app/views/users/index.json.jbuilder
      create      app/views/users/show.json.jbuilder
      create      app/views/users/_user.json.jbuilder

不要なファイルを作りたくない場合、config/application.rbにg.{invoke} falseで制御可能

データベースに反映

rails db:migrate

ここで作成されるテーブルには定義したカラム以外にid、created_at、updated_atが追加される。

注意

データベースに反映されていないマイグレーションファイルが存在する状態でページアクセスをするとマイグレーションエラーが発生する。

rails console

ターミナルでrails consoleを実行することでRubyのコードを実行できる環境を使える

// console起動
rails console

// Rubyコマンド。定義した変数はconsole終了まで使える
> text = "Hello"
> text + "World"
// 実行結果が表示
=> "HelloWorld"

// console終了
quit

データ保存

controllerにて、{モデル名}.newでモデルのインスタンスを作成して対応するテーブルに保存する。

// インスタンス作成
post = {モデル名}.new(content: "Hello world")

// テーブルに保存
post.save

new、saveは、モデルが継承しているApplicationRecordのメソッド

class {モデル名} < ApplicationRecord
end

データ取得

// 最初のデータ取得
post = {モデル名}.first

// カラムの値を取得
post.{カラム名}

// 全てのデータ取得（配列で取得）
{モデル名}.all

// データの最初のデータの値を取得
{モデル名}.all[0].content

入力制限を行う

modelに以下を記載すると、contentは必須かつ140文字以上でエラーが出るようになります。

class Micropost < ApplicationRecord
    validates :content, length: { maximum: 140 },
                        presence: true
end

モデル同士の関連づけ

一人のユーザが複数のポストを持つ場合

class User < ApplicationRecord
  has_many :microposts
end

class Micropost < ApplicationRecord
  belongs_to :user
end

belongs_toにより関連づけられるのは、user_idですが、これによりMicropostのuser_idは必須項目になります。

Railsコンソールでアプリケーションの状態を調べる

``` rails console

User.first // データベースからuserの一人目を取得 first_user = User.first // データベースからuserの一人目を取得し、変数first_userに格納 first_user.microposts // micropostsの一人目のポストを取得 exit // console終了