knife-cookbook-doc 0.15.0 → 0.16.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmNiMDNhYTk3Y2U4MjUzZGExZGY2MGZmOGQzMDMzZTNjZjdjZGUyOQ==
+    ZTdjZDI5OTM0Mjk5MTU4ZDVmMTI4NTMzOTM4MjJlMjNlYmM5ZDRiMg==
   data.tar.gz: !binary |-
-    ODk5ZDcyMTQzNmQzMWUzYmQ0MGMxMWI1MmJlY2YyODRjNzAyMzU2Mw==
+    YWIyYmJiZGZlMWZlZTg3NDZkZjBkNjRkOWU4Yjg3MmE4YzUxODEyNQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NWU0ZWQ4YThjNzUzMDE0NzYxNjE3MTlmNjdmNDk1N2M0N2RkZjVmZmRjZWJh
-    ODQ2Yjk4NWU1NDRhYzEwNzQ0ZDg4YWU1NjU5NGUwMDMwOGJhMzZjNmMyYzI3
-    MzkzZDFlY2E5MzdlMTVkMTA4NGFlOTYyODQ3ZDY3Y2EyYjBlMmM=
+    NTM0YTIzODBhNmE0NGIxYjlhZDA3ZjViNzAyNDc2NGZjZWQwNjhkNTRlZThk
+    ODg4N2EwODE3ZjRkOThkOGI1MGYzYjNjZTA0NmZlN2ZjMjFjMTIxNDA1NjE4
+    YjQ4NTdmOGJjMGZiOTBmNjI4YmZmYmE3NDg1NDAxNTA0Y2QzNTg=
   data.tar.gz: !binary |-
-    ZGNjNTVjMDA5ZTFmZDQ3ODE1OWJhNjQ3MmVmMmYzZTMxMDNkZjgwZjI5ZWM0
-    M2NiMjZmODA1ZmFlOTQ4OTRmODBkZDRkNGYwMjcwZDE4ZWJjY2Q3NGFkZWUw
-    ZjlkYWFkZmIxYjdmMDMzNjRjZmRlMDQ2NmU0NjU0ODNmNjI4ODU=
+    ZDA4YWVjYWEyMGU0ZmU4MjFkNGEzYTAwNGEzYTA0NDdjMmEyYWNhOWIxODdj
+    ZjgwYmM0M2I3NjBlYmUxOGMxYmE5MDMwMWRjNmE0YTBjMzkwZjk1NWEwMTBm
+    ZDZiMzFjOGI4MzgzZTYxNWI1N2QyM2NkMDdiOWNhN2E0NDg3ZmY=

data/.gitignore

@@ -7,3 +7,4 @@
 /*.iml
 /*.ipr
 /*.iws
+/.rakeTasks

data/.travis.yml

@@ -0,0 +1,49 @@
+language: ruby
+cache: bundler
+sudo: false
+gemfile: fixture/gemfile
+
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+
+env:
+  - CHEF_VERSION=master
+  - CHEF_VERSION=12.4.1
+  - CHEF_VERSION=12.3.0
+  - CHEF_VERSION=12.2.1
+  - CHEF_VERSION=12.1.2
+  - CHEF_VERSION=12.0.3
+  - CHEF_VERSION=11.18.12
+  - CHEF_VERSION=11.16.4
+  - CHEF_VERSION=11.14.6
+  - CHEF_VERSION=11.12.8
+  - CHEF_VERSION=11.10.4
+  - CHEF_VERSION=11.8.2
+  - CHEF_VERSION=11.6.2
+  - CHEF_VERSION=11.4.4
+  - CHEF_VERSION=11.2.0
+  - CHEF_VERSION=11.0.0
+
+matrix:
+  fast_finish: true
+  exclude:
+    - env: CHEF_VERSION=11.8.2
+      rvm: 2.2
+    - env: CHEF_VERSION=11.6.2
+      rvm: 2.2
+    - env: CHEF_VERSION=11.4.4
+      rvm: 2.2
+    - env: CHEF_VERSION=11.2.0
+      rvm: 2.2
+    - env: CHEF_VERSION=11.0.0
+      rvm: 2.2
+
+  allow_failures:
+    - env: CHEF_VERSION=master
+
+script:
+  - cd fixture
+  - bundle exec knife cookbook doc . -o README-generated.md -c knife.rb
+  - diff README-expected.md README-generated.md && rm README-generated.md

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.16.0 (Aug 6 2015)
+
+* Travis CI testing, and test matrix. Submitted by Mark Ayers.
+* Added badges to README. Submitted by Mark Ayers.
+* Expose metadata name value. Submitted by Mark Ayers.
+* No longer capitalize the platform. Submitted by Mark Ayers.
+* Allow '# <' and '# >' for doc block comments. Submitted by Mark Ayers.
+
 # v0.15.0 (Mar 20 2015)
 
 * Further bug-fixes for multi-line attributes. Submitted By Drew Blessing.

data/README.md

@@ -1,5 +1,12 @@
 # knife-cookbook-doc
 
+[![Build Status](http://img.shields.io/travis/realityforge/knife-cookbook-doc.svg)](https://travis-ci.org/realityforge/knife-cookbook-doc)
+[![Code Climate](https://codeclimate.com/github/realityforge/knife-cookbook-doc/badges/gpa.svg)](https://codeclimate.com/github/realityforge/knife-cookbook-doc)
+[![Gem Version](https://badge.fury.io/rb/knife-cookbook-doc.svg)](http://badge.fury.io/rb/knife-cookbook-doc)
+[![Dependency Status](https://gemnasium.com/realityforge/knife-cookbook-doc.svg)](https://gemnasium.com/realityforge/knife-cookbook-doc)
+[![Inline docs](http://inch-ci.org/github/realityforge/knife-cookbook-doc.svg)](http://inch-ci.org/github/realityforge/knife-cookbook-doc)
+
+
 This is a knife plugin to help create and maintain a README.md for a cookbook.
 As much as possible the plugin makes use of the same metadata as used by chef
 when generating the documentation. The plugin will also scan the source files
@@ -160,6 +167,33 @@ The documentation stored in comments comes in three forms;
     # This is some documentation
     #>
 
+## Version Testing and Support Matrix
+
+This knife plugin is tested against multiple MRI Ruby versions and multiple
+Chef versions. We aim to test against the lastest patch version of each minor
+version of Chef Client's knife. See the `.travis.yml` for more complete detail.
+
+```
+|   Chef   | MRI Ruby |         |         |
+| version  |   2.0    |   2.1   |   2.2   |
+|----------|----------|---------|---------|
+| master   | perhaps  | perhaps | perhaps |
+| 12.4.1   | yes      | yes     | yes     |
+| 12.3.0   | yes      | yes     | yes     |
+| 12.2.1   | yes      | yes     | yes     |
+| 12.1.2   | yes      | yes     | yes     |
+| 12.0.3   | yes      | yes     | yes     |
+| 11.18.12 | yes      | yes     | yes     |
+| 11.16.4  | yes      | yes     | yes     |
+| 11.14.6  | yes      | yes     | yes     |
+| 11.12.8  | yes      | yes     | yes     |
+| 11.10.4  | yes      | yes     | yes     |
+| 11.8.2   | yes      | yes     | no      |
+| 11.6.2   | yes      | yes     | no      |
+| 11.4.4   | yes      | yes     | no      |
+| 11.2.0   | yes      | yes     | no      |
+| 11.0.0   | yes      | yes     | no      |
+```
 
 ## Credit
 

data/fixture/CHANGELOG.md

@@ -0,0 +1,13 @@
+fixture CHANGELOG
+=================
+
+This file is used to list changes made in each version of the fixture cookbook.
+
+0.1.0
+-----
+- [your_name] - Initial release of fixture
+
+- - -
+Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
+
+The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.

data/fixture/README-expected.md

@@ -0,0 +1,34 @@
+# Description
+
+# My Cookbook Readme
+
+**`knife cookbook doc .` _rocks_**
+
+# Requirements
+
+## Platform:
+
+* cookbook-authors
+
+## Cookbooks:
+
+* upon-magic
+
+# Attributes
+
+* `node['knife']['cookbook']['doc']` -  Defaults to `successful automation`.
+
+# Recipes
+
+* [fixture::default](#fixturedefault) - The recipe is awesome.
+
+## fixture::default
+
+The recipe is awesome. It does thing 1, thing 2 and thing 3!
+
+MyApp Admin Group: The group allowed to manage MyApp.
+
+# Credits
+
+* Mathias Lafeldt
+* Peter Donald

data/fixture/README.md

@@ -0,0 +1 @@
+

data/fixture/attributes/default.rb

@@ -0,0 +1 @@
+default['knife']['cookbook']['doc'] = 'successful automation'

data/fixture/doc/credit.md

@@ -0,0 +1,4 @@
+# Credits
+
+* Mathias Lafeldt
+* Peter Donald

data/fixture/doc/overview.md

@@ -0,0 +1,3 @@
+# My Cookbook Readme
+
+**`knife cookbook doc .` _rocks_**

data/fixture/gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org/'
+
+if ENV['CHEF_VERSION'] == 'master'
+  gem 'chef', github: 'chef/chef'
+else
+  gem 'chef', ENV['CHEF_VERSION']
+end
+
+gemspec path: '..'

data/fixture/knife.rb

@@ -0,0 +1,3 @@
+cookbook_copyright 'A Cookbook Author'
+cookbook_email 'author@example.com'
+cookbook_license 'MIT'

data/fixture/metadata.rb

@@ -0,0 +1,10 @@
+name             'fixture'
+maintainer       'A Cookbook Author'
+maintainer_email 'author@example.com'
+license          'MIT'
+description      'Installs/Configures fixture'
+long_description IO.read(File.join(File.dirname(__FILE__), 'README.md'))
+version          '0.1.0'
+
+supports 'cookbook-authors'
+depends 'upon-magic'

data/fixture/recipes/default.rb

@@ -0,0 +1,14 @@
+#
+# Cookbook Name:: fixture
+# Recipe:: default
+#
+# Copyright 2015, Mark Ayers
+#
+
+=begin
+#<
+The recipe is awesome. It does thing 1, thing 2 and thing 3!
+#>
+=end
+
+#<> MyApp Admin Group: The group allowed to manage MyApp.

data/lib/chef/knife/README.md.erb

@@ -149,6 +149,12 @@
 # License and Maintainer
 
 Maintainer:: <%= maintainer %> (<<%= maintainer_email %>>)
+<% unless source_url.empty? -%>
+<%= 'Source:: ' + source_url %>
+<% end -%>
+<% unless issues_url.empty? -%>
+<%= 'Issues:: ' + issues_url %>
+<% end -%>
 
 License:: <%= license %>
 <% else -%>

data/lib/knife_cookbook_doc/attributes_model.rb

@@ -39,13 +39,13 @@ module KnifeCookbookDoc
       end
 
       # get/parse comments
-      resource_data = resource_data.gsub(/^=begin\s*\n\s*\#\<\s*\n(.*?)^\s*\#\>\n=end\s*\n#{ATTRIBUTE_REGEX}/m) do
+      resource_data = resource_data.gsub(/^=begin\s*\n\s*\#\ ?<\s*\n(.*?)^\s*\# ?\>\n=end\s*\n#{ATTRIBUTE_REGEX}/m) do
         update_attribute($2, $1)
       end
-      resource_data = resource_data.gsub(/^\s*\#\<\n(.*?)^\s*\#\>\n#{ATTRIBUTE_REGEX}/m) do
+      resource_data = resource_data.gsub(/^\s*\# ?\<\n(.*?)^\s*\# ?\>\n#{ATTRIBUTE_REGEX}/m) do
         update_attribute($2, $1.gsub(/^\s*\# ?/, ''))
       end
-      resource_data = resource_data.gsub(/^\s*\#\<\>\s(.*?$)\n#{ATTRIBUTE_REGEX}/) do
+      resource_data = resource_data.gsub(/^\s*\# ?\<\>\s(.*?$)\n#{ATTRIBUTE_REGEX}/) do
         update_attribute($2, $1)
       end
     end

data/lib/knife_cookbook_doc/base_model.rb

@@ -27,13 +27,13 @@ module KnifeCookbookDoc
 
     def extract_description
       description = []
-      IO.read(@filename).gsub(/^=begin *\n *\#\<\n(.*?)^ *\#\>\n=end *\n/m) do
+      IO.read(@filename).gsub(/^=begin *\n *\# ?\<\n(.*?)^ *\# ?\>\n=end *\n/m) do
         description << $1
         ""
-      end.gsub(/^ *\#\<\n(.*?)^ *\#\>\n/m) do
+      end.gsub(/^ *\# ?\<\n(.*?)^ *\# ?\>\n/m) do
         description << $1.gsub(/^ *\# ?/, '')
         ""
-      end.gsub(/^ *\#\<\> (.*?)$/) do
+      end.gsub(/^ *\# ?\<\> (.*?)$/) do
         description << $1
         ""
       end

data/lib/knife_cookbook_doc/readme_model.rb

@@ -66,13 +66,33 @@ module KnifeCookbookDoc
       @definitions
     end
 
+    def cookbook_name
+      @metadata.name
+    end
+
     def description
       @metadata.description
     end
 
+    def source_url
+      if @metadata.methods.include? :source_url
+        @metadata.source_url
+      else
+        ""
+      end
+    end
+
+    def issues_url
+      if @metadata.methods.include? :issues_url
+        @metadata.issues_url
+      else
+        ""
+      end
+    end
+
     def platforms
       @metadata.platforms.map do |platform, version|
-        format_constraint(platform.capitalize, version)
+        format_constraint(platform, version)
       end
     end
 
@@ -120,6 +140,10 @@ module KnifeCookbookDoc
       @metadata.license
     end
 
+    def name
+      @metadata.name
+    end
+
     def get_binding
       binding
     end

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/spec/knife_cookbook_doc/attribute_model_spec.rb

@@ -10,11 +10,19 @@ describe KnifeCookbookDoc::AttributesModel do
 #<> Single line comment
 default['knife_cookbook_doc']['attr1'] = 'attr1_value'
 
+# <> Another single line comment
+default['knife_cookbook_doc']['attr1x'] = 'attr1x_value'
+
 #<
 # Multiline comment with single line of text
 #>
 default['knife_cookbook_doc']['attr2'] = 'attr2_value'
 
+# <
+# Another multiline comment with single line of text
+# >
+default['knife_cookbook_doc']['attr2x'] = 'attr2x_value'
+
 =begin
 #<
 Multiline begin/end with single line of text
@@ -22,12 +30,25 @@ Multiline begin/end with single line of text
 =end
 default['knife_cookbook_doc']['attr3'] = 'attr3_value'
 
+=begin
+# <
+Another multiline begin/end with single line of text
+# >
+=end
+default['knife_cookbook_doc']['attr3x'] = 'attr3x_value'
+
 #<
 # Multiline comment with
-multiple lines of text
+# multiple lines of text
 #>
 default['knife_cookbook_doc']['attr4'] = 'attr4_value'
 
+# <
+# Another multiline comment with
+# multiple lines of text
+# >
+default['knife_cookbook_doc']['attr4x'] = 'attr4x_value'
+
 =begin
 #<
 Multiline begin/end with
@@ -35,6 +56,14 @@ multiple lines of text
 #>
 =end
 default['knife_cookbook_doc']['attr5'] = 'attr5_value'
+
+=begin
+# <
+Another multiline begin/end with
+multiple lines of text
+# >
+=end
+default['knife_cookbook_doc']['attr5x'] = 'attr5x_value'
 EOS
     }
     subject do
@@ -52,6 +81,17 @@ EOS
       )
     end
 
+    it do
+      is_expected.to include(
+        [
+          "node['knife_cookbook_doc']['attr1x']",
+          'Another single line comment',
+          'attr1x_value',
+          []
+        ]
+      )
+    end
+
     it do
       is_expected.to include(
         [
@@ -63,6 +103,17 @@ EOS
       )
     end
 
+    it do
+      is_expected.to include(
+        [
+          "node['knife_cookbook_doc']['attr2x']",
+          'Another multiline comment with single line of text',
+          'attr2x_value',
+          []
+        ]
+      )
+    end
+
     it do
       is_expected.to include(
         [
@@ -74,6 +125,17 @@ EOS
       )
     end
 
+    it do
+      is_expected.to include(
+        [
+          "node['knife_cookbook_doc']['attr3x']",
+          'Another multiline begin/end with single line of text',
+          'attr3x_value',
+          []
+        ]
+      )
+    end
+
     it do
       is_expected.to include(
         [
@@ -85,6 +147,17 @@ EOS
       )
     end
 
+    it do
+      is_expected.to include(
+        [
+          "node['knife_cookbook_doc']['attr4x']",
+          "Another multiline comment with\nmultiple lines of text",
+          'attr4x_value',
+          []
+        ]
+      )
+    end
+
     it do
       is_expected.to include(
         [
@@ -95,5 +168,16 @@ EOS
         ]
       )
     end
+
+    it do
+      is_expected.to include(
+        [
+          "node['knife_cookbook_doc']['attr5x']",
+          "Another multiline begin/end with\nmultiple lines of text",
+          'attr5x_value',
+          []
+        ]
+      )
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-19 00:00:00.000000000 Z
+date: 2015-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -76,13 +76,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- TODO.md
+- fixture/CHANGELOG.md
+- fixture/README-expected.md
+- fixture/README.md
+- fixture/attributes/default.rb
+- fixture/doc/credit.md
+- fixture/doc/overview.md
+- fixture/gemfile
+- fixture/knife.rb
+- fixture/metadata.rb
+- fixture/recipes/default.rb
 - knife_cookbook_doc.gemspec
 - lib/chef/knife/README.md.erb
 - lib/chef/knife/cookbook_doc.rb

data/TODO.md

@@ -1 +0,0 @@
-* Autodetect travis usage and add badges automagically