Class: Bundler::Dependency

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Gem::Dependency`
Instance Chain: self, `::Gem::Dependency`, `ForcePlatform`
Inherits:	Gem::Dependency Object Gem::Dependency Bundler::Dependency
Defined in:	lib/bundler/dependency.rb

Constant Summary

ALL_RUBY_VERSIONS =
# File 'lib/bundler/dependency.rb', line 12
```
((18..27).to_a + (30..33).to_a).freeze
```

PLATFORM_MAP =
# File 'lib/bundler/dependency.rb', line 13

{
  :ruby => [Gem::Platform::RUBY, ALL_RUBY_VERSIONS],
  :mri => [Gem::Platform::RUBY, ALL_RUBY_VERSIONS],
  :rbx => [Gem::Platform::RUBY],
  :truffleruby => [Gem::Platform::RUBY],
  :jruby => [Gem::Platform::JAVA, [18, 19]],
  :windows => [Gem::Platform::WINDOWS, ALL_RUBY_VERSIONS],
  :mswin => [Gem::Platform::MSWIN,     ALL_RUBY_VERSIONS],
  :mswin64 => [Gem::Platform::MSWIN64, ALL_RUBY_VERSIONS - [18]],
  :mingw => [Gem::Platform::MINGW, ALL_RUBY_VERSIONS],
  :x64_mingw => [Gem::Platform::X64_MINGW, ALL_RUBY_VERSIONS - [18, 19]],
}.each_with_object({}) do |(platform, spec), hash|
  hash[platform] = spec[0]
  spec[1]&.each {|version| hash[:"#{platform}_#{version}"] = spec[0] }
end.freeze

Class Method Summary

.new(name, version, options = {}, &blk) ⇒ Dependency constructor

Instance Attribute Summary

#autorequire readonly
#branch readonly
#current_env? ⇒ Boolean readonly
#current_platform? ⇒ Boolean readonly
#gemfile readonly
#git readonly
#github readonly
#groups readonly
#path readonly
#platforms readonly
#ref readonly
#should_include? ⇒ Boolean readonly
#specific? ⇒ Boolean readonly

`::Gem::Dependency` - Inherited

#groups, #source

Instance Method Summary

#expanded_platforms
#gem_platforms(valid_platforms)

Returns the platforms this dependency is valid for, in the same order as passed in the valid_platforms parameter.
#to_lock

`::Gem::Dependency` - Inherited

#encode_with, #eql?, #force_ruby_platform, #to_lock, #to_yaml_properties

`ForcePlatform` - Included

#default_force_ruby_platform

The :force_ruby_platform value used by dependencies for resolution, and by locked specifications for materialization is false by default, except for TruffleRuby.

Constructor Details

.new(name, version, options = {}, &blk) ⇒ `Dependency`

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 29


def initialize(name, version, options = {}, &blk)
  type = options["type"] || :runtime
  super(name, version, type)

  @autorequire    = nil
  @groups         = Array(options["group"] || :default).map(&:to_sym)
  @source         = options["source"]
  @path           = options["path"]
  @git            = options["git"]
  @github         = options["github"]
  @branch         = options["branch"]
  @ref            = options["ref"]
  @platforms      = Array(options["platforms"])
  @env            = options["env"]
  @should_include = options.fetch("should_include", true)
  @gemfile        = options["gemfile"]
  @force_ruby_platform = options["force_ruby_platform"] if options.key?("force_ruby_platform")

  @autorequire = Array(options["require"] || []) if options.key?("require")
end

Instance Attribute Details

#autorequire (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 9


attr_reader :autorequire

#branch (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#current_env? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 67


def current_env?
  return true unless @env
  if @env.is_a?(Hash)
    @env.all? do |key, val|
      ENV[key.to_s] && (val.is_a?(String) ? ENV[key.to_s] == val : ENV[key.to_s] =~ val)
    end
  else
    ENV[@env.to_s]
  end
end

#current_platform? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 78


def current_platform?
  return true if @platforms.empty?
  @platforms.any? do |p|
    Bundler.current_ruby.send("#{p}?")
  end
end

#gemfile (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#git (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#github (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#groups (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#path (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#platforms (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#ref (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 10


attr_reader :groups, :platforms, :gemfile, :path, :git, :github, :branch, :ref

#should_include? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 63


def should_include?
  @should_include && current_env? && current_platform?
end

#specific? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 91


def specific?
  super
rescue NoMethodError
  requirement != ">= 0"
end

Instance Method Details

#expanded_platforms

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 59


def expanded_platforms
  @expanded_platforms ||= @platforms.map {|pl| PLATFORM_MAP[pl] }.compact.flatten.uniq
end

#gem_platforms(valid_platforms)

Returns the platforms this dependency is valid for, in the same order as passed in the valid_platforms parameter

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 52


def gem_platforms(valid_platforms)
  return [Gem::Platform::RUBY] if force_ruby_platform
  return valid_platforms if @platforms.empty?

  valid_platforms.select {|p| expanded_platforms.include?(GemHelpers.generic(p)) }
end

#to_lock

[ GitHub ]

# File 'lib/bundler/dependency.rb', line 85


def to_lock
  out = super
  out << "!" if source
  out
end

Class: Bundler::Dependency

Constant Summary

Class Method Summary

Instance Attribute Summary

::Gem::Dependency - Inherited

Instance Method Summary

::Gem::Dependency - Inherited

ForcePlatform - Included

Constructor Details

.new(name, version, options = {}, &blk) ⇒ Dependency

Instance Attribute Details

#autorequire (readonly)

#branch (readonly)

#current_env? ⇒ Boolean (readonly)

#current_platform? ⇒ Boolean (readonly)

#gemfile (readonly)

#git (readonly)

#github (readonly)

#groups (readonly)

#path (readonly)

#platforms (readonly)

#ref (readonly)

#should_include? ⇒ Boolean (readonly)

#specific? ⇒ Boolean (readonly)

Instance Method Details

#expanded_platforms

#gem_platforms(valid_platforms)

#to_lock

`::Gem::Dependency` - Inherited

`::Gem::Dependency` - Inherited

`ForcePlatform` - Included

.new(name, version, options = {}, &blk) ⇒ `Dependency`

#current_env? ⇒ `Boolean` (readonly)

#current_platform? ⇒ `Boolean` (readonly)

#should_include? ⇒ `Boolean` (readonly)

#specific? ⇒ `Boolean` (readonly)