cli_class_tool 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b709fe8b17a110ea17968fb9d7d4ff45e2ceac57bed76c3dcda67438880dcdc4
-  data.tar.gz: 1ff6831f0c5bfbc9d54d8dac31e18fdad3003ec0d527bfb3999e11a472b1591b
+  metadata.gz: bad275062a9f72ff201812eb6cd7871b9321b80b57f379f817cab483de42b738
+  data.tar.gz: e3cb70b12fe4831a4fdd194eaa4c67118efcfd9ffc0f1903524d74bdaf805e1a
 SHA512:
-  metadata.gz: f408128eb985f8ad45949c452be46aa55edc028f1dc060c2870afdbea358016258071e0cc8aadf155e867c0f8e7be4295e8045c699eb0f82c501feaeb9b7502b
-  data.tar.gz: 75d8bbfd502b9a331be9c57e25b7f824b2bf1d24c94f6fe477f64f2078dde1a76911b4964b0bdcf531098f895a753556778571f0a4354e1d2b733b1fedc56212
+  metadata.gz: 43cc9f0156398b92a5d1c7370c6c8c7dcf61d80e4ad9b18bec8a4a5bedceec7aa9e9af40e5d801554c7369aa746bac98c204ad949d2d27b381c4e14cbec93312
+  data.tar.gz: '0948e6f13057dd174140d84a7845c33a25e758a9ef018e10afb9c75bb734e87dffaf191e81091e01fe8c1dc9ff66437672364343d7ffc054f76cf0d591ebec1d'

data/CHANGELOG

@@ -1,7 +1,14 @@
 ------------------
-0.3.0  (2026-06-02)
+0.4.0  (2026-06-05)
 ------------------
 
+* Add basic initializer for Common
+* Add Common::run() that will auto spawn a Common object and run the command with it.
+* log function can now be used in alternate object or class by including/extending CLIClassTool::Logger
+
+------------------
+0.3.0  (2026-06-02)
+------------------
 
 * Enforce module/class namespaces for all action classes (potentially breaking change)
 * Support automatic project-specific `RunError` generation with customized base error inheritance

data/lib/cli_class_tool/common.rb

@@ -1,39 +1,9 @@
 # Main module for generic CLI class-based tools and utilities
 module CLIClassTool
 
-    # Common utility class providing logging, configuration, and shell execution methods
-    class Common
-        # Hook to enforce namespace loading at load time
-        def self.inherited(subclass)
-            if subclass.name
-                parts = subclass.name.to_s.split('::')
-                if parts.size <= 1
-                    raise "CLIClassTool action classes must be defined within a named module/class namespace"
-                end
-            end
-        end
-
-        # List of available actions for this class
-        ACTION_LIST = [ :list_actions ]
-        # Help text for actions
-        ACTION_HELP = {}
-
+    # Logger for CLIClassTool::Common
+    module Logger
         private
-        # Get the parent module of this class (e.g. KernelWork or XXX)
-        def parent_module
-            @parent_module ||= begin
-                if self.class.name.nil?
-                    Object
-                else
-                    parts = self.class.name.split('::')
-                    if parts.size <= 1
-                        raise "CLIClassTool action classes must be defined within a named module/class namespace"
-                    end
-                    Object.const_get(parts[0...-1].join('::'))
-                end
-            end
-        end
-
         # Internal log method
         # @param lvl [String] Log level string (colored)
         # @param str [String] Message
@@ -50,28 +20,33 @@ module CLIClassTool
             out.print("# " + lvl.to_s() + ": " + str + "\r")
         end
 
-        # Raise error if system command failed
-        # @param check_err [Boolean] Whether to check for errors
-        # @param sysret [Process::Status] System return status
-        # @param ret [String, nil] Optional return message
+        # Compute the parent module of an object or a class
+        #
+        # @param obj [Object,Class] Object or class to get the Module from
         # @raise [StandardError] If command failed
-        def abort_if_err(check_err, sysret, ret = nil)
-            if sysret.exitstatus != 0 && check_err == true
-                unless parent_module.const_defined?(:RunError)
-                    raise "CLIClassTool parent module #{parent_module} must extend CLIClassTool::Utils to define RunError"
+        def obj_to_parent_mod(obj)
+            return obj if obj.is_a?(Module)
+            theClass = obj.is_a?(Class) ? obj : obj.class
+            if theClass.name.nil?
+                return Object
+            else
+                parts = theClass.name.split('::')
+                if parts.size <= 1
+                    raise "CLIClassTool action classes must be defined within a named module/class namespace"
                 end
-                raise(parent_module::RunError.new(sysret.exitstatus, ret))
+                return Object.const_get(parts[0...-1].join('::'))
             end
         end
 
-        # Debug command execution
-        # @param cmd_type [String] Type of command (e.g., 'git')
-        # @param cmd [String] The command string
-        def cmd_debug(cmd_type, cmd)
-            log(:DEBUG, "Called from #{caller[1]}")
-            log(:DEBUG, "Running #{cmd_type} command '#{cmd}'")
+        # Get the parent module of this class (e.g. KernelWork or XXX)
+        def parent_module
+            return @parent_module if @parent_module != nil
+
+            @parent_module = obj_to_parent_mod(self)
+            return @parent_module
         end
-        protected
+
+        public
         # Log a message with a specific level
         #
         # @param lvl [Symbol] Log level (:DEBUG, :INFO, :WARNING, :ERROR, etc.)
@@ -121,8 +96,61 @@ module CLIClassTool
             end
             return rep
         end
+    end
+
+    # Common utility class providing logging, configuration, and shell execution methods
+    class Common
+        # Hook to enforce namespace loading at load time
+        def self.inherited(subclass)
+            if subclass.name
+                parts = subclass.name.to_s.split('::')
+                if parts.size <= 1
+                    raise "CLIClassTool action classes must be defined within a named module/class namespace"
+                end
+            end
+        end
+
+        # List of available actions for this class
+        ACTION_LIST = [ :list_actions ]
+        # Help text for actions
+        ACTION_HELP = {}
+
+        # Give the Logger mathods to Common
+        include CLIClassTool::Logger
+
+        private
+        # Raise error if system command failed
+        # @param check_err [Boolean] Whether to check for errors
+        # @param sysret [Process::Status] System return status
+        # @param ret [String, nil] Optional return message
+        # @raise [StandardError] If command failed
+        def abort_if_err(check_err, sysret, ret = nil)
+            if sysret.exitstatus != 0 && check_err == true
+                unless parent_module.const_defined?(:RunError)
+                    raise "CLIClassTool parent module #{parent_module} must extend CLIClassTool::Utils to define RunError"
+                end
+                raise(parent_module::RunError.new(sysret.exitstatus, ret))
+            end
+        end
+
+        # Debug command execution
+        # @param cmd_type [String] Type of command (e.g., 'git')
+        # @param cmd [String] The command string
+        def cmd_debug(cmd_type, cmd)
+            log(:DEBUG, "Called from #{caller[1]}")
+            log(:DEBUG, "Running #{cmd_type} command '#{cmd}'")
+        end
+
 
         public
+        # Simple initializer for a Common object
+        #
+        # @param path [String] Path to run commands from
+        def initialize(path=".", caller_obj=self)
+            @path = path
+            @parent_module = obj_to_parent_mod(caller_obj)
+        end
+
         # Run a shell command
         #
         # @param cmd [String] Command to run
@@ -136,6 +164,10 @@ module CLIClassTool
             return ret
         end
 
+        def self.run(path, cmd, check_err = true)
+            obj = Common.new(path, self)
+            return obj.run(cmd, check_err)
+        end
         # Run a shell command using system() (interactive)
         #
         # @param cmd [String] Command to run

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cli_class_tool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nicolas Morey
 bindir: bin
 cert_chain: []
-date: 2026-06-02 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake