cookbook_creator 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f70ff162f70eff1a36152803cc46ca952c5d966f
-  data.tar.gz: 86bc88ba6ac05b613b49841cbc8af0ed4c5df02d
+  metadata.gz: 66e5138d92d0ac03392039c671d1da32d1c24bcb
+  data.tar.gz: 09708e4e04721354600873cd900c397d418940bd
 SHA512:
-  metadata.gz: 8373416c2a9ac6e9d05d4ab1fd6403ac9dbd2814a7768cd00a08ffcedbabaab438eb6000542df1799ca695e4671eb124ec511b6e9db130ddf9de71183f83469e
-  data.tar.gz: 8337b4a7c0e71c039e04d24de2f83d39e6842a8f5c5b8a1759046f0c27608c01fc999a275980bbae70cdd6b00f7ec14cc8bbef66ed9bf3712becd04c52542f9f
+  metadata.gz: a3f8a0e55be8be87b6b497d5d635c9fd182cb2e834a6a27dbb183b7232a06d7cbc91530fdd76c087f4768273b3dfc9c32ea4aaa1568631d7d5a5d25e0c7b3ed9
+  data.tar.gz: a392f6165c2af8ad965e6084200284b9d91d184119f7cc511609a70bdb6072055839e7c396d7a1c27a691964f63b504d44ef9671928d4c68f6c680ef9221f654

data/README.md

@@ -0,0 +1,77 @@
+# Cookbook Creator
+
+Cookbook Creator role is to provide lightweight mechanism of initial cookbook generation from template.
+
+## Installation
+
+You can install it by using a command:
+`gem install cookbook_creator`
+
+## Dependencies
+
+Cookbook Creator during its installation will also install required gems:
+* chef
+* berkshelf
+* kitchen
+* json
+* ohai
+* rake
+* rspec
+* chefspec
+* serverspec
+* mixlib-cli
+* mixlib-config
+* chef-zero
+
+## Usage
+
+`cookbook_create <cookbook_name> <options>`
+
+Where:
+* <cookbook_name> is obligatory
+* <options> can be:
+  - `-c, --config <path_to_custom_config_file>`
+  - `-g, --generator_cookbook <path to custom cookbook template>`
+  - `-m, --maintainer <maintainer>`
+  - `-e, --maintainer_email <maintainer_email>`
+  - `-p, --provisioner <provisioner_to_use>` # Default is chef_zero
+  - `-l, --license <license_name>`
+  - `-P, --platform <platform>`
+  - `-d, --driver <driver>` # Docker is the default
+  - `-i, --image <image_name> # Used only if selected driver is docker`
+  - `-s, --supermarket_url <url>` # Custom supermarket URL. Is usefull in case we have our own private supermarket
+  - `-L, --lwrp` # Will be generated LWRP skeleton
+  - `-b, --lib` # Will be generated library skeleton
+
+## Config options
+
+Config file could has following options:
+  - `maintainer '<maintainer>'`
+  - `maintainer_email '<maintainer_email>'`
+  - `provisioner '<provisioner>'`
+  - `license '<license>'`
+  - `platform '<platform>'`
+  - `driver '<driver>'`
+  - `supermarket_url '<supermarket_url>'`
+  - `lwrp '<true_or_false>'`
+  - `lib '<true_or_false>'`
+  - `generator_cookbook '<path_to_custom_templates>'`
+  - `image '<docker_image>'`
+
+## Config locations
+
+By default Cookbook Creator will search for config file in following places:
+* Under `env['COOKBOOK_CREATOR_HOME']/generator.rb` if set
+* Under `Current directory/generator.rb`
+* Under `Current directory/.generator/generator.rb`
+* Under `$HOME/.generator/generator.rb`
+
+## Options merging
+
+Options will be merged in the following order:
+* Initially will be build hash with default options from CLI
+* CLI options will be overwritten by the options within config file
+* Config file options will be overwritten by any arguments which will be passed to the script
+
+*WARNING:* Cookbook Creator can have some bugs.
+Please report to sanicheev@tacitknowledge.com if you will find any.

data/cookbook_creator.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'cookbook_creator'
-  s.version     = '0.0.2'
+  s.version     = '0.0.3'
   s.date        = '2016-01-11'
   s.summary     = "Everything required for cookbook generation"
   s.description = "This gem is used to generate cookbook skeleton"
@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '~> 2.2.1'
   s.bindir       = 'bin'
   s.executables  = [ 'cookbook_create' ]
-  s.files = %w(test.txt) + Dir.glob("*.gemspec") +
+  s.files = %w(README.md) + Dir.glob("*.gemspec") +
       Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
   s.add_dependency "chef", "~> 12.6.0"
   s.add_dependency "bundler"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cookbook_creator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Serghei Anicheev
@@ -213,8 +213,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/cookbook_create
 - cookbook_creator.gemspec
+- lib/cookbook_creator/.config_loader.rb.swp
 - lib/cookbook_creator/cli.rb
 - lib/cookbook_creator/config.rb
 - lib/cookbook_creator/config_loader.rb
@@ -324,7 +326,6 @@ files:
 - lib/skeletons/code_generator/templates/default/resource.rb.erb
 - lib/skeletons/code_generator/templates/default/serverspec_default_spec.rb.erb
 - lib/skeletons/code_generator/templates/default/template.erb
-- test.txt
 homepage: http://rubygems.org/gems/cookbook_creator
 licenses:
 - Free License