utils 0.60.2 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6248e316412b8927ac4a15ed491fdbe83d86db6f121d96de85eed9a6aa1cd400
-  data.tar.gz: 2845d382afc8c0a597a947c2213ba1043548a19031865db0f57a087e72a9c044
+  metadata.gz: c49b13b25be28b485a47834d29a84674332532062a752b3cae2da1877fca4b38
+  data.tar.gz: a2a8292a3b73c5527915f81218be45a9f48af681827aa342c0d79bfc2172ce9d
 SHA512:
-  metadata.gz: 438e3e13d461aeb22ffbccac934906b98b52bcc1e31af6cb2eaf9006631f7ea11ddfe76ba78cb3bee85ba980eb4190c1db99b4e0b342ca046283cd47e6360830
-  data.tar.gz: 6643afbc8922f6711939cb91371e5b56310147ffcb7774ee4e950eeae0b041c52ac927f9a6b061ff7aa4ca19bdeece11a4fa42d05a8d9e4f76fd09677a3eda32
+  metadata.gz: 9233604e38ee99da756da940174ccaadf801fef1be301e4cd58bdbfd076fc448a412e48d436ccb8f607729c521bb32096e459282607815888c582be72cded64a
+  data.tar.gz: 60f5a01d279a88784aa6c717b2baf11396d0fc5703f30b1353144e650bfba49c9b473114f8817fbfd70326358e99cf6952d18c8a301d233035ef1d095e37d18f

data/bin/code_comment

@@ -8,7 +8,7 @@ def fetch_method(filename_linenumber)
   result = ''
   source_location = filename_linenumber.source_location
   lf = Tins::LinesFile.for_filename(source_location.filename, source_location.linenumber)
-  if spaces = lf.match_backward(/^(\s*)def\s+(?:\S+?)(?:\(|\s*$)/)&.first
+  if spaces = lf.match_backward(/^(\s*|.*?(private|protected)\s+)def\s+(?:\S+?)(?:\(|\s*$)/)&.first
     line_number_begin = lf.line_number
     lf.match_forward(/^#{spaces}end/)
     line_number_end = lf.line_number
@@ -26,11 +26,12 @@ def fetch_file(filename_linenumber)
 end
 
 filename_linenumber = ARGV.shift or fail "require file_name as second argument"
-method   = fetch_method(filename_linenumber)
-#file     = fetch_file(filename_linenumber)
-files = Dir['{lib,spec,test}/**/*.rb']
-base_url = ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
-model    = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
+method              = fetch_method(filename_linenumber)
+method_indent       = method[/\A( *)/, 1].size
+#file                = fetch_file(filename_linenumber)
+files               = Dir['{lib,spec,test}/**/*.rb']
+base_url            = ENV['OLLAMA_URL'] || 'http://%s' % ENV.fetch('OLLAMA_HOST')
+model               = ENV.fetch('OLLAMA_MODEL', 'llama3.2')
 #file                = File.read(file_name)
 #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
@@ -86,7 +87,10 @@ documentation later.
 EOT
 
 system = <<EOT
-You are a Ruby code commenter that writes succinct, simple ruby YARD comments.
+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 = nil
 
@@ -95,20 +99,52 @@ Analyze this code:
 
 #{files.map { File.read(_1) } * ?\n}
 
-Then output a succinct YARD comment for the method below.
+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.
+    #
+    # @example
+    #   bar.foo("blub", 4) { |a, b| … } #=> …
+    #
+    # @return [ ProcessResult ]
+    def foo(first, second, third: false, &block)
+      block or raise ArgumentError, 'no &block'
+      a = first * 2
+      if second < 0
+        raise ArgumentError, 'too small'
+      end
+      b = "foo" * second
+      if third
+        a = a * b
+      end
+      block_result = block.(a, b)
+      result = process block_result
+      return result
+    end
 
-Follow the following guidelines:
-- Do not repeat the ruby method code.
-- Do not use `, `ruby, ```, ```ruby in your response.
-- Start each line of your comment with a single # character.
+And this is the method you should document:
 
-Here's a cheatsheet for YARD you can peek into:
+#{method}
 
-#{cheatsheet}
+Output a YARD comment for this method:
 
-And this is the method you should document:
+Format requirements:
 
-#{method}
+1. Focus on providing a description of the method's purpose, without including any code snippets.
+2. Never use `, `ruby, ```, ```ruby in your response.
+3. Never add any other remarks or explanation to your response.
+4. Start each line of your comment with a single # character.
 EOT
 
 options = Ollama::Options.new(
@@ -131,5 +167,6 @@ if ENV['DEBUG'].to_i == 1
   end
 end
 
-ollama = Client.new(base_url:, read_timeout: 120)
-ollama.generate(model:, system:, prompt:, options:, stream: false, &Print)
+ollama   = Client.new(base_url:, read_timeout: 120)
+response = ollama.generate(model:, system:, prompt:, options:, stream: false).response
+puts response.gsub(/^/) { ' ' * method_indent }

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.60.2'
+  VERSION         = '0.61.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,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.60.2 ruby lib
+# stub: utils 0.61.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.60.2".freeze
+  s.version = "0.61.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-12-13"
+  s.date = "2024-12-14"
   s.description = "This ruby gem provides some useful command line utilities".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ascii7".freeze, "blameline".freeze, "changes".freeze, "classify".freeze, "code_comment".freeze, "commit_message".freeze, "create_cstags".freeze, "create_tags".freeze, "discover".freeze, "edit".freeze, "edit_wait".freeze, "enum".freeze, "git-empty".freeze, "git-versions".freeze, "json_check".freeze, "long_lines".freeze, "myex".freeze, "number_files".freeze, "on_change".freeze, "path".freeze, "print_method".freeze, "probe".freeze, "rd2md".freeze, "search".freeze, "sedit".freeze, "serve".freeze, "ssh-tunnel".freeze, "strip_spaces".freeze, "sync_dir".freeze, "untest".freeze, "utils-utilsrc".freeze, "vcf2alias".freeze, "yaml_check".freeze]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.60.2
+  version: 0.61.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-13 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar