Poise-boiler is a set of helpers to reduce boilerplate in Poise/Halite style gems.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gemfiles
lib
spec
.gitignore
.travis.yml
CHANGELOG.md
Gemfile
LICENSE
README.md
Rakefile
poise-boiler.gemspec

README.md

Poise-Boiler

Build Status Gem Version Code Climate Gemnasium License

Poise-boiler is a set of helpers to reduce boilerplate in Poise/Halite style gems.

Dependencies

poise-boiler depends on a base set of useful gems for building Halite cookbooks. Make sure you only add it as a development dependency:

spec.add_development_dependency('poise-boiler', '~> 1.0')

spec_helper

The spec_helper sets up chefspec, rspec-its, and simplecov. Coverage reporting is also configured for CodeClimate and CodeCov if the relevant environment variables are set. The Halite spec helper is also enabled by default:

require 'poise_boiler/spec_helper'

You can disable the Halite spec helper if needed:

require 'poise_boiler'
PoiseBoiler.include_halite_spec_helper = false
require 'poise_boiler/spec_helper'

Rakefile

The Rakefile helper sets up the standard gem tasks, the Halite helper tasks, and a spec task to run unit tests.

require 'poise_boiler/rakefile'

Rake Tasks

test

Run all tests, specs, foodcritic, and kitchen.

spec

Run Rspec tests.

badges

Generate README badges for a project.

debug, quiet, verbose

Set the relevant mode environment variables. Can be abbreviated d, q, and v.

check

List uncommitted file changes and commits since the last release.

checkall

Run quiet check for all projects. This is specific to my folder layout and is less likely to work for others.

travis

Run tests for Travis CI. This does some setup and then runs rake test.

release, release:minor, release:major

Create a new release and push toe RubyGems and Supermarket.

.kitchen.yml

The .kitchen.yml helper sets up a default driver and default values for platforms and chef versions (used by knife-travis).

---
#<% require 'poise_boiler' %>
<%= PoiseBoiler.kitchen %>

suites:
- name: default
  run_list:
  - recipe[mycook]

You can also quickly customize the platforms using platform aliases:

<%= PoiseBoiler.kitchen(platforms: 'ubuntu') %>

You can always redefine a top-level key that has a default setting as well:

#<% require 'poise_boiler' %>
<%= PoiseBoiler.kitchen %>

platforms:
- name: arch

suites:
- name: default
  run_list:
  - recipe[mycook]

Available Aliases

  • ubuntu – ubuntu-12.04, ubuntu-14.04
  • rhel – centos-6.5, ubuntu-7
  • centos – rhel
  • linux – ubuntu, rhel

License

Copyright 2015-2016, Noah Kantrowitz

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.