knife-cookbook-doc 0.16.0 → 0.17.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTdjZDI5OTM0Mjk5MTU4ZDVmMTI4NTMzOTM4MjJlMjNlYmM5ZDRiMg==
-  data.tar.gz: !binary |-
-    YWIyYmJiZGZlMWZlZTg3NDZkZjBkNjRkOWU4Yjg3MmE4YzUxODEyNQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTM0YTIzODBhNmE0NGIxYjlhZDA3ZjViNzAyNDc2NGZjZWQwNjhkNTRlZThk
-    ODg4N2EwODE3ZjRkOThkOGI1MGYzYjNjZTA0NmZlN2ZjMjFjMTIxNDA1NjE4
-    YjQ4NTdmOGJjMGZiOTBmNjI4YmZmYmE3NDg1NDAxNTA0Y2QzNTg=
-  data.tar.gz: !binary |-
-    ZDA4YWVjYWEyMGU0ZmU4MjFkNGEzYTAwNGEzYTA0NDdjMmEyYWNhOWIxODdj
-    ZjgwYmM0M2I3NjBlYmUxOGMxYmE5MDMwMWRjNmE0YTBjMzkwZjk1NWEwMTBm
-    ZDZiMzFjOGI4MzgzZTYxNWI1N2QyM2NkMDdiOWNhN2E0NDg3ZmY=
+SHA1:
+  metadata.gz: f864d13016b58e2852ac3ee106881e6ecc5108e6
+  data.tar.gz: 270a238f84aecae4ef5897b17d2aa22ab704c7ac
+SHA512:
+  metadata.gz: 3f6838645213d246defcc7c5acb682241b5cac15a4a34ac7f01d57b72fd8cf9b179b1515009647a21b01633b401cf0e2749463939608224517a92b1a96e9f05b
+  data.tar.gz: 14c5eb78292fe9c27695e55ab6d96538d3ede2b3e7a44424317b0e10309d529ff5c402e42577ed09423d587c32fc9de2b8eda090d9eba25b9364943b0bc651be

data/.travis.yml

@@ -10,6 +10,7 @@ rvm:
 
 env:
   - CHEF_VERSION=master
+  - CHEF_VERSION=12.5.1
   - CHEF_VERSION=12.4.1
   - CHEF_VERSION=12.3.0
   - CHEF_VERSION=12.2.1

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.17.0 (Dec 1 2015)
+* Add support for Chef >= 12.5. Submitted by Ole Claussen.
+* Add support for arrays of default_actions. Submitted by Ole Claussen.
+
 # v0.16.0 (Aug 6 2015)
 
 * Travis CI testing, and test matrix. Submitted by Mark Ayers.

data/README.md

@@ -85,6 +85,10 @@ The other text will be added at the start of the LWRP documentation
 except if marked with `@section <heading>`, in which case it will be added
 to the end of the LWRP documentation.
 
+Starting with Chef >12.5, properties will replace attributes in custom
+resources. For compatibility, `@property` may be used interchangibly with
+`@attribute`. Both will be handled completely identical by the plugin.
+
 #### Step 5
 
 In each definition add documentation like:
@@ -143,6 +147,21 @@ Afterwards, the new knife command `knife cookbook doc DIR` will be available.
         knife cookbook doc path/to/cookbook
         knife cookbook doc path/to/cookbook --template README.md.erb
 
+Alternatively, you can execute cookbook doc directly from your Rakefile:
+
+    require 'knife_cookbook_doc/rake_task'
+
+    # With default options
+    KnifeCookbookDoc::RakeTask.new(:doc)
+
+    # Example with custom options
+    KnifeCookbookDoc::RakeTask.new(:doc) do |t|
+      t.options[:cookbook_dir] = './'
+      t.options[:constraints] = true
+      t.options[:output_file] = 'README.md'
+      t.options[:template_file] = "#{File.dirname(__FILE__)}/templates/README.md.erb"
+    end
+
 ## Further Details
 
 ### Documentation in comments

data/fixture/README-expected.md

@@ -28,6 +28,23 @@ The recipe is awesome. It does thing 1, thing 2 and thing 3!
 
 MyApp Admin Group: The group allowed to manage MyApp.
 
+# Resources
+
+* [fixture](#fixture) - This resource is awesome.
+
+## fixture
+
+This resource is awesome.
+
+### Actions
+
+- stuff: Does awesome things. 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>.
+
 # Credits
 
 * Mathias Lafeldt

data/fixture/resources/default.rb

@@ -0,0 +1,13 @@
+#<
+# This resource is awesome.
+#
+# @action stuff Does awesome things.
+#>
+
+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

@@ -120,8 +120,11 @@
 <% unless resource.actions.empty? -%>
 ### Actions
 
+<% if resource.default_action.is_a?(Array) %>
+- Default actions: [<%= resource.default_action.join ', ' %>]
+<% end %>
 <% resource.actions.each do |action| -%>
-- <%= action %>: <%= resource.action_description(action) %><% if resource.default_action == action %> Default action.<% end %>
+- <%= action %>: <%= resource.action_description(action) %><% if !resource.default_action.is_a?(Array) && resource.default_action == action %> Default action.<% end %>
 <% end -%>
 <% end -%>
 <% unless resource.attributes.empty? -%>

data/lib/knife_cookbook_doc/documenting_lwrp_base.rb

@@ -14,6 +14,12 @@ class DocumentingLWRPBase < ::Chef::Resource::LWRPBase
     def description
       @description || ""
     end
+
+    NOT_PASSED = defined?(::Chef::NOT_PASSED) ? ::Chef::NOT_PASSED : "NOT_PASSED"
+    def property(name, type = NOT_PASSED, **options)
+      attribute_specifications[name] = options
+      super(name, type, **options) if defined?(super)
+    end
   end
 
   def self.attribute(attr_name, validation_opts={})

data/lib/knife_cookbook_doc/rake_task.rb

@@ -0,0 +1,54 @@
+require 'chef/cookbook/metadata'
+require 'erubis'
+require 'rake'
+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/readme_model'
+require 'knife_cookbook_doc/recipe_model'
+require 'knife_cookbook_doc/resource_model'
+require 'knife_cookbook_doc/attributes_model'
+
+module KnifeCookbookDoc
+  class RakeTask < ::Rake::TaskLib
+    attr_accessor :name, :options
+
+    def initialize(name = :knife_cookbook_doc)
+      @name = name
+      @options = {}
+      yield self if block_given?
+      define
+    end
+
+    def define
+      desc 'Generate cookbook documentation' unless ::Rake.application.last_comment
+      task(name) do
+        merged_options = default_options.merge(options)
+        cookbook_dir = File.realpath(merged_options[:cookbook_dir])
+        model = ReadmeModel.new(cookbook_dir, merged_options[:constraints])
+        template = File.read(merged_options[:template_file])
+        eruby = Erubis::Eruby.new(template)
+        result = eruby.result(model.get_binding)
+
+        File.open("#{cookbook_dir}/#{merged_options[:output_file]}", 'wb') do |f|
+          result.each_line do |line|
+            f.write line.gsub(/[ \t\r\n]*$/,'')
+            f.write "\n"
+          end
+        end
+      end
+    end
+
+    private
+    def default_options
+      {
+        cookbook_dir: './',
+        constraints: true,
+        output_file: 'README.md',
+        template_file: Pathname.new("#{File.dirname(__FILE__)}/../chef/knife/README.md.erb").realpath
+      }
+    end
+  end
+end

data/lib/knife_cookbook_doc/resource_model.rb

@@ -13,16 +13,25 @@ module KnifeCookbookDoc
       @native_resource.resource_name
     end
 
-    # Return the unique set of actions, with the default one first, if there is a default
+    # Return the unique set of actions, with the default one first, if there is a single default
+    # The :nothing action will show up only if it is the only one, or it is  explicitly  documented
     def actions
-      unless @actions
+      return @actions unless @actions.nil?
+
+      if default_action.is_a?(Array)
+        @actions = @native_resource.actions
+      else
         @actions = [default_action].compact + @native_resource.actions.sort.uniq.select { |a| a != default_action }
       end
+
+      @actions.delete(:nothing) if @actions != [:nothing] && action_descriptions[:nothing].nil?
       @actions
     end
 
     def default_action
-      @native_resource.default_action
+      action = @native_resource.default_action
+      return action.first if action.is_a?(Array) && action.length == 1
+      action
     end
 
     def action_description(action)
@@ -65,7 +74,7 @@ module KnifeCookbookDoc
       @native_resource.description.each_line do |line|
         if /^ *\@action *([^ ]*) (.*)$/ =~ line
           action_descriptions[$1] = $2.strip
-        elsif /^ *\@attribute *([^ ]*) (.*)$/ =~ line
+        elsif /^ *(?:\@attribute|\@property) *([^ ]*) (.*)$/ =~ line
           attribute_descriptions[$1] = $2.strip
         elsif /^ *\@section (.*)$/ =~ line
           current_section = $1.strip

data/lib/knife_cookbook_doc/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,62 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Knife plugin to generate README.md for a cookbook
@@ -75,8 +75,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -93,6 +93,7 @@ files:
 - fixture/knife.rb
 - fixture/metadata.rb
 - fixture/recipes/default.rb
+- fixture/resources/default.rb
 - knife_cookbook_doc.gemspec
 - lib/chef/knife/README.md.erb
 - lib/chef/knife/cookbook_doc.rb
@@ -100,6 +101,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/rake_task.rb
 - lib/knife_cookbook_doc/readme_model.rb
 - lib/knife_cookbook_doc/recipe_model.rb
 - lib/knife_cookbook_doc/resource_model.rb
@@ -116,21 +118,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Knife plugin to generate README.md for a cookbook
 test_files:
 - spec/knife_cookbook_doc/attribute_model_spec.rb
 - spec/spec_helper.rb
-has_rdoc: