knife-cookbook-doc 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ef732bc170168616bfc22e319838395fdfd789a
-  data.tar.gz: 2b933a18b2825171e52a6dbdf992a4e0b08c1c56
+  metadata.gz: bf234f956b5b2932a4b0bc628c5ecf93c76f2446
+  data.tar.gz: 0d42eca15452227f41a815ba49607d82aff27ab3
 SHA512:
-  metadata.gz: 93bcc31a7e09ac48f3326b2c4ec3d29f1485be5518ca89f7d69a7ec406373ca392a19985709a9932ea02c2b633fd40ad1480256bbe5a91ca4f4b634febbde8df
-  data.tar.gz: 9ddb6f35e8ceb8fa57b050195c11a611cb5bb731e7ad03f382689c395f1b47f9d8e9b8e403dd1a579315b39e8e159ce60799138ed69d5fb3b5ab2dc4d9cad2b9
+  metadata.gz: 53cc932300b345ca738a9aff13caac0704788d8abf66b2872852a0b4553af6cd187b53d31625b47d6b8cdf4eedcdfa7b7a1c684d7d60090ca5fc266a1cd36b1e
+  data.tar.gz: cf0d15453d5565e2d0360f7d6baac7a6c3ce0a14912fdfc16fb68b2f360211b2871ca0408d59e37423dfb45d8f26eec5ecc81f14cbf74ce58d4327b95ec31430

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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.

data/lib/knife_cookbook_doc/readme_model.rb

@@ -1,3 +1,9 @@
+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
@@ -172,7 +178,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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-19 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef