A Little Each Day

note to self

Railsでcarrierwaveのファイルサイズをバリデーションする方法

こんにちは。本日はRailsで大人気の画像アップロードGemのCarrierwaveで画像を投稿した際、ファイルのサイズが大きかった場合にバリデーションにかけてエラーメッセージを表示する方法です。

Rails Tutorialではcarrierwaveを使いファイルサイズの制限をする方法が書かれているのですが、もっと簡単にできる(あくまで個人的に)方法があるのでご紹介したいと思います。


carrierwaveのインストール方法は以下を参考にしてください。

blog.otsukasatoshi.com


バージョン

Ruby '2.2.1'
Rails '4.2.1'


lib/file_size_validator.rbの作成

まずはじめにcarrierwaveの画像をバリデーションするために「file_size_validator.rb」というファイルを作成し、lib/以下に配置します。

# lib/file_size_validator.rb

class FileSizeValidator < ActiveModel::EachValidator
  MESSAGES  = { :is => :wrong_size, :minimum => :size_too_small, :maximum => :size_too_big }.freeze
  CHECKS    = { :is => :==, :minimum => :>=, :maximum => :<= }.freeze

  DEFAULT_TOKENIZER = lambda { |value| value.split(//) }
  RESERVED_OPTIONS  = [:minimum, :maximum, :within, :is, :tokenizer, :too_short, :too_long]

  def initialize(options)
    if range = (options.delete(:in) || options.delete(:within))
      raise ArgumentError, ":in and :within must be a Range" unless range.is_a?(Range)
      options[:minimum], options[:maximum] = range.begin, range.end
      options[:maximum] -= 1 if range.exclude_end?
    end

    super
  end

  def check_validity!
    keys = CHECKS.keys & options.keys

    if keys.empty?
      raise ArgumentError, 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
    end

    keys.each do |key|
      value = options[key]

      unless value.is_a?(Integer) && value >= 0
        raise ArgumentError, ":#{key} must be a nonnegative Integer"
      end
    end
  end

  def validate_each(record, attribute, value)
    raise(ArgumentError, "A CarrierWave::Uploader::Base object was expected") unless value.kind_of? CarrierWave::Uploader::Base

    value = (options[:tokenizer] || DEFAULT_TOKENIZER).call(value) if value.kind_of?(String)

    CHECKS.each do |key, validity_check|
      next unless check_value = options[key]

      value ||= [] if key == :maximum

      value_size = value.size
      next if value_size.send(validity_check, check_value)

      errors_options = options.except(*RESERVED_OPTIONS)
      errors_options[:file_size] = help.number_to_human_size check_value

      default_message = options[MESSAGES[key]]
      errors_options[:message] ||= default_message if default_message

      record.errors.add(attribute, MESSAGES[key], errors_options)
    end
  end

  def help
    Helper.instance
  end

  class Helper
    include Singleton
    include ActionView::Helpers::NumberHelper
  end
end

メッセージの国際化

画像を投稿した時にファイルサイズが大きかった場合バリデーションに引っかかるためエラーメッセージが表示されます。

まだバリデーションの実装は終わっていませんが先にエラーメッセージを国際化させましょう。

localesフォルダの中にvalidatorsというファイルを作ります。そしてその中に◯◯.ymlというファイルを作りましょう。今回は日本語に対応するためja.ymlを作ります。

# locales/validators/ja.yml

ja:
  errors:
    messages:
      wrong_size: "のサイズは%{file_size}に設定してください。"
      size_too_small: "のサイズが小さすぎます。(%{file_size}以上に設定してください)"
      size_too_big: "のサイズが大きすぎます。(%{file_size}以下に設定してください)"

application.rbの編集

次にconfig/application.rbでlib以下を読み込むようにするために次のように編集します。

# config/application.rb

   # carrierwaveのファイルサイズのバリデーション
   config.autoload_paths += %W(#{config.root}/lib)

対応するmodelの編集

最後に対応するモデルにバリデーションを書きます。

今回はわかりやすくするため1MB以上の画像を投稿した場合にバリデーションに引っかかるようにします。

もし自分で画像のサイズが決まっているならば、◯の部分を好きな数字に各自変えてください。

# post.rb

# 投稿の際の画像のサイズをバリデーション
  validates :picture, file_size: {maximum: ◯.megabytes.to_i} # 最大◯MBに制限


では実際に投稿してみましょう。

f:id:chi_kun:20160512110033p:plain


きちんと画像のサイズが大きいよ!とバリデーションに引っかかり、エラーメッセージが国際化できていると思います。



本日は以上です。