lbtというgemを作って公開してみた
以前からLaTeXで効率的に書籍を作ることを考えていました。 特に大きな文書、例えば100ページを越えるような文書ではタイプセットに時間がかかるのが問題です。 それを解決するには
- 文書を複数のファイルに分ける
- ひとつのファイルだけをタイプセットしてその出来栄えをチェックする。 これによって、タイプセットの時間を短縮できる
ということが必要です。
そのためのツールとしてLaTeX-Buildtoolsというプログラム群を作ってきました。 最初のバージョンはBashスクリプト、2番目はRubyとRakeを使ったものでした。 今回、3番めのバージョンとしてgemにすることを考えました。 それによって、ツールのインストールが格段に易しくなるからです。
$ gem install lbt
この1行だけでインストールが完了します。
今回の記事は、この作業で得た知見をもとに、gemのビルドと公開について書きたいと思います。 なお、RubyGems.orgのガイドに分かりやすいチュートリアルがあるので、そちらをご覧になるのも有益です。
lbtはどんなgemか
本題に入る前にlbtがどんなものかを説明します。
$ lbt new sample
これでsampleフォルダができ、その中にmain.texやhelper.texといったテンプレートが生成されます。 テンプレート内のタイトルや著者を書き直します。 そして本文部分をchap1/sec1.tex、chap1/sec2.texなどのファイルに、セクションごとに作っていきます。 なお、「chap数字」は章を表すディレクトリで、「sec数字.tex」はセクションのファイルです。 ファイル構成についてはGitHubのLbtのrakeバージョン・ブランチのReadme.mdを参考にしてください。 これができあがったらPDFファイルを生成します。 sampleフォルダをカレント・ディレクトリにして
$ lbt build
なお、ソースファイルはMarkdownも可能です。
ファイルの配置
gemを作るには特定のファイル配置をしなければなりません。
$ tree
.
├── License.md
├── README.md
├── Rakefile
├── Tutorial.en.md
├── Tutorial.ja.md
├── bin
│ └── lbt
├── lbt.gemspec
├── lib
│ ├── lbt
│ │ ├── build.rb
│ │ ├── create.rb
│ │ ├── part_typeset.rb
│ │ ├── renumber.rb
│ │ └── utils.rb
│ └── lbt.rb
└── test
├── test_build.rb
├── test_create.rb
├── test_lbt.rb
├── test_num2path.rb
├── test_part_typeset.rb
├── test_renumber.rb
├── test_utils1.rb
└── test_utils2.rb
- License.md、README.md、Rakefile、lbt.gemspecをトップディレクトリに置く
- 実行ファイル（lbt）はbinディレクトリの下に置き、実行可能属性をオンにする（chmodで755にすればよい）
- libディレクトリの下にlbt.rb、つまり「gem名.rb」というファイルを置き、このファイルを通して下位ファイルをrequireないしrequire_relativeで取り込む
- libディレクトリの下にlbtディレクトリを置き、その中に下位ファイルを置く
- testディレクトリの下にテスト用ファイルを置く
以上から、本体のプログラムは、bin/lbt、lib/lbt.rb、lib/lbtディレクトリ下の諸ファイル、になります。
lbt.gemspec
「gemの名前.gemspec」というファイル（上記ではlbt.gemspec）がgemの内容を定義するファイルです。
Gem::Specification.new do |s| s.name = 'lbt' s.version = '0.5' s.summary = 'LaTeX Build Tools' s.description = 'Lbt is a build tool for LaTeX. It is useful for big documents.' s.license = 'GPL-3.0' s.author = 'XXXX XXXX' s.email = 'XXXXXX@XXXXl.com' s.homepage = 'https://github.com/ToshioCP/LaTeX-BuildTools' s.files = ['bin/lbt', 'lib/lbt.rb', 'lib/lbt/build.rb', 'lib/lbt/create.rb', 'lib/lbt/part_typeset.rb', 'lib/lbt/renumber.rb', 'lib/lbt/utils.rb'] s.executables = ['lbt'] end
名前、バージョン、要約、説明、ライセンス、著者、連絡先email、ホームページ、gemに取り込むファイルの配列、実行ファイル名を指定しています。 この他にも設定項目を設けることができるので詳細はRubyGems.orgのガイドを参照してください。
Rakefile
Lbtでは、Rakefileにドキュメント生成（RDoc）とテストについて記述しました。 これに加えて、gemのビルドを記述することもできます。 Rubyのドキュメントを参考にしてください。
require "rdoc/task" require "rake/testtask" RDoc::Task.new do |rdoc| rdoc.main = "README.md" rdoc.title = "LaTeX-Buildtools" rdoc.rdoc_dir = "doc" rdoc.rdoc_files.include("README.md", "License.md", "Tutorial.en.md", "Tutorial.ja.md", "lib/lbt.rb", "lib/lbt/*.rb") end task :rdoc do touch "doc/.nojekyll" end Rake::TestTask.new do |t| # t.libs << "test" t.test_files = Dir.glob("test/test_*") t.verbose = true end
RDoc::Task.new以下がドキュメント作成タスクを生成し、Rake::TestTask.new以下がテストの実行タスクを生成します。 コマンドラインからは、rdoc、testをrakeの引数にすることでそれぞれのタスクを実行します。
$ rake rdoc #=>ドキュメントを生成 $ rake test #=>テストを実行
ドキュメントやテストの内容は省略しますが、興味のある方はGitHubレポジトリを参照してください。
gemのビルド
gemをビルドするには、gemコマンドを用います。
$ gem build lbt.gemspec
これにより、カレントディレクトリにlbt-0.5.gemが出来上がります。
このファイルからgemをインストールするには
$ gem install ./lbt-0.5.gem
とします。 インストールが完了すると、lbtコマンドが実行できるようになります。 例えば
$ lbt new sample
でsampleディレクトリを生成し、テンプレートをその下に作ります。
RubyGems.orgへのアップロード
RubyGems.orgにgemをアップロードすることにより一般に公開することができます。 他のユーザは
$ gem install lbt
という1行でlbtをインストールできるようになります。
アップロードは次の手順で行います。
- RubyGems.orgにサインアップ（ユーザ登録）する（サインアップはRubyGems.orgのウェブ画面から行う）
- gem push （gemファイル名）でアップロードする（その時登録したユーザ名とパスワードが必要）
以上、gemの作成と公開の手順を紹介しました。 みなさんもRubyの有用なアプリやライブラリを持っていたらぜひGemとして公開してください。
