cli-kit 5.3.0 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c406f8c2cf0b1c558c25cd0e6af9e4dd1de520f8a304e8762ee4e2086d72ab15
-  data.tar.gz: c916e638ee9dafd16b5ad646ba43ed1d226fe386488e1a0072a7b5f9107713f5
+  metadata.gz: a71589e7905e5dc0152e3f34baada5c16289f98af365aa7f4f795cc2fee3c3d1
+  data.tar.gz: 796526fbab7044920aa42f5d42ca86c6f17a28c9285c344fa210dda10f0e8397
 SHA512:
-  metadata.gz: c111015f730162b6ccf7f6f83d45782b27bdc044739cdc100146e08468acc4888ae363a9703f7c044b14e248a291f82d0c8f77cd7986bc2539f52d361b17356f
-  data.tar.gz: 9f8716992e5a263a8657a2e20035e679eb953cf790727283855804e6d433d5c53b412ec8f34b4fe5b09b6b82a98067ab76b32377c0108203d2c31d6f08143ca8
+  metadata.gz: 645d68f82d0147a7176b8a29d5d75f42848456528c06e3db2798823fc9cd732317f3935ddd5d4572e580d13186d6b17267d168f654ef57a19eaec5510074f64d
+  data.tar.gz: 5c9250e416b97184027b1742bfb88ee05873baf07d5d8bdfdcb6d5b24102eea0498914ee29ee3056a27dcb557879209c85c36f7c80ea53682b3b580cb887b773

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cli-kit (5.3.0)
+    cli-kit (5.3.1)
       cli-ui (~> 2.4)
       logger (~> 1.7)
 

data/lib/cli/kit/config.rb

@@ -14,11 +14,9 @@ module CLI
       # pointing into +/nix/store+).
       #
       # Inherits from SystemCallError so existing `rescue SystemCallError`
-      # handlers around +Config#set+ continue to match. The message contains
-      # only the keys that actually changed; unchanged keys (which may
-      # include sensitive values such as API tokens) are intentionally
-      # excluded so the failure message can never leak secrets through
-      # stderr or exception reports.
+      # handlers around +Config#set+ continue to match. Diagnostics contain
+      # only changed section/key names, never their values. Config contents
+      # are not retained on the exception, to keep them out of error reports.
       class ConfigWriteError < SystemCallError
         class << self
           # Ruby's +SystemCallError.===+ uses errno-based matching,
@@ -41,10 +39,10 @@ module CLI
           # checkers and callers see the real signature, and allocate
           # the instance manually to bypass +SystemCallError+'s
           # factory behaviour.
-          #: (String config_path, String old_content, String new_content, SystemCallError cause) -> ConfigWriteError
-          def new(config_path, old_content, new_content, cause)
+          #: (String config_path, Hash[String, Hash[String, String]] old_config, Hash[String, Hash[String, String]] new_config, SystemCallError cause) -> ConfigWriteError
+          def new(config_path, old_config, new_config, cause)
             instance = allocate
-            instance.__send__(:initialize, config_path, old_content, new_content, cause)
+            instance.__send__(:initialize, config_path, old_config, new_config, cause)
             instance
           end
         end
@@ -53,10 +51,7 @@ module CLI
         attr_reader :config_path
 
         #: String
-        attr_reader :old_content
-
-        #: String
-        attr_reader :new_content
+        attr_reader :diff
 
         # rubocop:disable Lint/MissingSuper
         # +SystemCallError#initialize+ has a factory-style signature that
@@ -65,16 +60,15 @@ module CLI
         # initialize via Exception so we just get a message-only
         # exception that +rescue SystemCallError+ still catches via
         # inheritance. +super+ would not work here.
-        #: (String config_path, String old_content, String new_content, SystemCallError cause) -> void
-        def initialize(config_path, old_content, new_content, cause)
+        #: (String config_path, Hash[String, Hash[String, String]] old_config, Hash[String, Hash[String, String]] new_config, SystemCallError cause) -> void
+        def initialize(config_path, old_config, new_config, cause)
           @config_path = config_path
-          @old_content = old_content
-          @new_content = new_content
+          @diff = build_diff(old_config, new_config)
           @wrapped_errno = cause.errno
           message = <<~MSG.rstrip
             Could not write to #{config_path}: #{cause.message}
 
-            Attempted changes (unchanged keys omitted):
+            Attempted changes (values and unchanged keys omitted):
             #{diff}
           MSG
           Exception.instance_method(:initialize).bind(self).call(message)
@@ -88,19 +82,14 @@ module CLI
           @wrapped_errno
         end
 
-        # A line-by-line diff of only the sections/keys that changed
-        # between +old_content+ and +new_content+. Unchanged keys are
-        # omitted so that sensitive values stored elsewhere in the config
-        # are never included in the failure message.
-        #: -> String
-        def diff
-          old_ini = CLI::Kit::Ini.new(config: @old_content).tap(&:parse).ini
-          new_ini = CLI::Kit::Ini.new(config: @new_content).tap(&:parse).ini
+        private
 
+        #: (Hash[String, Hash[String, String]] old_config, Hash[String, Hash[String, String]] new_config) -> String
+        def build_diff(old_config, new_config)
           lines = []
-          (old_ini.keys | new_ini.keys).each do |section|
-            old_section = old_ini[section] || {}
-            new_section = new_ini[section] || {}
+          (old_config.keys | new_config.keys).each do |section|
+            old_section = old_config[section] || {}
+            new_section = new_config[section] || {}
 
             changes = []
             (old_section.keys | new_section.keys).each do |key|
@@ -108,8 +97,8 @@ module CLI
               new_val = new_section[key]
               next if old_val == new_val
 
-              changes << "- #{key} = #{old_val}" if old_val
-              changes << "+ #{key} = #{new_val}" if new_val
+              changes << "- #{key}" if old_val
+              changes << "+ #{key}" if new_val
             end
             next if changes.empty?
 
@@ -270,8 +259,8 @@ module CLI
           # for nix/home-manager configs that live in +/nix/store+. Wrap
           # it the same way as +EACCES+/+EPERM+ so callers always see
           # the diff and any +rescue ConfigWriteError+ handler matches.
-          old_content = read_config_for_diff(config_path)
-          raise(ConfigWriteError.new(config_path, old_content, new_content, e))
+          old_config = read_config_for_diff(config_path)
+          raise(ConfigWriteError.new(config_path, old_config, all_configs, e))
         end
       end
 
@@ -285,17 +274,14 @@ module CLI
         begin
           tmpfile.write(new_content)
           tmpfile.close
-          # Tempfile defaults to 0o600. Match the permissions a plain
-          # +File.write+ would have produced: preserve the existing
-          # mode when the config is being updated, and use the
-          # umask-adjusted default (matching +open(2)+ for new files)
-          # otherwise. This avoids silently tightening permissions on
-          # an existing config and avoids creating new configs with
-          # the more restrictive Tempfile default.
+          # Configs may contain credentials. Keep them private to the
+          # owner, including when replacing a previously shared file.
+          # Preserve stricter owner permissions on existing files and
+          # respect the umask when creating new ones.
           mode = if File.exist?(config_path)
-            File.stat(config_path).mode
+            File.stat(config_path).mode & 0o600
           else
-            0o666 & ~File.umask
+            0o600 & ~File.umask
           end
           File.chmod(mode, tmpfile_path)
           File.rename(tmpfile_path, config_path)
@@ -306,11 +292,11 @@ module CLI
         end
       end
 
-      #: (String config_path) -> String
+      #: (String config_path) -> Hash[String, Hash[String, String]]
       def read_config_for_diff(config_path)
-        File.read(config_path)
+        CLI::Kit::Ini.new(config: File.read(config_path)).tap(&:parse).ini
       rescue SystemCallError
-        ''
+        {}
       end
 
       # Resolve +config_path+ through any symlinks so the atomic rename

data/lib/cli/kit/core_ext.rb

@@ -17,6 +17,7 @@ class Exception
     def to_s = raise NotImplementedError, 'abstract method called'
 
     # A bug in the tool itself (dev, tec, cli-kit, etc.).
+    # @sealed
     class System < Fault
       # @override
       #: -> String

data/lib/cli/kit/version.rb

@@ -2,6 +2,6 @@
 
 module CLI
   module Kit
-    VERSION = '5.3.0'
+    VERSION = '5.3.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cli-kit
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.3.1
 platform: ruby
 authors:
 - Burke Libbey