cmdx 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed549d510aee08ccdb114f75b51b7aefe1a9776905f53e75ec5c39477932350
-  data.tar.gz: b57596b1393185082d94616f8c08494d030a2d78bb85610674363a365efa15f5
+  metadata.gz: 198e34bfa10cf9b640e3a768e335e3901063e2cde3817be7c63fb710b322acc6
+  data.tar.gz: 59f99b87b1c2cc5fff64e2092f3f5ef5230a43d11de6f27c6609802627509164
 SHA512:
-  metadata.gz: 7d123c5a08fc89494b759eddea90e614858e55db733a3690e899de46b5e6e93e574a9bf2d9899f4f9c9c118686d5ff2f84cfd75b110ce242b79d7627ae3dfbd8
-  data.tar.gz: 17e336e03307f3dddaf7dba53d4a201f031f54348bc0e43059a17ace90cf7f4a762ad6e97ec731b32d1064616c978948867e8aa746ff96f52e93996376828a7c
+  metadata.gz: e60556e4f9af0a9af56d748a1084d95e5fecbe5316268d1d2f1414e5d4c323be81a7c56066bf19edf121eab3fb48080d6b5b3470086ee96241008eb28df9a152
+  data.tar.gz: cc37a5a0029f708f624e449b0526060e203b649d282f33f69551c641ae06f34a3d53886b346b8e48b68f6dbaff23654171d34e58e7d854429c58f0c3d90c62af

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
-## [0.1.0] - 2025-03-07
+## [0.2.0] - 2025-03-12
+### Added
+- Add `PrettyJson` log formatter
+- Add `PrettyKeyValue` log formatter
+- Add `PrettyLine` log formatter
+### Changed
+- Make `PrettyLine` the default log formatter
+- Rename `MethodName` util to `NameAffix`
+- Rename `DatetimeFormatter` util to `LogTimestamp`
+- Rename `Runtime` util to `MonotonicRuntime`
+- Fix logging non hash values from raising an error
+- Fix bubbling of faults with nested halted calls
+- Wrap result logger in a `Logger#with_logger` block
 
+## [0.1.0] - 2025-03-07
+### Added
 - Initial release

data/README.md

@@ -2,8 +2,8 @@
 
 [![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)
 
-[![Gem Version](https://badge.fury.io/rb/cmdx.svg)](https://badge.fury.io/rb/cmdx)
-[![CI](https://github.com/drexed/cmdx/actions/workflows/ruby.yml/badge.svg)](https://github.com/drexed/cmdx/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/cmdx.svg?icon=si%3Arubygems)](https://badge.fury.io/rb/cmdx)
+[![CI](https://github.com/drexed/cmdx/actions/workflows/ci.yml/badge.svg)](https://github.com/drexed/cmdx/actions/workflows/ci.yml)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)
 
 `CMDx` is a framework for expressive processing of business logic. Design

data/docs/logging.md

@@ -5,7 +5,9 @@ tasks executing concurrently so `CMDx` uses a custom logger to make debugging ea
 
 ## Output
 
-Built-in log formatters are: `Line` (default), `Json`, `KeyValue`, `Logstash`, `Raw`
+Built-in log formatters are:
+- Standard: `Line`, `Json`, `KeyValue`, `Logstash`, `Raw`
+- Stylized: `PrettyLine` (default), `PrettyJson`, `PrettyKeyValue`
 
 #### Success:
 ```txt

data/lib/cmdx/configuration.rb

@@ -14,7 +14,7 @@ module CMDx
 
   def reset_configuration!
     @configuration = LazyStruct.new(
-      logger: ::Logger.new($stdout, formatter: CMDx::LogFormatters::Line.new),
+      logger: ::Logger.new($stdout, formatter: CMDx::LogFormatters::PrettyLine.new),
       task_halt: CMDx::Result::FAILED,
       task_timeout: nil,
       batch_halt: CMDx::Result::FAILED,

data/lib/cmdx/core_ext/module.rb

@@ -6,7 +6,7 @@ module CMDx
 
       def __cmdx_attr_delegator(*methods, **options)
         methods.each do |method|
-          method_name = Utils::MethodName.call(method, options.fetch(:to), options)
+          method_name = Utils::NameAffix.call(method, options.fetch(:to), options)
 
           define_method(method_name) do |*args, **kwargs, &block|
             object = (options[:to] == :class ? self.class : send(options[:to]))

data/lib/cmdx/log_formatters/json.rb

@@ -5,7 +5,8 @@ module CMDx
     class Json
 
       def call(_severity, _time, _progname, message)
-        JSON.dump(message)
+        message = message.to_h if message.is_a?(Result)
+        JSON.dump(message) << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/key_value.rb

@@ -5,7 +5,13 @@ module CMDx
     class KeyValue
 
       def call(_severity, _time, _progname, message)
-        message.map { |k, v| "#{k}=#{v}" }.join(" ")
+        if message.is_a?(Result)
+          message = message.to_h.map do |k, v|
+            "#{k}=#{v}"
+          end.join(" ")
+        end
+
+        message << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/line.rb

@@ -5,8 +5,10 @@ module CMDx
     class Line
 
       def call(severity, time, progname, message)
-        message = message.map { |k, v| "#{k}=#{v}" }.join(" ")
-        "#{severity[0]}, [#{Utils::DatetimeFormatter.call(time.utc)} ##{Process.pid}] #{severity} -- #{progname || 'CMDx'}: #{message}"
+        timestamp = Utils::LogTimestamp.call(time.utc)
+        message   = KeyValue.new.call(severity, time, progname, message).chomp
+
+        "#{severity[0]}, [#{timestamp} ##{Process.pid}] #{severity} -- #{progname || 'CMDx'}: #{message}\n"
       end
 
     end

data/lib/cmdx/log_formatters/logstash.rb

@@ -5,12 +5,14 @@ module CMDx
     class Logstash
 
       def call(_severity, time, _progname, message)
+        message = message.to_h if message.is_a?(Result)
+
         if message.is_a?(Hash)
           message["@version"]   ||= "1"
-          message["@timestamp"] ||= Utils::DatetimeFormatter.call(time.utc)
+          message["@timestamp"] ||= Utils::LogTimestamp.call(time.utc)
         end
 
-        JSON.dump(message)
+        JSON.dump(message) << "\n"
       end
 
     end

data/lib/cmdx/log_formatters/pretty_json.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module CMDx
+  module LogFormatters
+    class PrettyJson
+
+      def call(_severity, _time, _progname, message)
+        message = message.to_h if message.is_a?(Result)
+        JSON.pretty_generate(message) << "\n"
+      end
+
+    end
+  end
+end

data/lib/cmdx/log_formatters/pretty_key_value.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module CMDx
+  module LogFormatters
+    class PrettyKeyValue
+
+      COLORED_KEYS = %i[
+        state status outcome
+      ].freeze
+
+      def call(_severity, _time, _progname, message)
+        if message.is_a?(Result)
+          message = message.to_h.map do |k, v|
+            v = ResultAnsi.call(v) if COLORED_KEYS.include?(k)
+            "#{k}=#{v}"
+          end.join(" ")
+        end
+
+        message << "\n"
+      end
+
+    end
+  end
+end

data/lib/cmdx/log_formatters/pretty_line.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module CMDx
+  module LogFormatters
+    class PrettyLine
+
+      def call(severity, time, progname, message)
+        indicator = LoggerAnsi.call(severity[0])
+        severity  = LoggerAnsi.call(severity)
+        timestamp = Utils::LogTimestamp.call(time.utc)
+        message   = PrettyKeyValue.new.call(severity, time, progname, message).chomp
+
+        "#{indicator}, [#{timestamp} ##{Process.pid}] #{severity} -- #{progname || 'CMDx'}: #{message}\n"
+      end
+
+    end
+  end
+end

data/lib/cmdx/log_formatters/raw.rb

@@ -5,7 +5,7 @@ module CMDx
     class Raw
 
       def call(_severity, _time, _progname, message)
-        message
+        message.inspect << "\n"
       end
 
     end

data/lib/cmdx/logger_ansi.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module CMDx
+  module LoggerAnsi
+
+    SEVERITY_COLOR_CODES = {
+      "D" => 34, # DEBUG - Blue
+      "I" => 32, # INFO  - Green
+      "W" => 33, # WARN  - Yellow
+      "E" => 31, # ERROR - Red
+      "F" => 35  # FATAL - Magenta
+    }.freeze
+
+    module_function
+
+    def call(s)
+      c = SEVERITY_COLOR_CODES[s[0]] || 39 # Default
+      "\e[1;#{c}m#{s}\e[0m"
+    end
+
+  end
+end

data/lib/cmdx/parameter.rb

@@ -60,7 +60,7 @@ module CMDx
     end
 
     def method_name
-      @method_name ||= Utils::MethodName.call(name, method_source, options)
+      @method_name ||= Utils::NameAffix.call(name, method_source, options)
     end
 
     def method_source

data/lib/cmdx/result.rb

@@ -103,11 +103,13 @@ module CMDx
       raise Fault.build(self)
     end
 
-    def throw!(result)
+    def throw!(result, local_metadata = {})
       raise ArgumentError, "must be a Result" unless result.is_a?(Result)
 
-      skip!(**result.metadata) if result.skipped?
-      fail!(**result.metadata) if result.failed?
+      md = result.metadata.merge(local_metadata)
+
+      skip!(**md) if result.skipped?
+      fail!(**md) if result.failed?
     end
 
     def caused_failure
@@ -154,7 +156,7 @@ module CMDx
       timeout_secs = task.task_setting(timeout_type)
 
       Timeout.timeout(timeout_secs, TimeoutError, "execution exceeded #{timeout_secs} seconds") do
-        @runtime = Utils::Runtime.call(&block)
+        @runtime = Utils::MonotonicRuntime.call(&block)
       end
     end
 

data/lib/cmdx/result_ansi.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module CMDx
+  module ResultAnsi
+
+    STATE_COLOR_CODES = {
+      Result::INITIALIZED => 34, # Blue
+      Result::EXECUTING => 33,   # Yellow
+      Result::COMPLETE => 32,    # Green
+      Result::INTERRUPTED => 31  # Red
+    }.freeze
+    STATUS_COLOR_CODES = {
+      Result::SUCCESS => 32, # Green
+      Result::SKIPPED => 33, # Yellow
+      Result::FAILED => 31   # Red
+    }.freeze
+
+    module_function
+
+    def call(s)
+      c = STATE_COLOR_CODES[s] || STATUS_COLOR_CODES[s] || 39 # Default
+      "\e[1;#{c}m#{s}\e[0m"
+    end
+
+  end
+end

data/lib/cmdx/result_logger.rb

@@ -3,7 +3,7 @@
 module CMDx
   module ResultLogger
 
-    STATUS_TO_LEVEL = {
+    STATUS_TO_SEVERITY = {
       Result::SUCCESS => :info,
       Result::SKIPPED => :warn,
       Result::FAILED => :error
@@ -12,10 +12,12 @@ module CMDx
     module_function
 
     def call(result)
-      logger = result.task.send(:logger)
-      status = STATUS_TO_LEVEL[result.status]
+      logger   = result.task.send(:logger)
+      severity = STATUS_TO_SEVERITY[result.status]
 
-      logger.send(status) { result.to_h }
+      logger.with_level(severity) do
+        logger.send(severity) { result }
+      end
     end
 
   end

data/lib/cmdx/task.rb

@@ -121,8 +121,10 @@ module CMDx
         call
       rescue UndefinedCallError => e
         raise(e)
+      rescue Fault => e
+        throw!(e.result, original_exception: e) if Array(task_setting(:task_halt)).include?(e.result.status)
       rescue StandardError => e
-        result.fail!(reason: "[#{e.class}] #{e.message}", original_exception: e) unless e.is_a?(Fault)
+        fail!(reason: "[#{e.class}] #{e.message}", original_exception: e)
       ensure
         after_call
       end

data/lib/cmdx/utils/{datetime_formatter.rb → log_timestamp.rb}

@@ -2,7 +2,7 @@
 
 module CMDx
   module Utils
-    module DatetimeFormatter
+    module LogTimestamp
 
       DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N"
 

data/lib/cmdx/utils/{runtime.rb → monotonic_runtime.rb}

@@ -2,7 +2,7 @@
 
 module CMDx
   module Utils
-    module Runtime
+    module MonotonicRuntime
 
       module_function
 

data/lib/cmdx/utils/{method_name.rb → name_affix.rb}

@@ -2,9 +2,9 @@
 
 module CMDx
   module Utils
-    module MethodName
+    module NameAffix
 
-      ROOTFIX = proc do |o, &block|
+      AFFIX = proc do |o, &block|
         o == true ? block.call : o
       end.freeze
 
@@ -12,8 +12,8 @@ module CMDx
 
       def call(method_name, source, options = {})
         options[:as] || begin
-          prefix = ROOTFIX.call(options[:prefix]) { "#{source}_" }
-          suffix = ROOTFIX.call(options[:suffix]) { "_#{source}" }
+          prefix = AFFIX.call(options[:prefix]) { "#{source}_" }
+          suffix = AFFIX.call(options[:suffix]) { "_#{source}" }
 
           "#{prefix}#{method_name}#{suffix}".strip.to_sym
         end

data/lib/cmdx/version.rb

@@ -2,6 +2,6 @@
 
 module CMDx
 
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 
 end

data/lib/cmdx.rb

@@ -18,6 +18,9 @@ require_relative "cmdx/log_formatters/key_value"
 require_relative "cmdx/log_formatters/line"
 require_relative "cmdx/log_formatters/logstash"
 require_relative "cmdx/log_formatters/raw"
+require_relative "cmdx/log_formatters/pretty_json"
+require_relative "cmdx/log_formatters/pretty_key_value"
+require_relative "cmdx/log_formatters/pretty_line"
 require_relative "cmdx/coercions/array"
 require_relative "cmdx/coercions/big_decimal"
 require_relative "cmdx/coercions/boolean"
@@ -38,13 +41,14 @@ require_relative "cmdx/validators/inclusion"
 require_relative "cmdx/validators/length"
 require_relative "cmdx/validators/numeric"
 require_relative "cmdx/validators/presence"
-require_relative "cmdx/utils/datetime_formatter"
-require_relative "cmdx/utils/method_name"
-require_relative "cmdx/utils/runtime"
+require_relative "cmdx/utils/log_timestamp"
+require_relative "cmdx/utils/name_affix"
+require_relative "cmdx/utils/monotonic_runtime"
 require_relative "cmdx/error"
 require_relative "cmdx/errors"
 require_relative "cmdx/fault"
 require_relative "cmdx/faults"
+require_relative "cmdx/logger_ansi"
 require_relative "cmdx/logger"
 require_relative "cmdx/lazy_struct"
 require_relative "cmdx/configuration"
@@ -63,6 +67,7 @@ require_relative "cmdx/parameters_inspector"
 require_relative "cmdx/result"
 require_relative "cmdx/result_serializer"
 require_relative "cmdx/result_inspector"
+require_relative "cmdx/result_ansi"
 require_relative "cmdx/result_logger"
 require_relative "cmdx/task"
 require_relative "cmdx/task_hook"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: cmdx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Juan Gomez
 bindir: exe
 cert_chain: []
-date: 2025-03-08 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -219,8 +219,12 @@ files:
 - lib/cmdx/log_formatters/key_value.rb
 - lib/cmdx/log_formatters/line.rb
 - lib/cmdx/log_formatters/logstash.rb
+- lib/cmdx/log_formatters/pretty_json.rb
+- lib/cmdx/log_formatters/pretty_key_value.rb
+- lib/cmdx/log_formatters/pretty_line.rb
 - lib/cmdx/log_formatters/raw.rb
 - lib/cmdx/logger.rb
+- lib/cmdx/logger_ansi.rb
 - lib/cmdx/parameter.rb
 - lib/cmdx/parameter_inspector.rb
 - lib/cmdx/parameter_serializer.rb
@@ -231,6 +235,7 @@ files:
 - lib/cmdx/parameters_serializer.rb
 - lib/cmdx/railtie.rb
 - lib/cmdx/result.rb
+- lib/cmdx/result_ansi.rb
 - lib/cmdx/result_inspector.rb
 - lib/cmdx/result_logger.rb
 - lib/cmdx/result_serializer.rb
@@ -239,9 +244,9 @@ files:
 - lib/cmdx/run_serializer.rb
 - lib/cmdx/task.rb
 - lib/cmdx/task_hook.rb
-- lib/cmdx/utils/datetime_formatter.rb
-- lib/cmdx/utils/method_name.rb
-- lib/cmdx/utils/runtime.rb
+- lib/cmdx/utils/log_timestamp.rb
+- lib/cmdx/utils/monotonic_runtime.rb
+- lib/cmdx/utils/name_affix.rb
 - lib/cmdx/validators/custom.rb
 - lib/cmdx/validators/exclusion.rb
 - lib/cmdx/validators/format.rb