chef-gen-flavor-example 0.2.0

data/code_generator/templates/default/_kitchen_yml.erb

@@ -0,0 +1,28 @@
+<%% proxy_vars = {} %>
+<%% %w(http_proxy https_proxy no_proxy).each do |envvar| %>
+<%%   if ENV.key?(envvar) %>
+<%%     proxy_vars[envvar] = ENV[envvar] %>
+<%%   end %>
+<%% end %>
+---
+driver:
+  name: vagrant
+
+<%% if proxy_vars.size > 0 %>
+driver_config:
+<%= kitchen_proxy_vars(2) %>
+<%% end %>
+
+provisioner:
+  name: chef_zero
+  client_rb:
+<%= kitchen_proxy_vars(4) %>
+
+platforms:
+  - name: ubuntu-14.04
+  - name: centos-6.6
+
+suites:
+  - name: default
+    run_list:
+      - recipe[<%= cookbook_name %>::default]

data/code_generator/templates/default/_rspec.erb

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

data/code_generator/templates/default/_rubocop_yml.erb

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+
+Style/SingleSpaceBeforeFirstArg:
+  Exclude:
+    - '**/Berksfile'
+    - '**/metadata.rb'
+
+Style/FileName:
+  Exclude:
+    - '**/Gemfile'
+    - '**/Berksfile'
+
+Style/RegexpLiteral:
+  Exclude:
+    - '**/Guardfile'

data/code_generator/templates/default/attributes_default_rb.erb

@@ -0,0 +1,8 @@
+#
+# Cookbook <%= cookbook_name %>
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+# replace these with something real
+default['<%= cookbook_name %>']['attribute_1'] = 'foo'
+default['<%= cookbook_name %>']['attribute_2'] = 'bar'

data/code_generator/templates/default/metadata_rb.erb

@@ -0,0 +1,10 @@
+#
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+name             '<%= cookbook_name %>'
+maintainer       '<%= copyright_holder %>'
+maintainer_email '<%= email %>'
+license          '<%= license %>'
+description      'Installs/Configures <%= cookbook_name %>'
+version          '0.1.0'

data/code_generator/templates/default/recipes_default_rb.erb

@@ -0,0 +1,9 @@
+#
+# Recipe: <%= cookbook_name %>::default
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+# a common pattern is to seperate the cookbook into distinct
+# recipes and pull them all in via the default recipe
+# include_recipe '<%= cookbook_name %>::recipe_a'
+# include_recipe '<%= cookbook_name %>::recipe_b'

data/code_generator/templates/default/spec_recipes_default_spec_rb.erb

@@ -0,0 +1,7 @@
+RSpec.describe '<%= cookbook_name %>::default' do
+  let(:chef_run) { ChefSpec::SoloRunner.new.converge(described_recipe) }
+
+  it 'converges successfully' do
+    expect(chef_run).to include_recipe(described_recipe)
+  end
+end

data/code_generator/templates/default/spec_spec_helper_rb.erb

@@ -0,0 +1,92 @@
+require 'chefspec'
+require 'chefspec/berkshelf'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+ChefSpec::Coverage.start! if ENV['COVERAGE']

data/code_generator/templates/default/test_integration_default_serverspec_recipes_default_spec_rb.erb

@@ -0,0 +1,16 @@
+#
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+require 'spec_helper'
+
+# this is a generic ServerSpec test.  It just runs 'whoami'
+# and confirms that it returns 'root'.  In a real test suite,
+# you would want to test things like directories, users,
+# processes, services, etc.
+#
+# for more information on the things ServerSpec can test, refer
+# to the documentation at http://serverspec.org
+describe command('whoami') do
+  its(:stdout) { should eq "root\n" }
+end

data/code_generator/templates/default/test_integration_default_serverspec_spec_helper_rb.erb

@@ -0,0 +1,7 @@
+#
+# Copyright (c) <%= year %> <%= copyright_holder %>
+#
+
+require 'serverspec'
+
+set :backend, :exec

data/lib/chef_gen/flavor/example.rb

@@ -0,0 +1,32 @@
+require 'chef_gen/flavor_base'
+require 'chef_gen/snippets'
+
+# chef generators
+module ChefGen
+  # a pluggable framework for distributing templates as ruby gems
+  module Flavor
+    # an example plugin for chef-gen-template
+    class Example < FlavorBase
+      include ChefGen::Snippet::CookbookBase
+      include ChefGen::Snippet::Attributes
+      include ChefGen::Snippet::Recipes
+      include ChefGen::Snippet::ChefSpec
+      include ChefGen::Snippet::TestKitchen
+      include ChefGen::Snippet::StandardIgnore
+      include ChefGen::Snippet::StyleRubocop
+      include ChefGen::Snippet::ExampleFile
+      include ChefGen::Snippet::ExampleTemplate
+
+      # the version of the gem
+      VERSION = '0.2.0'
+
+      class << self
+        # :nocov:
+        def description
+          'Example cookbook template'
+        end
+        # :nocov:
+      end
+    end
+  end
+end

data/spec/lib/chef_gen/flavor/example_spec.rb

@@ -0,0 +1,88 @@
+require 'chef_gen/flavor/example'
+
+RSpec.describe ChefGen::Flavor::Example do
+  before do
+    @ctx = double('ChefDK generator context')
+    allow(@ctx).to receive(:cookbook_root).and_return('/nonexistent')
+    allow(@ctx).to receive(:cookbook_name).and_return('foo')
+    allow(ChefDK::Generator).to receive(:context).and_return(@ctx)
+    @recipe = double('Chef recipe').as_null_object
+    @orig_stdout = $stdout
+    $stdout = File.open(File::NULL, 'w')
+  end
+
+  after do
+    $stdout = @orig_stdout
+  end
+
+  %w(
+    templates
+    templates/default
+    files
+    files/default
+    test
+    test/integration
+    test/integration/default
+    test/integration/default/serverspec
+    test/integration/default/serverspec/recipes
+    spec
+    spec/recipes
+    attributes
+    recipes
+  ).each do |dirname|
+    it "should create the directory #{dirname}" do
+      expect(@recipe).to receive(:directory).with(/#{dirname}$/)
+      template = ChefGen::Flavor::Example.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(
+    .rspec
+    Gemfile
+    Berksfile
+    Rakefile
+    Guardfile
+    .rubocop.yml
+    .kitchen.yml
+    test/integration/default/serverspec/spec_helper.rb
+    test/integration/default/serverspec/recipes/default_spec.rb
+    spec/spec_helper.rb
+    spec/recipes/default_spec.rb
+    recipes/default.rb
+    attributes/default.rb
+    metadata.rb
+    README.md
+    CHANGELOG.md
+  ).each do |filename|
+    it "should generate the file #{filename} from a template" do
+      expect(@recipe).to receive(:template).with(/#{filename}$/)
+      template = ChefGen::Flavor::Example.new(@recipe)
+      template.generate
+    end
+  end
+
+  %w(
+    templates/default/example.conf.erb
+    files/default/example.conf
+  ).each do |filename|
+    it "should write the file #{filename}" do
+      expect(@recipe).to receive(:cookbook_file).with(/#{filename}$/)
+      template = ChefGen::Flavor::Example.new(@recipe)
+      template.generate
+    end
+  end
+
+  it 'should write a chefignore and .gitignore' do
+    expect(@recipe).to receive(:file).with(/chefignore$/)
+    expect(@recipe).to receive(:file).with(/\.gitignore$/)
+    template = ChefGen::Flavor::Example.new(@recipe)
+    template.generate
+  end
+
+  it 'should display the actions taken' do
+    expect(@recipe).to receive(:ruby_block).with('report_actions_taken')
+    template = ChefGen::Flavor::Example.new(@recipe)
+    template.generate
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-console'
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ]
+  SimpleCov.start
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,287 @@
+--- !ruby/object:Gem::Specification
+name: chef-gen-flavor-example
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- James FitzGibbon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef-gen-flavors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: chef-dk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: |-
+  An example plugin for [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors).
+
+  This plugin makes use of most of the snippets available, and is meant as a
+  reference implementation than for actual use. It demonstrates how to create
+  a template plugin with tests and serve as a good example of how to get
+  started writing your own templates for distribution.
+email:
+- james.i.fitzgibbon@nordstrom.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.md
+- Manifest.txt
+- README.md
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- History.md
+- LICENSE
+- Manifest.txt
+- README.md
+- Rakefile
+- chef-gen-flavor-example.gemspec
+- code_generator/files/default/files_default_example_conf
+- code_generator/files/default/templates_default_example_conf_erb
+- code_generator/libraries/kitchen_helper.rb
+- code_generator/metadata.rb
+- code_generator/recipes/cookbook.rb
+- code_generator/templates/default/Berksfile.erb
+- code_generator/templates/default/CHANGELOG_md.erb
+- code_generator/templates/default/Gemfile.erb
+- code_generator/templates/default/Guardfile.erb
+- code_generator/templates/default/README_md.erb
+- code_generator/templates/default/Rakefile.erb
+- code_generator/templates/default/_kitchen_yml.erb
+- code_generator/templates/default/_rspec.erb
+- code_generator/templates/default/_rubocop_yml.erb
+- code_generator/templates/default/attributes_default_rb.erb
+- code_generator/templates/default/metadata_rb.erb
+- code_generator/templates/default/recipes_default_rb.erb
+- code_generator/templates/default/spec_recipes_default_spec_rb.erb
+- code_generator/templates/default/spec_spec_helper_rb.erb
+- code_generator/templates/default/test_integration_default_serverspec_recipes_default_spec_rb.erb
+- code_generator/templates/default/test_integration_default_serverspec_spec_helper_rb.erb
+- lib/chef_gen/flavor/example.rb
+- spec/lib/chef_gen/flavor/example_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Nordstrom/chef-gen-flavor-example
+licenses:
+- apache2
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: An example plugin for [chef-gen-flavors](https://rubygems.org/gems/chef-gen-flavors)
+test_files: []