Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miolab/ruby_rails_memo
[Cheat sheet] Ruby / Rails/ gem / and more
https://github.com/miolab/ruby_rails_memo
Last synced: about 2 months ago
JSON representation
[Cheat sheet] Ruby / Rails/ gem / and more
- Host: GitHub
- URL: https://github.com/miolab/ruby_rails_memo
- Owner: miolab
- Created: 2020-05-19T10:31:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T19:26:56.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T22:17:20.668Z (almost 2 years ago)
- Language: Ruby
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ruby / Ruby on Rails メモ
## 概要
- __Ruby__ および __Ruby on Rails__ 開発に関する覚え書きを、メモとして残していきます。
| | 説明 | 備考 |
| :-- | :-- | :-- |
| [ruby_notes/](https://github.com/miolab/ruby_rails_memo/tree/master/ruby_notes) | Ruby本体のメソッドや作法などのmdメモやrbファイルなど置き場 | |
| [rails_notes/](https://github.com/miolab/ruby_rails_memo/tree/master/rails_notes) | 整理中 | |
- 実行環境
- macOS (10.14.6)
- VSCode
- Ruby (2.7.1)
- Rails (5 / 6)
- rbenv (1.1.2)
- gem (3.1.2)
---
## 参考
- [Ruby org](https://www.ruby-lang.org/ja/)
- [RubyGems](https://rubygems.org/)
- [ruby-style-guide](https://github.com/rubocop-hq/ruby-style-guide)
- [日本語版](https://github.com/fortissimo1997/ruby-style-guide/blob/japanese/README.ja.md)
---
## 開発環境構築
- __rbenv__ （[GitHub](https://github.com/rbenv/rbenv)）
インストール
```terminal
$ brew install rbenv
$ rbenv init
```
- メッセージ中の `eval "$(rbenv init -)”` を、`$ vim ~/.bash_profile` で追記要。
- ターミナル再起動しておく。
セットアップ結果確認
```terminal
$ curl -fsSL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-doctor | bash
Checking for `rbenv' in PATH: /usr/local/bin/rbenv
Checking for rbenv shims in PATH: OK
Checking `rbenv install' support: /usr/local/bin/rbenv-install (ruby-build 20200520)
Counting installed Ruby versions: none
There aren't any Ruby versions installed under `/Users/im/.rbenv/versions'.
You can install Ruby versions like so: rbenv install 2.2.4
Checking RubyGems settings: OK
Auditing installed plugins: OK
```
- __Ruby__ 本体
インストールできるバージョン確認
```terminal
$ rbenv install -l
2.5.8
2.6.6
2.7.1
.
.
```
インストール & 使用バージョン指定
```terminal
$ rbenv install 2.7.1
$ rbenv rehash
$rbenv versions
// 環境内にあるバージョン確認
$rbenv global 2.7.1
// 使用バージョンを指定する
$ ruby -v
// 使用バージョン確認
```
---
# [WIP] :closed_book: Ruby on Rails
## 概要
- 理念
- 設定より規約（Convention over Configuration）
- 命名規約における複数形など
- DRY原則
- MVC
| | 説明 |
| :-- | :-- |
| View | 画面の描画 |
| Model | データ関連の処理 |
| Controller | 制御（ModelとViewとの橋渡し） |
- 参考
- [Ruby on Rails ガイド](https://railsguides.jp/)
- [Ruby on Rails Guides](https://guides.rubyonrails.org/)
- [Ruby on Rails Org](https://rubyonrails.org/)
## セッティング
- インストール
所望のディレクトリ配下にいる状態で、
```ruby
$ gem install rails
```
- バージョン指定する場合は以下。（例：5系）
```ruby
$ gem install rails -v 5.2.1 -N
```
`-N`: ドキュメントを省略し、DL時間を短縮する
- セットアップ
```ruby
$ rails new project_name
```
- 上記は最新版Railsをセットアップ。
- 明示的にバージョン指定する場合は以下。（例：5系）
```ruby
$ rails _5.2.1_ new project_name
```
- 確認
```terminal
$ rails -v
Rails 5.2.4.3
```
ディレクトリ移動
```terminal
$ cd project_name
```
- `Gemfile` 書き換え
```ruby
.
.
# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
gem 'rails', '5.2.4.3' --> change
# Use sqlite3 as the database for Active Record
gem 'sqlite3', '~> 1.3.6' --> change
.
.
```
アップデート
```ruby
$ bundle update
```
データベース作成
```ruby
$ rails db:create
```
- ブラウザで確認
```ruby
$ rails s
```
- [`http://localhost:3000/`](http://localhost:3000/) 起動
## Controller 作成
最低限 `Controller` があれば、ハローワールドはできる。
- Controller 用意
```ruby
$ rails g controller users index
```
- `rails g（generate） controller コントローラー名（複数形を推奨） コントローラークラス内に定義するメソッド名（=アクション）`
- `hello > app > controllers > concerns > users_controller.rb` を編集
```ruby
class UsersController < ApplicationController
def index
render plain: "Hello, im." --> add
end
end
```
- plain = __平文のテキスト__
- `$ rails s` でブラウザ起動し、結果確認
[http://localhost:3000/users/index](http://localhost:3000/users/index)
## Routing 設定
- `routes` 確認
__URL__ と __action__ の _対応表_ みたいなもの
（何が何を呼ぶか、を確認する）
```ruby
$ rails routes
.
.
Prefix Verb URI Pattern Controller#Action
users_index GET /users/index(.:format) users#index
rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show
rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show
rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show
update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update
rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create
```
- `$ rake routes` でも可（`$ rails routes` と同じ）
- `routes` の書き換え
`hello > config > routes.rb`
```ruby
Rails.application.routes.draw do
# get 'users/index' --> comment out
get 'users', to: 'users#index' --> add
```
- 上記 `routes` 設定により、[http://localhost:3000/users/](http://localhost:3000/users/) で _.../users/index_ を読み込めるようにした
- `get 'users/index'` と `get 'users/index', to: 'users#index'` は同じ意味になる
- 設定変更後の `routes` を確認
```ruby
$ rake routes
.
.
Prefix Verb URI Pattern Controller#Action
users GET /users(.:format) users#index
rails_service_blob GET /rails/active_storage/blobs/:signed_id/*filename(.:format) active_storage/blobs#show
rails_blob_representation GET /rails/active_storage/representations/:signed_blob_id/:variation_key/*filename(.:format) active_storage/representations#show
rails_disk_service GET /rails/active_storage/disk/:encoded_key/*filename(.:format) active_storage/disk#show
update_rails_disk_service PUT /rails/active_storage/disk/:encoded_token(.:format) active_storage/disk#update
rails_direct_uploads POST /rails/active_storage/direct_uploads(.:format) active_storage/direct_uploads#create
```
`$ rails s` して、[http://localhost:3000/users/](http://localhost:3000/users/) でブラウザ確認。
## View 設定
- __ERB__
- Embedded RuBy（埋め込みRuby）
- __テンプレートエンジン__。PythonでいうJinjaみたいなもの。
- 他のRailsテンプレートエンジンとして、_slim_ などがある
### 実装
- `app > controllers > users_controller.rb`
```ruby
class UsersController < ApplicationController
def index
# render plain: "Hello,im!!" --> delete
end
end
```
- `hello > app > views > users > index.html.erb`
（規約） __`app > views > コントローラー名 > アクション名.html.erb`__
```html
<%#
Users#index
--> comment out
Find me in app/views/users/index.html.erb
%> --> delete
Hello, im view!
<%= 10 + 1 %>
```
- `<%= .... %>` は、Rubyコードの埋め込み記法。
- __%__ に __=__ を付けたら画面表示させる。（ __=__ 付けないのは、`if` など処理系を使うとき）
- 確認（[http://localhost:3000/users/index](http://localhost:3000/users/index)）
### （リファクタリング）__`Controller` でロジックを書いて `View`__ に渡す
- `app > controllers > users_controller.rb`
```ruby
class UsersController < ApplicationController
def index
@num = 1 + 2 # --> add
end
end
```
- `@hoge` は、__インスタンス変数__。
- クラスのインスタンス前に保持される変数
- __Viewから参照ができる（Viewに渡せる）__
- __@__ 付けないと、name errorになる
- `hello > app > views > users > index.html.erb`
```html
Hello, im view!
<%= @num %>
```
.
.
.
---
---
# （補記）AWS `Cloud9` による開発環境構築
- 実行環境
- Ruby 2.5 / 2.6
- Rails 5 / 6
- RVM 2.5
- AWS Cloud9
- EC2 (Amazon Linux / t2.micro)
## `Cloud9`と`GitHub`の連携
- HTTPSで連携。
- 手元PCローカルリポジトリ→リモートリポジトリと同じ感覚で、
Cloud9ローカルリポジトリ→リモートリポジトリ連携が可。
（`git init` から）