utils 0.93.0 → 0.95.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4412a2649cf7a18654f0cdec0cf7fa86ba33cb15c8cf88e2ef1ba10267753cd4
-  data.tar.gz: 30095f823b5fad6f66e79667d82f88757d47f04d28cde52fe7706c1731331d6b
+  metadata.gz: dd3330bad863906079106f503caa40f83af5dd978e5c4cbec9561cfbf22228b8
+  data.tar.gz: 1081b4d918807345b36faa44d13b1c5ec287bdaf8156edfa3090ec909c3570a3
 SHA512:
-  metadata.gz: 0aa5db98d16b760637beb04b4fa5fcd99cb951854b9bb6f8714bc350f2351bb2acbe26fc2220e35b7caf3e079f0b19c3fa74f218bc44107ad03d98c7cbbcb5c2
-  data.tar.gz: fdb6289ad43454ed499fbdf9ae17051d5b24e93c474dc9ddc81c1f34661135e1c5275bc9dfee6b0b505a017c5a64b9c8c8a28e1caa744f9d7ae255e4ea115951
+  metadata.gz: 2fcaa85ef0d3a75b97d6c019c6ffd824e519505204056760956df512e6a85dd41a44787a9a665331c21ff5477cdebbc6c97607749fcabc7d404bcc18654e7b15
+  data.tar.gz: 2ed4678d7c0b12d96f3d0099ae3563d553e9f571b3e1c6ee12d8d910b22cd0357795fc42ebf3383f34323c00f84c256984f716e25dda4eec91c21ac0b1f8a434

data/README.md

@@ -52,8 +52,7 @@ gem install utils
 ### 🔍 Searching
 
 - **`blameline`** - Show git blame line for a file and line number
-- **`create_cstags`** - Create cscope tags file for current directory
-- **`create_tags`** - Create ctags tags file for current directory  
+- **`code_indexer`** - Create ctags/cscope tags file for current directory  
 - **`discover`** - Find files with specific content patterns
 - **`git-versions`** - Show git versions of files and directories
 - **`long_lines`** - Finds long lines with author attribution

data/bin/code_indexer

@@ -4,11 +4,22 @@ require 'utils'
 config = Utils::ConfigFile.new
 config.configure_from_paths
 
+only_format = ARGV.shift
+
 config.code_indexer.formats.each do |format, output|
+  if only_format
+    format == only_format or next
+  end
   paths = config.code_indexer.paths.grep_v(/Resolving dependencies/)
   puts "Indexing code for #{format}…"
-  cmd = [ 'starscope', '-e', format, '-f', output, '--no-read' ]
-  config.code_indexer.verbose and cmd << '--verbose'
+  case format
+  when 'ctags'
+    cmd = [ 'ctags', '-f', output, '--exclude=pkg', '-R' ]
+    config.code_indexer.verbose and cmd << '--verbose'
+  when 'cscope'
+    cmd = [ 'starscope', '-e', format, '-f', output, '--no-read' ]
+    config.code_indexer.verbose and cmd << '--verbose'
+  end
   cmd.push(*paths)
   system(*cmd)
   puts "Done."

data/bin/discover

@@ -82,7 +82,7 @@ Options are
   -d          match also directories
   -D          list all search leaf directories
   -v          be verbose
-  -n NUMBER   the first NUMBER of matches is returned
+  -m NUMBER   the maximum NUMBER of matches that is returned
   -s          search by interactively inputting PATTERN
   -l          list all paths in cache relative to current directory
   -L          list all paths in cache as absolute pathes from root
@@ -94,14 +94,14 @@ Version is #{File.basename($0)} #{Utils::VERSION}.
   exit 1
 end
 
-args = go 'n:I:i:a:p:P:lLcreEvdsDgh', defaults: { ?a => '\\w' }
+args = go 'm:I:i:a:p:P:lLcreEvdsDgh', defaults: { ?a => '\\w' }
 args[?h] and usage
 
 Term::ANSIColor.coloring = (STDIN.tty? && ENV['TERM'] !~ /dumb/) && !args[?c]
 STDOUT.sync = true
 config = Utils::ConfigFile.new
 config.configure_from_paths
-args[?n] ||= (args[?l] || args[?L]) ? 1 << 60 : config.discover.max_matches
+args[?m] ||= (args[?l] || args[?L]) ? 1 << 60 : config.discover.max_matches
 
 if args[?s]
   pattern = ''
@@ -125,7 +125,7 @@ finder = -> * {
 search = -> * {
   f        = nil
   pattern  = pattern.dup
-  args[?n] = Term::ANSIColor.terminal_lines - 1
+  args[?m] = Term::ANSIColor.terminal_lines - 1
   found = Search.new(
     match: -> answer {
       pattern.replace answer

data/bin/on_change

@@ -1,53 +1,118 @@
 #!/usr/bin/env ruby
 #
-# Monitor file for changes and execute command when modified
+# Monitor a set of files (specified by glob patterns) for modifications.
+# When any watched file changes, run an arbitrary shell command,
+# optionally inserting the full path of that file via the placeholder %f.
 #
 # Usage:
-#   on_change filename [command...]    # Watch file and run command on changes
+#   ./on_change [OPTS] [COMMAND]
 #
-# This script monitors a file for modifications and executes a specified
-# command whenever the file is changed. It can be used for auto-reloading,
-# rebuilding, or triggering actions when source files are updated.
+# Options:
+#   -i <glob>   Glob pattern(s) of files to watch.  Can be repeated
+#               – e.g., `-i 'lib/**/*.rb' -i bin/*`.
+#   -d <sec>    Sleep interval (seconds) when no changes are detected.
+#               Must be a positive integer; defaults to 1 if omitted or <=0.
+#   -h          Show this help message and exit.
 #
-# If no command is provided, 'true' is executed by default.
+# If [COMMAND] is not supplied the script defaults to running `true`.
 #
-# Special replacement:
-#   %f in command will be replaced with the filename being monitored
+# Command placeholder:
+#   The string `%f` inside COMMAND will be replaced by the full path of
+#   each file that changed.  Example:
+#       ./on_change -i 'lib/**/*.rb' echo '%f has been modified'
 #
-# Examples:
-#   on_change Gemfile bundle install
-#   on_change tests/utils_test.rb ruby -I lib:tests %f
+#   • It prints each executed command (for debugging) before streaming its
+#     output to STDOUT.
+
+require 'set'
+require 'tins/go'
+include Tins::GO
+require 'shellwords'
 
 # The execute method runs a command by processing its arguments and displaying
 # the output.
 #
 # @param args [ Array ] the command arguments to be executed
 def execute(*args)
-  cmd = args.map(&:inspect) * ' '
-  puts "Executing: #{cmd}"
+  cmd = Shellwords.join(args)
+  puts "Executing: #{cmd.inspect}"
   IO.popen(cmd, 'r') do |io|
     io.each { |l| puts l }
   end
 end
 
+# Computes a set of file paths based on glob patterns specified in the global
+# $opts[?i] option. It iterates over each pattern, expands it with Dir.glob,
+# and merges the results into a Set to eliminate duplicates.
+#
+# @return [Set<String>] a set containing the unique file paths matched by the
+#   provided glob patterns
+def compute_files
+  files = Set[]
+  $opts[?i].to_a.each do |glob|
+    files.merge Dir.glob(glob)
+  end
+  files
+end
+
+# The usage method displays a help message explaining command‑line options and
+# exits the program with the supplied return code.
+#
+# @param rc [ Integer ] the exit status to use when terminating the process
+def usage(rc)
+  puts <<~EOT
+    Usage: #{File.basename($0)} [OPTS] [COMMAND]
+
+    Options are
+
+      -i <glob>   Glob pattern(s) of files to watch.
+                  The option may be repeated; all matching paths will be monitored.
+      -d <sec>    Sleep interval (in seconds) when no file changes are detected.  
+                  Defaults to 1 second if omitted or set to a non‑positive value.
+      -h          Show this help message and exit.
+
+    If [COMMAND] is not supplied the script defaults to running `true`.
+
+    The command may contain the placeholder `%f`, which will be replaced by
+    the full path of each file that changed. For example:
+
+        #{File.basename($0)} -i 'lib/**/*.rb' -i 'bin/*' echo %f has been modified
+
+    EOT
+  exit rc
+end
+
+$opts = go 'i:d:h'
+
+$opts[?h] and usage(0)
+
 argv = ARGV.dup
-filename = argv.shift or fail "require a filename as first argument"
 argv.empty? and argv << 'true'
-argv.map! { |a| a == '%f' ? filename : a }
-warn "Observing #{filename.inspect} for changes now and execute #{argv.inspect}."
-old_mtime = nil
+
+files = compute_files
+files.empty? and fail 'Require files to watch'
+
+old_mtimes = {}
+files.each do |filename|
+  mtime = File.mtime(filename)
+  old_mtimes[filename] = mtime
+end
+
 loop do
-  begin
-    mtime = File.mtime(filename)
-    if old_mtime.nil? || mtime > old_mtime
-      execute(*argv)
-    else
-      sleep 0.1
+  files = compute_files
+
+  files.each do |filename|
+    begin
+      mtime = File.mtime(filename)
+      if !old_mtimes.key?(filename) || mtime > old_mtimes[filename]
+        execute(*argv.map { _1 == '%f' ? filename : _1 })
+      end
+      old_mtimes[filename] = mtime
+    rescue Interrupt
+      exit 0
+    rescue Errno::ENOENT
+      old_mtimes.delete(filename)
     end
-  rescue Interrupt
-    exit 1
-  rescue Errno::ENOENT
-  ensure
-    old_mtime = mtime
   end
+  sleep $opts[?d].to_i.clamp(1..)
 end

data/bin/search

@@ -200,6 +200,7 @@ def usage
 
       -n PATTERN  only search files whose names match fuzzy PATTERN
       -N PATTERN  only search files whose names match regexp PATTERN
+      -m NUMBER   maximum number of files to return
       -s PATTERN  skip lines that match fuzzy PATTERN
       -S PATTERN  skip lines that match regexp PATTERN
       -A NUMBER   displays NUMBER lines of context after the match
@@ -227,7 +228,7 @@ def usage
   exit 1
 end
 
-args = go 'r:p:I:A:B:C:s:S:n:N:a:i:G:P:cfFlLeEvgh'
+args = go 'r:p:I:A:B:C:s:S:n:N:m:a:i:G:P:cfFlLeEvgh'
 args[?h] and usage
 pattern = ARGV.shift or usage
 roots = (ARGV.empty? ? [ Dir.pwd ] : ARGV).map { |f| File.expand_path(f) }

data/lib/utils/finder.rb

@@ -150,9 +150,9 @@ class Utils::Finder
     end
     paths.compact!
     @paths, @output = paths.sort.transpose.values_at(-2, -1)
-    if n = @args[?n]&.to_i
-      @paths = @paths&.first(n) || []
-      @output = @output&.first(n) || []
+    if m = @args[?m]&.to_i
+      @paths = @paths&.first(m) || []
+      @output = @output&.first(m) || []
     end
     self
   end

data/lib/utils/grepper.rb

@@ -88,6 +88,11 @@ class Utils::Grepper
         raise ArgumentError, "needs to be an integer number >= 1"
       end
     end
+
+    if max_files = @args[?m].to_i and max_files > 0
+      @max_files = max_files
+    end
+
     @paths  = []
     pattern_opts = opts.subhash(:pattern) | {
       :cset  => @args[?a],
@@ -260,8 +265,17 @@ class Utils::Grepper
       end
     }
     find(*@roots, visit: visit) do |filename|
-      match(filename)
+      if @max_files && @paths.length >= @max_files
+        break
+      else
+        match(filename)
+      end
+    end
+
+    if @max_files
+      @paths = @paths.first(@max_files)
     end
+
     @paths = @paths.sort_by(&:source_location)
     self
   end

data/lib/utils/line_formatter.rb

@@ -33,13 +33,13 @@ else
       # The start method initializes the error logging output.
       #
       # This method writes a header message to the output indicating where the
-      # error list will be stored, followed by a separator line made of dashes
+      # errors list will be stored, followed by a separator line made of dashes
       # that spans the width of the terminal.
       #
       # @param _ignore [ Object ] this parameter is ignored and exists for
       # interface compatibility
       def start(_ignore)
-        output.puts "Storing error list in #{@errors_lst.path.inspect}: "
+        output.puts "Storing errors list in #{@errors_lst.path.inspect}: "
         output.puts ?━ * Tins::Terminal.columns
       end
 

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.93.0'
+  VERSION         = '0.95.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.93.0 ruby lib
+# stub: utils 0.95.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.93.0".freeze
+  s.version = "0.95.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.93.0
+  version: 0.95.0
 platform: ruby
 authors:
 - Florian Frank