philiprehberger-env_diff 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb5b721f4c0ca4625cc7065f8e443aeaeb069394759e21829141bc2e551180c4
-  data.tar.gz: 44866b77b4a8adeab0ac1550d1a53b995875cc444fc1fd67a7deb32bd1216035
+  metadata.gz: 8fa424560bb3f733e97c91a5e643f04306eb81aa032184970889e71d987910c6
+  data.tar.gz: 32748ed41ac378a1dd96fdf74a91ebd1f7e72fa74628510cd2fcdbb61e4d3c74
 SHA512:
-  metadata.gz: 8e35a278641cbd4e7adaf9fe571e096a9ebd3a2521c56aed09750025e04265ddc743a8551d0efd94c5fb5b190b789fca7a9e995aad0deadef4dbffe973d5d04a
-  data.tar.gz: 606bed2477c6205c621a5e4e728eeb6f22d8dc3e6f671ac66d7d3077a1948aed414cda0570207b5b5019a32a94e14cb40b4aed48c4b940fd0f5f4f0b02c03e69
+  metadata.gz: 1738b36b798d79c436f4471ee7a44f755d8d83ef4d2ba89ffcee2f7724de895573cdc3b198f7943c3c9d49c8737a9cc1887b76a0c035129a8f9b047d882469a1
+  data.tar.gz: bf909ac4ba6905c9889ce456b7c29d1ef087618562954305a553f58690c0f635dc32c9a8278de0946936ac33e27d0019e3ee3510535c3621482913aff8878c6a

data/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.0] - 2026-05-08
+
+### Added
+- `EnvDiff.to_csv(diff, mask: [])` — exports a structured `key,status,source,target` CSV (RFC 4180 quoting). Complements the existing `to_markdown` and `to_html` exports for spreadsheet review. Supports the same `mask:` substring redaction as `Diff#summary`.
+
+## [0.4.0] - 2026-04-24
+
+### Added
+- `Diff#status_for(key)` — returns the status of a single key as a Symbol (`:added`, `:removed`, `:changed`, `:unchanged`), or `nil` if the key is absent from both sides
+
 ## [0.3.0] - 2026-04-14
 
 ### Added

data/README.md

@@ -82,6 +82,16 @@ diff.stats
 # => { added: 1, removed: 1, changed: 1, unchanged: 1, total: 4 }
 ```
 
+### Per-key status
+
+```ruby
+diff.status_for("NEW_KEY")      # => :added
+diff.status_for("OLD_KEY")      # => :removed
+diff.status_for("DATABASE_URL") # => :changed
+diff.status_for("SECRET")       # => :unchanged
+diff.status_for("NOT_THERE")    # => nil
+```
+
 ### Validation
 
 Check that all required keys exist in a target hash or `.env` file:
@@ -112,7 +122,7 @@ diff.unchanged # => ["DB_HOST"]
 
 ### Export Formats
 
-Format a diff result as a Markdown or HTML table:
+Format a diff result as a Markdown, HTML, or CSV table:
 
 ```ruby
 diff = Philiprehberger::EnvDiff.compare(source, target)
@@ -131,6 +141,13 @@ puts Philiprehberger::EnvDiff.to_html(diff)
 #   <tr><td>NEW_KEY</td><td>added</td><td></td><td>added</td></tr>
 #   ...
 # </table>
+
+puts Philiprehberger::EnvDiff.to_csv(diff, mask: ['SECRET'])
+# key,status,source,target
+# NEW_KEY,added,,added
+# OLD_KEY,removed,remove_me,
+# DATABASE_URL,changed,postgres://localhost/dev,postgres://prod-host/app
+# SECRET,unchanged,***,***
 ```
 
 ### Compare against system ENV
@@ -170,6 +187,7 @@ ENV
 | `EnvDiff.validate(target, required:)` | Check that all required keys exist in target; returns `{ valid:, missing: }` |
 | `EnvDiff.to_markdown(diff)` | Format a diff result as a Markdown table string |
 | `EnvDiff.to_html(diff)` | Format a diff result as an HTML table string |
+| `EnvDiff.to_csv(diff, mask: [])` | Format a diff result as a `key,status,source,target` CSV; supports value masking |
 | `Diff#added` | Array of keys in target but not source |
 | `Diff#removed` | Array of keys in source but not target |
 | `Diff#changed` | Hash of keys with different values |
@@ -180,6 +198,7 @@ ENV
 | `Diff#to_json` | JSON serialization of the structured hash |
 | `Diff#filter(pattern:)` | New `Diff` containing only keys matching the regex pattern |
 | `Diff#stats` | Hash of counts: `:added`, `:removed`, `:changed`, `:unchanged`, `:total` |
+| `Diff#status_for(key)` | Status of a single key as `:added`, `:removed`, `:changed`, `:unchanged`, or `nil` |
 | `Parser.parse(content)` | Parse `.env` string into a hash |
 | `Parser.parse_file(path:)` | Read and parse a `.env` file |
 

data/lib/philiprehberger/env_diff/diff.rb

@@ -92,6 +92,19 @@ module Philiprehberger
         }
       end
 
+      # Status of a single key in this diff.
+      #
+      # @param key [String] the key to look up
+      # @return [Symbol, nil] one of :added, :removed, :changed, :unchanged, or nil if absent from both sides
+      def status_for(key)
+        return :added if @added.include?(key)
+        return :removed if @removed.include?(key)
+        return :changed if @changed.key?(key)
+        return :unchanged if @unchanged.include?(key)
+
+        nil
+      end
+
       private
 
       def build_changed(source, target)

data/lib/philiprehberger/env_diff/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module EnvDiff
-    VERSION = '0.3.0'
+    VERSION = '0.5.0'
   end
 end

data/lib/philiprehberger/env_diff.rb

@@ -63,6 +63,49 @@ module Philiprehberger
       lines.join("\n")
     end
 
+    # Format a diff result as a CSV string with header `key,status,source,target`.
+    #
+    # Values containing commas, quotes, or newlines are quoted per RFC 4180.
+    # Keys whose name contains any of `mask` (substring match, case-insensitive)
+    # have their source and target values redacted to `***`.
+    #
+    # @param diff [Diff] the diff to format
+    # @param mask [Array<String>] substrings to match against keys for redaction
+    # @return [String] CSV body with a trailing newline
+    def self.to_csv(diff, mask: [])
+      data = diff.to_h
+      lines = ['key,status,source,target']
+
+      diff.added.each { |key| lines << csv_row(key, 'added', '', data[:added][key], mask) }
+      diff.removed.each { |key| lines << csv_row(key, 'removed', data[:removed][key], '', mask) }
+      diff.changed.each do |key, vals|
+        lines << csv_row(key, 'changed', vals[:source], vals[:target], mask)
+      end
+      diff.unchanged.each do |key|
+        val = data[:unchanged][key]
+        lines << csv_row(key, 'unchanged', val, val, mask)
+      end
+
+      "#{lines.join("\n")}\n"
+    end
+
+    def self.csv_row(key, status, source, target, mask)
+      masked = mask.any? { |m| key.to_s.downcase.include?(m.to_s.downcase) }
+      source = '***' if masked && source.to_s != ''
+      target = '***' if masked && target.to_s != ''
+      [key, status, source, target].map { |cell| csv_escape(cell) }.join(',')
+    end
+    private_class_method :csv_row
+
+    def self.csv_escape(value)
+      string = value.to_s
+      return string unless string.match?(/[",\n\r]/)
+
+      escaped = string.gsub('"', '""')
+      "\"#{escaped}\""
+    end
+    private_class_method :csv_escape
+
     # Format a diff result as an HTML table string.
     #
     # @param diff [Diff] the diff to format

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-env_diff
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-15 00:00:00.000000000 Z
+date: 2026-05-08 00:00:00.000000000 Z
 dependencies: []
 description: Parse .env files or environment hashes, compare them, and get a clear
   report of added, removed, changed, and unchanged variables.