【Ruby3.x】Gem::Specification::files=()メソッドの使い方
files=メソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
files=メソッドは、Rubyのパッケージ管理システムであるRubyGemsで配布されるソフトウェア部品（Gem）に、どのようなファイルを含めるかを設定するメソッドです。このメソッドは、Gemの基本的な情報や構成を定義するために使われるGem::Specificationクラスに属しています。
Gemを作成する際、そのGemを構成するすべてのファイル、例えばソースコード、テストファイル、ドキュメント、ライセンス情報などを明示的に指定する必要があります。files=メソッドは、これらのファイルのパスを文字列の配列として受け取り、指定されたファイルをGemのパッケージに含めるように登録します。
この設定を行うことで、Gemがビルドされる際に、指定されたファイルのみがパッケージにまとめられます。そして、他の開発者がそのGemをインストールした際には、これらの指定されたファイルがユーザーのシステムに適切に配置され、Gemの機能が利用できるようになります。
たとえば、spec.files = ["lib/my_gem.rb", "bin/my_command", "README.md"]のように記述することで、my_gem.rbというライブラリファイル、my_commandという実行可能ファイル、そしてREADME.mdという説明ファイルが、そのGemの一部として確実に含まれるようになります。これにより、Gemの完全性と正確な動作が保証されます。
構文(syntax)
1s.files = ["lib/my_gem.rb", "Rakefile", "README.md", "LICENSE.txt"]
引数(parameters)
files
- files: このGemがインストールするファイルの一覧を指定する文字列の配列
戻り値(return)
Array
このメソッドは、指定されたファイルリストを Gem の仕様に設定します。戻り値は、設定されたファイルリストそのもの（Array 型）です。