chef-gen-flavors 0.3.0

data/Rakefile

@@ -0,0 +1,85 @@
+require 'chef_gen/flavors'
+
+begin
+  require 'hoe'
+  Hoe.plugin :gemspec
+  Hoe.plugins.delete :test
+  Hoe.spec 'chef-gen-flavors' do |s|
+    s.version = ChefGen::Flavors::VERSION
+    developer 'James FitzGibbon', 'james.i.fitzgibbon@nordstrom.com'
+    license 'apache2'
+    extra_deps << ['little-plugger', '~> 1.1']
+    extra_deps << ['bogo-ui', '~> 0.1']
+    extra_dev_deps << ['chef-dk', '~> 0.5']
+    extra_dev_deps << ['hoe', '~> 3.13']
+    extra_dev_deps << ['hoe-gemspec', '~> 1.0']
+    extra_dev_deps << ['rake', '~> 10.3']
+    extra_dev_deps << ['rspec', '~> 3.1']
+    extra_dev_deps << ['guard', '~> 2.12']
+    extra_dev_deps << ['guard-rspec', '~> 4.2']
+    extra_dev_deps << ['guard-rake', '~> 0.0']
+    extra_dev_deps << ['guard-rubocop', '~> 1.2']
+    extra_dev_deps << ['simplecov', '~> 0.9']
+    extra_dev_deps << ['simplecov-console', '~> 0.2']
+    extra_dev_deps << ['yard', '~> 0.8']
+  end
+  # re-generate our gemspec before packaging
+  task package: 'gem:spec'
+rescue LoadError
+  puts 'hoe not available; disabling tasks'
+end
+
+# Style Tests
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new do |t|
+    t.formatters = ['progress']
+    t.options = ['-D']
+    t.patterns = %w(
+      lib/**/*.rb
+      spec/**/*.rb
+      ./Rakefile
+    )
+  end
+  desc 'Run Style Tests'
+  task style: [:rubocop]
+rescue LoadError
+  puts 'rubocop not available; disabling tasks'
+end
+
+# Unit Tests
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+
+  # Coverage
+  desc 'Generate unit test coverage report'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task[:test].invoke
+  end
+rescue LoadError
+  puts 'rspec not available; disabling tasks'
+  # create a no-op task so that :default works
+  task :test
+end
+
+# Documentation
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new(:doc) do |t|
+    t.options = ['-m', 'markdown', '--private']
+    t.stats_options = ['--list-undoc']
+  end
+rescue LoadError
+  puts 'yard not available; disabling tasks'
+end
+
+# test is an alias for spec
+desc 'runs unit tests'
+task test: [:spec]
+
+# default is to test everything
+desc 'runs all tests'
+task default: :test

data/chef-gen-flavors.gemspec

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+# stub: chef-gen-flavors 0.3.0.20150514061941 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "chef-gen-flavors"
+  s.version = "0.3.0.20150514061941"
+
+  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-05-14"
+  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.extra_rdoc_files = ["History.md", "Manifest.txt", "README.md"]
+  s.files = [".rspec", ".rubocop.yml", ".travis.yml", "Gemfile", "Gemfile.lock", "Guardfile", "History.md", "LICENSE", "Manifest.txt", "README.md", "Rakefile", "chef-gen-flavors.gemspec", "lib/chef_gen/flavor.rb", "lib/chef_gen/flavor_base.rb", "lib/chef_gen/flavors.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/recipes.rb", "lib/chef_gen/snippet/resource_provider.rb", "lib/chef_gen/snippet/standard_ignore.rb", "lib/chef_gen/snippet/style_rubocop.rb", "lib/chef_gen/snippet/test_kitchen.rb", "lib/chef_gen/snippets.rb", "spec/lib/chef_gen/flavor_base_spec.rb", "spec/lib/chef_gen/flavors_spec.rb", "spec/lib/chef_gen/snippet/attributes_spec.rb", "spec/lib/chef_gen/snippet/chef_spec_spec.rb", "spec/lib/chef_gen/snippet/cookbook_base_spec.rb", "spec/lib/chef_gen/snippet/example_file_spec.rb", "spec/lib/chef_gen/snippet/example_template_spec.rb", "spec/lib/chef_gen/snippet/recipes_spec.rb", "spec/lib/chef_gen/snippet/resource_provider_spec.rb", "spec/lib/chef_gen/snippet/standard_ignore_spec.rb", "spec/lib/chef_gen/snippet/style_rubocop_spec.rb", "spec/lib/chef_gen/snippet/test_kitchen_spec.rb", "spec/spec_helper.rb", "spec/support/fixtures/code_generator/metadata.rb", "spec/support/fixtures/code_generator/recipes/cookbook.rb", "spec/support/fixtures/code_generator_2/metadata.rb", "spec/support/fixtures/code_generator_2/recipes/cookbook.rb", "spec/support/fixtures/lib/chef_gen/flavor/bar.rb", "spec/support/fixtures/lib/chef_gen/flavor/baz.rb", "spec/support/fixtures/lib/chef_gen/flavor/foo.rb"]
+  s.homepage = "https://github.com/Nordstrom/chef-gen-flavors"
+  s.licenses = ["apache2"]
+  s.rdoc_options = ["--main", "README.md"]
+  s.rubygems_version = "2.4.4"
+  s.summary = "chef-gen-flavors is a framework for creating custom templates for the 'chef generate' command provided by ChefDK"
+
+  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<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<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"])
+    else
+      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<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"])
+    end
+  else
+    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<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"])
+  end
+end

data/lib/chef_gen/flavor.rb

@@ -0,0 +1,5 @@
+# chef generators
+module ChefGen
+  # a namespace for template flavors
+  module Flavor; end
+end

data/lib/chef_gen/flavor_base.rb

@@ -0,0 +1,230 @@
+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
+
+    # the file patterns to write to the chefignore files
+    # @return [Array] list of file patterns
+    attr_reader :chefignore_files
+
+    # the file patterns to add to .gitignore
+    # @return [Array] list of file patterns
+    attr_reader :gitignore_files
+
+    # 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 = ChefDK::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 = [''] # root directory
+      %w(files files_if_missing templates templates_if_missing
+         chefignore_files gitignore_files actions_taken failures)
+        .each do |varname|
+        instance_variable_set("@#{varname}".to_sym, [])
+      end
+    end
+
+    # generates the Chef resources that the plugin has declared
+    # @return [void]
+    def generate
+      run_mixins
+      add_directories
+      add_files
+      add_templates
+      unless @failures.empty?
+        @failures.each { |f| $stderr.puts f }
+        fail 'errors during generation'
+      end
+      build_ignore('.gitignore', @gitignore_files)
+      build_ignore('chefignore', @chefignore_files)
+      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
+
+    # find all public methods of the plugin starting with snippet_
+    # and calls them
+    # @return [void]
+    # @yield [Chef::Recipe] the recipe into which the mixin can inject
+    #   resources
+    # @api private
+    def run_mixins
+      snippets = public_methods.select do |m|
+        m.to_s =~ /^snippet_/
+      end
+      snippets.each do |m|
+        send(m, @recipe)
+      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_files(
+        @files, nil, @fail_on_clobber, :cookbook_file, :create
+      )
+      _add_files(
+        @files_if_missing, nil, false, :cookbook_file, :create_if_missing
+      )
+    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_files(
+        @templates, '.erb', @fail_on_clobber, :template, :create
+      )
+      _add_files(
+        @templates_if_missing, '.erb', false, :template, :create_if_missing
+      )
+    end
+
+    # does the heavy lifting for add_files and add_templates
+    # @param files [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
+    # @return [void]
+    # @api private
+    def _add_files(files, suffix, clobberfail, resource, resource_action)
+      files.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
+          @recipe.send(resource, dst) do
+            # :nocov:
+            source src
+            action resource_action
+            helpers(ChefDK::Generator::TemplateHelper) \
+              if :template == resource
+            # :nocov:
+          end
+          @actions_taken << "create file #{dst}"
+        end
+      end
+    end
+
+    # creates a .gitignore or chefignore file
+    # @param dstfile [String] the destination file
+    # @param files [Array] an array of lines to write to the file
+    # @return [void]
+    # @api private
+    def build_ignore(dstfile, files)
+      return if files.empty?
+      dst = File.join(@target_path, dstfile)
+      @recipe.send(:file, dst) do
+        # :nocov:
+        content files.flatten.join("\n")
+        # :nocov:
+      end
+      @actions_taken << "create ignore file #{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

data/lib/chef_gen/flavors.rb

@@ -0,0 +1,173 @@
+require 'little-plugger'
+
+require 'chef_gen/flavor'
+
+# chef generators
+module ChefGen
+  # a plugin framework for creating ChefDK generator flavors
+  class Flavors
+    # the version of the gem
+    VERSION = '0.3.0'
+
+    extend LittlePlugger path: 'chef_gen/flavor',
+                         module: ChefGen::Flavor
+
+    class << self
+      # return the path to to the code_generator cookbook for
+      # the selected ChefGen Flavor
+      # @return [String] the path to the code_generator cookbook
+      def path
+        # validate what LittlePlugger found
+        validate_plugins
+        # then take a copy so we can augment it
+        @plugins = plugins.dup
+        add_builtin_template
+        selected = plugin_from_env ||
+                   only_plugin ||
+                   prompt_for_plugin ||
+                   fail('no ChefGen flavors found!')
+        path = generator_path(selected)
+        $stdout.puts "using ChefGen flavor '#{selected}' in #{path}"
+        path
+      end
+
+      private
+
+      # validates all plugins found by LittlePlugger
+      # @raise RuntimeError if any plugin is invalid
+      # @return [void]
+      # @api private
+      def validate_plugins
+        plugins.each do |name, klass|
+          fail "no description for plugin #{name}" \
+            unless klass.respond_to?(:description)
+        end
+      end
+
+      # checks if the plugin to use has been specified in the environment
+      # variable CHEFGEN_FLAVOR
+      # @return [Symbol,nil] the plugin if specified and found, nil otherwise
+      # @api private
+      def plugin_from_env
+        if ENV.key?('CHEFGEN_FLAVOR')
+          candidate = ENV['CHEFGEN_FLAVOR'].downcase.to_sym
+          return candidate if plugins.key?(candidate)
+        end
+        nil
+      end
+
+      # if the environment variable CHEFDK_FLAVOR is defined, adds
+      # the built-in template that comes with ChefDK to the list of available
+      # plugins
+      # @return [void]
+      # @api private
+      def add_builtin_template
+        @plugins[:builtin] = true if ENV.key?('CHEFDK_FLAVOR')
+      end
+
+      # returns the sole installed plugin if only one is found
+      # @return [Symbol,nil] the plugin if only one is installed,
+      #   nil otherwise
+      # @api private
+      def only_plugin
+        @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
+      def prompt_for_plugin
+        return nil unless @plugins.keys.size >= 1
+        require 'bogo-ui'
+        ui = Bogo::Ui.new(app_name: 'ChefGen Flavor Selector')
+        valid = plugin_selection(ui)
+        response = ui.ask_question('Enter selection').to_i
+        return valid[response.to_i] if valid[response]
+        ui.fatal 'Invalid flavor chosen'
+        fail 'Invalid ChefGen Flavor'
+      end
+
+      # 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
+      # @return [Hash] a hash of valid options
+      # @api private
+      def plugin_selection(ui)
+        output = [ui.color('Flavors on the menu', :bold)]
+        idx = 1
+        valid = {}
+        @plugins.each do |name, klass|
+          valid[idx] = name
+          if true == klass
+            output << "#{idx}. ChefDK built-in template"
+          else
+            output << "#{idx}. #{name}: #{klass.description}"
+          end
+          idx += 1
+        end
+        ui.info "#{output.join("\n")}\n"
+        valid
+      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
+    end
+  end
+end