Class: Gem::Source (Ruby 2.3.7)
Description: Class : Gem::Source - Ruby 2.3.7

- Home
- Core 2.3.7
- Std-lib 2.3.7
- Downloads

Support for the Ruby 2.3 series has ended. See here for reference.

### Home Classes Methods

### In Files

- rubygems/source.rb
- rubygems/source/git.rb
- rubygems/source/installed.rb
- rubygems/source/local.rb
- rubygems/source/lock.rb
- rubygems/source/specific_file.rb
- rubygems/source/vendor.rb
- rubygems/specification.rb

### Parent

Object

### Namespace

- CLASS Gem::Source::Git
- CLASS Gem::Source::Installed
- CLASS Gem::Source::Local
- CLASS Gem::Source::Lock
- CLASS Gem::Source::SpecificFile
- CLASS Gem::Source::Vendor

### Methods

- ::new
- #<=>
- #cache_dir
- #download
- #fetch_spec
- #load_specs
- #update_cache?

### Included Modules

- Comparable

### Class/Module Index

Quicksearch

- Gem::AvailableSet
- Gem::BasicSpecification
- Gem::Command
- Gem::CommandLineError
- Gem::CommandManager
- Gem::Commands
- Gem::Commands::BuildCommand
- Gem::Commands::CertCommand
- Gem::Commands::CheckCommand
- Gem::Commands::CleanupCommand
- Gem::Commands::ContentsCommand
- Gem::Commands::DependencyCommand
- Gem::Commands::EnvironmentCommand
- Gem::Commands::FetchCommand
- Gem::Commands::GenerateIndexCommand
- Gem::Commands::HelpCommand
- Gem::Commands::InstallCommand
- Gem::Commands::ListCommand
- Gem::Commands::LockCommand
- Gem::Commands::MirrorCommand
- Gem::Commands::OpenCommand
- Gem::Commands::OutdatedCommand
- Gem::Commands::OwnerCommand
- Gem::Commands::PristineCommand
- Gem::Commands::PushCommand
- Gem::Commands::QueryCommand
- Gem::Commands::RdocCommand
- Gem::Commands::SearchCommand
- Gem::Commands::ServerCommand
- Gem::Commands::SetupCommand
- Gem::Commands::SourcesCommand
- Gem::Commands::SpecificationCommand
- Gem::Commands::StaleCommand
- Gem::Commands::UninstallCommand
- Gem::Commands::UnpackCommand
- Gem::Commands::UpdateCommand
- Gem::Commands::WhichCommand
- Gem::Commands::YankCommand
- Gem::ConfigFile
- Gem::ConflictError
- Gem::ConsoleUI
- Gem::DefaultUserInteraction
- Gem::Dependency
- Gem::DependencyError
- Gem::DependencyInstaller
- Gem::DependencyList
- Gem::DependencyRemovalException
- Gem::DependencyResolutionError
- Gem::Deprecate
- Gem::Doctor
- Gem::DocumentError
- Gem::EndOfYAMLException
- Gem::ErrorReason
- Gem::Exception
- Gem::Ext
- Gem::Ext::BuildError
- Gem::Ext::Builder
- Gem::Ext::CmakeBuilder
- Gem::Ext::ConfigureBuilder
- Gem::Ext::ExtConfBuilder
- Gem::Ext::RakeBuilder
- Gem::FakeFetcher
- Gem::FilePermissionError
- Gem::FormatException
- Gem::GemNotFoundException
- Gem::GemNotInHomeException
- Gem::GemRunner
- Gem::GemcutterUtilities
- Gem::ImpossibleDependenciesError
- Gem::Indexer
- Gem::InstallError
- Gem::InstallUpdateOptions
- Gem::Installer
- Gem::Installer::FakePackage
- Gem::InstallerTestCase
- Gem::InvalidSpecificationException
- Gem::Licenses
- Gem::List
- Gem::LoadError
- Gem::LocalRemoteOptions
- Gem::MockGemUi
- Gem::MockGemUi::InputEOFError
- Gem::MockGemUi::SystemExitException
- Gem::MockGemUi::TTY
- Gem::MockGemUi::TermError
- Gem::NameTuple
- Gem::NoAliasYAMLTree
- Gem::OperationNotSupportedError
- Gem::Package::DigestIO
- Gem::Package::Error
- Gem::Package::FormatError
- Gem::Package::NonSeekableIO
- Gem::Package::Old
- Gem::Package::PathError
- Gem::Package::TarHeader
- Gem::Package::TarInvalidError
- Gem::Package::TarReader
- Gem::Package::TarReader::Entry
- Gem::Package::TarReader::UnexpectedEOF
- Gem::Package::TarTestCase
- Gem::Package::TarWriter
- Gem::Package::TarWriter::BoundedStream
- Gem::Package::TarWriter::FileOverflow
- Gem::Package::TarWriter::RestrictedStream
- Gem::Package::TooLongFileName
- Gem::PackageTask
- Gem::PathSupport
- Gem::Platform
- Gem::PlatformMismatch
- Gem::RemoteError
- Gem::RemoteFetcher
- Gem::RemoteFetcher::FetchError
- Gem::RemoteFetcher::UnknownHostError
- Gem::RemoteInstallationCancelled
- Gem::RemoteInstallationSkipped
- Gem::RemoteSourceException
- Gem::Request::ConnectionPools
- Gem::Request::ConnectionPools::Net
- Gem::RequestSet
- Gem::RequestSet::GemDependencyAPI
- Gem::RequestSet::Lockfile
- Gem::RequestSet::Lockfile::ParseError
- Gem::RequestSet::Lockfile::Parser
- Gem::RequestSet::Lockfile::Tokenizer
- Gem::Requirement
- Gem::Requirement::BadRequirementError
- Gem::Resolver
- Gem::Resolver::APISet
- Gem::Resolver::APISpecification
- Gem::Resolver::ActivationRequest
- Gem::Resolver::BestSet
- Gem::Resolver::ComposedSet
- Gem::Resolver::Conflict
- Gem::Resolver::CurrentSet
- Gem::Resolver::DependencyRequest
- Gem::Resolver::GitSet
- Gem::Resolver::GitSpecification
- Gem::Resolver::IndexSet
- Gem::Resolver::IndexSpecification
- Gem::Resolver::InstalledSpecification
- Gem::Resolver::InstallerSet
- Gem::Resolver::LocalSpecification
- Gem::Resolver::LockSet
- Gem::Resolver::LockSpecification
- Gem::Resolver::Molinillo
- Gem::Resolver::Molinillo::CircularDependencyError
- Gem::Resolver::Molinillo::DependencyGraph
- Gem::Resolver::Molinillo::DependencyGraph::Vertex
- Gem::Resolver::Molinillo::DependencyState
- Gem::Resolver::Molinillo::NoSuchDependencyError
- Gem::Resolver::Molinillo::PossibilityState
- Gem::Resolver::Molinillo::ResolutionState
- Gem::Resolver::Molinillo::Resolver
- Gem::Resolver::Molinillo::Resolver::Resolution
- Gem::Resolver::Molinillo::ResolverError
- Gem::Resolver::Molinillo::SpecificationProvider
- Gem::Resolver::Molinillo::UI
- Gem::Resolver::Molinillo::VersionConflict
- Gem::Resolver::RequirementList
- Gem::Resolver::Set
- Gem::Resolver::SourceSet
- Gem::Resolver::SpecSpecification
- Gem::Resolver::Specification
- Gem::Resolver::Stats
- Gem::Resolver::VendorSet
- Gem::Resolver::VendorSpecification
- Gem::RubyVersionMismatch
- Gem::SafeYAML
- Gem::Security
- Gem::Security::Exception
- Gem::Security::Policy
- Gem::Security::Signer
- Gem::Security::TrustDir
- Gem::Server
- Gem::SilentUI
- Gem::Source
- Gem::Source::Git
- Gem::Source::Installed
- Gem::Source::Local
- Gem::Source::Lock
- Gem::Source::SpecificFile
- Gem::Source::Vendor
- Gem::SourceFetchProblem
- Gem::SourceList
- Gem::SpecFetcher
- Gem::SpecificGemNotFoundException
- Gem::Specification
- Gem::StreamUI
- Gem::StreamUI::SilentDownloadReporter
- Gem::StreamUI::SilentProgressReporter
- Gem::StreamUI::SimpleProgressReporter
- Gem::StreamUI::VerboseDownloadReporter
- Gem::StreamUI::VerboseProgressReporter
- Gem::StubSpecification
- Gem::SystemExitException
- Gem::TestCase
- Gem::TestCase::SpecFetcherSetup
- Gem::TestCase::StaticSet
- Gem::Text
- Gem::Uninstaller
- Gem::UnsatisfiableDependencyError
- Gem::UriFormatter
- Gem::UserInteraction
- Gem::Util
- Gem::Validator
- Gem::VerificationError
- Gem::Version
- Gem::VersionOption
- Kernel
- Object
- OpenSSL
- TempIO
- YAML::Syck
- YAML::Syck

No matching classes.

# Gem::Source

A Source knows how to list and fetch gems from a RubyGems marshal index.

There are other Source subclasses for installed gems, local gems, the bundler dependency API and so-forth.

### Attributes

uri[R]

The URI this source will fetch gems from.

### Public Class Methods

new(uri) click to toggle source

Creates a new Source which will use the index located at `uri`.

                   # File rubygems/source.rb, line 28
    def initialize(uri)
      begin
        unless uri.kind_of? URI
          uri = URI.parse(uri.to_s)
        end
      rescue URI::InvalidURIError
        raise if Gem::Source == self.class
      end

      @uri = uri
      @api_uri = nil
    end

### Public Instance Methods

<=>(other) click to toggle source

Sources are ordered by installation preference.

                   # File rubygems/source.rb, line 52
    def <=>(other)
      case other
      when Gem::Source::Installed,
           Gem::Source::Local,
           Gem::Source::Lock,
           Gem::Source::SpecificFile,
           Gem::Source::Git,
           Gem::Source::Vendor then
        -1
      when Gem::Source then
        if !@uri
          return 0 unless other.uri
          return 1
        end

        return -1 if !other.uri

        @uri.to_s <=> other.uri.to_s
      else
        nil
      end
    end

cache_dir(uri) click to toggle source

Returns the local directory to write `uri` to.

                   # File rubygems/source.rb, line 110
    def cache_dir(uri)
      # Correct for windows paths
      escaped_path = uri.path.sub(/^\/([a-z]):\//i, '/\\1-/')
      escaped_path.untaint

      File.join Gem.spec_cache_dir, "#{uri.host}%#{uri.port}", File.dirname(escaped_path)
    end

download(spec, dir=Dir.pwd) click to toggle source

Downloads `spec` and writes it to `dir`. See also Gem::RemoteFetcher#download.

                   # File rubygems/source.rb, line 208
    def download(spec, dir=Dir.pwd)
      fetcher = Gem::RemoteFetcher.fetcher
      fetcher.download spec, api_uri.to_s, dir
    end

fetch_spec(name_tuple) click to toggle source

Fetches a specification for the given `name_tuple`.

                   # File rubygems/source.rb, line 133
    def fetch_spec name_tuple
      fetcher = Gem::RemoteFetcher.fetcher

      spec_file_name = name_tuple.spec_name

      uri = api_uri + "#{Gem::MARSHAL_SPEC_DIR}#{spec_file_name}"

      cache_dir = cache_dir uri

      local_spec = File.join cache_dir, spec_file_name

      if File.exist? local_spec then
        spec = Gem.read_binary local_spec
        spec = Marshal.load(spec) rescue nil
        return spec if spec
      end

      uri.path << '.rz'

      spec = fetcher.fetch_path uri
      spec = Gem.inflate spec

      if update_cache? then
        FileUtils.mkdir_p cache_dir

        open local_spec, 'wb' do |io|
          io.write spec
        end
      end

      # TODO: Investigate setting Gem::Specification#loaded_from to a URI
      Marshal.load spec
    end

load_specs(type) click to toggle source

Loads `type` kind of specs fetching from +@uri+ if the on-disk cache is out of date.

`type` is one of the following:

:released => Return the list of all released specs :latest => Return the list of only the highest version of each gem :prerelease => Return the list of all prerelease only specs

                   # File rubygems/source.rb, line 178
    def load_specs(type)
      file       = FILES[type]
      fetcher    = Gem::RemoteFetcher.fetcher
      file_name  = "#{file}.#{Gem.marshal_version}"
      spec_path  = api_uri + "#{file_name}.gz"
      cache_dir  = cache_dir spec_path
      local_file = File.join(cache_dir, file_name)
      retried    = false

      FileUtils.mkdir_p cache_dir if update_cache?

      spec_dump = fetcher.cache_update_path spec_path, local_file, update_cache?

      begin
        Gem::NameTuple.from_list Marshal.load(spec_dump)
      rescue ArgumentError
        if update_cache? && !retried
          FileUtils.rm local_file
          retried = true
          retry
        else
          raise Gem::Exception.new("Invalid spec cache file in #{local_file}")
        end
      end
    end

update_cache?() click to toggle source

Returns true when it is possible and safe to update the cache directory.

                   # File rubygems/source.rb, line 121
    def update_cache?
      @update_cache ||=
        begin
          File.stat(Gem.user_home).uid == Process.uid
        rescue Errno::ENOENT
          false
        end
    end