puppet-strings 2.4.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bfc095b6c7aa9124cfa44c79aa0404361fbe9b3971e58495aa8354f1b84163a
-  data.tar.gz: 56c425e69b8bd4b1e9c6a0bb07a25ca806d880e6e9a865afa8137d12b5412442
+  metadata.gz: a2d5345c5e091cd9e41b404f7529168e8e10b737d26b3b1b9a5a5bfbf118e062
+  data.tar.gz: 0bddf9dac1b890e8b487e261fd5eec2b3df45eecbc400af22602c1aac29aa99e
 SHA512:
-  metadata.gz: 0a0fcbc8af4653fb35166cad42488f21bf5f046092ef1434331c7d4ba03fa4ac2544c3e220859c9dc2de94b4a263caed7b35a6185df297bf6dbb631553601f9d
-  data.tar.gz: 7cf9f63f1fd50af678f4b3891ed7ac9da3d5eda249de6df50dd10ac93eed078f1f7fab6b5ca6945e6e057e89ce55c227b4aba1aab84884e6d89b1f039677ed38
+  metadata.gz: 6399094f9117b6966c7b91f4ec6438f6877faf0b25ab7f2b322957f1cf81719ddae70357d32d252a7276f9795f9bce6305b8c999f1f853ec83dbd35131030d99
+  data.tar.gz: faef11c0d37eb368b8e36a6bc7743669a7ad184893c969317434711ae13e6513e033393eb9b64e33f6d6e16f9bd0ff46dc4a784ba0ec574d398896c5b2dea095

data/CHANGELOG.md

@@ -3,7 +3,95 @@
 All significant changes to this repo will be summarized in this file.
 
 
-## [v2.4.0](https://github.com/puppetlabs/puppet-strings/tree/v2.4.0) (2020-02-18)
+## [v2.8.0](https://github.com/puppetlabs/puppet-strings/tree/v2.8.0) (2021-07-19)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.7.0...v2.8.0)
+
+Added
+
+- \(DOCUMENT-1232\) Add support for ensurable in types\_extras\_handler [\#281](https://github.com/puppetlabs/puppet-strings/pull/281) ([joshcooper](https://github.com/joshcooper))
+
+**Merged pull requests:**
+
+- \(FIXUP\) Check for nil before injecting provider param into Types [\#285](https://github.com/puppetlabs/puppet-strings/pull/285) ([scotje](https://github.com/scotje))
+- README.md: update link to docs [\#276](https://github.com/puppetlabs/puppet-strings/pull/276) ([kenyon](https://github.com/kenyon))
+
+## [v2.7.0](https://github.com/puppetlabs/puppet-strings/tree/v2.7.0) (2021-05-17)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.6.0...v2.7.0)
+
+Added
+
+- Add supported\_features to puppet strings input/output for types [\#228](https://github.com/puppetlabs/puppet-strings/issues/228)
+
+Fixed
+
+- `file` type is missing `ensure` in generated reference docs [\#230](https://github.com/puppetlabs/puppet-strings/issues/230)
+
+**Closed issues:**
+
+- class with "apply" attribute causes parser error [\#251](https://github.com/puppetlabs/puppet-strings/issues/251)
+
+**Merged pull requests:**
+
+- Update CODEOWNERS [\#272](https://github.com/puppetlabs/puppet-strings/pull/272) ([binford2k](https://github.com/binford2k))
+- Only set tasks = true when parsing plans. [\#266](https://github.com/puppetlabs/puppet-strings/pull/266) ([binford2k](https://github.com/binford2k))
+
+## [v2.6.0](https://github.com/puppetlabs/puppet-strings/tree/v2.6.0) (2021-01-18)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.5.0...v2.6.0)
+
+Added
+
+- Improved markdown templates [\#252](https://github.com/puppetlabs/puppet-strings/pull/252) ([kozl](https://github.com/kozl))
+
+Fixed
+
+- Do not fail in case return tag has no type specified [\#268](https://github.com/puppetlabs/puppet-strings/pull/268) ([tiandrey](https://github.com/tiandrey))
+- Handle a missing description gracefully [\#260](https://github.com/puppetlabs/puppet-strings/pull/260) ([scotje](https://github.com/scotje))
+- Fix ERB failure - parameters without descriptions [\#255](https://github.com/puppetlabs/puppet-strings/pull/255) ([trevor-vaughan](https://github.com/trevor-vaughan))
+- puppet\_function template: fix tags, source [\#249](https://github.com/puppetlabs/puppet-strings/pull/249) ([raemer](https://github.com/raemer))
+- Handle a missing description gracefully [\#246](https://github.com/puppetlabs/puppet-strings/pull/246) ([ekohl](https://github.com/ekohl))
+
+Changed
+
+- \(MAINT\) Drop Ruby 2.1.x and Puppet 4.x compatibility [\#253](https://github.com/puppetlabs/puppet-strings/pull/253) ([scotje](https://github.com/scotje))
+
+**Closed issues:**
+
+- Tags \(Parameter, Returns\) not generated in HTML output [\#248](https://github.com/puppetlabs/puppet-strings/issues/248)
+- Can we get 2.5.0 released please [\#244](https://github.com/puppetlabs/puppet-strings/issues/244)
+- Provider attribute is missing in generated types documentation [\#227](https://github.com/puppetlabs/puppet-strings/issues/227)
+
+## [v2.5.0](https://github.com/puppetlabs/puppet-strings/tree/v2.5.0) (2020-07-16)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.4.0...v2.5.0)
+
+Added
+
+- \(GH-225\) Document functions in Puppet Datatypes [\#235](https://github.com/puppetlabs/puppet-strings/pull/235) ([glennsarti](https://github.com/glennsarti))
+- Add checks to resource\_type handler and code objects [\#232](https://github.com/puppetlabs/puppet-strings/pull/232) ([scotje](https://github.com/scotje))
+- \(\#227\) Inject `provider` into params list for types with providers [\#231](https://github.com/puppetlabs/puppet-strings/pull/231) ([scotje](https://github.com/scotje))
+
+Fixed
+
+- \(\#242\) Wrap names in backticks when rendering to markdown [\#243](https://github.com/puppetlabs/puppet-strings/pull/243) ([scotje](https://github.com/scotje))
+- Eliminate trailing spaces w/o descriptions [\#224](https://github.com/puppetlabs/puppet-strings/pull/224) ([binford2k](https://github.com/binford2k))
+
+**Closed issues:**
+
+- text rendering as emojis in strings generated docs [\#242](https://github.com/puppetlabs/puppet-strings/issues/242)
+- Puppet Classes not Listed in Left Frame Contents [\#241](https://github.com/puppetlabs/puppet-strings/issues/241)
+- exec type in generated docs missing attributes `creates`, `onlyif` [\#229](https://github.com/puppetlabs/puppet-strings/issues/229)
+- \[Feature\] Document functions in Puppet Datatypes [\#225](https://github.com/puppetlabs/puppet-strings/issues/225)
+- Document usage [\#8](https://github.com/puppetlabs/puppet-strings/issues/8)
+- Need a search box on the main page [\#1](https://github.com/puppetlabs/puppet-strings/issues/1)
+
+**Merged pull requests:**
+
+- Release prep for v2.5.0 [\#245](https://github.com/puppetlabs/puppet-strings/pull/245) ([scotje](https://github.com/scotje))
+
+## [v2.4.0](https://github.com/puppetlabs/puppet-strings/tree/v2.4.0) (2020-02-20)
 
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.3.1...v2.4.0)
 
@@ -13,6 +101,10 @@ Added
 - \(PDOC-295\) Add @enum tag support for Enum data types [\#215](https://github.com/puppetlabs/puppet-strings/pull/215) ([seanmil](https://github.com/seanmil))
 - Expanded default search glob for plans. [\#214](https://github.com/puppetlabs/puppet-strings/pull/214) ([Raskil](https://github.com/Raskil))
 
+**Merged pull requests:**
+
+- \(MAINT\) Release prep for 2.4.0 [\#221](https://github.com/puppetlabs/puppet-strings/pull/221) ([scotje](https://github.com/scotje))
+
 ## [v2.3.1](https://github.com/puppetlabs/puppet-strings/tree/v2.3.1) (2019-09-23)
 
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.3.0...v2.3.1)
@@ -178,7 +270,7 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
   - Note: this means Markdown text in YARD comments and tags, not a change in the output of strings
 - New commandline options: --emit-json and --emit-json-stdout to generate JSON documentation **(PDOC-84)**
 - Runtime dependency on Puppet has been removed, allowing strings to function in Puppet Enterprise 3.8 **(PDOC-80)**
-  - Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the  [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#installing-puppet-strings)
+  - Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the  [README](https://github.com/puppetlabs/puppet-strings/blob/main/README.md#installing-puppet-strings)
 - New gemspec requirement on Ruby version 1.9.3, the oldest supported Ruby version
 
 ### BugFixes
@@ -198,8 +290,8 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
 ### Features
 - Support for JSON output **(PDOC-23)**
   - Strings now has the ability to produce a JSON representation of a given puppet module
-  - The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/master/json_dom.md)
-  - For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#running-puppet-strings)
+  - The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/main/json_dom.md)
+  - For details on how to generate JSON, see the [README](https://github.com/puppetlabs/puppet-strings/blob/main/README.md#running-puppet-strings)
 - Migrate to ruby gems as a distribution method **(PDOC-28)**
   - This is the last release of strings that will be available as a puppet module
   - The 0.4.0 release will be released concurrently as a ruby gem
@@ -282,4 +374,4 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
 - Strings will no longer crash when documenting 3x functions with less than two arguments passed into newfunction **(PDOC-27)**
 
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/COMMITTERS.md

@@ -4,7 +4,7 @@ Committing changes to Strings
 We would like to make it easier for community members to contribute to strings
 using pull requests, even if it makes the task of reviewing and committing
 these changes a little harder.  Pull requests are only ever based on a single
-branch. As a result contributors should target their changes at the master branch.
+branch. As a result contributors should target their changes at the main branch.
 This makes the process of contributing a little easier for the contributor since 
 they don't need to concern themselves with the question, "What branch do I base my changes
 on?"  This is already called out in the [CONTRIBUTING.md](http://goo.gl/XRH2J).
@@ -17,7 +17,7 @@ effort to make sure the end users must opt-in to new behavior that is
 incompatible with previous behavior.  We employ the use of [feature
 flags](http://stackoverflow.com/questions/7707383/what-is-a-feature-flag) as
 the primary way to achieve this user opt-in behavior.  Finally, it is the
-responsibility of the committer to make sure the `master` branch
+responsibility of the committer to make sure the `main` branch
 is clean and working at all times.  Clean means that dead code is not
 allowed, everything needs to be usable in some manner at all points in time.
 
@@ -45,9 +45,9 @@ making the decision what base branch to merge the change set into.
 
 **base branch** - A branch in Git that contains an active history of changes
 and will eventually be released using semantic version guidelines.  The branch
-named `master` will always exist as a base branch.
+named `main` will always exist as a base branch.
 
-**master branch** - The branch where new functionality that and bug fixes are
+**main branch** - The branch where new functionality that and bug fixes are
 merged.
 
 **security** - Where critical security fixes are merged.  These change sets
@@ -70,7 +70,7 @@ This section provides a guide to help a committer decide the specific base
 branch that a change set should be merged into.
 
 The latest minor release of a major release is the only base branch that should
-be patched.  These patches will be merged into `master` if they contain new
+be patched.  These patches will be merged into `main` if they contain new
 functionality and  if they fix a critical bug.  Older minor releases in a major release 
 do not get patched.
 
@@ -87,7 +87,7 @@ security branch as the base branch.  Please send all security related
 information or patches to security@puppet.com as per our [Security
 Policy](https://puppet.com/security/).
 
-The CI systems are configured to run against `master`.  Over time, this branch 
+The CI systems are configured to run against `main`.  Over time, this branch 
 will refer to different versions, but its name will remain fixed to avoid having 
 to update CI jobs and tasks as new versions are released.
 
@@ -108,7 +108,7 @@ branch:
    documentation being kept up to date?
  * Does the change set include clean code?  (software code that is formatted
    correctly and in an organized manner so that another coder can easily read
-   or modify it.)  HINT: `git diff master --check`
+   or modify it.)  HINT: `git diff main --check`
  * Does the change set conform to the contributing guide?
 
 Commit citizen guidelines:
@@ -118,13 +118,13 @@ This section aims to provide guidelines for being a good commit citizen by
 paying attention to our automated build tools.
 
  * Don’t push on a broken build.  (A broken build is defined as a failing job
-   in [Puppet Strings](https://jenkins.puppetlabs.com/job/platform_puppet-strings_unit-ruby_master/)
+   in [Puppet Strings](https://travis-ci.com/github/puppetlabs/puppet-strings)
    page.)
  * Watch the build until your changes have gone through green
  * Update the ticket status and target version.  The target version field in
    our issue tracker should be updated to be the next release of Puppet.  For
    example, if the most recent release of Puppet is 3.1.1 and you merge a
-   backwards compatible change set into master, then the target version should
+   backwards compatible change set into main, then the target version should
    be 3.2.0 in the issue tracker.)
  * Ensure the pull request is closed (Hint: amend your merge commit to contain
    the string `closes #123` where 123 is the pull request number and github
@@ -135,7 +135,7 @@ Example Procedure
 
 This section helps a committer rebase and merge a contribution into the base branch.
 
-Suppose a contributor submits a pull request based on master.  The change set
+Suppose a contributor submits a pull request based on main.  The change set
 fixes a bug reported against strings 0.1.0  which is the most recently released
 version of strings.
 
@@ -147,20 +147,20 @@ branch to track the remote branch.
     Branch jeffmccune-pdoc-34_fix_foo_error set up to track remote branch pdoc-34-fix_foo_error from jeffmccune.
     Switched to a new branch 'jeffmccune-pdoc-34_fix_foo_error'
 
-It's possible that more changes have been merged into master since the pull
+It's possible that more changes have been merged into main since the pull
 request was submitted. In this case it may be necessary to rebase the branch
 that contains the changes:
 
-    $ git rebase upstream/master
+    $ git rebase upstream/main
 
 After the branch has been checked out and rebased, the committer should ensure that
 the code review check list has been completed.
 
 Now that we have a topic branch containing the change set based on the most recent 
-`master` branch, the committer merges in:
+`main` branch, the committer merges in:
 
-    $ git checkout master
-    Switched to branch 'master'
+    $ git checkout main
+    Switched to branch 'main'
     $ git merge --no-ff --log jeffmccune-pdoc-34_fix_foo_error
     Merge made by the 'recursive' strategy.
      foo | 0
@@ -173,12 +173,12 @@ preserve the usefulness of `git branch --contains`.  If there are any merge
 conflicts, they are to be resolved in the merge commit itself and not by
 re-writing (rebasing) the patches for one base branch, but not another.
 
-Once the change set has been merged into `master`, the committer pushes.
+Once the change set has been merged into `main`, the committer pushes.
 Please note, the checklist should be complete at this point. It's helpful to make
 sure your local branches are up to date to avoid one of the branches failing to fast
 forward while the other succeeds.
 
-    $ git push origin master:master
+    $ git push origin main:main
 
 That's it!  The committer then updates the pull request, updates the issue in
 our issue tracker, and keeps an eye on the [build

data/CONTRIBUTING.md

@@ -23,7 +23,7 @@ Before you submit your issue, take a minute to...
    reported.
 
 2. **Check if the issue has been fixed** — try to reproduce it using the
-   latest `master` or release tag.
+   latest `main` or release tag.
 
 A good bug report shouldn't leave others needing to chase you up for more
 information. Please try to be as **detailed as possible** in your issue. What is
@@ -48,12 +48,12 @@ Example:
 ## Making Changes
 
 * Create a topic branch from where you want to base your work.
-  * This is usually the master branch.
+  * This is usually the main branch.
   * Only target release branches if you are certain your fix must be on that
     branch.
-  * To quickly create a topic branch based on master; `git checkout -b
-    fix/master/my_contribution master`. Please avoid working directly on the
-    `master` branch.
+  * To quickly create a topic branch based on main; `git checkout -b
+    fix/main/my_contribution main`. Please avoid working directly on the
+    `main` branch.
 * Make commits of logical units.
 * Check for unnecessary whitespace with `git diff --check` before committing.
 * Make sure your commit messages are in the proper format.
@@ -109,7 +109,7 @@ a ticket number.
 
 ## Cutting a release
 
-To cut a new release, from a current `master` checkout:
+To cut a new release, from a current `main` checkout:
 
 * Start the release branch with `git checkout -b release-prep`
 * Update `lib/puppet-strings/version.rb` to the new version

data/README.md

@@ -1,6 +1,6 @@
 Puppet Strings
 ==============
-[![Build Status](https://travis-ci.org/puppetlabs/puppet-strings.png?branch=master)](https://travis-ci.org/puppetlabs/puppet-strings) [![Gem Version](https://badge.fury.io/rb/puppet-strings.svg)](https://badge.fury.io/rb/puppet-strings)
+[![Build Status](https://travis-ci.org/puppetlabs/puppet-strings.png?branch=main)](https://travis-ci.org/puppetlabs/puppet-strings) [![Gem Version](https://badge.fury.io/rb/puppet-strings.svg)](https://badge.fury.io/rb/puppet-strings)
 
 Puppet Strings generates documentation for Puppet code and extensions written in Puppet and Ruby. Strings processes code and YARD-style code comments to create documentation in HTML, Markdown, or JSON formats.
 
@@ -62,7 +62,7 @@ See the [Puppet Strings documentation](https://puppet.com/docs/puppet/latest/pup
 
 Here are a few other good resources for getting started with documentation:
 
-  * [Module README Template](https://docs.puppet.com/puppet/latest/reference/modules_documentation.html)
+  * [Module README Template](https://puppet.com/docs/puppet/latest/puppet_strings.html)
   * [YARD Getting Started Guide](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)
   * [YARD Tags Overview](http://www.rubydoc.info/gems/yard/file/docs/Tags.md)
 
@@ -70,7 +70,7 @@ Here are a few other good resources for getting started with documentation:
 
 We love contributions from the community!
 
-If you'd like to contribute to `puppet-strings`, check out [CONTRIBUTING.md](https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md) to get information on the contribution process.
+If you'd like to contribute to `puppet-strings`, check out [CONTRIBUTING.md](https://github.com/puppetlabs/puppet-strings/blob/main/CONTRIBUTING.md) to get information on the contribution process.
 
 ### Running Specs
 
@@ -98,14 +98,14 @@ An example of running the acceptance tests locally with Docker:
 3. Provision a docker container, in this case CentOS 7
 
 ``` text
-    $ bundle exec rake litmus:provision[docker, centos:7]
+    $ bundle exec rake 'litmus:provision[docker, centos:7]'
 ```
 
 4. Install test items; Puppet Agent, our test module, and the puppet-strings gem built from this source code
 
 ``` text
-    $ bundle exec rake litmus:install_agent[puppet6]
-    $ bundle exec rake litmus:install_module_fixtures
+    $ bundle exec rake 'litmus:install_agent[puppet6]'
+    $ bundle exec rake 'litmus:install_modules_from_directory[./spec/fixtures/acceptance/modules]'
     $ bundle exec rake litmus:install_gems
 ```
 
@@ -141,9 +141,9 @@ Bug fixes and ongoing development will occur in minor releases for the current m
 
 [repo]: https://github.com/puppetlabs/puppet-strings
 [issues]: https://github.com/puppetlabs/puppet-strings/issues
-[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/master/LICENSE
-[changelog]: https://github.com/puppetlabs/puppet-strings/blob/master/CHANGELOG.md
-[contributing]: https://github.com/puppetlabs/puppet-strings/blob/master/CONTRIBUTING.md
-[committers]: https://github.com/puppetlabs/puppet-strings/blob/master/COMMITTERS.md
+[LICENSE]: https://github.com/puppetlabs/puppet-strings/blob/main/LICENSE
+[changelog]: https://github.com/puppetlabs/puppet-strings/blob/main/CHANGELOG.md
+[contributing]: https://github.com/puppetlabs/puppet-strings/blob/main/CONTRIBUTING.md
+[committers]: https://github.com/puppetlabs/puppet-strings/blob/main/COMMITTERS.md
 [Puppet community Slack]: https://slack.puppet.com
 

data/lib/puppet-strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The root module for Puppet Strings.
 module PuppetStrings
   # The glob patterns used to search for files to document.
@@ -27,8 +29,9 @@ module PuppetStrings
 
     # Format the arguments to YARD
     args = ['doc']
+    args << '--no-progress'
     args << '--debug'     if options[:debug]
-    args << '--backtrace' if options[:backtrace]
+    args << '--backtrace' if options[:debug]
     args << "-m#{options[:markup] || 'markdown'}"
 
     file = nil
@@ -42,7 +45,6 @@ module PuppetStrings
       args << '-n'
       args << '-q' unless file
       args << '--no-stats' unless file
-      args << '--no-progress' unless file
     end
 
     yard_args = options[:yard_args]

data/lib/puppet-strings/describe.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'puppet-strings/json'
 

data/lib/puppet-strings/json.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 # The module for JSON related functionality.

data/lib/puppet-strings/markdown.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings/json'
 
 # module for parsing Yard Registries and generating markdown
@@ -14,16 +16,16 @@ module PuppetStrings::Markdown
   # generates markdown documentation
   # @return [String] markdown doc
   def self.generate
-    final = "# Reference\n"
-    final << "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n"
-    final << PuppetStrings::Markdown::TableOfContents.render
-    final << PuppetStrings::Markdown::PuppetClasses.render
-    final << PuppetStrings::Markdown::DefinedTypes.render
-    final << PuppetStrings::Markdown::ResourceTypes.render
-    final << PuppetStrings::Markdown::Functions.render
-    final << PuppetStrings::Markdown::DataTypes.render
-    final << PuppetStrings::Markdown::PuppetTasks.render
-    final << PuppetStrings::Markdown::PuppetPlans.render
+    final = "# Reference\n\n"
+    final += "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n"
+    final += PuppetStrings::Markdown::TableOfContents.render
+    final += PuppetStrings::Markdown::PuppetClasses.render
+    final += PuppetStrings::Markdown::DefinedTypes.render
+    final += PuppetStrings::Markdown::ResourceTypes.render
+    final += PuppetStrings::Markdown::Functions.render
+    final += PuppetStrings::Markdown::DataTypes.render
+    final += PuppetStrings::Markdown::PuppetTasks.render
+    final += PuppetStrings::Markdown::PuppetPlans.render
 
     final
   end

data/lib/puppet-strings/markdown/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings'
 require 'puppet-strings/json'
 require 'puppet-strings/yard'
@@ -68,7 +70,7 @@ module PuppetStrings::Markdown
 
     # @return [String] top-level name
     def name
-      @registry[:name].to_s unless @registry[:name].nil?
+      @registry[:name]&.to_s
     end
 
     # @return [String] 'Overview' text (untagged text)
@@ -169,10 +171,22 @@ module PuppetStrings::Markdown
       @tags.any? { |tag| tag[:tag_name] == 'api' && tag[:text] == 'private' }
     end
 
+    def word_wrap(text, line_width: 120, break_sequence: "\n")
+      return unless text
+
+      text.split("\n").collect! do |line|
+        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
+      end * break_sequence
+    end
+
     # @return [String] full markdown rendering of a component
     def render(template)
-      file = File.join(File.dirname(__FILE__),"templates/#{template}")
-      ERB.new(File.read(file), nil, '-').result(binding)
+      begin
+        file = File.join(File.dirname(__FILE__),"templates/#{template}")
+        ERB.new(File.read(file), nil, '-').result(binding)
+      rescue StandardError => e
+        fail "Processing #{@registry[:file]}:#{@registry[:line]} with #{file} => #{e}"
+      end
     end
 
     private