chef-gen-flavors 0.6.2 → 0.7.0

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.6.2'
+    VERSION = '0.7.0'
 
     extend LittlePlugger path: 'chef_gen/flavor',
                          module: ChefGen::Flavor
@@ -18,7 +18,7 @@ module ChefGen
       # for the selected ChefGen Flavor
       # @return [String] the path to the code_generator cookbook
       def path
-        # then take a copy so we can augment it
+        # select the plugin to use
         @plugins = plugins.dup
         add_builtin_template
         selected = plugin_from_env ||
@@ -27,13 +27,27 @@ module ChefGen
                    fail('no ChefGen flavors found!')
         path = generator_path(selected)
         $stdout.puts "using ChefGen flavor '#{selected}' in #{path}"
-        copy = copy_generator_dir(path, selected)
-        ChefDK::Generator.add_attr_to_context('generator_path', copy)
+        # 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
       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)
+      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
@@ -94,15 +108,25 @@ module ChefGen
           if true == klass
             output << "#{idx}. ChefDK built-in template"
           else
-            descr = klass.respond_to?(:description) ? klass.description : ''
-            version = klass.const_defined?(:VERSION) ? "v#{klass.const_get(:VERSION, false)}" : ''
-            output << "#{idx}. #{name}: #{descr} #{version}"
+            output << "#{idx}. #{name}: #{plugin_descr(klass)}"
           end
           idx += 1
         end
         ui.info "#{output.join("\n")}\n"
         valid
       end
+
+      # builds the description of a flavor for the menu
+      # @param klass [Class] the class of the flavor
+      # @return [String] the flavor description with version if available
+      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
+      end
+
       # :nocov:
 
       # returns the path to the code_generator cookbook for the
@@ -167,11 +191,13 @@ module ChefGen
       # 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, selected)
+      def copy_generator_dir(srcdir)
         dstdir = Dir.mktmpdir('chefgen_flavor.')
-        at_exit {
+        at_exit do
           FileUtils.rm_rf(dstdir)
-        } unless ENV.key?('CHEFGEN_NOCLEANTMP')
+        end unless ENV.key?('CHEFGEN_NOCLEANTMP')
+        $stdout.puts srcdir
+        $stdout.puts dstdir
         FileUtils.cp_r(srcdir, dstdir)
         File.join(dstdir, File.basename(srcdir))
       end

data/lib/chef_gen/snippet/attributes.rb

@@ -17,6 +17,19 @@ module ChefGen
       def snippet_attributes_files(recipe)
         @templates_if_missing << File.join('attributes', 'default.rb')
       end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_attribute_files(path)
+        copy_snippet_file(
+          File.join(
+            File.dirname(__FILE__), '..', '..', '..',
+            'shared', 'snippet', 'attributes', 'attributes_default_rb.erb'
+          ),
+          File.join(path, 'templates', 'default', 'attributes_default_rb.erb')
+        )
+      end
     end
   end
 end

data/lib/chef_gen/snippet/chef_spec.rb

@@ -2,39 +2,109 @@ module ChefGen
   module Snippet
     # creates a framework for ChefSpec unit testing
     module ChefSpec
-      # declares the .rspec file
+      # declares directories
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_chefspec_dotrspec(recipe)
+      def snippet_chefspec_dirs(recipe)
+        @directories << 'spec'
+        @directories << File.join('spec', 'recipes')
+      end
+
+      # declares files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_files(recipe)
         @templates << '.rspec'
+        @templates_if_missing << File.join('spec', 'spec_helper.rb')
+        @templates_if_missing << File.join('spec', 'recipes', 'default_spec.rb')
+        @templates_if_missing << File.join('spec', 'chef_runner_context.rb')
       end
 
-      # declares the ChefSpec directories
+      # adds chefspec files to the git and chefignore patterns
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_chefspec_dirs(recipe)
-        @directories << 'spec'
-        @directories << File.join('spec', 'recipes')
+      def snippet_chefspec_ignore(recipe)
+        return unless respond_to?(:chefignore_patterns)
+        %w(
+          .rspec
+          spec/*
+          spec/fixtures/*
+        ).each do |e|
+          chefignore_patterns << e
+        end
       end
 
-      # declares the ChefSpec spec_helper
+      # adds chefspec gems to the Gemfile
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_chefspec_spechelper(recipe)
-        @templates_if_missing << File.join('spec', 'spec_helper.rb')
+      def snippet_chefspec_gems(recipe)
+        return unless respond_to?(:cookbook_gems)
+        cookbook_gems['chefspec'] = '~> 4.1'
+        cookbook_gems['guard-rspec'] = '~> 4.5'
+        cookbook_gems['ci_reporter_rspec'] = '~> 1.0'
+      end
+
+      # adds chefspec rake tasks to the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_chefspec_raketasks(recipe)
+        return unless respond_to?(:rake_tasks)
+        rake_tasks['chefspec'] = <<'END'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:chefspec)
+
+desc 'Generate ChefSpec coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task[:chefspec].invoke
+end
+task spec: :chefspec
+END
       end
 
-      # declares the default recipe spec
+      # adds chefspec sets to the Guardfile
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_chefspec_defaultrecipespec(recipe)
-        @templates_if_missing << File.join(
-          'spec', 'recipes', 'default_spec.rb'
-        )
+      def snippet_chefspec_guardsets(recipe)
+        return unless respond_to?(:guard_sets)
+        guard_sets['chefspec'] = <<'END'
+rspec_command = ENV.key?('DISABLE_PRY_RESCUE') ? 'rspec' : 'rescue rspec'
+guard :rspec, all_on_start: true, cmd: "bundle exec #{rspec_command}" do
+  watch(%r{^spec/recipes/.+_spec\.rb$})
+  watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+  watch(%r{^attributes/.+\.rb$})    { 'spec' }
+  watch(%r{^resources/.+\.rb$})     { 'spec' }
+  watch(%r{^providers/.+\.rb$})     { 'spec' }
+  watch(%r{^libraries/.+\.rb$})     { 'spec' }
+  watch(%r{^recipes/(.+)\.rb$})     { |m| "spec/recipes/#{m[1]}_spec.rb" }
+end
+END
+      end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_chefspec_files(path)
+        %w(
+          _rspec.erb
+          spec_spec_helper_rb.erb
+          spec_recipes_default_spec_rb.erb
+          spec_chef_runner_context_rb.erb
+        ).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'chef_spec', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+        end
       end
     end
   end

data/lib/chef_gen/snippet/cookbook_base.rb

@@ -1,63 +1,149 @@
+# rubocop:disable Metrics/MethodLength
+
 module ChefGen
   module Snippet
     # creates the basic files that every cookbook should have
     # each file is managed through a separate method to allow for
     # people to mix this in but turn off just one file
     module CookbookBase
-      # declares the Gemfile
+      # adds a Hash for gems to add to the gemfile
+      attr_reader :cookbook_gems
+
+      # adds an Array of gem sources, defaulting to rubygems
+      attr_reader :gem_sources
+
+      # adds an Array of berks sources, defaulting to supermarket
+      attr_reader :berks_sources
+
+      # adds a Hash of rake tasks
+      attr_reader :rake_tasks
+
+      # adds a Hash of guard sets
+      attr_reader :guard_sets
+
+      # initializes instance vars
+      def init_cookbookbase_instancevars
+        @gem_sources = %w(https://rubygems.org)
+        @berks_sources = %w(https://supermarket.chef.io)
+        @rake_tasks = {}
+        @guard_sets = {}
+        @cookbook_gems = {
+          rake: '~> 10.4',
+          pry: '~> 0.10',
+          'pry-byebug' => '~> 3.1',
+          'pry-rescue' => '~> 1.4',
+          'pry-stack_explorer' => '~> 0.4',
+          berkshelf: '~> 3.2',
+          guard: '~> 2.12'
+        }
+      end
+
+      # declares files
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_gemfile(recipe)
-        @templates << 'Gemfile'
+      def snippet_cookbookbase_files(recipe)
+        @templates_if_missing << 'metadata.rb'
+        @templates_if_missing << 'README.md'
+        @templates_if_missing << 'CHANGELOG.md'
       end
 
-      # declares the Berksfile
+      # declares the Gemfile with lazy evaluation of the gems
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_berksfile(recipe)
-        @templates << 'Berksfile'
+      def snippet_cookbookbase_gemfile(recipe)
+        gems = @cookbook_gems
+        sources = @gem_sources
+        # :nocov:
+        recipe.send(:template, File.join(@target_path, 'Gemfile')) do
+          helpers(ChefDK::Generator::TemplateHelper)
+          variables lazy { { gems: gems, sources: sources } }
+        end
+        # :nocov:
       end
 
-      # declares the Rakefile
+      # declares the Berksfile with lazy evaluation of the sources
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_rakefile(recipe)
-        @templates << 'Rakefile'
+      def snippet_cookbookbase_berksfile(recipe)
+        sources = @berks_sources
+        # :nocov:
+        recipe.send(:template, File.join(@target_path, 'Berksfile')) do
+          helpers(ChefDK::Generator::TemplateHelper)
+          variables lazy { { sources: sources } }
+        end
+        # :nocov:
       end
 
-      # declares the Guardfile
+      # declares the Rakefile with lazy evaluation of the tasks
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_guardfile(recipe)
-        @templates << 'Guardfile'
+      def snippet_cookbookbase_rakefile(recipe)
+        tasks = @rake_tasks
+        # :nocov:
+        recipe.send(:template, File.join(@target_path, 'Rakefile')) do
+          helpers(ChefDK::Generator::TemplateHelper)
+          variables lazy { { tasks: tasks } }
+        end
+        # :nocov:
       end
 
-      # declares the metadata.rb file
+      # declares the Guardfile with lazy evaluation of the guards
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_metadata(recipe)
-        @templates_if_missing << 'metadata.rb'
+      def snippet_cookbookbase_guardfile(recipe)
+        guards = @guard_sets
+        # :nocov:
+        recipe.send(:template, File.join(@target_path, 'Guardfile')) do
+          helpers(ChefDK::Generator::TemplateHelper)
+          variables lazy { { guards: guards } }
+        end
+        # :nocov:
       end
 
-      # declares the README file
+      # adds base files to the git and chefignore patterns
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_cookbookbase_readme(recipe)
-        @templates_if_missing << 'README.md'
+      def snippet_cookbookbase_ignore(recipe)
+        return unless respond_to?(:chefignore_patterns)
+        %w(
+          Gemfile
+          Rakefile
+          Guardfile
+          Berksfile
+        ).each do |e|
+          chefignore_patterns << e
+        end
       end
 
-      # declares the CHANGELOG
-      # @param recipe [Chef::Recipe] the recipe into which resources
-      #   will be injected
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
       # @return [void]
-      def snippet_cookbookbase_changelog(recipe)
-        @templates_if_missing << 'CHANGELOG.md'
+      def content_cookbookbase_files(path)
+        %w(
+          Gemfile.erb
+          Berksfile.erb
+          Rakefile.erb
+          Guardfile.erb
+          metadata_rb.erb
+          README_md.erb
+          CHANGELOG_md.erb
+        ).each do |file|
+          # :nocov:
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'cookbookbase', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+          # :nocov:
+        end
       end
     end
   end

data/lib/chef_gen/snippet/example_file.rb

@@ -18,6 +18,21 @@ module ChefGen
       def snippet_examplefile_files(recipe)
         @files_if_missing << File.join('files', 'default', 'example.conf')
       end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_examplefile_files(path)
+        %w(files_default_example_conf).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'examplefile', file
+            ),
+            File.join(path, 'files', 'default', file)
+          )
+        end
+      end
     end
   end
 end

data/lib/chef_gen/snippet/example_template.rb

@@ -20,6 +20,21 @@ module ChefGen
           'templates', 'default', 'example.conf.erb'
         )
       end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_exampletemplate_files(path)
+        %w(templates_default_example_conf_erb).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'exampletemplate', file
+            ),
+            File.join(path, 'files', 'default', file)
+          )
+        end
+      end
     end
   end
 end