redacted_struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33437d1b7be19f014678f6bdeab2900bc2e0d179699e2a5f5fd4e4cbe107b4f2
+  data.tar.gz: 5d3ad99adb60ffe21be6d1a172adc5f79374c82337e178a96e2b50a7a6f2f2b4
+SHA512:
+  metadata.gz: efb6986ea192e32bf37e2da288f219060eef31331840b321bdf09da14845a690bb217177237a3be73314b4c844a0836ff95a566eda51efd365e3871fcfb786b1
+  data.tar.gz: 38d2b23615e693b268804970a23d6840cda13019de0b12c7e3a7a553cc7fcffda65fd2c4f9c53ccc62173eba3ebc1afca8c7a379ebf8c29e1e2ea3396a5985c4

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    docker:
+      - image: cimg/ruby:2.6.5
+    executor: ruby/default
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Run specs
+          command: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: disable
+  SuggestExtensions: false
+
+Style/Alias:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2021-03-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in redacted_struct.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.7"

data/README.md

@@ -0,0 +1,43 @@
+# RedactedStruct
+
+A version of Ruby's built-in Struct that redacts members when printing, and can allow specifying
+members that can be printed normally (an allowlist).
+
+```ruby
+Config = RedactedStruct.new(
+  :username,
+  :password,
+  :timeout,
+  keyword_init: true,
+  allowed_members: [:username, :timeout]
+)
+
+Config.new(username: 'example', password: 'secret', timeout: 5)
+=> #<struct Config username="example" password=[REDACTED] timeout=5>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redacted_struct'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install redacted_struct
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zachmargolis/redacted_struct.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "redacted_struct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redacted_struct.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# A subclass of Struct that redacts members by default, and can allow some to be printed
+class RedactedStruct < Struct
+  VERSION = "1.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|
+      struct_class.class_eval do
+        @allowed_members = Array(allowed_members)
+      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

data/redacted_struct.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/redacted_struct"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redacted_struct"
+  spec.version       = RedactedStruct::VERSION
+  spec.authors       = ["Zach Margolis"]
+
+  spec.summary       = "A Ruby Struct that can be redacted"
+  spec.description   = "Help prevent logging sensitive by accident"
+  spec.homepage      = "https://github.com/zachmargolis/redacted_struct"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/zachmargolis/redacted_struct/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: redacted_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Zach Margolis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies: []
+description: Help prevent logging sensitive by accident
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redacted_struct.rb
+- redacted_struct.gemspec
+homepage: https://github.com/zachmargolis/redacted_struct
+licenses: []
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A Ruby Struct that can be redacted
+test_files: []