Class: Mixlib::Install::Options
- Inherits:
-
Object
- Object
- Mixlib::Install::Options
- Defined in:
- lib/mixlib/install/options.rb
Defined Under Namespace
Classes: InvalidOptions
Constant Summary collapse
- SUPPORTED_ARCHITECTURES =
%w{ aarch64 i386 powerpc ppc64 ppc64le s390x sparc x86_64 }
- SUPPORTED_CHANNELS =
[ :stable, :current, :unstable, ]
- SUPPORTED_PRODUCT_NAMES =
PRODUCT_MATRIX.products
- SUPPORTED_SHELL_TYPES =
[ :ps1, :sh, ]
- SUPPORTED_OPTIONS =
[ :architecture, :channel, :platform, :platform_version, :product_name, :product_version, :shell_type, :platform_version_compatibility_mode, :include_metadata, :user_agent_headers, :install_command_options, ]
- SUPPORTED_WINDOWS_DESKTOP_VERSIONS =
%w{10}
- SUPPORTED_WINDOWS_NANO_VERSIONS =
%w{2016nano}
Instance Attribute Summary collapse
-
#errors ⇒ Object
readonly
Returns the value of attribute errors.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#original_platform_version ⇒ Object
readonly
Returns the value of attribute original_platform_version.
Instance Method Summary collapse
- #for_ps1? ⇒ Boolean (also: #for_windows?)
- #include_metadata? ⇒ Boolean
-
#initialize(options) ⇒ Options
constructor
A new instance of Options.
- #latest_version? ⇒ Boolean
- #partial_version? ⇒ Boolean
- #platform_info ⇒ Object
-
#resolve_platform_version_compatibility_mode! ⇒ Object
Calling this method will give queries more of an opportunity to collect compatible artifacts where there may not always be an exact match.
-
#set_platform_info(info) ⇒ Object
Set the platform info on the instance info [Hash] Hash with keys :platform, :platform_version and :architecture.
- #validate! ⇒ Object
- #validate_options! ⇒ Object
Constructor Details
#initialize(options) ⇒ Options
Returns a new instance of Options.
71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/mixlib/install/options.rb', line 71 def initialize() @options = @errors = [] # Store original options in cases where we must remap @original_platform_version = [:platform_version] resolve_platform_version_compatibility_mode! map_windows_versions! validate! end |
Instance Attribute Details
#errors ⇒ Object (readonly)
Returns the value of attribute errors.
28 29 30 |
# File 'lib/mixlib/install/options.rb', line 28 def errors @errors end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
28 29 30 |
# File 'lib/mixlib/install/options.rb', line 28 def @options end |
#original_platform_version ⇒ Object (readonly)
Returns the value of attribute original_platform_version.
28 29 30 |
# File 'lib/mixlib/install/options.rb', line 28 def original_platform_version @original_platform_version end |
Instance Method Details
#for_ps1? ⇒ Boolean Also known as: for_windows?
106 107 108 |
# File 'lib/mixlib/install/options.rb', line 106 def for_ps1? platform == "windows" || shell_type == :ps1 end |
#include_metadata? ⇒ Boolean
129 130 131 |
# File 'lib/mixlib/install/options.rb', line 129 def .to_s == "true" end |
#latest_version? ⇒ Boolean
111 112 113 |
# File 'lib/mixlib/install/options.rb', line 111 def latest_version? product_version.to_sym == :latest end |
#partial_version? ⇒ Boolean
115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/mixlib/install/options.rb', line 115 def partial_version? # If PartialSemVer is defined than the version of mixlib-versioning loaded can parse partial versions # Otherwise parsing a partial version will return nil is_partial = if defined?(Mixlib::Versioning::Format::PartialSemVer) # remove if there's a trailing period for mixlib-versioning compatibility [:product_version] = product_version.chomp(".") if product_version.is_a? String Mixlib::Versioning.parse(product_version).is_a?(Mixlib::Versioning::Format::PartialSemVer) else !Mixlib::Versioning.parse(product_version) end !latest_version? && is_partial end |
#platform_info ⇒ Object
146 147 148 149 150 151 152 |
# File 'lib/mixlib/install/options.rb', line 146 def platform_info { platform: [:platform], platform_version: [:platform_version], architecture: [:architecture], } end |
#resolve_platform_version_compatibility_mode! ⇒ Object
Calling this method will give queries more of an opportunity to collect compatible artifacts where there may not always be an exact match.
This option is set to false by default.
-
In cases where no platform options are configured it will set this option to true.
-
In cases where all platform options are configured it will remain false UNLESS the option has been configured to be true.
163 164 165 166 167 |
# File 'lib/mixlib/install/options.rb', line 163 def resolve_platform_version_compatibility_mode! unless [:platform_version_compatibility_mode] [:platform_version_compatibility_mode] = true if platform_info.values.none? end end |
#set_platform_info(info) ⇒ Object
Set the platform info on the instance info [Hash]
Hash with keys :platform, :platform_version and :architecture
138 139 140 141 142 143 144 |
# File 'lib/mixlib/install/options.rb', line 138 def set_platform_info(info) [:platform] = info[:platform] [:platform_version] = info[:platform_version] [:architecture] = info[:architecture] end |
#validate! ⇒ Object
91 92 93 |
# File 'lib/mixlib/install/options.rb', line 91 def validate! end |
#validate_options! ⇒ Object
95 96 97 98 99 100 101 102 103 104 |
# File 'lib/mixlib/install/options.rb', line 95 def validate_architecture validate_product_names validate_channels validate_shell_type validate_user_agent_headers raise InvalidOptions, errors.join("\n") unless errors.empty? end |