cinnabar 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ba73ee68ae237057d44f55990de599fae1290bdb0ad22ed9f4a3cc6688e8a9c
-  data.tar.gz: 0ca77910329aa2c50e2ee0f6562ae1873ab31db0926dedc856aafeb9e1b98c03
+  metadata.gz: 0d07b1f0ca422a414fa67b7017920940bd12eadfe4f2d104de088e6ce67c9def
+  data.tar.gz: a2065bf84722d56727ce1d12602ef3d498d0026ba420f3e213ce5b9d24fdd558
 SHA512:
-  metadata.gz: 9123046f853c2533f6adbab221418066af5c351b283c346e31937ecd7a8010b897860cb3fb1365386d3d6abfdf7e822e405aa79ab63420fd1553cb5605f08b9f
-  data.tar.gz: 54b6ac22db5f6b5bb7287329d9b74876f03a8e76738968276cdd45b6d2ce22281b084c203ae93e66615bead81a2ce94cebbfdfd518c84956017a6f3a3e51949b
+  metadata.gz: ca95b7d444e89dd2c169d16b1255779c482dd4ed36bda09f7050a2d6c99f1049e27e52c660b4a2c35f0045b0c668a2954f7b982006257f3f74dcdb0a71a9d03c
+  data.tar.gz: 7da5135f3602cf662ea4bbc53e86cada66dc5d5601223600beaf53ac56d05262d7bb518a18cbfa2c22fc9128184032882c885e2906c438c3a7c7a00de8c3a69f

data/docs/ChangeLog.md

@@ -0,0 +1,5 @@
+# ChangeLog
+
+## v0.0.2 (2026-01-05)
+
+- fix ruby v4.0.0 compatibility

data/docs/Readme.md

@@ -40,7 +40,7 @@ env:
   RUBYOPT: "--disable=gems"
   default_ci_shell: ruby cinnabar/ci.rb {0}
   # optional values: debug, info, warn, error, fatal, unknown
-  RUBY_LOG: "debug"
+  RUBY_LOG: debug
 
 jobs:
   build:
@@ -56,7 +56,7 @@ jobs:
         with:
           repository: 2moe/cinnabar
           path: cinnabar
-          ref: v0.0.1
+          ref: v0.0.2
 
       - name: (example) run cargo command
         run: |
@@ -85,7 +85,7 @@ jobs:
     stdout.to_i == 5 #=> true
 ```
 
-#### `.async_run`
+#### `.async_run` + log
 
 ```ruby,yaml
 - run: |
@@ -98,6 +98,10 @@ jobs:
     } .to_argv
       .async_run
 
+    # log_dbg, log_info, log_warn, log_err, log_fatal, log_unk
+    "You can now do other things without waiting for
+    the process to complete.".log_dbg
+
     stdout, status = task.wait_with_output
     stdout.log_info
     raise "wasi" unless status.success?
@@ -117,7 +121,7 @@ jobs:
     # opts = { stdin_data:, stdin_binmode: false }
     opts = { stdin_data: }
 
-    accel = %w[kvm hvf tcg].join ':'
+    accel = %w[kvm hvf whpx].join ':'
     task = {
       'qemu-system-x86_64': (),
       machine: "accel=#{accel}",

data/lib/cinnabar/00_pre.rb

@@ -7,9 +7,8 @@
 # @see https://github.com/2moe/cinnabar
 module Cinnabar; end
 
+require 'pathname'
+
 # To ensure compatibility with "--disable=gems" (allowing users to pre-require),
 # add conditional checks before requiring these libraries.
 require 'sinlog' unless defined? Sinlog::VERSION
-# require 'argvise' unless defined? Argvise::VERSION
-
-require 'pathname'

data/lib/cinnabar/path.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+# NOTE: This file can be run independently;
+#   Although **00_pre.rb** has already imported the relevant libraries, they still need to be imported here.
+require 'pathname'
+
+module Cinnabar
+  # Build a Proc that converts a directory-like value into a {Kernel.Pathname}.
+  #
+  # This is handy when you want to pass a converter into higher-order APIs
+  # (e.g., map/filter pipelines).
+  #
+  # @param dir [String, #to_s] a directory path (or any object convertible to String)
+  # @return [Proc] a lambda that maps `dir` to `Pathname(dir)`
+  #
+  # @example Convert a list of directories to Pathname objects
+  #
+  #     conv = Cinnabar.to_path_proc
+  #     %w[/tmp /var].map(&conv)
+  #     #=> [#<Pathname:/tmp>, #<Pathname:/var>]
+  def self.to_path_proc = ->(dir) { Pathname(dir) }
+end
+
+# Adds `String#to_path` as a convenience helper to convert strings into {Kernel.Pathname}.
+#
+# This module supports two integration styles:
+#
+# - {Cinnabar::StrToPath::Mixin}: globally extends {String} (monkey patch).
+# - {Cinnabar::StrToPath::Refin}: lexically-scoped extension via refinements.
+#
+# @note This feature relies on Ruby's {Pathname} class.
+#   Make sure `require "pathname"` is loaded before calling `to_path`.
+module Cinnabar::StrToPath
+  # Implementation of the `#to_path` method intended to be mixed into {String}.
+  module Ext
+    # Convert the receiver (a String) into a {Pathname}.
+    #
+    # @return [Pathname] `Pathname(self)`
+    #
+    # @example
+    #
+    #     "lib".to_path
+    #     #=> #<Pathname:lib>
+    def to_path = ::Kernel.Pathname(self)
+  end
+
+  # This is a "mixin switch": `include Cinnabar::StrToPath::Mixin` will modify
+  # {::String} for the entire process (i.e., a monkey patch).
+  #
+  # @note Side effect: this will affect *all* strings in the process, including
+  #   third-party code. If you want scoped behavior, prefer {Refin}.
+  #
+  # @example
+  #
+  #     include Cinnabar::StrToPath::Mixin
+  #
+  #     __dir__.to_path
+  #     # Same as `Pathname(__dir__)`
+  module Mixin
+    # Hook invoked when this module is included.
+    #
+    # @param _host [Module] the including host (unused)
+    # @return [void]
+    def self.included(_host) = ::String.include Ext
+  end
+
+  # Adds `String#to_path` via Ruby refinements (lexically scoped).
+  #
+  # This avoids global monkey patches. The method is only visible within scopes
+  # where `using Cinnabar::StrToPath::Refin` is active.
+  #
+  # @example
+  #
+  #     using Cinnabar::StrToPath::Refin
+  #
+  #     __dir__.to_path
+  #     # Same as `Pathname(__dir__)`
+  module Refin
+    # Refinement for {String} to import {Ext#to_path}.
+    refine ::String do
+      import_methods Ext
+    end
+  end
+end
+
+module Cinnabar::Path
+  module_function
+
+  # Appends a directory to Ruby's load path (`$LOAD_PATH` / `$:`)
+  # if it is not already included.
+  #
+  # @param dir [String] directory path to add into `$LOAD_PATH`
+  # @return [void]
+  # @example
+  #
+  #     Cinnabar::Path.append_load_path '/opt/ruby/4.0.0/lib/ruby/4.0.0'
+  def append_load_path(dir)
+    # $: is an alias of $LOAD_PATH
+    $: << dir unless $:.include?(dir)
+  end
+
+  # Finds the gem's "lib directory" (via `gem which -V`) and append it to $LOAD_PATH.
+  #
+  # This method maintains a small cache file to avoid running `gem which` repeatedly.
+  # Cache format (per line):
+  #   <gem_name><two spaces><lib_dir>
+  #
+  # If the gem cannot be located, it will try to install it and retry up to `max_retries`.
+  #
+  # @param gem_name [String, Symbol] gem name to locate (default: 'logger')
+  # @param cache_file [String] cache file path (default: 'tmp/load_path.txt')
+  # @param max_retries [Integer] maximum retries for gem install + re-check (default: 2)
+  # @return [void]
+  def find_and_append_load_path(gem_name = 'logger', cache_file: 'tmp/load_path.txt', max_retries: 2)
+    pkg = gem_name.to_s
+    cache_data = decode_cache_file(cache_file)
+
+    # If cached, append immediately and return.
+    case val = cache_data&.[](pkg)
+      when nil then ()
+      else return append_load_path(val)
+    end
+
+    # Locate the gem's lib directory, installing the gem if necessary.
+    lib_dir = gem_dir_with_retry(pkg, max_retries)
+
+    # Update cache and write it back to disk.
+    cache_data[pkg] = lib_dir
+    encoded = encode_cache_hash(cache_data)
+
+    # Ensure parent directory exists, then write the cache file.
+    Kernel.Pathname(cache_file)
+      .tap { _1.dirname.mkpath }
+      .write(encoded)
+
+    # Finally, append the located directory to $LOAD_PATH.
+    append_load_path(lib_dir)
+  end
+
+  # Decodes cache file into a Hash.
+  #
+  # It ignores:
+  #
+  # - leading spaces (lstrip)
+  # - empty lines
+  # - comment lines that start with '#'
+  #
+  # Each line is split by "two spaces" into:
+  #   `key  value`
+  #
+  # @param file [String] cache file path
+  # @return [Hash{String => String}] mapping from gem name to lib dir
+  def decode_cache_file(file)
+    # If cache file does not exist, treat as empty cache.
+    return {} unless File.exist?(file)
+
+    File.foreach(file)
+      .lazy
+      .map(&:lstrip)                  # allow indentation; normalize leading spaces
+      .map(&:chomp)                   # remove trailing newline
+      .reject(&:empty?)               # drop blank lines
+      .reject { _1.start_with? '#' }  # drop comments
+      .map { |line| line.split('  ', 2) } # split into [key, value] by two spaces
+      .to_h
+  end
+
+  # Encodes a Hash into the cache file format.
+  #
+  # @param data [Hash] mapping from gem name to lib dir
+  # @return [String] encoded cache content
+  # @raise [ArgumentError] if `data` is not a Hash
+  #
+  # @example
+  #
+  #     CiPath = Cinnabar::Path
+  #
+  #     gem_home = "#{Dir.home}/.local/share/gem"
+  #     data = {
+  #       "logger" => "#{gem_home}/gems/logger-1.7.0/lib",
+  #       "irb" => "#{gem_home}/gems/irb-1.16.0/lib",
+  #       "reline" => "#{gem_home}/gems/reline-0.6.3/lib",
+  #     }
+  #     str = CiPath.encode_cache_hash(data)
+  def encode_cache_hash(data)
+    Kernel.raise ArgumentError, 'data must be a hash' unless data.is_a? ::Hash
+
+    # Use "two spaces" as a stable delimiter (same as decode).
+    data.map { |k, v| "#{k}  #{v}" }.join("\n")
+  end
+
+  # Resolves gem's lib directory by invoking:
+  #     `gem which -V <pkg>`
+  #
+  # `gem which -V` prints the resolved file path; we strip it and take its dirname.
+  #
+  # @param pkg [String] gem name
+  # @return [String] directory containing the resolved file
+  # @raise [RuntimeError] if gem which returns empty
+  #
+  # @note Please do not use `Gem::Specification` in this method,
+  # as this function and the script must remain compatible with `--disable=gems`.
+  def gem_dir(pkg)
+    path = IO.popen(%w[gem which -V] << pkg.to_s, &:read).to_s.strip
+    Kernel.raise "gem which returned empty for #{pkg}" if path.empty?
+
+    File.dirname(path)
+  end
+  private_class_method :gem_dir
+
+  # Locates the lib directory for the given gem_name; if it fails, retries by installing the gem.
+  #
+  # Behavior:
+  #
+  # - If `gem_dir` raises, print a warning and run `gem install <pkg>`.
+  # - Retry up to `max_retries`.
+  #
+  # @param gem_name [String, Symbol] gem name
+  # @param max_retries [Integer] max retry count (default: 2)
+  # @return [String] resolved lib directory
+  # @raise [RuntimeError] when install fails or retries exceed max
+  #
+  #
+  # @example
+  #
+  #     CiPath = Cinnabar::Path
+  #
+  #     dir_str = CiPath.gem_dir_with_retry("logger")
+  def gem_dir_with_retry(gem_name, max_retries = 2)
+    pkg = gem_name.to_s
+    attempts = 0
+
+    begin
+      logger_dir = gem_dir(pkg)
+    rescue StandardError => e
+      # Inform user about the failure and the planned automatic install attempt.
+      #
+      # Do not use `Sinlog.warn` or any "advanced" logger here!
+      # As this function is intended for lower-level APIs.
+      Kernel.warn "[WARN] #{e}; Try installing #{pkg}"
+
+      # Attempt to install; raise if installation fails.
+      Kernel.system "gem install #{pkg}" or Kernel.raise 'Failed to install'
+
+      attempts += 1
+      Kernel.raise 'Already retried 3 times' if attempts > max_retries
+
+      retry
+    end
+
+    logger_dir
+  end
+  # private_class_method :gem_dir_with_retry
+end

data/lib/cinnabar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cinnabar
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/cinnabar.rb

@@ -6,5 +6,6 @@
 require_relative 'cinnabar/00_pre'
 require_relative 'cinnabar/cmd_runner'
 require_relative 'cinnabar/net'
+require_relative 'cinnabar/path'
 require_relative 'cinnabar/pipe'
 require_relative 'cinnabar/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinnabar
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - 2moe
@@ -31,12 +31,14 @@ files:
 - ".rubocop.yml"
 - ".yardopts"
 - License
+- docs/ChangeLog.md
 - docs/Readme-zh.md
 - docs/Readme.md
 - lib/cinnabar.rb
 - lib/cinnabar/00_pre.rb
 - lib/cinnabar/cmd_runner.rb
 - lib/cinnabar/net.rb
+- lib/cinnabar/path.rb
 - lib/cinnabar/pipe.rb
 - lib/cinnabar/version.rb
 homepage: https://github.com/2moe/cinnabar
@@ -44,6 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://github.com/2moe/cinnabar
+  documentation_uri: https://2moe.github.io/cinnabar
 rdoc_options: []
 require_paths:
 - lib
@@ -58,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: CI Utils
 test_files: []