puppet-strings 2.5.0 → 2.6.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard/tags/option_tag'
 
 # Implements an enum tag for describing enumerated value data types

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard/tags/default_factory'
 require 'puppet-strings/yard/tags/enum_tag'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implements an overload tag for Puppet functions
 #
 # This differs from Yard's overload tag in that the signatures are formatted according to Puppet language rules.
@@ -22,7 +24,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
     args = @parameters.map do |parameter|
       name, default = parameter
       tag = tags.find { |t| t.name == name } if tags
-      type = tag && tag.types ? "#{tag.type} " : 'Any '
+      type = tag&.types ? "#{tag.type} " : 'Any '
       prefix = "#{name[0]}" if name.start_with?('*', '&')
       name = name[1..-1] if prefix
       default = " = #{default}" if default
@@ -75,6 +77,7 @@ class PuppetStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
   # @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
+
     super
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings/yard/code_objects'
 
 # Implements a parameter directive (e.g. #@!puppet.type.param) for documenting Puppet resource types.
@@ -5,14 +7,13 @@ class PuppetStrings::Yard::Tags::ParameterDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object && object.respond_to?(:add_parameter)
+    return unless object&.respond_to?(:add_parameter)
+
     # Add a parameter to the resource
     parameter = PuppetStrings::Yard::CodeObjects::Type::Parameter.new(tag.name, tag.text)
-    if tag.types
-      tag.types.each do |value|
+    tag.types&.each do |value|
         parameter.add(value)
       end
-    end
     object.add_parameter parameter
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet-strings/yard/code_objects'
 
 # Implements a parameter directive (e.g. #@!puppet.type.property) for documenting Puppet resource types.
@@ -5,14 +7,13 @@ class PuppetStrings::Yard::Tags::PropertyDirective < YARD::Tags::Directive
   # Called to invoke the directive.
   # @return [void]
   def call
-    return unless object && object.respond_to?(:add_property)
+    return unless object&.respond_to?(:add_property)
+
     # Add a property to the resource
     property = PuppetStrings::Yard::CodeObjects::Type::Property.new(tag.name, tag.text)
-    if tag.types
-      tag.types.each do |value|
+    tag.types&.each do |value|
         property.add(value)
       end
-    end
     object.add_property property
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Implements a summary tag for general purpose short descriptions
 
 class PuppetStrings::Yard::Tags::SummaryTag < YARD::Tags::Tag

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

@@ -1,5 +1,5 @@
 # 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, T('tags'), :source]
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util'
 
 # The module for various puppet-strings utility helpers.
@@ -24,8 +26,9 @@ module PuppetStrings::Yard::Util
   # @return [String] HTML document with links converted
   def self.github_to_yard_links(data)
     data.scan(/href\=\"\#(.+)\"/).each do |bad_link|
-      data.gsub!("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.gsub('-', '+')}\"")
+      data = data.gsub("=\"##{bad_link.first}\"", "=\"#label-#{bad_link.first.capitalize.gsub('-', '+')}\"")
     end
+
     data
   end
 

data/lib/puppet/application/strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/application/face_base'
 
 # Implements the 'puppet strings' application.

data/lib/puppet/face/strings.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/face'
 
 # Implements the 'puppet strings' interface.
@@ -57,6 +59,7 @@ Puppet::Face.define(:strings, '0.0.1') do
       environment = Puppet.lookup(:current_environment)
       environment.modules.each do |mod|
         next unless modules.empty? || modules.include?(mod.name)
+
         db = File.join(mod.path, '.yardoc')
         patterns = PuppetStrings::DEFAULT_SEARCH_PATTERNS.map do |p|
           File.join(mod.path, p)
@@ -145,7 +148,7 @@ Puppet::Face.define(:strings, '0.0.1') do
   def check_required_features
     raise RuntimeError, "The 'yard' gem must be installed in order to use this face." unless Puppet.features.yard?
     raise RuntimeError, "The 'rgen' gem must be installed in order to use this face." unless Puppet.features.rgen?
-    raise RuntimeError, 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION =~ /^1\.8/
+    raise RuntimeError, 'This face requires Ruby 1.9 or greater.' if RUBY_VERSION.match?(/^1\.8/)
   end
 
   # Builds the options to PuppetStrings.generate.

data/lib/puppet/feature/rgen.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util/feature'
 
 Puppet.features.add(:rgen, :libs => ['rgen/metamodel_builder', 'rgen/ecore/ecore'])

data/lib/puppet/feature/yard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet/util/feature'
 
 Puppet.features.add(:yard, :libs => ['yard'])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-16 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -235,15 +235,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- puppet, >= 4.0.0
-rubygems_version: 3.0.4
+- puppet, >= 5.0.0
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD