コードリーディング

better_errorsは、Railsのデフォルトエラーページよりもエラーを詳細に表示し、デバッグを助けてくれるgemです。 github.com READMEにある通り、基本的にはdevelopment環境での使用が想定されています。 しかしながら、今回、test環境で有効にしていたことによりハマったことがあったので、記録として残しておきます。 何が起きたか テストを書いていたら、以下の状況になりました。 「例外を起こすことのテストで、RSpecで実際に例外が発生しているはずなのにraise_errorするとテストが失敗するぞ？」 ↓実際に書いたテストを簡略化したもの it do expe…

以下の記事は、Go言語のコマンドライン引数取得の仕組みを探究する流れを、ブログ形式でまとめたものです。筆者はもともとRubyでエンジニアをしており、GoでCLIツールを作ってみようと思ったときに「Goでのフラグパースはどのように実装されているのだろう？」という疑問をきっかけに調べ始めました。パッケージ構成と低レイヤー部分のコードも含めて理解できたので、とても勉強になりました。 この記事の最後に、今回登場した関数の呼び出し関係を示す Mermaid ダイアグラムを掲載しています。Goの flag パッケージがどのようにして os.Args の値を受け取り、flag.Parse() のタイミングで…

はじめに 前提となるマインドセット 具体的な Tips コードを読まずに理解する技術 とりあえず Clone する インタフェースで理解する テストコードで理解する 慣習名で理解する コードの詳細を理解する技術 デバッガを使う とりあえずサンプルコードを書いてみる 分からないなら聞く 初見コードに安全に変更を加える技術 インタフェースを明らかにする Stub としての実装を用意する Design Doc を書く テストを書く まとめ We are hiring !! エンジニア採用ページはこちら カジュアル面談もお気軽にどうぞ インターンも常時募集しています はじめに 京都オフィス在籍で、AI…

はじめに 先日、Railsガイドを読んでいたら、sandbox_by_defaultという設定がRails7.1から追加されたことを知りました。 本番環境での操作ミスを低減できるので良いなと感じ、早速業務で使っているアプリでもこの設定を有効にしました。 この設定ってどういうコードで実現しているんだろうというのを疑問に思ったので、sandbox_by_defaultのPRを見ながらざっくりRailsのコードリーディングしてみました。 github.com （まとめ）PRと関連のRailsコードを読んでわかったこと Railsでconfigを管理しているのはRails::Application::…

今年に入ってまた Ruby をメインで書くようになりました。 少しずつ Ruby 力を高めたいので、今回は Retryable という Gem をコードリーディングします。 github.com コード量も少なくて読みやすいです。 概要 Retryable は例外発生時に指定した回数 retry してくれる便利な Gem です。 option がいくつか用意されていて特定の例外だけ retry するようにしたり、sleep time を設定できたりもします。 サンプルコード 簡単なサンプルコードを書いてみます。 require 'retryable' require 'benchmark' c…

この記事について 想定読者 この記事を書いたきっかけ 具体的なやりかた 〜プロジェクト全体のコードベースを把握する方法〜 プロジェクトのディレクトリ構成に着目する プロジェクトで使われている主要なデータ構造を把握する 木を見ず森を見るように､大きなモジュール単位で読む コードを読む際に､併せて心がけたいこと アウトプットしながら読む 感想を持ちながらコードを読む 筆者固有の経験則 仕様書を重視しない プルリクエストレビュー時は､関連コードも確認する まとめ この記事について この記事では､全てのエンジニアが必ず行う｢コード読む｣という行為について､その重要性とノウハウを説明します｡ 想定読者 …

コードは他の人が最短時間で理解できるように書かなくてはいけない。 『リーダブルコード』 p3 今週、機能開発をしているプロダクトのコードを読んでいて、理解が難しく時間がかかってしまい、頭を悩ませていました。 何かヒントになるものはないかと『リーダブルコード』を眺めていて、「コードは他の人が最短時間で理解できるように書かなくてはいけない」という一文を見つけました。 www.oreilly.co.jp コードが「読んで理解できるか」にとどまらず「最短時間で理解できるか」という、積極的な目標になっているのが気に入りました。 既存のコードベースに機能追加するとき、既存のコードで理解に時間がかかるコード…