Class: Gem::RequestSet::GemDependencyAPI
Relationships & Source Files | |
Inherits: | Object |
Defined in: | lib/rubygems/request_set/gem_dependency_api.rb |
Overview
A semi-compatible DSL for the Bundler Gemfile and Isolate gem dependencies files.
To work with both the Bundler Gemfile and Isolate formats this implementation takes some liberties to allow compatibility with each, most notably in #source.
A basic gem dependencies file will look like the following:
source 'https://rubygems.org'
gem 'rails', '3.2.14a
gem 'devise', '~> 2.1', '>= 2.1'
gem 'cancan'
gem 'airbrake'
gem 'pg'
RubyGems recommends saving this as gem.deps.rb over Gemfile or Isolate.
To install the gems in this Gemfile use gem install -g
to install it and create a lockfile. The lockfile will ensure that when you make changes to your gem dependencies file a minimum amount of change is made to the dependencies of your gems.
RubyGems can activate all the gems in your dependencies file at startup using the RUBYGEMS_GEMDEPS environment variable or through Gem.use_gemdeps. See Gem.use_gemdeps for details and warnings.
See gem help install
and gem help gem_dependencies
for further details.
Constant Summary
-
ENGINE_MAP =
Internal use only
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 34{ # :nodoc: :jruby => %w[jruby], :jruby_18 => %w[jruby], :jruby_19 => %w[jruby], :maglev => %w[maglev], :mri => %w[ruby], :mri_18 => %w[ruby], :mri_19 => %w[ruby], :mri_20 => %w[ruby], :mri_21 => %w[ruby], :rbx => %w[rbx], :truffleruby => %w[truffleruby], :ruby => %w[ruby rbx maglev truffleruby], :ruby_18 => %w[ruby rbx maglev truffleruby], :ruby_19 => %w[ruby rbx maglev truffleruby], :ruby_20 => %w[ruby rbx maglev truffleruby], :ruby_21 => %w[ruby rbx maglev truffleruby], }.freeze
-
PLATFORM_MAP =
Internal use only
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 58{ # :nodoc: :jruby => Gem::Platform::RUBY, :jruby_18 => Gem::Platform::RUBY, :jruby_19 => Gem::Platform::RUBY, :maglev => Gem::Platform::RUBY, :mingw => x86_mingw, :mingw_18 => x86_mingw, :mingw_19 => x86_mingw, :mingw_20 => x86_mingw, :mingw_21 => x86_mingw, :mri => Gem::Platform::RUBY, :mri_18 => Gem::Platform::RUBY, :mri_19 => Gem::Platform::RUBY, :mri_20 => Gem::Platform::RUBY, :mri_21 => Gem::Platform::RUBY, :mswin => mswin, :mswin_18 => mswin, :mswin_19 => mswin, :mswin_20 => mswin, :mswin_21 => mswin, :mswin64 => mswin64, :mswin64_19 => mswin64, :mswin64_20 => mswin64, :mswin64_21 => mswin64, :rbx => Gem::Platform::RUBY, :ruby => Gem::Platform::RUBY, :ruby_18 => Gem::Platform::RUBY, :ruby_19 => Gem::Platform::RUBY, :ruby_20 => Gem::Platform::RUBY, :ruby_21 => Gem::Platform::RUBY, :truffleruby => Gem::Platform::RUBY, :x64_mingw => x64_mingw, :x64_mingw_20 => x64_mingw, :x64_mingw_21 => x64_mingw, }.freeze
-
VERSION_MAP =
Internal use only
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 100{ # :nodoc: :jruby => gt_eq_0, :jruby_18 => tilde_gt_1_8_0, :jruby_19 => tilde_gt_1_9_0, :maglev => gt_eq_0, :mingw => gt_eq_0, :mingw_18 => tilde_gt_1_8_0, :mingw_19 => tilde_gt_1_9_0, :mingw_20 => tilde_gt_2_0_0, :mingw_21 => tilde_gt_2_1_0, :mri => gt_eq_0, :mri_18 => tilde_gt_1_8_0, :mri_19 => tilde_gt_1_9_0, :mri_20 => tilde_gt_2_0_0, :mri_21 => tilde_gt_2_1_0, :mswin => gt_eq_0, :mswin_18 => tilde_gt_1_8_0, :mswin_19 => tilde_gt_1_9_0, :mswin_20 => tilde_gt_2_0_0, :mswin_21 => tilde_gt_2_1_0, :mswin64 => gt_eq_0, :mswin64_19 => tilde_gt_1_9_0, :mswin64_20 => tilde_gt_2_0_0, :mswin64_21 => tilde_gt_2_1_0, :rbx => gt_eq_0, :ruby => gt_eq_0, :ruby_18 => tilde_gt_1_8_0, :ruby_19 => tilde_gt_1_9_0, :ruby_20 => tilde_gt_2_0_0, :ruby_21 => tilde_gt_2_1_0, :truffleruby => gt_eq_0, :x64_mingw => gt_eq_0, :x64_mingw_20 => tilde_gt_2_0_0, :x64_mingw_21 => tilde_gt_2_1_0, }.freeze
-
WINDOWS =
Internal use only
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 136{ # :nodoc: :mingw => :only, :mingw_18 => :only, :mingw_19 => :only, :mingw_20 => :only, :mingw_21 => :only, :mri => :never, :mri_18 => :never, :mri_19 => :never, :mri_20 => :never, :mri_21 => :never, :mswin => :only, :mswin_18 => :only, :mswin_19 => :only, :mswin_20 => :only, :mswin_21 => :only, :mswin64 => :only, :mswin64_19 => :only, :mswin64_20 => :only, :mswin64_21 => :only, :rbx => :never, :ruby => :never, :ruby_18 => :never, :ruby_19 => :never, :ruby_20 => :never, :ruby_21 => :never, :x64_mingw => :only, :x64_mingw_20 => :only, :x64_mingw_21 => :only, }.freeze
Gem Dependencies DSL
-
#gem(name)
Specifies a gem dependency with the given
name
andrequirements
. -
#gem_deps_file
Internal use only
Returns the basename of the file the dependencies were loaded from.
-
#gem_git(name, options)
private
Internal use only
Handles the git: option from
options
for gemname
. -
#gem_git_reference(options)
Internal use only
Handles the git options from
options
for git gem. -
#gem_git_source(name, options)
private
Internal use only
Handles a git gem option from
options
for gemname
for a git source registered through git_source. -
#gem_group(name, options)
private
Internal use only
Handles the
:group
and:groups
options
for the gem with the givenname
. -
#gem_path(name, options)
private
Internal use only
Handles the path: option from
options
for gemname
. -
#gem_platforms(name, options)
private
Internal use only
Handles the platforms: option from
options
. -
#gem_requires(name, options)
private
Internal use only
Records the require: option from
options
and adds those files, or the default file to the require list forname
. -
#gem_source(name, options)
private
Internal use only
Handles the source: option from
options
for gemname
. -
#gemspec(options = {})
Loads dependencies from a gemspec file.
-
#git(repository)
Block form for specifying gems from a git
repository
. -
#git_source(name, &callback)
Defines a custom git source that uses
name
to expand git repositories for use in gems built from git repositories. -
#group(*groups)
Block form for placing a dependency in the given
groups
. -
#pin_gem_source(name, type = :default, source = nil)
private
Pins the gem
name
to the given #source. -
#platform(*platforms)
(also: #platforms)
Block form for restricting gems to a set of platforms.
-
#platforms(*platforms)
Block form for restricting gems to a particular set of platforms.
-
#ruby(version, options = {})
Restricts this gem dependencies file to the given ruby
version
. -
#source(url)
Sets
url
as a source for gems for this dependency API.
Class Method Summary
-
.new(set, path) ⇒ GemDependencyAPI
constructor
Creates a new
GemDependencyAPI
that will add dependencies to the::Gem::RequestSet
set
based on the dependency API description in Gem.path.
Instance Attribute Summary
-
#dependencies
readonly
The gems required by #gem statements in the gem.deps.rb file.
-
#requires
readonly
A Hash containing gem names and files to require from those gems.
-
#git_set
readonly
Internal use only
A set of gems that are loaded via the
:git
option to #gem -
#installing=(installing)
writeonly
Internal use only
Changes the behavior of gem dependency file loading to installing mode.
-
#vendor_set
readonly
Internal use only
A set of gems that are loaded via the
:path
option to #gem -
#without_groups
rw
Internal use only
The groups of gems to exclude from installation.
Instance Method Summary
-
#load
Loads the gem dependency file and returns self.
-
#find_gemspec(name, path)
Internal use only
Finds a gemspec with the given
name
that lives at Gem.path. -
#add_dependencies(groups, dependencies)
private
Internal use only
Adds #dependencies to the request set if any of the
groups
are allowed.
Constructor Details
.new(set, path) ⇒ GemDependencyAPI
Creates a new GemDependencyAPI
that will add dependencies to the ::Gem::RequestSet
set
based on the dependency API description in Gem.path.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 196
def initialize(set, path) @set = set @path = path @current_groups = nil @current_platforms = nil @current_repository = nil @dependencies = {} @default_sources = true @git_set = @set.git_set @git_sources = {} @installing = false @requires = Hash.new {|h, name| h[name] = [] } @vendor_set = @set.vendor_set @source_set = @set.source_set @gem_sources = {} @without_groups = [] git_source :github do |repo_name| repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include? "/" "git://github.com/#{repo_name}.git" end git_source :bitbucket do |repo_name| repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include? "/" user, = repo_name.split "/", 2 "https://#{user}@bitbucket.org/#{repo_name}.git" end end
Instance Attribute Details
#dependencies (readonly)
The gems required by #gem statements in the gem.deps.rb file
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 170
attr_reader :dependencies
#git_set (readonly)
A set of gems that are loaded via the :git
option to #gem
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 175
attr_reader :git_set # :nodoc:
#installing=(installing) (writeonly)
Changes the behavior of gem dependency file loading to installing mode. In installing mode certain restrictions are ignored such as ruby version mismatch checks.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 274
def installing=(installing) # :nodoc: @installing = installing end
#requires (readonly)
A Hash containing gem names and files to require from those gems.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 180
attr_reader :requires
#vendor_set (readonly)
A set of gems that are loaded via the :path
option to #gem
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 185
attr_reader :vendor_set # :nodoc:
#without_groups (rw)
The groups of gems to exclude from installation
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 190
attr_accessor :without_groups # :nodoc:
Instance Method Details
#add_dependencies(groups, dependencies) (private)
Adds #dependencies to the request set if any of the groups
are allowed. This is used for gemspec dependencies.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 233
def add_dependencies(groups, dependencies) # :nodoc: return unless (groups & @without_groups).empty? dependencies.each do |dep| @set.gem dep.name, *dep.requirement.as_list end end
#find_gemspec(name, path)
Finds a gemspec with the given name
that lives at Gem.path.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 246
def find_gemspec(name, path) # :nodoc: glob = File.join path, "#{name}.gemspec" spec_files = Dir[glob] case spec_files.length when 1 then spec_file = spec_files.first spec = Gem::Specification.load spec_file return spec if spec raise ArgumentError, "invalid gemspec #{spec_file}" when 0 then raise ArgumentError, "no gemspecs found at #{Dir.pwd}" else raise ArgumentError, "found multiple gemspecs at #{Dir.pwd}, " + "use the name: option to specify the one you want" end end
#gem(name)
#gem(name, *requirements)
#gem(name, *requirements, options)
Specifies a gem dependency with the given name
and requirements
. You may also supply options
following the requirements
options
include:
- require:
-
RubyGems does not provide any autorequire features so requires in a gem dependencies file are recorded but ignored.
In bundler the require: option overrides the file to require during Bundler.require. By default the name of the dependency is required in Bundler. A single file or an Array of files may be given.
To disable requiring any file give
false
:gem 'rake', require: false
- group:
-
Place the dependencies in the given dependency group. A single group or an Array of groups may be given.
See also #group
- platform:
-
Only install the dependency on the given platform. A single platform or an Array of platforms may be given.
See #platform for a list of platforms available.
- path:
-
Install this dependency from an unpacked gem in the given directory.
gem 'modified_gem', path: 'vendor/modified_gem'
- git:
-
Install this dependency from a git repository:
gem 'private_gem', git: git@my.company.example:private_gem.git'
- gist:
-
Install this dependency from the gist ID:
gem 'bang', gist: '1232884'
- github:
-
Install this dependency from a github git repository:
gem 'private_gem', github: 'my_company/private_gem'
- submodules:
-
Set to
true
to include submodules when fetching the git repository for git:, gist: and github: dependencies. - ref:
-
Use the given commit name or SHA for git:, gist: and github: dependencies.
- branch:
-
Use the given branch for git:, gist: and github: dependencies.
- tag:
-
Use the given tag for git:, gist: and github: dependencies.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 358
def gem(name, *requirements) = requirements.pop if requirements.last.kind_of?(Hash) ||= {} [:git] = @current_repository if @current_repository source_set = false source_set ||= gem_path name, source_set ||= gem_git name, source_set ||= gem_git_source name, source_set ||= gem_source name, duplicate = @dependencies.include? name @dependencies[name] = if requirements.empty? and not source_set Gem::Requirement.default elsif source_set Gem::Requirement.source_set else Gem::Requirement.create requirements end return unless gem_platforms name, groups = gem_group name, return unless (groups & @without_groups).empty? pin_gem_source name, :default unless source_set gem_requires name, if duplicate warn <<-WARNING Gem dependencies file #{@path} requires #{name} more than once. WARNING end @set.gem name, *requirements end
#gem_deps_file
Returns the basename of the file the dependencies were loaded from
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 613
def gem_deps_file # :nodoc: File.basename @path end
#gem_git(name, options) (private)
Handles the git: option from options
for gem name
.
Returns true
if the gist or git option was handled.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 406
def gem_git(name, ) # :nodoc: if gist = .delete(:gist) [:git] = "https://gist.github.com/#{gist}.git" end return unless repository = .delete(:git) pin_gem_source name, :git, repository reference = gem_git_reference submodules = .delete :submodules @git_set.add_git_gem name, repository, reference, submodules true end
#gem_git_reference(options)
Handles the git options from options
for git gem.
Returns reference for the git gem.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 429
def gem_git_reference( ) # :nodoc: ref = .delete :ref branch = .delete :branch tag = .delete :tag reference = nil reference ||= ref reference ||= branch reference ||= tag reference ||= 'master' if ref && branch warn <<-WARNING Gem dependencies file #{@path} includes git reference for both ref and branch but only ref is used. WARNING end if (ref || branch) && tag warn <<-WARNING Gem dependencies file #{@path} includes git reference for both ref/branch and tag but only ref/branch is used. WARNING end reference end
#gem_git_source(name, options) (private)
Handles a git gem option from options
for gem name
for a git source registered through git_source.
Returns true
if the custom source option was handled.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 462
def gem_git_source(name, ) # :nodoc: return unless git_source = (@git_sources.keys & .keys).last source_callback = @git_sources[git_source] source_param = .delete git_source git_url = source_callback.call source_param [:git] = git_url gem_git name, true end
#gem_group(name, options) (private)
Handles the :group
and :groups
options
for the gem with the given name
.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 483
def gem_group(name, ) # :nodoc: g = .delete :group all_groups = g ? Array(g) : [] groups = .delete :groups all_groups |= groups if groups all_groups |= @current_groups if @current_groups all_groups end
#gem_path(name, options) (private)
Handles the path: option from options
for gem name
.
Returns true
if the path option was handled.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 502
def gem_path(name, ) # :nodoc: return unless directory = .delete(:path) pin_gem_source name, :path, directory @vendor_set.add_vendor_gem name, directory true end
#gem_platforms(name, options) (private)
Handles the platforms: option from options
. Returns true if the platform matches the current platform.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 535
def gem_platforms(name, ) # :nodoc: platform_names = Array( .delete :platform) platform_names.concat Array( .delete :platforms) platform_names.concat @current_platforms if @current_platforms return true if platform_names.empty? platform_names.any? do |platform_name| raise ArgumentError, "unknown platform #{platform_name.inspect}" unless platform = PLATFORM_MAP[platform_name] next false unless Gem::Platform.match_gem? platform, name if engines = ENGINE_MAP[platform_name] next false unless engines.include? Gem.ruby_engine end case WINDOWS[platform_name] when :only then next false unless Gem.win_platform? when :never then next false if Gem.win_platform? end VERSION_MAP[platform_name].satisfied_by? Gem.ruby_version end end
#gem_requires(name, options) (private)
Records the require: option from options
and adds those files, or the default file to the require list for name
.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 569
def gem_requires(name, ) # :nodoc: if .include? :require if requires = .delete(:require) @requires[name].concat Array requires end else @requires[name] << name end raise ArgumentError, "Unhandled gem options #{ .inspect}" unless .empty? end
#gem_source(name, options) (private)
Handles the source: option from options
for gem name
.
Returns true
if the source option was handled.
#gemspec(options = {})
Loads dependencies from a gemspec file.
options
include:
- name:
-
The name portion of the gemspec file. Defaults to searching for any gemspec file in the current directory.
gemspec name: 'my_gem'
- path:
-
The path the gemspec lives in. Defaults to the current directory:
gemspec 'my_gem', path: 'gemspecs', name: 'my_gem'
- development_group:
-
The group to add development dependencies to. By default this is :development. Only one group may be specified.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 639
def gemspec( = {}) name = .delete(:name) || '{,*}' path = .delete(:path) || '.' development_group = .delete(:development_group) || :development spec = find_gemspec name, path groups = gem_group spec.name, {} self_dep = Gem::Dependency.new spec.name, spec.version add_dependencies groups, [self_dep] add_dependencies groups, spec.runtime_dependencies @dependencies[spec.name] = Gem::Requirement.source_set spec.dependencies.each do |dep| @dependencies[dep.name] = dep.requirement end groups << development_group add_dependencies groups, spec.development_dependencies @vendor_set.add_vendor_gem spec.name, path gem_requires spec.name, end
#git(repository)
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 592
def git(repository) @current_repository = repository yield ensure @current_repository = nil end
#git_source(name, &callback)
Defines a custom git source that uses name
to expand git repositories for use in gems built from git repositories. You must provide a block that accepts a git repository name for expansion.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 606
def git_source(name, &callback) @git_sources[name] = callback end
#group(*groups)
Block form for placing a dependency in the given groups
.
group :development do
gem 'debugger'
end
group :development, :test do
gem 'minitest'
end
Groups can be excluded at install time using ‘gem install -g –without development`. See gem help install
and gem help gem_dependencies
for further details.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 684
def group(*groups) @current_groups = groups yield ensure @current_groups = nil end
#load
Loads the gem dependency file and returns self.
#pin_gem_source(name, type = :default, source = nil) (private)
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 697
def pin_gem_source(name, type = :default, source = nil) source_description = case type when :default then '(default)' when :path then "path: #{source}" when :git then "git: #{source}" when :source then "source: #{source}" else '(unknown)' end raise ArgumentError, "duplicate source #{source_description} for gem #{name}" if @gem_sources.fetch(name, source) != source @gem_sources[name] = source end
#platform(*platforms) Also known as: #platforms
Block form for restricting gems to a set of platforms.
The gem dependencies platform is different from ::Gem::Platform
. A platform gem.deps.rb platform matches on the ruby engine, the ruby version and whether or not windows is allowed.
:ruby
,:ruby_XY
-
Matches non-windows, non-jruby implementations where X and Y can be used to match releases in the 1.8, 1.9, 2.0 or 2.1 series.
:mri
,:mri_XY
-
Matches non-windows C Ruby (Matz Ruby) or only the 1.8, 1.9, 2.0 or 2.1 series.
:mingw
,:mingw_XY
-
Matches 32 bit C Ruby on MinGW or only the 1.8, 1.9, 2.0 or 2.1 series.
:x64_mingw
,:x64_mingw_XY
-
Matches 64 bit C Ruby on MinGW or only the 1.8, 1.9, 2.0 or 2.1 series.
:mswin
,:mswin_XY
-
Matches 32 bit C Ruby on Microsoft Windows or only the 1.8, 1.9, 2.0 or 2.1 series.
:mswin64
,:mswin64_XY
-
Matches 64 bit C Ruby on Microsoft Windows or only the 1.8, 1.9, 2.0 or 2.1 series.
:jruby
,:jruby_XY
-
Matches JRuby or JRuby in 1.8 or 1.9 mode.
:maglev
-
Matches Maglev
:rbx
-
Matches non-windows Rubinius
NOTE: There is inconsistency in what environment a platform matches. You may need to read the source to know the exact details.
#platforms(*platforms)
Block form for restricting gems to a particular set of platforms. See #platform.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 774
alias :platforms :platform
#ruby(version, options = {})
Restricts this gem dependencies file to the given ruby version
.
You may also provide engine:
and engine_version:
options to restrict this gem dependencies file to a particular ruby engine and its engine version. This matching is performed by using the RUBY_ENGINE and RUBY_ENGINE_VERSION constants.
# File 'lib/rubygems/request_set/gem_dependency_api.rb', line 786
def ruby(version, = {}) engine = [:engine] engine_version = [:engine_version] raise ArgumentError, 'You must specify engine_version along with the Ruby engine' if engine and not engine_version return true if @installing unless RUBY_VERSION == version = "Your Ruby version is #{RUBY_VERSION}, " + "but your #{gem_deps_file} requires #{version}" raise Gem::RubyVersionMismatch, end if engine and engine != Gem.ruby_engine = "Your Ruby engine is #{Gem.ruby_engine}, " + "but your #{gem_deps_file} requires #{engine}" raise Gem::RubyVersionMismatch, end if engine_version if engine_version != RUBY_ENGINE_VERSION = "Your Ruby engine version is #{Gem.ruby_engine} #{RUBY_ENGINE_VERSION}, " + "but your #{gem_deps_file} requires #{engine} #{engine_version}" raise Gem::RubyVersionMismatch, end end return true end
#source(url)
Sets url
as a source for gems for this dependency API. RubyGems uses the default configured sources if no source was given. If a source is set only that source is used.
This method differs in behavior from Bundler:
-
The
:gemcutter
, #:rubygems
and:rubyforge
sources are not supported as they are deprecated in bundler. -
The
prepend:
option is not supported. If you wish to order sources then list them in your preferred order.