Ruby

こんにちは、しきゆらです。
前回から2か月ほどたっていて驚いている今日この頃、いかがお過ごしでしょうか。

今回は、ちょっと前に書いた「【Ruby】YAMLに環境変数を埋め込む」で任意の文字列を環境変数に置換する方法をメモしましたが、そのちょっと発展した話です。
タイトル通り、YAMLにローカル変数を埋め込むにはどうすればよいかなぁ、と思って調べてみたら何とかなったのでちょっとメモしておきます。

Ruby

こんにちは、しきゆらです。
毎年12~2月は気分が落ち気味で何も手がつかない時期なんですが、今年は何もできてませんでした。
気が付いたら、前回の更新が11月ということに驚いています。

さて、今回はタイトルの通りYAMLに環境変数を埋め込みたいなぁと思って何とかしたのでメモしておきます。
YAMLは設定ファイルなどでよく作りますが、Gitで管理したいが重要項目は共有したくないことはよくあるかと思います。
こんな時、YAMLファイルを知っていそうな人経由で回していく運用とかをしているところもあるかもしれませんが、ずっとうまく回るわけはありません。
ということで、YAMLに必要項目を記載しておき、チーム内だけで見れるところに必要な情報を置いておけばよいだろう、という考えです。

方針としては、ファイルにそれっぽいマーカーをつけて置き、ファイル読み込み時に環境変数と置換してYAMLオブジェクトを作る感じです。
例としてはこんな感じ。

# YAMLファイルを文字列として読み込み
yaml_str = File.read("path/to/yaml.yml")
# ${ENV_VARIABLE}形式で埋め込んだ環境変数を置換する
yaml_str.gsub!(/\${\w*}/) do |matched|
  ENV[matched.gsub(/\W*/, "")]
end
 
# YAML文字列をオブジェクトに変換
YAML.safe_load(yaml_str, symbolize_names: true)

実際に挙動を見てみます。
上記のスクリプトを適当なメソッドにして動かしてみます。

 irb(main):001:1* def test(yaml_str)
 irb(main):002:2*   yaml_str.gsub!(/\${\w*}/) do |matched|
 irb(main):003:2*    ENV[matched.gsub(/\W*/, "")]
 irb(main):004:1*  end
 irb(main):005:1*
 irb(main):006:1*  YAML.safe_load(yaml_str, symbolize_names: true)
 irb(main):007:0> end
 => :test
 irb(main):008:0> test("token: ${SERVICE_TOKEN}")
 => {:token=>nil}
 irb(main):009:0> ENV["SERVICE_TOKEN"]
 => nil
 irb(main):010:0> ENV["SERVICE_TOKEN"] = "hogehoge"
 => "hogehoge"
 irb(main):011:0> ENV["SERVICE_TOKEN"]
 => "hogehoge"
 irb(main):012:0> test("token: ${SERVICE_TOKEN}")
 => {:token=>"hogehoge"}

${SERVICE_TOKEN}という文字列を環境変数の置換して、hogehogeという値を埋め込むことができています。
マーカーは自分で定義しているので、正規表現が書ければ好きな形式で表現できます。
本来はerbとかを使って埋め込んだほうがいらないバグが起きないかと思いますが、中でやっていることはこんな感じなので知っておくと便利かと思います。

今回は、ここまで。
おわり

RSpec,Ruby

こんにちは、しきゆらです。
少し前、レンタルサーバの支払いを忘れていて一瞬サイトが消えていました。
自分でもびっくりしました・・・。

さて今回は、というか今回もRSpecのお話。
ここ最近、お仕事で自分の書いている小さなスクリプトにテストがなくて怖いなーという思いが強くなりRSpecを書くことが多いので、その時のメモです。

最近書いているのは、Seleniumでとあるサイトで行っている操作を自動化するというもの。
どうしても外部サイトをあれこれするスクリプトを書いているとテストを書きにくいです。
ということで、直接サイトにあれこれする部分は最低限ログインできるかくらいしかかけていません。
どうするのがいいんでしょうか。

さて、Seleniumでブラウザを制御するときに困るのは、キャッシュやCookieなどの影響で挙動が変わること。
ログインしようとしても前回の残骸が残っていると何度も確かめることができない、なんていうこともあります。
そこで、タイトルの通りテストの時はプライベートモードで動いてほしいなーと思っていい感じに書く方法をあれこれ考えてできたものをメモしておきます。

RSpec,Ruby

こんにちは、しきゆらです。
今回はRSpecで特定の場合だけ動く・動かないようなテストを書く方法を知ったのでメモしておきます。

やりたいこと

ログイン周りのテストをCIで実行したくない

書いていたコードとしては、Seleniumを使ってWebサービスのテストを書いていました。
諸々のテストはいいんですが、ログイン周りのテストは2段階認証などがあるため、Waitをかけて人の手で操作していました。

このRSpecをCI上で動かそうとしたとき、ログイン周りだけは止めたい!
というのが一番初めにあったやりたいことでした。

特定のクラスを継承している場合は実行したくない

合わせて、コードの中で特定のクラスを継承している場合のみこのテストを実行したい、ということもありました。
RSpecはテストを共通化する仕組みがあるので、それを使ってテストコードを共通化していたのですが
一部共通化していたテストの中で、ちょっとまずい事態が出てきました。
上記に関連してSelenium周りなんですが、Seleniumを使うクラスとSeleniumを使わないクラスが出てきたことで共通化していたテストの一部がSeleniumを使わないクラスでは必要なくなるということが起きました。
共通化していた部分を分けてSelenium用の共通コードとSelenium使わないクラスの共通コードに分ければいいんでしょうが、両方とも分類的には同じくくりなので名前を分けるだけだと、名前が似てしまってごちゃっとしてしまいそうでした。

これを回避するために、共通化しているSpec側で実行されているクラスを判定して、必要ない場合は実行しないような世界を作りたかったんです。
こちらも併せて方法が分かったのでメモしておきます。

Ruby

こんにちは、しきゆらです。
今回は、Rubocopの更新を追っていたときに初めて知ったことをメモしておきます。

Rubocopさんは、Rubyを書く方は大半使っているのではないか、と思われる静的コード解析ツールです。
設定により、メソッドの長さやネストの深さなどを制限することで読みやすいコードを書く手伝いをしてくれる頼もしいツールですね。

そんなRubocopさんですが、先日0.90.0がリリースされました。
使っているGemの更新履歴をある程度追っているため、更新内容を確認していたところ今回の更新でも新しい項目が追加されていました。
それが、Lint/UselessMethodDefinitionです。

There are at least 2 cases:
・empty constructors – this may be just overriding parent’s constructor, but this is bad anyway
・methods just calling super

https://github.com/rubocop-hq/rubocop/issues/8472

ということで、空のinitializeメソッドやsuperしか呼び出していないメソッドを怒ってくれるというものです。
内容的には妥当なcopではないかと思います。
必要ないものは書くべきではないですね。

Ruby

こんにちは、しきゆらです。
今回は、タイトル通り`URI.join`の挙動で詰まったのでメモしておきます。

URI.joinとは

join(uri_str, *path) -> object
文字列 uri_str と path … を URI として連結して得られる URI オブジェクトを返します。

https://docs.ruby-lang.org/ja/latest/method/URI/s/parse.html

ということで、URIの文字列にpathを良しなに結合してくれるメソッドです。
しかし、単に`/`を付けるだけの挙動をしているわけではありませんでした。

Ruby

Rakeといえは、RubyでかけるMakefileのようなもの。
しかし、私はMakefileを書いたことがないので、単にRubyでちょっとしたタスクをコマンドとして呼び出せる便利ツールくらいに思っている。

このRakeだが、タスクの追加方法や設定等について調べて出てくるのはどうしてもRails環境が多い。
railsは内部的にはRakeを呼んでいる(?)っぽいので、しょうがないといえばしょうがないが、素のRubyでRakeタスクを作って実行する方法をメモしておく。

準備

Rakeといっても、Gemとして配布されている。
default gemとしてすでに入っているとは思うが、必要であればGemfileに入れてあげるとよい。

gem "rake"

そしてbundle install
ほかのGemと同じなので困ることはないはず。

Rakefile

基本的にはRakefileにタスクを追加してあげればよい。
Railsと同じようにlib/tasks/*.rakeという感じでタスクを個別のファイルで定義したい場合はRakefileに以下のように書いてあげればよい。

Dir["./lib/tasks/*.rake"].sort.each {|file| load file}

注意としては、requireではなくloadということ。
Railsさんも、内部でload使っているし、そういうことです。
(#TODO: 理由は後ほど調べる)

個別のタスク

個別は、普通にタスクを定義してあげればよい。

 namespace :task do
   # シンプルなタスク
   desc "test"
   task :test do
     puts "test task!"
   end
   
   desc "引数ありの場合"
   task :arg_task, [:hoge] do |_, args|
     puts args[:hoge]
   end
 end

ファイル名ごとにnamespaceを切ってあげると、タスク名に困ることはなくなると思います。

そして、rakeタスクを実行するときに引数を渡して実行することができます。
例えば、bundle exec rake task:arg_task[hogehoge]とするとコマンドラインから値を渡すことができます。

二つ目のタスクの通り、タスク名の後に配列で引数の名前を付けてあげる。
そしてブロックに2つの変数を作ってあげて、二つ目の変数に引数が入ってくるので指定した名前でアクセスすると取得できます。

まとめ

今回は、非Rails環境でRakeタスクを追加する方法をメモしておきました。
覚えておくと、ちょっとしたコマンドをRuby/Rakeで作れるので便利です。

RakeタスクはRails環境でしか使ったことがなかったので、素のRubyでも使えることが分かったのと、
ついでに実行時に引数を渡す方法もわかったので、簡単なコマンドをRakeで実装できるようになりました。
Rubyで良しなにスクリプトを書いた後、コマンドっぽく実行したいときに使えそうですね。

今回はここまで。
おわり。

Ruby,Windows,環境構築

こんにちは、しきゆらです。
ちょっと前まで気が狂うかと思うくらい雨続きでしたが、今度は溶けるほどの暑さにやられています。
良しなに均していただけないものかと毎年思っています。

昔、【Ruby/Win】Windows上のAtomからWSL2上のrubocopを利用するという記事にて、Windows上のAtomからWSL上のRubocopを使って文法チェックを行う方法をメモしました。
しかし、現在ではうまく動かないようです。
そこで、執筆時現在動作する方法をメモしておきます。

linter-rubocopにて以下のように指定してあげるだけ。

これにて、設定完了。
では動作確認してみます。

きちんと動いてくれているようです。
これにて、Windows上にRuby環境を構築せずともWSL上のRubocopを使ってチェックすることができるようになりました。

今回は、短いですがWindowsのAtomからWSL上のRubocopを使ってコードチェックを行う方法を改めてメモしました。
同じように設定すれば、ほかのツール等も利用できるのではないかと思います。

それでは、今回はここまで。
おわり

Ruby,読書

こんにちは、しきゆらです。
今回は、人生初の洋書である「Effective Testing with RSpec 3」を購入したので、洋書ってどうなの?というところをメモしておきます。

購入した本

購入したのは、先述の通り「Effective Testing with RSpec 3: Build Ruby Apps with Confidence」です。

数年前に発売されたRSpecの本です。
RSpecの書籍といえば、長年参照されていたのは「The RSpec Book」ではないでしょうか。

これは、日本語で読める数少ないRSpecの書籍ですが、内容としてはRSpecよりもCucumberなどの別ツールの話が多いことや、バージョンが古いなどの理由で、純粋にRSpecについてきちんと学ぼうと思って買うにはちょっとなぁ、という印象でした。

そんな中で発売された「Effective Testing with RSpec 3: Build Ruby Apps with Confidenc」。
こちらは英語ではありますが、RSpec 3で書かれており、純粋なRSpecについての説明がメインなのでRSpecを学ぶ上ではよさそうな本です。

しかし、洋書ということでハードルが高そう。
私もそう思っていました。
そんな中で、なぜ買ったのかをいかにまとめておきます。

洋書を買ってみて

そもそも、洋書とはいえ今回購入したのはRuby/RSpecの本です。
小説などと違い、スクリプトが読めればたいていの内容は理解できるはずです。
そんな軽いノリで買ってみました。

あとは、以下のブログを読んだから。
【洋書Q&A】どうやって洋書を読んでるの?どれくらい時間がかかるの?という質問に答えてみた – give IT a try | https://blog.jnito.com/entry/017/09/12/072903

正直に言うと、翻訳されたら買おうと思っていたのですが一向にそのような話が出てこないので早く読みたい、というモチベが勝ってしまった形です。

実際に読んでみると、英語が苦手な私でもある程度雰囲気で理解できている印象です。
要所でサンプルコードを提示してくれているので、単語がわからないから理解できない、ということはあまりありません。
単語的にも比較的簡単なほうなのではないでしょうか。

まだすべてを読み切ったわけではないので、内容的な話は控えますが
洋書を読むというハードルは思っているより低いようです。
洋書を買うという心理的なハードルを越えることができれば、意外とすんなり進んでいけそうな印象でした。

まとめ

今回は、人生で初めて洋書を買ったので、買うまで思っていたことや読んだ印象をさっくりメモしておきました。
洋書に手を出そうかと考えている方の参考になれば幸いです。
(そもそも、情報がほぼないですが・・・)

今回は、ここまで。
おわり

Ruby

こんにちは、しきゆらです。
今回は、タイトル通り非Railsアプリのデプロイ作業をCapistranoで自動化するための手順をメモしておきます。

Capistranoといえば、Ruby製のデプロイツールです。
A remote server automation and deployment tool written in Ruby. | https://capistranorb.com/

Capistranoさん自体はRubyやRails専用ではなく、様々なものをデプロイすることができるように設計されています。
とはいえ、調べて出てくる情報の大半はRailsのデプロイについてばかり。
Sinatraのデプロイすら情報が少ないような状態です。
そんな中で、非Railsどころかただ単にCronなどで定期実行するだけの簡単なスクリプトを自動でデプロイするのを自動化する情報なんて見つけるのが難しい。

ということで、今回はフレームワークを使っていないただのRubyスクリプトをCapistranoを使ってサーバへデプロイする方法をメモしておきます。