詩と創作・思索のひろば

ドキドキギュンギュンダイアリーです!!

オレ流 Pull Request 作業フロー

チームで作業する同じリポジトリの中で Pull Request を送り合うのではなく、オープンソースプロジェクトに外部から PR がやってくる場合の話です。

最近のフロー

送られてきた PR に対しては、大まかには仕様の話、実装方針の話、具体的な実装の話を詰めながらマージできるように持っていくわけだけれど、それがほとんど満足いく状態になっていてマージしたいと思うタイミングになっても、変数の名前付けだとか、ちょっとした処理の書き方だとかで、相手にお願いするよりは自分で手を加えてからマージした方が手っ取り早いことがある。そういう時は PR 元のブランチを手元にチェックアウトして、そのブランチを自分の変更で進めた上で master にマージするようにすると、push 時に PR も閉じられて便利です。

motemen/lgtm.sh#1 の例。分かりにくいれど、PR にさらに 1 コミット足してからマージしてる。

この際コードは fork された外部のリポジトリにあるから、たんに git checkout すればいいわけではなく予め git fetch なりする必要がある。

で、最近いろいろ試行錯誤した結果、以下のようにするとよさそうだった。

1. フォークされたリポジトリを、そのオーナー名で remote に登録する

git remote add -f jwerle https://github.com/jwerle/lgtm.sh.git

-f オプションで、登録後 git fetch する。

2. PR 元のリモートブランチを、ローカルにチェックアウトする

git checkout -b '#1-jwerle/master' --track remotes/jwerle/master

この際 #xxx をブランチ名に入れておくと、コミットメッセージなどにブランチ名が入った時に自動的にリンクになって便利(ありがたいことに # はブランチ名に使える)。また、このブランチで git pull すると、PR が更新されたときに最新のコードを取得できる。

3. ローカルにチェックアウトされたブランチの push 先を自分のリポジトリに変更

git config --local 'branch.#1-jwerle/master.pushremote' origin

これで、このブランチを変更したときに、自分のリポジトリに push することができる。この設定後も依然として git pull は相手のリポジトリから行われる。

hub-pr

一度以上のようにしてしまうと結構便利なわけだけど、セットアップに少し面倒がある。最近 PR を受け取ることが重なったこともあり、このへんの作業はもうフローが決まってるのでコマンド化することにした。ホントはちょっとしたシェルスクリプトに収めるつもりだったのだけど、なぜか色気を出してしまった……。yak shaving だけが人生だ。

motemen/hub-pr · GitHub

go get github.com/motemen/hub-pr で入手できます。

使い方

hub-pr checkout PULL_REQUEST_NUMBER

PR 番号を与えると、以上に書いたフローでブランチを作ってくれる。zsh 用の補完を用意してるので以外と簡単なのです。

f:id:motemen:20150324003457g:plain

あとは普通にマージしてやればいいのだけど、手元でマージするとあの GitHub おなじみのマージメッセージにならないので、それと同じものを生成するコマンドも用意しておいた。

hub-pr merge BRANCH

これであたかもマージボタンを押したかのようなコミットメッセージでもってマージされます。なんか便利ですね。ほかにも hub-pr browse っていう便利なのもありますが、オマケです。コンソールから PR やイシューを扱うなら、ghi ってのが圧倒的に便利。


このフローで作業したいと思う人がいるかどうかは分かりませんが……、どうぞご利用下さい。verbose output 的なオプションがないのでわりとブラックボックス感が高い。

Go で GitHub 用のツールを書く時は github.com/github/hub 以下のパッケージを使うとなかなか快適に行えるようでした。まあそりゃそうか。

GitHub実践入門 ~Pull Requestによる開発の変革 (WEB+DB PRESS plus)

GitHub実践入門 ~Pull Requestによる開発の変革 (WEB+DB PRESS plus)

秒速でLGTMするコマンド

LGTM するときはよさげなアニメーション GIF を探し出してきて lgtm.herokuapp.com にかけるのがデファクト[要出典]だけどこの「よさげなアニメーション GIF を探し出す」というのがくせ者で、大量のアニメーション GIF をブラウザで開くと CPU パワーを浪費するし選択にかける人的な労力もばかにならない。エコではない。そこで Tumblr のランダムな画像を LGTM 化するコマンドラインツールを書いた。その名も lgtm.sh だ。Tumblr には /random というエンドポイントがあるのでこれを利用して特定の Tumblr ブログ群からランダムに画像 URL を得ている。

./lgtm.sh -m | pbcopy

-m オプションをつけると Markdown フォーマットで出力する。つけない場合は画像 URL のみ。

LGTM

/random へのアクセスには少し時間がかかるのだけど、これを軽減するため、コマンドの毎実行時に同期的にアクセスするのではなく、実行後にバックグラウンドで HTTP GET してキャッシュ(次回の結果)を生成するようにしている。秒速たるゆえんだ。

実装は簡単なシェルスクリプトで、sites 変数を好きな Tumblr のリストにすることで生成される画像をカスタマイズできる。デフォルトではパブリックドメインのアニメーション GIF を利用するようになっているので、自分好みに編集してうまく活用してもらいたい。

motemen/lgtm.sh · GitHub

Go でコードを書く時のかゆいところに手が届く goquickfix というのを書いた

Go

go rungo test でコードを試しながら書きながら……というフェーズでは、以下のような状況によく遭遇することと思います:

  • デバッグプリント用のコードを削除したら、"log" や "fmt" パッケージが不要になって imported and not used: "log" と言われた。まだ使うかもしれないのでいちいち消したくない。
  • 同様に、コードを整理したところ使っていない変数がでてきて i declared and not used と言われた。まだ使うかも(ry

出来上がりのコードの品質を高く保つには便利な機能ですが、試行錯誤をしている段階ではけっこうな障害になります。そこで goquickfix

go build が通らないコードに goquickfix をかければ、コードを書き換えて go build 可能にしてくれます:

goquickfix -w hoge.go

やっていることは簡単で、エラーを起こす識別子の登場を blank identifier _ で抑制するだけです。 例えば以下のようなコードは、

package main

import (
    "fmt"
    "log" // <- imported and not used: "log"
)

func main() {
    nums := []int{3, 1, 4, 1, 5}
    for i, n := range nums { // <- i declared and not used
        fmt.Println(n)
    }
}

goquickfix -w 後以下のようなコードになります。

package main

import (
    "fmt"
    _ "log" // <- インポート文は残すけど名前を使用しない
)

func main() {
    nums := []int{3, 1, 4, 1, 5}
    for i, n := range nums {
        fmt.Println(n)
        _ = i // <- i はここで登場するのでエラーにならない
    }
}

goimports を愛用している人には、インポート文の書き換えは不要かもしれませんね。

もちろんその場しのぎの対処で、最終的には消したいコードです。-revert オプションを与えることで、goquickfix によって導入されたと思しきコードを取り除きます(たぶんそうだろうというコードを修正するようになっているので、完全に戻るとは限りません):

goquickfix -revert -w hoge.go

シンプルかつ便利ですね。

どうぞご利用下さい。これは gore の副産物でした。

motemen/go-quickfix · GitHub

The Go Programming Language (Addison-Wesley Professional Computing Series)

The Go Programming Language (Addison-Wesley Professional Computing Series)

コード補完もできる Go の REPL「gore」を作った

Go

タイトルの通りです。Go は LL 的に使える、とはよく申しますが、そういう意識で使っていると REPL 的なことをしたいときに困りがちですよね。そこで作りました。gore。いい名前ですね。

motemen/gore · GitHub

以下のスクリーンキャストでだいたいの雰囲気をお察し下さい。

gore screencast

(スクリーンキャストは cho45/KeyCast を使って撮影しました)

特徴

gore の特徴は以下の通りです。

  • ラインエディタと履歴
  • 複数行入力
  • パッケージのインポート、補完つき
  • 式および文を実行可能
  • コード補完(nsf/gocode を利用)
  • プリティプリント(k0kubun/ppdavecgh/go-spew がおすすめ)
  • ドキュメントも引ける(godoc が必要)

以上のように、非常に便利なものになっております。むしろこの程度 REPL には当然あってほしい機能だとも言える。

インストール

利用には Go 本体が必要なため、バイナリの配布はしていません。

go get github.com/motemen/gore

完全な機能のために、以下のライブラリも別途 go get しておくことをお薦めします。

go get github.com/nsf/gocode # 入力補完に
go get github.com/k0kubun/pp # プリティプリントに
go get golang.org/x/tools/cmd/godoc # ドキュメントに

使い方・機能

gore で起動すると、プロンプトが表示されます。Go の式や文を入力してください。入力された内容が値を返す式や変数の代入となる文であった場合には、よしなに値が印字されます。

gore> n := 1
1
gore> n+1
2

入力がうまく解析できなかったときはプロンプトが ..... となり、続けて入力できます。EOF(^D)でキャンセルします。

gore> even := func(n int) bool {
..... return n % 2 == 0
..... }
func(int) bool {...}
gore> even(4)
true

Go のコードではない指示は、コロンで始まるコマンドで入力できます。:help ですべてのコマンドを一覧できますが、よく使うのはパッケージのインポートを行う :import でしょう。

gore> :import strings
gore> strings.TrimSpace(" foo ")
"foo"

また :write コマンドで、REPL セッションで生成されたコードをファイルに保存することができます。

コード補完

エディタで Go を書いている人は gocode をインストールしていることと思いますが、gore もこれを利用してコード補完を行います。スクリーンキャストにあるように、適当なところで Tab キーを押すことでコードの補完がいい感じになされます。

プリティプリント

ppspew がインポートできる環境であれば、これらを利用して値の表示をおこないます。なければ fmt.Printf("%#v", ...) にフォールバックします。

ドキュメントを引く

:doc コマンドでドキュメントを引けます。名前だけでなく型も見てるので、ある変数のメソッドからドキュメントを引くということもできます。godoc コマンドが必要。

gore> :import encoding/json
gore> :doc json.Decoder
(godoc encoding/json Decoder)
gore> d := json.NewDecoder(nil)
...
gore> :doc d.Decode
(godoc encoding/json Decode)

他の REPL 実装との比較

Go の REPL を作ろうという試みは人類共通のようで、すでにいくつかの実装が存在しています:

以下、これらにの機能について簡単に gore と比較をした表です。

実装 値の表示 インポート 文の入力 アンドゥ 行編集 複数行入力
gore
go-repl
rango
igo
play.golang.org

補足

  • 「値の表示」とは 1 + 1 などと入力したときにその値が表示できること。対応していない実装では "1 + 1 evaluated but not used" などのエラーが表示され、fmt.Println(1 + 1) などとしなければいけません。
  • コード補完、色付きプリティプリントに対応しているのは gore のみです。

注意点

  • REPL といいつつ実は裏ではそれまでの入力を順番に実行するソースコードを生成して go run しているだけなので、どこかの時点で評価に時間のかかるコードを入力すると、その後の入力の評価にも時間がかかるようになります。

以上

紹介した機能のほかに、Go ではインポートしたパッケージが利用されていなかったり未使用の変数があったりするとエラーになる件の回避など、快適な REPL 体験のために細かく調整しています。どうぞご利用下さい。

いつも通りコードは GitHub 上にあります。不審な挙動があったら Issues よりお知らせください。

https://github.com/motemen/gore

Pocket の未読フィードを秘密の URL で公開するウェブサービスを作った

Pocket はあとで読むサービスで、とりあえずの URL を放り込むところとして使っているんだけど、これをほかのサービスとうまく連携しようとすると、IFTTT に対応していないところでは意外と面倒なときがある。今回は未読アイテムのフィードが欲しかった。

Pocket には RSS フィード形式で未読リストにアクセスできる機能がある(ヘルプ)のだけど、これは http://getpocket.com/users/username/feed/unread という URL に Basic 認証でアカウント名とパスワードを入力させるという形であったので、うーん……ちょっと使いたくない。認証を解除して全公開することも選べるが、自分がリストに何を入れているか知ってほしいわけでもない。こういう時はリセット可能な秘密の URL を作ってくれれば取り扱いしやすいだろ、というわけで作った。Pocket の API はシンプルでよい。

作ったのは Pocket Expose というウェブサービス。ログインすると自分用の URL が生成されます。プレーンテキスト(全件)、Atom フィード(最新 20 件)に対応。URL のリセットも情報の消去も簡単にできる。デザインは面倒なので Markdown 風です(笑)

ソースコードは GitHub に。

motemen/pocket-expose-web · GitHub

git-browse-remote で現在のブランチに対応するプルリクエストを一発で開く

マジで……というわけで、現在のブランチや作業ディレクトリなどをもとに いいかんじに GitHub (など)をブラウザで開いてくれる git-browse-remote にこれに対応する機能を追加したバージョン 0.2.0 をリリースしました。

インストール/アップグレード

RubyGems.org にアップロードされているので、

gem install git-browse-remote

でインストールできます。

使い方

git browse-remote --pr

とすると、現在のブランチから発しているプルリクエストのページ(/<user>/<repo>/pull/<branch>)をブラウザで開きます。プルリクエストが存在していればそのページ(/pull/<number>)に、存在していないときはプルリクエストの作成画面になるみたいです。何かにエイリアスしておくと便利ですね。

いまのところ GitHub (および GitHub Enterprise)専用の機能になるけど、Bitbucket にも同様の URL があったら対応できそう。

GitHub でイシューからイシューを作るときに便利な userscript

とくに GitHub を使って仕事をしていると、あるイシューからそのサブイシューを生成する機会がよくあって、そういう時はサブイシューから親イシューを(#765 のようにして)参照しておくと便利なのだけれど、イシューをまとめて整理しているときにはこの細かい作業が面倒。そこで userscript を書いた。

github-userscripts/refer-issue-when-creating at master · motemen/github-userscripts · GitHub

挙動は簡単で、GitHub 上のイシューや Pull Request のページ内にある「New Issue」ボタンをクリックしたとき、イシュー作成フォームの本文やタイトルに、もともとのイシューを参照するような内容がフィルインされるというもの。本文にはイシュー番号、タイトルには元のイシューの名前が入ります。このへんは人の好き好きだと思うので、各自カスタマイズするとよいと思う。また、ボタンのクリック時に選択していた内容がタイトルに付与されるというのもおまけでついてます。

以下のアニメーション GIF を見ればわかりやすい。

f:id:motemen:20150123135611g:plain

いつもどおり、利用するには chrome://extension に .user.js をドラッグ&ドロップすればよい(Chrome の場合)。どうぞご利用ください。