Class: Chef::Provider::Package::Rubygems::GemEnvironment
- Inherits:
-
Object
- Object
- Chef::Provider::Package::Rubygems::GemEnvironment
- Defined in:
- lib/chef/provider/package/rubygems.rb
Direct Known Subclasses
Constant Summary collapse
- DEFAULT_UNINSTALLER_OPTS =
{ :ignore => true, :executables => true }
Instance Method Summary collapse
-
#candidate_version_from_file(gem_dependency, source) ⇒ Object
Determines the candidate version for a gem from a .gem file on disk and checks if it matches the version constraints in
gem_dependency
=== Returns Gem::Version a singular gem version object is returned if the gem is available nil returns nil if the gem on disk doesn’t match the version constraints forgem_dependency
. -
#candidate_version_from_remote(gem_dependency, *sources) ⇒ Object
Finds the newest version that satisfies the constraints of
gem_dependency
. - #dependency_installer(opts = {}) ⇒ Object
-
#find_newest_remote_version(gem_dependency, *sources) ⇒ Object
Find the newest gem version available from Gem.sources that satisfies the constraints of
gem_dependency
. -
#gem_paths ⇒ Object
The paths where rubygems should search for installed gems.
-
#gem_source_index ⇒ Object
A rubygems source index containing the list of gemspecs for all available gems in the gem installation.
-
#gem_specification ⇒ Object
A rubygems specification object containing the list of gemspecs for all available gems in the gem installation.
-
#install(gem_dependency, options = {}) ⇒ Object
Installs a gem via the rubygems ruby API.
-
#installed_versions(gem_dep) ⇒ Object
Lists the installed versions of
gem_name
, constrained by the version spec ingem_dep
=== Arguments Gem::Dependencygem_dep
is a Gem::Dependency object, its version specification constrains which gems are returned. -
#spec_from_file(file) ⇒ Object
Extracts the gemspec from a (on-disk) gem package.
-
#uninstall(gem_name, gem_version = nil, opts = {}) ⇒ Object
Uninstall the gem
gem_name
via the rubygems ruby API. - #uninstaller(gem_name, opts = {}) ⇒ Object
-
#with_correct_verbosity ⇒ Object
Set rubygems’ user interaction to ConsoleUI or SilentUI depending on our current debug level.
-
#with_gem_sources(*sources) ⇒ Object
Yields to the provided block with rubygems’ source list set to the list provided.
Instance Method Details
#candidate_version_from_file(gem_dependency, source) ⇒ Object
Determines the candidate version for a gem from a .gem file on disk and checks if it matches the version constraints in gem_dependency
Returns
Gem::Version a singular gem version object is returned if the gem
is available
nil returns nil if the gem on disk doesn’t match the
version constraints for +gem_dependency+
133 134 135 136 137 138 139 140 141 142 143 |
# File 'lib/chef/provider/package/rubygems.rb', line 133 def candidate_version_from_file(gem_dependency, source) spec = spec_from_file(source) if spec.satisfies_requirement?(gem_dependency) logger.debug { "#{@new_resource} found candidate gem version #{spec.version} from local gem package #{source}" } spec.version else # This is probably going to end badly... logger.warn { "#{@new_resource} gem package #{source} does not satisfy the requirements #{gem_dependency}" } nil end end |
#candidate_version_from_remote(gem_dependency, *sources) ⇒ Object
Finds the newest version that satisfies the constraints of gem_dependency
. The version is determined from the cache or a round-trip to the server as needed. The architecture and gem sources will be set before making the query.
Returns
Gem::Version a singular gem version object is returned if the gem
is available
nil returns nil if the gem could not be found
154 155 156 |
# File 'lib/chef/provider/package/rubygems.rb', line 154 def candidate_version_from_remote(gem_dependency, *sources) raise NotImplementedError end |
#dependency_installer(opts = {}) ⇒ Object
221 222 223 |
# File 'lib/chef/provider/package/rubygems.rb', line 221 def dependency_installer(opts = {}) Gem::DependencyInstaller.new(opts) end |
#find_newest_remote_version(gem_dependency, *sources) ⇒ Object
Find the newest gem version available from Gem.sources that satisfies the constraints of gem_dependency
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/chef/provider/package/rubygems.rb', line 161 def find_newest_remote_version(gem_dependency, *sources) available_gems = dependency_installer.find_gems_with_sources(gem_dependency) spec, source = if available_gems.respond_to?(:last) # DependencyInstaller sorts the results such that the last one is # always the one it considers best. spec_with_source = available_gems.last spec_with_source && spec_with_source else # Rubygems 2.0 returns a Gem::Available set, which is a # collection of AvailableSet::Tuple structs available_gems.pick_best! best_gem = available_gems.set.first best_gem && [best_gem.spec, best_gem.source] end version = spec && spec.version if version logger.debug { "#{@new_resource} found gem #{spec.name} version #{version} for platform #{spec.platform} from #{source}" } version else source_list = sources.compact.empty? ? "[#{Gem.sources.to_a.join(', ')}]" : "[#{sources.join(', ')}]" logger.warn { "#{@new_resource} failed to find gem #{gem_dependency} from #{source_list}" } nil end end |
#gem_paths ⇒ Object
The paths where rubygems should search for installed gems. Implemented by subclasses.
55 56 57 |
# File 'lib/chef/provider/package/rubygems.rb', line 55 def gem_paths raise NotImplementedError end |
#gem_source_index ⇒ Object
A rubygems source index containing the list of gemspecs for all available gems in the gem installation. Implemented by subclasses
Returns
Gem::SourceIndex
65 66 67 |
# File 'lib/chef/provider/package/rubygems.rb', line 65 def gem_source_index raise NotImplementedError end |
#gem_specification ⇒ Object
A rubygems specification object containing the list of gemspecs for all available gems in the gem installation. Implemented by subclasses For rubygems >= 1.8.0
Returns
Gem::Specification
76 77 78 |
# File 'lib/chef/provider/package/rubygems.rb', line 76 def gem_specification raise NotImplementedError end |
#install(gem_dependency, options = {}) ⇒ Object
Installs a gem via the rubygems ruby API.
Options
:sources rubygems servers to use Other options are passed to Gem::DependencyInstaller.new
192 193 194 195 196 197 198 |
# File 'lib/chef/provider/package/rubygems.rb', line 192 def install(gem_dependency, = {}) with_gem_sources(*.delete(:sources)) do with_correct_verbosity do dependency_installer().install(gem_dependency) end end end |
#installed_versions(gem_dep) ⇒ Object
Lists the installed versions of gem_name
, constrained by the version spec in gem_dep
Arguments
Gem::Dependency gem_dep
is a Gem::Dependency object, its version
specification constrains which gems are returned.
Returns
- Gem::Specification
-
an array of Gem::Specification objects
88 89 90 91 92 93 94 |
# File 'lib/chef/provider/package/rubygems.rb', line 88 def installed_versions(gem_dep) if Gem::Version.new(Gem::VERSION) >= Gem::Version.new("1.8.0") gem_specification.find_all_by_name(gem_dep.name, gem_dep.requirement) else gem_source_index.search(gem_dep) end end |
#spec_from_file(file) ⇒ Object
Extracts the gemspec from a (on-disk) gem package.
Returns
Gem::Specification
– Compatibility note: Rubygems 1.x uses Gem::Format, 2.0 moved this code into Gem::Package.
117 118 119 120 121 122 123 |
# File 'lib/chef/provider/package/rubygems.rb', line 117 def spec_from_file(file) if defined?(Gem::Format) && Gem::Package.respond_to?(:open) Gem::Format.from_file_by_path(file).spec else Gem::Package.new(file).spec end end |
#uninstall(gem_name, gem_version = nil, opts = {}) ⇒ Object
Uninstall the gem gem_name
via the rubygems ruby API. If gem_version
is provided, only that version will be uninstalled. Otherwise, all versions are uninstalled.
Options
Options are passed to Gem::Uninstaller.new
206 207 208 209 210 211 |
# File 'lib/chef/provider/package/rubygems.rb', line 206 def uninstall(gem_name, gem_version = nil, opts = {}) gem_version ? opts[:version] = gem_version : opts[:all] = true with_correct_verbosity do uninstaller(gem_name, opts).uninstall end end |
#uninstaller(gem_name, opts = {}) ⇒ Object
225 226 227 |
# File 'lib/chef/provider/package/rubygems.rb', line 225 def uninstaller(gem_name, opts = {}) Gem::Uninstaller.new(gem_name, DEFAULT_UNINSTALLER_OPTS.merge(opts)) end |
#with_correct_verbosity ⇒ Object
Set rubygems’ user interaction to ConsoleUI or SilentUI depending on our current debug level
216 217 218 219 |
# File 'lib/chef/provider/package/rubygems.rb', line 216 def with_correct_verbosity Gem::DefaultUserInteraction.ui = Chef::Log.debug? ? Gem::ConsoleUI.new : Gem::SilentUI.new yield end |
#with_gem_sources(*sources) ⇒ Object
Yields to the provided block with rubygems’ source list set to the list provided. Always resets the list when the block returns or raises an exception.
100 101 102 103 104 105 106 107 |
# File 'lib/chef/provider/package/rubygems.rb', line 100 def with_gem_sources(*sources) sources.compact! original_sources = Gem.sources Gem.sources = sources unless sources.empty? yield ensure Gem.sources = original_sources end |