openvox-strings 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f8faeecab951abd8059486388fbddcc093314713c17c1a87f30764be80e4af3
-  data.tar.gz: c24f48e95451329e8367e5ffbf3835d901ef90678eb9af06e0b9d263ab6c1936
+  metadata.gz: 71629243bf4a78e83bf6dabc87a583eaca9878d5a12942f31fd301ffe5ad9628
+  data.tar.gz: 3c5953fccf4cf2db7df3535e07f45cd2848795e1f11e922ca98fa78d0117a49c
 SHA512:
-  metadata.gz: e63adf1b7018dfeeccab03b660cdd9b97ead8f0a2184c7be8b1db88aece067885725a812fc72f436a510593b5f203c9e37f50fcd2d7b27e08e736db6fc2bb06e
-  data.tar.gz: e124ea8d92900e5000dd00e126ddc13fed4d9b098e6771305e21cb3806988920a712d83557216e0a3013018fc9bea0f269edc16a8df001c2d0bde55fe82b41de
+  metadata.gz: 32603da312ed6bb016dea6b3d071811bed3d65ba6c5f56d6a26379ff3a7b469f5a9c8104ce5f991a7a20728d670328b7839251285e0ae2d56e261904ceb1ed1c
+  data.tar.gz: 2e6f7b566171d572ff5120164acbc26b5650b653f1659aff2b3d31b20c18969daf61dd5520a40764307c54ef83229e4b1efc52f632ca91e4eda75b0b5e7ff0cd

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to this project will be documented in this file.
 
+## [v6.0.0](https://github.com/voxpupuli/openvox-strings/tree/v6.0.0) (2025-08-13)
+
+[Full Changelog](https://github.com/voxpupuli/openvox-strings/compare/v5.0.0...v6.0.0)
+
+**Breaking changes:**
+
+- Require Ruby 3.2 or newer [\#13](https://github.com/voxpupuli/openvox-strings/pull/13) ([bastelfreak](https://github.com/bastelfreak))
+
+**Implemented enhancements:**
+
+- Allow rgen 0.10.x [\#10](https://github.com/voxpupuli/openvox-strings/pull/10) ([smortex](https://github.com/smortex))
+
 ## [v5.0.0](https://github.com/voxpupuli/openvox-strings/tree/v5.0.0) (2025-06-10)
 
 [Full Changelog](https://github.com/voxpupuli/openvox-strings/compare/v4.1.3...v5.0.0)
@@ -15,6 +27,10 @@ All notable changes to this project will be documented in this file.
 - Rake task allows for a different commit message [\#4](https://github.com/voxpupuli/openvox-strings/pull/4) ([bastelfreak](https://github.com/bastelfreak))
 - Add Ruby 2.7/3.0 support [\#3](https://github.com/voxpupuli/openvox-strings/pull/3) ([bastelfreak](https://github.com/bastelfreak))
 
+**Merged pull requests:**
+
+- dependabot: check for github actions and bundler [\#6](https://github.com/voxpupuli/openvox-strings/pull/6) ([bastelfreak](https://github.com/bastelfreak))
+
 <!-- markdownlint-disable MD024 -->
 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).
 

data/lib/openvox-strings/describe.rb

@@ -15,7 +15,7 @@ module OpenvoxStrings::Describe
     document = {
       defined_types: YARD::Registry.all(:puppet_defined_type).sort_by!(&:name).map!(&:to_hash),
       resource_types: YARD::Registry.all(:puppet_type).sort_by!(&:name).map!(&:to_hash),
-      providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash)
+      providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash),
     }
     # if --list flag passed, produce a summarized list of types
     if list_types

data/lib/openvox-strings/json.rb

@@ -17,7 +17,7 @@ module OpenvoxStrings::Json
       providers: YARD::Registry.all(:puppet_provider).sort_by!(&:name).map!(&:to_hash),
       puppet_functions: YARD::Registry.all(:puppet_function).sort_by!(&:name).map!(&:to_hash),
       puppet_tasks: YARD::Registry.all(:puppet_task).sort_by!(&:name).map!(&:to_hash),
-      puppet_plans: YARD::Registry.all(:puppet_plan).sort_by!(&:name).map!(&:to_hash)
+      puppet_plans: YARD::Registry.all(:puppet_plan).sort_by!(&:name).map!(&:to_hash),
       # TODO: Need Ruby documentation?
     }
 

data/lib/openvox-strings/markdown.rb

@@ -23,7 +23,7 @@ module OpenvoxStrings::Markdown
       OpenvoxStrings::Markdown::Function,
       OpenvoxStrings::Markdown::DataType,
       OpenvoxStrings::Markdown::PuppetTask,
-      OpenvoxStrings::Markdown::PuppetPlan
+      OpenvoxStrings::Markdown::PuppetPlan,
     ]
   end
 
@@ -33,7 +33,7 @@ module OpenvoxStrings::Markdown
     output = [
       "# Reference\n\n",
       "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n",
-      "## Table of Contents\n\n"
+      "## Table of Contents\n\n",
     ]
 
     # Create table of contents

data/lib/openvox-strings/tasks/generate.rb

@@ -13,7 +13,7 @@ namespace :strings do
     options = {
       debug: args[:debug] == 'true',
       backtrace: args[:backtrace] == 'true',
-      markup: args[:markup] || 'markdown'
+      markup: args[:markup] || 'markdown',
     }
 
     raise('Error: Both JSON and Markdown output have been selected. Please select one.') if args[:json] == 'true' && args[:markdown] == 'true'
@@ -33,7 +33,7 @@ namespace :strings do
       options[format] = !(args[format] == 'false' || args[format].empty?)
       return unless options[format]
 
-      options[:path] = args[format] == 'true' ? nil : args[format]
+      options[:path] = (args[format] == 'true') ? nil : args[format]
     end
     # rubocop:enable Style/PreferredHashMethods
 

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

@@ -24,7 +24,7 @@ namespace :strings do
           backtrace: args[:backtrace] == 'true',
           json: false,
           markdown: true,
-          path: file
+          path: file,
         }
         OpenvoxStrings.generate(patterns, options)
 

data/lib/openvox-strings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenvoxStrings
-  VERSION = '5.0.0'
+  VERSION = '6.0.0'
 end

data/lib/openvox-strings/yard/code_objects/base.rb

@@ -5,9 +5,9 @@ class OpenvoxStrings::Yard::CodeObjects::Base < YARD::CodeObjects::NamespaceObje
   # Allocates a new code object.
   # @param [Array] args The arguments to initialize the code object with.
   # @return Returns the code object.
-  def self.new(*args)
+  def self.new(*)
     # Skip the super class' implementation because it detects :: in names and this will cause namespaces in the output we don't want
-    object = Object.class.instance_method(:new).bind_call(self, *args)
+    object = Object.class.instance_method(:new).bind_call(self, *)
     existing = YARD::Registry.at(object.path)
     object = existing if existing.instance_of?(self)
     yield(object) if block_given?

data/lib/openvox-strings/yard/code_objects/data_type.rb

@@ -94,7 +94,7 @@ class OpenvoxStrings::Yard::CodeObjects::DataType < OpenvoxStrings::Yard::CodeOb
       {
         name: func.name,
         signature: func.signature,
-        docstring: OpenvoxStrings::Yard::Util.docstring_to_hash(func.docstring, %i[param option enum return example])
+        docstring: OpenvoxStrings::Yard::Util.docstring_to_hash(func.docstring, %i[param option enum return example]),
       }
     end
     hash

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

@@ -48,7 +48,7 @@ class OpenvoxStrings::Yard::CodeObjects::Task < OpenvoxStrings::Yard::CodeObject
       { name: name.to_s,
         tag_name: 'param',
         text: props['description'] || '',
-        types: [props['type']] || '' }
+        types: [props['type']] || '', }
     end
   end
 
@@ -60,10 +60,10 @@ class OpenvoxStrings::Yard::CodeObjects::Task < OpenvoxStrings::Yard::CodeObject
       line: statement.line,
       docstring: {
         text: statement.docstring,
-        tags: parameters
+        tags: parameters,
       },
       source: statement.source,
       supports_noop: statement.json['supports_noop'] || false,
-      input_method: statement.json['input_method'] }
+      input_method: statement.json['input_method'], }
   end
 end

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

@@ -158,7 +158,7 @@ class OpenvoxStrings::Yard::CodeObjects::Type < OpenvoxStrings::Yard::CodeObject
     provider_param = Parameter.new(
       'provider',
       "The specific backend to use for this `#{name}` resource. You will seldom need " \
-      'to specify this --- Puppet will usually discover the appropriate provider for your platform.'
+      'to specify this --- Puppet will usually discover the appropriate provider for your platform.',
     )
 
     @parameters ||= []

data/lib/openvox-strings/yard/handlers/puppet/function_handler.rb

@@ -40,9 +40,7 @@ class OpenvoxStrings::Yard::Handlers::Puppet::FunctionHandler < OpenvoxStrings::
   def add_return_tag(object, type = nil)
     tag = object.tag(:return)
     if tag
-      if (type && tag.types && tag.types.first) && (type != tag.types.first)
-        log.warn "Documented return type does not match return type in function definition near #{statement.file}:#{statement.line}."
-      end
+      log.warn "Documented return type does not match return type in function definition near #{statement.file}:#{statement.line}." if type && tag.types && tag.types.first && (type != tag.types.first)
 
       tag.types = type ? [type] : tag.types || ['Any']
       return

data/lib/openvox-strings/yard/handlers/ruby/function_handler.rb

@@ -39,7 +39,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
     is_3x = ['Puppet::Parser::Functions', 'newfunction'].include?(module_name)
     object = OpenvoxStrings::Yard::CodeObjects::Function.new(
       get_name(statement, 'Puppet::Functions.create_function'),
-      is_3x ? OpenvoxStrings::Yard::CodeObjects::Function::RUBY_3X : OpenvoxStrings::Yard::CodeObjects::Function::RUBY_4X
+      is_3x ? OpenvoxStrings::Yard::CodeObjects::Function::RUBY_3X : OpenvoxStrings::Yard::CodeObjects::Function::RUBY_4X,
     )
     object.source = statement
     register object
@@ -185,7 +185,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
         node_as_string(parameters[0]),
         nil, # TODO: determine default from corresponding Ruby method signature?
         method_name.include?('optional'),
-        method_name.include?('repeated')
+        method_name.include?('repeated'),
       )
     end
 
@@ -216,7 +216,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
           nil, # TODO: determine default from corresponding Ruby method signature?
           block.method_name.source.include?('optional'),
           false, # Not repeated
-          true # Is block
+          true, # Is block
         )
       end
     end
@@ -244,7 +244,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
         param_tags,
         parameter.source,
         parameter.file,
-        parameter.line
+        parameter.line,
       )
     end
 
@@ -259,7 +259,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
         parameter.line,
         nil,
         parameter[1].source,
-        true
+        true,
       )
     end
 
@@ -275,7 +275,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
         nil,
         nil,
         false,
-        true
+        true,
       )
     end
 
@@ -292,7 +292,7 @@ class OpenvoxStrings::Yard::Handlers::Ruby::FunctionHandler < OpenvoxStrings::Ya
         nil,
         false,
         false,
-        true
+        true,
       )
     end
 

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

@@ -170,7 +170,7 @@ module OpenvoxStrings::Yard::Parsers::Puppet
       case type_expr
       when Puppet::Pops::Model::AccessExpression
         # TODO: I don't like rebuilding the source from the AST, but AccessExpressions don't expose the original source
-        @alias_of = +"#{OpenvoxStrings::Yard::Util.ast_to_text(type_expr.left_expr)}[" # alias_of should be mutable so we add a + to the string.
+        @alias_of = "#{OpenvoxStrings::Yard::Util.ast_to_text(type_expr.left_expr)}[" # alias_of should be mutable so we add a + to the string.
         @alias_of << type_expr.keys.map { |key| OpenvoxStrings::Yard::Util.ast_to_text(key) }.join(', ')
         @alias_of << ']'
       else

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

@@ -25,7 +25,7 @@ class OpenvoxStrings::Yard::Tags::OverloadTag < YARD::Tags::Tag
       name, default = parameter
       tag = tags.find { |t| t.name == name } if tags
       type = tag&.types ? "#{tag.type} " : 'Any '
-      prefix = (name[0]).to_s if name.start_with?('*', '&')
+      prefix = name[0].to_s if name.start_with?('*', '&')
       name = name[1..] if prefix
       default = " = #{default}" if default
       "#{type}#{prefix}$#{name}#{default}"

data/lib/openvox-strings/yard/templates/default/layout/html/setup.rb

@@ -15,7 +15,7 @@ end
 # Renders the layout section.
 # @return [String] Returns the rendered section.
 def layout
-  @nav_url = url_for_list(!@file || options.index ? menu_lists.first[:type] : 'file')
+  @nav_url = url_for_list((!@file || options.index) ? menu_lists.first[:type] : 'file')
 
   case object
   when nil, String
@@ -78,53 +78,53 @@ def create_menu_lists
     {
       type: 'puppet_class',
       title: 'Puppet Classes',
-      search_title: 'Puppet Classes'
+      search_title: 'Puppet Classes',
     },
     {
       type: 'puppet_data_type',
       title: 'Data Types',
-      search_title: 'Data Types'
+      search_title: 'Data Types',
     },
     {
       type: 'puppet_defined_type',
       title: 'Defined Types',
-      search_title: 'Defined Types'
+      search_title: 'Defined Types',
     },
     {
       type: 'puppet_type',
       title: 'Resource Types',
-      search_title: 'Resource Types'
+      search_title: 'Resource Types',
     },
     {
       type: 'puppet_provider',
       title: 'Providers',
-      search_title: 'Providers'
+      search_title: 'Providers',
     },
     {
       type: 'puppet_function',
       title: 'Puppet Functions',
-      search_title: 'Puppet Functions'
+      search_title: 'Puppet Functions',
     },
     {
       type: 'puppet_task',
       title: 'Puppet Tasks',
-      search_totle: 'Puppet Tasks'
+      search_totle: 'Puppet Tasks',
     },
     {
       type: 'puppet_plan',
       title: 'Puppet Plans',
-      search_totle: 'Puppet Plans'
+      search_totle: 'Puppet Plans',
     },
     {
       type: 'class',
       title: 'Ruby Classes',
-      search_title: 'Class List'
+      search_title: 'Class List',
     },
     {
       type: 'method',
       title: 'Ruby Methods',
-      search_title: 'Method List'
-    }
+      search_title: 'Method List',
+    },
   ]
 
   menu_lists.delete_if { |e| YARD::Registry.all(e[:type].intern).empty? }
@@ -134,7 +134,7 @@ def create_menu_lists
     menu_lists << {
       type: 'file',
       title: 'Files',
-      search_title: 'File List'
+      search_title: 'File List',
     }
   end
 

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

@@ -10,7 +10,7 @@ end
 # Renders the overload section.
 # @return [String] Returns the rendered section.
 def overload
-  erb(object.type == :puppet_function ? :puppet_overload : :overload)
+  erb((object.type == :puppet_function) ? :puppet_overload : :overload)
 end
 
 # Renders the enum section.

data/lib/openvox-strings/yard.rb

@@ -61,7 +61,7 @@ class YARD::CLI::Yardoc
       :puppet_provider,
       :puppet_function,
       :puppet_task,
-      :puppet_plan
+      :puppet_plan,
     )
   end
 end

data/lib/openvox-strings.rb

@@ -79,10 +79,10 @@ module OpenvoxStrings
 
   # Runs the YARD documentation server.
   # @param [Array<String>] args The arguments to YARD.
-  def self.run_server(*args)
+  def self.run_server(*)
     require 'openvox-strings/yard'
     OpenvoxStrings::Yard.setup!
 
-    YARD::CLI::Server.run(*args)
+    YARD::CLI::Server.run(*)
   end
 end

data/lib/puppet/face/strings.rb

@@ -27,8 +27,8 @@ Puppet::Face.define(:strings, '0.0.1') do # rubocop:disable Metrics/BlockLength
       require 'openvox-strings'
 
       OpenvoxStrings.generate(
-        args.count > 1 ? args[0..-2] : OpenvoxStrings::DEFAULT_SEARCH_PATTERNS,
-        build_generate_options(args.last)
+        (args.count > 1) ? args[0..-2] : OpenvoxStrings::DEFAULT_SEARCH_PATTERNS,
+        build_generate_options(args.last),
       )
       nil
     end
@@ -46,7 +46,7 @@ Puppet::Face.define(:strings, '0.0.1') do # rubocop:disable Metrics/BlockLength
       check_required_features
       require 'openvox-strings'
 
-      modules = args.count > 1 ? args[0..-2] : []
+      modules = (args.count > 1) ? args[0..-2] : []
 
       # Generate documentation for all (or the given) modules
       module_docs = []
@@ -133,7 +133,7 @@ Puppet::Face.define(:strings, '0.0.1') do # rubocop:disable Metrics/BlockLength
       search_patterns = ['types/**/*.pp', 'lib/**/*.rb']
       OpenvoxStrings.generate(
         search_patterns,
-        build_generate_options(options)
+        build_generate_options(options),
       )
       nil
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openvox-strings
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Puppet Inc.
@@ -34,16 +34,22 @@ dependencies:
   name: rgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: voxpupuli-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 email: voxpupuli@groups.io
 executables: []
 extensions: []
@@ -250,14 +270,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Puppet documentation via YARD
 test_files: []