wide_events 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 861efab741f9c9c6445d2c5f877e08c6f7da36e01254719191d1976baaff398b
-  data.tar.gz: d2f7efdca7e96cd0f4d65589014ab0a137bde8ce22c1b3edd9bc15dd21425606
+  metadata.gz: ab8bbc27c3a72a3efd7dbb3cb63453936a5f520b0a72e50ca8c89fa79d296a0b
+  data.tar.gz: 28a32dc6e3c7d98ac4b795c012e36ea8e02eb8a72dd4115f08ad7c808e27f251
 SHA512:
-  metadata.gz: 49017796cabf1aea3026d39049e8ffdd085b9806e81574797cecc14e2e2c46502db6e7a0f8a37c44c26cc78f86f4d71d29f5db2576108970bee290c76dad39ba
-  data.tar.gz: 14201839ae140bb2f4a35bef52c581a95b9e6a0939db7a16b12feea7a8ac8cdf46f449564720829df689b63eaf0c198d268448498fac70f5955073aed4bc84e0
+  metadata.gz: f27aefb767cff731bc999fdec722d2a2ea0195dcd4e8d9d37b6f406c85725eed9a4594d279554a58fe27cdb8c5a92ac33f043ff9748439d546fb0825c3eba382
+  data.tar.gz: a3f1b8b6c52d66a045d08284fc101b036470509c571696f2f324c42451225db2f8e0dfaacac431aa2b966e8250761321f799387ab778c9c43a73f002497de6e9

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.1.4 (2026-08-04)
+
+- The railtie stores `registry_path` relative to the app root
+  (`config/wide_event/registry.yml`) and `Configuration` resolves it via
+  `Rails.root.join` when opening the registry. The generated doc's header
+  previously committed the machine-specific absolute path, which rewrote
+  itself on every other checkout; it now carries the relative path.
+  Explicitly configured absolute paths keep working unchanged.
+- `Registry#to_markdown` collapses whitespace and escapes pipes in every
+  cell. A `notes: >` folded scalar keeps a trailing newline, which pushed
+  the row's closing pipe onto its own line and split the table.
+- The generated doc's title is "Wide events attribute registry" — no
+  hyphen; that spelling belongs to file names, not copy.
+
 ## v0.1.3 (2026-08-03)
 
 - README links to the docs are absolute GitHub URLs, so they work on

data/lib/wide_event/configuration.rb

@@ -57,7 +57,16 @@ module WideEvent
 
     def registry
       return nil if @registry_path.nil?
-      @registry ||= Registry.load(@registry_path)
+      @registry ||= Registry.load(resolved_registry_path)
+    end
+
+    private
+
+    # `registry_path` stays relative so the generated doc can commit it;
+    # absolute paths win inside Pathname#join and pass through as-is.
+    def resolved_registry_path
+      root = Rails.root if defined?(Rails) && Rails.respond_to?(:root)
+      root ? root.join(@registry_path).to_s : @registry_path
     end
   end
 end

data/lib/wide_event/railtie.rb

@@ -15,8 +15,8 @@ module WideEvent
     end
 
     initializer "wide_event.registry" do |app|
-      path = app.root.join("config", "wide_event", "registry.yml")
-      WideEvent.config.registry_path ||= path.to_s if path.exist?
+      path = "config/wide_event/registry.yml"
+      WideEvent.config.registry_path ||= path if app.root.join(path).exist?
     end
 
     # After the app's own initializers, so the host's OpenTelemetry::SDK

data/lib/wide_event/registry.rb

@@ -66,9 +66,18 @@ module WideEvent
       lines = [ "| Attribute | Type | Set by | PII | Notes |", "|---|---|---|---|---|" ]
       entries.each do |key, entry|
         entry = {} unless entry.is_a?(Hash)
-        lines << "| `#{key}` | #{Array(entry["type"]).join(", ")} | #{entry["set_by"]} | #{entry["pii"]} | #{entry["notes"]} |"
+        cells = [ Array(entry["type"]).join(", "), entry["set_by"], entry["pii"], entry["notes"] ]
+        lines << "| `#{key}` | #{cells.map { |value| cell(value) }.join(" | ")} |"
       end
       lines.join("\n") + "\n"
     end
+
+    private
+
+    # A table cell can hold neither a newline (folded scalars keep a trailing
+    # one) nor a bare pipe.
+    def cell(value)
+      value.to_s.gsub(/\s+/, " ").strip.gsub("|") { "\\|" }
+    end
   end
 end

data/lib/wide_event/tasks/registry.rake

@@ -16,7 +16,7 @@ namespace :wide_events do
       path = ENV["WIDE_EVENTS_DOCS_PATH"] || "docs/wide-events-registry.md"
       require "fileutils"
       FileUtils.mkdir_p(File.dirname(path))
-      header = "# Wide-events attribute registry\n\n" \
+      header = "# Wide events attribute registry\n\n" \
                "Generated from `#{WideEvent.config.registry_path}` by `rake wide_events:registry:docs`. " \
                "Do not edit by hand.\n\n"
       File.write(path, header + registry.to_markdown)

data/lib/wide_event/version.rb

@@ -1,3 +1,3 @@
 module WideEvent
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wide_events
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Adam Miribyan