2018.10.03 Ruby: Rubocopスタイルガイドの最近の更新: オプション引数 options = {} が非推奨化など github.com/rubocop-hq/rubocopより こんにちは、hachi8833です。以下の「Rubyスタイルガイド」記事の元であるRubocopスタイルガイドをチェックしたところ、いくつか追加更新がありましたので、スペースなどのトリビアな修正以外のものをリストアップしてみました。更新は以下のRubyスタイルガイドにも反映しました。 【保存版】Rubyスタイルガイド（日本語・解説付き）総もくじ 追加されたスタイル キーワード引数に関するスタイルが追加されています。Rubyコミッターが審議中の「キーワード引数の現状と将来構想 - HackMD」と直接関連しているかどうかはわかりませんが、いわゆる=を使うデフォルト値付き引数やopt={}のような

概要 原著者の許諾を得て翻訳・公開いたします。 英語記事: Why We Argue: Style — Sandi Metz 原文公開日: 2017/06/01 著者: Sandi Metz -- 名著『オブジェクト指向設計実践ガイド』の著者です。 本記事は私のChainline Newsletterで最初に公開いたしました。 私は長年の間、コードのことで議論になるのはなぜなのか、そして決定的に食い違う意見を建設的な方向に転換する方法はないものかと模索してきました。 私の見解は、非常に特異な文脈の中から生まれました。私は、ありとあらゆる業種の企業に出向き、数日間に渡るオブジェクト指向設計の講義を年に10回から12回は繰り返しています。私は部外者ではありますが、そうした場所で数日間を過ごすだけでも企業の裏舞台の一端を垣間見られます。 そのときに気づいたのですが、ある場所では誰もがおおむね幸せ

概要 原著者の許諾を得て翻訳・公開いたします。 英語記事: Class Methods In Ruby: a Thorough Review & Why I Define Them Using class << self 原文公開日: 2017/11/24 著者: Eliav Lavi Rubyのクラスメソッドをclass << selfで定義している理由（翻訳） https://pixnio.com/nature-landscapes/winter/landscape-sky-winter-snow-ice-water-tree-nature-outdoor-reflectionより クラスメソッドは私の同僚の間で常に議論や反論の種になっています。クラスメソッドは的確かつ有用と考える人もいますが、実際にはコードの読みやすさや管理のしやすさを損ないがちな邪魔者だと感じる人もいます。私はRu

1〜8: 型、参照、オブジェクト、配列、関数ほか 9〜14: クラス、モジュール、イテレータ、プロパティ、変数、巻き上げ 15〜26: 比較演算子、ブロック、制御文、型変換、命名規則ほか -- 本記事 概要 AirbnbによるJavaScriptスタイルガイドです。 MITライセンスに基いて翻訳・公開いたします。 英語スタイルガイド: airbnb/javascript: README.md 更新日: 2017/09/08 著者: Airbnb github.com/airbnbより 凡例 原文にはありませんが、項目ごとに目安となる分類を【】で示しました。 【必須】【禁止】：従わないと技術的な悪影響が生じる 【推奨】【非推奨】：技術上の理由から強く推奨される、または推奨されない 【選択】：採用してもしなくてもよいスタイル 【スタイル】：読みやすさのためのスタイル統一指示 【知識】：指示に該

2017.09.21 JavaScriptスタイルガイド 9〜14: クラス、モジュール、イテレータ、プロパティ、変数、巻き上げ（翻訳） 1〜8: 型、参照、オブジェクト、配列、関数ほか 9〜14: クラス、モジュール、イテレータ、プロパティ、変数、巻き上げ -- 本記事 15〜26: 比較演算子、ブロック、制御文、型変換、命名規則ほか 概要 AirbnbによるJavaScriptスタイルガイドです。 MITライセンスに基いて翻訳・公開いたします。 英語スタイルガイド: airbnb/javascript: README.md 更新日: 2017/09/08 著者: Airbnb github.com/airbnbより 凡例 原文にはありませんが、項目ごとに目安となる分類を【】で示しました。 【必須】【禁止】：従わないと技術的な悪影響が生じる 【推奨】【非推奨】：技術上の理由から強く推奨さ

1〜8: 型、参照、オブジェクト、配列、関数ほか -- 本記事 9〜14: クラス、モジュール、イテレータ、プロパティ、変数、巻き上げ 15〜26: 比較演算子、ブロック、制御文、型変換、命名規則ほか 概要 AirbnbによるJavaScriptスタイルガイドです。 MITライセンスに基いて翻訳・公開いたします。 英語スタイルガイド: airbnb/javascript: README.md 更新日: 2017/09/08 著者: Airbnb github.com/airbnbより 凡例 原文にはありませんが、利便性のため項目ごとに目安となる分類を【】で示しました。 【必須】【禁止】：従わないと技術的な悪影響が生じる 【推奨】【非推奨】：技術上の理由から強く推奨される、または推奨されない 【選択】：採用してもしなくてもよいスタイル 【スタイル】：読みやすさのためのスタイル統一指示 【知識

こんにちは、hachi8833です。 「Rubyスタイルガイドを読む」シリーズのバックナンバーを改定し、「Rubyスタイルガイド（解説付き）」と題して総もくじ記事といたしました。 本スタイルガイドの元になっているbbatsov/ruby-style-guideは、同じ著者によるRuboCop gemで使われているスタイルです。 誤りや原文の追加・更新にお気づきの場合は、末尾のフォームまたは@techrachoでお知らせください。 1. ソースコードレイアウト （1）エンコード、クラス定義、スペースなど 通し番号 カテゴリ スタイル

こんにちは、hachi8833です。Rubyスタイルガイドを読むシリーズは今回で最終回となります。 今後総集編として修正・アンカー追加などを行って1本の記事にまとめますので、今後はそちらをご覧ください。原文末尾のツールなどの記述は総集編に含めます。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 数値、文字列、日時（日付・時刻・時間） Rubyスタイルガイド: 正規表現、%リテラル、メタプログラミングなど 参照: bbatsov/ruby-style-guide ひとつの問題に突き当たると「おっしゃ、正規表現の出番だ」と考えるタイプの人は、問題を2つに増やす。 -- Jamie Zawinski 9-01【統一】「文字列変数['テキスト']」で単純な文字列を検索するのであれば正規表現にしないこと Don't use regular expressions

こんにちは、hachi8833です。「Rubyスタイルガイドを読む」シリーズもやっと終わりが見えてきました。 まとまりのよさから、今回は「数値、文字列、日付・時間編」といたしました。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: コレクション（Array、Hash、Setなど） 次回: Rubyスタイルガイドを読む（最終回）: 正規表現、%リテラル、メタプログラミング Rubyスタイルガイド: 「数値、文字列、日時（日付・時刻・時間）」 参照: bbatsov/ruby-style-guide 8-01【統一】整数値のチェックにはIntegerを使うこと Use Integer check type of an integer number. Since Fixnum is platform-dependent, checking against it

2017.03.27 Rubyスタイルガイドを読む: コレクション（Array、Hash、Setなど） 参照: bbatsov/ruby-style-guide 7-01【統一】配列やハッシュの作成は[]や{}によるリテラル表記が望ましい Prefer literal array and hash creation notation (unless you need to pass parameters to their constructors, that is). Array#newやHash.newによる作成は、コンストラクタにパラメータを渡す必要がある場合のみとします。タイプ量が少ないという点も含めて、リテラル表記に揃えるスタイルにしたということですね。 # 不可 arr = Array.new hash = Hash.new # 良好 arr = [] hash = {} 7-0

こんにちは、hachi8833です。Rubyスタイルガイドを読むシリーズ、クラスとモジュール編の次は例外処理編をお送りします。記事中で推奨されている「contingency method」という手法をこのスタイルガイドで初めて知りましたが、今後の例外処理で積極的に検討したいと思います。 前回: Rubyスタイルガイドを読む: クラスとモジュール（3）クラスメソッド、スコープ、エイリアスなど 次回: Rubyスタイルガイドを読む: コレクション（Array、Hash、Setなど） Rubyスタイルガイド: 例外処理 参照: bbatsov/ruby-style-guide 6-01【統一】例外処理ではraiseを使う方がfailより望ましい Prefer raise over fail for exceptions. # 不可 fail SomeException, 'message' #

2017.03.13 Rubyスタイルガイドを読む: クラスとモジュール（3）クラスメソッド、スコープ、エイリアスなど こんにちは、hachi8833です。Rubyスタイルガイドを読むシリーズ、今回は「クラスとモジュール編」その3をお送りします。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: クラスとモジュール（2）クラス設計・アクセサ・ダックタイピングなど 次回: Rubyスタイルガイドを読む: コレクション（Array、Hash、Setなど） クラスとモジュール（3）メソッドのスコープやエイリアスなど 参照: bbatsov/ruby-style-guide 5-16【統一】クラス変数（@@で始まる変数）はできるだけ避ける Avoid the usage of class (@@) variables due to their "nasty" beh

こんにちは、hachi8833です。Rubyスタイルガイドを読むシリーズ、今回の「クラスとモジュール編」の2回目に予定していた部分がかなりこってりしているので、3回に分けることにしました。よろしくお願いします。 今回取り上げるスタイルの多くは、設計で「不要なクラスを作らない」「不要な継承を作らない」ことに注目していますね。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: クラスとモジュール（1）構造 次回: Rubyスタイルガイドを読む: クラスとモジュール（3）クラスメソッド、スコープ、エイリアスなど 参照: bbatsov/ruby-style-guide 5-06【統一】クラス設計の階層はLiskovの置換原則に従う When designing class hierarchies make sure that they conform to the

こんにちは、hachi8833です。Rubyスタイルガイドを読むシリーズ、今回の「クラスとモジュール編」は2回に分けてお送りします。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: コメント、アノテーション、マジックコメント 次回: Rubyスタイルガイドを読む: クラスとモジュール（2）クラス設計・アクセサ・ダックタイピングなど 参照: bbatsov/ruby-style-guide 5-01【統一】クラス定義は以下の構造で統一する Use a consistent structure in your class definitions. クラス内要素の記述順序を示しています。 class Person # extendとincludeは他の要素より先に書く extend SomeModule include AnotherModule # インナーク

こんにちは、hachi8833です。前回の命名編に続き、今回のコメント編も英語圏に寄った指示が多く見受けられます。 このセクションで興味深いのは、「コメントを増やすよりコードを改善せよ」というメッセージ自体が繰り返し主張されていることです。 こうした指示は、本来であればそれこそスタイルに1行書いて簡潔に終わらせたいところだと想像できますが、どれほど口を酸っぱくして指示しても、結局多くの人が残念なコメント記法を使ってしまっているということなのでしょう。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 命名 次回: Rubyスタイルガイドを読む: クラスとモジュール（1）構造 コメント（comment） 参照: bbatsov/ruby-style-guide よく書けたコードは、それ自体が最も優れたドキュメントになる。コメントを追加する前に、もう一度自問して

こんにちは、hachi8833です。スタイルガイドを読むシリーズ、今回は「命名編」です。 Rubyは日本で生まれた言語でありながら、英語を強く意識した作りになっています。Railsではそれがさらに推し進められ、ActiveSupport::Inflectorで英語の活用形変換がさかんに利用されているのは皆さまもご存知かと思います。 命名編のスタイルでも同様に、英語圏を中心とした記述が多く見当たります。今回は変数命名に役立ちそうなことも書いてみました（「述語メソッド命名のヒント」）。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 文法（8）配列や論理値など 次回: Rubyスタイルガイドを読む: コメント、アノテーション、マジックコメント Rubyスタイルガイド: 命名 参照: bbatsov/ruby-style-guide 現実のプログラミングで本当に

こんにちは、hachi8833です。長くなりましたが、「Rubyスタイルガイドを読む」シリーズの文法編もやっと今回で終わりです。次回からの「命名編」もどうぞご期待ください。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 文法（7）lambda、標準入出力など 次回: Rubyスタイルガイドを読む: 命名 文法（8） 配列や論理値など 参照: bbatsov/ruby-style-guide 2-58【統一】文字列を引数に取るArray#*はわかりにくいので避け、Array#joinを使うこと Favor the use of Array#join over the fairly cryptic Array#* with a string argument. # 不可 %w(one two three) * ', ' # => 'one, two, thr

こんにちは、hachi8833です。 「Rubyスタイルガイドを読む」シリーズ、そろそろ文法編も終わりかと思いきやもう少し続きます。今回はlambda周りです。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 文法（6）演算子など 次回: Rubyスタイルガイドを読む: 文法（8）配列や論理値など 文法（7） lambda、標準入出力など 参照: bbatsov/ruby-style-guide 2-47【統一】Rubyインタプリタは常に-wオプションをつけて実行すること Always run the Ruby interpreter with the -w option so it will warn you if you forget either of the rules above! Rubyには他の実行系と同様に冗長モード（verbose mod

こんにちは、hachi8833です。 「Rubyスタイルガイドを読む」シリーズ文法編、第6回目をお送りします。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 文法（5）ブロック、proc 次回: Rubyスタイルガイドを読む: 文法（7）lambda、標準入出力など 文法（6） 演算子など 参照: bbatsov/ruby-style-guide 2-38【統一】分岐の条件部分で=による代入の結果を値として使う場合は、条件全体をかっこ( )で囲むこと Don't use the return value of = (an assignment) in conditional expressions unless the assignment is wrapped in parentheses. This is a fairly popular idiom

こんにちは、hachi8833です。 「Rubyスタイルガイドを読む」シリーズの文法編もいよいよ第5回目にさしかかりました。今回はブロックとProc関連です。 Rubyスタイルガイドを読む: 総もくじ 前回: Rubyスタイルガイドを読む: 文法（4）ループ 次回: Rubyスタイルガイドを読む: 文法（6）演算子など 文法（5） ブロック、procなど 参照: bbatsov/ruby-style-guide 2-32【統一】ブロックの各要素でメソッドを1つだけ呼び出す場合は、proc呼び出しのショートハンド「&:」を使う Use the proc invocation shorthand when the invoked method is the only operation of a block. Rubyを使い始めた頃はこの&:という書き方にちょっと戸惑いましたが、メソッドが1つ