class Gem::BasicSpecification
BasicSpecification is an abstract class which implements some common code used by both Specification and StubSpecification.
Attributes
The path this gemspec was loaded from. This attribute is not persisted.
Public Class Methods
# File lib/rubygems/basic_specification.rb, line 27 def self.default_specifications_dir File.join(Gem.default_dir, "specifications", "default") end
Public Instance Methods
True when the gem has been activated
# File lib/rubygems/basic_specification.rb, line 34 def activated? raise NotImplementedError end
Returns the full path to the base gem directory.
eg: /usr/local/lib/ruby/gems/1.8
# File lib/rubygems/basic_specification.rb, line 43 def base_dir return Gem.dir unless loaded_from @base_dir ||= if default_gem? then File.dirname File.dirname File.dirname loaded_from else File.dirname File.dirname loaded_from end end
Return true if this spec can require file
.
# File lib/rubygems/basic_specification.rb, line 55 def contains_requirable_file? file build_extensions suffixes = Gem.suffixes full_require_paths.any? do |dir| base = "#{dir}/#{file}" suffixes.any? { |suf| File.file? "#{base}#{suf}" } end end
# File lib/rubygems/basic_specification.rb, line 66 def default_gem? loaded_from && File.dirname(loaded_from) == self.class.default_specifications_dir end
Returns full path to the directory where gem's extensions are installed.
# File lib/rubygems/basic_specification.rb, line 74 def extension_dir @extension_dir ||= File.expand_path File.join(extensions_dir, full_name) end
Returns path to the extensions directory.
# File lib/rubygems/basic_specification.rb, line 81 def extensions_dir @extensions_dir ||= Gem.default_ext_dir_for(base_dir) || File.join(base_dir, 'extensions', Gem::Platform.local.to_s, Gem.extension_api_version) end
The full path to the gem (install path + full name).
# File lib/rubygems/basic_specification.rb, line 99 def full_gem_path # TODO: This is a heavily used method by gems, so we'll need # to aleast just alias it to #gem_dir rather than remove it. @full_gem_path ||= find_full_gem_path end
Returns the full name (name-version) of this Gem. Platform information is included (name-version-platform) if it is specified and not the default Ruby platform.
# File lib/rubygems/basic_specification.rb, line 110 def full_name if platform == Gem::Platform::RUBY or platform.nil? then "#{name}-#{version}".untaint else "#{name}-#{version}-#{platform}".untaint end end
Full paths in the gem to add to $LOAD_PATH
when this gem is
activated.
# File lib/rubygems/basic_specification.rb, line 122 def full_require_paths full_paths = @require_paths.map do |path| File.join full_gem_path, path end full_paths.unshift extension_dir unless @extensions.empty? full_paths end
Returns the full path to this spec's gem directory. eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0
# File lib/rubygems/basic_specification.rb, line 136 def gem_dir @gem_dir ||= File.expand_path File.join(gems_dir, full_name) end
Returns the full path to the gems directory containing this spec's gem directory. eg: /usr/local/lib/ruby/1.8/gems
# File lib/rubygems/basic_specification.rb, line 144 def gems_dir # TODO: this logic seems terribly broken, but tests fail if just base_dir @gems_dir ||= File.join(loaded_from && base_dir || Gem.dir, "gems") end
Set the path the Specification was loaded from.
path
is converted to a String.
# File lib/rubygems/basic_specification.rb, line 153 def loaded_from= path @loaded_from = path && path.to_s @extension_dir = nil @extensions_dir = nil @full_gem_path = nil @gem_dir = nil @gems_dir = nil @base_dir = nil end
Name of the gem
# File lib/rubygems/basic_specification.rb, line 167 def name raise NotImplementedError end
Platform of the gem
# File lib/rubygems/basic_specification.rb, line 174 def platform raise NotImplementedError end
Paths in the gem to add to $LOAD_PATH
when this gem is
activated.
See also require_paths=
If you have an extension you do not need to add
"ext"
to the require path, the extension build
process will copy the extension files into “lib” for you.
The default value is "lib"
Usage:
# If all library files are in the root directory... spec.require_path = '.'
# File lib/rubygems/basic_specification.rb, line 199 def require_paths return @require_paths if @extensions.empty? relative_extension_dir = File.join '..', '..', 'extensions', Gem::Platform.local.to_s, Gem.extension_api_version, full_name [relative_extension_dir].concat @require_paths end
Returns the paths to the source files for use with analysis and documentation tools. These paths are relative to full_gem_path.
# File lib/rubygems/basic_specification.rb, line 213 def source_paths paths = raw_require_paths.dup if @extensions then ext_dirs = @extensions.map do |extension| extension.split(File::SEPARATOR, 2).first end.uniq paths.concat ext_dirs end paths.uniq end
Whether this specification is stubbed - i.e. we have information about the gem from a stub line, without having to evaluate the entire gemspec file.
# File lib/rubygems/basic_specification.rb, line 245 def stubbed? raise NotImplementedError end
Return a Gem::Specification from this gem
# File lib/rubygems/basic_specification.rb, line 230 def to_spec raise NotImplementedError end
Version of the gem
# File lib/rubygems/basic_specification.rb, line 237 def version raise NotImplementedError end