chef-gen-flavors 0.6.2 → 0.7.0

data/lib/chef_gen/snippet/git_init.rb

@@ -9,10 +9,12 @@ module ChefGen
       def snippet_gitinit(recipe)
         c = generator_context
         target_path = @target_path
+        # :nocov:
         recipe.send(:execute, 'initialize git repo') do
           command('git init .')
           cwd target_path
         end if c.have_git && !c.skip_git_init
+        # :nocov:
       end
     end
   end

data/lib/chef_gen/snippet/recipes.rb

@@ -17,6 +17,21 @@ module ChefGen
       def snippet_recipes_files(recipe)
         @templates_if_missing << File.join('recipes', 'default.rb')
       end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_recipes_files(path)
+        %w(recipes_default_rb.erb).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'recipes', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+        end
+      end
     end
   end
 end

data/lib/chef_gen/snippet/resource_provider.rb

@@ -19,6 +19,24 @@ module ChefGen
         @templates_if_missing << File.join('resources', 'default.rb')
         @templates_if_missing << File.join('providers', 'default.rb')
       end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_resourceprovider_files(path)
+        %w(
+          resources_default_rb.erb
+          providers_default_rb.erb
+        ).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'resourceprovider', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+        end
+      end
     end
   end
 end

data/lib/chef_gen/snippet/standard_ignore.rb

@@ -3,94 +3,70 @@ module ChefGen
   module Snippet
     # populates the list of ignore patterns for chefignore and .gitignore
     module StandardIgnore
-      # adds ignore patterns for chefignore
+      # adds an array for chefignore patterns
+      attr_reader :chefignore_patterns
+
+      # adds an array for gitignore patterns
+      attr_reader :gitignore_patterns
+
+      # initializes the pattern arrays
+      def init_standardignore_instancevars
+        @chefignore_patterns = %w(
+          .DS_Store Icon? nohup.out ehthumbs.db Thumbs.db
+          .sasscache \#* .#* *~ *.sw[az] *.bak REVISION TAGS*
+          tmtags *_flymake.* *_flymake *.tmproj .project .settings
+          mkmf.log a.out *.o *.pyc *.so *.com *.class *.dll
+          *.exe */rdoc/ .watchr  test/* features/* Procfile
+          .git */.git .gitignore .gitmodules .gitconfig .gitattributes
+          .svn */.bzr/* */.hg/*
+        )
+        @gitignore_patterns = %w(
+          Berksfile.lock *~ *# .#* \#*# .*.sw[az] *.un~
+          bin/* .bundle/*
+        )
+      end
+
+      # rubocop:disable Metrics/AbcSize
+
+      # declares ignore files
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_standardignore_files(recipe)
+        add_chefignore_resource(recipe)
+        add_gitignore_resource(recipe)
+      end
+
+      private
+
+      # add the chefignore file resource, with content from the list
+      # of patterns in the instance var set to reasonable defaults
+      # and lazily evaluated
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_standardignore_chefignore(recipe)
-        @chefignore_files << <<END.split("\n")
-.DS_Store
-Icon?
-nohup.out
-ehthumbs.db
-Thumbs.db
-.sass-cache
-\#*
-.#*
-*~
-*.sw[a-z]
-*.bak
-REVISION
-TAGS*
-tmtags
-*_flymake.*
-*_flymake
-*.tmproj
-.project
-.settings
-mkmf.log
-a.out
-*.o
-*.pyc
-*.so
-*.com
-*.class
-*.dll
-*.exe
-*/rdoc/
-.watchr
-.rspec
-spec/*
-spec/fixtures/*
-test/*
-features/*
-Guardfile
-Procfile
-.git
-*/.git
-.gitignore
-.gitmodules
-.gitconfig
-.gitattributes
-.svn
-*/.bzr/*
-*/.hg/*
-*/.svn/*
-Berksfile
-Berksfile.lock
-cookbooks/*
-tmp
-CONTRIBUTING
-Colanderfile
-Strainerfile
-.colander
-.strainer
-.vagrant
-Vagrantfile
-.travis.yml
-END
+      def add_chefignore_resource(recipe)
+        patterns = @chefignore_patterns
+        # :nocov:
+        recipe.send(:file, File.join(@target_path, 'chefignore')) do
+          content lazy { patterns.sort.uniq.join("\n") + "\n" }
+        end
+        # :nocov:
       end
 
-      # adds ignore patterns for .gitignore
+      # add the .gitignore file resource, with content from the list
+      # of patterns in the instance var set to reasonable defaults
+      # and lazily evaluated
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_standardignore_gitignore(recipe)
-        @gitignore_files << <<END.split("\n")
-.vagrant
-Berksfile.lock
-*~
-*#
-.#*
-\#*#
-.*.sw[a-z]
-*.un~
-Gemfile.lock
-bin/*
-.bundle/*
-.kitchen/
-.kitchen.local.yml
-END
+      def add_gitignore_resource(recipe)
+        patterns = @gitignore_patterns
+        # :nocov:
+        recipe.send(:file, File.join(@target_path, '.gitignore')) do
+          content lazy { patterns.sort.uniq.join("\n") + "\n" }
+        end
+        # :nocov:
       end
     end
   end

data/lib/chef_gen/snippet/style_foodcritic.rb

@@ -0,0 +1,51 @@
+module ChefGen
+  module Snippet
+    # sets up style testing using Foodcritic
+    module StyleFoodcritic
+      # adds foodcritic gems to the Gemfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_stylefoodcritic_gems(recipe)
+        return unless respond_to?(:cookbook_gems)
+        cookbook_gems['foodcritic'] = '~> 4.0'
+        cookbook_gems['guard-foodcritic'] = '~> 1.1'
+      end
+
+      # adds foodcritic rake tasks to the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_foodcritic_raketasks(recipe)
+        return unless respond_to?(:rake_tasks)
+        rake_tasks['foodcritic'] = <<'END'
+require 'foodcritic'
+require 'foodcritic/rake_task'
+
+FoodCritic::Rake::LintTask.new(:foodcritic)
+task style: :foodcritic
+END
+      end
+
+      # adds foodcritic sets to the Guardfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_foodcritic_guardsets(recipe)
+        return unless respond_to?(:guard_sets)
+        guard_sets['foodcritic'] = <<'END'
+guard :foodcritic,
+      cookbook_paths: '.',
+      cli: '-f any -X spec -X test -X features' do
+  watch(%r{^attributes/.+\.rb$})
+  watch(%r{^resources/.+\.rb$})
+  watch(%r{^providers/.+\.rb$})
+  watch(%r{^libraries/.+\.rb$})
+  watch(%r{^recipes/.+\.rb$})
+  watch(%r{^metadata\.rb$})
+end
+END
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/style_rubocop.rb

@@ -9,6 +9,86 @@ module ChefGen
       def snippet_stylerubocop_config(recipe)
         @templates_if_missing << '.rubocop.yml'
       end
+
+      # adds rubocop gems to the Gemfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_stylerubocop_gems(recipe)
+        return unless respond_to?(:cookbook_gems)
+        cookbook_gems['rubocop'] = '~> 0.31'
+        cookbook_gems['guard-rubocop'] = '~> 1.1'
+      end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_stylerubocop_files(path)
+        %w(_rubocop_yml.erb).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'stylerubocop', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+
+      # adds rubocop rake tasks to the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_rubocop_raketasks(recipe)
+        return unless respond_to?(:rake_tasks)
+        rake_tasks['rubocop'] = <<'END'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.formatters = ['progress']
+  t.options = ['-D']
+  t.patterns = %w(
+    attributes/*.rb
+    recipes/*.rb
+    libraries/**/*.rb
+    resources/*.rb
+    providers/*.rb
+    spec/**/*.rb
+    test/**/*.rb
+    ./metadata.rb
+    ./Berksfile
+    ./Gemfile
+    ./Rakefile
+  )
+end
+task style: :rubocop
+END
+      end
+
+      # adds rubocop sets to the Guardfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_rubocop_guardsets(recipe)
+        return unless respond_to?(:guard_sets)
+        guard_sets['rubocop'] = <<'END'
+guard :rubocop, all_on_start: true, cli: ['-f', 'p', '-D'] do
+  watch(%r{^attributes/.+\.rb$})
+  watch(%r{^recipes/.+\.rb$})
+  watch(%r{^libraries/.+\.rb$})
+  watch(%r{^resources/.+\.rb$})
+  watch(%r{^providers/.+\.rb$})
+  watch(%r{^spec/.+\.rb$})
+  watch(%r{^test/.+\.rb$})
+  watch(%r{^metadata\.rb$})
+  watch(%r{^Berksfile$})
+  watch(%r{^Gemfile$})
+  watch(%r{^Rakefile$})
+end
+END
+      end
     end
   end
 end

data/lib/chef_gen/snippet/style_tailor.rb

@@ -0,0 +1,48 @@
+module ChefGen
+  module Snippet
+    # sets up style testing using Tailor
+    module StyleTailor
+      # adds tailor gems to the Gemfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_styletailor_gems(recipe)
+        return unless respond_to?(:cookbook_gems)
+        cookbook_gems['tailor'] = '~> 1.4'
+        cookbook_gems['guard-rake'] = '~> 0.0'
+      end
+
+      # rubocop:disable Metrics/MethodLength
+
+      # adds tailor rake tasks to the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_tailor_raketasks(recipe)
+        return unless respond_to?(:rake_tasks)
+        rake_tasks['tailor'] = <<'END'
+require 'tailor/rake_task'
+Tailor::RakeTask.new do |t|
+  {
+    spec:        'spec/recipes/*_spec.rb',
+    spec_helper: 'spec/spec_helper.rb',
+    attributes:  'attributes/*.rb',
+    resources:   'resources/*.rb',
+    providers:   'providers/*.rb',
+    libraries:   'libraries/**/*.rb',
+    recipes:     'recipes/*.rb',
+    metadata:    'metadata.rb'
+  }.each do |name, glob|
+    t.file_set glob, name do |s|
+      s.max_line_length 1000
+      s.max_code_lines_in_method 1000
+      s.max_code_lines_in_class 1000
+    end
+  end
+end
+task style: :tailor
+END
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/test_kitchen.rb

@@ -1,15 +1,8 @@
+# rubocop:disable Metrics/MethodLength
 module ChefGen
   module Snippet
     # creates a framework for Test Kitchen integration testing
     module TestKitchen
-      # declares the Test Kitchen config
-      # @param recipe [Chef::Recipe] the recipe into which resources
-      #   will be injected
-      # @return [void]
-      def snippet_testkitchen_config(recipe)
-        @templates_if_missing << '.kitchen.yml'
-      end
-
       # declares directories
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
@@ -26,24 +19,86 @@ module ChefGen
         )
       end
 
-      # declares the Test Kitchen spec helper
+      # declares the Test Kitchen config
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_testkitchen_spechelper(recipe)
+      def snippet_testkitchen_files(recipe)
+        @templates_if_missing << '.kitchen.yml'
         @templates_if_missing << File.join(
           'test', 'integration', 'default', 'serverspec', 'spec_helper.rb'
         )
+        @templates_if_missing << File.join(
+          'test', 'integration', 'default', 'serverspec',
+          'recipes', 'default_spec.rb'
+        )
       end
 
-      # declares the Test Kitchen default recipe spec
+      # adds testkitchen to the git and chefignore patterns
       # @param recipe [Chef::Recipe] the recipe into which resources
       #   will be injected
       # @return [void]
-      def snippet_testkitchen_defaultrecipespec(recipe)
-        @templates_if_missing << File.join(
-          'test', 'integration', 'default', 'serverspec',
-          'recipes', 'default_spec.rb'
+      def snippet_testkitchen_ignore(recipe)
+        %w(
+          .vagrant
+          .kitchen/
+          .kitchen.local.yml
+        ).each do |e|
+          gitignore_patterns << e if respond_to?(:gitignore_patterns)
+          chefignore_patterns << e if respond_to?(:chefignore_patterns)
+        end
+      end
+
+      # adds testkitchen gems to the Gemfile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_gems(recipe)
+        return unless respond_to?(:cookbook_gems)
+        cookbook_gems['test-kitchen'] = '~> 1.4'
+        cookbook_gems['kitchen-vagrant'] = '~> 0.16'
+      end
+
+      # adds testkitchen rake tasks to the Rakefile
+      # @param recipe [Chef::Recipe] the recipe into which resources
+      #   will be injected
+      # @return [void]
+      def snippet_testkitchen_raketasks(recipe)
+        return unless respond_to?(:rake_tasks)
+        rake_tasks['testkitchen'] = <<'END'
+require 'kitchen/rake_tasks'
+begin
+  Kitchen::RakeTasks.new
+rescue LoadError
+  puts 'test-kitchen initialization failed; disabling kitchen tasks'
+end
+task integration: 'kitchen:all'
+END
+      end
+
+      # copies snippet content
+      # @param path [String] the path to the temporary generator cookbook
+      # @return [void]
+      def content_testkitchen_files(path)
+        %w(
+          _kitchen_yml.erb
+          test_integration_default_serverspec_spec_helper_rb.erb
+          test_integration_default_serverspec_recipes_default_spec_rb.erb
+        ).each do |file|
+          copy_snippet_file(
+            File.join(
+              File.dirname(__FILE__), '..', '..', '..',
+              'shared', 'snippet', 'testkitchen', file
+            ),
+            File.join(path, 'templates', 'default', file)
+          )
+        end
+        copy_snippet_file(
+          File.join(
+            File.dirname(__FILE__), '..', '..', '..',
+            'shared', 'snippet', 'testkitchen', 'libraries_kitchen_helper_rb'
+          ),
+          File.join(path, 'libraries', 'kitchen_helper.rb')
         )
       end
     end