※毎回書いたほうがいい気がするので書いておきます※ 平文の部分をちょこちょこI18nで日本語化しているのですが その部分に関しては特に記述していなくてもたまにコードが違ったりしています。 t(‘.hogehoge’)って部分です どうぞお気になさらず。
13.4 マイクロポストの画像投稿
マイクロポストの基本的な操作は実装できたが 応用として画像付きのマイクロポストを投稿できるようにしていく。
開発環境用のβ版を実装 ↓ 改善 ↓ 本番環境用の完成版を実装
.gitignoreの編集
開発環境でアップロードされた画像がgitにpushされないように.gitignoreを編集しておく （本文では最後の方に出てくるけど、途中でもコミットするのであれば設定しておく🐫）
. . . # アップロードされたテスト画像を無視する /public/uploads
※隠しファイルになっているので注意
画像アップロード機能を追加するために
アップロードするためのフォームと投稿された画像本体が必要！ [Upload image] ボタンと画像付きマイクロポストの見本はRoRT本文参照
13.4.1 基本的な画像アップロード
CarrierWaveという画像アップローダーを使って実装していく
まずはcarrierwave gemをGemfileに追加しましょう (リスト 13.58)15 。このとき、リスト 13.58ではmini_magick gemとfog gemsも含めている点に注目してください。これらのgemは画像をリサイズしたり (13.4.3)、本番環境で画像をアップロードする (13.4.4) ために使います。
source 'https://rubygems.org' gem 'rails', '5.1.6' gem 'bcrypt', '3.1.12' gem 'faker', '1.7.3' gem 'carrierwave', '1.2.2' gem 'mini_magick', '4.7.0' gem 'will_paginate', '3.1.5' gem 'bootstrap-will_paginate', '1.0.0' . . . group :production do gem 'pg', '0.20.0' gem 'fog', '1.42' end . . .
そして
$ bundle install
CarrierWaveを導入すると、Railsのジェネレーターで画像のアップローダーが生成できるようになる。 スゴイ！
# Pictureという名前の画像アップローダーを作る $ rails generate uploader Picture
Active Recordモデルの属性と関連付け
CarrierWaveでアップロードされた画像はActive Recordモデルの属性と関連付けされているべき！ →関連付けされる属性には画像のファイル名が格納される→ファイル名なので型はString型にしておく
picture属性を追加したマイクロポストのデータモデルはこちらの→RoRT本文 picture属性をMicropostモデルに追加する
# マイグレーションファイルを生成 $ rails generate migration add_picture_to_microposts picture:string # 開発環境のDBに適用 $ rails db:migrate
CarrierWaveに画像と関連付けたモデルを伝えるためには、mount_uploaderというメソッドを使います。このメソッドは、引数に属性名のシンボルと生成されたアップローダーのクラス名を取ります。
Micropostモデルにアップローダーを追加
class Micropost < ApplicationRecord
# MicropostとそのUserは belongs_to (1対1) の関係性がある
belongs_to :user
# default_scope（順序を指定するメソッド） created_at:を降順にする
default_scope -> { order(created_at: :desc) }
# mount_uploader（CarrierWaveへ画像と関連付けたモデルを伝えるメソッド）画像のファイル名の格納先の属性名、,アップローダーのクラス名
mount_uploader :picture, PictureUploader
# user_idが存在する
validates :user_id, presence: true
# contentが存在する 長さは最大140文字
validates :content, presence: true, length: { maximum: 140 }
end
アップローダーのクラス名は自動生成されたpicture_uploader.rbで定義されている
class PictureUploader < CarrierWave::Uploader::Base # Include RMagick or MiniMagick support: # include CarrierWave::RMagick # include CarrierWave::MiniMagick ・ ・ ・
viewにアップローダーを追加
Homeページにアップローダーを追加→_micropost_form.html.erbを編集
<%= form_for(@micropost) do |f| %> <%= render 'shared/error_messages', object: f.object %><%= f.text_area :content, placeholder: t('.content_msg') %><%= f.submit t('.post_btn'), class: "btn btn-primary" %> <%= f.file_field :picture %> <% end %>
また、Webから更新できる許可リストにpicture属性を追加する
・
・
・
private
def micropost_params
# micropost属性必須 content属性:pictureと属性のみ変更を許可
params.require(:micropost).permit(:content, :picture)
end
・
・
・
アップロードされた画像を表示できるようにする
一度画像がアップロードされれば、Micropostパーシャルのimage_tagヘルパーでその画像を描画できるようになります (リスト 13.62)。また、画像の無い (テキストのみの) マイクロポストでは画像を表示させないようにするために、picture?という論理値を返すメソッドを使っている点に注目してください。
「picture?」は画像用の属性名に応じて（今回はpicture）CarrierWaveが自動的に生成してくれます
image_tagヘルパーとは何ぞ
image_tagヘルパーは画像を表示するためのヘルパーメソッドHTML imgタグを返します。画像へのフルパス、またはapp/assets/imagesディレクトリ内にあるファイルを引数として与えられます。[blogcard url="https://railsguides.jp/action_view_overview.html#image-tag"] [blogcard url="https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-image_tag"] image_tag micropost.picture.url →生成されるHTML→
演習
1. 動作確認のみにて省略 2. ※本文と若干違う部分があるけど手元のコード重視で
- 画像付きのマイクロポストを投稿してみましょう。もしかして、大きすぎる画像が表示されてしまいましたか? (心配しないでください、次の13.4.3でこの問題を直します)。
- リスト 13.63に示すテンプレートを参考に、13.4で実装した画像アップローダーをテストしてください。テストの準備として、まずはサンプル画像をfixtureディレクトリに追加してください (コマンド例: cp app/assets/images/rails.png test/fixtures/)。リスト 13.63で追加したテストでは、Homeページにあるファイルアップロードと、投稿に成功した時に画像が表示されているかどうかをチェックしています。なお、テスト内にあるfixture_file_uploadというメソッドは、fixtureで定義されたファイルをアップロードする特別なメソッドです18 。ヒント: picture属性が有効かどうかを確かめるときは、11.3.3で紹介したassignsメソッドを使ってください。このメソッドを使うと、投稿に成功した後にcreateアクション内のマイクロポストにアクセスするようになります。
・
・
・
test "micropost interface" do
# @userでログイン
log_in_as(@user)
# root_pathにgetのリクエスト
get root_path
# 特定のHTMLタグが存在する→ class = "pagination"を持つdiv
assert_select 'div.pagination'
# 特定のHTMLタグが存在する→ type="file"を持つinput
assert_select 'input[type="file"]'
# ブロックで渡されたものを呼び出す前後でMicropost.countに違いがない
assert_no_difference 'Micropost.count' do
# microposts_pathにpostのリクエスト → micropost: { content: "" }（無効なデータ）
post microposts_path, params: { micropost: { content: "" } }
end
# 特定のHTMLタグが存在する→ id = "error_explanation"を持つdiv
assert_select 'div#error_explanation'
# contentに代入 → "This micropost really ties the room together"
content = "This micropost really ties the room together"
# pictureに代入→ fixtureで定義されたファイルをアップロードするメソッド（パス, タイプ）
picture = fixture_file_upload('test/fixtures/rails.png', 'image/png')
# ブロックで渡されたものを呼び出す前後でMicropost.countが+1
assert_difference 'Micropost.count', 1 do
# microposts_pathにpostのリクエスト → micropost: { content: content, picture: picture }（有効なデータ）
post microposts_path, params: { micropost:
{ content: content,
picture: picture } }
end
# @micropostにpictureが含まれる
assert assigns(:micropost).picture?
# root_urlにリダイレクト
assert_redirected_to root_url
# 指定されたリダイレクト先に移動
follow_redirect!
・
・
・
13.4.2 画像の検証
現状では画像サイズに対する制限がないので大きな画像も上げ放題！ また、フォーマットの指定もしていないので 大きなサイズや謎のファイルも上げ放題で危ない！ ので、バリデーションを設定する→サーバー用とクライアント用両方に追加する！！有効な画像の種類を制限
生成されたアップローダーの中にコメントアウトされたコードがありますが、ここのコメントアウトを取り消すことで、画像のファイル名から有効な拡張子 (PNG/GIF/JPEGなど) を検証することができます本文だとstore_dirメソッドのすぐ下にある感じだけど 🐫の環境では36行目～でした
・
・
・
# Add a white list of extensions which are allowed to be uploaded.
# For images you might use something like this:
def extension_whitelist
%w(jpg jpeg gif png)
end
・
・
・
画像サイズの制御
Micropostモデルに定義していく 画像サイズに関するバリデーションはpresenceやlengthなどと違ってRailsの既存オプションにはないので 手動で「picture_size」という独自のバリデーションを定義していくclass Micropost < ApplicationRecord
・
・
・
# 独自のバリデーションを定義するためvalidatesではなくvalidateメソッドを使っている
# 引数にシンボルを取り、シンボル名に対応したメソッド（picture_size）を呼び出す
validate :picture_size
private
# アップロードされた画像のサイズをバリデーションする
def picture_size
if picture.size > 5.megabytes
errors.add(:picture, "should be less than 5MB")
end
end
end
バリデーションをViewに組み込む
<%= form_for(@micropost) do |f| %> <%= render 'shared/error_messages', object: f.object %>上記の10行目acceptパラメーターは、送信できる（app/uploaders/picture_uploader.rbで許可した）ファイル形式をMIMEタイプで指定している<%= f.text_area :content, placeholder: t('.content_msg') %><%= f.submit t('.post_btn'), class: "btn btn-primary" %> <%= f.file_field :picture, accept: 'image/jpeg,image/gif,image/png' %> <% end %>
MIMEタイプとは何ぞ
[blogcard url="https://ja.wikipedia.org/wiki/Multipurpose_Internet_Mail_Extensions#Content-Type"] 大分類/詳細な形式 →image/png（imageファイル/png形式）、text/html（textファイル/html形式）とかアラート用のjQueryのコード
ただしこのコードでは規定サイズ以上のファイルのアップロードは阻止できない →メッセージを無視してアップロードを強行することも可能本書はRailsチュートリアルなので、今回は「リスト 13.66のようなコードでは実装はまだ不完全である」という点だけ覚えておけば十分です。今回Micropostモデルで設定したように、サーバー側でのバリデーションが重要！
演習
- 5MB以上の画像ファイルを送信しようとした場合、どうなりますか?
- 無効な拡張子のファイルを送信しようとした場合、どうなりますか? 13.4.3
-
- ファイル選択時Maximum file size is 5MB. Please choose a smaller file.のダイアログが出る
- 気にせず投稿ボタンを押すとバリデーションエラーでメッセージが出る
-
- そもそも投稿ファイルは指定の拡張子から選ぶようになってるので無効な拡張子を選ぶことはなかなかない
- 「すべてのファイル」から選んで送信ボタンを押すとバリデーションエラーでメッセージが出る
13.4.3 画像のリサイズ
ファイルサイズに対するバリデーションを設定したけど画像サイズ（縦横の長さ）に対する制限がないので （縦横のサイズ的に）大きすぎる画像がアップロードされるとレイアウトが崩れてイヤンな気持ちになる →適切なサイズにリサイズする他の解決策としてCSSで表示サイズを調整する方法もありますが、これだとファイルサイズが変わりません。結果として、ファイルサイズの大きな画像によって、読み込み時間が長くなるといった問題が発生します。
画像をリサイズするプログラムを導入
ImageMagickというプログラムを使うので、これを開発環境にインストールする ※環境によって手順が異なる！（ググろう）※Herokuではもともと導入されている クラウドIDEでは下記$ sudo yum install -y ImageMagick
次に、MiniMagickというImageMagickとRubyを繋ぐgemを使って、画像をリサイズしてみましょう。今回は最大幅を400pxに定める→縦横どちらかが400pxを超えていた場合に適切にリサイズ
class PictureUploader < CarrierWave::Uploader::Base # Include RMagick or MiniMagick support: # include CarrierWave::RMagick # ↓この行のコメントアウトを外す include CarrierWave::MiniMagick # 縦横どちらかが400pxを超えていた場合、適切なサイズに縮小するオプション process resize_to_limit: [400, 400] ・ ・ ・
演習
- 解像度の高い画像をアップロードし、リサイズされているかどうか確認してみましょう。画像が長方形だった場合、リサイズはうまく行われているでしょうか?
- 既にリスト 13.63のテストを追加していた場合、この時点でテストスイートを走らせると紛らわしいエラーメッセージが表示されることがあります。このエラーを取り除いてみましょう。ヒント: リスト 13.68にある設定ファイルを修正し、テスト時はCarrierWaveに画像のリサイズをさせないようにしてみましょう。
- 縦横比を保ったままリサイズされる
- エラーにならなかったのでわかりません🤔
13.4.4 本番環境での画像アップロード
13.4.3で実装した画像アップローダーは、開発環境で動かす分には問題ないのですが、本番環境には適していません。これはリスト 13.67のstorage :fileという行によって、ローカルのファイルシステムに画像を保存するようになっているからですなので、本番環境でも使えるようにする →本番環境ではクラウドストレージサービスに画像を保存→13.4.1で導入したfog gemを使うと簡単！
class PictureUploader < CarrierWave::Uploader::Base
# Include RMagick or MiniMagick support:
# include CarrierWave::RMagick
# ↓この行のコメントアウトを外す
include CarrierWave::MiniMagick
# 縦横どちらかが400pxを超えていた場合、適切なサイズに縮小するオプション
process resize_to_limit: [400, 400]
# 本番環境かそれ以外かで保存先を切り替え
if Rails.env.production?
storage :fog
else
storage :file
end
・
・
・
環境のセッティング
RoRT本文に則ってAWSで色々する /sample_app/config/initializers/carrier_wave.rbを作って（本来はファイルがあるものっぽい？）S3用に定義if Rails.env.production?
CarrierWave.configure do |config|
config.fog_credentials = {
# Amazon S3用の設定
:provider => 'AWS',
:region => ENV['S3_REGION'], # 例: 'ap-northeast-1'
:aws_access_key_id => ENV['S3_ACCESS_KEY'],
:aws_secret_access_key => ENV['S3_SECRET_KEY']
}
config.fog_directory = ENV['S3_BUCKET']
end
end
環境変数を設定
$ heroku config:set S3_ACCESS_KEY="ココに先ほどメモしたAccessキーを入力" $ heroku config:set S3_SECRET_KEY="同様に、Secretキーを入力" $ heroku config:set S3_BUCKET="Bucketの名前を入力" $ heroku config:set S3_REGION="Regionの名前を入力"いつものようにテストしてaddしてcommitしてpushしてぎとはぶでプルリクしてマージして戻ってきてpullる そしてHerokuへデプロイる
$ git push heroku $ heroku pg:reset DATABASE $ heroku run rails db:migrate $ heroku run rails db:seed
演習
- 本番環境で解像度の高い画像をアップロードし、適切にリサイズされているか確認してみましょう。長方形の画像であっても、適切にリサイズされていますか?
- される！