class Gem::BasicSpecification

BasicSpecification is an abstract class which implements some common code used by both Specification and StubSpecification.

Attributes

loaded_from[R]

The path this gemspec was loaded from. This attribute is not persisted.

Public Class Methods

default_specifications_dir() click to toggle source

# File lib/rubygems/basic_specification.rb, line 32
def self.default_specifications_dir
  File.join(Gem.default_dir, "specifications", "default")
end

Public Instance Methods

activated?() click to toggle source

True when the gem has been activated

# File lib/rubygems/basic_specification.rb, line 39
def activated?
  raise NotImplementedError
end

base_dir() click to toggle source

Returns the full path to the base gem directory.

eg: /usr/local/lib/ruby/gems/1.8

# File lib/rubygems/basic_specification.rb, line 48
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

contains_requirable_file?(file) click to toggle source

Return true if this spec can require file.

# File lib/rubygems/basic_specification.rb, line 60
def contains_requirable_file? file
  @contains_requirable_file ||= {}
  @contains_requirable_file[file] ||=
  begin
    if instance_variable_defined?(:@ignored) or
       instance_variable_defined?('@ignored') then
      return false
    elsif missing_extensions? then
      @ignored = true

      warn "Ignoring #{full_name} because its extensions are not built.  " +
           "Try: gem pristine #{name} --version #{version}"
      return false
    end

    suffixes = Gem.suffixes

    full_require_paths.any? do |dir|
      base = "#{dir}/#{file}"
      suffixes.any? { |suf| File.file? "#{base}#{suf}" }
    end
  end ? :yes : :no
  @contains_requirable_file[file] == :yes
end

default_gem?() click to toggle source

# File lib/rubygems/basic_specification.rb, line 85
def default_gem?
  loaded_from &&
    File.dirname(loaded_from) == self.class.default_specifications_dir
end

extension_dir() click to toggle source

Returns full path to the directory where gem's extensions are installed.

# File lib/rubygems/basic_specification.rb, line 93
def extension_dir
  @extension_dir ||= File.expand_path File.join(extensions_dir, full_name)
end

extensions_dir() click to toggle source

Returns path to the extensions directory.

# File lib/rubygems/basic_specification.rb, line 100
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

full_gem_path() click to toggle source

The full path to the gem (install path + full name).

# File lib/rubygems/basic_specification.rb, line 118
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

full_name() click to toggle source

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 129
def full_name
  if platform == Gem::Platform::RUBY or platform.nil? then
    "#{name}-#{version}".untaint
  else
    "#{name}-#{version}-#{platform}".untaint
  end
end

full_require_paths() click to toggle source

Full paths in the gem to add to $LOAD_PATH when this gem is activated.

# File lib/rubygems/basic_specification.rb, line 141
def full_require_paths
  @full_require_paths ||=
  begin
    full_paths = raw_require_paths.map do |path|
      File.join full_gem_path, path
    end

    full_paths.unshift extension_dir unless @extensions.nil? || @extensions.empty?

    full_paths
  end
end

gem_dir() click to toggle source

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 180
def gem_dir
  @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
end

gems_dir() click to toggle source

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 188
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

loaded_from=(path) click to toggle source

Set the path the Specification was loaded from. path is converted to a String.

# File lib/rubygems/basic_specification.rb, line 197
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() click to toggle source

Name of the gem

# File lib/rubygems/basic_specification.rb, line 211
def name
  raise NotImplementedError
end

platform() click to toggle source

Platform of the gem

# File lib/rubygems/basic_specification.rb, line 218
def platform
  raise NotImplementedError
end

require_paths() click to toggle source

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 243
def require_paths
  return raw_require_paths if @extensions.nil? || @extensions.empty?

  [extension_dir].concat raw_require_paths
end

source_paths() click to toggle source

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 253
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

stubbed?() click to toggle source

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 285
def stubbed?
  raise NotImplementedError
end

to_fullpath(path) click to toggle source

Full path of the target library file. If the file is not in this gem, return nil.

# File lib/rubygems/basic_specification.rb, line 158
def to_fullpath path
  if activated? then
    @paths_map ||= {}
    @paths_map[path] ||=
    begin
      fullpath = nil
      suffixes = Gem.suffixes
      full_require_paths.find do |dir|
        suffixes.find do |suf|
          File.file?(fullpath = "#{dir}/#{path}#{suf}")
        end
      end ? fullpath : nil
    end
  else
    nil
  end
end

to_spec() click to toggle source

Return a Gem::Specification from this gem

# File lib/rubygems/basic_specification.rb, line 270
def to_spec
  raise NotImplementedError
end

version() click to toggle source

Version of the gem

# File lib/rubygems/basic_specification.rb, line 277
def version
  raise NotImplementedError
end