• Home
• コーポレートブログ
• redmica_s3プラグインをアップデート、CSVインポート時の文字コード自動選択に対応

原田です。今回はredmica_s3プラグインをアップデートしたことについてお話しします。

今回のアップデートはお客様からのお問い合わせがきっかけでした

弊社ではプロジェクト管理サービスMy Redmineをお客様にご利用頂いております。

お客様より、チケットのCSVインポート時のエンコーディングがCP932になっているが、初期表示をUTF-8にすることは可能かといったお問い合わせがありました。

このお問い合わせから弊社前田がRedmine公式サイトにパッチを投稿し、Redmine 6.0.0に取り込まれました。

この変更はRedMica 3.1.0にも取り込まれました。

参考: RedMica 3.1.0 Changelog

redmica_s3プラグインをアップデートします

Redmine（RedMica）はアップデートされましたが、redmica_s3プラグインにはこの変更が反映されていないのでアップデートする必要があります。

redmica_s3とは

redmica_s3はRedmine（RedMica）の機能を改善したプラグインです。

• Redmineはfilesディレクトリにファイルを保存しますが、redmica_s3ではAmazon Simple Storage Service（S3）にS3オブジェクトで保存します。
• ファイルに対して実施していた処理をS3オブジェクトに対して実施します。
  • ファイルアップロード、ダウンロード
  • サムネイル出力
  • CSVインポート

変更箇所の洗い出し

redmica_s3はRedmineのクラス／モジュールの一部（メソッド）をオーバーライドしています。

• app/controllers/attachments_controller.rb
• app/models/attachment.rb
• app/models/import.rb
• lib/redmine/thumbnail.rb
• lib/redmine/utils.rb
• lib/redmine/export/pdf.rb

Redmine自体の変更は公式Subversionリポジトリで管理されています。ただしコミットログが追いづらいので、 このSubversionリポジトリをミラーリングしたGitHubリポジトリのコミットログ（9a10469以前）を参考にして変更箇所を洗い出しました。

上記6ファイルのログを調べた結果、主に今回お問い合わせのあった機能（CSVインポート）に関する変更がredmica_s3に組み込まれていないことが判明しました。

• Patch #35217: Replace use of Digest::MD5 / Digest::SHA1 with ActiveSupport::Digest
• Feature #34718: Auto guess file encoding when importing CSV file
• Feature #39511: Auto-detection of field wrapper type when importing CSV file
• Defect #41464: CSV file encoding auto-detection may fail with multibyte characters

変更箇所の取り込み自体は問題なく行えました

上記RedmineのチケットとGitHubのコミットログの内容から変更箇所は特定できましたので、この変更箇所をAWS S3用の処理に置き換えました。詳細はredmica_s3のプルリクエスト#41をご覧ください。

コミットログは定期的に確認したい

当初私はクラスやモジュールをファイル単位でどのような変更がされているのかまで追跡していませんでした（都度スポット的な対応で解決していた）。 Redmineの機能の一部をAWS S3用にオーバーライドしているredmica_s3ではRedmine（RedMica）のバージョンアップによって動作しなくなることもあり得ますので、定期的（6か月ごと）に（上記6本の）コミットログを確認しようと思いました。

【スタッフ募集中】
「My Redmine」など弊社提供サービスのお問い合わせ対応を担当するカスタマーサポートスタッフを募集しています。
弊社での勤務に関心をお持ちの方は、知り合いの弊社社員・関係者を通じてご連絡ください。採用情報の詳細

---