chef-gen-flavor-base 0.9.0

data/chef-gen-flavor-base.gemspec

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+# stub: chef-gen-flavor-base 0.9.0.20150909153100 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "chef-gen-flavor-base"
+  s.version = "0.9.0.20150909153100"
+
+  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-09-09"
+  s.description = "chef-gen-flavor-base is a base class to make it easy to create 'flavors'\nfor use with\n[chef-gen-flavors](https://github.com/jf647/chef-gen-flavors).\n\nchef-gen-flavors plugs into the 'chef generate' command provided by\nChefDK to let you provide an alternate template for cookbooks and other\nchef components.\n\nThis gem simply provides a class your flavor can derive from; templates\nare provided by separate gems, which you can host privately for use\nwithin your organization or publicly for the Chef community to use.\n\nAn example flavor that demonstrates how to use this gem is distributed\nseparately:\n[chef-gen-flavor-example](https://github.com/jf647/chef-gen-flavor-example)\n\nAt present this is focused primarily on providing templates for\ngeneration of cookbooks, as this is where most organization-specific\ncustomization takes place. Support for the other artifacts that ChefDK\ncan generate may work, but is not the focus of early releases."
+  s.email = ["james@nadt.net"]
+  s.extra_rdoc_files = ["History.md", "Manifest.txt", "README.md"]
+  s.files = ["History.md", "LICENSE", "Manifest.txt", "README.md", "chef-gen-flavor-base.gemspec", "lib/chef_gen/flavor_base.rb", "lib/chef_gen/flavor_base/copy_helpers.rb", "lib/chef_gen/flavor_base/resource_helpers.rb", "lib/chef_gen/snippet/actions_taken.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/debugging.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/guard.rb", "lib/chef_gen/snippet/next_steps.rb", "lib/chef_gen/snippet/no_clobber.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/snippet_base.rb", "lib/chef_gen/snippets.rb", "shared/snippet/attributes/templates/default/attributes_default_rb.erb", "shared/snippet/chef_spec/templates/default/_rspec.erb", "shared/snippet/chef_spec/templates/default/spec_chef_runner_context_rb.erb", "shared/snippet/chef_spec/templates/default/spec_recipes_default_spec_rb.erb", "shared/snippet/chef_spec/templates/default/spec_spec_helper_rb.erb", "shared/snippet/cookbook_base/templates/default/Berksfile.erb", "shared/snippet/cookbook_base/templates/default/CHANGELOG_md.erb", "shared/snippet/cookbook_base/templates/default/Gemfile.erb", "shared/snippet/cookbook_base/templates/default/README_md.erb", "shared/snippet/cookbook_base/templates/default/Rakefile.erb", "shared/snippet/cookbook_base/templates/default/metadata_rb.erb", "shared/snippet/example_file/files/default/files_default_example_conf", "shared/snippet/example_template/files/default/templates_default_example_conf_erb", "shared/snippet/guard/templates/default/Guardfile.erb", "shared/snippet/recipes/templates/default/recipes_default_rb.erb", "shared/snippet/resource_provider/templates/default/providers_default_rb.erb", "shared/snippet/resource_provider/templates/default/resources_default_rb.erb", "shared/snippet/style_rubocop/templates/default/_rubocop_yml.erb", "shared/snippet/test_kitchen/libraries/kitchen_helper.rb", "shared/snippet/test_kitchen/templates/default/_kitchen_yml.erb", "shared/snippet/test_kitchen/templates/default/test_integration_default_serverspec_recipes_default_spec_rb.erb", "shared/snippet/test_kitchen/templates/default/test_integration_default_serverspec_spec_helper_rb.erb"]
+  s.homepage = "https://github.com/jf647/chef-gen-flavor-base"
+  s.licenses = ["apache2"]
+  s.rdoc_options = ["--main", "README.md"]
+  s.rubygems_version = "2.4.4"
+  s.summary = "chef-gen-flavor-base is a base class to make it easy to create 'flavors' for use with [chef-gen-flavors](https://github.com/jf647/chef-gen-flavors)"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<chef-gen-flavors>, ["~> 0.9"])
+      s.add_runtime_dependency(%q<hooks>, ["~> 0.4"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      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"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_development_dependency(%q<guard>, ["~> 2.12"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_development_dependency(%q<guard-rake>, ["~> 0.0"])
+      s.add_development_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_development_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8"])
+      s.add_development_dependency(%q<aruba>, ["~> 0.6.2"])
+      s.add_development_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+      s.add_development_dependency(%q<fakefs>, ["~> 0.6"])
+    else
+      s.add_dependency(%q<chef-gen-flavors>, ["~> 0.9"])
+      s.add_dependency(%q<hooks>, ["~> 0.4"])
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      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"])
+      s.add_dependency(%q<rspec>, ["~> 3.1"])
+      s.add_dependency(%q<guard>, ["~> 2.12"])
+      s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+      s.add_dependency(%q<guard-rake>, ["~> 0.0"])
+      s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+      s.add_dependency(%q<simplecov>, ["~> 0.9"])
+      s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+      s.add_dependency(%q<yard>, ["~> 0.8"])
+      s.add_dependency(%q<aruba>, ["~> 0.6.2"])
+      s.add_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+      s.add_dependency(%q<fakefs>, ["~> 0.6"])
+    end
+  else
+    s.add_dependency(%q<chef-gen-flavors>, ["~> 0.9"])
+    s.add_dependency(%q<hooks>, ["~> 0.4"])
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    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"])
+    s.add_dependency(%q<rspec>, ["~> 3.1"])
+    s.add_dependency(%q<guard>, ["~> 2.12"])
+    s.add_dependency(%q<guard-rspec>, ["~> 4.2"])
+    s.add_dependency(%q<guard-rake>, ["~> 0.0"])
+    s.add_dependency(%q<guard-rubocop>, ["~> 1.2"])
+    s.add_dependency(%q<simplecov>, ["~> 0.9"])
+    s.add_dependency(%q<simplecov-console>, ["~> 0.2"])
+    s.add_dependency(%q<yard>, ["~> 0.8"])
+    s.add_dependency(%q<aruba>, ["~> 0.6.2"])
+    s.add_dependency(%q<rspec_junit_formatter>, ["~> 0.2"])
+    s.add_dependency(%q<fakefs>, ["~> 0.6"])
+  end
+end

data/lib/chef_gen/flavor_base.rb

@@ -0,0 +1,185 @@
+require 'chef-dk/generator'
+require 'hooks'
+
+require 'chef_gen/flavor_base/copy_helpers'
+require 'chef_gen/flavor_base/resource_helpers'
+
+module ChefGen
+  # a base for ChefDK Template Flavors
+  class FlavorBase
+    include Hooks
+    include ChefGen::FlavorBase::CopyHelpers
+    include ChefGen::FlavorBase::ResourceHelpers
+
+    # the version of the gem
+    VERSION = '0.9.0'
+
+    # define common hooks
+    define_hooks :before_initialize, :after_initialize,
+                 :before_snippet_construct, :after_snippet_construct
+
+    # define setup hooks
+    define_hooks :before_add_content, :after_add_content,
+                 :do_add_content,
+                 :before_copy_content, :after_copy_content
+
+    # define generate hooks
+    define_hooks :before_declare_resources, :after_declare_resources,
+                 :do_declare_resources,
+                 :before_add_resources, :after_add_resources,
+                 :before_add_directories, :after_add_directories,
+                 :before_add_files, :after_add_files,
+                 :before_add_templates, :after_add_templates
+
+    # the type of object being generated (cookbook, repo, etc.)
+    # @return [String] the type of object being generated
+    attr_reader :type
+
+    # a list of snippet classes to mix in
+    # @return [Array<Class>] list of snippet classes
+    attr_reader :snippets
+
+    # a list of pairs of src/dst files or directories to copy into
+    # the temporary directory.
+    # @return [Array<Array>] list of [src, dst] pairs
+    attr_reader :tocopy
+
+    # a list of directory resources
+    # @return [Array<String>] target path relative to cookbook root
+    attr_reader :directories
+
+    # a list of file resources with action :create
+    # @return [Array<String>] target path relative to cookbook root
+    attr_reader :files
+
+    # a list of file resources with action :create_if_missing
+    # @return [Array<String>] target path relative to cookbook root
+    attr_reader :files_if_missing
+
+    # a list of template resources with action :create
+    # @return [Array<String>] target path relative to cookbook root
+    attr_reader :templates
+
+    # a list of template resources with action :create_if_missing
+    # @return [Array<String>] target path relative to cookbook root
+    attr_reader :templates_if_missing
+
+    # @overload initialize(temp_path)
+    #   initializes the flavor in setup mode
+    #   @param temp_path [String] the temporary directory provided
+    #     by chef-gen-flavors
+    #   @return [self]
+    # @overload initialize(type, recipe)
+    #   initializes the flavor in generate mode
+    #   @param type [String] the type of object being generated
+    #     when constructed by ChefDK
+    #   @param recipe [Chef::Recipe] the recipe into which to inject
+    #     resources when constructed by ChefDK
+    #   @return [self]
+    def initialize(temp_path: nil, type: nil, recipe: nil)
+      # run before hook
+      run_hook :before_initialize
+
+      # set up instance variables
+      @recipe = recipe
+
+      # start with an empty list of snippets
+      @snippets = []
+      @enabled_snippets = {}
+
+      if setup_mode?
+        @temp_path = temp_path
+        # in setup mode, start with an empty list of things to copy
+        @tocopy = []
+      else
+        @type = type
+        # in generate mode, start empty dir, file and template lists
+        @directories = []
+        @files = []
+        @files_if_missing = []
+        @templates = []
+        @templates_if_missing = []
+      end
+
+      # run after hook
+      run_hook :after_initialize
+    end
+
+    # determines if the flavor is in setup mode
+    # @return [Boolean] true if the flavor is in setup mode, creating
+    #   the temporary directory
+    def setup_mode?
+      @recipe.nil?
+    end
+
+    # determines if the flavor is in generate mode
+    # @return [Boolean] true if the flavor is in generate mode, used
+    #   by ChefDK to create an object
+    def generate_mode?
+      !setup_mode?
+    end
+
+    # constructs and calls the #add_content of each snippet, then calls
+    # #copy_content to copy the files to the temporary directory
+    # @return [void]
+    def add_content
+      # construct each snippet in setup mode
+      run_hook :before_snippet_construct
+      snippets.map! { |s| s.new(flavor: self) }
+      mark_enabled_snippets
+      run_hook :after_snippet_construct
+
+      # call hooks to add content
+      run_hook :before_add_content
+      run_hook :do_add_content
+      run_hook :after_add_content
+
+      # copy queued content
+      run_hook :before_copy_content
+      copy_content
+      run_hook :after_copy_content
+    end
+
+    # constructs and calls the #declare_resources method of each snippet,
+    # then calls #add_resources to add the resources to the recipe
+    # @return [void]
+    def declare_resources
+      # declare the target directory
+      @recipe.send(:directory, destination_path('.'))
+
+      # construct each snippet in generate mode
+      run_hook :before_snippet_construct
+      snippets.map! { |s| s.new(flavor: self, recipe: @recipe) }
+      mark_enabled_snippets
+      run_hook :after_snippet_construct
+
+      # call hooks to add content
+      run_hook :before_declare_resources
+      run_hook :do_declare_resources
+      run_hook :after_declare_resources
+
+      # add queued resources to the recipe
+      run_hook :before_add_resources
+      add_resources
+      run_hook :after_add_resources
+    end
+
+    # a predicate to determine if a snippet has been included in a flavor
+    # @param [String] name the NAME constant of the snippet
+    # @return [Boolean] true if the snippet has been enabled
+    def snippet?(name)
+      @enabled_snippets.key?(name)
+    end
+
+    private
+
+    # populates a hash of enabled snippets for use in snippet?
+    # @return [void]
+    # @api private
+    def mark_enabled_snippets
+      @enabled_snippets = snippets.map do |s|
+        [s.class.const_get(:NAME), 1]
+      end.to_h
+    end
+  end
+end

data/lib/chef_gen/flavor_base/copy_helpers.rb

@@ -0,0 +1,45 @@
+module ChefGen
+  # a base for ChefDK Template Flavors
+  class FlavorBase
+    # helpers to copy files from flavors and snippets to the temporary
+    # directory; used in the setup phase
+    module CopyHelpers
+      private
+
+      # copies content enqueued by the flavor and snippets to the
+      # temporary directory.  Uses the list of things to copy in the
+      # #tocopy list.  In each pair, src is an absolute file or
+      # directory and dst is relative to the generator cookbook path.
+      # If copying to the root of the temp dir, pair[1] can be nil.
+      # Implemented using FileUtils::cp_r, so refer to that for details
+      # of the different patterns you can use.
+      # @return [void]
+      # @api private
+      def copy_content
+        @tocopy.each do |pair|
+          src = pair[0]
+          dst = File.expand_path(File.join(@temp_path, pair[1] || ''))
+          dstdir = File.dirname(dst)
+          FileUtils.mkpath(dstdir) unless File.exist?(dstdir)
+          FileUtils.cp_r(src, dst)
+        end
+
+        # clear out the list of things to copy so that snippets can
+        # re-load it and call copy_content again if needed
+        @tocopy = []
+      end
+
+      # returns the path to static content distributed with a flavor
+      # @param file [String] the file to generate the path from
+      # @return [String] the path the static content relative to the file
+      # @api private
+      def static_content_path(file)
+        File.expand_path(
+          File.join(
+            File.dirname(file), '..', '..', '..', 'shared', 'flavor', self.class::NAME
+          )
+        )
+      end
+    end
+  end
+end

data/lib/chef_gen/flavor_base/resource_helpers.rb

@@ -0,0 +1,110 @@
+module ChefGen
+  # a base for ChefDK Template Flavors
+  class FlavorBase
+    # helpers to add resources to recipes; used in the generate phase
+    module ResourceHelpers
+      # adds directories to the recipes
+      # @param [Array<String>] directories the directories to create
+      # @return [void]
+      # @api private
+      def add_directories(directories)
+        run_hook :before_add_directories, directories
+        directories.each do |dir|
+          dst = destination_path(dir)
+          @recipe.send(:directory, dst)
+        end
+        run_hook :after_add_directories, directories
+      end
+
+      # adds files to the recipes.  Without content, creates a cookbook_file
+      # resource, otherwise creates a file resource.
+      # @param files [Array<String>] list of files relative to target root.
+      #   If content is provided, this should only contain one file
+      # @param resource_action [Symbol] the action to send to the resource
+      # @param type [Symbol] the type of resource, :file or :cookbook_file
+      # @param attrs [Hash] additional attributes to pass to the resource
+      # @return [void]
+      # @api private
+      def add_files(files, resource_action = :create_if_missing, type = :cookbook_file, attrs = {})
+        run_hook :before_add_files, files, resource_action, type, attrs
+        files.each do |file|
+          src = source_path(file)
+          # :nocov:
+          @recipe.send(type, destination_path(file)) do
+            action resource_action
+            source src if :cookbook_file == type
+            attrs.each { |a, v| send a, v }
+          end
+          # :nocov:
+        end
+        run_hook :after_add_files, files, resource_action, type, attrs
+      end
+
+      # adds templates to the recipes
+      # @param templates [Array<String>] list of templates relative to target root
+      # @param resource_action [Symbol] the action to send to the resource
+      # @param attrs [Hash] additional attributes to pass to the resource
+      # @return [void]
+      # @api private
+      def add_templates(templates, resource_action = :create_if_missing, attrs = {})
+        run_hook :before_add_templates, templates, resource_action, attrs
+        templates.each do |template|
+          src = "#{source_path(template)}.erb"
+          # :nocov:
+          @recipe.send(:template, destination_path(template)) do
+            source src
+            action resource_action
+            helpers ChefDK::Generator::TemplateHelper
+            attrs.each { |a, v| send a, v }
+          end
+          # :nocov:
+          run_hook :after_add_templates, templates, resource_action, attrs
+        end
+      end
+
+      private
+
+      # 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
+
+      # returns the destination path for a file in the `chef generate`
+      #   target directory
+      # @param path [String] a path to append to the target dir
+      # @return [String] the absolute destination path
+      # @api private
+      def destination_path(path = '')
+        File.expand_path(File.join(generate_target, path))
+      end
+
+      # returns the target directory of `chef generate`
+      # @return [String]
+      # @api private
+      def generate_target
+        @generate_target ||= begin
+          ctx = ChefDK::Generator.context
+          File.expand_path(
+            File.join(ctx.cookbook_root, ctx.cookbook_name)
+          )
+        end
+      end
+
+      # adds declared directories / files / templates resources to the recipe
+      # @return [void]
+      # @api private
+      def add_resources
+        add_directories(@directories)
+        add_files(@files, :create)
+        add_files(@files_if_missing)
+        add_templates(@templates, :create)
+        add_templates(@templates_if_missing)
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/actions_taken.rb

@@ -0,0 +1,82 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # provides an accumulator of the actions were taken by the
+    # flavor during generation and a ruby_block resource to display
+    # them at the end of the generate phase
+    class ActionsTaken < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'actions_taken'
+
+      private
+
+      # @!attribute [rw] actions_taken
+      #   @return [Array<String>] the actions taken by the flavor
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.send(:attr_accessor, :actions_taken)
+        @flavor.actions_taken = []
+
+        hook_add_directories
+        hook_add_files
+        hook_add_templates
+        hook_report_actions
+      end
+
+      # adds a hook after add_directories to report on actions
+      # @return [void]
+      # @api private
+      def hook_add_directories
+        @flavor.class.after_add_directories do |directories|
+          directories.each do |dir|
+            actions_taken << "create directory #{dir}"
+          end
+        end
+      end
+
+      # adds a hook afer add_files to report on actions
+      # @return [void]
+      # @api private
+      def hook_add_files
+        @flavor.class.after_add_files do |files, resource_action, type|
+          files.each do |file|
+            actions_taken << "#{resource_action} #{type} #{file}"
+          end
+        end
+      end
+
+      # adds a hook after add_templates to report on actions
+      # @return [void]
+      # @api private
+      def hook_add_templates
+        @flavor.class.after_add_templates do |templates, resource_action|
+          templates.each do |template|
+            actions_taken << "#{resource_action} template #{template}"
+          end
+        end
+      end
+
+      # adds an after hook to declare resources to report on actions taken
+      # @return [void]
+      # @api private
+      def hook_report_actions
+        @flavor.class.after_add_resources do
+          actions = actions_taken
+          @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
+      end
+    end
+  end
+end