knife-cookbook-doc 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2547fe3a4ed594bf06e9c563ae040c45c42001e3
-  data.tar.gz: 92629b1e4e30ab40b3646708eb3ab97328afcad7
+  metadata.gz: 17c5fb8c4abf80bfc8900aba278be417d184c37d
+  data.tar.gz: 7724660129ece1fbb7fa7045ff7cdba8c3478de6
 SHA512:
-  metadata.gz: 5625b1d45f32c07f42ca21baf9512fba3e2cc75765b16c5debcf02d3f30cbf6a2be87238c62adc611c43c9b8f16f878a01a7221434bca77b7b985e8e7ea0433a
-  data.tar.gz: e4e821099a09abe61c24da3552a5c2c70fcf97af8e035a7b50117dd0712c5b5ad416d8de88566fd280d73514ddb239d81f9ecafb878eda0b948faf08562c0e9d
+  metadata.gz: 5cef0d16f18084b09540a0912ce6633ff257cc71d2996e77b183820a358985afb4357d3b4b00efd352862cd69b7185f77f2bd4a91b523abda2237fb4ef7cfbbb
+  data.tar.gz: 7a9e7770d224d241cb5939e287218808f5b9da50aeeb2ff2805cea931de577c8dc21375a3ef9ad3a5907ef661ae03fdf116b60aabf8c4405d50cae3fefb99030

data/.travis.yml

@@ -4,9 +4,8 @@ sudo: false
 gemfile: fixture/gemfile
 
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.2.6
+  - 2.3.3
 
 env:
   - CHEF_VERSION=master
@@ -21,25 +20,14 @@ env:
   - 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
+    - env: CHEF_VERSION=11.12.8
+      rvm: 2.3.3
+    - env: CHEF_VERSION=11.10.4
+      rvm: 2.3.3
 
   allow_failures:
     - env: CHEF_VERSION=master

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.21.0 (Dec 2 2016)
+
+* Add support `--ignore-missing-doc-attr` to skip attributes with no documentation. Submitted by Andrey Zax.
+
 # v0.20.0 (Mar 11 2016)
 
 * Support custom requirements being specified in `doc/requirements.md`. Submitted by Deepak Sihag.

data/lib/chef/knife/cookbook_doc.rb

@@ -36,6 +36,12 @@ module KnifeCookbookDoc
            :default => Pathname.new("#{File.dirname(__FILE__)}/README.md.erb").realpath,
            :description => 'Set template file used to render README.md'
 
+    option :ignore_missing_attribute_desc,
+           :long => '--ignore-missing-doc-attr',
+           :boolean => true,
+           :default => false,
+           :description => 'Ignore attributes without documetation'
+
     def run
       unless (cookbook_dir = name_args.first)
         ui.fatal 'Please provide cookbook directory as an argument'
@@ -44,7 +50,7 @@ module KnifeCookbookDoc
 
       cookbook_dir = File.realpath(cookbook_dir)
 
-      model = ReadmeModel.new(cookbook_dir, config[:constraints])
+      model = ReadmeModel.new(cookbook_dir, config)
 
       template = File.read(config[:template_file])
       eruby = Erubis::Eruby.new(template)

data/lib/knife_cookbook_doc/attributes_model.rb

@@ -3,9 +3,10 @@ module KnifeCookbookDoc
 
     ATTRIBUTE_REGEX = "(^\s*(?:default|set|force_default|override|force_override).*?)=\s*\n?\s*(.*?)$".freeze
 
-    def initialize(filename)
+    def initialize(filename, config)
       @filename = filename
       @attributes = {}
+      @config = config
       load_descriptions
     end
 
@@ -48,6 +49,10 @@ module KnifeCookbookDoc
       resource_data = resource_data.gsub(/^\s*\# ?\<\>\s(.*?$)\n#{ATTRIBUTE_REGEX}/) do
         update_attribute($2, $1)
       end
+
+      if @config[:ignore_missing_attribute_desc]
+        @attributes.select! { |att_name, att_options| att_options.has_key? :description }
+      end
     end
 
     def update_attribute(name, description)

data/lib/knife_cookbook_doc/readme_model.rb

@@ -2,7 +2,7 @@ module KnifeCookbookDoc
   class ReadmeModel
     DEFAULT_CONSTRAINT = ">= 0.0.0".freeze
 
-    def initialize(cookbook_dir, constraints)
+    def initialize(cookbook_dir, config)
 
       @metadata = Chef::Cookbook::Metadata.new
       @metadata.from_file("#{cookbook_dir}/metadata.rb")
@@ -15,7 +15,7 @@ module KnifeCookbookDoc
       else
         @attributes = []
         Dir["#{cookbook_dir}/attributes/*.rb"].sort.each do |attribute_filename|
-          model = AttributesModel.new(attribute_filename)
+          model = AttributesModel.new(attribute_filename, config)
           if !model.attributes.empty?
             @attributes += model.attributes
           end
@@ -51,7 +51,7 @@ module KnifeCookbookDoc
         end
       end
       @metadata = @metadata
-      @constraints = constraints
+      @constraints = config[:constraints]
     end
 
     def fragments

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.20.0'
+  VERSION = '0.21.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Knife plugin to generate README.md for a cookbook