puppet-strings 4.1.3 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f5cc43b3dfbc54e6a559b97f6b7bce4e5a8d6a94ff46f118095c7bcde517bbb
-  data.tar.gz: 2dd5bac66f509884479026f24b154f81e13e78edef723b1f482036447f0d942c
+  metadata.gz: 15e623045d2f26993f1193bde5d1a00c6eff406dff7eb4e3e40b198f74dfa92c
+  data.tar.gz: f9428ce6e6ce52b7a7ce92a755c0c1592e5eb0cd5e96c82aa4fd829a7877b0e5
 SHA512:
-  metadata.gz: b7203752a05e060ab1b92f9f2b952ab7cea1cb681ae7f1bd45368427f6202555bec2efb884f78f9ff27385fe6b931e037fd02234f9326073e26fbd72701e325c
-  data.tar.gz: 6d0afed23ef6b0a60600d85f359375887303759b59fba5661644f26aa0cd3ca3dfc2f154dca94397531cd1d1a562560c78f46f4262d604a92ead1f68f2168e9b
+  metadata.gz: fff9cbb435f70ff2d4d41c8956737c1a7adf1f2fb14110eb044a79e69d710e61b421828399b90c0ec4ee745d9c0ae0da5c4b538a9da1d89fbeb4f27822695988
+  data.tar.gz: 57fbf41d3236e9543a6313694ef3ecd01d96556ac93bb4f35cd4c9ea1f9d1267d47ba04f525fc9a07bf5cf1acd38b0ba23b9c2a24f008a8b1827e2c10c28eebb

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org).
 
+## [v5.0.0](https://github.com/puppetlabs/puppet-strings/tree/v5.0.0) - 2025-06-09
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v4.1.3...v5.0.0)
+
+### Changed
+
+- (CAT-2281) Remove puppet 7 infrastructure [#407](https://github.com/puppetlabs/puppet-strings/pull/407) ([LukasAud](https://github.com/LukasAud))
+
+### Fixed
+
+- Rake task allows for a different commit message [#408](https://github.com/puppetlabs/puppet-strings/pull/408) ([ghoneycutt](https://github.com/ghoneycutt))
+- clarifies the puppet-strings usage [#405](https://github.com/puppetlabs/puppet-strings/pull/405) ([binford2k](https://github.com/binford2k))
+- List puppet as runtime dependency [#404](https://github.com/puppetlabs/puppet-strings/pull/404) ([bastelfreak](https://github.com/bastelfreak))
+
 ## [v4.1.3](https://github.com/puppetlabs/puppet-strings/tree/v4.1.3) - 2024-09-05
 
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v4.1.2...v4.1.3)

data/README.md

@@ -11,8 +11,8 @@ Strings processes code and YARD-style code comments to create documentation in H
 
 ### Requirements
 
-* Ruby 2.7.0 or newer
-* Puppet 7.0.0 or newer
+* Ruby 3.1.0 or newer
+* Puppet 8.0.0 or newer
 
 ### Install Puppet Strings
 

data/lib/puppet/face/strings.rb

@@ -4,7 +4,7 @@ require 'puppet/face'
 
 # Implements the 'puppet strings' interface.
 Puppet::Face.define(:strings, '0.0.1') do # rubocop:disable Metrics/BlockLength
-  summary 'Generate Puppet documentation with YARD.'
+  summary 'Generate Puppet module documentation with YARD.'
 
   action(:generate) do
     default

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

@@ -181,7 +181,7 @@ module PuppetStrings::Markdown
     def toc_info
       {
         name: name.to_s,
-        link: link,
+        link:,
         desc: summary || @registry[:docstring][:text][0..140].tr("\n", ' '),
         private: private?
       }

data/lib/puppet-strings/tasks/gh_pages.rb

@@ -11,7 +11,9 @@ namespace :strings do
 
         Dir.chdir('doc') do
           system 'git checkout gh-pages'
+          exit 1 unless $?.success?
           system 'git pull --rebase origin gh-pages'
+          exit 1 unless $?.success?
         end
       else
         git_uri = `git config --get remote.origin.url`.strip
@@ -20,9 +22,13 @@ namespace :strings do
         Dir.mkdir('doc')
         Dir.chdir('doc') do
           system 'git init'
+          exit 1 unless $?.success?
           system "git remote add origin #{git_uri}"
+          exit 1 unless $?.success?
           system 'git pull origin gh-pages'
+          exit 1 unless $?.success?
           system 'git checkout -b gh-pages'
+          exit 1 unless $?.success?
         end
       end
     end
@@ -35,15 +41,23 @@ namespace :strings do
       end
     end
 
-    task :push do
+    # Task to push the gh-pages branch. Argument :msg_prefix is the beginning
+    # of the message and the actual commit will have "at Revision <git_sha>"
+    # appended.
+    task :push, [:msg_prefix] do |_t, args|
+      msg_prefix = args[:msg_prefix] || '[strings] Generated Documentation Update'
+
       output = `git describe --long 2>/dev/null`
       # If a project has never been tagged, fall back to latest SHA
       git_sha = output.empty? ? `git log --pretty=format:'%H' -n 1` : output
 
       Dir.chdir('doc') do
         system 'git add .'
-        system "git commit -m '[strings] Generated Documentation Update at Revision #{git_sha}'"
+        exit 1 unless $?.success?
+        system "git commit -m '#{msg_prefix} at Revision #{git_sha}'"
+        # Do not check status of commit, as it will error if there are no changes.
         system 'git push origin gh-pages -f'
+        exit 1 unless $?.success?
       end
     end
 

data/lib/puppet-strings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PuppetStrings
-  VERSION = '4.1.3'
+  VERSION = '5.0.0'
 end

data/lib/puppet-strings/yard/code_objects/function.rb

@@ -94,7 +94,7 @@ class PuppetStrings::Yard::CodeObjects::Function < PuppetStrings::Yard::CodeObje
         hash[:signatures] << { signature: o.signature, docstring: PuppetStrings::Yard::Util.docstring_to_hash(o.docstring, %i[param option enum return example]) }
       end
     else
-      hash[:signatures] << { signature: signature, docstring: PuppetStrings::Yard::Util.docstring_to_hash(docstring, %i[param option enum return example]) }
+      hash[:signatures] << { signature:, docstring: PuppetStrings::Yard::Util.docstring_to_hash(docstring, %i[param option enum return example]) }
     end
 
     hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)

data/lib/puppet-strings/yard/handlers/puppet/base.rb

@@ -21,7 +21,7 @@ class PuppetStrings::Yard::Handlers::Puppet::Base < YARD::Handlers::Base
     tags.each do |tag|
       next if statement.parameters.find { |p| tag.name == p.name }
 
-      log.warn "The @param tag for parameter '#{tag.name}' has no matching parameter at #{statement.file}:#{statement.line}." unless tag.name == 'name' || tag.name == 'title'
+      log.warn "The @param tag for parameter '#{tag.name}' has no matching parameter at #{statement.file}:#{statement.line}." unless %w[name title].include?(tag.name)
     end
 
     # Assign the types for the parameter

data/lib/puppet-strings/yard/handlers/ruby/base.rb

@@ -6,7 +6,7 @@ require 'ripper'
 class PuppetStrings::Yard::Handlers::Ruby::Base < YARD::Handlers::Ruby::Base
   # A regular expression for detecting the start of a Ruby heredoc.
   # Note: the first character of the heredoc start may have been cut off by YARD.
-  HEREDOC_START = /^<?<[-~]?['"]?(\w+)['"]?[^\n]*\n?/.freeze
+  HEREDOC_START = /^<?<[-~]?['"]?(\w+)['"]?[^\n]*\n?/
 
   protected
 

data/lib/puppet-strings/yard/handlers/ruby/data_type_handler.rb

@@ -237,7 +237,7 @@ class PuppetStrings::Yard::Handlers::Ruby::DataTypeHandler < PuppetStrings::Yard
         default   = value['value'] unless value['value'].nil?
       end
       data_type = [data_type] unless data_type.nil? || data_type.is_a?(Array)
-      params_hash[key] = { types: data_type, default: default }
+      params_hash[key] = { types: data_type, default: }
     end
 
     params_hash

data/lib/puppet-strings/yard/handlers/ruby/provider_handler.rb

@@ -61,7 +61,7 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
         # Look for a call to a dispatch method with a block
         next unless
           child.method_name &&
-          (child.method_name.source == 'desc' || child.method_name.source == 'doc=') &&
+          ['desc', 'doc='].include?(child.method_name.source) &&
           child.parameters(false).count == 1
 
         docstring = node_as_string(child.parameters[0])

data/lib/puppet-strings/yard/handlers/ruby/type_base.rb

@@ -34,7 +34,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeBase < PuppetStrings::Yard::Handl
       elsif child.is_a?(YARD::Parser::Ruby::MethodCallNode)
         # Look for a call to a dispatch method with a block
         next unless child.method_name &&
-                    (child.method_name.source == 'desc' || child.method_name.source == 'doc=') &&
+                    ['desc', 'doc='].include?(child.method_name.source) &&
                     child.parameters(false).count == 1
 
         docstring = node_as_string(child.parameters[0])

data/lib/puppet-strings/yard/parsers/puppet/statement.rb

@@ -7,7 +7,7 @@ module PuppetStrings::Yard::Parsers::Puppet
   # Represents the base Puppet language statement.
   class Statement
     # The pattern for parsing docstring comments.
-    COMMENT_REGEX = /^\s*#+\s?/.freeze
+    COMMENT_REGEX = /^\s*#+\s?/
 
     attr_reader :source, :file, :line, :docstring, :comments_range
 
@@ -170,7 +170,7 @@ module PuppetStrings::Yard::Parsers::Puppet
       case type_expr
       when Puppet::Pops::Model::AccessExpression
         # TODO: I don't like rebuilding the source from the AST, but AccessExpressions don't expose the original source
-        @alias_of = +"#{PuppetStrings::Yard::Util.ast_to_text(type_expr.left_expr)}[" # alias_of should be mutable so we add a + to the string.
+        @alias_of = "#{PuppetStrings::Yard::Util.ast_to_text(type_expr.left_expr)}[" # alias_of should be mutable so we add a + to the string.
         @alias_of << type_expr.keys.map { |key| PuppetStrings::Yard::Util.ast_to_text(key) }.join(', ')
         @alias_of << ']'
       else

data/lib/puppet-strings/yard/tags/overload_tag.rb

@@ -75,8 +75,8 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # @param [Array] args The args passed to the method.
   # @param block The block passed to the method.
   # @return Returns what the method call on the object would return.
-  def method_missing(method_name, *args, &block)
-    return object.send(method_name, *args, &block) if object.respond_to? method_name
+  def method_missing(method_name, ...)
+    return object.send(method_name, ...) if object.respond_to? method_name
 
     super
   end

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

@@ -4,13 +4,7 @@
 # @return [Array<YARD::Tag>] Returns the parameter tags if the object should have parameters.
 def param
   tag(:param) if
-    object.type == :method ||
-    object.type == :puppet_class ||
-    object.type == :puppet_data_type ||
-    object.type == :puppet_defined_type ||
-    object.type == :puppet_function ||
-    object.type == :puppet_task ||
-    object.type == :puppet_plan
+    %i[method puppet_class puppet_data_type puppet_defined_type puppet_function puppet_task puppet_plan].include?(object.type)
 end
 
 # Renders the overload section.

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

@@ -40,7 +40,7 @@ module PuppetStrings::Yard::Util
 
       tag = { tag_name: t.tag_name }
       # grab nested information for @option and @enum tags
-      if tag[:tag_name] == 'option' || tag[:tag_name] == 'enum'
+      if %w[option enum].include?(tag[:tag_name])
         tag[:opt_name] = t.pair.name
         tag[:opt_text] = t.pair.text
         tag[:opt_types] = t.pair.types if t.pair.types

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 5.0.0
 platform: ruby
 authors:
 - Puppet Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2025-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: rgen
   requirement: !ruby/object:Gem::Requirement
@@ -31,9 +45,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -41,10 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.9.37
-description: 
+description:
 email: info@puppet.com
 executables: []
 extensions: []
@@ -232,7 +240,7 @@ homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,16 +248,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- puppet, >= 7.0.0
-rubygems_version: 3.1.6
-signing_key: 
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []