Class: Gem::BasicSpecification (Ruby 2.3.4)

Home Classes Methods

In Files

rubygems/basic_specification.rb

Parent

Object

Methods

::default_specifications_dir
::new
#activated?
#base_dir
#contains_requirable_file?
#datadir
#default_gem?
#extension_dir
#extensions_dir
#full_gem_path
#full_name
#full_require_paths
#gem_dir
#gems_dir
#lib_dirs_glob
#matches_for_glob
#name
#platform
#require_paths
#source_paths
#stubbed?
#to_fullpath
#to_spec
#version

Class/Module Index

Gem::BasicSpecification

frozen_string_literal: true

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

Attributes

loaded_from[RW]

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

Public Class Methods

default_specifications_dir()

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

new()

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

Public Instance Methods

activated?()

True when the gem has been activated

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

base_dir()

Returns the full path to the base gem directory.

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

 
               # File rubygems/basic_specification.rb, line 61
def base_dir
  raise NotImplementedError
end

contains_requirable_file?(file)

Return true if this spec can require file.

 
               # File rubygems/basic_specification.rb, line 68
def contains_requirable_file? file
  if @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

  have_file? file, Gem.suffixes
end

datadir()

The path to the data directory for this gem.

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

default_gem?()

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

extension_dir()

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

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

extensions_dir()

Returns path to the extensions directory.

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

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

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

 
               # File rubygems/basic_specification.rb, line 126
def full_name
  if platform == Gem::Platform::RUBY or platform.nil? then
    "#{name}-#{version}".dup.untaint
  else
    "#{name}-#{version}-#{platform}".dup.untaint
  end
end

full_require_paths()

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

 
               # File rubygems/basic_specification.rb, line 138
def full_require_paths
  @full_require_paths ||=
  begin
    full_paths = raw_require_paths.map do |path|
      File.join full_gem_path, path.untaint
    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

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

 
               # File rubygems/basic_specification.rb, line 193
def gems_dir
  raise NotImplementedError
end

lib_dirs_glob()

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

 
               # File rubygems/basic_specification.rb, line 278
def lib_dirs_glob
  dirs = if self.require_paths.size > 1 then
           "{#{self.require_paths.join(',')}}"
         else
           self.require_paths.first
         end

  "#{self.full_gem_path}/#{dirs}".dup.untaint
end

matches_for_glob(glob)

Return all files in this gem that match for glob.

 
               # File rubygems/basic_specification.rb, line 267
def matches_for_glob glob # TODO: rename?
  # TODO: do we need these?? Kill it
  glob = File.join(self.lib_dirs_glob, glob)

  Dir[glob].map { |f| f.untaint } # FIX our tests are broken, run w/ SAFE=1
end

name()

Name of the gem

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

platform()

Platform of the gem

 
               # File rubygems/basic_specification.rb, line 215
def platform
  raise NotImplementedError
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 = '.'

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

 
               # File rubygems/basic_specification.rb, line 250
def source_paths
  paths = raw_require_paths.dup

  if have_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?()

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 rubygems/basic_specification.rb, line 306
def stubbed?
  raise NotImplementedError
end

to_fullpath(path)

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

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

to_spec()

Return a Gem::Specification from this gem

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

version()

Version of the gem

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