puppet-strings 4.1.1 → 4.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a436988d26135b32aebfa60a1629c0bb0abe3901498c323ba626720920adb6a5
-  data.tar.gz: 505f15e76bfa4fc30f9f0a3effd3fa6869c28c9c62d824fe84bd0a463a8ae57d
+  metadata.gz: 8f5cc43b3dfbc54e6a559b97f6b7bce4e5a8d6a94ff46f118095c7bcde517bbb
+  data.tar.gz: 2dd5bac66f509884479026f24b154f81e13e78edef723b1f482036447f0d942c
 SHA512:
-  metadata.gz: 863c8107391d017e15ef16d94b834e7cccf5c6b64e2026f20bd92aa38ba88a21ef635dfe2b80f5ad5008f381fe797368b7d0cf56bb4688a72fd0ddc23230ab49
-  data.tar.gz: 12f98c88971353202a5656798c2c9762b8e4b6806258d89ffbcaade4b84abed6957a045df181da4500e870b170c324f3621269c52f465060464db2b09e067063
+  metadata.gz: b7203752a05e060ab1b92f9f2b952ab7cea1cb681ae7f1bd45368427f6202555bec2efb884f78f9ff27385fe6b931e037fd02234f9326073e26fbd72701e325c
+  data.tar.gz: 6d0afed23ef6b0a60600d85f359375887303759b59fba5661644f26aa0cd3ca3dfc2f154dca94397531cd1d1a562560c78f46f4262d604a92ead1f68f2168e9b

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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).
 
+## [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)
+
+### Fixed
+
+- (bug) - Pin yard to < 0.9.37 [#401](https://github.com/puppetlabs/puppet-strings/pull/401) ([jordanbreen28](https://github.com/jordanbreen28))
+- validate: give hint on how to regenerate outdated REFERENCE.md [#388](https://github.com/puppetlabs/puppet-strings/pull/388) ([kenyon](https://github.com/kenyon))
+- (CAT-1688) Upgrade rubocop to `~> 1.50.0` [#383](https://github.com/puppetlabs/puppet-strings/pull/383) ([LukasAud](https://github.com/LukasAud))
+- Allow numerics for templates using code_maybe_block [#382](https://github.com/puppetlabs/puppet-strings/pull/382) ([seanmil](https://github.com/seanmil))
+
+## [v4.1.2](https://github.com/puppetlabs/puppet-strings/tree/v4.1.2) - 2023-12-05
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v4.1.1...v4.1.2)
+
+### Fixed
+
+- Revert "(maint) - fix rubocop" Leading argument with delegation syntax not supported with ruby 2.7.0 [#376](https://github.com/puppetlabs/puppet-strings/pull/376) ([jordanbreen28](https://github.com/jordanbreen28))
+
 ## [v4.1.1](https://github.com/puppetlabs/puppet-strings/tree/v4.1.1) - 2023-11-22
 
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v4.1.0...v4.1.1)
@@ -30,6 +49,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v3.0.1...v4.0.0.rc.1)
 
 ### Changed
+
 - (CONT-812) Puppet 8 / Ruby 3 support [#348](https://github.com/puppetlabs/puppet-strings/pull/348) ([chelnak](https://github.com/chelnak))
 
 ### Added
@@ -49,6 +69,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.9.0...v3.0.0)
 
 ### Changed
+
 - (CONT-228) Remove deprecated emit flags [#329](https://github.com/puppetlabs/puppet-strings/pull/329) ([chelnak](https://github.com/chelnak))
 - (CONT-228) Bump ruby version [#326](https://github.com/puppetlabs/puppet-strings/pull/326) ([chelnak](https://github.com/chelnak))
 - (#301) Update minimum Ruby version to 2.5.0 [#313](https://github.com/puppetlabs/puppet-strings/pull/313) ([danielparks](https://github.com/danielparks))
@@ -105,6 +126,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.5.0...v2.6.0)
 
 ### 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))
 
 ### Added
@@ -198,6 +220,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 [Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/1.2.1...2.0.0)
 
 ### Changed
+
 - bump required ruby and puppet versions [#178](https://github.com/puppetlabs/puppet-strings/pull/178) ([eputnam](https://github.com/eputnam))
 
 ### Added

data/CONTRIBUTING.md

@@ -124,7 +124,6 @@ To cut a new release, from a current `main` checkout:
 * Run `rake release[upstream]` to release from your checkout
   * make sure to use the name of your git remote pointing to the puppetlabs GitHub repo
 * Remove the release-prep branch
-* Send the release announcements using the template in [misc/ANNOUNCEMENT_TEMPLATE.md](misc/ANNOUNCEMENT_TEMPLATE.md)
 
 # Additional Resources
 

data/lib/puppet/face/strings.rb

@@ -144,7 +144,6 @@ Puppet::Face.define(:strings, '0.0.1') do # rubocop:disable Metrics/BlockLength
   def check_required_features
     raise "The 'yard' gem must be installed in order to use this face." unless Puppet.features.yard?
     raise "The 'rgen' gem must be installed in order to use this face." unless Puppet.features.rgen?
-    raise 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION.match?(/^1\.8/)
   end
 
   # Builds the options to PuppetStrings.generate.

data/lib/puppet-strings/describe.rb

@@ -66,7 +66,7 @@ module PuppetStrings::Describe
     targetlength = 48
     shortento = targetlength - 4
     contentstring = object[:docstring][:text]
-    end_of_line = contentstring.index("\n")  # "." gives closer results to old describeb, but breaks for '.k5login'
+    end_of_line = contentstring.index("\n") # "." gives closer results to old describeb, but breaks for '.k5login'
     contentstring = contentstring[0..end_of_line] unless end_of_line.nil?
     contentstring = "#{contentstring[0..shortento]} ..." if contentstring.length > targetlength
 

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

@@ -12,7 +12,7 @@ module PuppetStrings::Markdown::Helpers
   # @param [String] inline_prefix String to insert before if it’s inline.
   # @returns [String] Markdown
   def code_maybe_block(code, type: :puppet, block_prefix: "\n\n", inline_prefix: ' ')
-    if code.include?("\n")
+    if code.to_s.include?("\n")
       "#{block_prefix}```#{type}\n#{code}\n```"
     else
       "#{inline_prefix}`#{code}`"

data/lib/puppet-strings/markdown.rb

@@ -76,9 +76,6 @@ module PuppetStrings::Markdown
   # @param [String] path The full path to the template file.
   # @return [ERB] Template
   def self.erb(path)
-    unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.0')
-      # This outputs warnings in Ruby 2.6+.
-    end
     ERB.new(File.read(path), trim_mode: '-')
   end
 end

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

@@ -34,7 +34,7 @@ namespace :strings do
       existing = File.read(filename)
 
       if generated != existing
-        warn "#{filename} is outdated"
+        warn "#{filename} is outdated; to regenerate: bundle exec rake strings:generate:reference"
         exit 1
       end
     end

data/lib/puppet-strings/version.rb

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

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

@@ -8,7 +8,7 @@ class PuppetStrings::Yard::CodeObjects::Functions < PuppetStrings::Yard::CodeObj
   # @param [Symbol] type The function type to get the group for.
   # @return Returns the singleton instance of the group.
   def self.instance(type)
-    super("puppet_functions_#{type}".to_sym)
+    super(:"puppet_functions_#{type}")
   end
 
   # Gets the display name of the group.

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

@@ -8,7 +8,7 @@ class PuppetStrings::Yard::CodeObjects::Providers < PuppetStrings::Yard::CodeObj
   # @param [String] type The resource type name for the provider.
   # @return Returns the singleton instance of the group.
   def self.instance(type)
-    super("puppet_providers_#{type}".to_sym)
+    super(:"puppet_providers_#{type}")
   end
 
   # Gets the display name of the group.

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

@@ -44,14 +44,12 @@ class PuppetStrings::Yard::CodeObjects::Task < PuppetStrings::Yard::CodeObjects:
   end
 
   def parameters
-    parameters = []
-    statement.parameters.each do |name, props|
-      parameters.push({ name: name.to_s,
-                        tag_name: 'param',
-                        text: props['description'] || '',
-                        types: [props['type']] || '' })
+    statement.parameters.map do |name, props|
+      { name: name.to_s,
+        tag_name: 'param',
+        text: props['description'] || '',
+        types: [props['type']] || '' }
     end
-    parameters
   end
 
   # Converts the code object to a hash representation.

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

@@ -169,7 +169,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
   # render-time. For now, this should re-resolve on every call.
   # may be able to memoize this
   def providers
-    providers = YARD::Registry.all("puppet_providers_#{name}".to_sym)
+    providers = YARD::Registry.all(:"puppet_providers_#{name}")
     return providers if providers.empty?
 
     providers.first.children

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

@@ -107,9 +107,8 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
         parameters.each do |kvps|
           next unless kvps.count >= 1
 
-          defaultfor = []
-          kvps.each do |kvp|
-            defaultfor << [node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source]
+          defaultfor = kvps.map do |kvp|
+            [node_as_string(kvp[0]) || kvp[0].source, node_as_string(kvp[1]) || kvp[1].source]
           end
           object.add_default(defaultfor)
         end

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

@@ -92,7 +92,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param object The Puppet parser model object that has parameters.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
       @parameters = object.parameters.map { |parameter| Parameter.new(parameter) }
     end
   end
@@ -105,7 +105,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param [Puppet::Pops::Model::HostClassDefinition] object The model object for the class statement.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
       @name = object.name
       @parent_class = object.parent_class
     end
@@ -119,7 +119,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param [Puppet::Pops::Model::ResourceTypeDefinition] object The model object for the defined type statement.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
       @name = object.name
     end
   end
@@ -132,7 +132,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param [Puppet::Pops::Model::FunctionDefinition] object The model object for the function statement.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
       @name = object.name
       return unless object.respond_to? :return_type
 
@@ -151,7 +151,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param [Puppet::Pops::Model::PlanDefinition] object The model object for the plan statement.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
       @name = object.name
     end
   end
@@ -164,7 +164,7 @@ module PuppetStrings::Yard::Parsers::Puppet
     # @param [Puppet::Pops::Model::TypeAlias] object The model object for the type statement.
     # @param [String] file The file containing the statement.
     def initialize(object, file)
-      super(object, file)
+      super
 
       type_expr = object.type_expr
       case type_expr

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

@@ -65,7 +65,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # @param [Object] value The object to associate with this tag.
   # @return [void]
   def object=(value)
-    super(value)
+    super
     @docstring.object = value
     @docstring.tags.each { |tag| tag.object = value }
   end
@@ -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, ...)
-    return object.send(method_name, ...) if object.respond_to? method_name
+  def method_missing(method_name, *args, &block)
+    return object.send(method_name, *args, &block) if object.respond_to? method_name
 
     super
   end

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

@@ -35,7 +35,7 @@ module PuppetStrings::Yard::Util
   # @return [Array] Returns an array of tag hashes.
   def self.tags_to_hashes(tags)
     # Skip over the API tags that are public
-    tags.select { |t| (t.tag_name != 'api' || t.text != 'public') }.map do |t|
+    tags.select { |t| t.tag_name != 'api' || t.text != 'public' }.map do |t|
       next t.to_hash if t.respond_to?(:to_hash)
 
       tag = { tag_name: t.tag_name }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.1.3
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-22 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rgen
@@ -31,6 +31,9 @@ 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
@@ -38,6 +41,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.9.37
 description: 
 email: info@puppet.com
 executables: []