Rubyのメソッド探索についてまとめてみた
今回はパーフェクト Ruby で「Ruby のメソッド探索」について学んだのでそのメモです。
オブジェクトに対してメソッド呼び出しが行われる際、どのようにメソッドが呼び出されているのか、書いてみたいと思います。
自身のメソッドを呼び出した時
class BaseClass
def hello
:hello
end
end
base_object = BaseClass.new
base_object.hello #=> :hello
これは最も単純なケース。
自身のクラスのhelloメソッドを探しにいって、あれば実行します。
親クラスのメソッドを呼び出した時
class InheritClass < BaseClass end inherit_object = InheritClass.new inherit_object.hello #=> :hello
この場合、まず Ruby のインタプリタはinherit_objectのクラスInheritClassを参照しますが、ここにhelloメソッドはありません。なので、次にその親クラスであるBaseClassを探しにいってそこで見つかったhelloメソッドを呼び出します。
特異メソッドを呼び出した時
def base_object.hello :singleton_method_hello end base_object.hello #=> :singleton_method_hello
base_objectの特異メソッドにhelloを定義した場合。これはbase_objectの特異クラスのメソッドなので上図のような関係になります。
特異クラスはオブジェクトのクラスよりも先にメソッド探索されるようになっています。よって今回の場合、インタプリタはまずbase_objectの特異クラスを参照し、そこにあるhelloメソッドを呼び出します。
ちなみにbase_objectの特異クラスにはbase_object.singleton_classでアクセス可能（特異クラスはそれを定義したり、確認しようとしたタイミングで作成される）です。
クラスに include したモジュールのメソッドを呼び出した時
module HelloModule
def hello_from_module
:hello_from_module
end
end
class InheritClass
include HelloModule
end
inherit_object = InheritClass.new
inherit_object.hello_from_module #=> :hello_from_module
モジュールをクラスにincludeした場合、そのモジュールの機能を取り込んだクラスが自身と親クラスの間に挿入されます。そして自分、モジュールの機能を取り込んだクラス、親クラスの順に探索します。
今回の場合はモジュールの機能を取り込んだクラス内でhello_from_moduleを発見し、それを呼び出しています。
ちなみに複数のモジュールをincludeした場合は後からincludeしたモジュールが前に挿し込まれる感じになります。
クラスに extend したモジュールのメソッドを呼び出した時
module HelloModule
def hello_from_module
:hello_from_module
end
end
class InheritClass
extend HelloModule
end
inherit_object = InheritClass.new
inherit_object.hello_from_module #=> NoMethodError: undefined method ...
InheritClass.hello_from_module #=> :hello_from_module
モジュールをクラスにextendした場合、レシーバ(今回はInheritClass)の特異クラスに対してextendしたモジュールがincludeされます。
よって上図のような関係になり、モジュールで定義しているメソッドがInheritClassのクラスメソッドとして使えるようになります。inherit_objectのメソッド探索は直線部なので、破線部にあるhello_from_moduleは見つかりません。
存在しないメソッドを呼び出した時
method_missingメソッドが定義されているクラスを探し続けます。
それが見つからない場合は最終的にBaseObject#method_missingを呼び出し、NoMethodErrorが発生します。
まとめ
特異メソッド、特異クラス、mixin など何気なく使っているものの動作を図で整理できてよかったです。 なにか間違えていたらご指摘いただけると幸いです。
今回も参考にしたのはこちら。
Rubyのインスタンス変数、クラス変数、クラスインスタンス変数
Ruby のクラスには
があって何かとややこしい。。
特にクラス変数とクラスインスタンス変数の違いについてはいまいち理解しきれていなかったので、今回は頭の整理もかねてメモです。
それぞれの特徴について書いてみたいと思います。
インスタンス変数
オブジェクト固有の状態を保持するための変数。@をつける。
class Foo
attr_accessor :instance_foo
def initialize
@instance_foo = 'instance_foo!'
end
end
Foo.new.instance_foo #=> instance_foo!
外部からアクセスするにはFoo#nameとFoo#name=を定義する必要があるが、attr_accessorを使えば自動的に定義してくれる。
もしくはinstance_variable_getとかinstance_variable_setとか使う。
クラス変数
クラスとそのサブクラスの定義中、クラスメソッド、インスタンスメソッドで共有できる変数。
@@をつける。
class ParentFoo
@@class_foo = 'class_foo!'
def self.say
@@class_foo
end
end
class ChildFoo < ParentFoo
def say
@@class_foo
end
end
ParentFoo.say #=> class_foo!
ChildFoo.say #=> class_foo!
ChildFoo.new.say #=> class_foo!
今回はsayメソッドを用意してるけど、class_variable_getとかclass_variable_setとかで外部からアクセスもできる。
Rails を使ってるならcattr_accessorでattr_accessor的にクラス変数を外部に公開したりもできるはず。
クラスインスタンス変数
Ruby ではすべてがオブジェクトなので、クラスもClassクラスのオブジェクト。つまりクラスオブジェクト自体もインスタンス変数を持つことができる。これがクラスインスタンス変数。
クラス定義式、クラスメソッドなど、selfがクラスを指すコンテキスト内で定義可能。
class ParentFoo
@class_instance_foo = 'class_instance_foo!'
def say
@class_instance_foo
end
def self.say
@class_instance_foo
end
end
class ChildFoo < ParentFoo ; end
ParentFoo.say #=> 'class_instance_foo!'
ParentFoo.new.say #=> nil
ChildFoo.say #=> nil
ChildFoo.new.say #=> nil
クラス変数との明確な違いは以下の２点かなと思われる。
まとめ
それぞれの特徴を把握して、明確な意図を持って使い分けていきたいですね。
今回は以下の書籍を参考にしました。
Railsでfakerのバージョンを上げたらspecが壊滅したけど設定で乗り越えたメモ
最近、Rails プロジェクト内で使用しているfakerのバージョンを最新(v1.4.3)に上げたら、今まで通っていた spec が壊滅したので、その際のメモです。
状況把握
こちらの記事に記述されているものと全く同じ状況に陥ったと思われます。
プロジェクト内の locale はデフォルトでI18n.locale = :jaにしていたので faker の locale も:jaにセットされ、その結果Faker::Internet.emailやFaker::Internet.urlが壊れたのだと思います。（前はv1.1.2ぐらいだったのですが、faker の locale 設定まわり変わったんですかね。。）
対策
プロジェクト内でfactory_girlも使用していたので、config/initializers/factory_girl.rbを用意して
if defined? Faker Faker::Config.locale = :en end
のようにしました。
わざわざfactory_girl.rbに設定している理由はfactory_girlを
$ rails c [1] pry(main)> FactoryGirl.create :user 以下略
のように develop 環境でも使うことを想定しているからです。
spec/factories/users.rbなどの factory の中で
FactoryGirl.define do
factory :user do
name { Faker::Name.name }
email { Faker::Internet.url }
end
end
みたいにガンガン faker 使ってたので、rails cで毎回、Faker::Config.locale = :enを呼ばないといけないのもダルいし。。
もし test 環境だけでいいやーって感じなら、spec/support/faker.rbなどに
RSpec.configure do |config|
config.before(:suite) { Faker::Config.locale = :en }
end
とかでもいいんじゃないかと思います。
まとめ
テスト落ちまくって心臓に悪かったけど、おかげでバージョンの違いで使えなかった faker のメソッドが使えるようになりました。
同様の悩みを抱えている方のお役に立てれば幸いです。
参考
git-new-workdirを導入してGitのブランチを複数同時に扱えるようにした
今、僕の仕事環境では「エンジニアそれぞれが作業用ブランチを切って開発を進め、Github に pull-req を出してレビューもらって、それが通ったらマージされる」、といったよくありがちなフローで開発を進めています。
で、今までは自分が開発をしている最中に同僚から pull-req が飛んできてレビューをしなくてはならなくなったとき、自分の作業を一旦git stashなり、git commitなりしてキリがいい状態にしてから、git checkoutしてレビュー、、のようなことをやっていました。
ですが、最近同僚にgit-new-workdirなるものを使えばそんなだるいことしなくていいよーって教えてもらったのでさっそく導入！！今回はその導入メモです。
git-new-workdir コマンドを使えるようにする
僕はhomebrewで git を導入してるのですが、git-new-workdir自体はすでに/usr/local/share/git-core/contrib/workdir/git-new-workdirにありました。
ただ参考記事を見る感じだと、コマンドはパスを通すなり、シンボリックリンクを貼るなりしないと使えないようなので今回は
$ ln -s /usr/local/share/git-core/contrib/workdir/git-new-workdir /usr/local/bin/git-new-workdir
して使えるようにしました。これで
$ git-new-workdir usage: /usr/local/share/git-core/contrib/workdir/git-new-workdir <repository> <new_workdir> [<branch>]
って出るようになりました！
ちなみにgit-new-workdirがない人はこことかから落としたりすれば大丈夫そうです。
実際に使ってみる
$ git checkout git@github.com:project_name.git(てきとーなproject） $ git-new-workdir project_name for_develop $ git-new-workdir project_name for_review
これで開発用のブランチで開発をしつつ、pull-req レビュー用のブランチでレビューできる環境ができました！
$ tmux new -s for_develop $ tmux new -s for_review
みたいにして tmux で切り替えて管理できるようにするといいかもですね！
ちなみに.gitignoreに指定されているディレクトリ、ファイルはgit-new-workdirでつくったディレクトリには反映されていないのでそこは注意。
まとめ
git-new-workdir便利！！他にもここで紹介されているようにgit-contribには便利なツールがいっぱいあるみたいなので、また試していきたいです。
参考
bundle openでgemのディレクトリを手軽にエディタから確認する
gem のソースって今まで基本 Github から確認していたのですが、実はエディタから手軽に確認できる方法がありました。地味に知らなかったです。
こちらの記事を参考にさせていただきました。
エディタの設定
環境変数EDITORにあらかじめどのエディタを開くのか設定しておく必要がある。自分の場合は vim を使うので、.zshrcに以下のように書いてあります。
export EDITOR=/usr/local/bin/vim
gem のディレクトリを開く
あとはbundlerさえ入っていれば準備 OK.
例えばdeviseを開く時は
bundle open devise
まとめ
最近 Rails の開発が続く日々ですが、こういう地味に知らないことがまだまだ沢山あるので習得していきたいです。
