読者です 読者をやめる 読者になる 読者になる

CarrierWaveを利用した画像ファイルのアップロード

Rails CarrierWave

こんにちは。beaglesoftの真鍋です。

2016/04/04追記

手順にGemfileへcarrier_waveへの依存関係設定が記載されていなかったので追加しました。

RailsはいろいろなGemを組み合わせることで機動力のあるアプリケーションの開発ができますよね。本当にいろいろなGemが開発されています。今回は、ファイルのアップロードを行うためにcarrierwaveuploader/carrierwave: Classier solution for file uploads for Rails, Sinatra and other Ruby web frameworksを利用したいと思います。

CarrierWaveとは

ファイルのアップロードを粋に行うことができるGemで、とても簡単にファイルのアップロードを実現できます。

プロジェクトの目的について

このプロジェクトでは PictureStore のScaffoldを作成し以下の機能が実現できることを確認します。

  1. 新規登録時に画像ファイルをアップロードしてデータベースに保存する。
  2. 詳細表示でアップロードした画像ファイルを表示する。

もちろん、CarrierWaveにはいろいろな設定があるのですがとりあえずはお試しということでファイルのアップロードが実現できることを確認します。

作成手順

以下の手順でサンプルを作成しました。

  1. Gemにcarrier_waveを追加する。
  2. PictureStoreのscaffoldを作成する。
  3. CarrierWaveのUploaderクラスを生成する。
  4. Viewに設定を追加する。

1. carrier_waveを追加する

Gemfileに以下の通りcarrier_waveを追加します。

gem 'carrierwave'

2.PictureStoreのscaffoldを作成する。

store_namepictureを列に持つモデルについてscaffoldを生成します。

$ rails g scaffold picture_store store_name:string picture:string
Running via Spring preloader in process 38468
      invoke  active_record
      create    db/migrate/20160330120340_create_picture_stores.rb
      create    app/models/picture_store.rb
      invoke  resource_route
       route    resources :picture_stores
      invoke  scaffold_controller
      create    app/controllers/picture_stores_controller.rb
      invoke    erb
      create      app/views/picture_stores
      create      app/views/picture_stores/index.html.erb
      create      app/views/picture_stores/edit.html.erb
      create      app/views/picture_stores/show.html.erb
      create      app/views/picture_stores/new.html.erb
      create      app/views/picture_stores/_form.html.erb
      invoke    helper
      create      app/helpers/picture_stores_helper.rb
      invoke    jbuilder
      create      app/views/picture_stores/index.json.jbuilder
      create      app/views/picture_stores/show.json.jbuilder
      invoke  assets
      invoke    coffee
      create      app/assets/javascripts/picture_stores.coffee
      invoke    scss
      create      app/assets/stylesheets/picture_stores.scss
      invoke  scss
   identical    app/assets/stylesheets/scaffolds.scss

3.CarrierWaveのUploaderクラスを生成しモデルに設定する

CarrierWaveのUploaderクラスを生成します。この時、生成するUploaderクラスは対象となるモデルの列名と一致するようにします。

$ rails g uploader picture
Running via Spring preloader in process 38544
      create  app/uploaders/picture_uploader.rb

次に、生成したuploaderをモデルで利用できるように設定します。

class PictureStore < ActiveRecord::Base
  mount_uploader :picture, PictureUploader
end

4.Viewに設定を追加する。

Viewの_form.html.erbを以下の通り変更し、画像ファイルをアップロードできるようにします。

<%= form_for(@picture_store) do |f| %>
  <% if @picture_store.errors.any? %>
    <div id="error_explanation">
      <h2><%= pluralize(@picture_store.errors.count, "error") %> prohibited this picture_store from being saved:</h2>

      <ul>
      <% @picture_store.errors.full_messages.each do |message| %>
        <li><%= message %></li>
      <% end %>
      </ul>
    </div>
  <% end %>

  <div class="field">
    <%= f.label :store_name %><br>
    <%= f.text_field :store_name %>
  </div>
  <div class="field">
    <%= f.label :picture %><br>
    <%= f.file_field :picture %>
    <%= f.hidden_field :picture_cache %>
  </div>
  <div class="actions">
    <%= f.submit %>
  </div>
<% end %>

次に、登録された画像を表示するため以下のとおりshow.html.erbを修正します。

<p>
  <strong>Picture:</strong>
  <%= image_tag @picture_store.picture.url %>
</p>

動作のイメージ

このように簡単にプロジェクトを作成してGemの設定を行ったわけですが、このようにファイル(今回は画像ファイル)をアップロードして表示できるようになりました。

carrier_wave_demo.gif (167.0 kB)

ソースコード

ソースコードはGithubにあります。参考に利用してください。

beaglesoftjp/CarrierWaveExample: CarrierWaveを利用したファイルのアップロードを行うサンプルです。