メインコンテンツへスキップ
見出し画像

【IT】Rails導入から最小CRUDまで(3)〜ズレを直す ― 正規化+bytes検証+DB保険

    皆さん、こんにちは
    前回に引き続き、
    Rails思い出し講座の第3回です。

    前回の記事



    ― UIもCSVも“同じルール”で動かす3段構え

    前回は「CSVから登録したときだけ制限を超える」原因を探りました。
    今回は、その“ズレ”を実際に直す側の実装です。


    🧭 ゴール

    • UI・CSVどちらから登録しても同じ入力結果になる

    • “文字数(chars)ではなくバイト数(bytes)”基準で制御する

    • DB側にもCHECK制約を設けて「最終防衛線」を張る


    画像

    2️⃣ 入力の正規化(Normalizer)

    まずは共通のクレンジング処理を用意します。

    `app/services/normalizer.rb`

    # app/services/normalizer.rb
    module Normalizer
      # ゼロ幅スペースやBOMなどの不可視文字
      ZW = /\u200B|\u200C|\u200D|\uFEFF/
    
      def self.clean(s)
        s = s.to_s
        s = s.gsub(ZW, "")       # ゼロ幅除去
        s = s.delete("\r")       # CRを除去(改行統一)
        s = s.gsub(/\n+/, "\n")  # 改行を1個に
        s = s.strip              # 前後の空白除去
        s.unicode_normalize(:nfc)# 合成文字の表記ゆれ統一
      end
    end

    ✅ 目的

    * UIでもCSVでも同じ整形処理を通すこと。
    * “Unicode正規化”は濁点・半濁点の別文字化を防げる。


    3️⃣ CSV側にNormalizerを適用

    `app/services/csv_importer.rb` のループ内を差し替え:

    require "csv"
    
    class CsvImporter
      def self.import!(io, fast: false)
        csv = CSV.new(io, headers: true, return_headers: false, encoding: "bom|utf-8")
    
        csv.each do |row|
          # 正規化
          value = Normalizer.clean(row["introduce"])
    
          Rails.logger.info(
            event:  "csv_precheck",
            chars:  value.length,
            bytes:  value.bytesize,
            sample: value[0, 40]
          )
    
          shop = Shop.new(
            name:      row["name"],
            introduce: value,
            enabled:   row["enabled"].to_s == "true"
          )
    
          fast ? Shop.insert_all!([shop.attributes.except("id", "created_at", "updated_at")]) : shop.save!
        end
      end
    end

    `Normalizer.clean` を1行挟むだけで、
    不可視文字を取り除いた上でchars/bytesが一致します。


    4️⃣ UI側(フォーム送信)にも適用

    `app/controllers/shops_controller.rb`

    def shop_params
      sp = params.require(:shop).permit(:name, :introduce, :enabled)
      sp[:introduce] = Normalizer.clean(sp[:introduce])
      sp
    end

    これでCSV経由も画面経由も同じ“入口関数”を通るようになります。


    5️⃣ bytes単位のバリデーション

    `app/models/shop.rb`

    class Shop < ApplicationRecord
      MAX_BYTES = 255
    
      validates :name, presence: true, length: { maximum: 50 }
      validate  :introduce_bytes_limit
    
      private
    
      def introduce_bytes_limit
        s = Normalizer.clean(introduce)
        if s.bytesize > MAX_BYTES
          errors.add(:introduce, "は#{MAX_BYTES}バイト以内で入力してください(現在#{s.bytesize}バイト)")
        end
      end
    end

    ✅ ポイント
    * 文字数ではなくバイト数を基準に。
    * 実際のDB制約(PostgreSQLの`varchar`長など)に一致させ*のが安全。
     * エラーメッセージで何バイト超過しているかを出すとユーザーにも親切。


    6️⃣ DBの“保険”:CHECK制約

    どんなにアプリで制御しても、
    `insert_all` やバッチ処理などではvalidationがスキップされることがあります。
    その最終防衛として、DBにも上限を持たせます。

    マイグレーションを作成

    bin/rails g migration add_shop_introduce_check

    内容編集

    `db/migrate/xxxx_add_shop_introduce_check.rb`

    class AddShopIntroduceCheck < ActiveRecord::Migration[8.0]
      def change
        add_check_constraint :shops, "char_length(introduce) <= 255", name: "shops_introduce_len_chk"
      end
    end

    実行

    bin/rails db:migrate

    DB制約は「最終防衛線」。
    insert_all でもこれを超えたらDBが拒否してくれます。


    7️⃣ 動作確認

    1️⃣ サーバ再起動

    bin/rails s

    2️⃣ UIで登録

    • 255バイト以内 → 保存成功

    • 256バイト超 → バリデーションエラー

    3️⃣ CSVで登録

    RAILS_ENV=development bin/rails csv:import FILE=./shops.csv

    → bytes超過なら例外発生(またはDB制約違反)

    4️⃣ ログ確認

    grep -E "csv_precheck|bytes" log/development.log

    charsとbytesが一致しているのを確認。


    8️⃣ これで“ズレ”はなくなる

    画像

    全経路を同じ基準に揃える。
    これこそ「再現できないエラー」を減らす最短ルートです。


    9️⃣ 追加Tips(より実践的に)

    • 別環境でも安全に動かすには
      `.env` でDB接続を管理(第1回参照)

    • 一括登録を高速化したい場合
      `activerecord-import` Gemを利用し、`validate: true` オプションを付与

    • 文字化け対策
      `encoding: "bom|utf-8"` でExcel出力CSVも読み取れる


    画像

    ✅ これで UIとCSV、どちらから登録しても同じ判定。
    ✅ bytesのズレ・不可視文字問題は完全に防止。


    では
    また


    過去の記事


     
     
    インフラエンジニアとして実務メモを、 写真作家として写真物語を、 童話作家として物語を書いています。 写真作品は、ポートフォリオサイトとしてまとめていく予定です。

    あなたへのおすすめ