ぽよメモ

ファッション情報学徒の備忘録.

ghq管理下のリポジトリを色々するAlfredWorkflowを作った

色々するとは言っても基本的に何かで開くだけです.

きっかけ

最近ghq*1リポジトリを管理,pecoで開くというスキーム*2が流行りだという情報を耳にしたので導入してみたところかなり快適になりました.
Windowsでも同様のことが出来るというのが嬉しくて,ついつい散らばりがちなリポジトリたちをちゃんと管理していこうという気持ちが芽生えました.

開発でメインで使用している端末はMacBook Proなのですが,せっかくAlfredがあるのだからterminal以外からでも叩けると嬉しいなという気持ちで作り始めました.

環境

今回もGoで書いています.Workflowを使うだけであればGoの環境もGlideも必要ありません.ghqは必要です.

ghq-alfred

リポジトリは以下になります.

github.com

準備

現在最新のworkflowは以下からダウンロードできます.

Release v0.2.0: Actual 'First Release' · pddg/go-ghq-alfred · GitHub

インストールしたら設定画面を開き,Workflow Environment Variableghqの値を環境に合わせて設定してください*3
また,こちらでは使用するエディタとしてVS Code,ターミナルアプリにiTermを指定していますが,環境に合わせて指定してください.

できること

ghq list -pの結果と入力したクエリを元にリポジトリを絞り込みます.ghq {query}で検索を掛けます.

Finderで開く

選択してEnterまたはCommand+EnterでFinderで開きます.

f:id:pudding_info:20170924014501g:plain

ブラウザで開く

選択してShift+Enterでデフォルトブラウザでそのリポジトリのページを開きます.

f:id:pudding_info:20170924014623g:plain

ターミナルで開く

選択してFn+Enterでターミナルで開きます.僕はiTermを指定していますが,標準のterminalでも問題なく表示できるかと思います.

f:id:pudding_info:20170924014803g:plain

エディタで開く

選択してControl+Enterでエディタでそのリポジトリディレクトリを開きます.僕はVS Codeを指定していますが,大抵のエディタで可能かと思います.

f:id:pudding_info:20170924015028g:plain

Googleで検索

{user名}/{repository名}で検索をかけます.

f:id:pudding_info:20170924015133g:plain

できないこと

  • 上に書いたこと以外の全て.

既知の不具合

ghqではgit config --global --add ghq.root path/to/dirでデフォルトのroot以外にもリポジトリの入ったディレクトリを指定し参照できます.
が,このときghqの形式,つまり{root}/{site}/{user}/{repo}の形を取っていないディレクトリも含めることが出来てしまいます.

このWorkflowではフルパスから推察してそのリポジトリをbitbucketやgithubで開く設計になっているため,そういった形式のリポジトリ

  • ブラウザで開くことが出来ません.
  • Google検索も上手く機能しません.
  • Alfredでの表示が{user}/{repo}になりません.
  • Finderで開く,エディタで開く,などの動作は愚直にパスを渡すだけの設定になっているため問題なく動作いたします.

今のところghqディレクトリ形式を取らないリポジトリに対する動作を保証する予定はありません.

改善したいこと

アイコンをflaticonからお借りしているのですが,黒の部分以外が透過処理になっているため見づらい…
探してはいるのですが,あまりよい代替品を見つけられていません.何か良いアイコンをお知りでしたら,教えて頂ければ幸いです.

あと1日で書いたコードなのでバグなどがあるかと思います.見つけたらできればgithubの方まで…

まとめ

pythonrubyでScript Filterを頑張って書くよりも,Goで書いたバイナリを叩く方が気兼ねなく色々できて良いんじゃ無いかと思います.
ghqは便利なツールなのでid:motemen氏に感謝しつつ使わせて頂いています.

Alfredはいいぞ.

*1:motemen.hatenablog.com

*2:blog.craftz.dog

*3:AlfredのScript Filterではbashなどで設定したPATHが読み込まれません.環境の違いを吸収する手段も色々考えましたが,一度設定するだけなので諦めてこの形をとりました.

Entrykitのrenderで遊ぶ -後編-

頑張りすぎじゃ無いか感が溢れてきます.

発展的な記法

環境変数からの値の取得しか存在しないわけでは無く,色々できます.

include

これは比較的便利に扱えるのでは無いでしょうか,templateのモジュール化ができます.また,第二引数以降に"VAR=VALUE"の形で渡すと,includeするtemplateの中からvar "VAR"などとして値を取り出すことが出来ます.

ここではecho '{{ var "INCLUDED" }}' > include_test.tmplとしてincludeするtemplateを作成しておきます.

{{ include "include_test.tmpl" "INCLUDED=True" }} # -> True

file, text

ファイルの中身を読みとって文字列として展開します.例えばecho "hello world" > hello.txtとしてテンプレートと同じ階層に置いたとします.

# file
{{ file "hello.txt" }} # -> hello world

# text
{{ text "hello.txt" }} # -> hello world

ソースを読む限りこの二つの内部的な実装は全く同じに見えます*1

dir, dirs, files

引数として任意のディレクトリへのパスを渡します.文字列を返すわけでは無いことに注意してください.

# 指定されたディレクトリ中のディレクトリ・ファイルの名称の配列を返す
{{ dir "./" }}

# 指定されたディレクトリ中のディレクトリのみの名称の配列を返す
{{ dirs "./" }}

# 指定されたディレクトリ中のファイルのみの名称の配列を返す
{{ files "./" }}

存在しないディレクトリを参照しようとするとnot foundなエラーを発して中断します.

httpget, urlquery

APIリクエストしたりすることができます*2ca-certificatesをインストールしていないとエラーを吐いて死にます.

{{ httpget "http://search.twitter.com/search.json?lang=ja&rpp=20&q=%23poyo" }}

注意すべきなのは,返すオブジェクトが文字列では無いことでしょう.Goのオブジェクトが返却されるため,htmlがそのまま出力されるわけではありません.

json, tojson

ではAPIリクエストしたところでどうするんだという話ですが,これでjsonオブジェクトに変換できます.

{{ httpget "http://search.twitter.com/search.json?lang=ja&rpp=20&q=%23poyo" | json }}

これもまた返り値はGoのオブジェクトなのでノイズが混ざっています.純粋にレスポンスを記述するだけなら以下の様にします.

{{ httpget "http://search.twitter.com/search.json?lang=ja&rpp=20&q=%23poyo" | json | tojson }}

tojsonはgoのオブジェクトを受取り,jsonをstringにして返します.

yaml, toyaml

jsontojsonyaml版です.

split, join

stringから配列を生成することができます.

# 配列の生成
{{ split "a,b,c,d" }} # -> [a, b, c, d]

# 任意のセパレータで区切った文字列に変換
{{ split "a,b,c,d" | join ":" }} # -> a:b:c:d

splitkv, joinkv

少し難解で使いどころがよく分からないですが,splitjoinが配列を扱うのに対してmapを扱います.

# mapの生成
{{ split "\n" "a=A,b=B,c=C" | splitkv "=" }} # -> [a=A b=B c=C] 

# mapの値へアクセス
## mapを変数へ代入
{{ $map_var := (split "\n" "a=A,b=B,c=C" | splitkv "=") }}
 ## アクセス
{{ $map_var.a }} # -> A
{{ $map_var.d }} # -> <no value>
## 代入はできないようでエラーを吐く
{{ $map_var.d := "D" }} # -> unexpected ":=" in operand

# 任意のセパレータで文字列にする
{{ joinkv ":" $map_var }} # -> [a:A b:B c:C]

joinkvは直接文字列を返すわけではなく,key{{任意のセパレータ}}valueの形で文字列化し,その配列を返します.全体を文字列にするにはさらにjoinをはさむ必要があります,

seq

数値の配列を作成します.引数に数字(intまたはstring)をとり,0からその値までの配列を作って返します.

{{ seq 10 }} # -> [0 1 2 3 4 5 6 7 8 9 10]

append, drop

配列のへの値の追加,削除ができます.

# 数値でも
{{ seq 10 | append 11 | drop 1 }} #-> [0 2 3 4 5 6 7 8 9 10 11]

# 文字列でも
{{ split "," "a,b,c,d" | append "e" | drop "a" }} # -> [b c d e]

index

配列への添字アクセスができます.

{{ index (seq 5) 1 }} # -> 1

第一引数に配列を取ることに注意が必要です.また,index {{任意の多次元配列}} 1 2 3などは{{任意の多次元配列}}[1][2][3]と同義になります.

sh

もはやなんでもありですが任意のコマンド実行が出来ます.出力された値が文字列として取得できます.

{{ sh "ping -c 1 www.google.com" }}

sigilにはあるが使えなかったもの

  • jmespath

jsonからクエリを使って値を取り出すことができるようなのですが,renderではnot definedと言われてしまいました.

組み合わせる

ファイル一覧でループ

配列の生成ができることから,色々なループ処理が可能になります.例えば任意のディレクトリ内のファイル一覧に対して,*.logの場合には監視対象に加える,などといった処理が可能になります.

{{ range $index, $f := (files "/path/to/log") }}
{{ if match $f "*.log" }}
    something $f to do
{{ end }}

環境変数を判定

()を用いるとだいたいなんでもできるので,例えば環境変数も(どっかのQiitaではできないとか書いてましたが)ifで用いることが出来ます

{{ if eq "test" (var "TEST") }}
  This is test.
{{ else }}
  This is not test.
{{ end }}

まとめ

もっと色々やろうかと思ったけど力尽きた.

*1:textの方は何かエラー処理のコードが入っていますが,エラーがnilかどうかを判定して受け流しているだけのように思います.

*2:例ではTwitter API 1.0を使用しているので普通にエラーメッセージが返ってきます

Entrykitのrenderで遊ぶ -前編-

Dockerコンテナでsedで頑張っているみんながたどり着くところ.

Entrykitとは

github.com

たぶん僕がかいつまんで紹介するよりもこちらの記事の方が全体の紹介がしっかりされているのでこちらを読んで頂ければ良いと思います.

qiita.com

今回扱うのはそのうちのrenderで,シェルスクリプトで頑張っていたところをGo言語のtemplate機能で楽にやろうというものですね.

できること

  • 環境変数からの値の埋め込み
  • ifによる条件分岐
  • rangeによるループ
  • template中での変数の宣言と使用
  • ファイルの読み込み
  • インターネットリソースの取得
  • 任意のコマンド実行結果の取得

できないこと

もし以下のことも可能であるならコメント等で教えて頂きたいです.

  • template中での四則演算
  • 改行モードの変更*1

環境

ここでは以下の様なDockerfileのコンテナを用意し試しています.

FROM alpine:latest

ENV WORKDIR /workdir/
ENV ENTRYKIT_REPO progrium/entrykit
ENV ENTRYKIT_VERSION 0.4.0
ENV ENTRYKIT_DL_FILE entrykit_${ENTRYKIT_VERSION}_Linux_x86_64.tgz

RUN mkdir ${WORKDIR}

RUN apk --update --no-cache add wget ca-certificates\
    && wget --no-check-certificate \
    https://github.com/${ENTRYKIT_REPO}/releases/download/v${ENTRYKIT_VERSION}/${ENTRYKIT_DL_FILE} \
    && tar xvzf ${ENTRYKIT_DL_FILE} \
    && rm ${ENTRYKIT_DL_FILE} \
    && mv entrykit /bin/entrykit \
    && chmod +x /bin/entrykit \
    && entrykit --symlink \
    && apk --no-cache del wget

WORKDIR ${WORKDIR}

CMD ["render", "test.conf", "--", "cat", "test.conf"]

カレントディレクトリに試したいtest.conf.tmplというテンプレートファイルを用意してコンテナの/workdirにマウントして実行すると最後にrenderした結果を出力してくれます.

$ docker run --rm -v $PWD:/workdir {{ビルドしたコンテナ}}

基本文法

基本的な文法はGoのtext/template*2と同じです.それに加えていくつかの特殊な文法を使用することが出来ます(ここではそれらの区別に関して言及しません).ここではそれらのうちの基本的な部分を示します.
ちなみに,内部的にはSigilというテンプレートエンジンを使用しているため,Goが読める人はこっちを読んだ方が早いかも知れません.

github.com

パイプライン

実行結果をチェーンすることができます.前のコマンドの実行結果が,最後の引数として与えられます.つまり,

{{ did hoge | do }}

という式は

{{ do (did hoge) }}

と等価です.

変数宣言

{{ $x := "hoge" }}

これでxという変数を宣言したことになり,以下の様に呼び出すことが出来ます.

{{ $x }} # -> hoge

ifなどの構文中でも使用できます.

var

環境変数から値を取得します.内部ではos.Getenv()しているだけなので,存在しない場合は空文字列が返ります.

{{ var "VARIABLE" }}

if

条件分岐が使えます.

{{ if expr1 }}
    expr1 is True
{{ elif expr2 }}
    expr2 is True
{{ else }}
    False
{{ end }}

また,比較演算子として以下のものが使用できます.

  • eq : arg1 == arg2 || arg1 == arg3 || …
  • ne : arg1 != arg2
  • lt : arg1 < arg2
  • le : arg1 <= arg2
  • gt : arg1 > arg2
  • ge : arg1 >= arg2

論理演算子の文法は以下です.

{{ if and expr1 expr2 }}
    expr1 and expr2 are True
{{ elif or expr1 expr2}}
    expr1 or expr2 is True
{{ end }}

{{ if not expr }}
  expr is not True
{{ end }}

ただしandを使用した場合,expr1,expr2はどちらも評価されます.

range

ループ表現が使えます.ただしこのexprはiterableなオブジェクトである必要があります.具体的には後編で記述します.

{{ range expr }}
{{ . }}
{{ end }}

{{.}}で現在参照しているオブジェクトを取得できます.

補助的な文法

これらの表現はいずれもパイプラインでチェーンして文字列を受取り,文字列を返します*3

default

値が存在しない場合,デフォルト値を設定します.

{{ var "NOT_EXISTS_VAR" | default "default"}}

capitalize

最初の1文字が小文字の時,大文字に変換します.

{{ "abcd" | capitalize }} # -> Abcd

lower

全て小文字にします.

{{ "AbCdEf" | lower }} # -> abcdef

upper

全て大文字にします.

{{ "AbCdEf" | upper }} # -> ABCDEF

replace

与えたテキスト中の特定の文字列を全て置き換えます.内部的にはstrings.Replace()しているだけなので,正規表現などを使うことは出来ません.

{{ "Target Text (old)" | replace "old" "new" }} # -> Target Text (new)

trim

文字列の両端から指定文字を取り除きます.具体的には内部でstrings.Trim()の第二引数に\nを渡しているので,改行コードと空白が両端から取り除かれます.
docker-compose.ymlなどでyamlで複数行の文字列を渡したときも全体の両端しか認識しないため,文中の改行は保持されます.

{{ "    a b c    " | trim }} # -> a b c

indent

二行目以降の先頭に特定の文字列を付加します.使い方がイマイチ分からないですが,第二引数で渡した文字列を\nを認識して分割,2つめ以降の要素の先頭に第一引数の文字列を付加します.

{{ "This is a pen.\nThis is not a pen." | indent "a" }}

結果は以下の様になります.

This is a pen.
aThis is not a pen.

len

文字列の長さを返します.

{{ "abcd" | len }} # -> 4

Sigilにはあるが使えないもの

  • substr

not definedと言われてしまいました.

改行の取り扱い

goのtemplateのように-で改行を制御することが(試した限りでは)できないようです.つまり,制御構文を書いた行は空行になってしまいます.

# 以下のif文をrender
{{ if eq 4 (len "abcd") }}
    This term has 4 characters.
{{ else }}
    This term has not 4 characters.
{{ end }}

上の様なコードをrenderすると以下の様になります.

# 以下のif文をrender

    This term has 4 characters.


あまり空行が問題になることは無いかとは思いますが,気になる場合は以下の様にワンラインで書く方が良いかも知れません.

{{ if eq 4 (len "abcd") }}    This term has 4 characters.{{ else }}    This term has not 4 characters.{{ end }}

前編まとめ

このように,いちいちsedでコンフィグを書き換えなくても.tmplファイルを用意すれば簡単に埋め込みが出来ます.
正直これくらいまでがこのツールの良い使い道でこれ以上は無理しすぎではという感じもしますが,一応出来るので後編で紹介していきます.

[ 2017/09/22 追記 ] 後編書きました.

poyo.hatenablog.jp

*1:Golangのtemplate機能ではここにあるように-の有無で改行を制御できるのですが,renderではinvalidだと怒られてしまいました. developers.eure.jp

*2:template - The Go Programming Language

*3:別に使い方としてそう決められているわけでは無いですが,主な使い方としてはそうなるでしょう.