knife-cookbook-doc 0.25.2 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37887ab7ebaf12a054d994a6901d24d9e5783685
-  data.tar.gz: ed7ff7f97bc54ca4eaa390610632f8f1caedbdc0
+SHA256:
+  metadata.gz: d4b4645d7d5c912ee0727e526541469198e048c75792d308624039278329a729
+  data.tar.gz: 60ba6053bb465d1e50cca894de9ff772a6e0ab180b78800c738bd9e67136c142
 SHA512:
-  metadata.gz: 641fea042b4c32c4ab37ce6c17074e6d697fa9c0bf2c0d776b11a349c34b327a18501a67e4bc809e7f149f437609e01569826d5ebbdd24cf7b12f95034d691ee
-  data.tar.gz: abd0276748d694e383a32bcf3ad8bc9ba500fe3f173a474a52017ca053c97bb70c68e064de7a9be470048d54a5bb049ded17571cfad467daf1d23e1ec26e6bd8
+  metadata.gz: a31986554dce09246b247c9c50a10d720f8025a02eb059fea3b4d8dc3deb7f64dc10a70488eb37fd2e57d56d7518a2d3516d469682c54d04949912a34a0f2d5d
+  data.tar.gz: f91942855366f6cb84292754909217b881d9292d5e3c3843062aebba7865507b6e3da3a266afb9b73778ff8ede007e4c53b54921cf63db78fd9bdae28f50d20e

data/.github/ISSUE_TEMPLATE.md

@@ -35,7 +35,9 @@ Reproduction repository:
 
 <!--
 If possible, please create a repository that reproduces the issue with the
-minimal amount of code possible.
+minimal amount of code possible. It is highly recommended you take the time
+to read "How to create a Minimal, Complete, and Verifiable example" at
+https://stackoverflow.com/help/mcve
 -->
 
 Problem description:

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# v0.30.0 (Mar 19 2021)
+
+* Support a space after # in custom resource. Submitted by Tomoya Kabe.
+
+# 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.
+
+# v0.27.0 (Jun 20 2019)
+
+* Add support for Chef 15. Submitted by grozan.
+
+# v0.26.0 (Mar 4 2019)
+
+* Display `lazy` defaults as such. Submitted by Joe Nuspl.
+
 # v0.25.2 (Dec 18 2018)
 
 * Re-release gem with the appropriate version.

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

@@ -36,6 +36,7 @@ MyApp Admin Group: The group allowed to manage MyApp.
 # Resources
 
 * [fixture](#fixture) - This resource is awesome.
+* [fixture_space](#fixture_space) - This resource is spacial.
 
 ## fixture
 
@@ -50,6 +51,24 @@ 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>.
 
+## fixture_space
+
+This resource is spacial.
+
+### Actions
+
+- stuff: Inserts spaces. Default action.
+
+### Attribute Parameters
+
+- 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/fixture/resources/space.rb

@@ -0,0 +1,13 @@
+# <
+# This resource is spacial.
+#
+# @action stuff Inserts spaces.
+# >
+
+default_action :stuff
+
+# <> @attribute my_attribute This is an attribute.
+attribute :my_attribute, default: 'a default value'
+
+# <> @property my_property This is a property.
+property :my_property, default: 'another default value'

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

@@ -147,7 +147,7 @@
 ### Attribute Parameters
 
 <% resource.attributes.each do |attribute| -%>
-- <%= attribute %>: <%= resource.attribute_description(attribute) %><% if resource.attribute_has_default_value?(attribute) %> Defaults to <code><%= resource.attribute_default_value(attribute).inspect %></code>.<% end %>
+- <%= attribute %>: <%= resource.attribute_description(attribute) %><% if resource.attribute_has_default_value?(attribute) %> Defaults to <code><%= resource.attribute_default_value(attribute) %></code>.<% end %>
 <% end -%>
 <% end -%>
 <% resource.top_level_descriptions.keys.select{|k| k != 'main'}.each do |key| -%>
@@ -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

@@ -1,13 +1,21 @@
+begin
+  require 'berkshelf'
+rescue LoadError
+  # won't be able to get :source_url for dependent cookbooks
+end
+
 module KnifeCookbookDoc
   class ReadmeModel
     DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
 
+    attr_reader :libraries
+
     def initialize(cookbook_dir, config)
 
       @metadata = Chef::Cookbook::Metadata.new
       @metadata.from_file("#{cookbook_dir}/metadata.rb")
 
-      if !@metadata.attributes.empty?
+      if (!@metadata.attributes.empty? rescue false)
         @attributes = @metadata.attributes.map do |attr, options|
           name = "node['#{attr.gsub("/", "']['")}']"
           [name, options['description'], options['default'], options['choice']]
@@ -22,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)
@@ -172,7 +184,28 @@ module KnifeCookbookDoc
 
     private
 
+    def source_url_from_berkshelf(name)
+      @source_url ||= begin
+        if File.exist?('Berksfile') && defined?(::Berkshelf)
+          ::Berkshelf::Berksfile
+            .from_file('Berksfile')
+            .install
+            .map { |cb| [cb.cookbook_name, cb.metadata.source_url] }
+            .to_h
+        else
+          {}
+        end
+      end
+      @source_url[name]
+    end
+
     def format_constraint(name, version)
+      url = source_url_from_berkshelf(name)
+      if !url.nil? && url.start_with?('http')
+        # git:// and ssh:// URLs are not browsable
+        name = "[#{name}](#{url})"
+      end
+
       if @constraints && version != DEFAULT_CONSTRAINT
         "#{name} (#{version})"
       else

data/lib/knife_cookbook_doc/resource_model.rb

@@ -52,14 +52,18 @@ module KnifeCookbookDoc
 
     def attribute_has_default_value?(attribute)
       specification = @native_resource.attribute_specifications[attribute]
-      specification && specification.has_key?(:default)
+      specification && specification.key?(:default)
     end
 
     def attribute_default_value(attribute)
-      if attribute_has_default_value?(attribute)
-        return @native_resource.attribute_specifications[attribute][:default]
+      default = if attribute_has_default_value?(attribute)
+                  @native_resource.attribute_specifications[attribute][:default]
+                end
+
+      if default.is_a?(Chef::DelayedEvaluator)
+        'lazy { ... }'
       else
-        return nil
+        default.inspect
       end
     end
 
@@ -94,13 +98,13 @@ module KnifeCookbookDoc
       resource_class.resource_name = filename_to_qualified_string(cookbook_name, filename)
       resource_class.run_context = nil
       resource_data = IO.read(filename)
-      resource_data = resource_data.gsub(/^=begin *\n *\#\<\n(.*?)^ *\#\>\n=end *\n/m) do
+      resource_data = resource_data.gsub(/^=begin *\n *\# ?\<\n(.*?)^ *\# ?\>\n=end *\n/m) do
         "desc <<DOCO\n#{$1}\nDOCO\n"
       end
-      resource_data = resource_data.gsub(/^ *\#\<\n(.*?)^ *\#\>\n/m) do
+      resource_data = resource_data.gsub(/^ *\# ?\<\n(.*?)^ *\# ?\>\n/m) do
         "desc <<DOCO\n#{$1.gsub(/^ *\# ?/, '')}\nDOCO\n"
       end
-      resource_data = resource_data.gsub(/^ *\#\<\> (.*?)$/) do
+      resource_data = resource_data.gsub(/^ *\# ?\<\> (.*?)$/) do
         "desc #{$1.inspect}\n"
       end
 

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.25.2'
+  VERSION = '0.30.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.25.2
+  version: 0.30.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-17 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -94,9 +94,11 @@ 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
+- fixture/resources/space.rb
 - knife_cookbook_doc.gemspec
 - lib/chef/knife/README.md.erb
 - lib/chef/knife/cookbook_doc.rb
@@ -104,6 +106,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
@@ -130,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Knife plugin to generate README.md for a cookbook