Ruby 2.3.0 リファレンスマニュアル > ライブラリ一覧 > rubygems/specificationライブラリ > Gem::Specificationクラス

class Gem::Specification

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

要約

Gem パッケージのメタデータを扱うためのクラスです。

特異メソッド

定義 説明
_load(str) -> Gem::Specification

マーシャルされたデータをロードするためのメソッドです。

array_attribute(name) -> ()

Gem::Specification.attribute と同じですが、値を配列に格納するアクセサを作ります。

array_attributes -> Array

@@array_attributes の複製を返します。

attribute(name) -> ()

デフォルト値を指定したアクセサを定義するために使用します。

attribute_alias_singular(singular, plural) -> ()

既に存在する複数形の属性の単数形バージョンを定義します。

attribute_defaults -> Array

@todo

attribute_names -> Array

属性名の配列を返します。

attributes(*args) -> ()

複数の属性を一度に作成するために使用します。

default_value(name) -> object

与えられた名前の属性のデフォルト値を返します。

from_yaml(input) -> Gem::Specification

YAML ファイルから gemspec をロードします。

list -> Array

実行中の Ruby のインスタンスで作成された Gem::Specification のインスタンスを返します。

load(filename) -> Gem::Specification

gemspec ファイルをロードします。

normalize_yaml_input(input) -> String

YAML 形式の gemspec を正しくフォーマットします。

overwrite_accessor(name) { ... } -> ()

呼び出し時に特別な動作をする必要のある属性があります。このメソッドはそういうことを可能にします。

read_only(*names) -> ()

与えられた属性名を読み取り専用にします。

required_attribute(name, default = nil) -> ()

必須の属性を作成します。

required_attribute?(name) -> bool

必須属性であれば真を返します。

required_attributes -> Array

必須属性のリストを返します。

インスタンスメソッド

定義 説明
_dump -> String

重要なインスタンス変数のみを Marshal.#dump します。

add_bindir(executables) -> Array | nil

実行コマンドの格納場所を返します。

add_dependency(gem, *requirements) -> [Gem::Dependency]
add_runtime_dependency(gem, *requirements) -> [Gem::Dependency]

この gem の RUNTIME 依存性を追加します。実行時に必要となる gem を指定します。

add_development_dependency(gem, *requirements) -> [Gem::Dependency]

この gem の DEVELOPMENT 依存性を追加します。この gem の開発時に必要となる gem を指定します。

assign_defaults -> ()

全ての属性にデフォルト値をセットします。

author -> String

作成者の名前を返します。

author=(name)

作成者の名前をセットします。

authors -> Array

作成者の名前の配列を返します。

authors=(names)

作成者の名前の配列をセットします。

autorequire -> String

非推奨の属性です。

autorequire=(lib)

非推奨の属性です。

bindir -> String

実行ファイルを格納するディレクトリを返します。

bindir=(dir)

実行ファイルを格納するディレクトリをセットします。

cert_chain -> Array

@todo

cert_chain=(arr)

@todo

date -> Time

日付を返します。

date=(date)

@param date 日付をセットします。デフォルトは今日です。

default_executable -> String | nil

Gem パッケージ内で gem コマンド経由で実行するファイルを返します。

default_executable=(executable)

Gem パッケージ内で gem コマンド経由で実行するファイルをセットします。

dependencies -> Array

依存している Gem のリストを返します。

dependent_gems -> Array

この Gem に依存している全ての Gem の情報のリストを返します。

description -> String

Gem パッケージの説明を返します。

description=(desc)

Gem パッケージの説明をセットします。

development_dependencies -> Array

この Gem が依存している Gem のリストを返します。

email -> String

メールアドレスを返します。

email=(email)

メールアドレスをセットします。

executable -> String

実行可能ファイル名を返します。

executable=(executable)

実行可能ファイル名をセットします。

executables -> [String]

実行可能ファイル名のリストを返します。

executables=(executables)

実行可能ファイル名のリストをセットします。

extensions -> [String]

拡張ライブラリをコンパイルするために必要な extconf.rb 形式のファイルのリストを返します。

extensions=(paths)

拡張ライブラリをコンパイルするために必要な extconf.rb 形式のファイルのリストをセットします。

extra_rdoc_files -> [String]

RDoc でドキュメントを作成する際に使用する特別なファイルのリストを返します。

extra_rdoc_files=(paths)

RDoc でドキュメントを作成する際に使用する特別なファイルのリストをセットします。

file_name -> String

生成される Gem パッケージの名前を返します。

files -> [String]

この Gem パッケージに含まれるファイル名の配列を返します。

files=(files)

この Gem パッケージに含まれるファイル名の配列をセットします。

full_gem_path -> String

この Gem パッケージへのフルパスを返します。

full_name -> String

この Gem パッケージのバージョンを含む完全な名前 (name-version) を返します。

has_rdoc -> bool

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

has_rdoc=(flag)

RDoc を生成するかどうかをセットします。デフォルトは偽です。

has_rdoc? -> bool

真の場合は RDoc を生成しせん。偽の場合は RDoc を生成します。

has_test_suite? -> bool

このメソッドは非推奨です。 Gem::Specification#has_unit_tests? を使用してください。

has_unit_tests? -> bool

この Gem パッケージがユニットテストを含むかどうか返します。

homepage -> String

この Gem パッケージを作成しているプロジェクトか作成者のウェブサイトの URI を返します。

homepage=(uri)

この Gem パッケージを作成しているプロジェクトか作成者のウェブサイトの URI をセットします。

installation_path -> String

この Gem パッケージのインストール先のパスを返します。

lib_files -> [String]

この Gem パッケージに含まれているファイルのうち Gem::Specification#require_paths 以下にあるファイルのリストを返します。

loaded=(flag)

この Gem パッケージの gemspec が既にロードされているかどうかをセットします。

loaded? -> bool

この Gem パッケージの gemspec が既にロードされているかどうかを返します。

loaded_from -> String

この Gem パッケージの gemspec がある場所を返します。

loaded_from=(path)

この Gem パッケージの gemspec がある場所をセットします。

mark_version -> String

RubyGems のバージョンを内部にセットします。

name -> String

この Gem パッケージの名前を返します。

name=(name)

この Gem パッケージの名前をセットします。

normalize -> [String]

この Gem パッケージの含まれるファイルリストから重複を取り除きます。

original_name -> String

このメソッドは後方互換性のために残されています。

original_platform -> String

この属性は古いバージョンの Gem パッケージをアンインストールするために残されています。

original_platform=(platform)

この属性は古いバージョンの Gem パッケージをアンインストールするために残されています。

platform -> String

この Gem パッケージを使用できるプラットフォームを返します。

platform=(platform)

この Gem パッケージを使用できるプラットフォームをセットします。

post_install_message -> String

インストール完了後に表示するメッセージを返します。

post_install_message=(message)

インストール完了後に表示するメッセージをセットします。

rdoc_options -> [String]

API ドキュメントを生成するときに rdoc コマンドに与えるオプションを返します。

rdoc_options=(options)

API ドキュメントを生成するときに rdoc コマンドに与えるオプションをセットします。

require_path -> String

Gem::Specification#require_paths の単数バージョンです。

require_path=(path)

Gem::Specification#require_paths= の単数バージョンです。

require_paths -> [String]

この Gem パッケージを使用した際に require するファイルが置かれているディレクトリのリストを返します。

require_paths=(paths)

この Gem パッケージを使用した際に require するファイルが置かれているディレクトリのリストをセットします。

required_ruby_version -> Gem::Requirement

この Gem パッケージを動作させるのに必要な Ruby のバージョンを返します。

required_ruby_version=(requirement)

この Gem パッケージを動作させるのに必要な Ruby のバージョンをセットします。

required_rubygems_version -> Gem::Requirement

この Gem パッケージを動作させるのに必要な RubyGems のバージョンを返します。

required_rubygems_version=(requirement)

この Gem パッケージを動作させるのに必要な RubyGems のバージョンをセットします。

requirements -> Array

この Gem パッケージを動作させるのに必要な条件を返します。これはユーザのためのシンプルな情報です。

requirements=(informations)

この Gem パッケージを動作させるのに必要な条件をセットします。これはユーザのためのシンプルな情報をセットします。

rubygems_version -> String

この Gem パッケージを作成した RubyGems のバージョンを返します。

rubygems_version=(version)

この Gem パッケージを作成した RubyGems のバージョンをセットします。この属性は Gem パッケージが作成された時に自動的にセットされます。

runtime_dependencies -> Array

この Gem パッケージが依存している Gem パッケージのリストを返します。

satisfies_requirement?(dependency) -> bool

この Gem パッケージが与えられた依存関係を満たすかどうかを返します。

signing_key -> String

この Gem パッケージの署名に使用するキーを返します。

signing_key=(key)

この Gem パッケージの署名に使用するキーをセットします。

specification_version -> Integer

この Gem パッケージに用いられている gemspec のバージョンを返します。

specification_version=(version)

この Gem パッケージに用いられている gemspec のバージョンをセットします。

summary -> String

この Gem パッケージの短い説明を返します。

summary=(summary)

この Gem パッケージの短い説明をセットします。

test_file -> String

Gem::Specification#test_files の単数バージョンです。

test_file=(file)

Gem::Specification#test_files= の単数バージョンです。

test_files -> [String]

ユニットテストのファイルのリストを返します。

test_files=(files)

ユニットテストのファイルのリストをセットします。

test_suite_file -> String

この属性は非推奨です。 Gem::Specification#test_files を使用してください。

test_suite_file=(file)

この属性は非推奨です。 Gem::Specification#test_files= を使用してください。

to_ruby -> String

自身を再現するための Ruby スクリプトを文字列で返します。

validate -> bool

必須属性のチェックと自身の基本的な正当性チェックを行います。

version -> Gem::Version

この Gem パッケージのバージョンを返します。

version=(version)

この Gem パッケージのバージョンをセットします。

yaml_initialize

@todo

定数

定義 説明
CURRENT_SPECIFICATION_VERSION -> 2

現在の gemspec のバージョンを表す定数です。

MARSHAL_FIELDS -> Hash

@todo

NONEXISTENT_SPECIFICATION_VERSION -> -1

明確に指定されていない時の gemspec のバージョンを表します。

SPECIFICATION_VERSION_HISTORY -> Hash

gemspec ファイルのバージョンの歴史を表す定数です。

TODAY -> Time

本日の日付を返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .new .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE