Gem::RequestSet::Lockfile

Parses a gem.deps.rb.lock file and constructs a LockSet containing the dependencies found inside. If the lock file is missing no LockSet is constructed.

Attributes

platforms[R]

The platforms for this Lockfile

Public Class Methods

new(request_set, gem_deps_file, dependencies = nil) click to toggle source

Creates a new Lockfile for the given request_set and gem_deps_file location.

 
               # File rubygems/request_set/lockfile.rb, line 52
def initialize request_set, gem_deps_file, dependencies = nil
  @set           = request_set
  @dependencies  = dependencies
  @gem_deps_file = File.expand_path(gem_deps_file)
  @gem_deps_dir  = File.dirname(@gem_deps_file)

  @gem_deps_file.untaint unless gem_deps_file.tainted?

  @current_token  = nil
  @line           = 0
  @line_pos       = 0
  @platforms      = []
  @tokens         = []
end

Public Instance Methods

add_GIT(out) click to toggle source

 
               # File rubygems/request_set/lockfile.rb, line 139
def add_GIT out
  return unless git_requests =
    @spec_groups.delete(Gem::Resolver::GitSpecification)

  by_repository_revision = git_requests.group_by do |request|
    source = request.spec.source
    [source.repository, source.rev_parse]
  end

  out << "GIT"
  by_repository_revision.each do |(repository, revision), requests|
    out << "  remote: #{repository}"
    out << "  revision: #{revision}"
    out << "  specs:"

    requests.sort_by { |request| request.name }.each do |request|
      out << "    #{request.name} (#{request.version})"

      dependencies = request.spec.dependencies.sort_by { |dep| dep.name }
      dependencies.each do |dep|
        out << "      #{dep.name}#{dep.requirement.for_lockfile}"
      end
    end
  end

  out << nil
end

to_s() click to toggle source

The contents of the lock file.

 
               # File rubygems/request_set/lockfile.rb, line 530
def to_s
  @set.resolve

  out = []

  @requests = @set.sorted_requests

  @spec_groups = @requests.group_by do |request|
    request.spec.class
  end

  add_PATH out

  add_GIT out

  add_GEM out

  add_PLATFORMS out

  add_DEPENDENCIES out

  out.join "\n"
end

write() click to toggle source

Writes the lock file alongside the gem dependencies file

 
               # File rubygems/request_set/lockfile.rb, line 641
def write
  content = to_s

  open "#{@gem_deps_file}.lock", 'w' do |io|
    io.write content
  end
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

Home Classes Methods

In Files

Parent

Namespace

Methods

Class/Module Index

Gem::RequestSet::Lockfile

Attributes

Public Class Methods

Public Instance Methods