1. Gem::
  2. RequestSet::
  3. GemDependencyAPI

class Gem::RequestSet::GemDependencyAPI

A semi-compatible DSL for theBundler Gemfile and Isolate gem dependencies files.

To work with both theBundler Gemfile and Isolate formats this implementation takes some liberties to allow compatibility with each, most notably insource.

A basic gem dependencies file will look like the following:

source 'https://rubygems.org'gem 'rails', '3.2.14agem 'devise', '~> 2.1', '>= 2.1.3'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 throughGem.use_gemdeps. SeeGem.use_gemdeps for details and warnings.

See ‘gem help install` and `gem help gem_dependencies` for further details.

Attributes

dependencies[R]

The gems required bygem statements in the gem.deps.rb file

requires[R]

AHash containing gem names and files to require from those gems.

Public Class Methods

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 197definitialize(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:githubdo|repo_name|repo_name ="#{repo_name}/#{repo_name}"unlessrepo_name.include?"/""https://github.com/#{repo_name}.git"endgit_source:bitbucketdo|repo_name|repo_name ="#{repo_name}/#{repo_name}"unlessrepo_name.include?"/"user, =repo_name.split"/",2"https://#{user}@bitbucket.org/#{repo_name}.git"endend

Creates a newGemDependencyAPI that will add dependencies to theGem::RequestSetset based on the dependency API description inpath.

Public Instance Methods

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 605defgit_source(name,&callback)@git_sources[name] =callbackend

Defines a custom git source that usesname 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.

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 282defloadinstance_evalFile.read(@path),@path,1selfend

Loads the gem dependency file and returns self.

Private Instance Methods

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 695defpin_gem_source(name,type =:default,source =nil)source_description =casetypewhen:defaultthen"(default)"when:paththen"path: #{source}"when:gitthen"git: #{source}"when:sourcethen"source: #{source}"else"(unknown)"endraiseArgumentError,"duplicate source #{source_description} for gem #{name}"if@gem_sources.fetch(name,source)!=source@gem_sources[name] =sourceend

Pins the gemname to the givensource. Adding a gem with the same name from a differentsource will raise an exception.

Gem Dependencies DSL

↑ top

Public Instance Methods

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 359defgem(name,*requirements)options =requirements.popifrequirements.last.is_a?(Hash)options||= {}options[:git] =@current_repositoryif@current_repositorysource_set =falsesource_set||=gem_pathname,optionssource_set||=gem_gitname,optionssource_set||=gem_git_sourcename,optionssource_set||=gem_sourcename,optionsduplicate =@dependencies.include?name@dependencies[name] =ifrequirements.empty?&&!source_setGem::Requirement.defaultelsifsource_setGem::Requirement.source_setelseGem::Requirement.createrequirementsendreturnunlessgem_platformsname,optionsgroups =gem_groupname,optionsreturnunless (groups&@without_groups).empty?pin_gem_sourcename,:defaultunlesssource_setgem_requiresname,optionsifduplicatewarn<<-WARNINGGem dependencies file #{@path} requires #{name} more than once.      WARNINGend@set.gemname,*requirementsend

Specifies a gem dependency with the givenname andrequirements. You may also supplyoptions following therequirements

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 duringBundler.require. By default the name of the dependency is required inBundler. A single file or anArray of files may be given.

To disable requiring any file givefalse:

gem'rake',require:false
group:

Place the dependencies in the given dependency group. A single group or anArray of groups may be given.

See alsogroup

platform:

Only install the dependency on the given platform. A single platform or anArray of platforms may be given.

Seeplatform 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 totrue 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.

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 638defgemspec(options = {})name              =options.delete(:name)||"{,*}"path              =options.delete(:path)||"."development_group =options.delete(:development_group)||:developmentspec =find_gemspecname,pathgroups =gem_groupspec.name, {}self_dep =Gem::Dependency.newspec.name,spec.versionadd_dependenciesgroups, [self_dep]add_dependenciesgroups,spec.runtime_dependencies@dependencies[spec.name] =Gem::Requirement.source_setspec.dependencies.eachdo|dep|@dependencies[dep.name] =dep.requirementendgroups<<development_groupadd_dependenciesgroups,spec.development_dependencies@vendor_set.add_vendor_gemspec.name,pathgem_requiresspec.name,optionsend

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.

gemspecname:'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.

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 592defgit(repository)@current_repository =repositoryyieldensure@current_repository =nilend

Block form for specifying gems from a gitrepository.

git'https://github.com/rails/rails.git'dogem'activesupport'gem'activerecord'end
Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 683defgroup(*groups)@current_groups =groupsyieldensure@current_groups =nilend

Block form for placing a dependency in the givengroups.

group:developmentdogem'debugger'endgroup:development,:testdogem'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.

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 757defplatform(*platforms)@current_platforms =platformsyieldensure@current_platforms =nilend

Block form for restricting gems to a set of platforms.

The gem dependencies platform is different fromGem::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.

Also aliased as:platforms

Block form for restricting gems to a particular set of platforms. Seeplatform.

Alias for:platform
Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 783defruby(version,options = {})engine         =options[:engine]engine_version =options[:engine_version]raiseArgumentError,"You must specify engine_version along with the Ruby engine"ifengine&&!engine_versionreturntrueif@installingunlessversion==RUBY_VERSIONmessage ="Your Ruby version is #{RUBY_VERSION}, " \"but your #{gem_deps_file} requires #{version}"raiseGem::RubyVersionMismatch,messageendifengine&&engine!=Gem.ruby_enginemessage ="Your Ruby engine is #{Gem.ruby_engine}, " \"but your #{gem_deps_file} requires #{engine}"raiseGem::RubyVersionMismatch,messageendifengine_versionifengine_version!=RUBY_ENGINE_VERSIONmessage ="Your Ruby engine version is #{Gem.ruby_engine} #{RUBY_ENGINE_VERSION}, " \"but your #{gem_deps_file} requires #{engine} #{engine_version}"raiseGem::RubyVersionMismatch,messageendendtrueend

Restricts this gem dependencies file to the given rubyversion.

You may also provideengine: andengine_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.

Source
# File lib/rubygems/request_set/gem_dependency_api.rb, line 834defsource(url)Gem.sources.clearif@default_sources@default_sources =falseGem.sources<<urlend

Setsurl 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.

  • Theprepend: option is not supported. If you wish to order sources then list them in your preferred order.