間違っていると感じるコードでソフトウェア設計を改善する方法

あなたはあなたが欲しいを知っています やるべきことですが、あなたのコードは単に協力していません。たぶん、インデントのレベルが多すぎるか、半ダースのメソッドをチェーンしているか、非対称に見えます。それが何であれ、何かが気分が悪くなります。あなたはそれを無視することができます-つまり、あなたはまだ書きたい機能でいっぱいのバックログを持っています、そしてそれは実際にはではありません 悪い。しかし、それは間違いです。あなたのコードはあなたに何かを伝えようとしているので、あなたはそれを見逃したくないのです。

コードが奇妙に感じられる時期を知ることができれば、ソフトウェア設計スキルを迅速かつ大幅に向上させることができます 。この直感は、経験、メンターシップ、およびコードレビューから得られるため、構築するのは困難です。しかし、構文ビネガーを使用して悪いコードを気分を悪くするライブラリからいくつかの助けを得ることができます。

構文酢はどのように見えますか？

これは、Rubyに同梱されている小さなモックおよびスタブライブラリであるminitest/mockを使用した構文酢の例です。

require 'minitest/mock'

class CartTest < MiniTest::Test
  def test_error_message_set_on_charge_failure
    cart = Cart.new(items)
    cart.stub(:charge!, false) do
      cart.checkout!
      assert_equal "The credit card could not be charged", cart.credit_card_error
    end
  end
end

テストを実行すると、charge! Cartのメソッド スタブされているため、テストは支払い処理業者にヒットしません。ブロック構文は、必要なときにだけスタブするようにするのに適しています。しかし、たくさんのメソッドをスタブしたい場合はどうなりますか？

require 'minitest/mock'

class CartTest < MiniTest::Test
  def test_error_message_set_on_charge_failure
    payment_processor = PaymentProcessor.new
    cart = Cart.new(items, processor: payment_processor)

    payment_processor.stub(:charge!, false) do
      payment_processor.stub(:login!, true) do
        payment_processor.stub(:logout!, true) do
          cart.checkout!
          assert_equal "The credit card could not be charged", cart.credit_card_error
        end
      end
    end
  end
end

ええ。それはたくさんのインデントです。そして、それは1つのテストだけです。このコードが、他の多くのテストで繰り返されていることを想像できます。

あなたはできた このすべてのネストをテストヘルパーメソッドにラップします。しかし、あなたが本当に コードを聞くと、より良い方法を見つける必要があることがわかります。代わりにテストダブルの使用を検討する時期かもしれません：

class TestPaymentProcessor < PaymentProcessor
  def login!(account_id, key)
    true
  end

  def charge!(amount, credit_card)
    credit_card.can_be_charged?
  end

  def logout!
    true
  end
end

class CartTest < MiniTest::Test
  def test_error_message_set_on_charge_failure
    test_payment_processor = TestPaymentProcessor.new
    cart = Cart.new(items, processor: test_payment_processor)
    
    cart.credit_card = failing_credit_card
    cart.checkout!
    assert_equal "The credit card could not be charged", cart.credit_card_error
  end
end

これで、テストが読みやすくなりました。さらに、TestPaymentProcessorがあります それは他の多くの場所で使用することができます。実サーバーにアクセスしたくない場合は、開発モードで使用することもできます。