chef_attrdoc 1.0.0.pre → 1.0.0

data/README.md

@@ -4,7 +4,9 @@ chef_attrdoc
 [![Build Status](https://travis-ci.org/mapleoin/chef_attrdoc.svg?branch=master)](https://travis-ci.org/mapleoin/chef_attrdoc)
 [![Code Climate](https://codeclimate.com/github/mapleoin/chef_attrdoc.png)](https://codeclimate.com/github/mapleoin/chef_attrdoc)
 
-Extract documentation from chef cookbooks' attributes files and output it to the cookbook's README.md file.
+*The problem:* README documentation gets outdated because it's not close to the code. A lot of cookbook documentation describes the configuration options that the cookbook provides; so it naturally lies in attributes files.
+
+*The solution:* Extract documentation from chef cookbooks' attributes files and format and output it to the cookbook's README.md file.
 
 `chef_attrdoc` groups attribute initialization lines together with the comments immediately above them. Any lines containing an attribute initialization which are not separated by an empty line are considered a group. The comment immediately above them is assumed to describe the group of attributes below. Groups of attribute initialization lines which are not immediately preceded by a comment line are ignored and will not show up in the output.
 
@@ -17,6 +19,8 @@ $ gem install chef_attrdoc
 $ chef_attrdoc ~/cookbooks/mycookbook
 ```
 
+It's that simple. Only one command to run and `chef_attrdoc` will know how to do the rest.
+
 `chef_attrdoc` will try to find an Attributes heading in the README.md file in that directory and replace its contents with the generated attributes documentation. The attributes documentation is compiled from all the files in the cookbook's `attributes/` directory. All the files ending in `.rb` in that directory are considered to be attributes files.
 
 `chef_attrdoc` uses ruby's stdlib `ripper` module and so does not have any dependencies.
@@ -70,6 +74,6 @@ $ chef_attrdoc cookbook-example --stdout
 
 Here are some longer examples from openstack chef cookbooks:
 
-[openstack-compute attributes file](https://github.com/stackforge/cookbook-openstack-compute/blob/aa42f5c09a445cde7267e4b4d00a6ce893aa481e/attributes/default.rb) - [output](https://gist.github.com/mapleoin/6886586)
+[openstack-identity attributes file](https://github.com/stackforge/cookbook-openstack-identity/blob/552488824aa720f08249bc4d19f5224e9382aa00/attributes/default.rb) - [output](https://gist.github.com/mapleoin/d211b29f68dd519a4878#attributes)
 
-[openstack-identity attributes file](https://github.com/stackforge/cookbook-openstack-identity/blob/2e6b8b9c6788ae28fbc362c77c53a51c040b49a6/attributes/default.rb) - [output](https://gist.github.com/mapleoin/6886493)
+[openstack-common attributes file](https://github.com/stackforge/cookbook-openstack-common/tree/f0e55b8742d9285742163d8c2633833dc6f4241c/attributes) - [output](https://gist.github.com/mapleoin/d211b29f68dd519a4878#attributes)

data/bin/chef_attrdoc

@@ -1,4 +1,20 @@
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# Copyright 2013-2014, Ionuț Arțăriși <ionut@artarisi.eu>
+#
+# 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.
+#
 
 require 'optparse'
 
@@ -7,8 +23,8 @@ require 'chef_attrdoc'
 options = {}
 
 opt_parser = OptionParser.new do |opts|
-  opts.banner = "Usage: chef_attrdoc.rb [DIR] [options]\n"
-  opts.banner << "DIR - cookbook directory - defaults to the current directory\n\n"
+  opts.banner = "Usage: chef_attrdoc [DIR] [options]\n"
+  opts.banner << "DIR - cookbook directory - defaults to the current directory\n"
 
   options[:readme] = "README.md"
   opts.on("-r", "--readme README",

data/lib/chef_attrdoc/version.rb

@@ -1,3 +1,3 @@
 module ChefAttrdoc
-  VERSION = "1.0.0.pre"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: chef_attrdoc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Ionuț Arțăriși
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,9 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23