puppet-strings 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2d5345c5e091cd9e41b404f7529168e8e10b737d26b3b1b9a5a5bfbf118e062
-  data.tar.gz: 0bddf9dac1b890e8b487e261fd5eec2b3df45eecbc400af22602c1aac29aa99e
+  metadata.gz: 9397d83c2092aed842ea468c79012270659c27b5c9ad85e1a67f614ca3fef2a2
+  data.tar.gz: 65bc26d31881eefbb6de381a29afe1de4274bfeb2f1748969af60f9e30dcb9fe
 SHA512:
-  metadata.gz: 6399094f9117b6966c7b91f4ec6438f6877faf0b25ab7f2b322957f1cf81719ddae70357d32d252a7276f9795f9bce6305b8c999f1f853ec83dbd35131030d99
-  data.tar.gz: faef11c0d37eb368b8e36a6bc7743669a7ad184893c969317434711ae13e6513e033393eb9b64e33f6d6e16f9bd0ff46dc4a784ba0ec574d398896c5b2dea095
+  metadata.gz: a20053eca0ac726c86ea1b21596f1c66a98f9a28679ee00c4d9b64afe30d3f9fa9ce9d67bec6dd28ef9ff4c5c70f8f0b075d43c5d07c87c382265433bda13993
+  data.tar.gz: a476bfcc359d3e2603902f080a7d54f4e80b04d18b470dc0e8980c20cc7b4452e44ea7e344db4bf7702ce5c3b9aa7745d52d75e5cadc5991313d596de97f0d4a

data/CHANGELOG.md

@@ -3,6 +3,28 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [v2.9.0](https://github.com/puppetlabs/puppet-strings/tree/v2.9.0) (2021-11-29)
+
+[Full Changelog](https://github.com/puppetlabs/puppet-strings/compare/v2.8.0...v2.9.0)
+
+Added
+
+- Add strings:validate:reference task [\#293](https://github.com/puppetlabs/puppet-strings/issues/293)
+
+Fixed
+
+- Fix rare undefined method `any?' for nil:NilClass error [\#289](https://github.com/puppetlabs/puppet-strings/pull/289) ([sanfrancrisko](https://github.com/sanfrancrisko))
+
+**Closed issues:**
+
+- Error: undefined method `any?' for nil:NilClass when generating documentation [\#287](https://github.com/puppetlabs/puppet-strings/issues/287)
+- Update changelog with recent commits [\#283](https://github.com/puppetlabs/puppet-strings/issues/283)
+- Please document the `author` tag [\#256](https://github.com/puppetlabs/puppet-strings/issues/256)
+
+**Merged pull requests:**
+
+- Implement a strings:validate:reference task [\#291](https://github.com/puppetlabs/puppet-strings/pull/291) ([ekohl](https://github.com/ekohl))
+
 ## [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)

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'puppet-strings'
+require 'tempfile'
+
+namespace :strings do
+  namespace :validate do
+    desc 'Validate the reference is up to date'
+    task :reference, [:patterns, :debug, :backtrace] do |t, args|
+      filename = 'REFERENCE.md'
+
+      unless File.exist?(filename)
+        STDERR.puts "#{filename} does not exist"
+        exit 1
+      end
+
+      patterns = args[:patterns]
+      patterns = patterns.split if patterns
+      patterns ||= PuppetStrings::DEFAULT_SEARCH_PATTERNS
+
+      generated = Tempfile.create do |file|
+        options = {
+          debug: args[:debug] == 'true',
+          backtrace: args[:backtrace] == 'true',
+          json: false,
+          markdown: true,
+          path: file,
+        }
+        PuppetStrings.generate(patterns, options)
+
+        file.read
+      end
+
+      existing = File.read(filename)
+
+      if generated != existing
+        STDERR.puts "#{filename} is outdated"
+        exit 1
+      end
+    end
+  end
+end

data/lib/puppet-strings/tasks.rb

@@ -8,5 +8,6 @@ module PuppetStrings
   module Tasks
     require 'puppet-strings/tasks/generate.rb'
     require 'puppet-strings/tasks/gh_pages.rb'
+    require 'puppet-strings/tasks/validate.rb'
   end
 end

data/lib/puppet-strings/version.rb

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

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

@@ -148,6 +148,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
   end
 
   def parameters
+    @parameters ||= []  # guard against not filled parameters
     # just return params if there are no providers
     return @parameters if providers.empty?
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.8.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-19 00:00:00.000000000 Z
+date: 2021-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -85,6 +85,7 @@ files:
 - lib/puppet-strings/tasks.rb
 - lib/puppet-strings/tasks/generate.rb
 - lib/puppet-strings/tasks/gh_pages.rb
+- lib/puppet-strings/tasks/validate.rb
 - lib/puppet-strings/version.rb
 - lib/puppet-strings/yard.rb
 - lib/puppet-strings/yard/code_objects.rb
@@ -243,8 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - puppet, >= 5.0.0
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Puppet documentation via YARD