redacted_struct 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c02de7881517f0bbb564741a2b999e8066a8de32f7aed539c86da981d5bddf
-  data.tar.gz: ad4589962d6c3be459ffc88ef3712b3e59177b83cddef3b2526a0dfb11c2a2ad
+  metadata.gz: 4d69e9affe18e7d2f75a375a5cf36cbaed7045b638ea4a2b3fe9113d6e3828ab
+  data.tar.gz: 20bb14b68d38c7f2edf524abdc3a7021a0fc65d5129a32a2642b119872c65d19
 SHA512:
-  metadata.gz: a4616807a9c76c8f01c63585d02c79a592b1eaed901263bfc1109ff29ceb165e3b860b6e9a5005d6fa772ab585fef04d3469b18a78466b91a10f56af438d0ee1
-  data.tar.gz: ffe8ffa0f62360f78113cc98c4ee8972d1cb181682b3f10c87d63bc821ab24a25e62662b1e3485ab09f774f47a1e7b0681e04214037f4bbcfe936786f2c8c83a
+  metadata.gz: 89181954e77992a479f20429c686bcaa1cacc12ec5d97bbc8a82ee5fc4db2f75316e1b3aca78f4b0bf97a1bd1c6f0b53df473c42b8ca3930a89153545bea3550
+  data.tar.gz: aa27dc39f2548a175287dcee00f88f4ced18c99a7dbefc57c9d027309ed4c6535fe970f579a0b128c44d31487cb2724b0ee1a497d80a4080cc0e8a1f3dcbcfd3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [1.1.0] - 2021-03-24
+
+- Override `Struct#pretty_print` to keep redacted fields redacted when
+  pretty-printing via `pp`
+
 ## [1.0.0] - 2021-03-24
 
 - Initial release

data/README.md

@@ -8,14 +8,30 @@ Config = RedactedStruct.new(
   :username,
   :password,
   :timeout,
+  :url,
   keyword_init: true,
   allowed_members: [:username, :timeout]
 )
 
-Config.new(username: 'example', password: 'secret', timeout: 5)
+config = Config.new(username: 'example', password: 'secret', timeout: 5, url: 'https://example.com')
 => #<struct Config username="example" password=[REDACTED] timeout=5>
 ```
 
+## Pretty-Printing
+
+The struct will automatically redact itself when pretty-printed via `#pp`:
+
+```ruby
+require 'pp'
+
+pp config
+#<struct Config
+ username="example",
+ password=[REDACTED],
+ timeout=5,
+ url="https://example.com">
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/redacted_struct.rb

@@ -2,7 +2,7 @@
 
 # A subclass of Struct that redacts members by default, and can allow some to be printed
 class RedactedStruct < Struct
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 
   def self.new(*name_and_members, keyword_init: nil, allowed_members: [], &block)
     super(*name_and_members, keyword_init: keyword_init, &block).tap do |struct_class|
@@ -35,4 +35,26 @@ class RedactedStruct < Struct
   end
 
   alias_method :to_s, :inspect
+
+  # Overrides for pp
+  # See https://github.com/ruby/pp/blob/3d925b5688b8226f653127d990a8dce48bced5fe/lib/pp.rb#L379-L391
+  # rubocop:disable all
+  def pretty_print(q)
+    q.group(1, sprintf("#<struct %s", PP.mcall(self, Kernel, :class).name), '>') {
+      q.seplist(PP.mcall(self, Struct, :members), lambda { q.text "," }) {|member|
+        q.breakable
+        q.text member.to_s
+        q.text '='
+        q.group(1) {
+          q.breakable ''
+          if allowed_members.include?(member)
+            q.pp self[member]
+          else
+            q.text "[REDACTED]"
+          end
+        }
+      }
+    }
+  end
+  # rubocop:enable all
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redacted_struct
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Zach Margolis