123456789_123456789_123456789_123456789_123456789_

Class: RBS::Collection::Config::LockfileGenerator

Relationships & Source Files
Namespace Children
Exceptions:
GemfileLockMismatchError
Inherits: Object
Defined in: lib/rbs/collection/config/lockfile_generator.rb

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(config_path:, gemfile_lock_path:, with_lockfile:) ⇒ LockfileGenerator

[ GitHub ] 

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 29



def initialize(config_path:, gemfile_lock_path:, with_lockfile:)
  @config = Config.from_path config_path
  @lock_path = Config.to_lockfile_path(config_path)
  @lock = Config.from_path(lock_path) if lock_path.exist? && with_lockfile
  @gemfile_lock = Bundler::LockfileParser.new(gemfile_lock_path.read)
  @gem_queue = []

  validate_gemfile_lock_path!(lock: lock, gemfile_lock_path: gemfile_lock_path)

  config.gemfile_lock_path = gemfile_lock_path
end


  







Class Method Details



  

    .generate(config_path:, gemfile_lock_path:, with_lockfile: true)  
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 25



def self.generate(config_path:, gemfile_lock_path:, with_lockfile: true)
  new(config_path: config_path, gemfile_lock_path: gemfile_lock_path, with_lockfile: with_lockfile).generate
end


  







Instance Attribute Details



  

    #config   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 23



attr_reader :config, :lock, :gemfile_lock, :lock_path


  








  

    #gemfile_lock   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 23



attr_reader :config, :lock, :gemfile_lock, :lock_path


  








  

    #lock   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 23



attr_reader :config, :lock, :gemfile_lock, :lock_path


  








  

    #lock_path   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 23



attr_reader :config, :lock, :gemfile_lock, :lock_path


  







Instance Method Details



  

    #assign_gem(name:, version:)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 67



private def assign_gem(name:, version:)
  # @type var locked: gem_entry?
  locked = lock&.gem(name)
  specified = config.gem(name)

  return if specified&.dig('ignore')
  return if specified&.dig('source') # skip if the source is already filled

  # If rbs_collection.lock.yaml contain the gem, use it.
  # Else find the gem from gem_collection.
  unless locked
    source = find_source(name: name)
    return unless source

    installed_version = version
    best_version = find_best_version(version: installed_version, versions: source.versions({ 'name' => name }))

    locked = {
      'name' => name,
      'version' => best_version.to_s,
      'source' => source.to_lockfile,
    }
  end

  locked or raise

  upsert_gem specified, locked
  source = Sources.from_config_entry(locked['source'] || raise)
  source.dependencies_of(locked)&.each do |dep|
    @gem_queue.push({ name: dep['name'], version: nil} )
  end
end


  








  

    #find_best_version(version:, versions:)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 124



private def find_best_version(version:, versions:)
  candidates = versions.map { |v| Gem::Version.create(v) or raise }
  return candidates.max || raise unless version

  v = Gem::Version.create(version) or raise
  Repository.find_best_version(v, candidates)
end


  








  

    #find_source(name:)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 118



private def find_source(name:)
  sources = config.sources

  sources.find { |c| c.has?({ 'name' => name, 'revision' => nil } ) }
end


  








  

    #gemfile_lock_gems(&block)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 112



private def gemfile_lock_gems(&block)
  gemfile_lock.specs.each do |spec|
    yield spec
  end
end


  








  

    #generate  
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 41



def generate
  config.gems.each do |gem|
    @gem_queue.push({ name: gem['name'], version: gem['version'] })
  end

  gemfile_lock_gems do |spec|
    @gem_queue.push({ name: spec.name, version: spec.version })
  end

  while gem = @gem_queue.shift
    assign_gem(**gem)
  end
  remove_ignored_gems!

  config.dump_to(lock_path)
  config
end


  








  

    #remove_ignored_gems!   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 108



private def remove_ignored_gems!
  config.gems.reject! { |gem| gem['ignore'] }
end


  








  

    #upsert_gem(old, new)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 100



private def upsert_gem(old, new)
  if old
    old.merge! new
  else
    config.add_gem new
  end
end


  








  

    #validate_gemfile_lock_path!(lock:, gemfile_lock_path:)   (private)
  



  

    
  





  
Raises:





  [ GitHub ]


  

  


# File 'lib/rbs/collection/config/lockfile_generator.rb', line 59



private def validate_gemfile_lock_path!(lock:, gemfile_lock_path:)
  return unless lock
  return unless lock.gemfile_lock_path
  return if lock.gemfile_lock_path == gemfile_lock_path

  raise GemfileLockMismatchError.new(expected: lock.gemfile_lock_path, actual: gemfile_lock_path)
end