chef-gen-flavors 0.8.6 → 0.9.0

data/chef-gen-flavors.gemspec

@@ -1,19 +1,19 @@
 # -*- encoding: utf-8 -*-
-# stub: chef-gen-flavors 0.8.6.20150806075045 ruby lib
+# stub: chef-gen-flavors 0.9.0.20150904171033 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "chef-gen-flavors"
-  s.version = "0.8.6.20150806075045"
+  s.version = "0.9.0.20150904171033"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["James FitzGibbon"]
-  s.date = "2015-08-06"
+  s.date = "2015-09-05"
   s.description = "chef-gen-flavors is a framework for creating custom templates for the\n'chef generate' command provided by ChefDK.\n\nThis gem simply provides a framework; templates are provided by separate\ngems, which you can host privately for use within your organization or\npublicly for the Chef community to use.\n\nAt present this is focused primarily on providing templates for generation of\ncookbooks, as this is where most organization-specific customization takes place.\nSupport for the other artifacts that ChefDK can generate may work, but is not\nthe focus of early releases."
-  s.email = ["james.i.fitzgibbon@nordstrom.com"]
+  s.email = ["james@nadt.net"]
   s.extra_rdoc_files = ["ARUBA_STEPS.md", "History.md", "Manifest.txt", "README.md"]
-  s.files = ["ARUBA_STEPS.md", "History.md", "LICENSE", "Manifest.txt", "README.md", "chef-gen-flavors.gemspec", "lib/chef_gen/flavor.rb", "lib/chef_gen/flavor_base.rb", "lib/chef_gen/flavors.rb", "lib/chef_gen/flavors/cucumber.rb", "lib/chef_gen/flavors/cucumber/bundle.rb", "lib/chef_gen/flavors/cucumber/chefdk.rb", "lib/chef_gen/flavors/cucumber/kitchen.rb", "lib/chef_gen/flavors/cucumber/knife.rb", "lib/chef_gen/flavors/cucumber/rake.rb", "lib/chef_gen/flavors/cucumber/regex.rb", "lib/chef_gen/snippet/attributes.rb", "lib/chef_gen/snippet/chef_spec.rb", "lib/chef_gen/snippet/cookbook_base.rb", "lib/chef_gen/snippet/example_file.rb", "lib/chef_gen/snippet/example_template.rb", "lib/chef_gen/snippet/git_init.rb", "lib/chef_gen/snippet/recipes.rb", "lib/chef_gen/snippet/resource_provider.rb", "lib/chef_gen/snippet/standard_ignore.rb", "lib/chef_gen/snippet/style_foodcritic.rb", "lib/chef_gen/snippet/style_rubocop.rb", "lib/chef_gen/snippet/style_tailor.rb", "lib/chef_gen/snippet/test_kitchen.rb", "lib/chef_gen/snippets.rb", "shared/snippet/attributes/attributes_default_rb.erb", "shared/snippet/chef_spec/_rspec.erb", "shared/snippet/chef_spec/spec_chef_runner_context_rb.erb", "shared/snippet/chef_spec/spec_recipes_default_spec_rb.erb", "shared/snippet/chef_spec/spec_spec_helper_rb.erb", "shared/snippet/cookbookbase/Berksfile.erb", "shared/snippet/cookbookbase/CHANGELOG_md.erb", "shared/snippet/cookbookbase/Gemfile.erb", "shared/snippet/cookbookbase/Guardfile.erb", "shared/snippet/cookbookbase/README_md.erb", "shared/snippet/cookbookbase/Rakefile.erb", "shared/snippet/cookbookbase/metadata_rb.erb", "shared/snippet/examplefile/files_default_example_conf", "shared/snippet/exampletemplate/templates_default_example_conf_erb", "shared/snippet/recipes/recipes_default_rb.erb", "shared/snippet/resourceprovider/providers_default_rb.erb", "shared/snippet/resourceprovider/resources_default_rb.erb", "shared/snippet/stylerubocop/_rubocop_yml.erb", "shared/snippet/testkitchen/_kitchen_yml.erb", "shared/snippet/testkitchen/libraries_kitchen_helper_rb", "shared/snippet/testkitchen/test_integration_default_serverspec_recipes_default_spec_rb.erb", "shared/snippet/testkitchen/test_integration_default_serverspec_spec_helper_rb.erb"]
-  s.homepage = "https://github.com/Nordstrom/chef-gen-flavors"
+  s.files = ["ARUBA_STEPS.md", "History.md", "LICENSE", "Manifest.txt", "README.md", "chef-gen-flavors.gemspec", "lib/chef_gen/flavor.rb", "lib/chef_gen/flavors.rb", "lib/chef_gen/flavors/cucumber.rb", "lib/chef_gen/flavors/cucumber/bundle.rb", "lib/chef_gen/flavors/cucumber/chefdk.rb", "lib/chef_gen/flavors/cucumber/kitchen.rb", "lib/chef_gen/flavors/cucumber/knife.rb", "lib/chef_gen/flavors/cucumber/rake.rb", "lib/chef_gen/flavors/cucumber/regex.rb"]
+  s.homepage = "https://github.com/jf647/chef-gen-flavors"
   s.licenses = ["apache2"]
   s.rdoc_options = ["--main", "README.md"]
   s.rubygems_version = "2.4.4"
@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<little-plugger>, ["~> 1.1"])
       s.add_runtime_dependency(%q<bogo-ui>, ["~> 0.1"])
       s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_development_dependency(%q<chef-dk>, ["~> 0.5"])
+      s.add_development_dependency(%q<chef-dk>, ["~> 0.7"])
       s.add_development_dependency(%q<hoe>, ["~> 3.13"])
       s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0"])
       s.add_development_dependency(%q<rake>, ["~> 10.3"])
@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<little-plugger>, ["~> 1.1"])
       s.add_dependency(%q<bogo-ui>, ["~> 0.1"])
       s.add_dependency(%q<rdoc>, ["~> 4.0"])
-      s.add_dependency(%q<chef-dk>, ["~> 0.5"])
+      s.add_dependency(%q<chef-dk>, ["~> 0.7"])
       s.add_dependency(%q<hoe>, ["~> 3.13"])
       s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
       s.add_dependency(%q<rake>, ["~> 10.3"])
@@ -65,7 +65,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<little-plugger>, ["~> 1.1"])
     s.add_dependency(%q<bogo-ui>, ["~> 0.1"])
     s.add_dependency(%q<rdoc>, ["~> 4.0"])
-    s.add_dependency(%q<chef-dk>, ["~> 0.5"])
+    s.add_dependency(%q<chef-dk>, ["~> 0.7"])
     s.add_dependency(%q<hoe>, ["~> 3.13"])
     s.add_dependency(%q<hoe-gemspec>, ["~> 1.0"])
     s.add_dependency(%q<rake>, ["~> 10.3"])

data/lib/chef_gen/flavors.rb

@@ -8,7 +8,7 @@ module ChefGen
   # a plugin framework for creating ChefDK generator flavors
   class Flavors
     # the version of the gem
-    VERSION = '0.8.6'
+    VERSION = '0.9.0'
 
     extend LittlePlugger path: 'chef_gen/flavor',
                          module: ChefGen::Flavor
@@ -25,27 +25,33 @@ module ChefGen
                    only_plugin ||
                    prompt_for_plugin ||
                    fail('no ChefGen flavors found!')
-        path = generator_path(selected)
-        $stdout.puts "using ChefGen flavor '#{selected}' in #{path}"
-        # take a copy so we can augment it
-        copy = copy_generator_dir(path)
-        # augment the copy if the plugin has hooks
-        run_content_hooks(selected, copy)
-        # return the path to the copy
-        copy
+        $stdout.puts "using ChefGen flavor '#{selected}'"
+
+        # return early if we're using the builtin flavor
+        return nil if :builtin == selected
+
+        # get a temp dir
+        tmpdir = create_tmpdir(selected)
+
+        # call the content hooks in the flavor
+        @plugins[selected].new(temp_path: tmpdir).add_content
+
+        # return the temporary directory
+        tmpdir
       end
 
       private
 
-      # call content hooks in the flavor if it has any
-      # @param selected [Symbol] the selected flavor
-      # @param path [String] the temporary generator cookbook path
-      # @return [void]
-      def run_content_hooks(selected, path)
-        flavor_klass = @plugins[selected]
-        return unless flavor_klass.is_a?(Class)
-        return unless flavor_klass.instance_methods.include?(:add_content)
-        @plugins[selected].new(nil).add_content(path)
+      # creates a temporary directory for the flavor to populate
+      # @param [Symbol] flavor the selected flavor
+      # @return [String] the temporary path
+      # @api private
+      def create_tmpdir(flavor)
+        tmpdir = File.join(Dir.mktmpdir('chefgen_flavor.'), flavor.to_s)
+        at_exit do
+          FileUtils.rm_rf(tmpdir)
+        end unless ENV.key?('CHEFGEN_NOCLEANTMP')
+        tmpdir
       end
 
       # checks if the plugin to use has been specified in the environment
@@ -77,12 +83,11 @@ module ChefGen
         @plugins.keys.size == 1 ? @plugins.keys.first : nil
       end
 
-      # :nocov:
-
       # prompts the user for a plugin to use if more than one is available
       # @return [Symbol] the selected plugin
       # @raise RuntimeError if an invalid plugin is chosen
       # @api private
+      # :nocov:
       def prompt_for_plugin
         return nil unless @plugins.keys.size >= 1
         require 'bogo-ui'
@@ -93,12 +98,14 @@ module ChefGen
         ui.fatal 'Invalid flavor chosen'
         fail 'Invalid ChefGen Flavor'
       end
+      # :nocov:
 
       # builds a list of plugins and displays them with as
       # a number selection list
-      # @param ui [Bogo::Ui] the ui object to use for display
+      # @param [Bogo::Ui] ui the ui object to use for display
       # @return [Hash] a hash of valid options
       # @api private
+      # :nocov:
       def plugin_selection(ui)
         output = [ui.color('Flavors on the menu', :bold)]
         idx = 1
@@ -115,92 +122,19 @@ module ChefGen
         ui.info "#{output.join("\n")}\n"
         valid
       end
+      # :nocov:
 
       # builds the description of a flavor for the menu
-      # @param klass [Class] the class of the flavor
+      # @param [Class] klass the class of the flavor
       # @return [String] the flavor description with version if available
+      # @api private
+      # :nocov:
       def plugin_descr(klass)
-        descr = klass.respond_to?(:description) ? klass.description : ''
-        if klass.const_defined?(:VERSION)
-          descr += " v#{klass.const_get(:VERSION, false)}"
-        end
+        descr = klass.const_defined?(:DESC) ? klass.const_get(:DESC) : ''
+        descr += " v#{klass.const_get(:VERSION, false)}" if klass.const_defined?(:VERSION)
         descr
       end
-
       # :nocov:
-
-      # returns the path to the code_generator cookbook for the
-      # selected plugin.  Handles the built-in template path,
-      # a plugin that overrides the path and a plugin that uses
-      # the default path
-      # @param plugin [Symbol] the selected plugin
-      # @return [String] the path to the code_generator cookbook
-      # @api private
-      def generator_path(plugin)
-        return builtin_code_generator_path if :builtin == plugin
-        klass = @plugins[plugin]
-        classfile = path_to_plugin(klass)
-        if klass.respond_to?(:code_generator_path)
-          klass.code_generator_path(classfile)
-        else
-          default_code_generator_path(classfile)
-        end
-      end
-
-      # returns the path of the file where the description method
-      # is defined for a given class
-      # @param klass [Class] the class to look up the method in
-      # @return [String] the path to the source file for the class
-      # @api private
-      def path_to_plugin(klass)
-        klass.method(:description).source_location[0]
-      end
-
-      # returns the default path to the code generator cookbook for
-      # a plugin, which is a directory named 'code_generator' four
-      # levels above the file which defines the plugin class
-      # @param classfile [String] the path to the class source, as
-      #   returned from ::path_to_plugin
-      # @return [String] the path to the code_generator cookbook
-      # @api private
-      def default_code_generator_path(classfile)
-        File.expand_path(
-          File.join(
-            classfile,
-            '..', '..', '..', '..',
-            'code_generator'
-          )
-        )
-      end
-
-      # return the path to the code_generator cookbook that comes
-      # with ChefDK
-      # @return [String] the path to the code_generator cookbook
-      # @api private
-      def builtin_code_generator_path
-        require 'rubygems'
-        spec = Gem::Specification.find_by_name('chef-dk')
-        File.join(
-          spec.gem_dir, 'lib', 'chef-dk', 'skeletons', 'code_generator'
-        )
-      end
-
-      # recursively copies the generator cookbook to a temporary
-      # directory.  Sets up an at_exit handler to remove the
-      # temporary directory unless CHEFGEN_NOCLEANTMP is set
-      # in the environment.
-      # @param srcdir [String] the path to the generator cookbook
-      # @return [String] the temporary path to generate from
-      def copy_generator_dir(srcdir)
-        dstdir = Dir.mktmpdir('chefgen_flavor.')
-        at_exit do
-          FileUtils.rm_rf(dstdir)
-        end unless ENV.key?('CHEFGEN_NOCLEANTMP')
-        $stdout.puts srcdir
-        $stdout.puts dstdir
-        FileUtils.cp_r(srcdir, dstdir)
-        File.join(dstdir, File.basename(srcdir))
-      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-gen-flavors
 version: !ruby/object:Gem::Version
-  version: 0.8.6
+  version: 0.9.0
 platform: ruby
 authors:
 - James FitzGibbon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: little-plugger
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
@@ -270,12 +270,18 @@ description: |-
   gems, which you can host privately for use within your organization or
   publicly for the Chef community to use.
 
-  At present this is focused primarily on providing templates for generation of
-  cookbooks, as this is where most organization-specific customization takes place.
-  Support for the other artifacts that ChefDK can generate may work, but is not
-  the focus of early releases.
+  [chef-gen-flavor-base](https://github.com/jf647/chef-gen-flavor-base) is
+  a base class that makes it easy to compose a flavor from reusable
+  snippets of functionality, and using it is highly recommended.  Using
+  chef-gen-flavors on its own is only suitable if you already have a
+  template which is a copy of the skeleton provided by ChefDK.
+
+  At present this is focused primarily on providing templates for
+  generation of cookbooks, as this is where most organization-specific
+  customization takes place. Support for the other artifacts that ChefDK
+  can generate may work, but is not the focus of early releases.
 email:
-- james.i.fitzgibbon@nordstrom.com
+- james@nadt.net
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -291,7 +297,6 @@ files:
 - README.md
 - chef-gen-flavors.gemspec
 - lib/chef_gen/flavor.rb
-- lib/chef_gen/flavor_base.rb
 - lib/chef_gen/flavors.rb
 - lib/chef_gen/flavors/cucumber.rb
 - lib/chef_gen/flavors/cucumber/bundle.rb
@@ -300,43 +305,7 @@ files:
 - lib/chef_gen/flavors/cucumber/knife.rb
 - lib/chef_gen/flavors/cucumber/rake.rb
 - lib/chef_gen/flavors/cucumber/regex.rb
-- lib/chef_gen/snippet/attributes.rb
-- lib/chef_gen/snippet/chef_spec.rb
-- lib/chef_gen/snippet/cookbook_base.rb
-- lib/chef_gen/snippet/example_file.rb
-- lib/chef_gen/snippet/example_template.rb
-- lib/chef_gen/snippet/git_init.rb
-- lib/chef_gen/snippet/recipes.rb
-- lib/chef_gen/snippet/resource_provider.rb
-- lib/chef_gen/snippet/standard_ignore.rb
-- lib/chef_gen/snippet/style_foodcritic.rb
-- lib/chef_gen/snippet/style_rubocop.rb
-- lib/chef_gen/snippet/style_tailor.rb
-- lib/chef_gen/snippet/test_kitchen.rb
-- lib/chef_gen/snippets.rb
-- shared/snippet/attributes/attributes_default_rb.erb
-- shared/snippet/chef_spec/_rspec.erb
-- shared/snippet/chef_spec/spec_chef_runner_context_rb.erb
-- shared/snippet/chef_spec/spec_recipes_default_spec_rb.erb
-- shared/snippet/chef_spec/spec_spec_helper_rb.erb
-- shared/snippet/cookbookbase/Berksfile.erb
-- shared/snippet/cookbookbase/CHANGELOG_md.erb
-- shared/snippet/cookbookbase/Gemfile.erb
-- shared/snippet/cookbookbase/Guardfile.erb
-- shared/snippet/cookbookbase/README_md.erb
-- shared/snippet/cookbookbase/Rakefile.erb
-- shared/snippet/cookbookbase/metadata_rb.erb
-- shared/snippet/examplefile/files_default_example_conf
-- shared/snippet/exampletemplate/templates_default_example_conf_erb
-- shared/snippet/recipes/recipes_default_rb.erb
-- shared/snippet/resourceprovider/providers_default_rb.erb
-- shared/snippet/resourceprovider/resources_default_rb.erb
-- shared/snippet/stylerubocop/_rubocop_yml.erb
-- shared/snippet/testkitchen/_kitchen_yml.erb
-- shared/snippet/testkitchen/libraries_kitchen_helper_rb
-- shared/snippet/testkitchen/test_integration_default_serverspec_recipes_default_spec_rb.erb
-- shared/snippet/testkitchen/test_integration_default_serverspec_spec_helper_rb.erb
-homepage: https://github.com/Nordstrom/chef-gen-flavors
+homepage: https://github.com/jf647/chef-gen-flavors
 licenses:
 - apache2
 metadata: {}

data/lib/chef_gen/flavor_base.rb

@@ -1,266 +0,0 @@
-require 'chef-dk/generator'
-
-module ChefGen
-  # a base for ChefDK Template Flavors
-  class FlavorBase
-    # the target path of 'chef generate'
-    # @return [String] path
-    attr_reader :target_path
-
-    # directories to create
-    # @return [Array] list of directories
-    attr_reader :directories
-
-    # files to create unconditionally
-    # @return [Array] list of destination filenames
-    attr_reader :files
-
-    # files to create only if they do not exist
-    # @return [Array] list of destination filenames
-    attr_reader :files_if_missing
-
-    # templates to render unconditionally
-    # @return [Array] list of destination filenames
-    attr_reader :templates
-
-    # templates to render only if they do not exist
-    # @return [Array] list of destination filenames
-    attr_reader :templates_if_missing
-
-    # an informational block about how the user should proceed
-    # @return [String] instructions
-    attr_accessor :next_steps
-
-    # whether to fail if files would be overwritten
-    # @return [Boolean] true to fail on attempted overwrite
-    attr_accessor :fail_on_clobber
-
-    # whether to report the actions that were taken
-    # @return [Boolean] true to report actions
-    attr_accessor :report_actions
-
-    # creates a new flavor object
-    # @param recipe [Chef::Recipe] the recipe into which
-    #   resources will be injected
-    # @return [self]
-    def initialize(recipe)
-      # store the recipe we'll be injecting resources into
-      @recipe = recipe
-
-      # derive our target path
-      ctx = generator_context
-      @target_path = File.expand_path(
-        File.join(ctx.cookbook_root, ctx.cookbook_name)
-      )
-
-      # set defaults
-      @report_actions = true
-      @fail_on_clobber = !ctx.respond_to?(:clobber)
-      @directories = []
-      %w(directories files files_if_missing templates
-         templates_if_missing actions_taken failures).each do |varname|
-        instance_variable_set("@#{varname}".to_sym, [])
-      end
-
-      # call initializers defined by snippets
-      methods_by_pattern(/^init_/).each do |m|
-        send(m)
-      end
-    end
-
-    # find all public methods of the flavor starting with content_
-    # and calls them, passing the path as the sole parameter
-    # @param path [String] the path to the copy of the generator cookbook
-    # @return [void]
-    def add_content(path)
-      methods_by_pattern(/^content_/).each do |m|
-        send(m, path)
-      end
-    end
-
-    # copy a snippet content file to the temporary generator path,
-    # creating the destination directory if it does not already exist
-    # @param src [String] the source file
-    # @param dst [String] the destination file
-    # @return [void]
-    def copy_snippet_file(src, dst)
-      # make sure the parent of the destination exists
-      parent = File.dirname(dst)
-      FileUtils.mkpath(parent) unless Dir.exist?(parent)
-      # copy the file
-      FileUtils.copy_file(src, dst)
-    end
-
-    # a proxy to ChefDK's generator context
-    # @return [ChefDK::Generator::Context]
-    def generator_context
-      ChefDK::Generator.context
-    end
-
-    # generates the Chef resources that the plugin has declared
-    # @return [void]
-    def generate
-      add_target_path
-      run_snippets
-      after_run_snippets if respond_to?(:after_run_snippets)
-      add_directories
-      add_files
-      add_templates
-      unless @failures.empty?
-        @failures.each { |f| $stderr.puts f }
-        fail 'errors during generation'
-      end
-      report_actions_taken(@actions_taken) \
-        if @report_actions && @actions_taken
-      display_next_steps(@next_steps) if @next_steps
-    end
-
-    # given a destination file, returns a flattened source
-    # filename by replacing / and . with _
-    # @param path [String] the destination file
-    # @return [String] the flattened source file
-    # @example convert a destination file
-    #   source_path('spec/spec_helper.rb') #=> 'spec_spec_helper_rb'
-    def source_path(path)
-      path.tr('/.', '_')
-    end
-
-    private
-
-    # creates a directory resource for the target
-    # @return [void]
-    def add_target_path
-      @recipe.send(:directory, @target_path)
-      @actions_taken << "create directory #{@target_path}"
-    end
-
-    # find all public methods of the flavor starting with snippet_
-    # and calls them
-    # @return [void]
-    # @yield [Chef::Recipe] the recipe into which the mixin can inject
-    #   resources
-    # @api private
-    def run_snippets
-      methods_by_pattern(/^snippet_/).each do |m|
-        send(m, @recipe)
-      end
-    end
-
-    # returns a list of public methods that match a pattern
-    # @param pattern [Regexp] the pattern to match methods against
-    # @return [Array] a list of sorted methods
-    def methods_by_pattern(pattern)
-      public_methods.select do |m|
-        m.to_s =~ pattern
-      end
-    end
-
-    # declares a directory resource for each element of @directories
-    # @return [void]
-    # @api private
-    def add_directories
-      @directories.flatten.each do |dirname|
-        path = File.join(@target_path, dirname)
-        @recipe.send(:directory, path)
-        @actions_taken << "create directory #{path}"
-      end
-    end
-
-    # declares a cookbook_file resource for each element of '#files' and
-    # '#files_if_missing', respecting the value of '#fail_on_clobber'
-    # @return [void]
-    # @api private
-    def add_files
-      add_render(
-        @files,
-        suffix: '', resource: :cookbook_file, resource_action: :create
-      )
-      add_render(
-        @files_if_missing,
-        suffix: '', clobberfail: false, resource: :cookbook_file
-      )
-    end
-
-    # declares a template resource for each element of '#templates' and
-    # '#templates_if_missing', respecting the value of '#fail_on_clobber'
-    # @return [void]
-    # @api private
-    def add_templates
-      add_render(@templates, resource_action: :create)
-      add_render(@templates_if_missing, clobberfail: false)
-    end
-
-    # does the heavy lifting for add_files and add_templates
-    # @param things [Array] the list of things to declare
-    # @param suffix [String] a suffix to add to the source file
-    # @param clobberfail [Boolean] whether to protect against
-    #   overwriting files
-    # @param resource [Symbol] the symbolized Chef resource to declare
-    # @param resource_action [Symbol] the action to give the resource
-    # @param attrs [Hash] additional attributes to send to the resource.
-    #   Keys are methods, values are parameters
-    # @return [void]
-    # @api private
-    def add_render( # rubocop:disable Metrics/ParameterLists
-      things,
-      suffix: '.erb', clobberfail: @fail_on_clobber,
-      resource: :template, resource_action: :create_if_missing,
-      attrs: {}
-    )
-      things.flatten.each do |filename|
-        src = "#{source_path(filename)}#{suffix}"
-        dst = File.join(@target_path, filename)
-        if clobberfail && File.exist?(dst)
-          @failures << "tried to overwrite file #{dst}"
-        else
-          _add_resource(resource, src, dst, resource_action, attrs)
-        end
-      end
-    end
-
-    # adds a resource to the recipe
-    # @api private
-    def _add_resource(type, src, dst, action, attrs)
-      @recipe.send(type, dst) do
-        # :nocov:
-        source src
-        action action
-        helpers(ChefDK::Generator::TemplateHelper) \
-          if :template == type
-        attrs.each do |attr, value|
-          send attr, value
-        end
-        # :nocov:
-      end
-      @actions_taken << "add resource #{type}[#{dst}]"
-    end
-
-    # reports on the actions taken by the plugin
-    # @param actions [Array] the list of actions taken
-    # @return [void]
-    # @api private
-    def report_actions_taken(actions)
-      @recipe.send(:ruby_block, 'report_actions_taken') do
-        # :nocov:
-        block do
-          $stdout.puts "\n\nactions taken:"
-          actions.each { |a| $stdout.puts "  #{a}" }
-        end
-        # :nocov:
-      end
-    end
-
-    # displays the next steps for the user to take
-    # @return [void]
-    # @api private
-    def display_next_steps(next_steps)
-      @recipe.send(:ruby_block, 'display_next_steps') do
-        # :nocov:
-        block do
-          $stdout.puts next_steps
-        end
-        # :nocov:
-      end
-    end
-  end
-end