Class: Ansible::Ruby::Modules::Bundler

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/language/bundler.rb

Overview

Manage installation and Gem version dependencies for Ruby using the Bundler gem

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#binstub_directory ⇒ Object?

Returns Only applies if state is C(present). Specifies the directory to install any gem bins files to. When executed the bin files will run within the context of the Gemfile and fail if any required gem dependencies are not installed. If C(chdir) is set then this path is relative to C(chdir).

Returns:

  • (Object, nil) —

    Only applies if state is C(present). Specifies the directory to install any gem bins files to. When executed the bin files will run within the context of the Gemfile and fail if any required gem dependencies are not installed. If C(chdir) is set then this path is relative to C(chdir)



52
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 52

attribute :binstub_directory

#chdir ⇒ String?

Returns The directory to execute the bundler commands from. This directoy needs to contain a valid Gemfile or .bundle/ directory.

Returns:

  • (String, nil) —

    The directory to execute the bundler commands from. This directoy needs to contain a valid Gemfile or .bundle/ directory



20
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 20

attribute :chdir

#clean ⇒ :yes, ...

Returns Only applies if state is C(present). If set removes any gems on the target host that are not in the gemfile.

Returns:

  • (:yes, :no, nil) —

    Only applies if state is C(present). If set removes any gems on the target host that are not in the gemfile



28
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 28

attribute :clean

#deployment_mode ⇒ :yes, ...

Returns Only applies if state is C(present). If set it will install gems in ./vendor/bundle instead of the default location. Requires a Gemfile.lock file to have been created prior.

Returns:

  • (:yes, :no, nil) —

    Only applies if state is C(present). If set it will install gems in ./vendor/bundle instead of the default location. Requires a Gemfile.lock file to have been created prior



40
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 40

attribute :deployment_mode

#exclude_groups ⇒ String?

Returns A list of Gemfile groups to exclude during operations. This only applies when state is C(present). Bundler considers this a ‘remembered’ property for the Gemfile and will automatically exclude groups in future operations even if C(exclude_groups) is not set.

Returns:

  • (String, nil) —

    A list of Gemfile groups to exclude during operations. This only applies when state is C(present). Bundler considers this a ‘remembered’ property for the Gemfile and will automatically exclude groups in future operations even if C(exclude_groups) is not set



24
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 24

attribute :exclude_groups

#executable ⇒ String?

Returns The path to the bundler executable.

Returns:

  • (String, nil) —

    The path to the bundler executable



12
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 12

attribute :executable

#extra_args ⇒ Object?

Returns A space separated string of additional commands that can be applied to the Bundler command. Refer to the Bundler documentation for more information.

Returns:

  • (Object, nil) —

    A space separated string of additional commands that can be applied to the Bundler command. Refer to the Bundler documentation for more information



55
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 55

attribute :extra_args

#gem_path ⇒ String?

Returns Only applies if state is C(present). Specifies the directory to install the gems into. If C(chdir) is set then this path is relative to C(chdir).

Returns:

  • (String, nil) —

    Only applies if state is C(present). Specifies the directory to install the gems into. If C(chdir) is set then this path is relative to C(chdir)



48
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 48

attribute :gem_path

#gemfile ⇒ String?

Returns Only applies if state is C(present). The path to the gemfile to use to install gems.

Returns:

  • (String, nil) —

    Only applies if state is C(present). The path to the gemfile to use to install gems.



32
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 32

attribute :gemfile

#local ⇒ :yes, ...

Returns If set only installs gems from the cache on the target host.

Returns:

  • (:yes, :no, nil) —

    If set only installs gems from the cache on the target host



36
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 36

attribute :local

#state ⇒ :present, ...

Returns The desired state of the Gem bundle. C(latest) updates gems to the most recent, acceptable version.

Returns:

  • (:present, :latest, nil) —

    The desired state of the Gem bundle. C(latest) updates gems to the most recent, acceptable version



16
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 16

attribute :state

#user_install ⇒ :yes, ...

Returns Only applies if state is C(present). Installs gems in the local user’s cache or for all users.

Returns:

  • (:yes, :no, nil) —

    Only applies if state is C(present). Installs gems in the local user’s cache or for all users



44
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/bundler.rb', line 44

attribute :user_install