class Bundler::LockfileParser

Constants

BUNDLED
DEPENDENCIES
ENVIRONMENT_VERSION_SECTIONS
GEM
GIT
KNOWN_SECTIONS
NAME_VERSION
OPTIONS
PATH
PLATFORMS
PLUGIN
RUBY
SECTIONS_BY_VERSION_INTRODUCED
SOURCE
SPECS
TYPES

Attributes

bundler_version[R]
dependencies[R]
platforms[R]
ruby_version[R]
sources[R]
specs[R]

Public Class Methods

new(lockfile) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 61
def initialize(lockfile)
  @platforms    = []
  @sources      = []
  @dependencies = {}
  @state        = nil
  @specs        = {}

  @rubygems_aggregate = Source::Rubygems.new

  if lockfile.match(/<<<<<<<|=======|>>>>>>>|\|\|\|\|\|\|\|/)
    raise LockfileError, "Your #{Bundler.default_lockfile.relative_path_from(SharedHelpers.pwd)} contains merge conflicts.\n" \
      "Run `git checkout HEAD -- #{Bundler.default_lockfile.relative_path_from(SharedHelpers.pwd)}` first to get a clean lock."
  end

  lockfile.split(/(?:\r?\n)+/).each do |line|
    if SOURCE.include?(line)
      @state = :source
      parse_source(line)
    elsif line == DEPENDENCIES
      @state = :dependency
    elsif line == PLATFORMS
      @state = :platform
    elsif line == RUBY
      @state = :ruby
    elsif line == BUNDLED
      @state = :bundled_with
    elsif line =~ /^[^\s]/
      @state = nil
    elsif @state
      send("parse_#{@state}", line)
    end
  end
  @sources << @rubygems_aggregate unless Bundler.feature_flag.lockfile_uses_separate_rubygems_sources?
  @specs = @specs.values.sort_by(&:identifier)
  warn_for_outdated_bundler_version
rescue ArgumentError => e
  Bundler.ui.debug(e)
  raise LockfileError, "Your lockfile is unreadable. Run `rm #{Bundler.default_lockfile.relative_path_from(SharedHelpers.pwd)}` " \
    "and then `bundle install` to generate a new lockfile."
end
sections_in_lockfile(lockfile_contents) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 42
def self.sections_in_lockfile(lockfile_contents)
  lockfile_contents.scan(/^\w[\w ]*$/).uniq
end
sections_to_ignore(base_version = nil) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 50
def self.sections_to_ignore(base_version = nil)
  base_version &&= base_version.release
  base_version ||= Gem::Version.create("1.0".dup)
  attributes = []
  SECTIONS_BY_VERSION_INTRODUCED.each do |version, introduced|
    next if version <= base_version
    attributes += introduced
  end
  attributes
end
unknown_sections_in_lockfile(lockfile_contents) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 46
def self.unknown_sections_in_lockfile(lockfile_contents)
  sections_in_lockfile(lockfile_contents) - KNOWN_SECTIONS
end

Public Instance Methods

parse_bundled_with(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 246
  def parse_bundled_with(line)
    line = line.strip
    return unless Gem::Version.correct?(line)
    @bundler_version = Gem::Version.create(line)
  end

  def parse_ruby(line)
    @ruby_version = line.strip
  end
end
parse_dependency(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 190
  def parse_dependency(line)
    return unless line =~ NAME_VERSION
    spaces = $1
    return unless spaces.size == 2
    name = $2
    version = $3
    pinned = $5

    version = version.split(",").map(&:strip) if version

    dep = Bundler::Dependency.new(name, version)

    if pinned && dep.name != "bundler"
      spec = @specs.find {|_, v| v.name == dep.name }
      dep.source = spec.last.source if spec

      # Path sources need to know what the default name / version
      # to use in the case that there are no gemspecs present. A fake
      # gemspec is created based on the version set on the dependency
      # TODO: Use the version from the spec instead of from the dependency
      if version && version.size == 1 && version.first =~ /^\s*= (.+)\s*$/ && dep.source.is_a?(Bundler::Source::Path)
        dep.source.name    = name
        dep.source.version = $1
      end
    end

    @dependencies[dep.name] = dep
  end

  def parse_spec(line)
    return unless line =~ NAME_VERSION
    spaces = $1
    name = $2
    version = $3
    platform = $4

    if spaces.size == 4
      version = Gem::Version.new(version)
      platform = platform ? Gem::Platform.new(platform) : Gem::Platform::RUBY
      @current_spec = LazySpecification.new(name, version, platform)
      @current_spec.source = @current_source

      # Avoid introducing multiple copies of the same spec (caused by
      # duplicate GIT sections)
      @specs[@current_spec.identifier] ||= @current_spec
    elsif spaces.size == 6
      version = version.split(",").map(&:strip) if version
      dep = Gem::Dependency.new(name, version)
      @current_spec.dependencies << dep
    end
  end

  def parse_platform(line)
    @platforms << Gem::Platform.new($1) if line =~ /^  (.*)$/
  end

  def parse_bundled_with(line)
    line = line.strip
    return unless Gem::Version.correct?(line)
    @bundler_version = Gem::Version.create(line)
  end

  def parse_ruby(line)
    @ruby_version = line.strip
  end
end
parse_platform(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 242
def parse_platform(line)
  @platforms << Gem::Platform.new($1) if line =~ /^  (.*)$/
end
parse_ruby(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 252
def parse_ruby(line)
  @ruby_version = line.strip
end
parse_source(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 128
def parse_source(line)
  case line
  when SPECS
    case @type
    when PATH
      @current_source = TYPES[@type].from_lock(@opts)
      @sources << @current_source
    when GIT
      @current_source = TYPES[@type].from_lock(@opts)
      # Strip out duplicate GIT sections
      if @sources.include?(@current_source)
        @current_source = @sources.find {|s| s == @current_source }
      else
        @sources << @current_source
      end
    when GEM
      if Bundler.feature_flag.lockfile_uses_separate_rubygems_sources?
        @opts["remotes"] = @opts.delete("remote")
        @current_source = TYPES[@type].from_lock(@opts)
        @sources << @current_source
      else
        Array(@opts["remote"]).each do |url|
          @rubygems_aggregate.add_remote(url)
        end
        @current_source = @rubygems_aggregate
      end
    when PLUGIN
      @current_source = Plugin.source_from_lock(@opts)
      @sources << @current_source
    end
  when OPTIONS
    value = $2
    value = true if value == "true"
    value = false if value == "false"

    key = $1

    if @opts[key]
      @opts[key] = Array(@opts[key])
      @opts[key] << value
    else
      @opts[key] = value
    end
  when *SOURCE
    @current_source = nil
    @opts = {}
    @type = line
  else
    parse_spec(line)
  end
end
parse_spec(line) click to toggle source
# File lib/bundler/lockfile_parser.rb, line 219
    def parse_spec(line)
      return unless line =~ NAME_VERSION
      spaces = $1
      name = $2
      version = $3
      platform = $4

      if spaces.size == 4
        version = Gem::Version.new(version)
        platform = platform ? Gem::Platform.new(platform) : Gem::Platform::RUBY
        @current_spec = LazySpecification.new(name, version, platform)
        @current_spec.source = @current_source

        # Avoid introducing multiple copies of the same spec (caused by
        # duplicate GIT sections)
        @specs[@current_spec.identifier] ||= @current_spec
      elsif spaces.size == 6
        version = version.split(",").map(&:strip) if version
        dep = Gem::Dependency.new(name, version)
        @current_spec.dependencies << dep
      end
    end

    def parse_platform(line)
      @platforms << Gem::Platform.new($1) if line =~ /^  (.*)$/
    end

    def parse_bundled_with(line)
      line = line.strip
      return unless Gem::Version.correct?(line)
      @bundler_version = Gem::Version.create(line)
    end

    def parse_ruby(line)
      @ruby_version = line.strip
    end
  end
end
warn_for_outdated_bundler_version() click to toggle source
# File lib/bundler/lockfile_parser.rb, line 102
  def warn_for_outdated_bundler_version
    return unless bundler_version
    prerelease_text = bundler_version.prerelease? ? " --pre" : ""
    current_version = Gem::Version.create(Bundler::VERSION)
    case current_version.segments.first <=> bundler_version.segments.first
    when -1
      raise LockfileError, "You must use Bundler #{bundler_version.segments.first} or greater with this lockfile."
    when 0
      if current_version < bundler_version
        Bundler.ui.warn "Warning: the running version of Bundler (#{current_version}) is older " \
             "than the version that created the lockfile (#{bundler_version}). We suggest you " \
             "upgrade to the latest version of Bundler by running `gem " \
             "install bundler#{prerelease_text}`.\n"
      end
    end
  end

private

  TYPES = {
    GIT    => Bundler::Source::Git,
    GEM    => Bundler::Source::Rubygems,
    PATH   => Bundler::Source::Path,
    PLUGIN => Bundler::Plugin,
  }.freeze

  def parse_source(line)
    case line
    when SPECS
      case @type
      when PATH
        @current_source = TYPES[@type].from_lock(@opts)
        @sources << @current_source
      when GIT
        @current_source = TYPES[@type].from_lock(@opts)
        # Strip out duplicate GIT sections
        if @sources.include?(@current_source)
          @current_source = @sources.find {|s| s == @current_source }
        else
          @sources << @current_source
        end
      when GEM
        if Bundler.feature_flag.lockfile_uses_separate_rubygems_sources?
          @opts["remotes"] = @opts.delete("remote")
          @current_source = TYPES[@type].from_lock(@opts)
          @sources << @current_source
        else
          Array(@opts["remote"]).each do |url|
            @rubygems_aggregate.add_remote(url)
          end
          @current_source = @rubygems_aggregate
        end
      when PLUGIN
        @current_source = Plugin.source_from_lock(@opts)
        @sources << @current_source
      end
    when OPTIONS
      value = $2
      value = true if value == "true"
      value = false if value == "false"

      key = $1

      if @opts[key]
        @opts[key] = Array(@opts[key])
        @opts[key] << value
      else
        @opts[key] = value
      end
    when *SOURCE
      @current_source = nil
      @opts = {}
      @type = line
    else
      parse_spec(line)
    end
  end

  space = / /
  NAME_VERSION = /
    ^(#{space}{2}|#{space}{4}|#{space}{6})(?!#{space}) # Exactly 2, 4, or 6 spaces at the start of the line
    (.*?)                                              # Name
    (?:#{space}\(([^-]*)                               # Space, followed by version
    (?:-(.*))?\))?                                     # Optional platform
    (!)?                                               # Optional pinned marker
    $                                                  # Line end
  /xo

  def parse_dependency(line)
    return unless line =~ NAME_VERSION
    spaces = $1
    return unless spaces.size == 2
    name = $2
    version = $3
    pinned = $5

    version = version.split(",").map(&:strip) if version

    dep = Bundler::Dependency.new(name, version)

    if pinned && dep.name != "bundler"
      spec = @specs.find {|_, v| v.name == dep.name }
      dep.source = spec.last.source if spec

      # Path sources need to know what the default name / version
      # to use in the case that there are no gemspecs present. A fake
      # gemspec is created based on the version set on the dependency
      # TODO: Use the version from the spec instead of from the dependency
      if version && version.size == 1 && version.first =~ /^\s*= (.+)\s*$/ && dep.source.is_a?(Bundler::Source::Path)
        dep.source.name    = name
        dep.source.version = $1
      end
    end

    @dependencies[dep.name] = dep
  end

  def parse_spec(line)
    return unless line =~ NAME_VERSION
    spaces = $1
    name = $2
    version = $3
    platform = $4

    if spaces.size == 4
      version = Gem::Version.new(version)
      platform = platform ? Gem::Platform.new(platform) : Gem::Platform::RUBY
      @current_spec = LazySpecification.new(name, version, platform)
      @current_spec.source = @current_source

      # Avoid introducing multiple copies of the same spec (caused by
      # duplicate GIT sections)
      @specs[@current_spec.identifier] ||= @current_spec
    elsif spaces.size == 6
      version = version.split(",").map(&:strip) if version
      dep = Gem::Dependency.new(name, version)
      @current_spec.dependencies << dep
    end
  end

  def parse_platform(line)
    @platforms << Gem::Platform.new($1) if line =~ /^  (.*)$/
  end

  def parse_bundled_with(line)
    line = line.strip
    return unless Gem::Version.correct?(line)
    @bundler_version = Gem::Version.create(line)
  end

  def parse_ruby(line)
    @ruby_version = line.strip
  end