chef-gen-flavor-base 0.9.0

data/lib/chef_gen/snippet/next_steps.rb

@@ -0,0 +1,44 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # provides an accessor with a block of text to be displayed at
+    # the end of the generate phase; normally used to give the user
+    # some information about how to proceed.  When used in conjunction
+    # with the ActionsTaken snippet, care should be taken to put this
+    # snippet after it in the list so that the next steps is the last
+    # thing that the user sees
+    class NextSteps < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'next_steps'
+
+      private
+
+      # @!attribute [rw] next_steps
+      #   @return [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, :next_steps)
+        hook_display_next_steps
+      end
+
+      # adds an after hook to declare resources to report on actions taken
+      # @return [void]
+      # @api private
+      def hook_display_next_steps
+        @flavor.class.after_add_resources do
+          steps = next_steps
+          @recipe.send(:ruby_block, 'display_next_steps') do
+            # :nocov:
+            block { $stdout.puts steps }
+            # :nocov:
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/no_clobber.rb

@@ -0,0 +1,62 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # disallows overwrite of @files and @templates unless -a clobber
+    # is passed on the command line
+    class NoClobber < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'no_clobber'
+
+      # @!attribute [rw] fail_on_clobber
+      #   @return [Boolean] whether to fail on attempted clobber
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.send(:attr_accessor, :fail_on_clobber)
+
+        # default is false if '-a clobber' was passed, true otherwise
+        c = ChefDK::Generator.context
+        @flavor.fail_on_clobber = !c.respond_to?(:clobber)
+
+        hook_add_files
+        hook_add_templates
+      end
+
+      # adds a hook before add_files to fail on clobber
+      # @return [void]
+      # @api private
+      def hook_add_files
+        @flavor.class.before_add_files do |files, resource_action|
+          if :create == resource_action && fail_on_clobber
+            files.each do |file|
+              if File.exist?(destination_path(file))
+                fail "tried to overwrite file #{file}; pass '-a clobber' to override"
+              end
+            end
+          end
+        end
+      end
+
+      # adds a hook before add_templates to fail on clobber
+      # @return [void]
+      # @api private
+      def hook_add_templates
+        @flavor.class.before_add_templates do |templates, resource_action|
+          if :create == resource_action && fail_on_clobber
+            templates.each do |template|
+              if File.exist?(destination_path(template))
+                fail "tried to overwrite file #{template}; pass '-a clobber' to override"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/recipes.rb

@@ -0,0 +1,35 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # a cookbook that has recipes
+    class Recipes < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'recipes'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          directories << 'recipes'
+          templates_if_missing << File.join('recipes', 'default.rb')
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/resource_provider.rb

@@ -0,0 +1,37 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # a cookbook that has provides resources and providers
+    class ResourceProvider < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'resource_provider'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          directories << 'resources'
+          directories << 'providers'
+          templates_if_missing << File.join('resources', 'default.rb')
+          templates_if_missing << File.join('providers', 'default.rb')
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/standard_ignore.rb

@@ -0,0 +1,85 @@
+require 'chef_gen/snippet_base'
+
+require 'chef/mixin/params_validate'
+
+module ChefGen
+  module Snippet
+    # populates the list of ignore patterns for chefignore and .gitignore
+    class StandardIgnore < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'standard_ignore'
+
+      # @!attribute [rw] chefignore_patterns
+      #   @return [Array<String>] a list of patterns for chefignore
+
+      # @!attribute [rw] gitignore_patterns
+      #   @return [Array<String>] a list of patterns for .gitignore
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        add_accessors
+        declare_chefignore
+        declare_gitignore
+      end
+
+      # adds accessors to the flavor for chefignore and gitignore patterns
+      # @return [void]
+      # @api private
+      def add_accessors
+        @flavor.class.send(:attr_accessor, :chefignore_patterns)
+        @flavor.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/* tmp/*
+        )
+
+        @flavor.class.send(:attr_accessor, :gitignore_patterns)
+        @flavor.gitignore_patterns = %w(
+          *~ *# .#* \#*# .*.sw[az] *.un~
+          bin/* .bundle/* tmp/*
+        )
+      end
+
+      # add the chefignore file resource, with content from the list
+      # of patterns in the instance var set to reasonable defaults
+      # and lazily evaluated
+      # @return [void]
+      # @api private
+      def declare_chefignore
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          content = Chef::DelayedEvaluator.new do
+            chefignore_patterns.sort.uniq.join("\n") + "\n"
+          end
+          # :nocov:
+          add_files(%w(chefignore), :create_if_missing, :file, content: content)
+        end
+      end
+
+      # add the .gitignore file resource, with content from the list
+      # of patterns in the instance var set to reasonable defaults
+      # and lazily evaluated
+      # @return [void]
+      # @api private
+      def declare_gitignore
+        @flavor.class.do_declare_resources do
+          # :nocov:
+          content = Chef::DelayedEvaluator.new do
+            gitignore_patterns.sort.uniq.join("\n") + "\n"
+          end
+          # :nocov:
+          add_files(%w(.gitignore), :create_if_missing, :file, content: content)
+        end
+      end
+    end
+  end
+end

data/lib/chef_gen/snippet/style_foodcritic.rb

@@ -0,0 +1,73 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # sets up style testing using Foodcritic
+    class StyleFoodcritic < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'style_foodcritic'
+
+      private
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        declare_cookbook_gems
+        declare_rake_tasks
+        declare_guard_sets
+      end
+
+      # declares cookbook_gems if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_cookbook_gems
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            cookbook_gems['foodcritic'] = '~> 4.0'
+            cookbook_gems['guard-foodcritic'] = '~> 1.1'
+          end
+        end
+      end
+
+      # declares rake tasks if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_rake_tasks
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            rake_tasks['foodcritic'] = <<'END'
+require 'foodcritic'
+require 'foodcritic/rake_task'
+
+FoodCritic::Rake::LintTask.new(:foodcritic)
+task style: :foodcritic
+END
+          end
+        end
+      end
+
+      # declares guard sets if the flavor supports it
+      # @return [void]
+      def declare_guard_sets
+        @flavor.class.do_declare_resources do
+          if snippet?('guard')
+            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
+  end
+end

data/lib/chef_gen/snippet/style_rubocop.rb

@@ -0,0 +1,115 @@
+require 'chef_gen/snippet_base'
+
+module ChefGen
+  module Snippet
+    # sets up style testing using Rubocop
+    class StyleRubocop < ChefGen::SnippetBase
+      # the name of the snippet
+      NAME = 'style_rubocop'
+
+      private
+
+      # initializes the snippet in setup mode
+      # @return [void]
+      # @api private
+      def initialize_setup
+        super
+        snippet_content_path = File.expand_path(File.join(static_content_path(__FILE__))) + '/.'
+        @flavor.class.do_add_content do
+          tocopy << [snippet_content_path]
+        end
+      end
+
+      # initializes the snippet in generate mode
+      # @return [void]
+      # @api private
+      def initialize_generate
+        super
+        @flavor.class.do_declare_resources do
+          templates << '.rubocop.yml'
+        end
+        declare_chefignore_patterns
+        declare_cookbook_gems
+        declare_rake_tasks
+        declare_guard_sets
+      end
+
+      # declares chefignore patterns if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_chefignore_patterns
+        @flavor.class.do_declare_resources do
+          chefignore_patterns << '.rubocop.yml' if snippet?('standard_ignore')
+        end
+      end
+
+      # declares cookbook_gems if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_cookbook_gems
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            cookbook_gems['rubocop'] = '~> 0.34'
+            cookbook_gems['guard-rubocop'] = '~> 1.1'
+          end
+        end
+      end
+
+      # declares rake tasks if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_rake_tasks
+        @flavor.class.do_declare_resources do
+          if snippet?('cookbook_base')
+            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
+        end
+      end
+
+      # declares guard sets if the flavor supports it
+      # @return [void]
+      # @api private
+      def declare_guard_sets
+        @flavor.class.do_declare_resources do
+          if snippet?('guard')
+            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
+  end
+end