chef-utils 16.10.17 → 17.10.19

data/lib/chef-utils/version.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-# 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.
-
-module ChefUtils
-  CHEFUTILS_ROOT = File.expand_path("..", __dir__)
-  VERSION = "16.10.17"
-end
+# frozen_string_literal: true
+# 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.
+
+module ChefUtils
+  CHEFUTILS_ROOT = File.expand_path("..", __dir__)
+  VERSION = "17.10.19"
+end

data/lib/chef-utils/version_string.rb

@@ -1,160 +1,160 @@
-# frozen_string_literal: true
-# Copyright:: Copyright 2017, Noah Kantrowitz
-# 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.
-
-module ChefUtils
-  # String-like object for version strings.
-  #
-  # @since 13.2
-  # @api internal
-  class VersionString < String
-    # Parsed version object for the string.
-    # @return [Gem::Version]
-    attr_reader :parsed_version
-
-    # Create a new VersionString from an input String.
-    #
-    # @param val [String] Version string to parse.
-    def initialize(val)
-      val ||= ""
-      super(val)
-      begin
-        @parsed_version = ::Gem::Version.create(self)
-      rescue ArgumentError
-        @parsed_version = nil
-      end
-    end
-
-    # @!group Compat wrappers for String
-
-    # Compat wrapper for + to behave like a normal String.
-    #
-    # @param other [String]
-    # @return [String]
-    def +(other)
-      to_s + other
-    end
-
-    # Compat wrapper for * to behave like a normal String.
-    #
-    # @param other [Integer]
-    # @return [String]
-    def *(other)
-      to_s * other
-    end
-
-    # @!group Comparison operators
-
-    # Compare a VersionString to an object. If compared to another VersionString
-    # then sort like `Gem::Version`, otherwise try to treat the other object as
-    # a version but fall back to normal string comparison.
-    #
-    # @param other [Object]
-    # @return [Integer]
-    def <=>(other)
-      other_ver = case other
-                  when VersionString
-                    other.parsed_version
-                  else
-                    begin
-                      Gem::Version.create(other.to_s)
-                    rescue ArgumentError
-                      # Comparing to a string that isn't a version.
-                      return super
-                    end
-                  end
-      parsed_version <=> other_ver
-    end
-
-    # Compat wrapper for == based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def ==(other)
-      (self <=> other) == 0
-    end
-
-    # Compat wrapper for != based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def !=(other)
-      (self <=> other) != 0
-    end
-
-    # Compat wrapper for < based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def <(other)
-      (self <=> other) < 0
-    end
-
-    # Compat wrapper for <= based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def <=(other)
-      (self <=> other) < 1
-    end
-
-    # Compat wrapper for > based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def >(other)
-      (self <=> other) > 0
-    end
-
-    # Compat wrapper for >= based on <=>.
-    #
-    # @param other [Object]
-    # @return [Boolean]
-    def >=(other)
-      (self <=> other) > -1
-    end
-
-    # @!group Matching operators
-
-    # Matching operator to support checking against a requirement string.
-    #
-    # @param other [Regexp, String]
-    # @return [Boolean]
-    # @example Match against a Regexp
-    #   ChefUtils::VersionString.new('1.0.0') =~ /^1/
-    # @example Match against a requirement
-    #   ChefUtils::VersionString.new('1.0.0') =~ '~> 1.0'
-    def =~(other)
-      case other
-      when Regexp
-        super
-      else
-        begin
-          Gem::Requirement.create(other) =~ parsed_version
-        rescue ArgumentError
-          # one side of the comparison wasn't parsable
-          super
-        end
-      end
-    end
-
-    # Back-compat API for chef-sugar.  The other APIs are preferable.
-    #
-    # @api private
-    def satisfies?(*constraints)
-      Gem::Requirement.new(*constraints).satisfied_by?(@parsed_version)
-    end
-  end
-end
+# frozen_string_literal: true
+# Copyright:: Copyright 2017, Noah Kantrowitz
+# 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.
+
+module ChefUtils
+  # String-like object for version strings.
+  #
+  # @since 13.2
+  # @api internal
+  class VersionString < String
+    # Parsed version object for the string.
+    # @return [Gem::Version]
+    attr_reader :parsed_version
+
+    # Create a new VersionString from an input String.
+    #
+    # @param val [String] Version string to parse.
+    def initialize(val)
+      val ||= ""
+      super(val)
+      begin
+        @parsed_version = ::Gem::Version.create(self)
+      rescue ArgumentError
+        @parsed_version = nil
+      end
+    end
+
+    # @!group Compat wrappers for String
+
+    # Compat wrapper for + to behave like a normal String.
+    #
+    # @param other [String]
+    # @return [String]
+    def +(other)
+      to_s + other
+    end
+
+    # Compat wrapper for * to behave like a normal String.
+    #
+    # @param other [Integer]
+    # @return [String]
+    def *(other)
+      to_s * other
+    end
+
+    # @!group Comparison operators
+
+    # Compare a VersionString to an object. If compared to another VersionString
+    # then sort like `Gem::Version`, otherwise try to treat the other object as
+    # a version but fall back to normal string comparison.
+    #
+    # @param other [Object]
+    # @return [Integer]
+    def <=>(other)
+      other_ver = case other
+                  when VersionString
+                    other.parsed_version
+                  else
+                    begin
+                      Gem::Version.create(other.to_s)
+                    rescue ArgumentError
+                      # Comparing to a string that isn't a version.
+                      return super
+                    end
+                  end
+      parsed_version <=> other_ver
+    end
+
+    # Compat wrapper for == based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def ==(other)
+      (self <=> other) == 0
+    end
+
+    # Compat wrapper for != based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def !=(other)
+      (self <=> other) != 0
+    end
+
+    # Compat wrapper for < based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def <(other)
+      (self <=> other) < 0
+    end
+
+    # Compat wrapper for <= based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def <=(other)
+      (self <=> other) < 1
+    end
+
+    # Compat wrapper for > based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def >(other)
+      (self <=> other) > 0
+    end
+
+    # Compat wrapper for >= based on <=>.
+    #
+    # @param other [Object]
+    # @return [Boolean]
+    def >=(other)
+      (self <=> other) > -1
+    end
+
+    # @!group Matching operators
+
+    # Matching operator to support checking against a requirement string.
+    #
+    # @param other [Regexp, String]
+    # @return [Boolean]
+    # @example Match against a Regexp
+    #   ChefUtils::VersionString.new('1.0.0') =~ /^1/
+    # @example Match against a requirement
+    #   ChefUtils::VersionString.new('1.0.0') =~ '~> 1.0'
+    def =~(other)
+      case other
+      when Regexp
+        super
+      else
+        begin
+          Gem::Requirement.create(other) =~ parsed_version
+        rescue ArgumentError
+          # one side of the comparison wasn't parsable
+          super
+        end
+      end
+    end
+
+    # Back-compat API for chef-sugar.  The other APIs are preferable.
+    #
+    # @api private
+    def satisfies?(*constraints)
+      Gem::Requirement.new(*constraints).satisfied_by?(@parsed_version)
+    end
+  end
+end

data/lib/chef-utils.rb

@@ -1,53 +1,53 @@
-# frozen_string_literal: true
-#
-# 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 "chef-utils/dsl/architecture"
-require_relative "chef-utils/dsl/cloud"
-require_relative "chef-utils/dsl/introspection"
-require_relative "chef-utils/dsl/os"
-require_relative "chef-utils/dsl/default_paths"
-require_relative "chef-utils/dsl/path_sanity"
-require_relative "chef-utils/dsl/platform"
-require_relative "chef-utils/dsl/platform_family"
-require_relative "chef-utils/dsl/platform_version"
-require_relative "chef-utils/dsl/service"
-require_relative "chef-utils/dsl/train_helpers"
-require_relative "chef-utils/dsl/virtualization"
-require_relative "chef-utils/dsl/which"
-require_relative "chef-utils/dsl/windows"
-require_relative "chef-utils/mash"
-
-# This is the Chef Infra Client DSL, not everything needs to go in here
-module ChefUtils
-  include ChefUtils::DSL::Architecture
-  include ChefUtils::DSL::Cloud
-  include ChefUtils::DSL::DefaultPaths
-  include ChefUtils::DSL::Introspection
-  include ChefUtils::DSL::OS
-  include ChefUtils::DSL::Platform
-  include ChefUtils::DSL::PlatformFamily
-  include ChefUtils::DSL::PlatformVersion
-  include ChefUtils::DSL::TrainHelpers
-  include ChefUtils::DSL::Virtualization
-  include ChefUtils::DSL::Which
-  include ChefUtils::DSL::Windows
-  # ChefUtils::DSL::Service is deliberately excluded
-
-  CANARY = 1 # used as a guard for requires
-  extend self
-end
+# frozen_string_literal: true
+#
+# 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 "chef-utils/dsl/architecture"
+require_relative "chef-utils/dsl/cloud"
+require_relative "chef-utils/dsl/introspection"
+require_relative "chef-utils/dsl/os"
+require_relative "chef-utils/dsl/default_paths"
+require_relative "chef-utils/dsl/path_sanity"
+require_relative "chef-utils/dsl/platform"
+require_relative "chef-utils/dsl/platform_family"
+require_relative "chef-utils/dsl/platform_version"
+require_relative "chef-utils/dsl/service"
+require_relative "chef-utils/dsl/train_helpers"
+require_relative "chef-utils/dsl/virtualization"
+require_relative "chef-utils/dsl/which"
+require_relative "chef-utils/dsl/windows"
+require_relative "chef-utils/mash"
+
+# This is the Chef Infra Client DSL, not everything needs to go in here
+module ChefUtils
+  include ChefUtils::DSL::Architecture
+  include ChefUtils::DSL::Cloud
+  include ChefUtils::DSL::DefaultPaths
+  include ChefUtils::DSL::Introspection
+  include ChefUtils::DSL::OS
+  include ChefUtils::DSL::Platform
+  include ChefUtils::DSL::PlatformFamily
+  include ChefUtils::DSL::PlatformVersion
+  include ChefUtils::DSL::TrainHelpers
+  include ChefUtils::DSL::Virtualization
+  include ChefUtils::DSL::Which
+  include ChefUtils::DSL::Windows
+  # ChefUtils::DSL::Service is deliberately excluded
+
+  CANARY = 1 # used as a guard for requires
+  extend self
+end

data/spec/spec_helper.rb

@@ -1,100 +1,100 @@
-# frozen_string_literal: true
-require "chef-utils"
-
-# FIXME: dynamically generate this for accuracy
-HELPER_MODULES = [
-  ChefUtils::DSL::Architecture,
-  ChefUtils::DSL::Cloud,
-  ChefUtils::DSL::Introspection,
-  ChefUtils::DSL::OS,
-  ChefUtils::DSL::DefaultPaths,
-  ChefUtils::DSL::Platform,
-  ChefUtils::DSL::PlatformFamily,
-  ChefUtils::DSL::Service,
-  ChefUtils::DSL::Virtualization,
-  ChefUtils::DSL::Which,
-  ChefUtils::DSL::Windows,
-].freeze
-
-ARCH_HELPERS = (ChefUtils::DSL::Architecture.methods - Module.methods).freeze
-CLOUD_HELPERS = (ChefUtils::DSL::Cloud.methods - Module.methods).freeze
-INTROSPECTION_HELPERS = (ChefUtils::DSL::Introspection.methods - Module.methods).freeze
-OS_HELPERS = (ChefUtils::DSL::OS.methods - Module.methods).freeze
-PLATFORM_FAMILY_HELPERS = (ChefUtils::DSL::PlatformFamily.methods - Module.methods).freeze
-PLATFORM_HELPERS = (ChefUtils::DSL::Platform.methods - Module.methods).freeze
-VIRTUALIZATION_HELPERS = (ChefUtils::DSL::Virtualization.methods - Module.methods).freeze
-WINDOWS_HELPERS = (ChefUtils::DSL::Windows.methods - Module.methods).freeze
-
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  config.filter_run_excluding windows_only: true unless ChefUtils.windows?
-  config.filter_run_excluding unix_only: true if ChefUtils.windows?
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  # config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-end
+# frozen_string_literal: true
+require "chef-utils"
+
+# FIXME: dynamically generate this for accuracy
+HELPER_MODULES = [
+  ChefUtils::DSL::Architecture,
+  ChefUtils::DSL::Cloud,
+  ChefUtils::DSL::Introspection,
+  ChefUtils::DSL::OS,
+  ChefUtils::DSL::DefaultPaths,
+  ChefUtils::DSL::Platform,
+  ChefUtils::DSL::PlatformFamily,
+  ChefUtils::DSL::Service,
+  ChefUtils::DSL::Virtualization,
+  ChefUtils::DSL::Which,
+  ChefUtils::DSL::Windows,
+].freeze
+
+ARCH_HELPERS = (ChefUtils::DSL::Architecture.methods - Module.methods).freeze
+CLOUD_HELPERS = (ChefUtils::DSL::Cloud.methods - Module.methods).freeze
+INTROSPECTION_HELPERS = (ChefUtils::DSL::Introspection.methods - Module.methods).freeze
+OS_HELPERS = (ChefUtils::DSL::OS.methods - Module.methods).freeze
+PLATFORM_FAMILY_HELPERS = (ChefUtils::DSL::PlatformFamily.methods - Module.methods).freeze
+PLATFORM_HELPERS = (ChefUtils::DSL::Platform.methods - Module.methods).freeze
+VIRTUALIZATION_HELPERS = (ChefUtils::DSL::Virtualization.methods - Module.methods).freeze
+WINDOWS_HELPERS = (ChefUtils::DSL::Windows.methods - Module.methods).freeze
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.filter_run_excluding windows_only: true unless ChefUtils.windows?
+  config.filter_run_excluding unix_only: true if ChefUtils.windows?
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end