chef-gen-flavors 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 946c3722860ef01d69ca49847202671db1846c9b
+  data.tar.gz: a51977f890bb4ef7be75e79d441f0338ba078bdb
+SHA512:
+  metadata.gz: bb6c97a4fe43d518c45fdc5be85fc3c857524d79ac48a09417e160a6fafcfe4bb4f35df93ad725d602776d76d636be0a9191f97e7ef87c180820a3c94ffc12b5
+  data.tar.gz: 223a7f1f8652f75c5fa59eb1bd37e9cc56712550e5ea989b38f4ee446d1b74ace0c3f72cdfc0866fc697cbf7722a1ab5baf3185323837036e6a520d23bdbaacf

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+    - 'pkg/**/*'
+
+Style/RegexpLiteral:
+  Exclude:
+    - '**/Guardfile'
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 150
+
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/chef_gen/snippet/*.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.1.6"
+  - "2.2.2"
+install: bundle install --binstubs
+env: TRAVIS_BUILD=true

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org/'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,242 @@
+PATH
+  remote: .
+  specs:
+    chef-gen-flavors (0.3.0.20150514061941)
+      bogo-ui (~> 0.1)
+      little-plugger (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
+    bogo (0.1.22)
+      hashie
+      multi_json
+    bogo-ui (0.1.10)
+      bogo
+      command_line_reporter
+      paint
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    chef (12.3.0)
+      chef-zero (~> 4.1)
+      diff-lcs (~> 1.2, >= 1.2.4)
+      erubis (~> 2.7)
+      ffi-yajl (>= 1.2, < 3.0)
+      highline (~> 1.6, >= 1.6.9)
+      mixlib-authentication (~> 1.3)
+      mixlib-cli (~> 1.4)
+      mixlib-config (~> 2.0)
+      mixlib-log (~> 1.3)
+      mixlib-shellout (>= 2.0.0.rc.0, < 3.0)
+      net-ssh (~> 2.6)
+      net-ssh-multi (~> 1.1)
+      ohai (~> 8.0)
+      plist (~> 3.1.0)
+      pry (~> 0.9)
+      rspec-core (~> 3.2)
+      rspec-expectations (~> 3.2)
+      rspec-mocks (~> 3.2)
+      rspec_junit_formatter (~> 0.2.0)
+      serverspec (~> 2.7)
+      specinfra (~> 2.10)
+    chef-dk (0.5.1)
+      chef (~> 12.0, >= 12.2.1)
+      cookbook-omnifetch (~> 0.2)
+      diff-lcs (~> 1.0)
+      ffi-yajl (~> 1.0)
+      mixlib-cli (~> 1.5)
+      mixlib-shellout (>= 2.0.0.rc.0, < 3.0.0)
+      paint (~> 1.0)
+      solve (~> 1.2)
+    chef-zero (4.2.1)
+      ffi-yajl (>= 1.1, < 3.0)
+      hashie (~> 2.0)
+      mixlib-log (~> 1.3)
+      rack
+      uuidtools (~> 2.1)
+    coderay (1.1.0)
+    colored (1.2)
+    colorize (0.7.7)
+    command_line_reporter (3.3.5)
+      colored (>= 1.2)
+    cookbook-omnifetch (0.2.1)
+      minitar (~> 0.5.4)
+    dep-selector-libgecode (1.0.2)
+    dep_selector (1.0.3)
+      dep-selector-libgecode (~> 1.0)
+      ffi (~> 1.9)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    ffi (1.9.8)
+    ffi-yajl (1.4.0)
+      ffi (~> 1.5)
+      libyajl2 (~> 1.2)
+    formatador (0.2.5)
+    guard (2.12.5)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rake (0.0.10)
+      guard
+      rake
+    guard-rspec (4.5.0)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    guard-rubocop (1.2.0)
+      guard (~> 2.0)
+      rubocop (~> 0.20)
+    hashie (2.1.2)
+    highline (1.7.2)
+    hirb (0.7.3)
+    hitimes (1.2.2)
+    hoe (3.13.1)
+      rake (>= 0.8, < 11.0)
+    hoe-gemspec (1.0.0)
+      hoe (>= 2.2.0)
+    ipaddress (0.8.0)
+    json (1.8.2)
+    libyajl2 (1.2.0)
+    listen (2.10.0)
+      celluloid (~> 0.16.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    little-plugger (1.1.3)
+    lumberjack (1.0.9)
+    method_source (0.8.2)
+    mime-types (2.5)
+    minitar (0.5.4)
+    mixlib-authentication (1.3.0)
+      mixlib-log
+    mixlib-cli (1.5.0)
+    mixlib-config (2.1.0)
+    mixlib-log (1.6.0)
+    mixlib-shellout (2.0.1)
+    multi_json (1.11.0)
+    nenv (0.2.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    net-ssh-gateway (1.2.0)
+      net-ssh (>= 2.6.5)
+    net-ssh-multi (1.2.1)
+      net-ssh (>= 2.6.5)
+      net-ssh-gateway (>= 1.2.0)
+    notiffany (0.0.6)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    ohai (8.3.0)
+      ffi (~> 1.9)
+      ffi-yajl (>= 1.1, < 3.0)
+      ipaddress
+      mime-types (~> 2.0)
+      mixlib-cli
+      mixlib-config (~> 2.0)
+      mixlib-log
+      mixlib-shellout (~> 2.0)
+      rake (~> 10.1)
+      systemu (~> 2.6.4)
+      wmi-lite (~> 1.0)
+    paint (1.0.0)
+    parser (2.2.2.2)
+      ast (>= 1.1, < 3.0)
+    plist (3.1.0)
+    powerpack (0.1.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    rspec_junit_formatter (0.2.2)
+      builder (< 4)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.31.0)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+    semverse (1.2.1)
+    serverspec (2.15.0)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.31)
+    shellany (0.0.1)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-console (0.2.0)
+      colorize
+      hirb
+      simplecov
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    solve (1.2.1)
+      dep_selector (~> 1.0)
+      semverse (~> 1.1)
+    specinfra (2.31.0)
+      net-scp
+      net-ssh
+    systemu (2.6.5)
+    thor (0.19.1)
+    timers (4.0.1)
+      hitimes
+    uuidtools (2.1.5)
+    wmi-lite (1.0.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  chef-dk (~> 0.5)
+  chef-gen-flavors!
+  guard (~> 2.12)
+  guard-rake (~> 0.0)
+  guard-rspec (~> 4.2)
+  guard-rubocop (~> 1.2)
+  hoe (~> 3.13)
+  hoe-gemspec (~> 1.0)
+  rake (~> 10.3)
+  rdoc (~> 4.0)
+  rspec (~> 3.1)
+  simplecov (~> 0.9)
+  simplecov-console (~> 0.2)
+  yard (~> 0.8)

data/Guardfile

@@ -0,0 +1,15 @@
+# prevent dropping into pry when nothing is happening
+interactor :off
+
+guard :rubocop, all_on_start: true, cli: ['-D'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  watch('Gemfile')
+  watch('Rakefile')
+end
+
+guard :rspec, all_on_start: true, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/(.+)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/spec_helper.*\.rb$}) { 'spec' }
+end

data/History.md

@@ -0,0 +1,10 @@
+# Changelog for chef-gen-template
+
+## 0.3.0
+
+* renamed from ChefDK::Template::Plugin to ChefGen::Flavors at Chef's request so as to not pollute the ChefDK namespace
+  * 0.2.0 exists only with the old name as a transitional to remind people that the name has changed
+
+## 0.1.0
+
+* initial version

data/LICENSE

@@ -0,0 +1,15 @@
+# THE APACHE LICENSE, v2
+
+Copyright 2015 Nordstrom, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy
+of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.

data/Manifest.txt

@@ -0,0 +1,46 @@
+.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

data/README.md

@@ -0,0 +1,311 @@
+# chef-gen-flavors
+
+* home :: https://github.com/Nordstrom/chef-gen-flavors
+* license :: [Apache2](http://www.apache.org/licenses/LICENSE-2.0)
+* gem version :: [![Gem Version](https://badge.fury.io/rb/chef-gen-flavors.png)](http://badge.fury.io/rb/chef-gen-flavors)
+* build status :: [![Build Status](https://travis-ci.org/Nordstrom/chef-gen-flavors.png?branch=master)](https://travis-ci.org/Nordstrom/chef-gen-flavors)
+* code climate :: [![Code Climate](https://codeclimate.com/github/Nordstrom/chef-gen-flavors/badges/gpa.svg)](https://codeclimate.com/github/Nordstrom/chef-gen-flavors)
+* docs :: [![Inline docs](http://inch-ci.org/github/nordstrom/chef-gen-flavors.svg?branch=master)](http://inch-ci.org/github/nordstrom/chef-gen-flavors)
+
+## DESCRIPTION
+
+chef-gen-flavors is a framework for creating custom templates for the
+'chef generate' command provided by ChefDK.
+
+This gem simply provides a framework; templates are provided by separate
+gems, which you can host privately for use within your organization or
+publicly for the Chef community to use.
+
+At present this is focused primarily on providing templates for generation of
+cookbooks, as this is where most organization-specific customization takes place.
+Support for the other artifacts that ChefDK can generate may work, but is not
+the focus of early releases.
+
+## INSTALLATION
+
+    chef gem install chef-gen-flavors
+
+You will also need to install at least one plugin, which may be distributed
+via Rubygems (in which case you install using `chef gem`) or as source, in
+which case you should refer to the installation documentation that comes with
+the plugin.
+
+## PREREQUISITES
+
+This gem requires that you have [ChefDK](https://downloads.chef.io/chef-dk/)
+(at least version 0.3.6) installed. chef-dk is not a dependency of this gem
+because chef-dk should always be installed using the omnibus packages
+provided by Chef, not as a gem.
+
+## CONFIGURATION
+
+In your `knife.rb` file, add this snippet:
+
+    unless chefdk.nil?
+      require 'chef_gen/template'
+      chefdk.generator_cookbook = ChefGen::Flavors.path
+    end
+
+When you run `chef generate`, all available plugins will be loaded. If more
+than one plugin is found, you will be prompted as to which you want to use:
+
+    $ chef generate cookbook my_app
+
+If you set the environment variable `CHEFGEN_TEMPLATE` to the name of a
+plugin, it will be chosen instead of presenting a prompt:
+
+    $ CHEFGEN_TEMPLATE=mytemplate chef generate cookbook my_app
+
+## USING THE BUILT-IN CHEFDK TEMPLATE
+
+By default, this gem does not offer the built-in ChefDK template as an
+option. By setting the environment variable CHEFDK_FLAVOR, the
+option `builtin` will be offered.
+
+## TERMINOLOGY
+
+(because everything in the Chef ecosystem has to have foodie names)
+
+* Flavor - a type of template.  Provided by a plugin in the namespace `ChefGen::Flavor::`.  Flavors can be distributed as ruby gems inside or outside of your organization.
+* Snippet - a small piece of a code_generator cookbook that flavors can compose together to avoid repeating themselves.  Nominally provided by a module in the namespace `ChefGen::Snippet::`, but can be defined in any module.  chef-gen-flavors comes with several common snippets, but you can create your own and package them as standalone gems or as part of a flavor gem
+
+## FLAVORS
+
+This gem uses [little-plugger](https://rubygems.org/gems/little-plugger) to
+make adding template flavors easy. Each flavor is defined by a plugin named
+using [little-pluggers's
+rules](https://github.com/TwP/little-plugger/blob/little-plugger-1.1.2/lib/little-plugger.rb#L13-25).
+
+The plugin must define a class inside the naming hierarchy
+`ChefGen::Flavor::`. The class name should be the filename converted to
+CamelCase (e.g. `foo_bar.rb` = `FooBar`)
+
+The name of the module must not be in all caps, as little-plugger ignores
+these (assuming that they are constants).
+
+Plugins must also define a class method named `description`, which is used
+both to find the path to the file that defines the plugin and in the prompt
+displayed when more than one plugin is available.
+
+You do not have to `require` your plugin; little-plugger searches all
+installed gems for files matching the globspec.
+
+## EXAMPLE FLAVOR STRUCTURE
+
+This example defines a flavor named `Example`. It can only generate
+cookbooks, as its code_generator cookbook contains no other recipes.
+
+A functional copy of this plugin is available on rubygems as
+`chef-gen-flavor-example`.
+
+The directory structure of a plugin looks like this:
+
+    chef-gen-flavor-example
+    ├── code_generator
+    │   ├── files
+    │   │   └── default
+    │   ├── metadata.rb
+    │   ├── recipes
+    │   │   └── cookbook.rb
+    │   └── templates
+    │       └── default
+    └── lib
+        └── chef_gen
+            └── flavor
+                └── example.rb
+
+## ALTERNATE code_generator PATHS
+
+By default, the code_generator cookbook is assumed to live in a directory
+named `code_generator` four levels higher than the path of the file
+definining the plugin.
+
+To specify that the code_generator cookbook lives elsewhere, define a class
+method named `code_generator_path` which takes one argument (the path to the
+plugin class) and returns the path to the code_generator cookbook. If the
+`Example` plugin wanted to place the code_generator cookbook in a directory
+named `template` instead of `code_generator`, it would define an instance
+method like this:
+
+    module ChefGen
+      module Flavor
+        class Example
+          class << self
+            def description
+              'example cookbook template'
+            end
+
+            def code_generator_path(classfile)
+              File.expand_path(
+                File.join(
+                  classfile,
+                  '..', '..', '..', '..',
+                  'template'
+                )
+              )
+            end
+          end
+        end
+      end
+    end
+
+For compatibility with all platforms supported by ChefDK, plugins should use
+the methods in the `File` class to construct relative paths rather than
+assuming what the path separator should be.
+
+## FLAVOR BASE CLASS
+
+Inside of your plugin's code_generator cookbook, you can do anything that
+chef-solo can do. If you aren't familiar with the mechanics of the default
+generators that comes with chef-dk, you should study [those
+recipes](https://github.com/chef/chef-dk/tree/0.5.1/lib/chef-dk/skeletons/code_generator)
+first before attempting to create your own.
+
+To make the job of authoring a custom template easier, this gem comes with a
+base class that plugins can inherit from. This provides some useful
+features:
+
+* helpers to create directories and render files and templates using simple name translation
+* the ability to create and use snippets that set up commonly used functionality (i.e. ChefSpec or Test Kitchen)
+* the ability to prevent files from being overwritten when a template is being applied overtop an existing cookbook
+
+To use the base class, make it a dependency of your gem and inherit from it:
+
+    require 'chef_gen/flavor_base'
+
+    module ChefGen
+      module Flavor
+        class Amazing < FlavorBase
+        end
+      end
+    end
+
+Then in one of your generator recipes like `recipes/cookbook.rb`, create
+an instance of your plugin, passing the recipe into which resources will
+be injected:
+
+    template = ChefGen::Flavor::Amazing.new(self)
+
+The plugin has several helper methods you can use:
+
+* `target_path` returns the full path to the target directory
+* `directories` is a `Array` of directories to create
+* `files` is an `Array` of files to create
+* `files_if_missing` is an `Array` of files to create which should not be overwritten if they exist
+* `templates` is an `Array` of templates to render
+* `templates_if_missing` is an `Array` of templates to render which should not be overwritten if they exist
+* `chefignore_files` is an `Array` of glob patterns to write to the `chefignore` file.  If this array is empty, the file is not created automatically (but templates can take this on themselves)
+* `gitignore_files` is an `Array` of glob patterns to write to the `.gitignore` file.  If this array is empty, the file is not created automatically (but templates can take this on themselves)
+* `fail_on_clobber` is a boolean accessor which causes generation to fail if any files in the `files` or `templates` arrays already exist.  Defaults to true, but can be set to false by adding `-a clobber` to the `chef generate` command line
+* `report_actions` is a boolean accessor which causes the generator to report all of the actions it took
+* `next_steps` is a message to be displayed to the user as the last thing the generator does
+
+The distinction between files that are overwritten and those that are
+created only if they do not exist allows for updating a cookbook to an
+organization-wide policy while still allowing for per-cookbook
+customization.
+
+For example, if your cookbook template has a standard Rakefile and you wish
+to add a target to it, you can do so if Rakefile is in the `files` array.
+When the generator is used on top of an existing cookbook, the Rakefile will
+be rewritten. Custom rake tasks can be placed in `.rake` files in the
+directory `lib/tasks`, which will not be overwritten.
+
+Once the template object has been set up to your satisfaction, call the
+`#generate` method, which creates the Chef resources to generate your
+target.
+
+The list of files and templates take the path to the rendered file (e.g.
+`spec/spec_helper.rb`). The source for the file or template will be
+transformed by replacing foreward slashes and dots with underscores.
+Additionally, templates have `.erb` appended to the source.
+
+This code:
+
+    template = ChefGen::Flavor::Amazing.new
+    template.files << 'spec/spec_helper.rb'
+    template.templates << '.rubocop.yml'
+    template.generate
+
+is equivalent to manually creating these resources:
+
+    file "#{cookbook_dir}/spec/spec_helper.rb" do
+      source 'spec_spec_helper_rb'
+    end
+
+    template "#{cookbook_dir}/.rubocop.yml" do
+      source '_rubocop_yml.erb'
+    end
+
+### TEMPLATE SNIPPETS
+
+Many templates will use common patterns, such as providing a README.md and
+CHANGELOG.md, providing the files necessary to create a ChefSpec unit
+testing suite, or the files necessary to create a Test Kitchen integration
+testing suite.
+
+Rather than have every template author create these, this gem ships with a
+number of snippets, which can be included in your plugin class like so:
+
+    require 'chef_gen/flavor'
+    require 'chef_gen/snippets'
+
+    module ChefGen
+      module Flavor
+        class Amazing < FlavorBase
+          include ChefGen::Snippet::ChefSpec
+        end
+      end
+    end
+
+The snippets that ship with this gem are:
+
+* `CookbookBase` - sets up the basic files any cookbook needs (README, CHANGELOG, etc.)
+* `StyleRubocop` - sets up the files for style checking with Rubocop
+* `ChefSpec` - sets up the files for basic ChefSpec unit testing
+* `TestKitchen` - sets up the files for basic Test Kitchen integration testing
+* `Recipes` - creates recipes/default.rb
+* `Attributes` - creates attributes/default.rb
+* `ExampleFile` - creates files/default/example.conf
+* `ExampleTemplate` - creates templates/default/example.conf.erb
+* `ResourceProvider` - sets up a sample LWRP resource and provider
+
+You can also create your own snippet. A snippet is simply a module that
+provides some number of public methods prefixed with `snippet\_`. Any such
+methods will be called, passing the recipe object as the only parameter when
+`#generate` is called. For example, a simplified ChefSpec snippet might look
+like this:
+
+    module ChefGen
+      module Snippet
+        module ChefSpec
+          def snippet_chefspec(recipe)
+            @directories << 'spec'
+            @directories << File.join('spec', '/recipes')
+            @files << '.rspec'
+            @files << File.join('spec', 'spec_helper.rb')
+            @files << File.join('spec', 'recipes', 'default_spec.rb')
+          end
+        end
+      end
+    end
+
+## AUTHOR
+
+James FitzGibbon - james.i.fitzgibbon@nordstrom.com - Nordstrom, Inc.
+
+## LICENSE
+
+Copyright 2015 Nordstrom, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use this file except in compliance with the License. You may obtain a copy
+of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+License for the specific language governing permissions and limitations
+under the License.