method

gem

v2_6_3 - Show latest stable - 0 notes - Class: GemDependencyAPI

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378
1_9_2_180
1_9_3_125
1_9_3_392
2_1_10 (0)
2_2_9 (38)
2_4_6 (0)
2_5_5 (0)
2_6_3 (0)
What's this?

gem(name, *requirements) public

:category: Gem Dependencies DSL

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.

Show source

# File lib/rubygems/request_set/gem_dependency_api.rb, line 356
  def gem(name, *requirements)
    options = requirements.pop if requirements.last.kind_of?(Hash)
    options ||= {}

    options[:git] = @current_repository if @current_repository

    source_set = false

    source_set ||= gem_path       name, options
    source_set ||= gem_git        name, options
    source_set ||= gem_git_source name, options
    source_set ||= gem_source     name, options

    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 options

    groups = gem_group name, options

    return unless (groups & @without_groups).empty?

    pin_gem_source name, :default unless source_set

    gem_requires name, options

    if duplicate
      warn Gem dependencies file #{@path} requires #{name} more than once.
    end

    @set.gem name, *requirements
  end

gem

Related methods