Module: Bundler::GemHelpers

Included in:
Definition, LockfileParser, MatchPlatform, Resolver
Defined in:
lib/bundler/gem_helpers.rb

Defined Under Namespace

Classes: PlatformMatch

Constant Summary collapse

GENERIC_CACHE =

rubocop:disable Style/MutableConstant

{ Gem::Platform::RUBY => Gem::Platform::RUBY }
GENERICS = 
[
  [Gem::Platform.new("java"), Gem::Platform.new("java")],
  [Gem::Platform.new("mswin32"), Gem::Platform.new("mswin32")],
  [Gem::Platform.new("mswin64"), Gem::Platform.new("mswin64")],
  [Gem::Platform.new("universal-mingw32"), Gem::Platform.new("universal-mingw32")],
  [Gem::Platform.new("x64-mingw32"), Gem::Platform.new("x64-mingw32")],
  [Gem::Platform.new("x86_64-mingw32"), Gem::Platform.new("x64-mingw32")],
  [Gem::Platform.new("x64-mingw-ucrt"), Gem::Platform.new("x64-mingw-ucrt")],
  [Gem::Platform.new("mingw32"), Gem::Platform.new("x86-mingw32")],
].freeze

Class Method Summary collapse

Class Method Details

.generic(p) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/bundler/gem_helpers.rb', line 17

def generic(p)
  GENERIC_CACHE[p] ||= begin
    _, found = GENERICS.find do |match, _generic|
      p.os == match.os && (!match.cpu || p.cpu == match.cpu)
    end
    found || Gem::Platform::RUBY
  end
end

.generic_local_platform ⇒ Object 



27
28
29
 
# File 'lib/bundler/gem_helpers.rb', line 27

def generic_local_platform
  generic(local_platform)
end

.generic_local_platform_is_ruby? ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
 
# File 'lib/bundler/gem_helpers.rb', line 37

def generic_local_platform_is_ruby?
  generic_local_platform == Gem::Platform::RUBY
end

.local_platform ⇒ Object 



32
33
34
 
# File 'lib/bundler/gem_helpers.rb', line 32

def local_platform
  Bundler.local_platform
end

.platform_specificity_match(spec_platform, user_platform) ⇒ Object 



42
43
44
45
46
 
# File 'lib/bundler/gem_helpers.rb', line 42

def platform_specificity_match(spec_platform, user_platform)
  spec_platform = Gem::Platform.new(spec_platform)

  PlatformMatch.specificity_score(spec_platform, user_platform)
end

.same_deps(spec, exemplary_spec) ⇒ Object 



143
144
145
146
147
 
# File 'lib/bundler/gem_helpers.rb', line 143

def same_deps(spec, exemplary_spec)
  same_runtime_deps = spec.dependencies.sort == exemplary_spec.dependencies.sort
  same_metadata_deps = spec.required_ruby_version == exemplary_spec.required_ruby_version && spec.required_rubygems_version == exemplary_spec.required_rubygems_version
  same_runtime_deps && same_metadata_deps
end

.same_specificity(platform, spec, exemplary_spec) ⇒ Object 



138
139
140
 
# File 'lib/bundler/gem_helpers.rb', line 138

def same_specificity(platform, spec, exemplary_spec)
  platform_specificity_match(spec.platform, platform) == platform_specificity_match(exemplary_spec.platform, platform)
end

.select_all_platform_match(specs, platform, force_ruby: false, prefer_locked: false) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/bundler/gem_helpers.rb', line 49

def select_all_platform_match(specs, platform, force_ruby: false, prefer_locked: false)
  matching = if force_ruby
    specs.select {|spec| spec.match_platform(Gem::Platform::RUBY) && spec.force_ruby_platform! }
  else
    specs.select {|spec| spec.match_platform(platform) }
  end

  if prefer_locked
    locked_originally = matching.select {|spec| spec.is_a?(LazySpecification) }
    return locked_originally if locked_originally.any?
  end

  matching
end

.select_best_local_platform_match(specs, force_ruby: false) ⇒ Object 



72
73
74
75
76
 
# File 'lib/bundler/gem_helpers.rb', line 72

def select_best_local_platform_match(specs, force_ruby: false)
  matching = select_all_platform_match(specs, local_platform, force_ruby: force_ruby).filter_map(&:materialized_for_installation)

  sort_best_platform_match(matching, local_platform)
end

.select_best_platform_match(specs, platform, force_ruby: false, prefer_locked: false) ⇒ Object 



65
66
67
68
69
 
# File 'lib/bundler/gem_helpers.rb', line 65

def select_best_platform_match(specs, platform, force_ruby: false, prefer_locked: false)
  matching = select_all_platform_match(specs, platform, force_ruby: force_ruby, prefer_locked: prefer_locked)

  sort_and_filter_best_platform_match(matching, platform)
end

.sort_and_filter_best_platform_match(matching, platform) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bundler/gem_helpers.rb', line 79

def sort_and_filter_best_platform_match(matching, platform)
  return matching if matching.one?

  exact = matching.select {|spec| spec.platform == platform }
  return exact if exact.any?

  sorted_matching = sort_best_platform_match(matching, platform)
  exemplary_spec = sorted_matching.first

  sorted_matching.take_while {|spec| same_specificity(platform, spec, exemplary_spec) && same_deps(spec, exemplary_spec) }
end

.sort_best_platform_match(matching, platform) ⇒ Object 



92
93
94
 
# File 'lib/bundler/gem_helpers.rb', line 92

def sort_best_platform_match(matching, platform)
  matching.sort_by {|spec| platform_specificity_match(spec.platform, platform) }
end