Help us understand the problem. What is going on with this article?

メソッドの仕様をコード中にドキュメント的に記述する

More than 5 years have passed since last update.

StrongTypingを使用することで、Railsアプリのモデルのインターフェイスなどに手軽に強い型付けを導入できる。またその結果、メソッドの仕様をコード中にドキュメント的に記述しておくことができる。

StrongTypingのインストール

Gemfile に以下を記述して bundle install を実行。

gem 'strongtyping'

セットアップ

強い型付けを導入したいクラスにStrongTypingモジュールをインクルードしておく。

class Person
  include StrongTyping

引数が期待している型をドキュメント的に記述する

StrongTypingをインクルードすることで、#expectで引数が期待している型をチェックできるようになる。

class Person
  include StrongTyping
  ...

  def name=(name)
    expect(name, String)
    @name = name
  end

  ...

こう記述することで、引数nameStringオブジェクト以外が渡された場合にArgumentTypeErrorが投げられるようになる。

> person = Person.new
=> #<Person:0x0000010cd7a980>
> person.name=1
StrongTyping::ArgumentTypeError: Expecting String as argument 1, got Fixnum
> person.name="takkanm"
=> "takkanm"

複数の型が渡ってくることを許す場合には、以下のように配列で許容する型のリストを指定することができる。

  def foo(a)
    expect(a, [Integer, String])
    ...

また、引数が複数ある場合には、以下のような感じで記述する。

  def foo(a, b)
    expect(a, String, b, [String, NilClass])
    ...

チェックしてくれるのはもちろん、それぞれの引数に何が入ってくることを期待しているかを他の開発者に伝えるときにも便利。

参考

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした