#
# Author:: Adam Jacob (<adam@chef.io>)
# Copyright:: Copyright 2008-2017, 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 "chef/resource/package"

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

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

      # 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://www.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 ]
      property :clear_sources, [ TrueClass, FalseClass ], default: false, desired_state: false
      # Sets a custom gem_binary to run for gem commands.
      property :gem_binary, String, desired_state: false

      # set to false to avoid including Chef::Config[:rubygems_url] in the sources
      property :include_default_source, [ TrueClass, FalseClass ], default: true

      ##
      # 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.
      property :options, [ String, Hash, Array, nil ], desired_state: false

    end
  end
end