utils 0.59.2 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbe0007addc8116defba0c532f3f9b2266c49f5676ed64c461a58882234abc74
-  data.tar.gz: 5f59ed14c8e97ba588c03fe8f103a66addbec60f3ea2a9c942570825a979a6b8
+  metadata.gz: 5d5a13dd0dc3c72e4110c54d7b218275b8ffe0aaffb79d1ad14d0e8c4de2201f
+  data.tar.gz: e35c204313debe613cbe39e915f986d84faf6ff0ef9c0a7d3529eeabcab8f628
 SHA512:
-  metadata.gz: ec001d02e5cf6b9844532b0495d2b64e78e1503d120d831725ec77bb86e8c56929a68d8774de1593c890488a4b99d1b94d89dfb831d2dfb410b1effe93d28e9c
-  data.tar.gz: 78021684fb51db6b4a926046edb9cc38e56caf20d75937f3fad4c9df9533418bd56e3a9815173751755cfe96964cabba41631a0764ab73f45b61ac9f4690063c
+  metadata.gz: f2755da93986eb39d4c2736578fa26acba7b8a3a4d8a56baaf30c509eb008260eb30281ad26dfba430ab5d031381f5f84ae8a0f4e2fdacc635e96aa105f0ec72
+  data.tar.gz: 8169b9827f29e237e589e76cc98a732a0bda047f524eeccdeaf2e1a0aadc18accdc879fecdbb00c1b19fdb318b52dac193c795bba4cfddf4043db7ebaedd90fc

data/Rakefile

@@ -29,6 +29,7 @@ GemHadar do
   dependency 'search_ui',      '~> 0.0'
   dependency 'all_images',     '~> 0.5.0'
   dependency 'ollama-ruby'
+  dependency 'kramdown-ansi'
   dependency 'simplecov'
   dependency 'debug'
 

data/bin/code_comment

@@ -36,96 +36,53 @@ model    = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
 #methods             = call_sites.map { fetch_method(_1) } * ?\n
 
 cheatsheet = <<EOT
-# YARD CHEATSHEET http://yardoc.org
-
-## May 2020 - updated fork: https://gist.github.com/phansch/db18a595d2f5f1ef16646af72fe1fb0e
-
-cribbed from http://pastebin.com/xgzeAmBn
-
-Templates to remind you of the options and formatting for the different types of objects you might
-want to document using YARD.
-
-## Modules
-
-    # Namespace for classes and modules that handle serving documentation over HTTP
-
-## Classes
-
-    # Abstract base class for CLI utilities. Provides some helper methods for
-    # the option parser
-    #
-    # @author Full Name
-    # @abstract
-    # @attr [Types] attribute_name a full description of the attribute
-    # @attr_reader [Types] name description of a readonly attribute
-    # @attr_writer [Types] name description of writeonly attribute
-    # @deprecated Describe the reason or provide alt. references here
-
-## Methods
-
-    # An alias to {Parser::SourceParser}'s parsing method
-    #
-    # @author Donovan Bray
-    #
-    # @see http://example.com Description of URL
-    # @see SomeOtherClass#method
-    #
-    # @deprecated Use {#my_new_method} instead of this method because
-    #   it uses a library that is no longer supported in Ruby 1.9.
-    #   The new method accepts the same parameters.
-    #
-    # @abstract
-    # @private
-    #
-    # @param subject [String] The subject
-    # @param from [String] ('nobody') From address
-    # @param to [String] Recipient email
-    # @param body [String] ('') The email's body
-    #
-    # @param (see User#initialize)
-    # @param [OptionParser] opts the option parser object
-    # @param [Array<String>] args the arguments passed from input. This
-    #   array will be modified.
-    # @param [Array<String, Symbol>] list the list of strings and symbols.
-    #
-    # The options parsed out of the commandline.
-    # Default options are:
-    #   :format => :dot
-    #
-    # @example Reverse a string
-    #   "mystring.reverse" #=> "gnirtsym"
-    #
-    # @example Parse a glob of files
-    #   YARD.parse('lib/**/*.rb')
-    #
-    # @raise [ExceptionClass] description
-    #
-    # @return [optional, types, ...] description
-    # @return [true] always returns true
-    # @return [void]
-    # @return [String, nil] the contents of our object or nil
-    #   if the object has not been filled with data.
-    #
-    # We don't care about the "type" here:
-    # @return the object
-    #
-    # @return [String, #read] a string or object that responds to #read
-    # @return description here with no types
-
-## Anywhere
-
-    # @todo Add support for Jabberwocky service
-    #   There is an open source Jabberwocky library available
-    #   at http://somesite.com that can be integrated easily
-    #   into the project.
-
-## Blocks
-
-    # for block {|a, b, c| ... }
-    # @yield [a, b, c] Description of block
-    #
-    # @yieldparam [optional, types, ...] argname description
-    # @yieldreturn [optional, types, ...] description
+Documenting Code with YARD
+
+By default, YARD is compatible with the same RDoc syntax most Ruby developers
+are already familiar with. However, one of the biggest advantages of YARD is
+the extended meta-data syntax, commonly known as "tags", that you can use to
+express small bits of information in a structured and formal manner. While RDoc
+syntax expects you to describe your method in a completely free-form manner,
+YARD recommends declaring your parameters, return types, etc. with the @tag
+syntax, which makes outputting the documentation more consistent and easier to
+read. Consider the RDoc documentation for a method to_format:
+
+# Converts the object into textual markup given a specific `format`
+# (defaults to `:html`)
+#
+# == Parameters:
+# format::
+#   A Symbol declaring the format to convert the object to. This
+#   can be `:text` or `:html`.
+#
+# == Returns:
+# A string representing the object in a specified
+# format.
+#
+def to_format(format = :html)
+  # format the object
+end
+
+While this may seem easy enough to read and understand, it's hard for a machine
+to properly pull this data back out of our documentation. Also we've tied our
+markup to our content, and now our documentation becomes hard to maintain if we
+decide later to change our markup style (maybe we don't want the ":" suffix on
+our headers anymore).
+
+In YARD, we would simply define our method as:
+
+# Converts the object into textual markup given a specific format.
+#
+# @param format [Symbol] the format type, `:text` or `:html`
+# @return [String] the object converted into the expected format.
+# @raise [CannotFormatException] the object cannot be formatted
+def to_format(format = :html)
+  # format the object
+end
+
+Using tags we can add semantic metadata to our code without worrying about
+presentation. YARD will handle presentation for us when we decide to generate
+documentation later.
 EOT
 
 system = <<EOT

data/lib/utils/version.rb

@@ -1,6 +1,6 @@
 module Utils
   # Utils version
-  VERSION         = '0.59.2'
+  VERSION         = '0.60.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

@@ -10,8 +10,6 @@ module Utils
   require 'utils/probe_server'
   require 'utils/ssh_tunnel_specification'
   require 'utils/line_blamer'
-  require 'utils/markdown'
-  require 'utils/pager'
 
   require 'utils/xt/source_location_extension'
   class ::Object

data/utils.gemspec

@@ -1,19 +1,19 @@
 # -*- encoding: utf-8 -*-
-# stub: utils 0.59.2 ruby lib
+# stub: utils 0.60.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "utils".freeze
-  s.version = "0.59.2".freeze
+  s.version = "0.60.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-27"
+  s.date = "2024-10-31"
   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-md".freeze, "git-versions".freeze, "json_check".freeze, "long_lines".freeze, "md".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/markdown.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/pager.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-md".freeze, "bin/git-versions".freeze, "bin/json_check".freeze, "bin/long_lines".freeze, "bin/md".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/markdown.rb".freeze, "lib/utils/md5.rb".freeze, "lib/utils/pager.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.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.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]
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency(%q<search_ui>.freeze, ["~> 0.0".freeze])
   s.add_runtime_dependency(%q<all_images>.freeze, ["~> 0.5.0".freeze])
   s.add_runtime_dependency(%q<ollama-ruby>.freeze, [">= 0".freeze])
+  s.add_runtime_dependency(%q<kramdown-ansi>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<simplecov>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<debug>.freeze, [">= 0".freeze])
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utils
 version: !ruby/object:Gem::Version
-  version: 0.59.2
+  version: 0.60.0
 platform: ruby
 authors:
 - Florian Frank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -164,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -208,11 +222,9 @@ executables:
 - edit_wait
 - enum
 - git-empty
-- git-md
 - git-versions
 - json_check
 - long_lines
-- md
 - myex
 - number_files
 - on_change
@@ -242,9 +254,7 @@ extra_rdoc_files:
 - lib/utils/irb.rb
 - lib/utils/line_blamer.rb
 - lib/utils/line_formatter.rb
-- lib/utils/markdown.rb
 - lib/utils/md5.rb
-- lib/utils/pager.rb
 - lib/utils/patterns.rb
 - lib/utils/probe_server.rb
 - lib/utils/ssh_tunnel_specification.rb
@@ -270,11 +280,9 @@ files:
 - bin/edit_wait
 - bin/enum
 - bin/git-empty
-- bin/git-md
 - bin/git-versions
 - bin/json_check
 - bin/long_lines
-- bin/md
 - bin/myex
 - bin/number_files
 - bin/on_change
@@ -301,9 +309,7 @@ files:
 - lib/utils/irb.rb
 - lib/utils/line_blamer.rb
 - lib/utils/line_formatter.rb
-- lib/utils/markdown.rb
 - lib/utils/md5.rb
-- lib/utils/pager.rb
 - lib/utils/patterns.rb
 - lib/utils/probe_server.rb
 - lib/utils/ssh_tunnel_specification.rb

data/bin/git-md

@@ -1,51 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'utils/markdown'
-include Utils::Markdown
-require 'utils/pager'
-require 'term/ansicolor'
-include Term::ANSIColor
-require 'shellwords'
-
-cmd = %{git log --color=always --pretty=format:"commit %H%C(auto)%d%nDate:   %Cgreen%cD (%cr)%Creset%nAuthor: %Cblue%an <%ae>%Creset%n%nMARKUP%n%s%n%n%b%nMARKDOWN%n"}
-
-core_pager     = `git config get core.pager`.chomp.full?
-git_pager      = ENV['GIT_PAGER'].full?
-default_pager  = ENV['PAGER'].full?
-if fallback_pager = `which less`.chomp.full? || `which more`.chomp.full?
-  fallback_pager << ' -r'
-end
-my_pager = git_pager || core_pager || default_pager || fallback_pager
-
-repo_url = case git_origin_url = `git remote get-url origin`.chomp
-           when %r(\Ahttps://)
-             u = git_origin_url.sub(%r(\.git\z), '')
-             u << '/commit/'
-           when %r(\Agit@github.com:([^.]+))
-             "https://github.com/#$1/commit/"
-           end
-
-Utils::Pager.pager(command: my_pager) do |output|
-  IO.popen("#{cmd} #{Shellwords.join(ARGV)}") do |log|
-    until log.eof?
-      message = nil
-      log.each do |line|
-        case line
-        when /^MARKUP$/
-          message =  ''
-        when /^MARKDOWN$/
-          output.puts markdown(message + "\n---\n")
-          message = nil
-        else
-          if message
-            message << line
-          else
-            output.puts line.sub(/(?<=^commit )(\h{40})/) {
-              yellow { repo_url ? hyperlink(repo_url + $1) { $1 }  : $1 }
-            }
-          end
-        end
-      end
-    end
-  end
-end

data/bin/md

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'utils/markdown'
-include Utils::Markdown
-require 'utils/pager'
-
-rendered      = markdown(ARGF.read)
-default_pager = ENV['PAGER'].full?
-if fallback_pager = `which less`.chomp.full? || `which more`.chomp.full?
-  fallback_pager << ' -r'
-end
-my_pager = default_pager || fallback_pager
-
-Utils::Pager.pager(lines: rendered.count(?\n), command: my_pager) do |output|
-  output.puts rendered
-end

data/lib/utils/markdown.rb

@@ -1,11 +0,0 @@
-require 'ollama'
-
-module Utils
-  module Markdown
-    module_function
-
-    def markdown(message)
-      Ollama::Utils::ANSIMarkdown.parse(message)
-    end
-  end
-end

data/lib/utils/pager.rb

@@ -1,30 +0,0 @@
-require 'tins'
-
-module Utils
-  module Pager
-    module_function
-
-    def pager(command: nil, lines: nil, &block)
-      if block
-        if my_pager = pager(command:, lines:)
-          IO.popen(my_pager, 'w') do |output|
-            output.sync = true
-            yield output
-            output.close
-          end
-        else
-          yield STDOUT
-        end
-      else
-        return unless STDOUT.tty?
-        if lines
-          if lines >= Tins::Terminal.lines
-            pager(command:)
-          end
-        else
-          command
-        end
-      end
-    end
-  end
-end