exis_ray 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72c313e5194f8252623ac026d98ab510c8ad50c7f4b7c7d8f362005c14d6d3e5
-  data.tar.gz: 51b8c985ab03bff4389784477e9c5eb5f27e81138766e50356414b2e88121b68
+  metadata.gz: 37c492f253a0a6899c05e68bb34b2d3f2f2bb90a4ee94a205e602fd821aa7a65
+  data.tar.gz: dac186ccd577e7171655656029db9ab1d3dfe52bc6b5b005f61821f50a99259d
 SHA512:
-  metadata.gz: 5bd0a72ee15676c2074306af62a71098230b30831f49d9b678bb02dd853528a687db9e2d354d0fa34f3bcf758e0bf63fbd5512a949963e256528817749163fda
-  data.tar.gz: 485e39a4b8bf41a01a099d5a75c472f77683ac4a98bb1dcfa109e9abd16be0532930f78bebfee0a94beeb2a725cbae0a3696eabafaa070b0aae2a4cd24b13937
+  metadata.gz: 54fcb9e9ffe4172373089e229942d960bf60d9a64b36c34ed5080acac7458fb6013f8d647eac6de4f2c702eca45491e905cf8728bd6982483ecb419a62745df7
+  data.tar.gz: d2921731f064a4d1216a402de59bc915cfec98eeea8671d17a4ce39340b1f1180d2795d75e165827072cc16b2d363f9437826626a2f14e4b79316bd7ea202c12

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased]
+## [0.3.0] - 2026-03-23
+
+### Added
+- **KV String Parser in JsonFormatter:** The `JsonFormatter` now automatically detects and parses messages in `key=value` format.
+- Extracted pairs from strings are elevated to the JSON root, allowing structured logging from plain string messages.
+- Support for quoted values with spaces (e.g., `message="some text"`) and escaped characters within logs.
+- Added comprehensive RSpec suite for `ExisRay::JsonFormatter` to verify message processing logic.
 
 ## [0.2.0] - 2026-03-12
 

data/README.md

@@ -250,6 +250,7 @@ end
 * **`ExisRay::Current`**: The business layer. Manages domain identity (`User`, `ISP`).
 * **`ExisRay::Reporter`**: The observability layer. Bridges the gap between your app and Sentry.
 * **`ExisRay::JsonFormatter`**: The central logging engine. Intercepts HTTP, Sidekiq, and Tasks to output clean JSON.
+    * **KV String Parser:** It automatically detects if a log message (String) uses `key=value` format. If so, it parses the pairs and elevates them to the root of the JSON. For example, `Rails.logger.info "event=boot status=ok"` becomes `{"event":"boot","status":"ok",...}`. It supports quoted values with spaces: `message="something went wrong"`.
 * **`ExisRay::TaskMonitor`**: The entry point for non-HTTP processes.
 
 ## License

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
+require "rspec/core/rake_task"
 
 RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :rubocop
+task default: %i[spec rubocop]

data/lib/exis_ray/json_formatter.rb

@@ -84,7 +84,10 @@ module ExisRay
     # Procesa el cuerpo del mensaje recibido y lo fusiona con el payload.
     #
     # Si el mensaje es un `Hash` (como el que nos pasará Lograge para peticiones HTTP),
-    # se hace un merge directo. Si es texto plano u otro objeto, se asigna a la clave `:message`.
+    # se hace un merge directo. Si es un String con formato key=value (ej: "event=foo bar=baz"),
+    # se parsea y los campos se elevan al nivel raíz del JSON. Valores con espacios deben estar
+    # entre comillas (ej: message="algo salió mal"). Si el String no sigue ese formato, se asigna
+    # a la clave `:message`.
     #
     # @param payload [Hash] El diccionario base del log.
     # @param msg [String, Hash, Object] El mensaje original recibido por el logger.
@@ -92,9 +95,33 @@ module ExisRay
     def process_message(payload, msg)
       if msg.is_a?(Hash)
         payload.merge!(msg)
+      elsif msg.is_a?(String) && kv_string?(msg)
+        payload.merge!(parse_kv_string(msg))
       else
         payload[:message] = msg.to_s
       end
     end
+
+    # Determina si un string tiene formato key=value.
+    # Considera que hay formato kv si el string comienza con `word=`.
+    #
+    # @param str [String]
+    # @return [Boolean]
+    def kv_string?(str)
+      str.match?(/\A\w+=/)
+    end
+
+    # Parsea un string con formato key=value y retorna un Hash.
+    # Soporta valores con espacios si están entre comillas dobles (ej: message="algo salió mal").
+    #
+    # @param str [String]
+    # @return [Hash]
+    def parse_kv_string(str)
+      result = {}
+      str.scan(/(\w+)=("(?:[^"\\]|\\.)*"|\S+)/) do |key, value|
+        result[key.to_sym] = value.start_with?('"') ? value[1..-2].gsub('\\"', '"') : value
+      end
+      result
+    end
   end
 end

data/lib/exis_ray/version.rb

@@ -2,5 +2,5 @@
 
 module ExisRay
   # Versión actual de la gema.
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/exis_ray/json_formatter_spec.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe ExisRay::JsonFormatter do
+  subject(:formatter) { described_class.new }
+
+  let(:severity)  { "INFO" }
+  let(:timestamp) { Time.utc(2025, 9, 1, 12, 0, 0) }
+  let(:progname)  { nil }
+
+  before do
+    # Stub Tracer y Current para aislar el formatter de dependencias externas
+    stub_const("ExisRay::Tracer", Module.new do
+      def self.service_name = "test-service"
+      def self.root_id      = nil
+      def self.trace_id     = nil
+    end)
+
+    allow(ExisRay).to receive(:current_class).and_return(nil)
+
+    # current_tags es un método de ActiveSupport::TaggedLogging::Formatter que depende
+    # de IsolatedExecutionState (thread-local). Lo stubeamos para entornos sin Rails.
+    allow(formatter).to receive(:current_tags).and_return([])
+  end
+
+  def call(msg)
+    JSON.parse(formatter.call(severity, timestamp, progname, msg))
+  end
+
+  describe "#call" do
+    context "cuando el mensaje es un Hash" do
+      it "eleva los campos al nivel raíz del JSON" do
+        result = call({ event: "archive_lookup", cutoff: "2025-09-01" })
+
+        expect(result).to include(
+          "event"   => "archive_lookup",
+          "cutoff"  => "2025-09-01",
+          "level"   => "INFO",
+          "service" => "test-service"
+        )
+        expect(result).not_to have_key("message")
+      end
+
+      it "convierte claves symbol y string indistintamente" do
+        result = call({ "event" => "foo", bar: "baz" })
+
+        expect(result).to include("event" => "foo", "bar" => "baz")
+      end
+    end
+
+    context "cuando el mensaje es un String con formato key=value" do
+      it "parsea los pares y los eleva al nivel raíz" do
+        result = call("event=archive_lookup cutoff=2025-09-01")
+
+        expect(result).to include(
+          "event"   => "archive_lookup",
+          "cutoff"  => "2025-09-01",
+          "level"   => "INFO",
+          "service" => "test-service"
+        )
+        expect(result).not_to have_key("message")
+      end
+
+      it "soporta un único par key=value" do
+        result = call("event=boot")
+
+        expect(result["event"]).to eq("event=boot".split("=").last)
+        expect(result).not_to have_key("message")
+      end
+
+      it "soporta valores con espacios entre comillas dobles" do
+        result = call('event=error message="algo salió mal"')
+
+        expect(result["event"]).to eq("error")
+        expect(result["message"]).to eq("algo salió mal")
+      end
+
+      it "soporta comillas escapadas dentro del valor" do
+        result = call('msg="dijo \"hola\""')
+
+        expect(result["msg"]).to eq('dijo "hola"')
+      end
+
+      it "soporta múltiples pares con tipos de valor variados" do
+        result = call("component=orders event=invoice_generated duration_ms=42.5 retries=0")
+
+        expect(result).to include(
+          "component"   => "orders",
+          "event"       => "invoice_generated",
+          "duration_ms" => "42.5",
+          "retries"     => "0"
+        )
+      end
+    end
+
+    context "cuando el mensaje es un String libre (sin formato key=value)" do
+      it "asigna el string completo al campo message" do
+        result = call("algo salió mal")
+
+        expect(result["message"]).to eq("algo salió mal")
+        expect(result).to include("level" => "INFO", "service" => "test-service")
+      end
+
+      it "asigna un string vacío al campo message" do
+        result = call("")
+
+        expect(result["message"]).to eq("")
+      end
+
+      it "convierte objetos arbitrarios a string via to_s" do
+        result = call(42)
+
+        expect(result["message"]).to eq("42")
+      end
+    end
+
+    describe "campos base" do
+      it "incluye time en formato ISO8601 UTC" do
+        result = call("event=boot")
+
+        expect(result["time"]).to eq("2025-09-01T12:00:00Z")
+      end
+
+      it "incluye level y service" do
+        result = call("event=boot")
+
+        expect(result["level"]).to eq("INFO")
+        expect(result["service"]).to eq("test-service")
+      end
+    end
+  end
+
+  describe "#kv_string? (privado)" do
+    it "retorna true si el string empieza con word=" do
+      expect(formatter.send(:kv_string?, "event=foo")).to be true
+    end
+
+    it "retorna false para strings libres" do
+      expect(formatter.send(:kv_string?, "algo salió mal")).to be false
+      expect(formatter.send(:kv_string?, "")).to be false
+      expect(formatter.send(:kv_string?, "=sinkey")).to be false
+    end
+  end
+
+  describe "#parse_kv_string (privado)" do
+    it "retorna un hash con claves symbol" do
+      result = formatter.send(:parse_kv_string, "a=1 b=2")
+
+      expect(result).to eq({ a: "1", b: "2" })
+    end
+
+    it "desenvuelve las comillas dobles de los valores" do
+      result = formatter.send(:parse_kv_string, 'msg="hello world"')
+
+      expect(result).to eq({ msg: "hello world" })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "logger"
+require "json"
+require "active_support/tagged_logging"
+require "exis_ray/json_formatter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exis_ray
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Gabriel Edera
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-03-12 00:00:00.000000000 Z
+date: 2026-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,6 +78,8 @@ files:
 - lib/exis_ray/tracer.rb
 - lib/exis_ray/version.rb
 - sig/exis_ray.rbs
+- spec/exis_ray/json_formatter_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/gedera/exis_ray
 licenses:
 - MIT