Class | Gem::Specification |
In: |
lib/rubygems/specification.rb
|
Parent: | Object |
The Specification class contains the metadata for a Gem. Typically defined in a .gemspec file or a Rakefile, and looks like this:
spec = Gem::Specification.new do |s| s.name = 'rfoo' s.version = '1.0' s.summary = 'Example gem specification' ... end
There are many gemspec attributes, and the best place to learn about them in the "Gemspec Reference" linked from the RubyGems wiki.
NONEXISTENT_SPECIFICATION_VERSION | = | -1 | The the version number of a specification that does not specify one (i.e. RubyGems 0.7 or earlier). | |
CURRENT_SPECIFICATION_VERSION | = | 2 | The specification version applied to any new Specification instances created. This should be bumped whenever something in the spec format changes. | |
SPECIFICATION_VERSION_HISTORY | = | { -1 => ['(RubyGems versions up to and including 0.7 did not have versioned specifications)'], 1 => [ 'Deprecated "test_suite_file" in favor of the new, but equivalent, "test_files"', '"test_file=x" is a shortcut for "test_files=[x]"' | An informal list of changes to the specification. The highest-valued key should be equal to the CURRENT_SPECIFICATION_VERSION. |
== | -> | eql? |
Used to specify the name and default value of a specification attribute. The side effects are:
The reader method behaves like this:
def attribute @attribute ||= (copy of default value) end
This allows lazy initialization of attributes to their default values.
Defines a singular version of an existing plural attribute (i.e. one whose value is expected to be an array). This means just creating a helper method that takes a single value and appends it to the array. These are created for convenience, so that in a spec, one can write
s.require_path = 'mylib'
instead of
s.require_paths = ['mylib']
That above convenience is available courtesy of
attribute_alias_singular :require_path, :require_paths
Shortcut for creating several attributes at once (each with a default value of nil).
Special loader for YAML files. When a Specification object is loaded from a YAML file, it bypasses the normal Ruby object initialization routine (initialize). This method makes up for that and deals with gems of different ages.
‘input’ can be anything that YAML.load() accepts: String or IO.
Specification constructor. Assigns the default values to the attributes, adds this spec to the list of loaded specs (see Specification.list), and yields itself for further initialization.
Some attributes require special behaviour when they are accessed. This allows for that.
Adds a dependency to this Gem. For example,
spec.add_dependency('jabber4r', '> 0.1', '<= 0.5')
gem: | [String or Gem::Dependency] The Gem name/dependency. |
requirements: | [default=">= 0"] The version requirements. |
Each attribute has a default value (possibly nil). Here, we initialize all attributes to their default value. This is done through the accessor methods, so special behaviours will be honored. Furthermore, we take a copy of the default so each specification instance has its own empty arrays, etc.
Checks if this Specification meets the requirement of the supplied dependency.
dependency: | [Gem::Dependency] the dependency to check |
return: | [Boolean] true if dependency is met, otherwise false |
Returns a Ruby code representation of this specification, such that it can be eval‘ed and reconstruct the same specification later. Attributes that still have their default values are omitted.
Checks that the specification contains all required fields, and does a very basic sanity check.
Raises InvalidSpecificationException if the spec does not pass the checks..