puppet-strings 3.0.1 → 4.0.0

data/lib/puppet-strings/yard/templates/default/puppet_defined_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_defined_type/html/setup.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
 end

data/lib/puppet-strings/yard/templates/default/puppet_function/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, [:note, :todo, T('tags'), :source]
+  sections :header, :box_info, :summary, :overview, [:note, :todo, :deprecated, T('tags'), :source]
 end

data/lib/puppet-strings/yard/templates/default/puppet_plan/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_plan/html/setup.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
 end
 
 # Renders the box_info section.

data/lib/puppet-strings/yard/templates/default/puppet_provider/html/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init

data/lib/puppet-strings/yard/templates/default/puppet_task/html/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init

data/lib/puppet-strings/yard/templates/default/puppet_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :properties, :parameters, :features
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :properties, :parameters, :features
 end
 
 # Renders the box_info section.
@@ -19,7 +21,7 @@ def properties
   #
   # "checks" such as "creates" and "onlyif" are another type of property
   @parameters = (object.properties || []) + (object.checks || [])
-  @parameters.sort_by! { |p| p.name }
+  @parameters.sort_by!(&:name)
   @tag_title = 'Properties'
   erb(:parameters)
 end
@@ -28,7 +30,7 @@ end
 # @return [String] Returns the rendered section.
 def parameters
   @parameters = object.parameters || []
-  @parameters.sort_by! { |p| p.name }
+  @parameters.sort_by!(&:name)
   @tag_title = 'Parameters'
   erb(:parameters)
 end

data/lib/puppet-strings/yard/templates/default/tags/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Called to return parameter tags.
 # @return [Array<YARD::Tag>] Returns the parameter tags if the object should have parameters.
 def param
@@ -14,7 +16,7 @@ end
 # Renders the overload section.
 # @return [String] Returns the rendered section.
 def overload
-  erb(if object.type == :puppet_function then :puppet_overload else :overload end)
+  erb(object.type == :puppet_function ? :puppet_overload : :overload)
 end
 
 # Renders the enum section.

data/lib/puppet-strings/yard/util.rb

@@ -9,10 +9,8 @@ module PuppetStrings::Yard::Util
   # @param [String] str The string to scrub.
   # @return [String] A scrubbed string.
   def self.scrub_string(str)
-    match = str.match(%r{^%[Qq]{(.*)}$}m)
-    if match
-      return Puppet::Util::Docs.scrub(match[1])
-    end
+    match = str.match(/^%[Qq]{(.*)}$/m)
+    return Puppet::Util::Docs.scrub(match[1]) if match
 
     Puppet::Util::Docs.scrub(str)
   end
@@ -25,7 +23,7 @@ module PuppetStrings::Yard::Util
   # @param [String] data HTML document to convert
   # @return [String] HTML document with links converted
   def self.github_to_yard_links(data)
-    data.scan(%r{href\=\"\#(.+)\"}).each do |bad_link|
+    data.scan(/href="\#(.+)"/).each do |bad_link|
       data = data.gsub("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.tr('-', '+')}\"")
     end
 

data/lib/puppet-strings/yard.rb

@@ -61,7 +61,7 @@ class YARD::CLI::Yardoc
       :puppet_provider,
       :puppet_function,
       :puppet_task,
-      :puppet_plan,
+      :puppet_plan
     )
   end
 end

data/lib/puppet-strings.rb

@@ -1,5 +1,3 @@
-# rubocop:disable Naming/FileName
-
 # frozen_string_literal: true
 
 # The root module for Puppet Strings.
@@ -50,16 +48,13 @@ module PuppetStrings
     YARD::CLI::Yardoc.run(*args)
 
     # If outputting JSON, render the output
-    if options[:json] && !options[:describe]
-      render_json(file)
-    end
+    render_json(file) if options[:json] && !options[:describe]
 
     # If outputting Markdown, render the output
-    if options[:markdown]
-      render_markdown(file)
-    end
+    render_markdown(file) if options[:markdown]
 
     return unless options[:describe]
+
     render_describe(options[:describe_types], options[:describe_list], options[:providers])
   end
 

metadata

@@ -1,56 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-25 00:00:00.000000000 Z
+date: 2023-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: rgen
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
 description: 
 email: info@puppet.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
-- COMMITTERS.md
 - CONTRIBUTING.md
 - LICENSE
 - README.md
 files:
 - CHANGELOG.md
-- COMMITTERS.md
 - CONTRIBUTING.md
 - LICENSE
 - README.md
@@ -137,6 +135,7 @@ files:
 - lib/puppet-strings/yard/templates/default/layout/html/objects.erb
 - lib/puppet-strings/yard/templates/default/layout/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/overview.erb
@@ -145,6 +144,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_class/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_data_type/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/note.erb
@@ -155,6 +155,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/alias_of.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/overview.erb
@@ -163,6 +164,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/overview.erb
@@ -171,6 +173,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/overview.erb
@@ -179,6 +182,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_function/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_plan/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_plan/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_plan/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_plan/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_plan/html/overview.erb
@@ -201,6 +205,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_task/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_task/html/supports_noop.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/box_info.erb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/deprecated.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/features.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/note.erb
@@ -236,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- puppet, >= 6.0.0
+- puppet, >= 7.0.0
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4

data/COMMITTERS.md

@@ -1,185 +0,0 @@
-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 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).
-
-Therefore, it is the responsibility of the committer to re-base the change set
-on the appropriate branch which should receive the contribution.
-
-It is also the responsibility of the committer to review the change set in an
-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 `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.
-
-The rest of this document addresses the concerns of the committer.  This
-document will help guide the committer decide which branch to base, or re-base
-a contribution on top of.  This document also describes our branch management
-strategy, which is closely related to the decision of what branch to commit
-changes into.
-
-Terminology
-====
-
-Many of these terms have more than one meaning.  For the purposes of this
-document, the following terms refer to specific things.
-
-**contributor** - A person who makes a change to strings and submits a change
-set in the form of a pull request.
-
-**change set** - A set of discrete patches which combined together form a
-contribution.  A change set takes the form of Git commits and is submitted to
-strings in the form of a pull request.
-
-**committer** - A person responsible for reviewing a pull request and then
-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 `main` will always exist as a base branch.
-
-**main branch** - The branch where new functionality that and bug fixes are
-merged.
-
-**security** - Where critical security fixes are merged.  These change sets
-will then be merged into release branches independently from one another. (i.e.
-no merging up).  Please do not submit pull requests against the security branch
-and instead report all security related issues to security@puppet.com as
-per our security policy published at
-[https://puppet.com/security/](https://puppet.com/security/).
-
-Committer Guide
-====
-
-This section provides a guide to follow while committing change sets to strings
-base branches.
-
-How to decide what release(s) should be patched
----
-
-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 `main` if they contain new
-functionality and  if they fix a critical bug.  Older minor releases in a major release 
-do not get patched.
-
-Before the switch to [semantic versions](http://semver.org/) committers did not
-have to think about the difference between minor and major releases.
-Committing to the latest minor release of a major release is a policy intended
-to limit the number of active base branches that must be managed.
-
-Security patches are handled as a special case.  Security patches may be
-applied to earlier minor releases of a major release, but the patches should
-first be merged into the `security` branch.  Security patches should be merged
-by Puppet Labs staff members.  Pull requests should not be submitted with the
-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 `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.
-
-Code review checklist
----
-
-This section aims to provide a checklist of things to look for when reviewing a
-pull request and determining if the change set should be merged into a base
-branch:
-
- * All tests pass
- * Are there any platform gotchas? (Does a change make an assumption about
-   platform specific behavior that is incompatible with other platforms?  e.g.
-   Windows paths vs. POSIX paths.)
- * Is the change backwards compatible? (It should be)
- * Are there YARD docs for API changes?
- * Does the change set also require documentation changes? If so is the
-   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 main --check`
- * Does the change set conform to the contributing guide?
-
-Commit citizen guidelines:
----
-
-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://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 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
-   will automatically close the pull request when the branch is pushed.)
-
-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 main.  The change set
-fixes a bug reported against strings 0.1.0  which is the most recently released
-version of strings.
-
-First, the committer pulls down the branch using the `hub` gem.  This tool
-automates the process of adding the remote repository and creating a local
-branch to track the remote branch.
-
-    $ hub checkout https://github.com/puppetlabs/puppet-strings/pull/123
-    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 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/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 
-`main` branch, the committer merges in:
-
-    $ 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
-     1 file changed, 0 insertions(+), 0 deletions(-)
-     create mode 100644 foo
-
-Once the change set has been merged into one base branch, the change set should
-not be modified in order to keep the history clean, avoid "double" commits, and
-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 `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 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
-status](http://jenkins.puppetlabs.com).