puppet-strings 2.3.0 → 2.7.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'puppet'
 require 'puppet/pops'
 
@@ -32,11 +34,13 @@ module PuppetStrings::Yard::Parsers::Puppet
       comment = []
       (0..@line-2).reverse_each do |index|
         break unless index <= lines.count
+
         line = lines[index].strip
         count = line.size
         line.gsub!(COMMENT_REGEX, '')
         # Break out if nothing was removed (wasn't a comment line)
         break unless line.size < count
+
         comment << line
       end
       @comments_range = (@line - comment.size - 1..@line - 1)

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

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 # The module for custom YARD tags.
 module PuppetStrings::Yard::Tags
+  require 'puppet-strings/yard/tags/factory'
   require 'puppet-strings/yard/tags/parameter_directive'
   require 'puppet-strings/yard/tags/property_directive'
   require 'puppet-strings/yard/tags/overload_tag'
   require 'puppet-strings/yard/tags/summary_tag'
+  require 'puppet-strings/yard/tags/enum_tag'
 end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'yard/tags/option_tag'
+
+# Implements an enum tag for describing enumerated value data types
+
+class PuppetStrings::Yard::Tags::EnumTag < YARD::Tags::OptionTag
+  # Registers the tag with YARD.
+  # @return [void]
+  def self.register!
+    YARD::Tags::Library.define_tag("puppet.enum", :enum, :with_enums)
+    YARD::Tags::Library.visible_tags.place(:enum).after(:option)
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'yard/tags/default_factory'
+require 'puppet-strings/yard/tags/enum_tag'
+
+class PuppetStrings::Yard::Tags::Factory < YARD::Tags::DefaultFactory
+
+  # Parses tag text and creates a new enum tag type. Modeled after
+  # the parse_tag_with_options method in YARD::Tags::DefaultFactory.
+  #
+  # @param tag_name        the name of the tag to parse
+  # @param [String] text   the raw tag text
+  # @return [Tag]          a tag object with the tag_name, name, and nested Tag as type
+  def parse_tag_with_enums(tag_name, text)
+    name, text = *extract_name_from_text(text)
+    PuppetStrings::Yard::Tags::EnumTag.new(tag_name, name, parse_tag_with_name(tag_name, text))
+  end
+end

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_data_type/html/method_details_list.erb

@@ -0,0 +1,6 @@
+<h2>Data Type Functions</h2>
+<% method_listing.each_with_index do |meth, i| %>
+  <div id="<%= meth.name %>-instance_method"><h3><%= meth.name %></h3>
+  <%= yieldall :object => meth, :owner => object, :index => i %>
+  </div>
+<% end %>

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

@@ -1,5 +1,13 @@
 # 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'), :method_details_list, [T('method_details')], :source
+end
+
+def method_listing
+  sort_listing(object.functions)
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end

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/templates/default/puppet_type/html/setup.rb

@@ -16,7 +16,9 @@ end
 def properties
   # Properties are the same thing as parameters (from the documentation standpoint),
   # so reuse the same template but with a different title and data source.
-  @parameters = object.properties || []
+  #
+  # "checks" such as "creates" and "onlyif" are another type of property
+  @parameters = (object.properties || []) + (object.checks || [])
   @parameters.sort_by! { |p| p.name }
   @tag_title = 'Properties'
   erb(:parameters)

data/lib/puppet-strings/yard/templates/default/tags/html/enum.erb

@@ -0,0 +1,17 @@
+<% if object.has_tag?(:enum) %>
+  <% object.parameters.each do |param, default| %>
+    <% tags = object.tags(:enum).select {|x| x.name.to_s == param.to_s.sub(/^\*+|:$/, '') } %>
+    <% next if tags.empty? %>
+    <p class="tag_title">Enum Options (<tt><%= param %></tt>):</p>
+    <ul class="option">
+      <% for tag in tags %>
+        <li>
+          <span class="name"><%= tag.pair.name %></span>
+          <% if tag.pair.text && tag.pair.text =~ /\S/ %>
+            &mdash; <%= htmlify_line(tag.pair.text) %>
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  <% end %>
+<% end %>

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

@@ -16,3 +16,9 @@ end
 def overload
   erb(if object.type == :puppet_function then :puppet_overload else :overload end)
 end
+
+# Renders the enum section.
+# @return [String] Returns the rendered section.
+def enum
+  erb(:enum)
+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
 
@@ -38,11 +41,11 @@ module PuppetStrings::Yard::Util
       next t.to_hash if t.respond_to?(:to_hash)
 
       tag = { tag_name: t.tag_name }
-      # grab nested information for @option tags
-      if tag[:tag_name] == 'option'
+      # grab nested information for @option and @enum tags
+      if tag[:tag_name] == 'option' || tag[:tag_name] == 'enum'
         tag[:opt_name] = t.pair.name
         tag[:opt_text] = t.pair.text
-        tag[:opt_types] = t.pair.types
+        tag[:opt_types] = t.pair.types if t.pair.types
         tag[:parent] = t.name
       end
       tag[:text] = t.text if t.text

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.3.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Puppet Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-17 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -52,13 +52,8 @@ files:
 - CHANGELOG.md
 - COMMITTERS.md
 - CONTRIBUTING.md
-- Gemfile
-- HISTORY.md
-- JSON.md
 - LICENSE
 - README.md
-- Rakefile
-- codecov.yml
 - lib/puppet-strings.rb
 - lib/puppet-strings/describe.rb
 - lib/puppet-strings/json.rb
@@ -81,6 +76,7 @@ files:
 - lib/puppet-strings/markdown/table_of_contents.rb
 - lib/puppet-strings/markdown/templates/classes_and_defines.erb
 - lib/puppet-strings/markdown/templates/data_type.erb
+- lib/puppet-strings/markdown/templates/data_type_function.erb
 - lib/puppet-strings/markdown/templates/function.erb
 - lib/puppet-strings/markdown/templates/puppet_task.erb
 - lib/puppet-strings/markdown/templates/resource_type.erb
@@ -127,6 +123,8 @@ files:
 - lib/puppet-strings/yard/parsers/puppet/parser.rb
 - lib/puppet-strings/yard/parsers/puppet/statement.rb
 - lib/puppet-strings/yard/tags.rb
+- lib/puppet-strings/yard/tags/enum_tag.rb
+- lib/puppet-strings/yard/tags/factory.rb
 - lib/puppet-strings/yard/tags/overload_tag.rb
 - lib/puppet-strings/yard/tags/parameter_directive.rb
 - lib/puppet-strings/yard/tags/property_directive.rb
@@ -154,6 +152,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_class/html/todo.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/header.erb
+- lib/puppet-strings/yard/templates/default/puppet_data_type/html/method_details_list.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/note.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_data_type/html/setup.rb
@@ -216,6 +215,7 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/todo.erb
+- lib/puppet-strings/yard/templates/default/tags/html/enum.erb
 - lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb
 - lib/puppet-strings/yard/templates/default/tags/setup.rb
 - lib/puppet-strings/yard/util.rb
@@ -223,49 +223,11 @@ files:
 - lib/puppet/face/strings.rb
 - lib/puppet/feature/rgen.rb
 - lib/puppet/feature/yard.rb
-- misc/ANNOUNCEMENT_TEMPLATE.md
-- spec/acceptance/emit_json_options_spec.rb
-- spec/acceptance/generate_markdown_spec.rb
-- spec/acceptance/running_strings_generate_spec.rb
-- spec/fixtures/acceptance/modules/test/functions/add.pp
-- spec/fixtures/acceptance/modules/test/lib/puppet/functions/4x_function.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/parser/functions/function3x.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/provider/server/linux.rb
-- spec/fixtures/acceptance/modules/test/lib/puppet/type/database.rb
-- spec/fixtures/acceptance/modules/test/manifests/init.pp
-- spec/fixtures/acceptance/modules/test/manifests/triple_nested_classes.pp
-- spec/fixtures/acceptance/modules/test/metadata.json
-- spec/fixtures/acceptance/modules/test/types/elephant.pp
-- spec/fixtures/unit/markdown/output.md
-- spec/fixtures/unit/markdown/output_with_data_types.md
-- spec/fixtures/unit/markdown/output_with_plan.md
-- spec/spec_helper.rb
-- spec/spec_helper_acceptance.rb
-- spec/spec_helper_acceptance_local.rb
-- spec/unit/puppet-strings/describe_spec.rb
-- spec/unit/puppet-strings/json_spec.rb
-- spec/unit/puppet-strings/markdown/base_spec.rb
-- spec/unit/puppet-strings/markdown_spec.rb
-- spec/unit/puppet-strings/yard/code_objects/task_spec.rb
-- spec/unit/puppet-strings/yard/handlers/json/task_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/data_type_alias_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/data_type_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/rsapi_handler_spec.rb
-- spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/parser_spec.rb
-- spec/unit/puppet-strings/yard/parsers/json/task_statement_spec.rb
-- spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb
-- spec/unit/puppet-strings/yard/util_spec.rb
 homepage: https://github.com/puppetlabs/puppet-strings
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -273,16 +235,17 @@ 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
-signing_key: 
+- puppet, >= 5.0.0
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []

data/Gemfile

@@ -1,47 +0,0 @@
-source ENV['GEM_SOURCE'] || "https://rubygems.org"
-
-gemspec
-
-gem 'rgen'
-gem 'redcarpet'
-gem 'yard', '~> 0.9.11'
-
-if ENV['PUPPET_GEM_VERSION']
-  gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false
-else
-  gem 'puppet', :require => false
-end
-
-group :test do
-  gem 'codecov'
-  gem 'mocha'
-  gem 'puppetlabs_spec_helper'
-  gem 'serverspec'
-  gem 'simplecov-console'
-  gem 'rspec', '~> 3.1'
-  gem 'json_spec', '~> 1.1', '>= 1.1.5'
-end
-
-group :acceptance do
-  # Litmus has dependencies which require Ruby 2.5 (Puppet 6) or above.
-  gem 'puppet_litmus' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.5.0')
-end
-
-group :development do
-  gem 'github_changelog_generator', git: 'https://github.com/skywinder/github-changelog-generator', ref: '20ee04ba1234e9e83eb2ffb5056e23d641c7a018' if Gem::Version.new(RUBY_VERSION.dup) >= Gem::Version.new('2.2.2')
-  gem 'pry'
-  gem 'pry-byebug'
-end
-
-gem 'rubocop-rspec'
-gem 'rubocop', '~> 0.57.2'
-
-# Evaluate Gemfile.local if it exists
-if File.exists? "#{__FILE__}.local"
-  eval(File.read("#{__FILE__}.local"), binding)
-end
-
-# Evaluate ~/.gemfile if it exists
-if File.exists?(File.join(Dir.home, '.gemfile'))
-  eval(File.read(File.join(Dir.home, '.gemfile')), binding)
-end