RubyやRailsでカスタムエラータイプを定義する場所

Rubyライブラリ（gem）またはRuby on Railsアプリケーションでカスタムエラータイプを定義するためのベストプラクティスはありますか？具体的には：

1. 彼らはプロジェクトのどこに構造的に属していますか？別の場所に、関連するモジュール/クラス定義をインライン化した別のファイル？
2. 新しいエラータイプを作成するタイミングと作成しないタイミングを規定する規則はありますか？

ライブラリが異なれば、実行方法も異なります。実際のパターンには気づきませんでした。一部のライブラリは常にカスタムエラータイプを使用しますが、他のライブラリはまったく使用しません。StandardErrorを拡張するすべてのエラーがあるものもあれば、階層がネストされているものもあります。空のクラス定義であるものもあれば、あらゆる種類の巧妙なトリックがあるものもあります。

ああ、そして私がこれらの「エラータイプ」を呼ぶのがちょっと曖昧だと感じたからといって、私が意味するのはこれです：

class AuthenticationError < StandardError; end
class InvalidUsername < AuthenticationError; end

宝石用

私はあなたが例外をこのように定義することを何度も見ました：

gem_dir / lib / gem_name / exceptions.rb

次のように定義されます：

module GemName

  class AuthenticationError < StandardError; end
  class InvalidUsername < AuthenticationError; end

end

この例は、httpartyのこのようなものです。

Ruby on Railsの場合

これらを、次のように見えるexceptions.rbというファイルの下のlib /フォルダーに配置します。

module Exceptions
  class AuthenticationError < StandardError; end
  class InvalidUsername < AuthenticationError; end
end

次のように使用します。

raise Exceptions::InvalidUsername

私はあなたのプロジェクトにまとまりのあるソースファイルを持たせるために、クラスでエラーを定義して、それらを他のどこにもスローしないようにする必要があると思います。

いくつかの階層が役立つ可能性があります-名前空間は冗長な文字列を型名から遠ざけるのに優れています-しかし、それは好みの問題です-区別するために全体を通して使用するアプリに少なくとも1つのカスタム例外型があれば、やり過ぎる必要はありません「意図的」と「偶発的」の例外ケースの間。

レールではapp/errorsディレクトリを作成できます

# app/errors/foo_error.rb
class FooError < StandardError; end

春/サーバーを再起動し、それをピックアップする必要があります

これは古い質問ですが、Railsでカスタムエラーを処理する方法（エラーメッセージの添付、テスト、ActiveRecordモデルでの処理方法など）を共有したいと思いました。

カスタムエラーの作成

class MyClass
  # create a custome error
  class MissingRequirement < StandardError; end

  def my_instance_method
    raise MyClass::MissingRequirement, "My error msg" unless true   
  end
end

テスト（ミニテスト）

test "should raise MissingRequirement if ____ is missing"
  # should raise an error
  error = assert_raises(MyClass::MissingRequirement) {
    MyClass.new.my_instance_method
  }

  assert error.message = "My error msg"
end

ActiveRecordを使用

ActiveRecordモデルを操作する場合、一般的なパターンは、以下に説明するようにモデルにエラーを追加して、検証が失敗することです。

def MyModel < ActiveRecord::Base
  validate :code_does_not_contain_hyphens

  def code_does_not_contain_hyphens
    errors.add(:code, "cannot contain hyphens") if code.include?("-")
  end
end

検証が実行されると、このメソッドはActiveRecordのActiveRecord::RecordInvalidエラークラスに便乗し、検証が失敗します。

お役に立てれば！

自動ロードがRails 4.1.10で複数のカスタムエラークラスに対して期待どおりに機能することを確認するには、それぞれに個別のファイルを指定する必要があります。これは、動的にリロードする開発で機能するはずです。

これは私が最近のプロジェクトでエラーを設定する方法です：

に lib/app_name/error/base.rb

module AppName
    module Error
        class Base < StandardError; end
    end
end

次のようなカスタムエラーで lib/app_name/error/bad_stuff.rb

module AppName
    module Error
        class BadStuff < ::AppName::Error::Base; end
    end
end

その後、次の方法でエラーを呼び出すことができます。

 raise AppName::Error::BadStuff.new("Bad stuff just happened")