chef-config 12.6.0 → 12.7.2

data/lib/chef-config/exceptions.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright 2015-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require 'chef-config/windows'
-require 'chef-config/logger'
+require "chef-config/windows"
+require "chef-config/logger"
 
 module ChefConfig
 

data/lib/chef-config/logger.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright 2015-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +15,6 @@
 # limitations under the License.
 #
 
-
 module ChefConfig
 
   # Implements enough of Logger's API that we can use it in place of a real
@@ -58,5 +57,3 @@ module ChefConfig
     @logger
   end
 end
-
-

data/lib/chef-config/package_task.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Kartik Null Cating-Subramanian (<ksubramanian@chef.io>)
-# Copyright:: Copyright (c) 2015 Chef, Inc.
+# Copyright:: Copyright 2015-2016, Chef, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,9 +16,9 @@
 # limitations under the License.
 #
 
-require 'rake'
-require 'rubygems'
-require 'rubygems/package_task'
+require "rake"
+require "rubygems"
+require "rubygems/package_task"
 
 module ChefConfig
   class PackageTask < Rake::TaskLib
@@ -47,10 +47,6 @@ module ChefConfig
       @module_path || module_name.downcase
     end
 
-    # Path to a VERSION file with a single string that contains the package version.
-    # By default, this is root_path/VERSION
-    attr_accessor :version_file_path
-
     # Directory used to store package files and output that is generated.
     # This has the same meaning (or lack thereof) as package_dir in
     # rake/packagetask.
@@ -59,7 +55,7 @@ module ChefConfig
     # Name of git remote used to push tags during a release.  Default is origin.
     attr_accessor :git_remote
 
-    def initialize(root_path=nil, module_name=nil)
+    def initialize(root_path = nil, module_name = nil)
       init(root_path, module_name)
       yield self if block_given?
       define unless root_path.nil? || module_name.nil?
@@ -70,22 +66,25 @@ module ChefConfig
       @module_name = module_name
       @component_paths = []
       @module_path = nil
-      @version_file_path = 'VERSION'
-      @package_dir = 'pkg'
-      @git_remote = 'origin'
+      @package_dir = "pkg"
+      @git_remote = "origin"
       @generate_version_class = false
     end
 
     def component_full_paths
-      component_paths.map { |path| File.expand_path(path, root_path)}
+      component_paths.map { |path| File.expand_path(path, root_path) }
     end
 
     def version_rb_path
       File.expand_path("lib/#{module_path}/version.rb", root_path)
     end
 
+    def chef_root_path
+      module_name == "Chef" ? root_path : File.dirname(root_path)
+    end
+
     def version
-      IO.read(File.expand_path(version_file_path, root_path)).strip
+      IO.read(File.join(chef_root_path, "VERSION")).strip
     end
 
     def full_package_dir
@@ -93,7 +92,7 @@ module ChefConfig
     end
 
     def class_or_module
-      generate_version_class ? 'class' : 'module'
+      generate_version_class ? "class" : "module"
     end
 
     def with_clean_env(&block)
@@ -105,46 +104,46 @@ module ChefConfig
     end
 
     def define
-      fail 'Need to provide package root and module name' if root_path.nil? || module_name.nil?
+      raise "Need to provide package root and module name" if root_path.nil? || module_name.nil?
 
-      desc 'Build Gems of component dependencies'
+      desc "Build Gems of component dependencies"
       task :package_components do
         component_full_paths.each do |component_path|
           Dir.chdir(component_path) do
-            sh 'rake package'
+            sh "rake package"
           end
         end
       end
 
       task :package => :package_components
 
-      desc 'Build and install component dependencies'
+      desc "Build and install component dependencies"
       task :install_components => :package_components do
         component_full_paths.each do |component_path|
           Dir.chdir(component_path) do
-            sh 'rake install'
+            sh "rake install"
           end
         end
       end
 
       task :install => :install_components
 
-      desc 'Clean up builds of component dependencies'
+      desc "Clean up builds of component dependencies"
       task :clobber_component_packages do
         component_full_paths.each do |component_path|
           Dir.chdir(component_path) do
-            sh 'rake clobber_package'
+            sh "rake clobber_package"
           end
         end
       end
 
       task :clobber_package => :clobber_component_packages
 
-      desc 'Update the version number for component dependencies'
+      desc "Update the version number for component dependencies"
       task :update_components_versions do
         component_full_paths.each do |component_path|
           Dir.chdir(component_path) do
-            sh 'rake version'
+            sh "rake version"
           end
         end
       end
@@ -152,7 +151,7 @@ module ChefConfig
       desc 'Regenerate lib/#{@module_path}/version.rb from VERSION file'
       task :version => :update_components_versions do
         contents = <<-VERSION_RB
-# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.
+# Copyright:: Copyright 2010-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -175,7 +174,7 @@ module ChefConfig
 
 #{class_or_module} #{module_name}
   #{module_name.upcase}_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
-  VERSION = '#{version}'
+  VERSION = "#{version}"
 end
 
 #
@@ -209,11 +208,11 @@ end
         sh %{gem uninstall #{module_path} -x -v #{version} }
       end
 
-      desc 'Build it, tag it and ship it'
+      desc "Build it, tag it and ship it"
       task :ship => [:clobber_package, :gem] do
         sh("git tag #{version}")
         sh("git push #{git_remote} --tags")
-        Dir[File.expand_path('*.gem', full_package_dir)].reverse.each do |built_gem|
+        Dir[File.expand_path("*.gem", full_package_dir)].reverse.each do |built_gem|
           sh("gem push #{built_gem}")
         end
       end

data/lib/chef-config/path_helper.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Bryan McLellan <btm@loftninjas.org>
-# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+# Copyright:: Copyright 2014-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,9 +16,9 @@
 # limitations under the License.
 #
 
-require 'chef-config/windows'
-require 'chef-config/logger'
-require 'chef-config/exceptions'
+require "chef-config/windows"
+require "chef-config/logger"
+require "chef-config/exceptions"
 
 module ChefConfig
   class PathHelper
@@ -32,11 +32,11 @@ module ChefConfig
         loop do
           slash = path.rindex(/[#{Regexp.escape(File::SEPARATOR)}#{Regexp.escape(path_separator)}]/, end_slash - 1)
           if !slash
-            return end_slash == path.size ? '.' : path_separator
+            return end_slash == path.size ? "." : path_separator
           elsif slash == end_slash - 1
             end_slash = slash
           else
-            return path[0..slash-1]
+            return path[0..slash - 1]
           end
         end
       else
@@ -64,8 +64,8 @@ module ChefConfig
       leading_slashes = /^[#{path_separator_regex}]+/
 
       args.flatten.inject() do |joined_path, component|
-        joined_path = joined_path.sub(trailing_slashes, '')
-        component = component.sub(leading_slashes, '')
+        joined_path = joined_path.sub(trailing_slashes, "")
+        component = component.sub(leading_slashes, "")
         joined_path += "#{path_separator}#{component}"
       end
     end
@@ -110,7 +110,7 @@ module ChefConfig
     end
 
     # Produces a comparable path.
-    def self.canonical_path(path, add_prefix=true)
+    def self.canonical_path(path, add_prefix = true)
       # First remove extra separators and resolve any relative paths
       abs_path = File.absolute_path(path)
 
@@ -146,7 +146,7 @@ module ChefConfig
     # http://stackoverflow.com/questions/14127343
     def self.escape_glob(*parts)
       path = cleanpath(join(*parts))
-      path.gsub(/[\\\{\}\[\]\*\?]/) { |x| "\\"+x }
+      path.gsub(/[\\\{\}\[\]\*\?]/) { |x| "\\" + x }
     end
 
     def self.relative_path_from(from, to)
@@ -201,12 +201,12 @@ module ChefConfig
         # HOMESHARE HOMEPATH
         # USERPROFILE
 
-        paths << ENV['HOME']
-        paths << ENV['HOMEDRIVE'] + ENV['HOMEPATH'] if ENV['HOMEDRIVE'] && ENV['HOMEPATH']
-        paths << ENV['HOMESHARE'] + ENV['HOMEPATH'] if ENV['HOMESHARE'] && ENV['HOMEPATH']
-        paths << ENV['USERPROFILE']
+        paths << ENV["HOME"]
+        paths << ENV["HOMEDRIVE"] + ENV["HOMEPATH"] if ENV["HOMEDRIVE"] && ENV["HOMEPATH"]
+        paths << ENV["HOMESHARE"] + ENV["HOMEPATH"] if ENV["HOMESHARE"] && ENV["HOMEPATH"]
+        paths << ENV["USERPROFILE"]
       end
-      paths << Dir.home if ENV['HOME']
+      paths << Dir.home if ENV["HOME"]
 
       # Depending on what environment variables we're using, the slashes can go in any which way.
       # Just change them all to / to keep things consistent.
@@ -231,27 +231,28 @@ module ChefConfig
 
     # Determine if the given path is protected by OS X System Integrity Protection.
     def self.is_sip_path?(path, node)
-      if node['platform'] == 'mac_os_x' and Gem::Version.new(node['platform_version']) >= Gem::Version.new('10.11')
+      if node["platform"] == "mac_os_x" and Gem::Version.new(node["platform_version"]) >= Gem::Version.new("10.11")
           # todo: parse rootless.conf for this?
-          sip_paths= [
-            '/System', '/bin', '/sbin', '/usr',
-          ]
-          sip_paths.each do |sip_path|
-            ChefConfig.logger.info("This is a SIP path, checking if it in exceptions list.")
-            return true if path.start_with?(sip_path)
-          end
-          false
+        sip_paths = [
+          "/System", "/bin", "/sbin", "/usr"
+        ]
+        sip_paths.each do |sip_path|
+          ChefConfig.logger.info("This is a SIP path, checking if it in exceptions list.")
+          return true if path.start_with?(sip_path)
+        end
+        false
       else
         false
       end
     end
+
     # Determine if the given path is on the exception list for OS X System Integrity Protection.
     def self.writable_sip_path?(path)
       # todo: parse rootless.conf for this?
       sip_exceptions = [
-        '/System/Library/Caches', '/System/Library/Extensions',
-        '/System/Library/Speech', '/System/Library/User Template',
-        '/usr/libexec/cups', '/usr/local', '/usr/share/man'
+        "/System/Library/Caches", "/System/Library/Extensions",
+        "/System/Library/Speech", "/System/Library/User Template",
+        "/usr/libexec/cups", "/usr/local", "/usr/share/man"
       ]
       sip_exceptions.each do |exception_path|
         return true if path.start_with?(exception_path)
@@ -261,4 +262,3 @@ module ChefConfig
     end
   end
 end
-

data/lib/chef-config/version.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.
+# Copyright:: Copyright 2010-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,7 +21,7 @@
 
 module ChefConfig
   CHEFCONFIG_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
-  VERSION = '12.6.0'
+  VERSION = "12.7.2"
 end
 
 #

data/lib/chef-config/windows.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2015 Chef Software, Inc.
+# Copyright:: Copyright 2015-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,4 +26,3 @@ module ChefConfig
   end
 
 end
-

data/lib/chef-config/workstation_config_loader.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Daniel DeLeo (<dan@chef.io>)
-# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+# Copyright:: Copyright 2014-2016, Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,11 +16,11 @@
 # limitations under the License.
 #
 
-require 'chef-config/config'
-require 'chef-config/exceptions'
-require 'chef-config/logger'
-require 'chef-config/path_helper'
-require 'chef-config/windows'
+require "chef-config/config"
+require "chef-config/exceptions"
+require "chef-config/logger"
+require "chef-config/path_helper"
+require "chef-config/windows"
 
 module ChefConfig
   class WorkstationConfigLoader
@@ -29,7 +29,7 @@ module ChefConfig
     attr_accessor :explicit_config_file
 
     # TODO: initialize this with a logger for Chef and Knife
-    def initialize(explicit_config_file, logger=nil)
+    def initialize(explicit_config_file, logger = nil)
       @explicit_config_file = explicit_config_file
       @chef_config_dir = nil
       @config_location = nil
@@ -99,36 +99,36 @@ module ChefConfig
       candidate_configs = []
 
       # Look for $KNIFE_HOME/knife.rb (allow multiple knives config on same machine)
-      if env['KNIFE_HOME']
-        candidate_configs << File.join(env['KNIFE_HOME'], 'config.rb')
-        candidate_configs << File.join(env['KNIFE_HOME'], 'knife.rb')
+      if env["KNIFE_HOME"]
+        candidate_configs << File.join(env["KNIFE_HOME"], "config.rb")
+        candidate_configs << File.join(env["KNIFE_HOME"], "knife.rb")
       end
       # Look for $PWD/knife.rb
       if Dir.pwd
-        candidate_configs << File.join(Dir.pwd, 'config.rb')
-        candidate_configs << File.join(Dir.pwd, 'knife.rb')
+        candidate_configs << File.join(Dir.pwd, "config.rb")
+        candidate_configs << File.join(Dir.pwd, "knife.rb")
       end
       # Look for $UPWARD/.chef/knife.rb
       if chef_config_dir
-        candidate_configs << File.join(chef_config_dir, 'config.rb')
-        candidate_configs << File.join(chef_config_dir, 'knife.rb')
+        candidate_configs << File.join(chef_config_dir, "config.rb")
+        candidate_configs << File.join(chef_config_dir, "knife.rb")
       end
       # Look for $HOME/.chef/knife.rb
-      PathHelper.home('.chef') do |dot_chef_dir|
-        candidate_configs << File.join(dot_chef_dir, 'config.rb')
-        candidate_configs << File.join(dot_chef_dir, 'knife.rb')
+      PathHelper.home(".chef") do |dot_chef_dir|
+        candidate_configs << File.join(dot_chef_dir, "config.rb")
+        candidate_configs << File.join(dot_chef_dir, "knife.rb")
       end
 
-      candidate_configs.find do | candidate_config |
+      candidate_configs.find do |candidate_config|
         have_config?(candidate_config)
       end
     end
 
     def working_directory
       a = if ChefConfig.windows?
-            env['CD']
+            env["CD"]
           else
-            env['PWD']
+            env["PWD"]
           end || Dir.pwd
 
       a
@@ -151,7 +151,7 @@ module ChefConfig
       message = "You have an error in your config file #{config_file_path}\n\n"
       message << "#{e.class.name}: #{e.message}\n"
       filtered_trace = e.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
-      filtered_trace.each {|bt_line| message << "  " << bt_line << "\n" }
+      filtered_trace.each { |bt_line| message << "  " << bt_line << "\n" }
       if !filtered_trace.empty?
         line_nr = filtered_trace.first[/#{Regexp.escape(config_file_path)}:([\d]+)/, 1]
         message << highlight_config_error(config_file_path, line_nr.to_i)
@@ -159,10 +159,9 @@ module ChefConfig
       raise ChefConfig::ConfigurationError, message
     end
 
-
     def highlight_config_error(file, line)
       config_file_lines = []
-      IO.readlines(file).each_with_index {|l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}"}
+      IO.readlines(file).each_with_index { |l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}" }
       if line == 1
         lines = config_file_lines[0..3]
       else