Class: Ansible::Ruby::Modules::Gem

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

Overview

Manage installation and uninstallation of Ruby gems.

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

#build_flags ⇒ Object?

Returns Allow adding build flags for gem compilation.

Returns:

  • (Object, nil) —

    Allow adding build flags for gem compilation



57
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 57

attribute :build_flags

#env_shebang ⇒ String?

Returns Rewrite the shebang line on installed scripts to use /usr/bin/env.

Returns:

  • (String, nil) —

    Rewrite the shebang line on installed scripts to use /usr/bin/env.



41
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 41

attribute :env_shebang

#executable ⇒ Object?

Returns Override the path to the gem executable.

Returns:

  • (Object, nil) —

    Override the path to the gem executable



35
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 35

attribute :executable

#gem_source ⇒ String?

Returns The path to a local gem used as installation source.

Returns:

  • (String, nil) —

    The path to a local gem used as installation source.



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

attribute :gem_source

#include_dependencies ⇒ :yes, ...

Returns Whether to include dependencies or not.

Returns:

  • (:yes, :no, nil) —

    Whether to include dependencies or not.



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

attribute :include_dependencies

#include_doc ⇒ String?

Returns Install with or without docs.

Returns:

  • (String, nil) —

    Install with or without docs.



53
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 53

attribute :include_doc

#install_dir ⇒ Object?

Returns Install the gems into a specific directory. These gems will be independant from the global installed ones. Specifying this requires user_install to be false.

Returns:

  • (Object, nil) —

    Install the gems into a specific directory. These gems will be independant from the global installed ones. Specifying this requires user_install to be false.



38
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 38

attribute :install_dir

#name ⇒ String

Returns The name of the gem to be managed.

Returns:

  • (String) —

    The name of the gem to be managed.



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

attribute :name

#pre_release ⇒ String?

Returns Allow installation of pre-release versions of the gem.

Returns:

  • (String, nil) —

    Allow installation of pre-release versions of the gem.



49
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 49

attribute :pre_release

#repository ⇒ Object?

Returns The repository from which the gem will be installed.

Returns:

  • (Object, nil) —

    The repository from which the gem will be installed



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

attribute :repository

#state ⇒ :present, ...

Returns The desired state of the gem. C(latest) ensures that the latest version is installed.

Returns:

  • (:present, :absent, :latest, nil) —

    The desired state of the gem. C(latest) ensures that the latest version is installed.



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

attribute :state

#user_install ⇒ :yes, ...

Returns Install gem in user’s local gems cache or for all users.

Returns:

  • (:yes, :no, nil) —

    Install gem in user’s local gems cache or for all users



31
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 31

attribute :user_install

#version ⇒ Float?

Returns Version of the gem to be installed/removed.

Returns:

  • (Float, nil) —

    Version of the gem to be installed/removed.



45
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/gem.rb', line 45

attribute :version