buffbuff をgem化するにあたってのメモ

概要

buffbuff をgem化しました。

github.com

当初は clone してそのまま利用するという作りにしていたのですが、gem としてインストール(from GitHub)できるように修正を行いました。この作業でハマった点や気付いた点などを書き残しておきます。

メモ

• .gemspec についてはここを参照 Specification Reference - RubyGems Guides
• こちらも参考になりました gemを作る時に気をつけていること - くりにっき
• gem が依存するライブラリは Gemfile ではなく .gemspec に定義する
  • 該当の gem をインストールする場合は .gemspec に add_dependency で定義されている依存関係のみが同時にインストールされる仕組みらしい
  • add_development_dependency で定義した依存関係は gem 自体を開発する場合のみ、すなわちソースコードを手元において bundle install するとインストールされる
• executables
  • gem 内に実行可能なRubyファイルがある場合ここに追加する必要がある
  • これをやっておくとインストール時に bundle exec <executable> できるようになるっぽい
  • 実行可能なファイルを配置するディレクトリは bindir で設定できる(デフォルトは bin )
• 実行場所の問題
  • buffbuff では、テンプレートファイルを配置するディレクトリをプロジェクトルート直下の templates ディレクトリにするというルールにしている
  • プロジェクトルートが実行時に分からないと、このディレクトリを探索できない
  • executable を実行したときにワーキングディレクトリを取得して、これを使うようにしてみた
    • https://github.com/TAKAyukiatkwsk/buffbuff/blob/v0.2.0/bin/buffbuff#L5
    • https://github.com/TAKAyukiatkwsk/buffbuff/blob/v0.2.0/lib/buffbuff/command.rb#L16
  • なんか良い方法あったら教えてください🙏