Clojureのライブラリを作成して公開するまで
記事の要約
Clojure初心者の投稿者が、Clojureのライブラリを作成してみる記事。
REPL上でクリップボードへのデータのコピー、クリップボードからのデータ取得（こちらはおまけ）を行うライブラリを作成している。
以下の内容を含んでいるので、ライブラリを作ってみたい人には参考になると思う。
- 自分で使うためのライブラリ作成方法。
- 作ったライブラリを使う方法。
- 作ったライブラリを公開する方法。
経緯
ClojureのREPLを触っているときに、マウスを使っていちいちコピペするのが面倒になったので、関数から気軽にクリップボードコピーできればいいな、と思って作成しようと思い立ったのが経緯。
macでいうところのpbcopyのような感じで、REPL上でコピーがしたかったのだ。
こういう感じのやつ。
$ cat file-name | grep pbcopy
実際にはREPL上で扱うのでシェルコマンドと全く同じとはいかないが、(clipboard-copy-function "want-to-copy-text")といった感じで使える関数を作成していく。
記事に書いた手順は、投稿者が「あとで手順絶対忘れるマン」なので結構詳細に書いており、記載が冗長かもしれない。
リポジトリの作成
まずGithub上でリポジトリを作成する。
GithubのマイページからRepositoriesを選択し、Newボタンをクリックする。
リポジトリの設定画面が表示されるので、各種設定を行う。
詳細は画像を参照。
リポジトリが作成された。
ローカル環境にクローンする
作成したリポジトリを、ローカル環境にクローンする。
リポジトリ画面で、<>Codeをクリックし、アドレスをコピーする。
ssh設定を行っているならSSHを、そうでないならHTTPSでいいと思う。
コピーしたアドレスを使用し、ローカル環境で以下のコマンドを入力する。
$ git clone <コピーしたアドレス>
# 例として、HTTPSだと以下の形式
# git clone https:githb.com/user-name/repository-name.git
# 例として、SSHだと以下の形式
# git clone git@github.com:user-name/repository-name.git
あとはクローンしたディレクトリをエディタで開く。
投稿者はVSCodeを使用しているので、以下のコマンドでディレクトリを開く。
# クローンしたリポジトリのディレクトリに移動する。
$ cd <repository-name>
# カレントディレクトリをVSCodeで開く。
$ code .
# 以下の形式でも開ける。
$ code <repository-name>
このあとはVSCode上のターミナルから操作を行う。
プロジェクトを作成
先ほど開いたディレクトリ内で、以下のコマンドを使用してプロジェクトを作成する。
$ lein new clj-clip
これで環境の準備がおわった。
あとは実際にコードを作成していく作業となる。
コードの作成
今回のライブラリについて
今回作成するライブラリの要件を整理しておこう。
といっても一つだけど。
- REPL上でクリップボードへ値をコピーをしたい。
追加で以下の要件も入れておくことにする。
- クリップボードから値を取得する。(REPL上で扱うかは微妙だが、対称性をもたせるために作成する)
つまり、クリップボードへの入出力をするライブラリを作成するということだ。
コードとして、これらの要件を満たすコードを書いていけば良い。
プロジェクトの説明文などを修正
さて、実際にコードを書く前にプロジェクトの設定を変更しておく。
project.cljの説明文とURLを変更する。
(defproject clj-clip "0.1.0"
;; :description "FIXME: write description" ; <= ここを変更
:description "A simple library for handling the clipboard within the Clojure REPL."
;; :url "http://example.com/FIXME" ; <= ここを変更
:url "https://github.com/kip2/clj-clip"
:license {:name "EPL-2.0 OR GPL-2.0-or-later WITH Classpath-exception-2.0"
:url "https://www.eclipse.org/legal/epl-2.0/"}
:dependencies [[org.clojure/clojure "1.11.1"]]
:repl-options {:init-ns clj-clip.core})
テストコードを書く
では、実際にコードを書いていこう。
まずはテストコードから書く。
やりたいことはクリップボードへのデータの出し入れだけなので、クリップボードからのデータ取得と、クリップボードへのデータの保存をテストする。
test/clj-clip/core.clj
(ns clj-clip.core-test
(:require [clojure.test :refer :all]
[clj-clip.core :refer :all]))
(deftest clipboard-test
(testing "クリップボードへのデータ保存と取得"
(let [data "Hello, clipboard!"]
(write-clip data)
(is (= data (read-clip))))))
write-clipとraed-clipは、存在するものとして呼び出している。
もちろん存在しない関数を呼び出しているので、テストを実行するとレッドバーになる。
レッドバーになったことを確認したあと、最小限のコードを書いてグリーンバーにしていく。
src/clj-clip/core.clj
(ns clj-clip.core
(:require [clj-clip.core-test :refer :all]))
(defn write-clip [data]
nil)
(defn read-clip []
"Hello, clipboard!")
TDD初心者のため厳密なTDDにはなってないと思うけど、いまだお作法がわかっていないので見逃して...
まさかりなげないで(`；ω；´)...
実装コードの中身を書いていく
テストが通ったので、あとは実装していく。
クリップボードからデータを取得するには、どのような関数やライブラリを使えばいいのだろうか?
調べたところ、java.awt.Toolkitを使うと良いらしいので、これを使っていく。
java.awtをインポート
さて、ではまずjava.awtをインポートする
(ns clj-clip.core
(:import [java.awt Toolkit]
)
クリップボードとのコネクションを取得
クリップボードへのコネクションはどのように張るのだろうか？
この記事によると、以下のコード例のようにクリップボードの取得をするらしい。
2行目のが今回欲しいコードだと思う。
String str = "Test"; // 保存するテキスト
Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
StringSelection selection = new StringSelection(str);
clipboard.setContents(selection, null);
これをClojureでも同じ様にやる。
(defn clipboard []
(.getSystemClipboard (Toolkit/getDefaultToolkit)))
これでコネクションを取得できた。
クリップボードにコピーするコードを書く
では、先程の引用コードをもとにして、同様にクリップボードへのコピーコードを書こう。
再度引用するコードの3行目と4行目が該当の箇所。
String str = "Test"; // 保存するテキスト
Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
StringSelection selection = new StringSelection(str);
clipboard.setContents(selection, null);
Clojureに直す。
;; importにStringSelectionを追加
(ns clj-clip.core
(:require [clj-clip.core-test :refer :all])
(:import [java.awt Toolkit]
[java.awt.datatransfer StringSelection])) ;; <= StringSelectionを追加>
;; 以下のコードを追加
(defn write-clip [text]
(let [clipboard (clipboard)
selection (StringSelection. text)]
(.setContents clipboard selection nil)))
ここまでの動作を確認
さて、クリップボードへのコピーコードは正しく書けただろうか？
テストコードで確かめたいが、これをテストコードで確認するのは難しいと考える。
なぜなら、クリップボードにコピーしたものを取ってこないと、ちゃんとコピーされたかがわからないからだ。
つまり、後ほど作る予定のクリップボードからの取得コードが必要なので、そこまで書かないとテストができないことになってしまうからだ。
ClojureやJavaのテストに詳しい人ならこの問題を解決する方法があるのかもしれないが、今の自分にはそこまで望めないので、手動でテストする。
REPLから呼び出して、貼り付けて目視確認すれば良い。
というわけで確認コードを書いて、確かめていこう。
(write-clip "Hello, Test!")
;; 手動でペーストした結果は以下になる。
;; Hello, Test!
テストが成功したので、クリップボードからデータを取得できることがわかった。
次にいこう。
クリップボードの内容を取得するコードを書く
さて、クリップボードからのデータ取得のコードを書いていこう。
再度、こちらの記事から該当しそうなコードを引用する。
Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
Transferable object = clipboard.getContents(null);
String str = "";
try {
String str = (String)object.getTransferData(DataFlavor.stringFlavor);
} catch(UnsupportedFlavorException e){
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
とりあえず、ほぼ忠実に書いてみる。
(defn read-clip []
(let [clipboard (clipboard)
contents (.getContents clipboard nil)]
(try
(when (.isDataFlavorSupported contents DataFlavor/stringFlavor)
(.getTransferData contents DataFlavor/stringFlavor))
(catch UnsupportedFlavorException e
(.printStackTrace e))
(catch java.io.IOException e
(.printStackTrace e)))))
書けたので、テストコードを実行して動作を確かめてみよう。
テストコードは以前書いたものをここで初めて使用する。
コード自体は再掲。
(deftest clipboard-test
(testing "クリップボードへのデータ保存と取得"
(let [data "Hello, clipboard!"]
(write-clip data)
(is (= data (read-clip))))))
実行したところ、ちゃんとテストも通ったので、クリップボードの内容を取得できることが確認できた。
リファクタリングでClojureらしいコードに
さて、今回書いたコードはClojureらしいコードだろうか？
Javaのコードをそのまま直したので、Clojuraらしいコードにはなっていないと思う。
しかし、Clojureのライブラリとして作るので、Clojureのお作法に乗っ取る必要があるだろう。
というわけでClojureらしいコードにするため、リファクタリングを行うこととする。
本来はコードレビューをしてもらって、フィードバックをしてもらうのだろうが、残念ながら投稿者はぼっち気質のため、気軽に話せるClojureに詳しい人はいない。
なので、chatGPT大先生にきいてコードレビューをお願いしよう。
ぼっちにも優しい時代になったものだ。
さて、色々とやりとりしてClojureらしいコードの書き方は教えてもらったが、途中は省略して結果のコードだけ示す。
;; 外部からは呼ばれないので、ローカル関数に変更
(defn- clipboard []
(.getSystemClipboard (Toolkit/getDefaultToolkit)))
;; クリップボードコネクションのローカル関数バインドを削除、直接生成するようにした。
(defn write-clip [text]
(let [selection (StringSelection. text)]
(.setContents (clipboard) selection nil)))
(defn read-clip []
(let [contents (.getContents (clipboard) nil)]
(try
;; whenではなくifに変更し、明示的に失敗した場合を処理するようにした。
(if (.isDataFlavorSupported contents DataFlavor/stringFlavor)
(.getTransferData contents DataFlavor/stringFlavor)
;; 失敗した場合のメッセージを出力
(println "String data not available in clipboard"))
(catch UnsupportedFlavorException e
;; printStackTraceを使わずに、明示的にログ出力したほうがClojureらしいので、明示的にログ出力。
(println "Unsupported flavor error" (.getMessage e)))
(catch java.io.IOException e
;; printStackTraceを使わずに、明示的にログ出力したほうがClojureらしいので、明示的にログ出力。
(println "I/O error" (.getMessage e))))))
テストコードを実行しながら変更したので、問題なくリファクタリングできた。
テストがあると変更にしやすいから本当にいい。
ライブラリの使用
さて、作ったライブラリを他のプロジェクトから使ってみよう。
ローカルリポジトリへの登録
使用するためにはローカルリポジトリへの登録が必要らしいので、登録していく。
登録にはlein installを使う。
このコマンドを行うと、ローカルのMavenリポジトリにライブラリがインストールされ、他のプロジェクトでも使えるようになるらしい。
$ lein install
# Created /Users/clj-clip/target/clj-clip-0.1.0.jar
# Wrote /Users/clj-clip/pom.xml
# Installed jar and pom into local repo.
ローカルのmavenリポジトリである~/.m2/repositoryに登録されるとのこと。
実際に確かめてみよう。
$ ls ~/.m2/repository | grep clj-clip
$ clj-clip
たしかに格納されている。
中身はどうなっているのだろうか？
$ tree ~/.m2/repository/clj-clip
/Users/.m2/repository/clj-clip
└── clj-clip
├── 0.1.0
│ ├── _remote.repositories
│ ├── clj-clip-0.1.0.jar
│ ├── clj-clip-0.1.0.pom
│ └── maven-metadata-local.xml
└── maven-metadata-local.xml
3 directories, 5 files
どうやら、jarファイルとしてリポジトリに登録されているようだ。
ローカルのリポジトリから読み込んで使用する
別のプロジェクトからローカルのリポジトリを読み込んで使用してみよう。
といっても、やることは普段と変わらない。
まず、project.cljに依存関係を追加する。
:dependencies [[org.clojure/clojure "1.11.1"]
[clj-clip "0.1.0"]] ; <= これを追加
それからleiningenに読み込ませる。
$ lein deps
# ちゃんと読み込まれたかは以下のコマンドでわかる
$ lein classpath
あとは、実際に使用する側で読み込んで使うだけだ。
;; import
(ns markdown-utils.core
(:require [clj-clip.core :as clip]))
;; write-clipを使用
(clip/write-clip "Hello from clj-clip!")
;; read-clipを使用
(println (clip/read-clip))
ライブラリのデプロイ
せっかくなので、つくったライブラリをClojarsにデプロイしてみよう。
Clojarsにユーザー登録をする。
Clojarsにユーザー登録する。
k
特に言うこともないので、これは省略する。
デプロイ用トークンを生成
Clojarsのダッシュボードから、デプロイ用のトークンを生成する。
Create Tokenをクリックすると、画面遷移してトークンが生成される (スクショをミスったので、スクショなし)。
トークンは一度しか表示されないので、手元に大事に保存しておくこと。
project.cljを更新
project.cljに以下の項目を追加する。
:deploy-repositories [["clojars" {:url "https://repo.clojars.org"}]]
デプロイコマンドの実行
$ lein deploy clojars
# ユーザー名とパスワードを求められる。
# ユーザー名はClojarsに登録したユーザー名を入力する。
Username: your-username
# パスワードは、Clojarsで作成したデプロイトークンを入力する。
Password: your-deploy-token
# デプロイ作業が行われる。
Created /Users/clj-clip/target/clj-clip-0.1.0.jar
Wrote /Users/clj-clip/pom.xml
Need to sign 2 files
[1/2] Signing /Users/clj-clip/target/clj-clip-0.1.0.jar
[2/2] Signing /Users/clj-clip/pom.xml
Sending com/github/kip2/clj-clip/0.1.0/clj-clip-0.1.0.jar (9k)
to https://repo.clojars.org/
Sending com/github/kip2/clj-clip/0.1.0/clj-clip-0.1.0.pom (2k)
to https://repo.clojars.org/
Sending com/github/kip2/clj-clip/0.1.0/clj-clip-0.1.0.jar.asc (1k)
to https://repo.clojars.org/
Sending com/github/kip2/clj-clip/0.1.0/clj-clip-0.1.0.pom.asc (1k)
to https://repo.clojars.org/
Could not find metadata com.github.kip2:clj-clip/maven-metadata.xml in clojars (https://repo.clojars.org)
Sending com/github/kip2/clj-clip/maven-metadata.xml (1k)
to https://repo.clojars.org/
デプロイが終わると、無事にClojarsにライブラリが登録される。
最後に
本当はローカルで利用できるところまで作る予定だったが、せっかくならとClojarsに登録するところまで冒険ができたので、楽しかった。
実際に作ることで、ライブラリ作者さんはこういった苦労をしているのだ、ということを知ることができた。
日夜苦労をしながら使いやすいライブラリを世に送り出している作者さんたちには、本当に頭が上がらないと思う。
今後は、より感謝しながら、ライブラリ作者の苦労に思いを馳せながら使っていこうと思いました。
しかしはじめてライブラリを作ったが、とても楽しい。
自分の感じた問題を解決するものを作るのも楽しいし、もしかしたらそのライブラリを人が使って役立ててくれるかもしれない、というのが、自分の問題と他人の問題がライブラリを通してつながっている感覚がするので楽しい。
みんなもライブラリ作ってClojureを充実させていこうよ。
自分で使うものを作って人に使ってもらうの、結構楽しいよ？
Discussion