chef-dk 3.9.0 → 3.10.1

data/lib/chef-dk/command/gem.rb

@@ -1,47 +1,47 @@
-#
-# Copyright:: Copyright (c) 2014-2018 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 "chef-dk/command/base"
-require "rubygems"
-require "rubygems/gem_runner"
-require "rubygems/exceptions"
-require "pp"
-
-module ChefDK
-  module Command
-
-    # Forwards all commands to rubygems.
-    class GemForwarder < ChefDK::Command::Base
-      banner "Usage: chef gem GEM_COMMANDS_AND_OPTIONS"
-
-      def run(params)
-        retval = Gem::GemRunner.new.run( params.clone )
-        retval.nil? ? true : retval
-      rescue Gem::SystemExitException => e
-        exit( e.exit_code )
-      end
-
-      # Lazy solution: By automatically returning false, we force ChefDK::Base to
-      # call this class' run method, so that Gem::GemRunner can handle the -v flag
-      # appropriately (showing the gem version, or installing a specific version
-      # of a gem).
-      def needs_version?(params)
-        false
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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 "chef-dk/command/base"
+require "rubygems"
+require "rubygems/gem_runner"
+require "rubygems/exceptions"
+require "pp"
+
+module ChefDK
+  module Command
+
+    # Forwards all commands to rubygems.
+    class GemForwarder < ChefDK::Command::Base
+      banner "Usage: chef gem GEM_COMMANDS_AND_OPTIONS"
+
+      def run(params)
+        retval = Gem::GemRunner.new.run( params.clone )
+        retval.nil? ? true : retval
+      rescue Gem::SystemExitException => e
+        exit( e.exit_code )
+      end
+
+      # Lazy solution: By automatically returning false, we force ChefDK::Base to
+      # call this class' run method, so that Gem::GemRunner can handle the -v flag
+      # appropriately (showing the gem version, or installing a specific version
+      # of a gem).
+      def needs_version?(params)
+        false
+      end
+    end
+  end
+end

data/lib/chef-dk/command/generate.rb

@@ -1,126 +1,126 @@
-#
-# Copyright:: Copyright (c) 2014-2018, 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 "chef-dk/command/base"
-require "chef-dk/command/generator_commands"
-require "chef-dk/command/generator_commands/base"
-require "chef-dk/command/generator_commands/cookbook_code_file"
-require "chef-dk/command/generator_commands/cookbook"
-require "chef-dk/command/generator_commands/app"
-require "chef-dk/command/generator_commands/attribute"
-require "chef-dk/command/generator_commands/cookbook_file"
-require "chef-dk/command/generator_commands/helpers"
-require "chef-dk/command/generator_commands/resource"
-require "chef-dk/command/generator_commands/recipe"
-require "chef-dk/command/generator_commands/template"
-require "chef-dk/command/generator_commands/repo"
-require "chef-dk/command/generator_commands/policyfile"
-require "chef-dk/command/generator_commands/generator_generator"
-require "chef-dk/command/generator_commands/build_cookbook"
-
-module ChefDK
-  module Command
-    class Generate < Base
-
-      GeneratorCommand = Struct.new(:name, :class_name, :description)
-
-      def self.generators
-        @generators ||= []
-      end
-
-      def self.generator(name, class_name, description)
-        generators << GeneratorCommand.new(name, class_name, description)
-      end
-
-      generator(:app, :App, "Generate an application repo - DEPRECATED")
-      generator(:cookbook, :Cookbook, "Generate a single cookbook")
-      generator(:recipe, :Recipe, "Generate a new recipe")
-      generator(:attribute, :Attribute, "Generate an attributes file")
-      generator(:template, :Template, "Generate a file template")
-      generator(:file, :CookbookFile, "Generate a cookbook file")
-      generator(:helpers, :Helpers, "Generate a cookbook helper file in libraries")
-      generator(:lwrp, :Resource, "Generate a lightweight resource provider (LWRP) - DEPRECATED")
-      generator(:resource, :Resource, "Generate a custom resource")
-      generator(:repo, :Repo, "Generate a Chef code repository")
-      generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands")
-      generator(:generator, :GeneratorGenerator, "Copy ChefDK's generator cookbook so you can customize it")
-      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with Delivery")
-
-      def self.banner_headline
-        <<~E
-          Usage: chef generate GENERATOR [options]
-
-          Available generators:
-        E
-      end
-
-      def self.generator_list
-        justify_size = generators.map { |g| g.name.size }.max + 2
-        generators.map { |g| "  #{g.name.to_s.ljust(justify_size)}#{g.description}" }.join("\n")
-      end
-
-      def self.banner
-        banner_headline + generator_list + "\n"
-      end
-
-      # chef generate app path/to/basename --skel=path/to/skeleton --example
-      # chef generate file name [path/to/cookbook_root] (inferred from cwd) --from=source_file
-
-      def initialize(*args)
-        super
-      end
-
-      def run(params)
-        if ( generator_spec = generator_for(params[0]) )
-          puts "WARNING: The command 'chef generator #{params[0]}' is deprecated and will be removed from the next major release of Chef DK / Workstation (April 2019)\n\n" if %w{lwrp app}.include?(params[0])
-          params.shift
-          generator = GeneratorCommands.build(generator_spec.class_name, params)
-          generator.run
-        else
-          msg(banner)
-          1
-        end
-      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
-        # ChefDK::Command::Base also handles this error in the same way, but it
-        # does not have access to the correct option parser, so it cannot print
-        # the usage correctly. Therefore, invalid CLI usage needs to be handled
-        # here.
-        err("ERROR: #{e.message}\n")
-        msg(generator.opt_parser)
-        1
-      end
-
-      def generator_for(arg)
-        self.class.generators.find { |g| g.name.to_s == arg }
-      end
-
-      # In the Base class, this is defined to be true if any args match "-h" or
-      # "--help". Here we override that behavior such that if the first
-      # argument is a valid generator name, like `chef generate cookbook -h`,
-      # we delegate the request to the specified generator.
-      def needs_help?(params)
-        return false if have_generator?(params[0])
-        super
-      end
-
-      def have_generator?(name)
-        self.class.generators.map { |g| g.name.to_s }.include?(name)
-      end
-
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018, 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 "chef-dk/command/base"
+require "chef-dk/command/generator_commands"
+require "chef-dk/command/generator_commands/base"
+require "chef-dk/command/generator_commands/cookbook_code_file"
+require "chef-dk/command/generator_commands/cookbook"
+require "chef-dk/command/generator_commands/app"
+require "chef-dk/command/generator_commands/attribute"
+require "chef-dk/command/generator_commands/cookbook_file"
+require "chef-dk/command/generator_commands/helpers"
+require "chef-dk/command/generator_commands/resource"
+require "chef-dk/command/generator_commands/recipe"
+require "chef-dk/command/generator_commands/template"
+require "chef-dk/command/generator_commands/repo"
+require "chef-dk/command/generator_commands/policyfile"
+require "chef-dk/command/generator_commands/generator_generator"
+require "chef-dk/command/generator_commands/build_cookbook"
+
+module ChefDK
+  module Command
+    class Generate < Base
+
+      GeneratorCommand = Struct.new(:name, :class_name, :description)
+
+      def self.generators
+        @generators ||= []
+      end
+
+      def self.generator(name, class_name, description)
+        generators << GeneratorCommand.new(name, class_name, description)
+      end
+
+      generator(:app, :App, "Generate an application repo - DEPRECATED")
+      generator(:cookbook, :Cookbook, "Generate a single cookbook")
+      generator(:recipe, :Recipe, "Generate a new recipe")
+      generator(:attribute, :Attribute, "Generate an attributes file")
+      generator(:template, :Template, "Generate a file template")
+      generator(:file, :CookbookFile, "Generate a cookbook file")
+      generator(:helpers, :Helpers, "Generate a cookbook helper file in libraries")
+      generator(:lwrp, :Resource, "Generate a lightweight resource provider (LWRP) - DEPRECATED")
+      generator(:resource, :Resource, "Generate a custom resource")
+      generator(:repo, :Repo, "Generate a Chef code repository")
+      generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands")
+      generator(:generator, :GeneratorGenerator, "Copy ChefDK's generator cookbook so you can customize it")
+      generator(:'build-cookbook', :BuildCookbook, "Generate a build cookbook for use with Delivery")
+
+      def self.banner_headline
+        <<~E
+          Usage: chef generate GENERATOR [options]
+
+          Available generators:
+        E
+      end
+
+      def self.generator_list
+        justify_size = generators.map { |g| g.name.size }.max + 2
+        generators.map { |g| "  #{g.name.to_s.ljust(justify_size)}#{g.description}" }.join("\n")
+      end
+
+      def self.banner
+        banner_headline + generator_list + "\n"
+      end
+
+      # chef generate app path/to/basename --skel=path/to/skeleton --example
+      # chef generate file name [path/to/cookbook_root] (inferred from cwd) --from=source_file
+
+      def initialize(*args)
+        super
+      end
+
+      def run(params)
+        if ( generator_spec = generator_for(params[0]) )
+          puts "WARNING: The command 'chef generator #{params[0]}' is deprecated and will be removed from the next major release of Chef DK / Workstation (April 2019)\n\n" if %w{lwrp app}.include?(params[0])
+          params.shift
+          generator = GeneratorCommands.build(generator_spec.class_name, params)
+          generator.run
+        else
+          msg(banner)
+          1
+        end
+      rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        # ChefDK::Command::Base also handles this error in the same way, but it
+        # does not have access to the correct option parser, so it cannot print
+        # the usage correctly. Therefore, invalid CLI usage needs to be handled
+        # here.
+        err("ERROR: #{e.message}\n")
+        msg(generator.opt_parser)
+        1
+      end
+
+      def generator_for(arg)
+        self.class.generators.find { |g| g.name.to_s == arg }
+      end
+
+      # In the Base class, this is defined to be true if any args match "-h" or
+      # "--help". Here we override that behavior such that if the first
+      # argument is a valid generator name, like `chef generate cookbook -h`,
+      # we delegate the request to the specified generator.
+      def needs_help?(params)
+        return false if have_generator?(params[0])
+        super
+      end
+
+      def have_generator?(name)
+        self.class.generators.map { |g| g.name.to_s }.include?(name)
+      end
+
+    end
+  end
+end

data/lib/chef-dk/command/generator_commands.rb

@@ -1,83 +1,83 @@
-#
-# Copyright:: Copyright (c) 2014-2018 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 "mixlib/cli"
-require "rbconfig"
-require "pathname"
-require "chef-dk/command/base"
-require "chef-dk/chef_runner"
-require "chef-dk/generator"
-
-module ChefDK
-  module Command
-
-    # ## SharedGeneratorOptions
-    #
-    # These CLI options are shared amongst the generator commands
-    module SharedGeneratorOptions
-      include Mixlib::CLI
-
-      # You really want these to have default values, as
-      # they will likely be used all over the place.
-      option :license,
-        short: "-I LICENSE",
-        long: "--license LICENSE",
-        description: "all_rights, apachev2, mit, gplv2, gplv3 - defaults to all_rights",
-        proc: Proc.new { |l|
-          l =~ /apache2/ ? "apachev2" : l
-        },
-        default: nil
-
-      option :copyright_holder,
-        short: "-C COPYRIGHT",
-        long: "--copyright COPYRIGHT",
-        description: "Name of the copyright holder - defaults to 'The Authors'",
-        default: nil
-
-      option :email,
-        short: "-m EMAIL",
-        long: "--email EMAIL",
-        description: "Email address of the author - defaults to 'you@example.com'",
-        default: nil
-
-      option :generator_cookbook,
-        short: "-g GENERATOR_COOKBOOK_PATH",
-        long: "--generator-cookbook GENERATOR_COOKBOOK_PATH",
-        description: "Use GENERATOR_COOKBOOK_PATH for the code_generator cookbook",
-        default: nil,
-        proc: Proc.new { |s| File.expand_path(s) },
-        on: :tail
-
-      generator_args = [] # accumulator variable
-      option :generator_arg,
-        short: "-a KEY=VALUE",
-        long: "--generator-arg KEY=VALUE",
-        description: "Use to set arbitrary attribute KEY to VALUE in the code_generator cookbook",
-        default: [],
-        proc: Proc.new { |s| generator_args << s.split("=").map(&:strip) }
-    end
-
-    # ## GeneratorCommands
-    #
-    # This module is the namespace for all subcommands of `chef generate`
-    module GeneratorCommands
-      def self.build(class_name, params)
-        const_get(class_name).new(params)
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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 "mixlib/cli"
+require "rbconfig"
+require "pathname"
+require "chef-dk/command/base"
+require "chef-dk/chef_runner"
+require "chef-dk/generator"
+
+module ChefDK
+  module Command
+
+    # ## SharedGeneratorOptions
+    #
+    # These CLI options are shared amongst the generator commands
+    module SharedGeneratorOptions
+      include Mixlib::CLI
+
+      # You really want these to have default values, as
+      # they will likely be used all over the place.
+      option :license,
+        short: "-I LICENSE",
+        long: "--license LICENSE",
+        description: "all_rights, apachev2, mit, gplv2, gplv3 - defaults to all_rights",
+        proc: Proc.new { |l|
+          l =~ /apache2/ ? "apachev2" : l
+        },
+        default: nil
+
+      option :copyright_holder,
+        short: "-C COPYRIGHT",
+        long: "--copyright COPYRIGHT",
+        description: "Name of the copyright holder - defaults to 'The Authors'",
+        default: nil
+
+      option :email,
+        short: "-m EMAIL",
+        long: "--email EMAIL",
+        description: "Email address of the author - defaults to 'you@example.com'",
+        default: nil
+
+      option :generator_cookbook,
+        short: "-g GENERATOR_COOKBOOK_PATH",
+        long: "--generator-cookbook GENERATOR_COOKBOOK_PATH",
+        description: "Use GENERATOR_COOKBOOK_PATH for the code_generator cookbook",
+        default: nil,
+        proc: Proc.new { |s| File.expand_path(s) },
+        on: :tail
+
+      generator_args = [] # accumulator variable
+      option :generator_arg,
+        short: "-a KEY=VALUE",
+        long: "--generator-arg KEY=VALUE",
+        description: "Use to set arbitrary attribute KEY to VALUE in the code_generator cookbook",
+        default: [],
+        proc: Proc.new { |s| generator_args << s.split("=").map(&:strip) }
+    end
+
+    # ## GeneratorCommands
+    #
+    # This module is the namespace for all subcommands of `chef generate`
+    module GeneratorCommands
+      def self.build(class_name, params)
+        const_get(class_name).new(params)
+      end
+    end
+  end
+end