redacted_struct 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c02de7881517f0bbb564741a2b999e8066a8de32f7aed539c86da981d5bddf
-  data.tar.gz: ad4589962d6c3be459ffc88ef3712b3e59177b83cddef3b2526a0dfb11c2a2ad
+  metadata.gz: 84097ef8bb895a91b3d17f35daee43dd9e6b4d0a677c25bf4bd9c82962aba823
+  data.tar.gz: 3c7c5c3328485f20e92b23e9ae2f221eab868830b6efecab27ddd08221bae014
 SHA512:
-  metadata.gz: a4616807a9c76c8f01c63585d02c79a592b1eaed901263bfc1109ff29ceb165e3b860b6e9a5005d6fa772ab585fef04d3469b18a78466b91a10f56af438d0ee1
-  data.tar.gz: ffe8ffa0f62360f78113cc98c4ee8972d1cb181682b3f10c87d63bc821ab24a25e62662b1e3485ab09f774f47a1e7b0681e04214037f4bbcfe936786f2c8c83a
+  metadata.gz: a6bc81b2aa8cf0abcaa1b69b1f748443d60d35778ce08635076f27010a37c897652fd1a154d635d72f076958a74dd3203bd7525d7e3240a432c30d99d26b6c7a
+  data.tar.gz: 44c61acc111af1b2ce4310fcf6e44001bbc96ccbd18eedb055f6a9d87e1bbec8ca8ea26673400b30217218531a614bd8bfe7b9b88b9f4815e284387f211b6406

data/.circleci/config.yml

@@ -1,18 +1,33 @@
 version: 2.1
 orbs:
-  ruby: circleci/ruby@0.1.2
+  ruby: circleci/ruby@1.1
 
 jobs:
-  build:
+  test:
+    parameters:
+      ruby-version:
+        type: string
     docker:
-      - image: cimg/ruby:2.6.5
-    executor: ruby/default
+      - image: cimg/ruby:<< parameters.ruby-version >>
     steps:
       - checkout
       - run:
-          name: Which bundler?
-          command: bundle -v
-      - ruby/bundle-install
+          name: "Add platform for Bundler"
+          description: "Normally the platforms lives in Gemfile.lock, but as a gem this repo does not have one, CircleCI fails if there are no platforms"
+          command: bundle lock --add-platform x86_64-linux
+      - ruby/install-deps:
+          bundler-version: '1.17.2'
+          with-cache: false
+      - ruby/rspec-test
       - run:
-          name: Run specs
-          command: bundle exec rake spec
+          name: Rubocop
+          command: bundle exec rubocop
+
+workflows:
+  build_and_test:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              # https://github.com/CircleCI-Public/cimg-ruby
+              ruby-version: ["2.6", "3.1", "3.2"]

data/.rubocop.yml

@@ -23,6 +23,12 @@ Style/TrailingCommaInArguments:
 Layout/LineLength:
   Max: 120
 
+# require "pp" in specs is flagged in Ruby 2.6 but not in other ones
+# and doing a point disable gets a "unused lint" warning, so this is easier
+# to disable here
+Lint/RedundantRequireStatement:
+    Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - "spec/**/*.rb"

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [2.0.0] - 2024-01-10
+
+- Add support to redact `Data` objects
+
+## [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/Gemfile

@@ -7,4 +7,5 @@ gemspec
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
+gem "rspec_junit_formatter", "~> 0.6"
 gem "rubocop", "~> 1.7"

data/README.md

@@ -8,14 +8,47 @@ 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">
+```
+
+## RedactedData
+
+Redaction is also supported for Ruby's built-in Data class:
+
+```ruby
+Config = RedactedData.define(
+  :username,
+  :password,
+  :timeout,
+  :url,
+  allowed_members: [:username, :timeout]
+)
+
+config = Config.new(username: 'example', password: 'secret', timeout: 5, url: 'https://example.com')
+=> #<data Config username="example" password=[REDACTED] timeout=5>
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/redactable.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# A module that adds redacted functionality to a class
+module Redactable
+  def self.included(mod)
+    class << mod
+      attr_reader :allowed_members
+    end
+  end
+
+  def inspect
+    name_or_nil = self.class.name ? " #{self.class.name}" : nil
+
+    members_h = to_h
+    attributes = members.map do |member|
+      if allowed_members.include?(member)
+        "#{member}=#{members_h[member].inspect}"
+      else
+        "#{member}=[REDACTED]"
+      end
+    end.join(" ")
+
+    "#<#{base_name_for_inspection}#{name_or_nil} #{attributes}>"
+  end
+
+  def allowed_members
+    self.class.allowed_members
+  end
+
+  # 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("#<%s %s", base_name_for_inspection, PP.mcall(self, Kernel, :class).name), '>') {
+      members_h = to_h
+      q.seplist(PP.mcall(self, base_type_for_pp, :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 members_h[member]
+          else
+            q.text "[REDACTED]"
+          end
+        }
+      }
+    }
+  end
+  # rubocop:enable all
+
+  alias_method :to_s, :inspect
+
+  def base_name_for_inspection
+    if is_a? Struct
+      "struct"
+    else
+      "data"
+    end
+  end
+
+  def base_type_for_pp
+    if is_a? Struct
+      Struct
+    else
+      Data
+    end
+  end
+end

data/lib/redacted_data.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/Documentation
+# rubocop:disable Style/MultilineIfModifier
+# A subclass of Data that redacts members by default, and can allow some to be printed
+class RedactedData < Data
+  include Redactable
+
+  def self.define(*members, allowed_members: [], &block)
+    super(*members, &block).tap do |data_class|
+      data_class.class_eval do
+        @allowed_members = Array(allowed_members)
+      end
+    end
+  end
+end if defined?(Data) && Data.respond_to?(:define)
+# rubocop:enable Style/MultilineIfModifier
+# rubocop:enable Style/Documentation

data/lib/redacted_struct.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require_relative "./redactable"
+require_relative "./redacted_data"
+
 # A subclass of Struct that redacts members by default, and can allow some to be printed
 class RedactedStruct < Struct
-  VERSION = "1.0.1"
+  include Redactable
+
+  VERSION = "2.0.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|
@@ -11,28 +16,4 @@ class RedactedStruct < Struct
       end
     end
   end
-
-  class << self
-    attr_reader :allowed_members
-  end
-
-  def allowed_members
-    self.class.allowed_members
-  end
-
-  def inspect
-    name_or_nil = self.class.name ? " #{self.class.name}" : nil
-
-    attributes = members.map do |member|
-      if allowed_members.include?(member)
-        "#{member}=#{self[member].inspect}"
-      else
-        "#{member}=[REDACTED]"
-      end
-    end.join(" ")
-
-    "#<struct#{name_or_nil} #{attributes}>"
-  end
-
-  alias_method :to_s, :inspect
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: redacted_struct
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Zach Margolis
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies: []
 description: Help prevent logging sensitive information by accident
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -26,6 +26,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/redactable.rb
+- lib/redacted_data.rb
 - lib/redacted_struct.rb
 - redacted_struct.gemspec
 homepage: https://github.com/zachmargolis/redacted_struct
@@ -34,7 +36,7 @@ metadata:
   homepage_uri: https://github.com/zachmargolis/redacted_struct
   source_code_uri: https://github.com/zachmargolis/redacted_struct
   changelog_uri: https://github.com/zachmargolis/redacted_struct/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A Ruby Struct that can be redacted
 test_files: []