Skip to Content Skip to Search

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

Methods
A
B
C
D
E
F
G
L
M
N
P
R
S
T
V

Attributes

[RW] loaded_from

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

Class Public methods

default_specifications_dir()

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 37
def self.default_specifications_dir
  Gem.default_specifications_dir
end

new()

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 33
def initialize
  internal_init
end

Instance Public methods

activated?()

True when the gem has been activated

Source: show | on GitHub 

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

base_dir()

Returns the full path to the base gem directory.

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

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 66
def base_dir
  raise NotImplementedError
end

contains_requirable_file?(file)

Return true if this spec can require file.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 73
def contains_requirable_file?(file)
  if @ignored
    return false
  elsif missing_extensions?
    @ignored = true

    if platform == Gem::Platform::RUBY || Gem::Platform.local === platform
      warn "Ignoring #{full_name} because its extensions are not built. " \
           "Try: gem pristine #{name} --version #{version}"
    end

    return false
  end

  is_soext = file.end_with?(".so", ".o")

  if is_soext
    have_file? file.delete_suffix(File.extname(file)), Gem.dynamic_library_suffixes
  else
    have_file? file, Gem.suffixes
  end
end

datadir()

The path to the data directory for this gem.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 166
def datadir
  # TODO: drop the extra ", gem_name" which is uselessly redundant
  File.expand_path(File.join(gems_dir, full_name, "data", name))
end

default_gem?()

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 96
def default_gem?
  loaded_from &&
    File.dirname(loaded_from) == Gem.default_specifications_dir
end

extension_dir()

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

Source: show | on GitHub 

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

extensions_dir()

Returns path to the extensions directory.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 111
def 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()

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

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 127
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()

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.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 138
def full_name
  if platform == Gem::Platform::RUBY || platform.nil?
    "#{name}-#{version}"
  else
    "#{name}-#{version}-#{platform}"
  end
end

full_require_paths()

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

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 150
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 << extension_dir if have_extensions?

      full_paths
    end
end

gem_dir()

Returns the full path to this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems/mygem-1.0

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 193
def gem_dir
  @gem_dir ||= File.expand_path File.join(gems_dir, full_name)
end

gems_dir()

Returns the full path to the gems directory containing this spec’s gem directory. eg: /usr/local/lib/ruby/1.8/gems

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 201
def gems_dir
  raise NotImplementedError
end

lib_dirs_glob()

Returns a string usable in Dir.glob to match all requirable paths for this spec.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 291
def lib_dirs_glob
  dirs = if raw_require_paths
    if raw_require_paths.size > 1
      "{#{raw_require_paths.join(",")}}"
    else
      raw_require_paths.first
    end
  else
    "lib" # default value for require_paths for bundler/inline
  end

  "#{full_gem_path}/#{dirs}"
end

matches_for_glob(glob)

Return all files in this gem that match for glob.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 274
def matches_for_glob(glob) # TODO: rename?
  glob = File.join(lib_dirs_glob, glob)

  Dir[glob]
end

name()

Name of the gem

Source: show | on GitHub 

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

platform()

Platform of the gem

Source: show | on GitHub 

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

plugins()

Returns the list of plugins in this spec.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 283
def plugins
  matches_for_glob("rubygems#{Gem.plugin_suffix_pattern}")
end

require_paths()

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 = '.'

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 247
def require_paths
  return raw_require_paths unless have_extensions?

  [extension_dir].concat raw_require_paths
end

source_paths()

Returns the paths to the source files for use with analysis and documentation tools. These paths are relative to full_gem_path.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 257
def source_paths
  paths = raw_require_paths.dup

  if have_extensions?
    ext_dirs = extensions.map do |extension|
      extension.split(File::SEPARATOR, 2).first
    end.uniq

    paths.concat ext_dirs
  end

  paths.uniq
end

stubbed?()

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.

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 323
def stubbed?
  raise NotImplementedError
end

this()

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 327
def this
  self
end

to_fullpath(path)

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

Source: show | on GitHub 

# File ruby/lib/rubygems/basic_specification.rb, line 175
def to_fullpath(path)
  if activated?
    @paths_map ||= {}
    Gem.suffixes.each do |suf|
      full_require_paths.each do |dir|
        fullpath = "#{dir}/#{path}#{suf}"
        next unless File.file?(fullpath)
        @paths_map[path] ||= fullpath
      end
    end
    @paths_map[path]
  end
end

to_spec()

Return a Gem::Specification from this gem

Source: show | on GitHub 

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

version()

Version of the gem

Source: show | on GitHub 

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