knife-cookbook-doc 0.10.0 → 0.11.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.11.0 (Jun 5 2014)
+--------------------
+
+* Be honest about attribute types. Submitted by benlangfeld.
+
 v0.10.0 (Mar 3 2014)
 --------------------
 

data/CONTRIBUTING.md

@@ -12,7 +12,7 @@ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
 
 ## How to speed the merging of pull requests
 
-* Describe your changes in the CHANGELOG. 
+* Describe your changes in the CHANGELOG.
 * Give yourself some credit in the appropriate place (usually the CHANGELOG).
 * Make commits of logical units.
 * Ensure your commit messages help others understand what you are doing and why.

data/README.md

@@ -35,7 +35,7 @@ If the user has not specified documentation for the recipe in `metadata.rb`
 then the tool takes the first sentence of the detailed documentation as the
 summary to use in the table of contents.
 
-#### Step 2
+#### Step 3
 
 If the user has not specified documentation for the attributes in `metadata.rb`
 then the tool scans the attribute files and uses the documentation block
@@ -44,7 +44,7 @@ preceding the attribute.
     #<> MyApp Admin Group: The group allowed to manage MyApp.
     default['myapp']['group'] = 'myapp-admin'
 
-#### Step 3
+#### Step 4
 
 In each LWRP, add detailed documentation such as;
 
@@ -78,7 +78,7 @@ 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.
 
-#### Step 4
+#### Step 5
 
 In each definition add documentation like:
 
@@ -91,7 +91,7 @@ In each definition add documentation like:
 
         @section Examples
 
-            # An example of my awesome service
+            # An example of my awesome definition
             mycookbook_awesome_definition "app resources" do
               user 'appuser'
               group 'appgroup'
@@ -100,7 +100,7 @@ In each definition add documentation like:
       =end
 
 
-#### Step 5
+#### Step 6
 
 Finally the user should add some documentation fragments into the `doc/` dir.
 Most importantly you should add `doc/overview.md` which will replace the first

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

@@ -41,7 +41,7 @@
 
 <% unless attributes.empty? %>
 <% attributes.each do |name, description, default, choice| %>
-* `<%= name %>` - <%= description %><% if !description.nil? && !description.strip.end_with?(".") %>.<% end %> <% unless choice.empty? %>Available options: <%= "`#{choice.join('`, `')}`" %>. <% end %>Defaults to `<%= default %>`.
+* `<%= name %>` - <%= description %><% if !description.nil? && !description.strip.end_with?(".") %>.<% end %> <% unless choice.empty? %>Available options: <%= "`#{choice.map(&:inspect).join('`, `')}`" %>. <% end %>Defaults to `<%= default.inspect %>`.
 <% end %>
 <% else %>
 *No attributes defined*

data/lib/knife_cookbook_doc/attributes_model.rb

@@ -32,7 +32,7 @@ module KnifeCookbookDoc
         else
           value = value.gsub(/\A\"|\A'|\"\Z|'\Z/, '')
         end
-        
+
         options = {}
         options[:default] = value
         @attributes[name] = options
@@ -50,7 +50,7 @@ module KnifeCookbookDoc
       end
     end
 
-    def update_attribute(name, description) 
+    def update_attribute(name, description)
       name = get_attribute_name(name)
       options = @attributes[name]
       options[:description] = description.strip

data/lib/knife_cookbook_doc/base_model.rb

@@ -1,44 +1,44 @@
-module KnifeCookbookDoc
-  module BaseModel
-
-    def top_level_description(section)
-      (top_level_descriptions[section.to_s] || []).join("\n").gsub(/\n+$/m,"\n")
-    end
-
-    def top_level_descriptions
-      @top_level_descriptions ||= {}
-    end
-
-    def short_description
-      unless @short_description
-        @short_description = first_sentence(top_level_description('main'))
-      end
-      @short_description
-    end
-
-    private
-
-    def first_sentence(string)
-      string.gsub(/^(.*?\.(\z|\s))/m) do |match|
-        return $1.gsub("\n",' ').strip
-      end
-      return nil
-    end
-
-    def extract_description
-      description = []
-      IO.read(@filename).gsub(/^=begin *\n *\#\<\n(.*?)^ *\#\>\n=end *\n/m) do
-        description << $1
-        ""
-      end.gsub(/^ *\#\<\n(.*?)^ *\#\>\n/m) do
-        description << $1.gsub(/^ *\# ?/, '')
-        ""
-      end.gsub(/^ *\#\<\> (.*?)$/) do
-        description << $1
-        ""
-      end
-      description.join("\n")
-    end
-
-  end
-end
+module KnifeCookbookDoc
+  module BaseModel
+
+    def top_level_description(section)
+      (top_level_descriptions[section.to_s] || []).join("\n").gsub(/\n+$/m,"\n")
+    end
+
+    def top_level_descriptions
+      @top_level_descriptions ||= {}
+    end
+
+    def short_description
+      unless @short_description
+        @short_description = first_sentence(top_level_description('main'))
+      end
+      @short_description
+    end
+
+    private
+
+    def first_sentence(string)
+      string.gsub(/^(.*?\.(\z|\s))/m) do |match|
+        return $1.gsub("\n",' ').strip
+      end
+      return nil
+    end
+
+    def extract_description
+      description = []
+      IO.read(@filename).gsub(/^=begin *\n *\#\<\n(.*?)^ *\#\>\n=end *\n/m) do
+        description << $1
+        ""
+      end.gsub(/^ *\#\<\n(.*?)^ *\#\>\n/m) do
+        description << $1.gsub(/^ *\# ?/, '')
+        ""
+      end.gsub(/^ *\#\<\> (.*?)$/) do
+        description << $1
+        ""
+      end
+      description.join("\n")
+    end
+
+  end
+end

data/lib/knife_cookbook_doc/definitions_model.rb

@@ -37,7 +37,7 @@ module KnifeCookbookDoc
       code = IO.read(@filename)
       code.gsub(/^ *define (.*?) (?=do)/m) do
         all = $1.split(' ', 2)
-        @name = all.shift.gsub(/:/, '')
+        @name = all.shift.gsub(/:|,/, '')
         next if all.empty?
         all = eval("{#{all.last}}") rescue {}
         all.each do |k, v|

data/lib/knife_cookbook_doc/readme_model.rb

@@ -19,7 +19,7 @@ module KnifeCookbookDoc
           if !model.attributes.empty?
             @attributes += model.attributes
           end
-        end        
+        end
       end
 
       @resources = []

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-02 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef