koheisg.dreamin.ccRSS

rspec-daemonの個人的な設定が決まった

RubyKaigi2024 お疲れ様でした。

別にRubyKaigi関係ないけど、 rspec-daemon の設定を今更してみたのでメモ。

ちょっとペアプロしたときに、動いてたはずのGuardが動かずファイル保存したらrspec実行みたいなことが上手くいかなくなっていた。

rspec-daemonは追加とかは公式ドキュメントを見ればいいだけなんだけなので、そちらに譲るとして、公式ドキュメントにはleaderで実行みたいなのしかなかったので、僕はこういう設定にして、保存したらrspecが実行されるようにしました。

vim.api.nvim_create_autocmd({ "BufWritePre" }, {
  pattern = {"*_spec.rb"},
  callback = function()
    local specfile = vim.fn.expand('%')
    vim.fn.system('echo ' .. specfile .. '| nc -v 0.0.0.0 3002')
  end
})

rspec-daemonはデーモンを $ rspec-daemon で立ち上げておきつつ、別でシグナルを送らないとrspecが実行されないのです。 が、逆に echo $specfile | nc -v 0.0.0.0 3002 の部分はデーモンが立ち上がってないと空振りしてくれるので、この設定で気に入りました。

Neovim って結構色々遊べそうですね。

shared_examples とshared_context の使い分けについて

Twitter眺めていると楽しい機能の話です。

shared_examples と shared_context は実装的には同じものですが、 個人的にはdescribeがテスト対象の明示、contextがテスト条件の明示で使い分けるのと同じように以下のルールでやっています。

  • itを共通化したいときはshared_examples
  • contextを共通化したいときはinclude_context
  • describeは共通化しない

shared_examples の使い方

Shared examplesのRSpec公式のドキュメント を見てみましょう。

RSpec.shared_examples "some example" do |parameter|
  \# Same behavior is triggered also with either `def something; 'some value'; end`
  \# or `define_method(:something) { 'some value' }`
  let(:something) { parameter }
  it "uses the given parameter" do
    expect(something).to eq(parameter)
  end
end

RSpec.describe SomeClass do
  include_examples "some example", "parameter1"
  include_examples "some example", "parameter2"
end

このようにinclude_examplesをすることで、テストする条件をまとめることができます。 include_examples は it_behaves_like と書いてもokです。

公式ドキュメントがわかりやすいですね! わかりやすいので、shared_examplesばかり使われている気がするぞ。。。

shared_context

次にshared_context。 以下はShared contextのRSpec公式のドキュメント の例を短く改変しています。*1

RSpec.shared_context "shared stuff" do
  subject { xxx }
  before do
    create(:stuff)
  end
end

require "./shared_stuff.rb"

RSpec.describe "group that includes a shared context using 'include_context'" do
  include_context "shared stuff"

  it "accesses the subject defined in the shared context" do
    expect(subject).to eq('this is the subject')
  end
end

個人的に上記のような shared_context はあまり好きではありません。 テスト対象であるsubjectやshared_methodがshared stuffの中に隠蔽されてしまっていて、何をテストしているかがわかりにくいからです。 私が書くなら以下のようになるでしょう。

RSpec.shared_context "shared stuff" do
  before do
    create(:stuff)
  end
end

require "./shared_stuff.rb"

RSpec.describe "group that includes a shared context using 'include_context'" do
  subject { nanika }

  include_context "shared stuff"

  it "accesses the subject defined in the shared context" do
    expect(subject).to eq('this is the subject')
  end
end

「subjectを毎回書かなくちゃいけない!」と思うかもしれませんが、テスト対象は毎回定義しません? じゃないと、何をテストしているかわからなくなってしまいます。 もちろんshared_contextに引数で毎回差し込むこともできるのですが、それだとsubjectを書くのと何も変わらないので、subjectは毎回書くようにしています。

うん。わかりやすい。

まとめ

shared_exampleはsystem specの権限管理的や暗黙的にテストしておきたいときに自動で発火するように仕込むのに便利です。*2 ちょっとしたテストのDRYのために、shared_exampleを使ってしまうとテストコードが変更に弱くなってしまうので注意しましょう。

一方shared_contextは「ある条件のユーザーを作る」や「ユーザー1でログインする」など再現性のある「条件」を作成するのに使うと便利です。 shared_contextはテスト条件を再利用するのに便利ですので、ちょっとしたテストのDRYのために使うことも多いでしょう。 このときに先述のsubjectを隠蔽するようなことをやってしまうと、私の経験上厄介なことになります。 *3

AAA(Arrange Act Assert)の考え方を知ってる人には、「あーAssertをshared_examplesで共通化して、Arrangeをshared_contextで共通化して、Actはベタで書くのね。なるほどね〜」となったと思います。

*1 shared_stuff.rbに shared_context 'shared stuff'が定義が省略されているので、それを個人的に解釈して補完して追記。 *2 暗黙的にテストしたい場合は、metadata を利用したものが便利です *3 その他には shared_contextもshared_examplesも別ファイルで管理することになるので、具体的な名前をつけたほうがいいよ!ってtwadaさんが言ってたよ! RSpec3で書かれた jnchito さんの記事 もあります。)

ModelのValidationのRSpecの書き方について

railsでテストコードを少なくする技術 - TDD on railsの間合い - Qiita

以前、上記のような記事を書きました。

「Model SpecやRequest Spec/Feature Spec(今ならSystem Spec)を中心に書いて、実装速度を上げていこう」という話でした。

その後、Ruby on Railsのコードを読み書きする中で、自分自信の考えが少し変化しました。ここで一度新しい僕のRuby on Railsでのテストとの向き合い方をまとめたくなりました。

いろいろと変化している部分があり長くなるので、今回はModel SpecのValidationの書き方を以前のコードと比べつつ見ていきましょう。

以前の記事に書いてあるModel Specのコード

前述の記事のvalidationのテスト という項目のコードです。(一部改変しています)

describe Post, type: :model do
  describe '#validate' do
    subject { Post.new params }
    context '全てのデータが正しいとき' do
      let(:params) { body: "iiyon" }
      it { is_expected.to be_valid }
    end
    context '正しくない場合' do
      let(:params) { body: "dame" }
      it { is_expected.to be_valid }
    end
  end
end

validateのテストは下記のように describe “#validate” の中に書くようにしています。 letにmodelの引数に渡したいものを定義して、contextの中で遅延的にletしなおします。 いつもこのパターンでテストを書いて、paramsのパターンを微妙に変更するようにしています。

この考え方は基本的には変わりません。タイトルがテストを少なくすると言っていますが、これだと結構テストコードが増えそうですね。Modelはしっかりテストしましょうという考え方なのだということもわかります。

今の考え方が投影されたModel Specのコード

上記のコードを今ならどのように書くのかは以下です。

describe Post, type: :model do
  describe '#valid?' do
    subject { Post.new(params) }
    let(:params) { { body: body } }
    
    context 'when body is ok' do
      let(:body) { "iiyon" }
      
      it { is_expected.to be_valid }
    end
    
    context 'when body is not ok' do
      let(:body) { "dame" }
      
      it do
        expect(subject).to be_valid
        expect(subject.errors.full_messages).to eq ['Body is shold be iiyon']
      end
    end
  end
end

ほとんど以前の記事と考え方は変わってはいないのですが、変わった部分に関して解説を行っていきます。

describe に対応する subject と context に対応する let

describe '#メソッド名' の直後に subject を持ってくるのは昔から読みやすくて好きなので、変わらずですね。better specなどでも紹介されている方法です。

subject { Post.new(params) } として params を一括で let に切り出しています。ここは多少の拘りがあって、差分だけを context 内の let に持っていきたいという気持ちの表明です。 仕様変更で追加の attribute が必要になったときに、読みやすくなることを期待しています。

エラーメッセージのテスト

続いて、大きく変わった部分はvalidationがエラーになるときに、必ずmessageエラーをテストするようになりました。

これがテストできていないと、view側でエラーになったときに予期せぬ表示になってしまいます。また、i18nなどを使っているとテストができる部分がなくなってしまうので、これを書くようにしています。このテストを書くようになってから、組み込みvalidationだからといって省略することは少なくなってきました。

そもそも、Validationのテストは shoulda matcher などに任せてしまう人も多いと思います。私は shoulda matcher が使えるテストなら、Railsが用意してくれているValidation用メソッドについてはテストを省略することが多かったです。 しかし最近ではRailsが用意してくれているValidation用メソッドであったとしても、テストを書くことが増えてきました。それは前述のエラーメッセージをテストしたいという理由です。

まとめ

以前の主張と比べて、少し保守的なコードを書くようになったように感じました。 しかし、以前の記事も「テストコードを少なくしたい」という欲は見えつつも、「十分にModelはテストするように」というように読めました。

大きく変わったのはデフォルトのValidationも好んで書くようになったことでしょう。エラーメッセージをテストする効果を体感することで、しっかりと書くようになりました。

入力値のvalidationはパラメータが増えれば増えるほど、掛け合わせの数も増えますし、特にRailsのValidationは ifオプション や with_options などがでてくると一気にどんどん肥大化していきます。 肥大化させないテクニックやValidationに頼らないようにするテクニックももちろんありますが、またValidatorクラスにロジックを移譲したり、Serviceクラスにロジックを移したりする際にもテストは非常に有用になってきます。

少し保守的な主張になったのは開発を進めていく中で、バグや設計ミスなど痛い目にあった部分が、テストにフィードバックされて、テストの書き方が変わったという意味で私の成長なのかもしれません。

想定突っ込み集

以下は今回の主張したい内容と少しずれるので、まとめより下においておきます。

described_class は利用しないのですか?

described_class は利用する時もありますし、利用しない時もあります。 チームのメンバーがRSpecの特有の記述方法を使うと学習コストが高くなってしまう場合は使用しません。利用する時の気持ちとしてはクラス名に自信がないときです。レビューのタイミングや実装の後半になってテストの中まで影響が及ぶのは避けるためです。

FactoryBot は利用しないのですか?

ここで大体の実装案としては let(:params) { attributes_for(:post) } という方式でしょうか。これについては使うこともあります。しかし、FactoryBotのデフォルト値に関しては変化したときにテストが落ちることを優先したいため、あえてパラメータを自分で指定してテストする形にしています。 また subject { build(:post) } とする方法もありますが、こちらについてもValidationをテストする時に限ってはオブジェクトを自分で作ってテストをする形を採用することが多いです。

context は英語で書くようになったのですか?

英語で書くことが増えましたし、rubocop-rspec に指摘されるので、合わせてしまっています。日本語よりも目的語が見やすい気がしています。

describeが #valid? なのに subject { Post.new } なのが気持ち悪いです

わかりますが、 be_valid を使いたくて、このようにしています。 be_valid の方がテストが落ちたときの情報が多くて好きです。

突っ込み集まとめ

この辺りは好みの問題ですので、チームメンバーの意向と私の考えるメリットデメリットをすり合わせながら進めています。

DHHが選んだ『最も参考になった技術書 5選』と、その道標

Ruby on Railsの作者であるDHHは、2012年に投稿されたブログポストの中では5つの技術書を紹介しています。タイトルは『The five programming books that meant most to me』。

日本語でいうと「私がもっとも参考になった技術書 5選」といったところでしょうか? どのような本を選んだのかと、その本に関するエピソードや読み方?のようなものを書いていきます。

5つの本は以下になります。名著と呼ばれるものが並んでいますね。

ちなみにどの順番に読むべき?というtwitterの質問にも答えています。

『Smalltalkベストプラクティス』 『リファクタリング』 『ライトついてますか』 『PoEAA』『DDD』 の順番のようです。

ちなみに私は 『DDD』『リファクタリング』『PoEAA』『ライトついてますか』『Smalltalkベストプラクティス』の順番で読みました。最初にDDDに手を出したのは今思っても難解だったなと思います。若手がDDDを好んで読む傾向にあるようですが、それより先に読むべき本があるのになぁといつも思ってしまいます 笑

それではDHHの読むべきおすすめ順に筆者の感想や書評も交えつつ見ていきましょう。 ※ 引用部分の()内の翻訳は筆者が機械翻訳を参考にしながら翻訳したものです。

Smalltalkベストプラクティス

オブジェクト指向の考え方にプラスして、Smalltalkで使うイディオムなどエレガントな書き方などが解説されています。解決したい問題に対して、こういう書き方をする良いという引き出し増やせる本ですね。特にSmalltalkやRubyのような表現力が豊かな言語にはこのようなタイプは打ってつけな気がします。

デザインパターンやオブジェクト指向の原則を重視したタイプ本よりも、このような現実問題に対する答えを導いてくれる本の方が私も好きです。これの他の言語版があれば読みたいなぁ。 とはいうものの、どんな言語を使っている方にもおすすめできる一冊であることは間違いありません。

DHHもこのように評価しています。

Incredibly practical advice for what constitutes good OO code. It’s done in Smalltalk, but the principles are mostly universal. Probably my favorite nuts’n’bolts of programming design book. Very granular.

(何が良いオブジェクト指向のコードを構成するかについて、信じられないほど実用的なアドバイスです。Smalltalk で書かれていますが、原則はほとんど普遍的です。プログラミングデザインの本の中では、おそらく一番好きな本です。非常に細かい。)

The five programming books that meant most to me – Signal v. Noise

リファクタリング

The fundamental before/after book.[...] The trick to reading this book is to carefully read through every single refactoring pattern and then try to apply it on your code base (you don’t have to commit if it doesn’t fix things). You can’t just blow through it or you won’t really learn it.

(基本的なビフォーアフターの本です。(中略)この本を読むコツは、リファクタリングのパターンをひとつひとつ丁寧に読み通し、自分のコードベースに適用してみることです(修正できない場合はコミットする必要はありません)。この本を読んでも、ただ読み通すだけでは、本当の意味での学習にはなりません。)

The five programming books that meant most to me – Signal v. Noise

私自身はこの本にかなり思い入れがありまして、時折読み直したくなります。 リファクタリング自体はこの本を読む前からやっていました。でも、この本と出会って優秀な先輩にペアプロしてもらっているような感覚があったのです。僕は虜になってこの本にある内容をじっくりと学習しました。また所属していたチームのメンバーでもRubyエディションの輪読会をやりました。議論があることでさらに理解が深まりました。これも読書会がおすすめの本です。

私はリファクタリングをした際のコミットメッセージにリファクタリングカタログの名前を利用することが多くあります。Extract XXX methods to YYY Class といった感じですね。(Rubyの場合はmethod)

この本を読もうとしたとき、現在では3つの選択肢があります。 第一版はJava、第二版はJavaScript、そして前述のRubyエディションはRubyで学ぶことができます。おすすめは第二版のJavaScriptですが、得意な言語で学べるのはとても良いことだと思います。

↑第二版JavaScript

↑第一版Java

↑Rubyエディション、プレミアがついて高いです。 復刊運動も展開されているので、無理して買う必要はないと思います。

ライト、ついてますか

プログラミングを仕事でやる上では、問題解決をするのではなく、問題発見をすることはとても大事です。DHHも以下のように評価しています。

Nothing has increased my programming productivity more than being able to restate hard problems as simple ones.

(難しい問題をシンプルな問題として復元できることほど、私のプログラミングの生産性を向上させてくれるものはありません。)

The five programming books that meant most to me – Signal v. Noise

ときに型破りな手法を盛り込んででも、支持を得たRailsの作者らしい言葉ですね。

この本の共著者のワンバーグやトムデマルコ本は今でもとても人気があります。私も今彼らの本を一つ一つ読んでいっている段階です。 wikipediaにもよいまとめがのっています。

PoEAAについて

DHHはPoEAA本を以下のように評価しています。

Great inventory of many of the patterns that underpin Rails itself, as well as descriptions of many of the “new” approaches that people advocate today (like transaction scripts and service layers). You won’t necessarily implement most of these patterns yourself, but it’s an invaluable resource to understanding the differences in architectures and why framework work the way they do

(Railsを支える多くのパターンと、人々が提唱している「新しい」アプローチの多く(トランザクションスクリプトやサービスレイヤーなど)について書かれています。必ずしもこれらのパターンの多くを自分で実装する必要はありませんが、アーキテクチャの違いやフレームワークがなぜそのように機能するのかを理解するための貴重なリソースとなっています。)

The five programming books that meant most to me – Signal v. Noise

『Rails自体を支える多くのパターン』を例に上げるとたくさんありますよね。ActiveRecordパターンをはじめ、フレームワークの足回りに必要なものがたくさんRailsに詰め込まれています。詳しくみていくのは別の機会に譲りたいです。

少し補足すると、この本は伝説の読書会が開かれていた本でもあります。 なぜ、伝説かというと参加者が錚々たる面子です。検索すれば当時参加されてた猛者の記事がたくさんでてきます。

アジャイルサムライの訳者でも角谷さん曰く、

高橋さんはもちろん、ひがやすをさんも来てくれてました。あとはt-wadaさん(和田卓人氏)とかogijunさん(荻野淳也氏)とか。伊藤直也さんも1回だけだけど来たことがあります。そういえばsecondlifeさん(舘野祐一氏)と初めて会ったのもこの読書会

よしおか×角谷対談「勉強会に眠る宝物」 - @IT自分戦略研究所

メガベンチャーのCTO経験者やOSSで成果を出されてる方がずらり。検索すると、ここに名前がないメンバーでも凄い方が参加されて、ブログを書いていたのがわかります。このころのブログ文化はほんとうに今のtwitterで一瞬で消費されてしまう文化とはちょっと違いがありますよね。

日本語で読む場合は翻訳が現在我々がよく使っている用語と少し違ったりします。 私は原著で読む挑戦をしたのですが、英語の穴を埋めるために、2016年あたりに読書会をクックパッド社やTMIX社で開いてくれていたころに参加しました。

1人で読むのがしんどい方はコミュニティの力を利用できるのも、現代のテクニックかもしれませんね。

洋書はこちら。

DDDについて

DHHはDDD本を以下のように評価しています。

It’s a slug to work through, but the ideas are worth it. It’s a great primer on how to turn a problem space into a beautiful OO domain model.

(読むのは大変だけど、アイデアに価値がある。問題空間をどのようにして、綺麗なオブジェクト指向的なドメインモデルに落とし込むことについての素晴らしい入門書。)

The five programming books that meant most to me – Signal v. Noise

これだけではRailsとDDDの関係を解き明かすことはできません。 まずはDDDでよく議論になる部分を整理するところから先にはじめ、またの機会に詳しくみていきましょう。

また読むのはわりと難しいです。私はこの本を読んで、長い間意味を理解できずにいました。 こちらもDDDコミュニティの力を使って読むのもよいかもしれません。自分の会社の有志で読書会もいいかもしれませんね。

まとめ

DHHが参考になった技術書を自分でも読みつつ、その技術書の評価と合わせて紹介しました。この記事を土台に、Railsと技術書の関係に迫る次の議論を別の記事で展開できればと思います。

補足

ちなみにDHHの記事日本語訳を書いてくれた方がいたと思ったのですが、もしご存知の方がいらっしゃったら @koheisg にリプライくださるとうれしいです。

system specとそのrandom落ち (flaky test) との戦い

randomにテストが落ちてしまう

どんな種類のテストでもrandomにテストは落ちてしまうことがあります。 Ruby on Railsを利用している場合にもっともこのような不安定なテスト (flaky test) になりがちなのは、Capybaraを利用したsystem test/system specではないでしょうか。 私がrandomに落ちるテストと戦った中で得た経験をここに記しておきます。

基本的に自前で sleep はしなくて良い

ページ遷移の直後や描画された直後にclick_linkやclick_buttonなどを実行すると、ブラウザの描画よりもブラウザを操作するテストの実行が早く走ってしまいrandom落ちを引き起こします。 そういうときの解決策として sleep 0.5 などとして、テストの実行を止めるアイデアを思いつくでしょう。

しかし、capybaraは Capbypara.default_max_timeout までは、対象のコンテンツを探してくれるメソッドが用意されています。 ですので、基本的に自前でsleepする必要はありません。

例をいくつか挙げておきます。

click_link '次へ' # ここでrandom落ちしたら
within '.some_dom' do # 次への親要素を探すまで待たせる
  click_link '次へ'
end
find('.next').click # 次へのリンクを探してからクリックする
expect(page).to have_content 'some content' # 画面遷移の直後の場合は expect も有効です
click_link '次へ'

within / find で超えられない壁

find('.some_dom').click # .next_domが表示される
find('.next_dom').click

このようにある操作をしてから、表示するコンテンツを操作する場合、capybaraの操作ブラウザの表示より早く、.next_dom が表示する前に .next_dom をfindして見つからずにエラーになることがあります。

find('.some_dom').click
Timeout.timeout(Capybara.default_max_wait_time) do
  loop until find('.next_dom', visible: false).visible?
end
find('.next_dom').click

上記のようにすることで、 .next_dom が必ずある状態を担保してからクリックすることができます。 ここで安易にsleepしてしまうと、時間がもったいないのでCPUのスピードでloopさせるというのがポイントです。

ただ Capybara.default_max_wait_time が長い時間設定されていると、本当に落ちるべきテストが落ちるまでの時間が長くなります。 --fail-fast なども活用しながら、できる限り短い時間を設定したほうがCIのスピードには寄与するでしょう。

楽観的UIの壁

楽観的UIとはクリックした操作のサーバー側の成否に関わらずユーザーにUI操作を続けさせるというものです。

  • 投稿ボタンをクリック
  • 非同期でサーバーにリクエスト
  • サーバーからのレスポンスを待たずに、投稿した内容を表示

というようなものです。

普通のUI操作のテストでは、サーバーサイドの変化については問題になりません。 しかし、サーバーサイドで発番されたデータなどを確認しないと、次のテストに移れいないようなテストもあります。 (本来テストとして別のシナリオにわけるべきですが、生成されるデータ複雑な場合などはfixtureを用意するコストが高い場合もあります)

click_button '投稿'
expect(page).to have_content 'thank you.'' # とりあえず投稿ボタンが押されたら表示される、成功したら裏でメールが送られる
visit post_path(Post.find(token: 'now_token')) # メールに乗っているリンクを押すには投稿の裏で生成されたpostが必要

そのような場合は wait_for_ajax のようなメソッドを作りましょうというのが慣例となっています。自分はjqueryが必要なこのギミックがあまり好きではないのですが、楽観的UIとサーバーサイドのデータを合わせ技で確認しないとできないテストでは仕方なく使いました。

click_button '投稿'
expect(page).to have_content 'thank you.'' # とりあえず投稿ボタンが押されたら表示される、成功したら裏でメールが送られる
wait_for_ajax # ajaxリクエストが終わるまで待つ
visit post_path(Post.find(token: 'now_token')) # メールに乗っているリンクを押すには投稿の裏で生成されたpostが必要
def wait_for_ajax
  Timeout.timeout(Capybara.default_max_wait_time) do
    loop until page.evaluate_script('jQuery.active').zero?
  end  
end

そもそも動いているDOMは表示されていてもクリックできないという壁

後述する参考文献をあたって欲しいのですが、そもそも動いているDOMはクリックできません。そこであまりにも動きが多いページのテストは以下を設定することで、解決するかもしれません。

Capybara.disable_animation = true

それでもクリックできない (sleep の方がましかも)

それでもclickに失敗することがあったので、こういうギミックに改良したりしました。。。画面先するまで押したる!ということです。

wait_for_path_change('next_path') { click '次へ' }
find('.next_path_dom').click
def wait_for_path_change(path, wait_time = Capybara.default_max_wait_time)
Timeout.timeout(wait_time) do
  yeild if block_given?
  loop until page.current_path == path
rescue TimeoutError => e
  pp e
  if block_given?
    yield 
  else
    raise e
  end
end

だいぶバッドノウハウになってきました。 素直に sleep 0.5 とした方が全体的なメンテのしやすさは秒数でできるので便利かもしれません。。。

まとめ

他にもランダム落ち。特にsystem specやjsを有効にしたfeature specでは苦しめられることが多いと思います。このように知見がたくさんでてくると嬉しいので、自分からシェアしてみることにしました。

補足(というかメモ)

ランダム落ちとの戦いのときは、、以下のコマンドを多用しました。

$ RSPEC_RETRY_RETRY_COUNT=0 rspec --fail-fast --order=defined

参考文献

Ruby on Railsでバッチ書く時どうするか問題

別に問題じゃなさそうなことに問題って名前をつけたのは公式で用意してくれているバッチインターフェースが二つあって、いつも迷っちゃうからだ。

$ rails foo:bar:baz

のようにコマンドを作れるのがrake taskです。 これは普通にrails db:migrateやrails g scaffold Fooのようにいろいろなところで開発者が使うからおなじみのコマンドです。

もう一つのインターフェースが、rails runnerと呼ばれるやつで、こちらは引数に自由にruby(しかもrailsの資産をつかった)のコードを書くことができる。

普通にバッチを書くならどっちでも問題ない

基本的にどっちを使っても問題はありません。しかしrails runnerを作るときはインターフェースを自分で考える必要があります。以前言及した記事としては app/batches 配下にバッチフレームワークのようなものを作り、 rails runner FooBatch.run のように書くものでした。

自前のバッチフレームワークのようなものが必要なのはひょっとしたら過去の時代の話かもしれません。例えばkuroko2やjenkins、rundeckのようなcron replacementと呼ばれるツール群を使えば、共通処理で書いていた排他制御やロギングなどをそちらに任せることができます。そしてkuroko2やjenkinsの先ではrailsの入ったdockerを実行させるようなことも簡単にできます。 また、dockerの話を続けるとk8sのcronojobを使えばGKEやAKSのサポートの上で、kuroko2で得ていた問題を吸収することができます。

rails runner と rake task のどちらを使おうとも、結局バッチを実行するツールが実行するインターフェースはdocker runのようなものだったりするわけです。

そもそもバッチっていつ書く?というもう一つの問題

そもそもrailsをつかっているということは、おそらくはWebサービスのバッチを動かすということだと思います。 基本的にバッチ処理にしなくてもバックグラウンドジョブを利用するようにした方が、エンドユーザーにとっては処理完了のタイムラグも短くsidekiqやrescueのようなワーカーを使えばリトライも自動的に行ってくれるというメリットがあります。

それでもバッチ処理はある時点で行う集計を伴う処理には必要なものであると言えます。

思考停止でバッチにやらせない判断をする

僕は新規のサービスに携わることが多いですが、ほとんどバッチを使う機会がなくなってきている印象にあります。集計は基本的にredashのようなツールを用いるため、railsが関与することは減らすことができています。

一方ジョブキューの処理はちょっとしたデータの更新や重い処理を行うのにも非常によく使うようになってきています。 例えばトランザクションに影響されないAPIコールなども可能な限りバックグラウンドジョブで行うようにしてretryの判断をジョブキューで行わせるようにしています。

これは月次や日次のバッチに書き直そうとなるときもあるのですが、一旦ジョブキューで行わせるように検討してから、時間がかかりすぎるからバッチにしましょうと後で移行することも増えてきました。

そこで浮上する第三のバッチインターフェース

これはバッチように作られたインターフェースではないのですが、activejobでバッチ処理をキックする運用をやって意外とうまくいくじゃんという成功体験がありましたのでシェアします。

namecpace :es do
  task index_rebuild: enviroment do
    ElasticSearch::IndexRebuildJob.perform_now
  end
end
class Elasticsearch::IndexRebuildJob < BatchJob
  def perform(foo)
  end
end

こんな感じでindex rebuildを最初は管理画面から実行して行っていたのですが、時間がかかるようになりワーカーサーバーとは別のコンテナで実行したいという要望がでてきました。 そこでrake taskから同期的にActiveJobを呼び出すという荒技をやってしまうと意外とバッチインターフェースとしてしっくりきました。

上記では BatchJob を継承していますが、rake taskでは難しかった処理の共通化をフックメソッド before_perform などを使って制御することも可能になります。

まとめ

ここ最近バッチ処理どうしようかなぁという人をちょいちょい見かけたので、だらだらと書いてみました。

さらば!fat controller - scaffoldで生成されたようなコントローラーを意識しよう!

流しのRails業でチームの中で共有したtipsをちょっとずつブログにも書いていくぞという。気持ち。 ちょっと初心者向けの話題のように思うかもしれないけれど、私もなんども苦しんだことなので。

$ rails g scaffold Book name:string price:integer

scaffoldでこのように生成したとしよう。 そうすると、BooksController#create は以下のように生成される。

# POST /books
# POST /books.json
def create
  @book = Book.new(book_params)

  respond_to do |format|
    if @book.save
      format.html { redirect_to @book, notice: 'Book was successfully created.' }
      format.json { render :show, status: :created, location: @book }
    else
      format.html { render :new }
      format.json { render json: @book.errors, status: :unprocessable_entity }
    end
  end
end

もう少し簡易化してみましょう。

# POST /books
def create
  @book = Book.new(book_params)

   if @book.save
     redirect_to @book, notice: 'Book was successfully created.'
   else
    render :new
  end
end

respond_toを排除し、HTMLしか返さないようにしてみました。 何の変哲も無いcreateアクションに見えるでしょうが、これがrailsのcreateの基本形です。全てのPOSTをこの形で書けるようにすべきです。

例えば、Serviceクラスを使う時はこうなっていると綺麗です。

def create
  if BookRegisterService.call(book_params)
    redirect_to :show, notice: 'Book was successfully created.'
  else
    render :new
  end
end

save modelのインターフェースを委譲されたmodelでデコレーターパターンを用いて実装すると、もっと元の形に近いままです。

def create
  @book = Manga.new(Book.new(book_params))
  if @book.save
    redirect_to @book, notice: 'Book was successfully created.'
  else
    render :new
  end
end

MangaはBookクラスから委譲されたインターフェースを持っています。

class Manga
  delegate_missing_to :@book
  def initialize(book)
    @book = book
  end
  def save
    # Manga固有のロジックをここに書く
    @book.save
  end
end

Formオブジェクトも似たような形にできます。

def create
  @book = BookForm.new(book_params)
  if @book.save
    redirect_to @book, notice: 'Book was successfully created.'
  else
    render :new
  end
end
class BookForm
  include ActiveModel::Model
  attr_accessor :name, :price
  def save
    if valid?
      # フォームが正しかった時の処理
      true
    else
      false
    end
  end
end

とりあえず、今日はここまでにしておきます。

意識低いrubocopの運用の仕方

rails 界隈では Sider の普及に伴い rubocop を業務で使っている方も増えてきたのではないでしょうか? しかしながら、一度荒れ果てた荒野にrubocopを放っても成果はほとんど上がらないことでしょう。 必要なのは、すべてのコードを綺麗にするぞ!という高尚な志ではなく、現実を少し改善すれば、それでOKという意識低い気持ちな気がします。

--lint オプション

rubocopには -l または --lint というオプションがあるのをご存知でしょうか? こいつはlintオプションと呼ばれるやつで、bugに繋がりやすい警告レベルを指摘してくれます。

こいつをまずデフォルトにしましょう。 .rubocop ファイルに --lint と記述すると、rubocopのコマンドが常に--lintオプションがついた状態で実行されるようになります。 .rubocop ファイルを使うことで、プロジェクトのメンバー全員がそのオプションをつけてrubocopを実行することができるため、「 rubocop -l と実行してください!」などと呼びかける必要がなく便利です。

rubocop_todo.yml と向き合う

次にこの状態で、rubocop_todo.yml を生成します。 rubocop --auto-gen-config

プロジェクトにこれ以上 --lint に違反するコードを入れないようにするためです。

rubocopを入れると、rubocop対応で色々と対応工数が増えてしまうと恐れている方もいらっしゃると思いますが、 この --lint オプションは宗教戦争的なものはほぼなく、バグに繋がる恐れがあるか?という観点での指摘です。

さて、auto-genされた rubocop_todo.yml には問題が山積です。 これらは指摘事項を修正していかなくてはなりません。

todoファイルと向き合いきれなかった場合

rubocop_todo.yml ではルールをファイルあたりで抑制してしまうため、 todoファイルを全部修正できない場合は、問題の箇所を特定してコメントアウトで警告を抑制する方法をとったほうが良いでしょう。 じゃないと、 rubocop_todo.yml に記載されたファイルは治安が悪化して行きます。

一日1cop修正

私のプロジェクトでは1日に一つだけ、これを実行していくことを行いました。 修正はコミットを細かく分けて、tmpブランチからcherry-pickをしてmasterにマージする量を調整する形をお勧めします。 (OSSである dev.to では一つのpull requestがマージされたら新しいpull requestを作るという方法をとりました。)

rubocop_todo.ymlを消すことができれば、これでとりあえずrubocop -lに適応した状態を作ることができたということです。

--lint 以外のオプションと向きあう

次の段階としてrubocop -lをやめて、rubocop.ymlを設定していくというステップがありますが、これは次回以降に。 まずは、--lintで怒られないくらいを目指すのはいかがでしょうか?

FactoryBot.lintの困るところ。

associationをデフォルトのfactoryではnilを渡す

一般的にFactoryBotは大きなプロジェクトになってくると無駄なデータを作成する可能性が増えてきます。 例えば、こんな時。

factory :tag do
  article
end

it do
  create_list(:tag, 10)
  # 10個タグがある場合のなんらかのテスト
end

articleがtagを複数持てるDB構造になっているとして、 tagが10個以上付いているページのfeature specなどを書きたい場合がある時に、 上記のような書き方をしてしまうと、tagが10個だけできればいいものの、articleも10個できてしまうのです。

これを抑制するために、

factory :tag do
  article { nil }
end

このようにartilceは敢えてnilを渡して、validateエラーが起こるようにしておきます。 そうするとうっかり、 create_list(:tag, 10) なんて書いてもテストが落ちるようになり、、

it do
  create(: article)
  create_list(:tag, 10, article: article)
  # 10個タグがある場合のなんらかのテスト
end

おそらく、このようなテストになってくれるはずです。

あくまでデフォルトの話であって、traitを使う分には特定のcontextの名前を入れることができるので、問題ないと考えています。

factory :tag do
  trait :with_article do
    article
  end
end

↑みたいなのはOK

FactoryBot.lintの困るところ

で、この方針でfactorybotを運用すると困ることがあり、、 FactoryBot.lintは factory_botで作成されたDBテスト用のファイルの治安を守るためのFactoryBotがデフォルトで持っているlint機構です。

factory :tag do

  article { nil }
end

何と、こんなFactoryBot.lintは許されないのです。 validateエラーを敢えて起こしているのに、validateエラーになっちゃう。

ので、 strategy: :build のオプションを使ったlintを実行しています。 しかしながら、buildのlintは意味があるような無いような。。。 そもそも、関連にnilを渡すようにするのって多分気持ち悪いって方が多い気もします。(僕も最近まではそうでした。

皆さんはどのようにFactoryBot.lintを運用されていますか??

2018年夏フロントエンド×Railsの事情

このテーマ。僕はずっとずっと悩んで来た問題です。railsdm周りで話題になってたっぽい。

ベストプラクティスというものはまだ見えない。 でも、いろいろな実績が出て来たし、自分でもいろいろやって見たのでまとめて行きたいと思います。

1. sprokets + turbolinks + webpacker + stimulus

basecamp wayですね。 それぞれハマりどころが多くrailsに精通していないと使いにくいと思います。 DHH信者にオススメの設定です。

気持ちはわかるけど、染まって見るのもなしではないかな。

2. webpacker + react(or other javascript view library) (+ some cssloader || sprokets)

部分的にreactなどのviewを使う設定。場合によってはcssもstylesheet_pack_tagを使うパターン。 個人的にはこのパターンってreact使う必要ある?という気もします。 が、例えばKPIに直結する非常に重要な機能だけをSPAにして、 UXを最大化するのに使える構成ではあると思います。

この場合はsproketsを捨てない方が無難な気もしますが、 reactの中でcssを使いたい場合や、依存ライブラリをいい感じにシュッとしたい場合はwebpackerに頼ってしまうのもいいでしょう。

3. webpack + rails(without sprokets and webpacker)

例えばsproketsを捨てるのようなやつ。 railsでレンダリングするのは完全に捨てないまでも、 webpackerを通じてwebpackをコントロールするのに融通が効かないのは嫌だという場合にオススメな構成。

確かにハッシュダイジェストは捨ててもええっすね。

4. webpack + rails api

railsは完全にapiに成り下がるパターン。 フロントエンドは完全にjavascript wayに集中できる。 しかしながらSPAで全部作るのは大規模案件には骨が折れる作業にはなりそう。 特に管理画面系なんかはまだrailsに一日の長がある印象。

管理画面は別でrailsでサクッとmicroserviceで作ったりrails engineを採用したり工夫すると工数の削減も進むかも。 BFFとしてのrails apiといったところ。

ただ、そもそもBFFをrailsがある必要がどこにあるだろう。 他の言語でもswaggerやgraphqlを利用すればrails並みに工数を削減することもできるだろうしね。

けど、それでもrailsがいいって時はこれが無難ですよね。

まとめ

個人的にはオススメは4。逆に1という手もある。 一般的には2,3が多いけど、2,3が最も辛い。

ブログを独自のCMSに移行しました

ブログ移管した

ブログを jekyll + github pages での運用から、独自のCMS(heroku + rails)に移行しました。

移管した理由

オンラインからサクッと編集したい

記事の雛形は make post みたいなコマンドを書いて、サクッと記事を書き始められるようにしてはいたのだけれども、、、 ちょっとした修正を出先や移動時間にするのにgithubに接続してブラウザから修正することにイライラしており、サクッと編集できるものが欲しかった。

jekyll疲れ

jekyllのプラグインとか拡張とかに限界を感じていた。

GitHub離れ

買収が発表される前から検討していたので、半分冗談ですが、移管完成がこのタイミングになったのはこれもある。 blogはコミットを外に公開したくなかったので、privateリポジトリで運用していましたが、 microsoft買収により自分が課金する必要もないかなと思いました。

このお金はherokuに払っていくぞ!頑張れheroku!

(あといくつかのprivateリポをgitlabかbitbucketに移管すれば、コスト削減も同時に達成できます。ありがとうmicrosoft。)

移管先の検討

wordpress

  • 拡張性は高いものの、拡張しすぎると辛そうなので手を出すのをやめました。
  • また移管したい気持ちになるので、その時は楽なんですけどね。

ブログサービス系 (medium/note/qiita/はてな/livedoor/line)

この辺りのツールはスマホからも修正がかなり簡単で圧倒的に使いやすいのです。 が、当たり前ですが融通が効かない点も多いので、断念しました。

自作

  • 最近メディア関連のお仕事が多く、blogに近いものをサクッと作れるノウハウが溜まってました。
  • あわよくば複数のメディアを同じblogツールを使って運用できるかもという下心が湧いてきちゃいました。
  • esaやkibelaやwikiツールも作りたくて同じような仕組みになりそうだから、とりあえず個人ブログだけ作ってみた。
  • 後述するURLそのまま移管を思いついたらサクッとできた

rails + herokuで自作しました

railsは自分のライスワークでありながら、ライクワークなので、 ブログを書きたくない時も、railsを書いてインプットができるのは良さそうと思いました。 あと、railsはブログみたいなツール作るのに向いてるんですよね。

以下、有益になるかもしれないことです。

markdownで記述は html-pipeline 周りでサクッと対応

html-pipeline というgemを使うとmarkdownをhtmlに変換するのは簡単です。 独自に拡張したい時もfilterをサクッと書くことができて最高です。

https://github.com/jch/html-pipeline

パーマリンクをそのまま移管

railsでブログ記事というとURLが /articles/1 みたいになりそうですが、 パーマリンクを過去の記事のまま移管する方法に rails engineを使用しました。 記事公開するためだけの rails engine を作り完全にroutesを分離し、それによりパーマリンクのためだけの一つのroutesを実現しました。

main appの config/routes.rb に下記を記述します。

  constraints(-> 'koheisg.dreamin.cc'.eql?(req.host)) do
    mount SomeEngine::Engine => "/"
  end

そして、SomeEngineのroutes、つまり some_engine/config/routes.rb に

get '/:permalink', to: 'articles#show', permalink: /[^\s]+/

と記述しました。

今後について

  • 頑張ってブログを更新する
  • ブログの機能の拡張をする (編集履歴の管理、複数ブログ、複数ユーザー、netlifyなどへのexport対応など)
  • テスト的にブログを使ってくれる人を募集する

という感じで考えてます。

Ruby on Railsのscaffoldを簡単にブラウザで作れるツールを作りました。

READMEとか全然充実してないし、まだまだ改善点もあるのですが、とりあえず公開しました。

http://koheisg.github.io/scaffold-generator/

名前の通り、scaffoldコマンドを生成してくれるツールです。

本当はjavascriptの最先端なツールを使ってみたかったのですが、jqueryとunderscoreで動いてます。

railsプロジェクトでgithubなどを利用する場合を想定しています。

webアプリを作るとき、大体は最初にモデルとルーティングの設計を行うと思います。

Railsはモデルの場合、DBの設計をした後、その設計でジェネレートをしてしまえば良いのですが。

rails初心者だとジェネレータのコマンドやrailsの型を覚えていなくて、わらわらすることがあると思います。

その時にこいつを使えばDB設計をするような感覚でブラウザから、プルダウンでポコポコできるかなと。

GithubやRedmineのissueに貼るとコマンドを実行する前にレビューもできますし、コマンド実行後でもpull requestの本文に貼るとレビュアーは嬉しいですよね。

今後やりたいこととしては、コマンドを書くとDB定義が生成されたり、railsの型だけでなくRDB側の型を見れるようにしたいなと思ってます。

あっ、その前にデータ長を指定できないのを最初にやろうと思っています。

何かご要望がありましたら、issueを切るかpull request頂ければと思います!!