Merge pull request #3 from voxpupuli/ruby27

Add Ruby 2.7/3.0 support

Author: bastelfreak

.rubocop_todo.yml

@@ -94,13 +94,6 @@ RSpec/ExpectInHook:
   Exclude:
     - 'spec/unit/openvox-strings/json_spec.rb'
 
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-RSpec/IncludeExamples:
-  Exclude:
-    - 'spec/unit/openvox-strings/json_spec.rb'
-    - 'spec/unit/openvox-strings/markdown_spec.rb'
-
 # Offense count: 91
 RSpec/MultipleExpectations:
   Max: 64
@@ -127,17 +120,6 @@ Rake/Desc:
   Exclude:
     - 'Rakefile'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
-# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
-# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
-# FunctionalMethods: let, let!, subject, watch
-# AllowedMethods: lambda, proc, it
-Style/BlockDelimiters:
-  Exclude:
-    - 'lib/openvox-strings/markdown/base.rb'
-
 # Offense count: 1
 Style/ClassVars:
   Exclude:
@@ -150,6 +132,15 @@ Style/CombinableLoops:
     - 'lib/openvox-strings/markdown.rb'
     - 'lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb'
 
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: literals, strict
+Style/MutableConstant:
+  Exclude:
+    - 'lib/openvox-strings/yard/handlers/ruby/base.rb'
+    - 'lib/openvox-strings/yard/parsers/puppet/statement.rb'
+
 # Offense count: 20
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
@@ -169,11 +160,10 @@ Style/OptionalBooleanParameter:
     - 'lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb'
     - 'lib/openvox-strings/yard/handlers/ruby/function_handler.rb'
 
-# Offense count: 3
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 Style/RedundantParentheses:
   Exclude:
-    - 'lib/openvox-strings/yard/code_objects/function.rb'
     - 'lib/openvox-strings/yard/handlers/puppet/function_handler.rb'
     - 'lib/openvox-strings/yard/tags/overload_tag.rb'
 
@@ -209,13 +199,12 @@ Style/StringLiterals:
     - 'Gemfile'
     - 'Rakefile'
 
-# Offense count: 7
+# Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, AllowSafeAssignment.
 # SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
 Style/TernaryParentheses:
   Exclude:
-    - 'lib/openvox-strings/markdown/base.rb'
     - 'lib/openvox-strings/tasks/generate.rb'
     - 'lib/openvox-strings/yard/templates/default/layout/html/setup.rb'
     - 'lib/openvox-strings/yard/templates/default/tags/setup.rb'
@@ -250,15 +239,14 @@ Style/TrailingCommaInArrayLiteral:
     - 'spec/unit/openvox-strings/yard/handlers/ruby/data_type_handler_spec.rb'
     - 'spec/unit/openvox-strings/yard/parsers/puppet/parser_spec.rb'
 
-# Offense count: 32
+# Offense count: 30
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, diff_comma, no_comma
 Style/TrailingCommaInHashLiteral:
   Exclude:
     - 'lib/openvox-strings/describe.rb'
     - 'lib/openvox-strings/json.rb'
-    - 'lib/openvox-strings/markdown/base.rb'
     - 'lib/openvox-strings/tasks/generate.rb'
     - 'lib/openvox-strings/tasks/validate.rb'
     - 'lib/openvox-strings/yard/code_objects/data_type.rb'

Gemfile

@@ -32,7 +32,7 @@ group :development do
 end
 
 group :rubocop do
-  gem 'voxpupuli-rubocop', '~> 4.1.0'
+  gem 'voxpupuli-rubocop', '~> 3.1.0'
 end
 
 # https://github.com/OpenVoxProject/puppet/issues/90

README.md

@@ -10,8 +10,10 @@ Strings processes code and YARD-style code comments to create documentation in H
 
 ### Requirements
 
-* Ruby 3.1.0 or newer
-* Puppet 8.0.0 or newer
+* Ruby 2.7 or newer
+* OpenVox 7 or newer
+
+For detailed dependencies, please checkout the gemspec file.
 
 ### Install Puppet Strings
 

lib/openvox-strings/markdown/base.rb

@@ -95,7 +95,7 @@ def initialize(registry, component_type)
       summary: 'summary',
       note: 'note',
       todo: 'todo',
-      deprecated: 'deprecated' }.each do |method_name, tag_name|
+      deprecated: 'deprecated', }.each do |method_name, tag_name|
       # @return [String] unless the tag is nil or the string.empty?
       define_method method_name do
         @tags.find { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }[:text] if @tags.any? { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }
@@ -181,9 +181,9 @@ def defaults
     def toc_info
       {
         name: name.to_s,
-        link:,
+        link: link,
         desc: summary || @registry[:docstring][:text][0..140].tr("\n", ' '),
-        private: private?
+        private: private?,
       }
     end
 
@@ -199,9 +199,9 @@ def private?
     def word_wrap(text, line_width: 120, break_sequence: "\n")
       return unless text
 
-      text.split("\n").map! { |line|
-        line.length > line_width ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
-      } * break_sequence
+      text.split("\n").map! do |line|
+        (line.length > line_width) ? line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1#{break_sequence}").strip : line
+      end * break_sequence
     end
 
     # @return [String] full markdown rendering of a component

lib/openvox-strings/yard/code_objects/function.rb

@@ -69,7 +69,7 @@ def signature
       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}"
@@ -94,7 +94,7 @@ def to_hash
         hash[:signatures] << { signature: o.signature, docstring: OpenvoxStrings::Yard::Util.docstring_to_hash(o.docstring, %i[param option enum return example]) }
       end
     else
-      hash[:signatures] << { signature:, docstring: OpenvoxStrings::Yard::Util.docstring_to_hash(docstring, %i[param option enum return example]) }
+      hash[:signatures] << { signature: signature, docstring: OpenvoxStrings::Yard::Util.docstring_to_hash(docstring, %i[param option enum return example]) }
     end
 
     hash[:docstring] = OpenvoxStrings::Yard::Util.docstring_to_hash(docstring)

lib/openvox-strings/yard/handlers/ruby/data_type_handler.rb

@@ -237,7 +237,7 @@ def extract_params(hash)
         default   = value['value'] unless value['value'].nil?
       end
       data_type = [data_type] unless data_type.nil? || data_type.is_a?(Array)
-      params_hash[key] = { types: data_type, default: }
+      params_hash[key] = { types: data_type, default: default }
     end
 
     params_hash

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

@@ -170,7 +170,7 @@ def initialize(object, file)
       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

openvox-strings.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary = 'Puppet documentation via YARD'
   s.email = '[email protected]'
   s.homepage = 'https://github.com/voxpupuli/openvox-strings'
-  s.required_ruby_version = '>= 3.1.0'
+  s.required_ruby_version = '>= 2.7.0'
 
   s.extra_rdoc_files = [
     'CHANGELOG.md',
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   ]
   s.files = Dir['CHANGELOG.md', 'README.md', 'LICENSE', 'lib/**/*', 'exe/**/*']
 
-  s.add_dependency 'openvox', '~> 8.19'
+  s.add_dependency 'openvox', '>= 7', '< 9'
   s.add_dependency 'rgen', '~> 0.9'
   s.add_dependency 'yard', '~> 0.9'
 end

spec/unit/openvox-strings/json_spec.rb

@@ -310,7 +310,7 @@ class klass(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
 #
 # @param [Proc] block The block to capture output from
 # @return [Hash] A hash containing the captured output
-def capture_output(&)
+def capture_output(&_block)
   begin
     $stdout = StringIO.new
     $stderr = StringIO.new