リーダブルコードを久しぶりに読み返してみた

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

だいぶ前に読んだけど、すっかり内容忘れてたので久しぶりに読み返してみた。
もっと意識しないとなーとおもったことをコメントとともにつらつらとまとめる。

理解しやすいコード

読みやすさの基本
コードは他の人が最短時間で理解できるように書かなければいけない。

理解しやすいコードとは、文字数が短いコードではなく、理解する時間が短いコード。
ここでいう「他の人」とは、将来の自分の事でもあるので、たとえチーム開発してなくても注意すること。

名前に情報を詰め込む

• 明確な単語を選ぶ
  • 例えば、Getではなく、状況に応じてFetchやDownloadなどを使う
• 変数名に大切な情報を追加する
  • ミリ秒を表す変数名に_msをつける、など
• スコープの大きな変数には長い名前をつける
  • 長い名前、というよりは明確な名前、かな
  • 1,2文字の短い変数名を使うのはスコープが数行のときだけにする

誤解されない名前

例えば、get()やset()には軽量なメソッドが期待されていて、思わず頻繁に使用されてボトルネックになったりするのでメソッド名には注意する。

• 上下の限界値: max_, min_
• 包含的範囲: first, last
• 包含／排他的範囲: begin, end

コメントは正確で簡潔に

入出力のコーナーケースに実例を使う。

// 実例: Strip("abba/a/ba", "ab")は"/a/"を返す
String Strip(String src, String chars)

もちろん、テストを書けるのであればテストに入れたほうがいい。

制御フローを読みやすくする

条件式の並び順

if (length >= 10) か if (10 <= length)
だと前者のほうが読みやすい。

white (bytes_received < bytes_expected)
または、
white (bytes_expected > bytes_received)
これも、前者のほうが読みやすい。

左側	右側
「調査対象」の式。変化する	「比較対象」の式。あまり変化しない。

要は、英語の用法に合わせる。
（「もし君の身長が170cm以下なら」と「もし170cmが君の身長以上なら」）

短いコードを書く

身近なライブラリに親しむ

プログラマというのは、既存のライブラリで問題を解決できることを知らないことが多い。
たまには標準ライブラリのすべての関数、モジュール、型の名前を15分かけて読んでみよう。

車輪の再発明はしない。これはとても重要。

Railsを使っているとこれは特に顕著な気がする。

最近だと、prev_weekとかいう便利メソッドを知った。（active_support）

Time.zone.today.prev_week(:sunday) # 先週の日曜日
=> Sun, 10 Dec 2017

テストと読みやすさ

テストについては、rspecのdescribeやcontextを使えば文脈が読みやすいテストコードが書けるようになってるはず。

入力値を単純にする

テストには最もキレイで単純な値を選ぶ。

たとえば、
CheckScoresBeforeAfter("-5, 1, 4, -99998.7", "4, 3, 1")
のようなテストだと、-99998.7の主張が激しすぎてテスト内容に集中できない。

ここでは「マイナスの値を検証したい」とすると、

CheckScoresBeforeAfter("1, 2, -3, 1", "3, 2, 1")

のようにしてテストの効果を変えずに値だけ単純にできる。

テストに優しい開発

コードにはテストしやすいものとそうでないものがある。
テストしやすいコードには明確なインタフェースがある。
あとでテストをするつもりでコードを書くと、 テストしやすいようにコードを設計するようになる。
このようにコードを書いていけば、いいコードを書けるようになる。

テスト容易性の低いコード

• グローバル変数を使っている。
• 多くの外部コンポーネントに依存している。
• コードが非決定的な動作をする。

テスト容易性の高いコード

• クラスが小さい。あるいは内部状態を持たない。
• クラスや関数が１つのことをしている。
• クラスは他のクラスにあまり依存していない。高度に疎結合化されている。
• 関数は単純でインタフェースが明確である。

テスト容易性は設計の問題／利点にも直結してくるので意識する。

「テスト駆動開発」については、t_wadaさんの本を読んで勉強する。

テスト駆動開発

既存のコードを読みやすくする前にやること

既存のコードを読みやすくしたい衝動にかられても、とりあえずはガマンすること。
まずは、これから自分が触るコードを読みやすいコードにしていく。
それから、他の人のコードについても、同じく読みやすいコードにしていく。

ただ、たとえば変数名など（冒頭にある_msつける／つけないとか）細かい議論になりがちなものは、チームでコーディングルールを作ってから着手したほうがいい。

ひとまず開発チーム全員でこの本読んで認識合わせられると幸せになれそう。

WordPressでfacebookのoEmbed対応をする

WordPressが4.4からoEmbedに対応し、特に埋め込みコードを書かなくてもurlから自動で埋め込みコードを発行してくれるようになりました。

oEmbedって？

例えばTwitterのつぶやきをサイトに埋め込みたい場合、いままでこういう埋め込みコードをコピペしてたのが、

<blockquote class="twitter-tweet" data-lang="ja"><p lang="ja" dir="ltr">＼そろそろ本気出す／</p>&mdash; にっしー (@paranishian) <a href="https://twitter.com/paranishian/status/465847958143918080">2014年5月12日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

そのツイートのurlを貼っつけるだけで自動でoEmbedエンドポイントから埋め込みコードを取得して表示してくれるようになりました。

https://twitter.com/paranishian/status/465847958143918080
↓↓↓
<blockquote class="twitter-tweet" data-lang="ja"><p lang="ja" dir="ltr">＼そろそろ本気出す／</p>&mdash; にっしー (@paranishian) <a href="https://twitter.com/paranishian/status/465847958143918080">2014年5月12日</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

ただ、なぜかfacebookだけ対応しておらず、4.7にて対応予定となっています。。

#34737 (Add Facebook oEmbed support) – WordPress Trac

自分で対応しよう

WordPressのアップグレードは待てないので自分で先に対応しちゃいましょう！

GitHubで便利なスニペットが公開されてるのでそれを使うだけでOKです。

khromov/wp-facebook-oembed: Facebook oEmbed support for WordPress

<?php
function khromov_wp_facebook_oembed() {
    $endpoints = array(
        '#https?://www\.facebook\.com/video.php.*#i'      => 'https://www.facebook.com/plugins/video/oembed.json/',
        '#https?://www\.facebook\.com/.*/videos/.*#i'     => 'https://www.facebook.com/plugins/video/oembed.json/',
        '#https?://www\.facebook\.com/.*/posts/.*#i'      => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/.*/activity/.*#i'   => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/photo(s/|.php).*#i' => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/permalink.php.*#i'  => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/media/.*#i'         => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/questions/.*#i'     => 'https://www.facebook.com/plugins/post/oembed.json/',
        '#https?://www\.facebook\.com/notes/.*#i'         => 'https://www.facebook.com/plugins/post/oembed.json/',
    );
    foreach ( $endpoints as $pattern => $endpoint ) {
        wp_oembed_add_provider( $pattern, $endpoint, true );
    }
}
add_action( 'init', 'khromov_wp_facebook_oembed' );

こういうのはもっと早く対応してほしいですね〜。

参考

• oEmbedエンドポイント - ソーシャルプラグイン
• Embeds: Add support for embedding Facebook posts and videos via oEmbed. · WordPress/WordPress@07c31a5
• khromov/wp-facebook-oembed: Facebook oEmbed support for WordPress

URLからクエリ文字列（GETパラメータ）を抽出してハッシュにする

環境

$ rails -v
Rails 4.1.1
$ ruby -v
ruby 2.1.2p95 (2014-05-08 revision 45877) [x86_64-darwin14.0]

方法

例えば、URLからクエリ文字列を抽出する場合はURIを使えば簡単。

uri_str = 'http://sample.com/path/to/hoge?a=1&b=2'
uri = URI.parse(uri_str)
uri.query
#=> "a=1&b=2"

このクエリ文字列をハッシュにしたい場合はRack::Utilsを使います。

Rack::Utils.parse_nested_query(uri.query)
#=> {"a"=>"1", "b"=>"2"}

余談

このハッシュにいろいろ処理して、クエリ文字列に戻してみたり。

new_query_hash = Rack::Utils.parse_nested_query(uri.query) 
new_query_hash['a'] = 3
new_query_hash['c'] = 4
new_query_hash.to_query
#=> "a=3&b=2&c=4"

参考

parsing - Parse a string as if it were a querystring in Ruby on Rails - Stack Overflow