utils 0.69.0 → 0.70.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85f412311ef245615fb822299605146a2b1fe3c6a678b7c4826bfda8c7f80e78
-  data.tar.gz: 0af45f306f2115ccb6b2a508d7d206a19d8433305d88e9d4b36da3d362edbae3
+  metadata.gz: 5ceaf5765e54421ff1940fb7f39c2e46a40ae1f3886b31490da70780e810cdf6
+  data.tar.gz: 3b1df5558bb1a352778b8c747a4a1085951a16e4dc33050a2d14ce5353402ad6
 SHA512:
-  metadata.gz: 5b72e6f84ed6945c7dcc29ce430385c29fe5f91ff27a5ddeff394e09a0c43324845677a775311cd67059507918a3080699b78d9c1828c132d439a4055103881e
-  data.tar.gz: 26f68d486605ae78883a3dd6589517e80351f186efb17e4be12946b18d2fbdbd870276f89ee68e08f8eb1f21ff0958cc7ff7b100ab709ae7a128ac475ca0208a
+  metadata.gz: a1318e0a95615867bdaff12d8a5fd88e9e8329ab997585a804e7e8f160b7ff303d33101b9f43b055ec6bbc30c93ba9c915f9e5c3c29f4d45c876377b7269225c
+  data.tar.gz: 6f064a83362f4e5053fb3dbb37ab1331b00865707139cc880e08f2230fac2c95bb16184814e707c8f88f87a08aa3f13b3d432cac6e706443c4feeb12a51f5c59

data/bin/code_comment

@@ -54,24 +54,18 @@ META_METHOD = /(
   )?                          # Optional variant
 )\s+:/x
 
-# Fetches the method definition from a given filename and line number.
-#
-# This method retrieves the source code of a method by analyzing the file
-# location and line number provided. It attempts to identify the method
-# definition by examining the surrounding context, including handling
-# private and protected method declarations.
-#
-# @param filename_linenumber [ Object ] an object that responds to #source_location
-#                                       and provides filename and line number information
-#
-# @return [ String ] the source code of the method definition, or an empty string
-#                    if the method cannot be determined
-def fetch_method(filename_linenumber)
+def fetch_construct(filename_linenumber)
   result = ''
   source_location = filename_linenumber.source_location
   lf = Tins::LinesFile.for_filename(source_location.filename, source_location.linenumber)
+  if /^(?:\s*)(class|module)/ =~ lf.line
+    return lf.line, $1.to_sym
+  end
+  if /^(?:\s*)(?:[A-Z]\w*)\s*=\s*(Class|Module)\.new/ =~ lf.line
+    return lf.line, $1.downcase.to_sym
+  end
   if lf.line =~ META_METHOD
-    return lf.line
+    return lf.line, :method
   end
   if spaces = lf.match_backward(/^(\s*?)(\S.*?\s+)?def\s+/)&.first
     line_number_begin = lf.line_number
@@ -82,68 +76,132 @@ def fetch_method(filename_linenumber)
       result << lf.line
     end
   end
-  result
+  return result, :method
+end
+
+def build_method_prompt(construct_type, construct, file_contents)
+  default_prompt = <<~EOT
+    Look at this code to document it:
+
+    %{file_contents}
+
+    Here's an example for how you should document a %{construct_type}.
+
+      # The foo %{construct_type} computes the bar result by processing…
+      # then it returns the result.
+      #
+      # @param first [ String ] the foo string
+      # @param second [ Integer ] the number of bars lengthy detailed mutltiline
+      #                           detailed explanation including a newline.
+      # @param third [ TrueClass, FalseClass ]
+      #
+      # @yield [ a, b ]
+      #
+      # @raise [ ArgumentError ] if block argument wasn't provided
+      # @raise [ ArgumentError ] if second parameter was too small.
+      #
+      # @return [ ProcessResult ]
+
+    And this is the %{construct_type} you should document:
+
+    %{construct}
+
+    Output a YARD comment for this %{construct_type}:
+
+    Format requirements:
+
+    1. Focus on providing a description of the %{construct_type}'s purpose
+       without including any code snippets.
+    2. You should omit the @raise if you are not sure.
+    3. Never use `, `ruby, ```, ```ruby in your response.
+    4. Never add any other remarks or explanation to your response.
+    5. Start each line of your comment with a single # character.
+  EOT
+  $config.read('method-prompt.txt', default: default_prompt) % {
+    construct_type:, construct:, file_contents:,
+  }
+end
+
+def build_class_module_prompt(construct_type, construct, file_contents)
+  default_prompt = <<~EOT
+    Look at this code to document it:
+
+    %{file_contents}
+
+    Here's an example for how you should document a %{construct_type}.
+
+      # A brief description of what this %{construct_type} does.
+      #
+      # @example
+      #   MyClass.new do |obj|
+      #     obj.method
+      #   end
+
+    And this is the %{construct_type} you should document:
+
+    %{construct}
+
+    Output a YARD comment for this %{construct_type}:
+
+    Format requirements:
+
+    1. Focus on providing a description of the %{construct_type}'s purpose
+       without including any code snippets.
+    2. Include @example tag if there are notable usage patterns for this
+       construct.
+    3. Never use `, `ruby, ```, ```ruby in your response.
+    4. Never add any other remarks or explanation to your response.
+    5. Start each line of your comment with a single # character.
+  EOT
+  $config.read('class-module-prompt.txt', default: default_prompt) % {
+    construct_type:, construct:, file_contents:,
+  }
+end
+
+def build_prompt(construct_type, construct, file_contents)
+  case construct_type
+  when :method
+    build_method_prompt(construct_type, construct, file_contents)
+  when :class, :module
+    build_class_module_prompt(construct_type, construct, file_contents)
+  else
+    fail "unknown construct_type #{construct_type.inspect}"
+  end
 end
 
 filename_linenumber = ARGV.shift or fail "require file_name as second argument"
-config              = Utils::ConfigDir.new('code_comment', env_var: 'XDG_CONFIG_HOME')
-method              = fetch_method(filename_linenumber)
-method_indent       = method[/\A( *)/, 1].size
+$config             = Utils::ConfigDir.new('code_comment', env_var: 'XDG_CONFIG_HOME')
 files               = Dir['{lib,spec,test}/**/*.rb']
 base_url            = ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
 model               = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
+construct, construct_type = fetch_construct(filename_linenumber)
+construct_indent          = construct[/\A( *)/, 1].size
+file_contents = files.map { _1 + ":\n" + File.read(_1) } * ?\n
 #call_sites          = %x(cscope -L -3 "#{method_name}" $(find . -name '*.rb') | awk '{ print $1 ":" $3 }').lines.map(&:chomp).uniq
 #methods             = call_sites.map { fetch_method(_1) } * ?\n
 
-default_system = <<EOT
-Provide high-quality YARD comments for the given Ruby method, including a brief
-description of its purpose, parameters, raised exceptions (and why), and
-return values, assuming an expert-level understanding of the programming
-concepts involved.
-EOT
-system = config.read('system.txt', default: default_system)
+default_system = <<~EOT
+  **Guidelines**
 
-file_contents = files.map { _1 + ":\n" + File.read(_1) } * ?\n
-default_prompt = <<EOT
-Look at this code to document it:
-
-%{file_contents}
-
-Here's an example for how you should document a method.
-
-  # The foo method computes the bar result by processing…
-  # then it returns the result.
-  #
-  # @param first [ String ] the foo string
-  # @param second [ Integer ] the number of bars lengthy detailed mutltiline
-  #                           detailed explanation including a newline.
-  # @param third [ TrueClass, FalseClass ]
-  #
-  # @yield [ a, b ]
-  #
-  # @raise [ ArgumentError ] if block argument wasn't provided
-  # @raise [ ArgumentError ] if second parameter was too small.
-  #
-  # @return [ ProcessResult ]
-
-And this is the method you should document:
-
-%{method}
-
-Output a YARD comment for this method:
-
-Format requirements:
-
-1. Focus on providing a description of the method's purpose
-   without including any code snippets.
-2. You should ommit the @raise if you are not sure.
-3. Never use `, `ruby, ```, ```ruby in your response.
-4. Never add any other remarks or explanation to your response.
-5. Start each line of your comment with a single # character.
+  - When answering, assume an expert-level understanding of the programming
+  concepts involved.
+
+  - If given a **method**, provide high-quality YARD comments including:
+    * A brief description of its purpose
+    * Parameter documentation (@param)
+    * Return value documentation (@return)
+    * Exception documentation (@raise) when appropriate
+    * Avoid version information (@since)
+
+  - If given a **class or module**, provide high-quality YARD comments including:
+    * A brief description of its purpose
+    * Public interface documentation
+    * @example usage patterns when helpful
+    * Avoid version information (@since)
 EOT
-prompt = config.read('prompt.txt', default: default_prompt) % {
-  method:, file_contents:,
-}
+system = $config.read('system.txt', default: default_system)
+
+prompt = build_prompt(construct_type, construct, file_contents)
 
 default_options = JSON(
   #repeat_penalty: 1.8,
@@ -156,10 +214,10 @@ default_options = JSON(
   min_p: 0.1,
 )
 
-client_config = Client::Config.load_from_json config + 'client.json'
+client_config = Client::Config.load_from_json $config + 'client.json'
 client_config.base_url = base_url
 ollama  = Client.configure_with(client_config)
-options = JSON.parse(config.read('options.json', default: default_options))
+options = JSON.parse($config.read('options.json', default: default_options))
 
 if ENV['DEBUG'].to_i == 1
   File.open('debug.log', ?w) do |log|
@@ -171,4 +229,4 @@ if ENV['DEBUG'].to_i == 1
 end
 
 response = ollama.generate(model:, system:, prompt:, options:, stream: false, think: false).response
-puts response.gsub(/^/) { ' ' * method_indent }
+puts response.gsub(/^/) { ' ' * construct_indent }

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.69.0'
+  VERSION         = '0.70.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/utils.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.69.0 ruby lib
+# stub: utils 0.70.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.69.0".freeze
+  s.version = "0.70.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.27".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.0".freeze])
   s.add_development_dependency(%q<test-unit>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<unix_socks>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<webrick>.freeze, [">= 0".freeze])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.69.0
+  version: 0.70.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement