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

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

前回はcarrierwaveuploader/carrierwave: Classier solution for file uploads for Rails, Sinatra and other Ruby web frameworksの設定をいろいろと行いました。今回は、日本語ファイルの扱いやファイル容量の制限などの設定を確認したいと思います。

日本語名が含まれているファイルについて

CarrierWaveは初期設定では半角英数と一部の記号が含まれたファイル名のみを保存可能となっていて、日本語は利用できません。

実際になんの設定も行わないと、ファイル名は_にサニタイズされます。

>> ps = PictureStore.last
D, [2016-03-31T06:46:01.027709 #68278] DEBUG -- :   PictureStore Load (0.2ms)  SELECT  "picture_stores".* FROM "picture_stores"  ORDER BY "picture_stores"."id" DESC LIMIT 1
#<PictureStore id: 5, store_name: "日本語ファイル名", picture: "_________.png", created_at: "2016-03-30 21:45:12", updated_at: "2016-03-30 21:45:12">

日本語を扱うためには、config/initializerにcarrierwave.rbファイルを作成し利用可能な文字を正規表現で設定します。

CarrierWave::SanitizedFile.sanitize_regexp = /[^[:word:]\.\-\+]/

これにより、日本語を含むファイル名を持つファイルのアップロードでもファイル名が正しく保存されることになります。

>> ps = PictureStore.last
D, [2016-03-31T06:49:57.425693 #68278] DEBUG -- :   PictureStore Load (0.2ms)  SELECT  "picture_stores".* FROM "picture_stores"  ORDER BY "picture_stores"."id" DESC LIMIT 1
#<PictureStore id: 6, store_name: "日本語を含むファイル名", picture: "ビーグルソフト.png", created_at: "2016-03-30 21:49:52", updated_at: "2016-03-30 21:49:52">

ファイルサイズの制限

アップロードするファイルサイズについてValidationを設定することができます。詳細はA cheap knock off of the default validates_length_of validator, but checks the filesize of a Carrierwave attachmentにある内容になりますが、簡単にまとめたいと思います。

※How to: Validate attachment file size · carrierwaveuploader/carrierwave WikiではValidatorとしてmusaffa/file_validators: Adds file validators to ActiveModel.を利用してみてもいいと書いてありますが、あまり活発な開発が行われているわけではないようなのでValidatorをlib配下に保存する方法を利用しました。

ファイルサイズの制限を行う方法は以下の通りとなります。

1. lib/file_size_validator.rbを作成します。
2. config/locales/en.ymlを設定します。
3. application.rbにlib配下を読み込む設定を行います。
4. 該当するファイルのモデルにvalidatorを設定します。

lib/file_size_validator.rbを作成します

以下のとおりlib配下にfile_size_validatorを作成し、validationの内容を記述します。

$ touch 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

config/locales/en.ymlを設定します

エラーメッセージを設定します。日本語も必要ですが、まだ作成していません…。

en:
  errors:
    messages:
      wrong_size: "is the wrong size (should be %{file_size})"
      size_too_small: "is too small (should be at least %{file_size})"
      size_too_big: "is too big (should be at most %{file_size})"

application.rbにlib配下を読み込む設定を行います

そのままではfile_size_validator.rbを読み込まないため以下の設定をapplicatrion.rbに追加します。

require File.expand_path('../boot', __FILE__)

require "rails"
# Pick the frameworks you want:
require "active_model/railtie"
require "active_job/railtie"
require "active_record/railtie"
require "action_controller/railtie"
require "action_mailer/railtie"
require "action_view/railtie"
require "sprockets/railtie"
# require "rails/test_unit/railtie"

# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

module CarrierWave
  class Application < Rails::Application
    # Settings in config/environments/* take precedence over those specified here.
    # Application configuration should go into files in config/initializers
    # -- all .rb files in that directory are automatically loaded.

    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
    # config.time_zone = 'Central Time (US & Canada)'

    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
    # config.i18n.default_locale = :de

    # Do not swallow errors in after_commit/after_rollback callbacks.
    config.active_record.raise_in_transactional_callbacks = true

    # lib配下のパスを読み込む << ここを追加
    config.autoload_paths += %W(#{config.root}/lib)

  end
end

該当するファイルのモデルにvalidatorを設定します

最後に作成したvalidatorをモデルに設定します。

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

  validates :picture,
            :file_size => {
                :maximum => 1.megabytes.to_i
            }
end

これで、動作するとエラーとなることが確認できました。

ファイルを作成する方法

今回は1MBをファイルの上限としているので、2MBのファイルを作成しました。

$ mkfile 2m test.txt
$ ll | grep test
-rw-------   1 ymanabe  staff   2.0M  4  2 07:12 test.txt

ソースコード

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

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