lib/chef/resource/gem_package.rb


#
# Author:: Adam Jacob (<adam@chef.io>)
# Copyright:: Copyright (c) Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require_relative "package"
require "chef-utils/dist" unless defined?(ChefUtils::Dist)

class Chef
  class Resource
    class GemPackage < Chef::Resource::Package
      provides :gem_package

      description <<~DESC
        Use the **gem_package** resource to manage gem packages that are only included in recipes.
        When a gem is installed from a local file, it must be added to the node using the **remote_file** or **cookbook_file** resources.

        Note: The **gem_package** resource must be specified as `gem_package` and cannot be shortened to `package` in a recipe.

        Warning: The **chef_gem** and **gem_package** resources are both used to install Ruby gems. For any machine on which #{ChefUtils::Dist::Infra::PRODUCT} is
        installed, there are two instances of Ruby. One is the standard, system-wide instance of Ruby and the other is a dedicated instance that is
        available only to #{ChefUtils::Dist::Infra::PRODUCT}.
        Use the **chef_gem** resource to install gems into the instance of Ruby that is dedicated to #{ChefUtils::Dist::Infra::PRODUCT}.
        Use the **gem_package** resource to install all other gems (i.e. install gems system-wide).
      DESC

      examples <<~EXAMPLES
        The following examples demonstrate various approaches for using the **gem_package** resource in recipes:

        **Install a gem file from the local file system**

        ```ruby
        gem_package 'loofah' do
          source '/tmp/loofah-2.7.0.gem'
          action :install
        end
        ```

        **Use the `ignore_failure` common attribute**

        ```ruby
        gem_package 'syntax' do
          action :install
          ignore_failure true
        end
        ```
      EXAMPLES

      allowed_actions :install, :upgrade, :remove, :purge

      property :package_name, String,
        description: "An optional property to set the package name if it differs from the resource block's name.",
        identity: true

      property :version, String,
        description: "The version of a package to be installed or upgraded."

      # the source can either be a path to a package source like:
      #   source /var/tmp/mygem-1.2.3.4.gem
      # or it can be a url rubygems source like:
      #   https://rubygems.org
      # the default has to be nil in order for the magical wiring up of the name property to
      # the source pathname to work correctly.
      #
      # we don't do coercions here because its all a bit too complicated
      #
      # FIXME? the array form of installing paths most likely does not work?
      #
      property :source, [ String, Array ],
        description: "Optional. The URL, or list of URLs, at which the gem package is located. This list is added to the source configured in `Chef::Config[:rubygems_url]` (see also include_default_source) to construct the complete list of rubygems sources. Users in an 'airgapped' environment should set Chef::Config[:rubygems_url] to their local RubyGems mirror."

      property :clear_sources, [ TrueClass, FalseClass, nil ],
        description: "Set to `true` to download a gem from the path specified by the `source` property (and not from RubyGems).",
        default: lazy { Chef::Config[:clear_gem_sources] },
        default_description: "false unless `clear_gem_sources` set to true in the `client.rb` config.", desired_state: false

      property :gem_binary, String, desired_state: false,
        description: "The path of a gem binary to use for the installation. By default, the same version of Ruby that is used by #{ChefUtils::Dist::Infra::PRODUCT} will be used."

      property :include_default_source, [ TrueClass, FalseClass, nil ],
        description: "Set to `false` to not include `Chef::Config[:rubygems_url]` in the sources.",
        default: nil, introduced: "13.0"

      property :options, [ String, Hash, Array, nil ],
        description: "Options for the gem install, either a Hash or a String. When a hash is given, the options are passed to `Gem::DependencyInstaller.new`, and the gem will be installed via the gems API. When a String is given, the gem will be installed by shelling out to the gem command. Using a Hash of options with an explicit gem_binary will result in undefined behavior.",
        desired_state: false
    end
  end
end