Fix pronto complaints

Author: Dakad

.rubocop.yml

@@ -1,9 +1,21 @@
 # This gist contains the config for rubocop-performance >1.11 / rubocop >1.22, for ruby 3.0: https://gist.github.com/apptweak-ci/2aca83afffbcbe0c0bca2beaab1500c0
 inherit_from: https://gist.githubusercontent.com/apptweak-ci/2aca83afffbcbe0c0bca2beaab1500c0/raw/.rubocop.yml
 
-require:
+plugins:
+  - rubocop-performance
   - rubocop-rake
+
+require:
   - rubocop-yard
 
 Gemspec/RequireMFA:
   Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - "lib/yard-apptweak-template.rb"
+
+Style/DocumentationMethod:
+  Exclude:
+    - "lib/yard-apptweak-template/stubs/**/*"
+    - "lib/yard-apptweak-template/templates/**/*"

Gemfile

@@ -15,12 +15,11 @@ group :development do
   gem "lefthook", "~> 1.8", require: false
   gem "pronto", "~> 0.11.1", require: false
   gem "pronto-rubocop", require: false
-  gem "webrick", require: false
   gem "rubocop", "~> 1.68", require: false
   gem "rubocop-performance", "~> 1.22", require: false
   gem "rubocop-rake", "~> 0.6", require: false
   gem "rubocop-yard", "~> 0.9", require: false
-
+  gem "webrick", require: false
   gem "yard-junk", require: false
   gem "yard-markdown", require: false
 end

bin/new_release

@@ -89,7 +89,7 @@ class ReleaseManager
     # Store initial state for potential rollback
     @initial_state = {
       branch: current_branch,
-      commit_sha: get_current_commit_sha
+      commit_sha: current_commit_sha
     }
     @current_phase = PHASES[:init]
 
@@ -162,7 +162,7 @@ class ReleaseManager
 
     # Get current commit SHA for potential rollback
     # @return [String] current commit SHA
-    def get_current_commit_sha
+    def current_commit_sha
       sha, _err = silent_runner.run("git rev-parse HEAD")
       sha.strip
     end

lib/yard-apptweak-template.rb

@@ -9,7 +9,9 @@
 require_relative "yard-apptweak-template/yard/html_helper"
 require_relative "yard-apptweak-template/patches/c_base_handler"
 
+# Module for Yard-related code.
 module ApptweakTemplateYARD
+  # Initialize the Yard-related code.
   def self.init
     # https://github.com/burtlo/yard-cucumber/blob/master/lib/yard-cucumber.rb
     # This registered template works for yardoc
@@ -28,6 +30,7 @@ def self.init
     YARD::Tags::Library.visible_tags |= tags
   end
 
+  # @return [String] Path to the templates
   def self.templates_path
     File.join(__dir__, "yard-apptweak-template", "templates")
   end

lib/yard-apptweak-template/patches/c_base_handler.rb

@@ -3,23 +3,36 @@
 module YARD
   module Handlers
     module C
+      # Patch for YARD's C Base handler to correctly map C exception variables
+      # to their corresponding Ruby class names.
       class Base < Handlers::Base
         # Temporary workaround until a proper fix can be applied to YARD master.
         alias namespace_for_variable_original namespace_for_variable
+
+        # Overrides the original method to include custom mapping for C exception variables.
+        # Falls back to the original implementation if no custom mapping is found.
+        #
+        # @param var [String] The C variable name.
+        # @return [CodeObjects::NamespaceObject, nil] The corresponding namespace object or nil.
         def namespace_for_variable(var)
           patch_namespace_for_variable(var) ||
             namespace_for_variable_original(var)
         end
 
         private
 
+          # Attempts to find a Ruby class name mapping for the given C variable.
+          #
+          # @param var [String] The C variable name.
+          # @return [CodeObjects::Proxy, nil] A proxy object for the mapped class or nil.
           def patch_namespace_for_variable(var)
             name = PATCH_ERROR_NAME[var]
             # $stderr.puts "Mapped #{var} to #{name}" if name
             name.nil? ? nil : P(name)
           end
 
           # Generated by update_error_map.rb (Copy+past results)
+          # Maps C exception variable names to their Ruby class names.
           PATCH_ERROR_NAME = {
             "rb_eException" => "Exception",
             "rb_eSystemExit" => "SystemExit",

lib/yard-apptweak-template/stubs/autoload.rb

@@ -2,6 +2,7 @@
 
 module ApptweakTemplateYARD
   module Stubs
+    # Generates the autoload file for the SketchUp API stubs.
     class AutoLoadGenerator
       # @param [YARD::CodeObject::Base] namespace_objects
       # @param [IO] out
@@ -20,7 +21,7 @@ def generate(namespace_objects, out)
 
       private
 
-        class Node
+        class Node # :nodoc:
           attr_reader :object, :dependencies
 
           def initialize(object)
@@ -53,7 +54,7 @@ def hash
           end
         end
 
-        class NodeFactory
+        class NodeFactory # :nodoc:
           def initialize
             @dependencies = {}
           end

lib/yard-apptweak-template/yard/handlers/class_constants.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ApptweakTemplateYARD
+  # Handles the definition of class constants defined in the Ruby code using
+  # the `DEFINE_RUBY_CLASS_CONSTANT` macro.
   class ClassConstantHandler < YARD::Handlers::C::Base
     MATCH = /\bDEFINE_RUBY_CLASS_CONSTANT\s*\(([^,]+)\s*,\s*([^,]+)\s*,\s*(\w+)\s*\)\s*;/xm
     handles MATCH

lib/yard-apptweak-template/yard/handlers/class_enum_constants.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ApptweakTemplateYARD
+  # Handles the definition of class enum constants defined in the Ruby code
+  # using the `DEFINE_RUBY_CLASS_ENUM` macro.
   class ClassEnumConstantHandler < YARD::Handlers::C::Base
     MATCH = /\bDEFINE_RUBY_CLASS_ENUM\s*\(([^,]+)\s*,\s*(\w+)\s*\)\s*;/xm
     handles MATCH

lib/yard-apptweak-template/yard/handlers/global_constants.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module ApptweakTemplateYARD
+  # Handles the definition of global constants defined in the Ruby code using
+  # the `DEFINE_RUBY_CONSTANT` macro or `rb_define_global_const`.
   class GlobalConstantHandler < YARD::Handlers::C::Base
     MATCH = /\bDEFINE_RUBY_(?:(?:NAMED_)?CONSTANT|ENUM)\s*\((?:[^)]+,\s*)?(\w+)\)\s*;/xm
     handles MATCH

lib/yard-apptweak-template/yard/html_helper.rb

@@ -3,9 +3,15 @@
 require "rouge"
 
 # Injection pattern copied from YARD::CodeRay:
-# https://github.com/sagmor/yard-coderay/blob/master/lib/yard/coderay/html_helper.rb
+#
+# @see https://github.com/sagmor/yard-coderay/blob/master/lib/yard/coderay/html_helper.rb
 module ApptweakTemplateYARD
+  # Module for Yard-related code.
   module HTMLHelper
+    # Highlight the source code of a C++ method.
+    #
+    # @param source [String] The source code to highlight.
+    # @return [String] The highlighted source code.
     def html_syntax_highlight_cpp(source)
       # puts "html_syntax_highlight_cpp (GEM)"
       formatter = Rouge::Formatters::HTML.new