puppet-strings 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: decf380cb5cb58228eead7c8cc9c59d9ce144b608d939c258d56ebb268086c09
-  data.tar.gz: 62254e20387c9172de91b8bd6e2623ac000a6f11c568805da7805ca1526d6def
+  metadata.gz: a2d5345c5e091cd9e41b404f7529168e8e10b737d26b3b1b9a5a5bfbf118e062
+  data.tar.gz: 0bddf9dac1b890e8b487e261fd5eec2b3df45eecbc400af22602c1aac29aa99e
 SHA512:
-  metadata.gz: 05c877672e2f7c4d803db4e3d4c24371655336647fd9862319c5b0ba89d36710758cd03677792a91c843fd6150b70d1bb3c3a01d4343be46ceec76549c32426f
-  data.tar.gz: 3d3a7dae2b4e4eaac710b403a291d3a5623c22250f328619cabf68f205c2ff68110cd9e9d345d1db7b0301b9a4c07349674f8f59fac9bc244baf538e2f5531a3
+  metadata.gz: 6399094f9117b6966c7b91f4ec6438f6877faf0b25ab7f2b322957f1cf81719ddae70357d32d252a7276f9795f9bce6305b8c999f1f853ec83dbd35131030d99
+  data.tar.gz: faef11c0d37eb368b8e36a6bc7743669a7ad184893c969317434711ae13e6513e033393eb9b64e33f6d6e16f9bd0ff46dc4a784ba0ec574d398896c5b2dea095

data/CHANGELOG.md

@@ -3,6 +3,19 @@
 All significant changes to this repo will be summarized in this file.
 
 
+## [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)

data/README.md

@@ -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)
 
@@ -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
 ```
 

data/lib/puppet-strings/version.rb

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

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

@@ -152,7 +152,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
     return @parameters if providers.empty?
 
     # return existing params if we have already added provider
-    return @parameters if @parameters.any? { |p| p.name == 'provider' }
+    return @parameters if @parameters&.any? { |p| p.name == 'provider' }
 
     provider_param = Parameter.new(
       'provider',
@@ -160,6 +160,7 @@ class PuppetStrings::Yard::CodeObjects::Type < PuppetStrings::Yard::CodeObjects:
       "to specify this --- Puppet will usually discover the appropriate provider for your platform."
     )
 
+    @parameters ||= []
     @parameters << provider_param
   end
 

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

@@ -5,7 +5,7 @@ require 'puppet-strings/yard/handlers/ruby/type_base'
 require 'puppet-strings/yard/code_objects'
 require 'puppet-strings/yard/util'
 
-# Implements the handler for Puppet resource type newparam/newproperty calls written in Ruby.
+# Implements the handler for Puppet resource type newparam/newproperty/ensurable calls written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Yard::Handlers::Ruby::TypeBase
   # The default docstring when ensurable is used without given a docstring.
   DEFAULT_ENSURABLE_DOCSTRING = 'The basic property that the resource should be in.'
@@ -13,6 +13,7 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Ya
   namespace_only
   handles method_call(:newparam)
   handles method_call(:newproperty)
+  handles method_call(:ensurable)
 
   process do
 
@@ -38,9 +39,15 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Ya
     method1_name = statement[0].children.drop(1).find{ |c| c.type == :ident }.source
     return unless ['Type', 'Puppet::Type'].include?(module_name) && method1_name == 'type'
 
+    # ensurable is syntatic sugar for newproperty
     typename = get_name(statement[0], 'Puppet::Type.type')
-    method2_name = caller_method
-    propertyname = get_name(statement, "Puppet::Type.type().#{method2_name}")
+    if caller_method == 'ensurable'
+      method2_name = 'newproperty'
+      propertyname = 'ensure'
+    else
+      method2_name = caller_method
+      propertyname = get_name(statement, "Puppet::Type.type().#{method2_name}")
+    end
 
     typeobject = get_type_yard_object(typename)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard