契約による設計

# 事前条件: pathは/files/からの相対パスで指定され、存在していること
def import_file(path)
  # ...
end

# 事前条件: pathは/files/からの相対パスで指定され、存在していること
def import_file(path)
  path = Pathname.new('/files/') / "./#{path}"
  unless path.exist?
    raise "指定されたファイルが/files/に存在しない: path => #{path}"
  end
  # ...
end

# 事前条件: pathは/files/からの相対パスで指定され、存在していること
# 事後条件: 処理されたファイルは削除されていること
def import_file(path)
  path = Pathname.new('/files/') / "./#{path}"
  unless path.exist?
    raise "指定されたファイルが/files/に存在しない: path => #{path}"
  end
  # ...
end

# クラス不変表明:  0 <= @collection.length <= 10
# 10個の要素を持てるコレクション
class Collection
  def initialize
    @collection = []
  end

  # 事後条件: 追加できた場合は@collectionの最後にitemが追加される
  # 追加できた場合はtrueを、追加できなかった場合はfalseを返す
  def try_add(item)
    return false if 10 < @collection.length
    @collection << item

    true
  end
end

RSpec.describe Collection, type: :model do
  let(:target) { described_class.new }
  # インスタンス変数をメタプログラミングを使って取得している
  let(:collection) { target.instance_variale_get(:@collection) }

  # クラス不変表明テスト
  def class_invariant_spec
    expect(collection.length).to be >= 0
    expect(collection.length).to be <= 10
  end

  describe '#try_add' do
    # 事後条件テスト
    def postcondition_spec(item)
      expect(last_added_item).to eq item
    end
    let(:last_added_item) { collection.last }

    it '10回目の実行までtrueを返す' do
      10.times do |item|
        expect(target.try_add(item)).to eq true
        postcondition_spec(item)
        class_invariant_spec
      end
    end

    it '11回目以降の実行ではfalseを返す' do
      10.times { |item| target.try_add(item) }
      last_item = last_added_item
      10.times do |item|
        expect(target.try_add(item)).to eq false
        postcondition_spec(last_item)
        class_invariant_spec
      end
    end
  end
end

# 各メソッド名は本番環境でどのように振る舞うかをイメージしている
class Precondition
  class << self
    # 本番環境でチェックする
    def check
      yield
      self
    end

    # 本番環境でチェックし問題があればログに記録する
    def logging
      yield
      self
    rescue StandardError => e
      Rails.logger.fatal(e.message)
      raise unless Rails.env.production?

      self
    end

    # 本番環境では忘れる＝実行しない
    def forget
      return self if Rails.env.production?

      yield
      self
    end
  end
end

def import_file(path)
  path = Pathname.new('/files/') / "./#{path}"
  # 利用例。本番環境以外では例外が呼び出し元に投げられるが、本番環境ではログに記録されるだけ
  Precondition.logging do
    unless path.exist?
      raise "指定されたファイルが/files/に存在しない: path => #{path}"
    end
  end
  # ...
end