Class: Gem::StubSpecification

Relationships & Source Files
Namespace Children
Classes: `StubLine`
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `BasicSpecification`, `Deprecate`
Instance Chain: self, `BasicSpecification`
Inherits:	Gem::BasicSpecification Object Gem::BasicSpecification Gem::StubSpecification
Defined in:	lib/rubygems/stub_specification.rb

Overview

StubSpecification reads the stub: line from the gemspec. This prevents us having to eval the entire gemspec in order to find out certain information.

Constant Summary

OPEN_MODE = Internal use only
# File 'lib/rubygems/stub_specification.rb', line 13
```
"r:UTF-8:-"
```
PREFIX = Internal use only
# File 'lib/rubygems/stub_specification.rb', line 10
```
"# stub: "
```

Class Method Summary

.default_gemspec_stub(filename, base_dir, gems_dir)
.gemspec_stub(filename, base_dir, gems_dir)
.new(filename, base_dir, gems_dir, default_gem) ⇒ StubSpecification constructor

`BasicSpecification` - Inherited

.default_specifications_dir, .new

`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 this gem has been activated.
#base_dir readonly
#default_gem? ⇒ Boolean readonly
#gems_dir readonly
#missing_extensions? ⇒ Boolean readonly
#stubbed? ⇒ Boolean readonly

Is there a stub line present for this StubSpecification?
#valid? ⇒ Boolean readonly

Is this StubSpecification valid? i.e.

`BasicSpecification` - Inherited

#activated?	True when the gem has been activated.
#base_dir	Returns the full path to the base gem directory.
#default_gem?,
#extension_dir	Returns full path to the directory where gem’s extensions are installed.
#full_gem_path	The full path to the gem (install path + full name).
#ignored?	Return true if this spec should be ignored because it’s missing extensions.
#loaded_from	The path this gemspec was loaded from.
#stubbed?	Whether this specification is stubbed - i.e.
#have_extensions?,
#base_dir=	Allows installation of extensions for git: gems.
#extension_dir=	Sets the directory where extensions for this gem will be installed.
#full_gem_path=	Allows correct activation of git: and path: gems.
#ignored=	Is this specification ignored for activation purposes?

Instance Method Summary

#extensions

Extensions for this gem.
#full_name
#name

Name of the gem.
#platform

Platform of the gem.
#spec (also: #to_spec)

The full Specification for this gem, loaded from evalling its gemspec.
#to_spec

Alias for #spec.
#version

Version of the gem.
#data private

If the gemspec contains a stubline, returns a StubLine instance.
#loaded_spec private
#<=>(other) Internal use only
#==(other) (also: #eql?) Internal use only
#build_extensions Internal use only
#eql?(other) Internal use only

Alias for #==.
#hash Internal use only
#raw_require_paths Internal use only
#sort_obj Internal use only

`BasicSpecification` - Inherited

#base_dir_priority	Gems higher up in `gem_path` take precedence.
#contains_requirable_file?	Return true if this spec can require `file`.
#datadir	The path to the data directory for this gem.
#default_gem_priority	Regular gems take precedence over default gems.
#extensions_dir	Returns path to the extensions directory.
#full_name	Returns the full name (name-version) of this `::Gem`.
#full_name_with_location	Returns the full name of this `::Gem` (see BasicSpecification#full_name).
#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	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	Full path of the target library file.
#to_spec	Return a `Specification` from this gem.
#version	`Version` of the gem.
#have_file?,
#gem_build_complete_path	The path to the gem.build_complete file within the extension install directory.
#internal_init, #raw_require_paths, #find_full_gem_path

Constructor Details

.new(filename, base_dir, gems_dir, default_gem) ⇒ `StubSpecification`

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 70


def initialize(filename, base_dir, gems_dir, default_gem)
  super()

  self.loaded_from = filename
  @data            = nil
  @name            = nil
  @spec            = nil
  @base_dir        = base_dir
  @gems_dir        = gems_dir
  @default_gem     = default_gem
end

Class Method Details

.default_gemspec_stub(filename, base_dir, gems_dir)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 60


def self.default_gemspec_stub(filename, base_dir, gems_dir)
  new filename, base_dir, gems_dir, true
end

.gemspec_stub(filename, base_dir, gems_dir)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 64


def self.gemspec_stub(filename, base_dir, gems_dir)
  new filename, base_dir, gems_dir, false
end

Instance Attribute Details

#activated? ⇒ `Boolean` (readonly)

True when this gem has been activated

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 85


def activated?
  @activated ||= !loaded_spec.nil?
end

#base_dir (readonly)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 68


attr_reader :base_dir, :gems_dir

#default_gem? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def default_gem?
  @default_gem
end

#gems_dir (readonly)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 68


attr_reader :base_dir, :gems_dir

#missing_extensions? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 142


def missing_extensions?
  return false if default_gem?
  return false if extensions.empty?
  return false if File.exist? gem_build_complete_path

  to_spec.missing_extensions?
end

#stubbed? ⇒ `Boolean` (readonly)

Is there a stub line present for this StubSpecification?

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 202


def stubbed?
  data.is_a? StubLine
end

#valid? ⇒ `Boolean` (readonly)

Is this StubSpecification valid? i.e. have we found a stub line, OR does the filename contain a valid gemspec?

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 195


def valid?
  data
end

Instance Method Details

#<=>(other)

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 219


def <=>(other) # :nodoc:
  sort_obj <=> other.sort_obj
end

#==(other) Also known as: #eql?

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 206


def ==(other) # :nodoc:
  self.class === other &&
    name == other.name &&
    version == other.version &&
    platform == other.platform
end

#build_extensions

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 93


def build_extensions # :nodoc:
  return if default_gem?
  return if extensions.empty?

  to_spec.build_extensions
end

#data (private)

If the gemspec contains a stubline, returns a StubSpecification::StubLine instance. Otherwise returns the full Specification.

[ GitHub ]

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


def data
  unless @data
    begin
      saved_lineno = $.

      Gem.open_file loaded_from, OPEN_MODE do |file|
        file.readline # discard encoding line
        stubline = file.readline
        if stubline.start_with?(PREFIX)
          extline = file.readline

          extensions =
            if extline.delete_prefix!(PREFIX)
              extline.chomp!
              extline.split "\0"
            else
              StubLine::NO_EXTENSIONS
            end

          stubline.chomp! # readline(chomp: true) allocates 3x as much as .readline.chomp!
          @data = StubLine.new stubline, extensions
        end
      rescue EOFError
      end
    ensure
      $. = saved_lineno
    end
  end

  @data ||= to_spec
end

#eql?(other)

This method is for internal use only.

Alias for #==.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 213


alias_method :eql?, :== # :nodoc:

#extensions

Extensions for this gem

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 167


def extensions
  data.extensions
end

#full_name

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 178


def full_name
  data.full_name
end

#hash

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 215


def hash # :nodoc:
  name.hash ^ version.hash ^ platform.hash
end

#loaded_spec (private)

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 229


def loaded_spec
  spec = Gem.loaded_specs[name]
  return unless spec && spec.version == version && spec.default_gem? == default_gem?

  spec
end

#name

Name of the gem

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 153


def name
  data.name
end

#platform

Platform of the gem

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 160


def platform
  data.platform
end

#raw_require_paths

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 138


def raw_require_paths # :nodoc:
  data.require_paths
end

#sort_obj

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 223


def sort_obj # :nodoc:
  [name, version, Gem::Platform.sort_priority(platform)]
end

#spec Also known as: #to_spec

The full Specification for this gem, loaded from evalling its gemspec

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 185


def spec
  @spec ||= loaded_spec if @data
  @spec ||= Gem::Specification.load(loaded_from)
end

#to_spec

Alias for #spec.

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 189


alias_method :to_spec, :spec

#version

Version of the gem

[ GitHub ]

# File 'lib/rubygems/stub_specification.rb', line 174


def version
  data.version
end

Class: Gem::StubSpecification

Overview

Constant Summary

Class Method Summary

BasicSpecification - Inherited

Deprecate - Extended

Instance Attribute Summary

BasicSpecification - Inherited

Instance Method Summary

BasicSpecification - Inherited

Constructor Details

.new(filename, base_dir, gems_dir, default_gem) ⇒ StubSpecification

Class Method Details

.default_gemspec_stub(filename, base_dir, gems_dir)

.gemspec_stub(filename, base_dir, gems_dir)

Instance Attribute Details

#activated? ⇒ Boolean (readonly)

#base_dir (readonly)

#default_gem? ⇒ Boolean (readonly)

#gems_dir (readonly)

#missing_extensions? ⇒ Boolean (readonly)

#stubbed? ⇒ Boolean (readonly)

#valid? ⇒ Boolean (readonly)

Instance Method Details

#<=>(other)

#==(other) Also known as: #eql?

#build_extensions

#data (private)

#eql?(other)

#extensions

#full_name

#hash

#loaded_spec (private)

#name

#platform

#raw_require_paths

#sort_obj

#spec Also known as: #to_spec

#to_spec

#version

`BasicSpecification` - Inherited

`Deprecate` - Extended

`BasicSpecification` - Inherited

`BasicSpecification` - Inherited

.new(filename, base_dir, gems_dir, default_gem) ⇒ `StubSpecification`

#activated? ⇒ `Boolean` (readonly)

#default_gem? ⇒ `Boolean` (readonly)

#missing_extensions? ⇒ `Boolean` (readonly)

#stubbed? ⇒ `Boolean` (readonly)

#valid? ⇒ `Boolean` (readonly)