Class: Gem::BasicSpecification

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: Specification, StubSpecification
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `Deprecate`
Inherits:	Object
Defined in:	lib/rubygems/basic_specification.rb

Overview

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

`Deprecate` - Extended

deprecate	Simple deprecation method that deprecates #name by wrapping it up in a dummy method.
rubygems_deprecate	Simple deprecation method that deprecates #name by wrapping it up in a dummy method.
rubygems_deprecate_command	Deprecation method to deprecate Rubygems commands.
skip_during	Temporarily turn off warnings.

Instance Attribute Summary

#activated? ⇒ Boolean readonly

True when the gem has been activated.
#base_dir rw

Returns the full path to the base gem directory.
#default_gem? ⇒ Boolean readonly
#extension_dir rw

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

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

The path this gemspec was loaded from.
#stubbed? ⇒ Boolean readonly

Whether this specification is stubbed - i.e.
#have_extensions? ⇒ Boolean readonly private
#base_dir=(value) rw Internal use only

Allows installation of extensions for git: gems.
#extension_dir=(value) rw Internal use only

Sets the directory where extensions for this gem will be installed.
#full_gem_path=(value) rw Internal use only

Allows correct activation of git: and path: gems.
#ignored=(value) writeonly Internal use only

Is this specification ignored for activation purposes?

Instance Method Summary

#contains_requirable_file?(file) ⇒ Boolean

Return true if this spec can require file.
#datadir

The path to the data directory for this gem.
#extensions_dir

Returns path to the extensions directory.
#full_name

Returns the full name (name-version) of this ::Gem.
#full_require_paths

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

Returns the full path to this spec’s gem directory.
#gems_dir

Returns the full path to the gems directory containing this spec’s gem directory.
#lib_dirs_glob

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

Return all files in this gem that match for glob.
#name

Name of the gem.
#platform

Platform of the gem.
#plugins

Returns the list of plugins in this spec.
#require_paths

Paths in the gem to add to $LOAD_PATH when this gem is activated.
#source_paths

Returns the paths to the source files for use with analysis and documentation tools.
#this
#to_fullpath(path)

Full path of the target library file.
#to_spec

Return a Specification from this gem.
#version

Version of the gem.
#have_file?(file, suffixes) ⇒ Boolean private
#gem_build_complete_path Internal use only

The path to the gem.build_complete file within the extension install directory.
#internal_init Internal use only
#raw_require_paths Internal use only
#find_full_gem_path private Internal use only

Constructor Details

.new ⇒ `BasicSpecification`

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 32


def initialize
  internal_init
end

Class Method Details

.default_specifications_dir

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 36


def self.default_specifications_dir
  Gem.default_specifications_dir
end

Instance Attribute Details

#activated? ⇒ `Boolean` (readonly)

True when the gem has been activated

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 56


def activated?
  raise NotImplementedError
end

#base_dir (rw)

Returns the full path to the base gem directory.

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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 65


def base_dir
  raise NotImplementedError
end

#base_dir=(value) (rw)

This method is for internal use only.

Allows installation of extensions for git: gems.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 10


attr_writer :base_dir # :nodoc:

#default_gem? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 89


def default_gem?
  loaded_from &&
    File.dirname(loaded_from) == Gem.default_specifications_dir
end

#extension_dir (rw)

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 97


def extension_dir
  @extension_dir ||= File.expand_path(File.join(extensions_dir, full_name)).tap(&Gem::UNTAINT)
end

#extension_dir=(value) (rw)

This method is for internal use only.

Sets the directory where extensions for this gem will be installed.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 15


attr_writer :extension_dir # :nodoc:

#full_gem_path (rw)

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 122


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_gem_path=(value) (rw)

This method is for internal use only.

Allows correct activation of git: and path: gems.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 30


attr_writer :full_gem_path # :nodoc:

#have_extensions? ⇒ `Boolean` (readonly, private)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 330


def have_extensions?; !extensions.empty?; end

#ignored=(value) (writeonly)

This method is for internal use only.

Is this specification ignored for activation purposes?

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 20


attr_writer :ignored # :nodoc:

#loaded_from (rw)

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 25


attr_accessor :loaded_from

#stubbed? ⇒ `Boolean` (readonly)

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.

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 322


def stubbed?
  raise NotImplementedError
end

Instance Method Details

#contains_requirable_file?(file) ⇒ `Boolean`

Return true if this spec can require file.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 72


def contains_requirable_file?(file)
  if @ignored
    return false
  elsif missing_extensions?
    @ignored = true

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

    return false
  end

  have_file? file, Gem.suffixes
end

#datadir

The path to the data directory for this gem.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 161


def datadir
  # TODO: drop the extra ", gem_name" which is uselessly redundant
  File.expand_path(File.join(gems_dir, full_name, "data", name)).tap(&Gem::UNTAINT)
end

#extensions_dir

Returns path to the extensions directory.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 104


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

#find_full_gem_path (private)

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 110


def find_full_gem_path # :nodoc:
  # TODO: also, shouldn't it default to full_name if it hasn't been written?
  path = File.expand_path File.join(gems_dir, full_name)
  path.tap(&Gem::UNTAINT)
  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.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 133


def full_name
  if platform == Gem::Platform::RUBY or platform.nil?
    "#{name}-#{version}".dup.tap(&Gem::UNTAINT)
  else
    "#{name}-#{version}-#{platform}".dup.tap(&Gem::UNTAINT)
  end
end

#full_require_paths

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 145


def full_require_paths
  @full_require_paths ||=
  begin
    full_paths = raw_require_paths.map do |path|
      File.join full_gem_path, path.tap(&Gem::UNTAINT)
    end

    full_paths << extension_dir if have_extensions?

    full_paths
  end
end

#gem_build_complete_path

This method is for internal use only.

The path to the gem.build_complete file within the extension install directory.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 49


def gem_build_complete_path # :nodoc:
  File.join extension_dir, 'gem.build_complete'
end

#gem_dir

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 192


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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 200


def gems_dir
  raise NotImplementedError
end

#have_file?(file, suffixes) ⇒ `Boolean` (private)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 332


def have_file?(file, suffixes)
  return true if raw_require_paths.any? do |path|
    base = File.join(gems_dir, full_name, path.tap(&Gem::UNTAINT), file).tap(&Gem::UNTAINT)
    suffixes.any? {|suf| File.file? base + suf }
  end

  if have_extensions?
    base = File.join extension_dir, file
    suffixes.any? {|suf| File.file? base + suf }
  else
    false
  end
end

#internal_init

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 204


def internal_init # :nodoc:
  @extension_dir = nil
  @full_gem_path = nil
  @gem_dir = nil
  @ignored = nil
end

#lib_dirs_glob

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 290


def lib_dirs_glob
  dirs = if self.raw_require_paths
           if self.raw_require_paths.size > 1
             "{#{self.raw_require_paths.join(',')}}"
           else
             self.raw_require_paths.first
           end
         else
           "lib" # default value for require_paths for bundler/inline
         end

  "#{self.full_gem_path}/#{dirs}".dup.tap(&Gem::UNTAINT)
end

#matches_for_glob(glob)

Return all files in this gem that match for glob.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 273


def matches_for_glob(glob) # TODO: rename?
  glob = File.join(self.lib_dirs_glob, glob)

  Dir[glob].map {|f| f.tap(&Gem::UNTAINT) } # FIX our tests are broken, run w/ SAFE=1
end

#name

Name of the gem

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 214


def name
  raise NotImplementedError
end

#platform

Platform of the gem

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 221


def platform
  raise NotImplementedError
end

#plugins

Returns the list of plugins in this spec.

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 282


def plugins
  matches_for_glob("rubygems#{Gem.plugin_suffix_pattern}")
end

#raw_require_paths

This method is for internal use only.

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 225


def raw_require_paths # :nodoc:
  raise NotImplementedError
end

#require_paths

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

#source_paths

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 256


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

#this

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 326


def this; self; end

#to_fullpath(path)

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

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 170


def to_fullpath(path)
  if activated?
    @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 Specification from this gem

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 307


def to_spec
  raise NotImplementedError
end

#version

Version of the gem

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/rubygems/basic_specification.rb', line 314


def version
  raise NotImplementedError
end

Class: Gem::BasicSpecification

Overview

Class Method Summary

Deprecate - Extended

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new ⇒ BasicSpecification

Class Method Details

.default_specifications_dir

Instance Attribute Details

#activated? ⇒ Boolean (readonly)

#base_dir (rw)

#base_dir=(value) (rw)

#default_gem? ⇒ Boolean (readonly)

#extension_dir (rw)

#extension_dir=(value) (rw)

#full_gem_path (rw)

#full_gem_path=(value) (rw)

#have_extensions? ⇒ Boolean (readonly, private)

#ignored=(value) (writeonly)

#loaded_from (rw)

#stubbed? ⇒ Boolean (readonly)

Instance Method Details

#contains_requirable_file?(file) ⇒ Boolean

#datadir

#extensions_dir

#find_full_gem_path (private)

#full_name

#full_require_paths

#gem_build_complete_path

#gem_dir

#gems_dir

#have_file?(file, suffixes) ⇒ Boolean (private)

#internal_init

#lib_dirs_glob

#matches_for_glob(glob)

#name

#platform

#plugins

#raw_require_paths

#require_paths

#source_paths

#this

#to_fullpath(path)

#to_spec

#version

`Deprecate` - Extended

.new ⇒ `BasicSpecification`

#activated? ⇒ `Boolean` (readonly)

#default_gem? ⇒ `Boolean` (readonly)

#have_extensions? ⇒ `Boolean` (readonly, private)

#stubbed? ⇒ `Boolean` (readonly)

#contains_requirable_file?(file) ⇒ `Boolean`

#have_file?(file, suffixes) ⇒ `Boolean` (private)