decentworks-hexdigest-support 0.1.0

data/lib/decentworks/hexdigest_support/hash.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "object"
+
+class Hash
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: キーも値と同じく#to_hexdigest_inputで正規化する。キーをそのまま文字列へ
+  #       埋めると、#to_sを実装していないオブジェクトがキーの場合にオブジェクトIDが
+  #       混入して非決定的になる。#to_hexdigest_input経由なら検出して例外になる
+  #
+  # MEMO: キー・値ともに#to_hexdigest_sourceではなく#to_hexdigest_inputを使う。
+  #       値だけでは型が落ちるため、{ a: 1 } と { "a" => 1 }、
+  #       { a: 1, "a" => 2 } と { "a" => 1, a: 2 } が同じ値になってしまう
+  #
+  # MEMO: Hash#to_sには頼らず自前で文字列を組み立てる。ネイティブの#inspectの出力形式は
+  #       Rubyのバージョンによって変わりうる（例: Ruby 3.4以降で"=>"の前後にスペースが
+  #       入るようになった）ため、バージョンが変わるとダイジェストの値も変わってしまう
+  def to_hexdigest_source
+    return "{}" if empty?
+
+    map { |key, value| "#{key.to_hexdigest_input}=>#{value.to_hexdigest_input}" }
+      .sort
+      .join(",")
+      .prepend("{")
+      .concat("}")
+  end
+end

data/lib/decentworks/hexdigest_support/input.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Decentworks
+  module HexdigestSupport
+    # 値がオブジェクトIDを含んでおり、ダイジェストが決定的にならない
+    class NonDeterministicSourceError < ::StandardError; end
+
+    # 値が自身を含んでおり、入力の組み立てが終わらない
+    class CircularReferenceError < ::StandardError; end
+
+    # ダイジェストの入力の組み立て
+    class << self
+      # 既定の#to_sが返す文字列（例: "#<Object:0x00007f9e0c0d1234>"）
+      #
+      # MEMO: メソッドの定義元（#to_sのowner）ではなく結果の文字列で判定する。
+      #       Proc#to_sや無名クラスのModule#to_sのように、独自の#to_sを持ちながら
+      #       オブジェクトIDを含む型も拾いたいため
+      DEFAULT_TO_S_PATTERN = /\A#<.*:0x\h+/
+
+      # 組み立て中のオブジェクトを記録するキー
+      #
+      # MEMO: Thread.current[]はスレッドではなくFiber単位で値を持つ。組み立ての
+      #       途中でFiberをまたぐことはないため、これで取り違えは起きない
+      VISITING_KEY = :decentworks_hexdigest_support_visiting
+
+      # 値を引用・エスケープする
+      #
+      # MEMO: #inspectを使わない。#inspectは非ASCII文字をEncoding.default_externalが
+      #       印字可能かどうかでエスケープするか決めるため、同じ値でも実行環境の
+      #       ロケール次第で異なる入力になってしまう
+      #       （UTF-8環境では"あ"、US-ASCII環境では"あ"）
+      #
+      # MEMO: エスケープ対象は引用符とバックスラッシュのみ。UTF-8環境の#inspectと
+      #       同じ出力になるため、制御文字を含まない値のダイジェストは変わらない
+      #
+      # MEMO: 引用しないと、値に区切り文字（:）が含まれる場合に型名との境界が
+      #       曖昧になる（例: Foo::Barの"x" と Fooの":Bar:x" が衝突する）
+      def quote(value) = %("#{value.to_s.gsub(/[\\"]/) { |char| "\\#{char}" }}")
+
+      # 値が決定的かを検査する
+      #
+      # MEMO: 既定のObject#to_sはオブジェクトIDを含むため、#to_sも
+      #       #to_hexdigest_sourceも実装していないオブジェクトのダイジェストは
+      #       プロセスごとに変わる。永続化した後で気付くと復旧できないため、
+      #       黙って通さず例外にする
+      #
+      # MEMO: StringとSymbolは検査しない。検査は「既定のObject#to_sへ落ちていないか」を
+      #       見るためのものだが、この2つは値そのものが文字列であり、オブジェクトIDが
+      #       混入する経路がない。除外しないと "#<User:0x00007f9e0c0d1234>" のような
+      #       正当な文字列（ログの1行や#inspectの結果を保持した値）が例外になってしまう
+      #
+      # MEMO: 裏を返すと、利用側が自分でオブジェクトを文字列化して渡した場合は検出
+      #       できない。gemから見ればただの文字列であり、他の文字列と区別できないため
+      def validate_source!(source, object)
+        return if object.is_a?(::String) || object.is_a?(::Symbol)
+        return unless DEFAULT_TO_S_PATTERN.match?(source.to_s)
+
+        raise ::Decentworks::HexdigestSupport::NonDeterministicSourceError,
+              "#{object.class}の値がオブジェクトIDを含むため、ダイジェストが決定的になりません" \
+              "（#{source}）。#to_hexdigest_sourceか#to_sを実装してください"
+      end
+
+      # 組み立て中のオブジェクトを記録しながらブロックを実行する
+      #
+      # MEMO: 自身を含む値をそのまま辿ると再帰が終わらず、StandardErrorを継承しない
+      #       SystemStackErrorになる。呼び出し側のrescueをすり抜けてプロセスを
+      #       落としてしまうため、自前で検出して例外にする
+      #
+      # MEMO: 記録するのは現在辿っている経路だけで、組み立てが終わった時点で取り除く。
+      #       同じオブジェクトが兄弟として複数回現れるのは循環ではないため、経路に
+      #       残っている場合だけを循環とみなす
+      #
+      # MEMO: 自身を含まない深いネスト（1万段など）はSystemStackErrorのまま。循環と
+      #       違って有限であり、深さの上限を決め打ちすると正当な構造まで弾いてしまう
+      def detect_circular_reference(object)
+        visiting = (::Thread.current[VISITING_KEY] ||= [])
+        raise_circular_reference(object) if visiting.include?(object.object_id)
+
+        visiting.push(object.object_id)
+
+        begin
+          yield
+        ensure
+          visiting.pop
+        end
+      end
+
+      private
+
+      def raise_circular_reference(object)
+        raise ::Decentworks::HexdigestSupport::CircularReferenceError,
+              "#{object.class}の値が自身を含んでいるため、ダイジェストを求められません。" \
+              "循環参照を取り除いてください"
+      end
+    end
+  end
+end

data/lib/decentworks/hexdigest_support/nil_class.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class NilClass
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: NilClass#to_sは空文字を返すため、既定のままでは入力がNilClass:""となり、
+  #       空文字を持つ他の型（String:""）とは型でしか区別できない。#inspectと同じ
+  #       "nil"を明示することで、入力を目視したときに値の不在だと分かるようにする
+  #
+  # MEMO: true / falseはTrueClass#to_s / FalseClass#to_sが"true" / "false"を返すため、
+  #       既定のObject#to_hexdigest_sourceのままで意図した入力になる
+  def to_hexdigest_source = "nil"
+end

data/lib/decentworks/hexdigest_support/numeric.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "numeric_like"
+
+# MEMO: Numericへ直接includeせず、具体的なクラスごとにincludeする。Numericのサブクラスには
+#       有理数へ変換できないものがあり（Complexは実部と虚部の組なので、虚部があると
+#       #to_rがRangeErrorになる）、一律に寄せると壊れるため
+#
+# MEMO: Complexは対象外とする。Complex(1, 0) == 1 が真なので厳密には型で割れるが、
+#       アプリケーションで虚数を扱う場面はまれであり、対応のコストに見合わない
+class Integer
+  include ::Decentworks::HexdigestSupport::NumericLike
+end
+
+class Rational
+  include ::Decentworks::HexdigestSupport::NumericLike
+end
+
+class Float
+  include ::Decentworks::HexdigestSupport::NumericLike
+
+  # 正規化に用いる有理数
+  #
+  # MEMO: #to_rではなく#to_sを経由して十進として読む。#to_rは2進の厳密値を返すため、
+  #       0.1が1/10ではなく3602879701896397/36028797018963968になり、
+  #       BigDecimal("0.1")やRational(1, 10)と別のダイジェストになってしまう
+  #
+  # MEMO: Float#to_sは元の値へ復元できる最短の十進表記を返す。よって#==が真になる
+  #       Float同士は必ず同じ有理数になり、異なるFloatが同じ有理数になることもない
+  def to_hexdigest_rational = ::Kernel.Rational(to_s)
+end

data/lib/decentworks/hexdigest_support/numeric_like.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Decentworks
+  module HexdigestSupport
+    # 数を表す型に共通の入力生成
+    #
+    # MEMO: Integer / Float / Rational / BigDecimalへincludeする。Rubyのクラス階層上は
+    #       それぞれ別の型だが、いずれも「数」を表す点は同じなのでダイジェストの入力は
+    #       共通化する
+    module NumericLike
+      # ハッシュ値化に用いる型の識別子
+      #
+      # MEMO: 実装クラス名ではなく"Numeric"へ正規化する。Railsでは同じ数が経路によって
+      #       別のクラスで現れる（decimalカラムはBigDecimal、integerカラムやJSONの整数は
+      #       Integer、JSONの小数はFloat）ため、クラス名を型にすると入力経路の違いだけで
+      #       ダイジェストが割れてしまう
+      #
+      # MEMO: 「型で区別する」という本gemの原則に対する意図的な例外。TimeLikeで
+      #       Time / DateTime / TimeWithZoneを"Time"へ寄せているのと同じ割り切り
+      def to_hexdigest_type = "Numeric"
+
+      # ハッシュ値を求めるためのオリジナルの値
+      #
+      # MEMO: 有理数へ寄せてから文字列化する。#to_sの表記はクラスごとに異なり
+      #       （1.5は"1.5"、BigDecimal("1.5")は"0.15e1"）、同じ数でも別の値になってしまう
+      #
+      # MEMO: NaNと±Infinityは有理数にできないため#to_sをそのまま使う。FloatとBigDecimalの
+      #       どちらも"NaN" / "Infinity" / "-Infinity"を返すので、型を寄せても表記は揃う
+      #
+      # MEMO: NaN同士は#==がfalseになるがダイジェストは一致する。値として区別する術が
+      #       ない以上、インスタンスごとに異なる入力を作るよりは同一として扱う
+      def to_hexdigest_source
+        return to_s unless finite?
+
+        ::Decentworks::HexdigestSupport.format_rational(to_hexdigest_rational)
+      end
+
+      # 正規化に用いる有理数
+      #
+      # MEMO: 十進として解釈すべき型（Float）はこのメソッドを上書きする
+      def to_hexdigest_rational = to_r
+    end
+
+    # 数の正規化
+    class << self
+      # 有理数を一意な文字列へ整形する
+      #
+      # MEMO: 有限小数で表せる場合は十進表記、表せない場合は分数表記にする。Rationalは
+      #       既約かつ分母が正へ正規化済みのため、どちらの表記も数に対して一意になる
+      #
+      # MEMO: 分数表記が十進表記と衝突することはない。十進表記に区切り文字（/）は
+      #       現れないため
+      def format_rational(rational)
+        return rational.numerator.to_s if rational.denominator == 1
+
+        scale = decimal_scale(rational.denominator)
+        return "#{rational.numerator}/#{rational.denominator}" unless scale
+
+        sign   = rational.negative? ? "-" : ""
+        digits = (rational.numerator.abs * (10**scale / rational.denominator)).to_s.rjust(scale + 1, "0")
+
+        "#{sign}#{digits[0...-scale]}.#{digits[-scale..]}"
+      end
+
+      private
+
+      # 有限小数で表すのに必要な小数点以下の桁数（表せない場合はnil）
+      #
+      # MEMO: 分母が2と5のべき乗の積のときだけ有限小数になる。既約分数なので、
+      #       2と5で割り切った残りが1かどうかだけで判定できる
+      #
+      # MEMO: 桁数は2と5の指数の大きい方。これが必要最小の桁数であり、末尾に0が
+      #       並ばないため表記が一意になる
+      def decimal_scale(denominator)
+        rest  = denominator
+        twos  = 0
+        fives = 0
+
+        while (rest % 2).zero?
+          rest /= 2
+          twos += 1
+        end
+
+        while (rest % 5).zero?
+          rest /= 5
+          fives += 1
+        end
+
+        (rest == 1) ? [twos, fives].max : nil
+      end
+    end
+  end
+end

data/lib/decentworks/hexdigest_support/object.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "digest"
+
+require_relative "configuration"
+require_relative "input"
+
+class Object
+  # MD5でハッシュ値化（16進数）
+  def to_md5_hexdigest = ::Digest::MD5.hexdigest(to_salted_hexdigest_input)
+
+  # RMD160でハッシュ値化（16進数）
+  def to_rmd160_hexdigest = ::Digest::RMD160.hexdigest(to_salted_hexdigest_input)
+
+  # SHA1でハッシュ値化（16進数）
+  def to_sha1_hexdigest = ::Digest::SHA1.hexdigest(to_salted_hexdigest_input)
+
+  # SHA256でハッシュ値化（16進数）
+  def to_sha256_hexdigest = ::Digest::SHA256.hexdigest(to_salted_hexdigest_input)
+
+  # SHA384でハッシュ値化（16進数）
+  def to_sha384_hexdigest = ::Digest::SHA384.hexdigest(to_salted_hexdigest_input)
+
+  # SHA512でハッシュ値化（16進数）
+  def to_sha512_hexdigest = ::Digest::SHA512.hexdigest(to_salted_hexdigest_input)
+
+  # MD系のデフォルトアルゴリズム
+  alias_method :to_md_hexdigest, :to_md5_hexdigest
+
+  # RMD系のデフォルトアルゴリズム
+  alias_method :to_rmd_hexdigest, :to_rmd160_hexdigest
+
+  # SHA系のデフォルトアルゴリズム
+  alias_method :to_sha_hexdigest, :to_sha256_hexdigest
+
+  # ハッシュ値化のデフォルトアルゴリズム
+  alias_method :to_hexdigest, :to_sha_hexdigest
+
+  # ソルトを前置したハッシュ値化の入力
+  #
+  # MEMO: ソルトはダイジェストを求める直前に一度だけ前置する。#to_hexdigest_inputに
+  #       含めてしまうと、配列やハッシュの要素ごとに再帰的にソルトが混入し、
+  #       構造によってソルトの出現回数が変わってしまう
+  def to_salted_hexdigest_input = "#{::Decentworks::HexdigestSupport.salt}#{to_hexdigest_input}"
+
+  # ハッシュ値化の入力（型 + 値）
+  #
+  # MEMO: #to_hexdigest_sourceは値を文字列へ射影するだけなので単射にならない。
+  #       型を添えないと :a と "a"、1 と "1" が同じ入力になり、内容の異なる
+  #       オブジェクト同士が同じダイジェストになってしまう
+  #
+  # MEMO: 引用・エスケープと決定性の検査はHexdigestSupport側へ切り出している。
+  #       #inspectに任せると実行環境のロケールで出力が変わるため
+  #       （詳細はinput.rbのMEMOを参照）
+  #
+  # MEMO: 検査を#to_hexdigest_sourceではなく本メソッドで行うのは、ここが
+  #       すべての値が通る唯一の経路であるため。オーバーライドされた
+  #       #to_hexdigest_sourceが返した値も同じように検査される
+  #
+  # MEMO: 循環参照の検出も同じ理由でここに置く。要素を辿るのは各型の
+  #       #to_hexdigest_sourceだが、その入り口は必ず本メソッドを通るため、
+  #       独自クラス同士が参照しあう循環も検出できる
+  def to_hexdigest_input
+    source = ::Decentworks::HexdigestSupport.detect_circular_reference(self) { to_hexdigest_source }
+    ::Decentworks::HexdigestSupport.validate_source!(source, self)
+
+    "#{to_hexdigest_type}:#{::Decentworks::HexdigestSupport.quote(source)}"
+  end
+
+  # ハッシュ値化に用いる型の識別子
+  #
+  # MEMO: 無名クラスは#nameがnilのため、名前を持つ祖先クラスまで遡る。
+  #       #ancestorsではなく#superclassを辿るのは、無名クラスがincludeしている
+  #       モジュール名を型として拾ってしまうのを避けるため
+  def to_hexdigest_type
+    klass = self.class
+    klass = klass.superclass until klass.name
+    klass.name
+  end
+
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: #to_s以外で値を指定する場合は、本メソッドをオーバーライドすること。
+  #       型の識別は#to_hexdigest_inputが担うため、オーバーライド側で
+  #       型を意識する必要はない
+  #
+  # MEMO: #to_sも本メソッドも実装していないオブジェクトは、既定のObject#to_sが
+  #       返すオブジェクトIDが値になってしまう。#to_hexdigest_inputで検査して
+  #       例外にしているため、そのままダイジェストになることはない
+  def to_hexdigest_source = to_s
+end

data/lib/decentworks/hexdigest_support/range.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "hash"
+
+class Range
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: 端点は文字列化せずそのままHashに渡す。先に#to_hexdigest_sourceで
+  #       文字列にしてしまうと型が落ちて、(1..3) と ("1".."3") が同じ値になってしまう
+  #
+  # MEMO: 端点の取得に#first/#lastではなく#begin/#endを使う。#firstは始端のない範囲で、
+  #       #lastは終端のない範囲でRangeErrorになるため、(1..) や (..3) を扱えない。
+  #       #begin/#endは端点がなければnilを返すので、端点なしをNilClassとして表現できる
+  #
+  # MEMO: 有界な範囲では#first/#lastと#begin/#endの戻り値は一致し、キー名もfirst/lastの
+  #       ままとしているため、この実装で既存のダイジェストは変わらない
+  def to_hexdigest_source
+    {
+      first:       self.begin,
+      last:        self.end,
+      exclude_end: exclude_end?
+    }.to_hexdigest_source
+  end
+end

data/lib/decentworks/hexdigest_support/set.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "array"
+
+class Set
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: 要素の文字列化はArrayへ委譲する。Array#to_hexdigest_sourceが要素を
+  #       ソートするため、挿入順が違っても同じ値になる
+  #
+  # MEMO: 型は#to_hexdigest_inputが付与するため、同じ要素を持つArrayとは
+  #       別のダイジェストになる
+  def to_hexdigest_source = to_a.to_hexdigest_source
+end

data/lib/decentworks/hexdigest_support/struct.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "hash"
+
+class Struct
+  # ハッシュ値を求めるためのオリジナルの値
+  #
+  # MEMO: 値の配列（#to_a）ではなく#to_hに委譲する。メンバー名が落ちると、
+  #       メンバー構成の異なるStruct同士が同じ値になってしまう
+  #       （例: Struct.new(:a, :b)の(1, 2) と Struct.new(:x, :y)の(1, 2) が衝突する）
+  #
+  # MEMO: 定数へ代入していない無名のStructは#to_hexdigest_typeが"Struct"へ丸まるため、
+  #       メンバー名と値が同じなら別々に生成したStruct同士でも同じダイジェストになる。
+  #       型で区別したい場合は定数へ代入して名前を与えること
+  def to_hexdigest_source = to_h.to_hexdigest_source
+end

data/lib/decentworks/hexdigest_support/time.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "time_like"
+
+class Time
+  # MEMO: 直接メソッドを定義せずincludeするのは、DateTime / TimeWithZoneと
+  #       実装を1箇所に集めるため
+  include ::Decentworks::HexdigestSupport::TimeLike
+end

data/lib/decentworks/hexdigest_support/time_like.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Decentworks
+  module HexdigestSupport
+    # 時刻（ある一瞬）を表す型に共通の入力生成
+    #
+    # MEMO: Time / DateTime / ActiveSupport::TimeWithZoneへincludeする。Rubyの
+    #       クラス階層上は無関係な3つだが、いずれも「ある一瞬」を表す点は同じなので
+    #       ダイジェストの入力は共通化する
+    module TimeLike
+      # ハッシュ値化に用いる型の識別子
+      #
+      # MEMO: 実装クラス名ではなく"Time"へ正規化する。Railsでは同じ瞬間が経路によって
+      #       別のクラスで現れる（Time.zone.nowやActiveRecordのdatetimeカラムは
+      #       ActiveSupport::TimeWithZone、Time.nowやFile.mtimeはTime）ため、
+      #       クラス名を型にすると入力経路の違いだけでダイジェストが割れてしまう
+      #
+      # MEMO: 「型で区別する」という本gemの原則に対する意図的な例外。Rangeの端点を
+      #       first / lastというキー名に固定しているのと同じく、実装ではなく意味論に
+      #       合わせた割り切り
+      def to_hexdigest_type = "Time"
+
+      # ハッシュ値を求めるためのオリジナルの値
+      #
+      # MEMO: UTCへ変換してから文字列化する。#to_sはタイムゾーンのオフセットを含むため、
+      #       同じ瞬間を指す時刻でも実行環境やTime.zoneの設定次第で異なる値になってしまう
+      #
+      # MEMO: 精度はナノ秒で固定する。秒へ丸めると同一秒内の異なる時刻が衝突し、
+      #       小数部を可変長にすると1.0秒と1秒が異なる値になってしまう
+      #
+      # MEMO: time（stdlib）の#iso8601ではなく#strftimeで組み立てる。ネイティブの
+      #       文字列表現に依存させないという方針はHash#to_hexdigest_sourceと同じ
+      #
+      # MEMO: Timeはナノ秒より細かい精度を持ちうるが、その桁は切り捨てる。
+      #       DBのtimestamp（多くはマイクロ秒）と往復させても値が変わらない粒度に揃えるため
+      #
+      # MEMO: 先に#to_timeを挟むのは、DateTimeとTimeWithZoneをTimeへ寄せるため。
+      #       Time#to_timeは自身を返すので、Timeにとっては実質的に無害
+      def to_hexdigest_source = to_time.getutc.strftime("%Y-%m-%dT%H:%M:%S.%9NZ")
+    end
+  end
+end

data/lib/decentworks/hexdigest_support/time_with_zone.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# MEMO: active_support/timeを読み込むのは、ActiveSupport::TimeWithZoneがActiveSupportの
+#       autoload経由でしか解決できないため。内部のファイルパスに依存しない公開の入口として
+#       この行を使う
+require "active_support/time"
+
+require_relative "time_like"
+
+# MEMO: TimeWithZoneはTimeのサブクラスではない（#is_a?(Time)がtrueを返すのは
+#       TimeWithZone側の偽装）ため、Timeへの拡張は届かない。明示的にincludeする
+#
+# MEMO: これを入れないとObject#to_hexdigest_source（＝#to_s）へフォールバックし、
+#       オフセットを含む文字列が入力になる。Rails上ではTime.zone.nowやActiveRecordの
+#       datetimeカラムがこのクラスなので、実質ほぼ全ての時刻が該当する
+#
+# MEMO: class ... endで開き直さず.includeを呼ぶのは、万一TimeWithZoneが未解決だった場合に
+#       autoloadを潰して空のクラスを新規定義してしまうのを避けるため
+::ActiveSupport::TimeWithZone.include(::Decentworks::HexdigestSupport::TimeLike)

data/lib/decentworks/hexdigest_support/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Decentworks
+  module HexdigestSupport
+    VERSION = "0.1.0"
+  end
+end

data/lib/decentworks/hexdigest_support.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "hexdigest_support/version"
+require_relative "hexdigest_support/configuration"
+require_relative "hexdigest_support/input"
+require_relative "hexdigest_support/object"
+require_relative "hexdigest_support/nil_class"
+require_relative "hexdigest_support/numeric_like"
+require_relative "hexdigest_support/numeric"
+require_relative "hexdigest_support/big_decimal"
+require_relative "hexdigest_support/array"
+require_relative "hexdigest_support/hash"
+require_relative "hexdigest_support/range"
+require_relative "hexdigest_support/struct"
+require_relative "hexdigest_support/data"
+require_relative "hexdigest_support/set"
+require_relative "hexdigest_support/time_like"
+require_relative "hexdigest_support/time"
+require_relative "hexdigest_support/date"
+require_relative "hexdigest_support/time_with_zone"

data/lib/decentworks-hexdigest-support.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "decentworks/hexdigest_support"

data/lib/generators/decentworks/hexdigest_support/install/install_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Decentworks
+  module HexdigestSupport
+    module Generators
+      # 初期化ファイルを生成するジェネレータ
+      #
+      #   bin/rails generate decentworks:hexdigest_support:install
+      #
+      # MEMO: 本ファイルはlib/decentworks/hexdigest_support.rbからはrequireしない。
+      #       Railsのジェネレータ探索（lib/generators配下）から呼ばれた時にだけ
+      #       読み込まれるため、railtiesを導入していない環境でも利用できる
+      #
+      # MEMO: gem本体はactivesupportに依存する（ActiveSupport::TimeWithZone対応のため）が、
+      #       railtiesには依存しない。この遅延読み込みが担保しているのは後者
+      class InstallGenerator < ::Rails::Generators::Base
+        source_root ::File.expand_path("templates", __dir__)
+
+        desc "config/initializers/decentworks_hexdigest_support.rb を生成する"
+
+        class_option :salt_key,
+                     type:    :string,
+                     default: "hexdigest_support_salt",
+                     desc:    "credentialsから読み出すキー名（decentworks配下）"
+
+        def create_initializer_file
+          template "decentworks_hexdigest_support.rb", "config/initializers/decentworks_hexdigest_support.rb"
+        end
+
+        private
+
+        def salt_key = options[:salt_key]
+      end
+    end
+  end
+end

data/lib/generators/decentworks/hexdigest_support/install/templates/decentworks_hexdigest_support.rb.tt

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# ハッシュ値化の設定
+#
+# MEMO: ソルトはダイジェストの入力へ前置される。ソルトを変更すると同じ値でも
+#       異なるダイジェストになるため、永続化済みのダイジェストがある場合は
+#       変更前に移行方針を検討すること
+#
+# MEMO: ソルトはリポジトリに平文で置かず、credentialsで管理する。
+#       EDITOR="vi" bundle exec rails credentials:edit --environment [development | test | production]
+#
+#       decentworks:
+#         <%= salt_key %>: <ランダムな文字列（例: `bin/rails secret` の出力）>
+::Decentworks::HexdigestSupport.configure do |config|
+  config.salt = ::Rails.application.credentials.dig(:decentworks, :<%= salt_key %>)
+end

data/sig/decentworks/hexdigest_support/array.rbs

@@ -0,0 +1,3 @@
+class ::Array[unchecked out Elem]
+  def to_hexdigest_source: -> ::String
+end

data/sig/decentworks/hexdigest_support/configuration.rbs

@@ -0,0 +1,14 @@
+module Decentworks
+  module HexdigestSupport
+    class Configuration
+      attr_accessor salt: ::String?
+
+      def initialize: -> void
+    end
+
+    def self.configuration: -> ::Decentworks::HexdigestSupport::Configuration
+    def self.configure: { (::Decentworks::HexdigestSupport::Configuration) -> void } -> void
+    def self.reset_configuration!: -> nil
+    def self.salt: -> ::String
+  end
+end

data/sig/decentworks/hexdigest_support/data.rbs

@@ -0,0 +1,3 @@
+class ::Data
+  def to_hexdigest_source: -> ::String
+end

data/sig/decentworks/hexdigest_support/date.rbs

@@ -0,0 +1,7 @@
+class ::Date
+  def to_hexdigest_source: -> ::String
+end
+
+class ::DateTime
+  include ::Decentworks::HexdigestSupport::TimeLike
+end

data/sig/decentworks/hexdigest_support/hash.rbs

@@ -0,0 +1,3 @@
+class ::Hash[unchecked out K, unchecked out V]
+  def to_hexdigest_source: -> ::String
+end

data/sig/decentworks/hexdigest_support/input.rbs

@@ -0,0 +1,11 @@
+module Decentworks
+  module HexdigestSupport
+    class NonDeterministicSourceError < ::StandardError
+    end
+
+    DEFAULT_TO_S_PATTERN: ::Regexp
+
+    def self.quote: (untyped value) -> ::String
+    def self.validate_source!: (untyped source, untyped object) -> void
+  end
+end

data/sig/decentworks/hexdigest_support/nil_class.rbs

@@ -0,0 +1,3 @@
+class ::NilClass
+  def to_hexdigest_source: -> ::String
+end