knife-cookbook-doc 0.24.1 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 352a68b24110e8c990e327478345214b3b4e619d
-  data.tar.gz: 92555f89d0f0d0812eb76a04fa2b509714ea357d
+  metadata.gz: cf3382df756fcf1c8789beffa5b2a14364a9f12e
+  data.tar.gz: 2fdff7fcaa6c1fa3d447d3dc769418989063f708
 SHA512:
-  metadata.gz: 0554d09c9f95fc917c6019166ae033901b01e50a3586f4c3f66686bd95aba34bf8cfd98234c2d8c282fae829ef7912ab369a81acabd327355fe4c82d89e2c420
-  data.tar.gz: 7941527cf37668835415a97e12ef35bd63b207b3db55ad8934ccddd0a202cc82ac7f839e5df9afaabbc94eb698237b6b232ab70e0522f236fc20cb99d8974ea3
+  metadata.gz: 68d087001a289bb1ea5d1e697a53e606a3da0f88826dba7e4ed7d0aa27b9daacc455d933740644c0b3f201b81b1677c3d5855882d4395b607c433f10da1e79fb
+  data.tar.gz: 999f4b72d106d83b211be21b2b082ef6c14ad4f63aea0e0c1b7ed64237846d302c9a3b0c4dd5efe2dd249e570f485ab02cc836950805e18514e63038a4b215f2

data/.gitattributes

@@ -5,6 +5,7 @@
 *.md text
 *.rb text
 *.yml text
+.gitattributes text
 .gitignore text
 Gemfile text
 LICENSE text

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+<!--
+Thanks for your interest in the project. I appreciate bugs filed and PRs submitted!
+Please make sure that you are familiar with and follow the Code of Conduct for
+this project (found in the CODE_OF_CONDUCT.md file).
+
+Please fill out this template with all the relevant information so we can
+understand what's going on and fix the issue.
+
+I may ask you to submit the fix (after giving some direction).
+-->
+
+Environment:
+
+<!--
+  Please provide the version of this project where the issue occurred as well as the
+  versions of other environmental factors. This could be virtual machine version, os
+  version, browser version etc.
+-->
+
+Relevant code or config:
+
+```
+
+```
+
+What you did:
+
+
+
+What happened:
+
+<!-- Please provide the full error message/screenshots/anything -->
+
+Reproduction repository:
+
+<!--
+If possible, please create a repository that reproduces the issue with the
+minimal amount of code possible.
+-->
+
+Problem description:
+
+
+
+Suggested solution:

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 cache: bundler
-sudo: false
 gemfile: fixture/gemfile
 
 rvm:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.24.2 (Dec 17 2018)
+
+* Add chef_versions support. Submitted by Nikolay Antsiferov.
+
 # v0.24.1 (Oct 2 2017)
 
 * Fix the markdown spacing for maintainer/source/issues URL. Submitted by Jamie Tanna.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,73 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter@realityforge.org. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org

data/CONTRIBUTING.md

@@ -1,19 +1,34 @@
 # How to Contribute
 
-Pull requests are greatly appreciated and are what makes opensource great. Here's a quick guide:
+We'd love to accept your patches and contributions to this project. Pull requests are part of
+what makes open source great. There are just a few small guidelines you need to follow.
 
-* Fork it
-* Create your feature branch (`git checkout -b my-new-feature`)
-* Commit your changes (`git commit -am 'Add some feature'`)
-* Push to the branch (`git push origin my-new-feature`)
-* Create new Pull Request
+## Code of Conduct
 
-Pester us if we don't get your Pull Requests merged in a timely fashion. :)
+Participation in this project comes under the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md)
+
+## Submitting code via Pull Requests
+
+- We follow the [Github Pull Request Model](https://help.github.com/articles/about-pull-requests/) for
+  all contributions.
+- For large bodies of work, we recommend creating an issue outlining the feature that you wish to build,
+  and describing how it will be implemented. This gives a chance for review to happen early, and ensures
+  no wasted effort occurs.
+- All submissions, will require review before being merged.
+- Finally - *Thanks* for considering submitting code to the project!
+
+## Formatting
+
+When submitting pull requests, make sure to do the following:
+
+- Maintain the same code style as the rest of the project.
+- Remove trailing whitespace. Many editors will do this automatically.
+- Ensure any new files have [a trailing newline](https://stackoverflow.com/questions/5813311/no-newline-at-end-of-file)
 
 ## How to speed the merging of pull requests
 
-* Describe your changes in the CHANGELOG.
-* Give yourself some credit in the appropriate place (usually the CHANGELOG).
+* Describe your changes in the CHANGELOG.md (if present).
+* Give yourself some credit in the appropriate place (usually the CHANGELOG.md).
 * Make commits of logical units.
 * Ensure your commit messages help others understand what you are doing and why.
 * Check for unnecessary whitespace with `git diff --check` before committing.
@@ -23,4 +38,6 @@ Pester us if we don't get your Pull Requests merged in a timely fashion. :)
 ## Additional Resources
 
 * [General GitHub documentation](http://help.github.com/)
-* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [How to write a good Git Commit message](https://chris.beams.io/posts/git-commit/) -
+  Great way to make sure your Pull Requests get accepted.
+* [An Open Source Etiquette Guidebook](https://css-tricks.com/open-source-etiquette-guidebook/#article-header-id-1)

data/fixture/README-expected.md

@@ -6,6 +6,11 @@
 
 # Requirements
 
+
+## Chef Client:
+
+*No Chef versions defined*
+
 ## Platform:
 
 * cookbook-authors

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

@@ -12,6 +12,17 @@
 <%= fragments['requirements'] -%>
 
 <% end -%>
+
+## Chef Client:
+
+<% unless chef_versions.empty? %>
+<% chef_versions.each do |chef_version| %>
+* <%= chef_version %>
+<% end %>
+<% else %>
+*No Chef versions defined*
+<% end %>
+
 ## Platform:
 
 <% unless platforms.empty? %>

data/lib/knife_cookbook_doc/readme_model.rb

@@ -96,6 +96,16 @@ module KnifeCookbookDoc
       end
     end
 
+    def chef_versions
+      if @metadata.methods.include?(:chef_version)
+        @metadata.chef_versions.map do |chef_version, version|
+          format_constraint(chef_version, version)
+        end
+      else
+        []
+      end
+    end
+
     def dependencies
       @metadata.dependencies.map do |cookbook, version|
         format_constraint(cookbook, version)
@@ -103,20 +113,32 @@ module KnifeCookbookDoc
     end
 
     def recommendations
-      @metadata.recommendations.map do |cookbook, version|
-        format_constraint(cookbook, version)
+      if @metadata.methods.include?(:recommendations)
+        @metadata.recommendations.map do |cookbook, version|
+          format_constraint(cookbook, version)
+        end
+      else
+        []
       end
     end
 
     def suggestions
-      @metadata.suggestions.map do |cookbook, version|
-        format_constraint(cookbook, version)
+      if @metadata.methods.include?(:suggestions)
+        @metadata.suggestions.map do |cookbook, version|
+          format_constraint(cookbook, version)
+        end
+      else
+        []
       end
     end
 
     def conflicting
-      @metadata.conflicting.map do |cookbook, version|
-        format_constraint(cookbook, version)
+      if @metadata.methods.include?(:conflicting)
+        @metadata.conflicting.map do |cookbook, version|
+          format_constraint(cookbook, version)
+        end
+      else
+        []
       end
     end
 

data/lib/knife_cookbook_doc/version.rb

@@ -1,3 +1,3 @@
 module KnifeCookbookDoc
-  VERSION = '0.24.1'
+  VERSION = '0.24.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-doc
 version: !ruby/object:Gem::Version
-  version: 0.24.1
+  version: 0.24.2
 platform: ruby
 authors:
 - Mathias Lafeldt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2018-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -76,9 +76,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitattributes"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE