Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > rubygems/indexer/abstract_index_builderライブラリ > Gem::Indexer::AbstractIndexBuilderクラス

class Gem::Indexer::AbstractIndexBuilder

クラスの継承リスト: Gem::Indexer::AbstractIndexBuilder < Object < Kernel < BasicObject

Abstract

Gem のインデックスを構築するための抽象クラスです。

テンプレートパターンを使用しています。

特異メソッド

new(filename, directory)

自身を初期化します。

[PARAM] filename:
作成するインデックスを保存するファイル名です。
[PARAM] directory:
インデックスファイルを保存する作業ディレクトリです。

インスタンスメソッド

build { ... }

Gem のインデックスを作成します。

実際のインデックスを作成する処理の詳細は与えられたブロックに記述されています。 基本的な処理をカスタマイズするために、適切なタイミングで begin_index, end_index, cleanup が呼び出されるようになっています。

cleanup

インデックスファイルを閉じたあとに呼び出されます。

compress(filename, ext = 'rz')

与えられたファイルを圧縮します。

[PARAM] filename:
圧縮するファイルの名前を指定します。
[PARAM] ext:
圧縮後のファイルの拡張子を指定します。
directory -> String

インデックスファイルに入れるファイルを配置しているディレクトリ名を返します。

end_index

Gem::Indexer::AbstractIndexBuilder#build 内でブロックが実行された後に呼び出されます。 インデックスファイルは有効で、@file も参照可能です。

filename -> String

作成するインデックスファイルの名前を返します。

files -> [String]

作成するインデックスファイルに含まれるファイルのリストを返します。

start_index

Gem::Indexer::AbstractIndexBuilder#build 内でブロックが実行される前に呼び出されます。 インデックスファイルは有効で、@file も参照可能です。

unzip(string) -> String

与えられた圧縮済み文字列を展開して返します。

[PARAM] string:
圧縮されているデータを指定します。

[SEE_ALSO] Zlib::Inflate.inflate

zip(string) -> String

与えられた文字列を圧縮して返します。

[PARAM] string:
圧縮するデータを指定します。

[SEE_ALSO] Zlib::Deflate.deflate

Methods

Classes