knife-cookbook-doc 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf234f956b5b2932a4b0bc628c5ecf93c76f2446
-  data.tar.gz: 0d42eca15452227f41a815ba49607d82aff27ab3
+  metadata.gz: 7d4e4e61d176043dd41fa77782ac36203bc1251a
+  data.tar.gz: 49a72076fe65ea3f15878479e7c709394e2bc14c
 SHA512:
-  metadata.gz: 53cc932300b345ca738a9aff13caac0704788d8abf66b2872852a0b4553af6cd187b53d31625b47d6b8cdf4eedcdfa7b7a1c684d7d60090ca5fc266a1cd36b1e
-  data.tar.gz: cf0d15453d5565e2d0360f7d6baac7a6c3ce0a14912fdfc16fb68b2f360211b2871ca0408d59e37423dfb45d8f26eec5ecc81f14cbf74ce58d4327b95ec31430
+  metadata.gz: 325f8c3e22e8f67778480106847aafbccc2d7da9d58831005f3fa09b7e3de3c4710c9a05e6023718a8669c064e51c94f3cc8cf5305752704e5d6a587d5c89fae
+  data.tar.gz: 876de6b5caff31196e93bd7dd71c8b5fb1c6bec5725a95c24644595ae19954de6a043d1e987be44df56c67c1e376eec46bec027bcd9ef285ce0b7393347e97da

data/.gitignore

@@ -1,5 +1,6 @@
 /Gemfile.lock
 /*.gem
+/fixture/README-generated.md
 
 # Intermediate package dir
 /pkg

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.29.0 (Jun 26 2020)
+
+* Extract descriptions from `libraries/*.rb`. Submitted by Joe Nuspl.
+
 # v0.28.0 (Jun 11 2020)
 
 * If `Berksfile` exists, add source_url links to cookbooks. Submitted by Joe Nuspl.

data/Rakefile

@@ -4,3 +4,12 @@ require 'rake/clean'
 task :default => :build
 
 CLEAN.include 'pkg'
+
+task :test => :install
+task :test do
+  sh <<SCRIPT
+cd fixture
+knife cookbook doc . -o README-generated.md -c knife.rb
+diff -u README-expected.md README-generated.md && rm README-generated.md
+SCRIPT
+end

data/fixture/README-expected.md

@@ -50,6 +50,11 @@ This resource is awesome.
 - my_attribute: This is an attribute. Defaults to <code>"a default value"</code>.
 - my_property: This is a property. Defaults to <code>"another default value"</code>.
 
+# Libraries
+
+## stooges()
+Returns `['Moe', 'Larry', 'Curly']`
+
 # Credits
 
 * Mathias Lafeldt

data/fixture/libraries/default.rb

@@ -0,0 +1,7 @@
+# <
+# ## stooges()
+# Returns `['Moe', 'Larry', 'Curly']`
+# >
+def stooges
+  %w(Moe Larry Curly)
+end

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

@@ -157,6 +157,13 @@
 <%= resource.top_level_description(key) -%>
 <% end -%>
 
+<% end -%>
+<% end -%>
+<% unless libraries.empty? -%>
+# Libraries
+<% libraries.each do |lib| -%>
+
+<%= lib.descriptions %>
 <% end -%>
 <% end -%>
 <% fragments.keys.select {|k|k != 'overview' && k != 'credit' && k != 'requirements'}.each do |key| -%>

data/lib/chef/knife/cookbook_doc.rb

@@ -9,6 +9,7 @@ module KnifeCookbookDoc
       require 'knife_cookbook_doc/base_model'
       require 'knife_cookbook_doc/documenting_lwrp_base'
       require 'knife_cookbook_doc/definitions_model'
+      require 'knife_cookbook_doc/libraries_model'
       require 'knife_cookbook_doc/readme_model'
       require 'knife_cookbook_doc/recipe_model'
       require 'knife_cookbook_doc/resource_model'

data/lib/knife_cookbook_doc/libraries_model.rb

@@ -0,0 +1,13 @@
+module KnifeCookbookDoc
+  class LibrariesModel
+    include KnifeCookbookDoc::BaseModel
+
+    attr_reader :descriptions
+
+    def initialize(name, filename)
+      @name = name
+      @filename = filename
+      @descriptions = extract_description
+    end
+  end
+end

data/lib/knife_cookbook_doc/rake_task.rb

@@ -6,6 +6,7 @@ require 'rake/tasklib'
 require 'knife_cookbook_doc/base_model'
 require 'knife_cookbook_doc/documenting_lwrp_base'
 require 'knife_cookbook_doc/definitions_model'
+require 'knife_cookbook_doc/libraries_model'
 require 'knife_cookbook_doc/readme_model'
 require 'knife_cookbook_doc/recipe_model'
 require 'knife_cookbook_doc/resource_model'

data/lib/knife_cookbook_doc/readme_model.rb

@@ -8,6 +8,8 @@ module KnifeCookbookDoc
   class ReadmeModel
     DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
 
+    attr_reader :libraries
+
     def initialize(cookbook_dir, config)
 
       @metadata = Chef::Cookbook::Metadata.new
@@ -28,6 +30,10 @@ module KnifeCookbookDoc
         end
       end
 
+      @libraries = Dir["#{cookbook_dir}/libraries/*.rb"].sort.map do |path|
+        LibrariesModel.new(@metadata.name, path)
+      end
+
       @resources = []
       Dir["#{cookbook_dir}/resources/*.rb"].sort.each do |resource_filename|
         @resources << ResourceModel.new(@metadata.name, resource_filename)

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.28.0'
+  VERSION = '0.29.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -94,6 +94,7 @@ files:
 - fixture/doc/overview.md
 - fixture/gemfile
 - fixture/knife.rb
+- fixture/libraries/default.rb
 - fixture/metadata.rb
 - fixture/recipes/default.rb
 - fixture/resources/default.rb
@@ -104,6 +105,7 @@ files:
 - lib/knife_cookbook_doc/base_model.rb
 - lib/knife_cookbook_doc/definitions_model.rb
 - lib/knife_cookbook_doc/documenting_lwrp_base.rb
+- lib/knife_cookbook_doc/libraries_model.rb
 - lib/knife_cookbook_doc/rake_task.rb
 - lib/knife_cookbook_doc/readme_model.rb
 - lib/knife_cookbook_doc/recipe_model.rb