chef-dk 1.2.22 → 1.3.40

data/lib/chef-dk/configurable.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require 'chef/config'
-require 'chef/workstation_config_loader'
+require "chef/config"
+require "chef/workstation_config_loader"
 
 # Define a config context for ChefDK
 class Chef::Config

data/lib/chef-dk/cookbook_metadata.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require 'chef-dk/exceptions'
-require 'chef/cookbook/metadata'
+require "chef-dk/exceptions"
+require "chef/cookbook/metadata"
 
 module ChefDK
 

data/lib/chef-dk/cookbook_omnifetch.rb

@@ -15,18 +15,17 @@
 # limitations under the License.
 #
 
-require 'cookbook-omnifetch'
-require 'chef-dk/shell_out'
-require 'chef-dk/cookbook_metadata'
-require 'chef-dk/helpers'
+require "cookbook-omnifetch"
+require "chef-dk/shell_out"
+require "chef-dk/cookbook_metadata"
+require "chef-dk/helpers"
 
-require 'chef/http/simple'
+require "chef/http/simple"
 
 # Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
 CookbookOmnifetch.configure do |c|
-  c.cache_path = File.expand_path(File.join(ChefDK::Helpers.chefdk_home, 'cache'))
-  c.storage_path = Pathname.new(File.expand_path(File.join(ChefDK::Helpers.chefdk_home, 'cache', 'cookbooks')))
+  c.cache_path = File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache"))
+  c.storage_path = Pathname.new(File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache", "cookbooks")))
   c.shell_out_class = ChefDK::ShellOut
   c.cached_cookbook_class = ChefDK::CookbookMetadata
 end
-

data/lib/chef-dk/cookbook_profiler/git.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require 'chef-dk/helpers'
+require "chef-dk/helpers"
 
 module ChefDK
   module CookbookProfiler
@@ -42,7 +42,7 @@ module ChefDK
           "revision" => revision,
           "working_tree_clean" => clean?,
           "published" => !unpublished_commits?,
-          "synchronized_remote_branches" => synchronized_remotes
+          "synchronized_remote_branches" => synchronized_remotes,
         }
       end
 
@@ -60,7 +60,7 @@ module ChefDK
       end
 
       def clean?
-        git!("diff-files --quiet", returns: [0,1]).exitstatus == 0
+        git!("diff-files --quiet", returns: [0, 1]).exitstatus == 0
       end
 
       def unpublished_commits?
@@ -90,11 +90,11 @@ module ChefDK
       end
 
       def remote_name
-        @remote_name ||= git!("config --get branch.#{current_branch}.remote", returns: [0,1]).stdout.strip
+        @remote_name ||= git!("config --get branch.#{current_branch}.remote", returns: [0, 1]).stdout.strip
       end
 
       def have_remote?
-        !remote_name.empty? && remote_name != '.'
+        !remote_name.empty? && remote_name != "."
       end
 
       def current_branch
@@ -103,19 +103,19 @@ module ChefDK
 
       private
 
-      def git!(subcommand, options={})
+      def git!(subcommand, options = {})
         cmd = git(subcommand, options)
         cmd.error!
         cmd
       end
 
-      def git(subcommand, options={})
+      def git(subcommand, options = {})
         options = { cwd: cookbook_path }.merge(options)
         system_command("git #{subcommand}", options)
       end
 
       def detect_current_branch
-        branch = git!('rev-parse --abbrev-ref HEAD').stdout.strip
+        branch = git!("rev-parse --abbrev-ref HEAD").stdout.strip
         @unborn_branch = false
         branch
       rescue Mixlib::ShellOut::ShellCommandFailed => e

data/lib/chef-dk/cookbook_profiler/identifiers.rb

@@ -16,13 +16,13 @@
 #
 
 # TODO: Chef should require its dependency correctly.
-require 'singleton'
-require 'chef/cookbook/cookbook_version_loader'
-require 'digest/sha1'
+require "singleton"
+require "chef/cookbook/cookbook_version_loader"
+require "digest/sha1"
 
-require 'chef/digester'
+require "chef/digester"
 
-require 'chef-dk/exceptions'
+require "chef-dk/exceptions"
 
 module ChefDK
   module CookbookProfiler
@@ -47,12 +47,12 @@ module ChefDK
         major = hex_id[0...14]
         minor = hex_id[14...28]
         patch = hex_id[28..40]
-        decimal_integers =[major, minor, patch].map {|hex| hex.to_i(16) }
+        decimal_integers = [major, minor, patch].map { |hex| hex.to_i(16) }
         decimal_integers.join(".")
       end
 
       def fingerprint_text
-        files_with_checksums.sort {|a,b| a[0] <=> b[0]}.inject("") do |fingerprint, file_spec|
+        files_with_checksums.sort { |a, b| a[0] <=> b[0] }.inject("") do |fingerprint, file_spec|
           fingerprint << "#{file_spec[0]}:#{file_spec[1]}\n"
         end
       end

data/lib/chef-dk/cookbook_profiler/null_scm.rb

@@ -29,4 +29,3 @@ module ChefDK
     end
   end
 end
-

data/lib/chef-dk/exceptions.rb

@@ -116,7 +116,7 @@ module ChefDK
           source_a.universe_graph.key?(cookbook_name) && source_b.universe_graph.key?(cookbook_name)
         end
         "Source #{source_a.desc} and #{source_b.desc} contain conflicting cookbooks:\n" +
-          overlapping_cookbooks.sort.map {|c| "- #{c}"}.join("\n") + "\n\n" +
+          overlapping_cookbooks.sort.map { |c| "- #{c}" }.join("\n") + "\n\n" +
           resolution_message(overlapping_cookbooks)
       end
       conflicting_cookbook_sets.join("\n")

data/lib/chef-dk/generator.rb

@@ -49,7 +49,7 @@ module ChefDK
       @context ||= Context.new
     end
 
-    def self.add_attr_to_context(name, value=nil)
+    def self.add_attr_to_context(name, value = nil)
       sym_name = name.to_sym
       ChefDK::Generator::Context.add_attr(sym_name)
       ChefDK::Generator::TemplateHelper.delegate_to_app_context(sym_name)
@@ -70,11 +70,11 @@ module ChefDK
 
       # Prints the short description of the license, suitable for use in a
       # preamble to a file. Optionally specify a comment to prepend to each line.
-      def license_description(comment=nil)
+      def license_description(comment = nil)
         case license
-        when 'all_rights'
+        when "all_rights", "none"
           result = "Copyright:: #{year}, #{copyright_holder}, All Rights Reserved."
-        when 'apachev2'
+        when "apachev2"
           result = <<-EOH
 Copyright:: #{year}, #{copyright_holder}
 
@@ -90,7 +90,7 @@ 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.
 EOH
-        when 'mit'
+        when "mit"
           result = <<-EOH
 The MIT License (MIT)
 
@@ -114,7 +114,7 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 EOH
-        when 'gplv2'
+        when "gplv2"
           result = <<-EOH
 Copyright:: #{year},  #{copyright_holder}
 
@@ -132,7 +132,7 @@ You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 EOH
-        when 'gplv3'
+        when "gplv3"
           result = <<-EOH
 Copyright:: #{year},  #{copyright_holder}
 
@@ -149,6 +149,8 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 EOH
+        else
+          raise ArgumentError, "Invalid generator.license setting: #{license}.  See available licenses at https://docs.chef.io/ctl_chef.html#chef-generate-cookbook"
         end
         if comment
           # Ensure there's no trailing whitespace

data/lib/chef-dk/helpers.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require 'mixlib/shellout'
-require 'chef-dk/exceptions'
+require "mixlib/shellout"
+require "chef-dk/exceptions"
 
 module ChefDK
   module Helpers
@@ -72,14 +72,14 @@ module ChefDK
     end
 
     def omnibus_chefdk_location
-      @omnibus_chefdk_location ||= File.expand_path('embedded/apps/chef-dk', expected_omnibus_root)
+      @omnibus_chefdk_location ||= File.expand_path("embedded/apps/chef-dk", expected_omnibus_root)
     end
 
     def chefdk_home
       @chefdk_home ||= begin
-                         chefdk_home_set = !([nil, ''].include? ENV['CHEFDK_HOME'])
+                         chefdk_home_set = !([nil, ""].include? ENV["CHEFDK_HOME"])
                          if chefdk_home_set
-                           ENV['CHEFDK_HOME']
+                           ENV["CHEFDK_HOME"]
                          else
                            default_chefdk_home
                          end
@@ -119,15 +119,15 @@ module ChefDK
     def omnibus_env
       @omnibus_env ||=
         begin
-          user_bin_dir = File.expand_path(File.join(Gem.user_dir, 'bin'))
-          path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH'] ]
+          user_bin_dir = File.expand_path(File.join(Gem.user_dir, "bin"))
+          path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"] ]
           path << git_bin_dir if Dir.exists?(git_bin_dir)
           path << git_windows_bin_dir if Dir.exists?(git_windows_bin_dir)
           {
-            'PATH' => path.join(File::PATH_SEPARATOR),
-            'GEM_ROOT' => Gem.default_dir,
-            'GEM_HOME' => Gem.user_dir,
-            'GEM_PATH' => Gem.path.join(File::PATH_SEPARATOR),
+            "PATH" => path.join(File::PATH_SEPARATOR),
+            "GEM_ROOT" => Gem.default_dir,
+            "GEM_HOME" => Gem.user_dir,
+            "GEM_PATH" => Gem.path.join(File::PATH_SEPARATOR),
           }
         end
     end
@@ -136,7 +136,7 @@ module ChefDK
 
     def omnibus_expand_path(*paths)
       dir = File.expand_path(File.join(paths))
-      raise OmnibusInstallNotFound.new() unless ( dir and File.directory?(dir) )
+      raise OmnibusInstallNotFound.new() unless dir && File.directory?(dir)
       dir
     end
 
@@ -146,16 +146,16 @@ module ChefDK
 
     def default_chefdk_home
       if Chef::Platform.windows?
-        File.join(ENV['LOCALAPPDATA'], 'chefdk')
+        File.join(ENV["LOCALAPPDATA"], "chefdk")
       else
-        File.expand_path('~/.chefdk')
+        File.expand_path("~/.chefdk")
       end
     end
 
     # Open a file. By default, the mode is for read+write,
     # and binary so that windows writes out what we tell it,
     # as this is the most common case we have.
-    def with_file(path, mode='wb+', &block)
+    def with_file(path, mode = "wb+", &block)
       File.open(path, mode, &block)
     end
 

data/lib/chef-dk/pager.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require 'chef-dk/ui'
+require "chef-dk/ui"
 
 module ChefDK
   class Pager
@@ -98,9 +98,8 @@ module ChefDK
     end
 
     def pager_env
-      {"LESS" => "-FRX", "LV" => "-c"}
+      { "LESS" => "-FRX", "LV" => "-c" }
     end
 
   end
 end
-

data/lib/chef-dk/policyfile/chef_repo_cookbook_source.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require 'chef-dk/exceptions'
-require 'chef/cookbook_loader'
-require 'chef/cookbook/file_system_file_vendor'
-require 'chef-dk/ui'
+require "chef-dk/exceptions"
+require "chef/cookbook_loader"
+require "chef/cookbook/file_system_file_vendor"
+require "chef-dk/ui"
 
 module ChefDK
   module Policyfile

data/lib/chef-dk/policyfile/chef_server_cookbook_source.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require 'ffi_yajl'
-require 'chef-dk/exceptions'
-require 'chef-dk/policyfile/source_uri'
-require 'chef-dk/authenticated_http'
+require "ffi_yajl"
+require "chef-dk/exceptions"
+require "chef-dk/policyfile/source_uri"
+require "chef-dk/authenticated_http"
 
 module ChefDK
   module Policyfile
@@ -67,7 +67,7 @@ module ChefDK
         {
           chef_server: uri.to_s,
           version: cookbook_version,
-          http_client: http_connection_for(uri.to_s)
+          http_client: http_connection_for(uri.to_s),
         }
       end
 
@@ -90,7 +90,7 @@ module ChefDK
       def full_chef_server_graph
         @full_chef_server_graph ||=
           begin
-            http_connection_for(uri.to_s).get('/universe')
+            http_connection_for(uri.to_s).get("/universe")
           end
       end
     end

data/lib/chef-dk/policyfile/community_cookbook_source.rb

@@ -15,10 +15,10 @@
 # limitations under the License.
 #
 
-require 'json'
-require 'chef-dk/cookbook_omnifetch'
-require 'chef-dk/exceptions'
-require 'chef/http/simple'
+require "json"
+require "chef-dk/cookbook_omnifetch"
+require "chef-dk/exceptions"
+require "chef/http/simple"
 
 module ChefDK
   module Policyfile
@@ -82,7 +82,6 @@ module ChefDK
         @http_connections[base_url] ||= Chef::HTTP::Simple.new(base_url)
       end
 
-
       def full_community_graph
         @full_community_graph ||=
           begin

data/lib/chef-dk/policyfile/comparison_base.rb

@@ -15,9 +15,9 @@
 # limitations under the License.
 #
 
-require 'ffi_yajl'
-require 'mixlib/shellout'
-require 'chef-dk/service_exceptions'
+require "ffi_yajl"
+require "mixlib/shellout"
+require "chef-dk/service_exceptions"
 
 module ChefDK
   module Policyfile
@@ -121,4 +121,3 @@ module ChefDK
     end
   end
 end
-

data/lib/chef-dk/policyfile/cookbook_location_specification.rb

@@ -15,9 +15,9 @@
 # limitations under the License.
 #
 
-require 'semverse'
-require 'chef-dk/cookbook_omnifetch'
-require 'chef-dk/policyfile/storage_config'
+require "semverse"
+require "chef-dk/cookbook_omnifetch"
+require "chef-dk/policyfile/storage_config"
 
 module ChefDK
   module Policyfile
@@ -54,9 +54,9 @@ module ChefDK
       end
 
       def ==(other)
-        other.kind_of?(self.class) and
-          other.name == name and
-          other.version_constraint == version_constraint and
+        other.kind_of?(self.class) &&
+          other.name == name &&
+          other.version_constraint == version_constraint &&
           other.source_options == source_options
       end
 

data/lib/chef-dk/policyfile/cookbook_locks.rb

@@ -15,17 +15,17 @@
 # limitations under the License.
 #
 
-require 'forwardable'
+require "forwardable"
 
-require 'chef-dk/exceptions'
+require "chef-dk/exceptions"
 
-require 'chef-dk/cookbook_profiler/null_scm'
-require 'chef-dk/cookbook_profiler/git'
+require "chef-dk/cookbook_profiler/null_scm"
+require "chef-dk/cookbook_profiler/git"
 
-require 'chef-dk/cookbook_profiler/identifiers'
-require 'chef-dk/policyfile/storage_config'
+require "chef-dk/cookbook_profiler/identifiers"
+require "chef-dk/policyfile/storage_config"
 
-require 'chef-dk/policyfile/cookbook_location_specification'
+require "chef-dk/policyfile/cookbook_location_specification"
 
 module ChefDK
 
@@ -164,7 +164,7 @@ module ChefDK
       private
 
       def assert_required_keys_valid!(lock_data)
-        missing_keys = REQUIRED_LOCK_DATA_KEYS.reject {|key| lock_data.key?(key) }
+        missing_keys = REQUIRED_LOCK_DATA_KEYS.reject { |key| lock_data.key?(key) }
         unless missing_keys.empty?
           raise InvalidLockfile, "Lockfile cookbook_lock for #{name} missing required attributes `#{missing_keys.join("', `")}'"
         end
@@ -241,7 +241,7 @@ module ChefDK
           "dotted_decimal_identifier" => dotted_decimal_identifier,
           "cache_key" => cache_key,
           "origin" => origin,
-          "source_options" => source_options
+          "source_options" => source_options,
         }
       end
 
@@ -261,7 +261,7 @@ module ChefDK
         # This behavior fits better with the intent of the #validate! method,
         # but we cannot check for modifications there because the user may be
         # setting custom identifiers.
-        if @identifier and identifiers.content_identifier != @identifier
+        if @identifier && identifiers.content_identifier != @identifier
           message = "Cached cookbook `#{name}' (#{version}) has been modified since the lockfile was generated. " +
             "Cached cookbooks cannot be modified. (full path: `#{cookbook_path}')"
           raise CachedCookbookModified, message
@@ -318,7 +318,7 @@ module ChefDK
           "source" => source,
           "cache_key" => nil,
           "scm_info" => scm_info,
-          "source_options" => source_options
+          "source_options" => source_options,
         }
       end