utils 0.60.1 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88ba0780f681bd2eda0c0540db25a4aa5ca26a01f2147ded80e70f4536106438
-  data.tar.gz: 054cec3fd556ab33f2c5458f0e7ce43e78cd1b86aac31ac031ce52452b320ea5
+  metadata.gz: c49b13b25be28b485a47834d29a84674332532062a752b3cae2da1877fca4b38
+  data.tar.gz: a2a8292a3b73c5527915f81218be45a9f48af681827aa342c0d79bfc2172ce9d
 SHA512:
-  metadata.gz: 3421e11798a097f7d8342919e1e8dfe66d83d17981d1fe23257bbaa9f8ae1c1ac8feeccc9623577b73c6d1f106d794d397e5cd99ad254dcef4bc2dafefdd575c
-  data.tar.gz: 14008c6d12939b0247679e285e45638bbc6abff83d14071babf9d3fb624284d7737eabd4311bf3e889f6655c2bd68cf84b08da41158a71d589b9fbe4bb19d990
+  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/bin/git-versions

@@ -1,25 +1,25 @@
 #!/usr/bin/env ruby
 
-require 'tins/xt'
+require 'tins'
 require 'term/ansicolor'
-include Tins::GO
-
-$opts = go 'r:v'
-
 class String
   include Term::ANSIColor
+  include Tins::StringVersion
 end
+require 'shellwords'
 
-regexp = $opts[?r] && Regexp.new($opts[?r]) || /^v((?:\d+\.)*\d+)/
+args = ARGV.dup
+args.empty? and args.concat %w[ --color --stat ]
+
+regexp = ENV['GIT_VERSIONS_REGEXP']
+regexp = regexp ? Regexp.new(regexp) : /^v((?:\d+\.)*\d+)/
 
 versions = `git tag`.lines.map(&:chomp).grep(regexp).sort_by { |x|
   x[regexp, 1].version
 }.reverse
+
+git_options = args.empty? ? ' ' : " #{Shellwords.join(args)} "
 versions.each_cons(2) do |new, old|
   puts "Version #{new}".red.bold
-  if $opts[?v]
-    puts `git log --color --stat -u #{old}..#{new}`
-  else
-    puts `git log --color --stat #{old}..#{new}`
-  end
+  puts `git log #{git_options}#{old}..#{new}`
 end

data/bin/strip_spaces

@@ -6,12 +6,9 @@ require 'tins/secure_write'
 include Tins::SecureWrite
 require 'tins/find'
 include Tins::Find
+require 'tins/xt/file_binary'
 require 'utils'
 
-class ::File
-  include Utils::FileXt
-end
-
 def usage
   puts <<-EOT
 Usage: #{File.basename($0)} [OPTS] [PATHS]

data/lib/utils/finder.rb

@@ -5,10 +5,6 @@ require 'digest/md5'
 require 'fileutils'
 require 'mize'
 
-class ::File
-  include Utils::FileXt
-end
-
 class Utils::Finder
   include Tins::Find
   include Utils::Patterns

data/lib/utils/grepper.rb

@@ -1,10 +1,6 @@
 require 'term/ansicolor'
 require 'tins/xt'
 
-class ::File
-  include Utils::FileXt
-end
-
 class Utils::Grepper
   include Tins::Find
   include Utils::Patterns

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.60.1'
+  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/lib/utils.rb

@@ -1,6 +1,5 @@
 module Utils
   require 'utils/version'
-  require 'utils/file_xt'
   require 'utils/md5'
   require 'utils/patterns'
   require 'utils/config_file'

data/utils.gemspec

@@ -1,23 +1,23 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.60.1 ruby lib
+# stub: utils 0.61.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.60.1".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-10-31"
+  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]
-  s.extra_rdoc_files = ["README.md".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/file_xt.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe_server.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze]
-  s.files = [".github/dependabot.yml".freeze, ".github/workflows/codeql-analysis.yml".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ascii7".freeze, "bin/blameline".freeze, "bin/changes".freeze, "bin/classify".freeze, "bin/code_comment".freeze, "bin/commit_message".freeze, "bin/create_cstags".freeze, "bin/create_tags".freeze, "bin/discover".freeze, "bin/edit".freeze, "bin/edit_wait".freeze, "bin/enum".freeze, "bin/git-empty".freeze, "bin/git-versions".freeze, "bin/json_check".freeze, "bin/long_lines".freeze, "bin/myex".freeze, "bin/number_files".freeze, "bin/on_change".freeze, "bin/path".freeze, "bin/print_method".freeze, "bin/probe".freeze, "bin/rd2md".freeze, "bin/search".freeze, "bin/sedit".freeze, "bin/serve".freeze, "bin/ssh-tunnel".freeze, "bin/strip_spaces".freeze, "bin/sync_dir".freeze, "bin/untest".freeze, "bin/utils-utilsrc".freeze, "bin/vcf2alias".freeze, "bin/yaml_check".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/file_xt.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe_server.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze, "utils.gemspec".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe_server.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze]
+  s.files = [".github/dependabot.yml".freeze, ".github/workflows/codeql-analysis.yml".freeze, "COPYING".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "bin/ascii7".freeze, "bin/blameline".freeze, "bin/changes".freeze, "bin/classify".freeze, "bin/code_comment".freeze, "bin/commit_message".freeze, "bin/create_cstags".freeze, "bin/create_tags".freeze, "bin/discover".freeze, "bin/edit".freeze, "bin/edit_wait".freeze, "bin/enum".freeze, "bin/git-empty".freeze, "bin/git-versions".freeze, "bin/json_check".freeze, "bin/long_lines".freeze, "bin/myex".freeze, "bin/number_files".freeze, "bin/on_change".freeze, "bin/path".freeze, "bin/print_method".freeze, "bin/probe".freeze, "bin/rd2md".freeze, "bin/search".freeze, "bin/sedit".freeze, "bin/serve".freeze, "bin/ssh-tunnel".freeze, "bin/strip_spaces".freeze, "bin/sync_dir".freeze, "bin/untest".freeze, "bin/utils-utilsrc".freeze, "bin/vcf2alias".freeze, "bin/yaml_check".freeze, "lib/utils.rb".freeze, "lib/utils/config_file.rb".freeze, "lib/utils/editor.rb".freeze, "lib/utils/finder.rb".freeze, "lib/utils/grepper.rb".freeze, "lib/utils/irb.rb".freeze, "lib/utils/line_blamer.rb".freeze, "lib/utils/line_formatter.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/patterns.rb".freeze, "lib/utils/probe_server.rb".freeze, "lib/utils/ssh_tunnel_specification.rb".freeze, "lib/utils/version.rb".freeze, "lib/utils/xt/source_location_extension.rb".freeze, "utils.gemspec".freeze]
   s.homepage = "http://github.com/flori/utils".freeze
   s.licenses = ["GPL-2.0".freeze]
   s.rdoc_options = ["--title".freeze, "Utils - Some useful command line utilities".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.5.22".freeze
+  s.rubygems_version = "3.5.23".freeze
   s.summary = "Some useful command line utilities".freeze
 
   s.specification_version = 4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.60.1
+  version: 0.61.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -248,7 +248,6 @@ extra_rdoc_files:
 - lib/utils.rb
 - lib/utils/config_file.rb
 - lib/utils/editor.rb
-- lib/utils/file_xt.rb
 - lib/utils/finder.rb
 - lib/utils/grepper.rb
 - lib/utils/irb.rb
@@ -303,7 +302,6 @@ files:
 - lib/utils.rb
 - lib/utils/config_file.rb
 - lib/utils/editor.rb
-- lib/utils/file_xt.rb
 - lib/utils/finder.rb
 - lib/utils/grepper.rb
 - lib/utils/irb.rb
@@ -339,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Some useful command line utilities

data/lib/utils/file_xt.rb

@@ -1,46 +0,0 @@
-require 'tins'
-
-module Utils
-  module FileXt
-    extend DSLKit::Concern
-    include File::Constants
-
-    SEEK_SET = File::SEEK_SET
-
-    ZERO   = "\x00"
-    BINARY = "\x01-\x1f\x7f-\xff"
-
-    if defined?(::Encoding)
-      ZERO.force_encoding(Encoding::ASCII_8BIT)
-      BINARY.force_encoding(Encoding::ASCII_8BIT)
-    end
-
-    def binary?
-      old_pos = tell
-      seek 0, SEEK_SET
-      data = read 2 ** 13
-      !data or data.empty? and return nil
-      data.count(ZERO) > 0 and return true
-      data.count(BINARY).to_f / data.size > 0.3
-    ensure
-      seek old_pos, SEEK_SET
-    end
-
-    def ascii?
-      case binary?
-      when true   then false
-      when false  then true
-      end
-    end
-
-    module ClassMethods
-      def binary?(name)
-        File.open(name, 'rb') { |f| f.binary? }
-      end
-
-      def ascii?(name)
-        File.open(name, 'rb') { |f| f.ascii? }
-      end
-    end
-  end
-end