immutable_struct_ex_redactable 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42c25462c52746ec41cd4342439fffbb683fec77c05bb5a4206e7d7b2e5476f
-  data.tar.gz: e37bae62f51c0e8c0d8cc3acc624714f06ddbe94783509d6c0e37d84b03ca05f
+  metadata.gz: cfd26e195119def213e1b3b5c296761323b2e682b7afcef49cc066b9ac386a8d
+  data.tar.gz: e6b605a95ff4121df11a2fec4e112493610bbca5112209a5a324a18232f98549
 SHA512:
-  metadata.gz: c3668bb96227c69b6babd198c2ee832e87e41f94a7f9c1e30f51a4606a7fbb22e1f804208f741dd5a72f7f6c7ed7291b29dea863ebfe8338ef579cb9e6f76033
-  data.tar.gz: e0b12b781c99c6e453c4c27653fa4992181d8bfe352b14e5f4653098d2553b80910b298f47b4b04fd780995a2289861fce7b15fe9a863b027858a2693c2cd101
+  metadata.gz: 5032428a593c4114903acedf6cb8747b733af10874dd092d2c2c5270f8857abb069a503400f34e18bd8fe8bfba481f4e0c2c5883fb7d3afddc150f6c019c932a
+  data.tar.gz: 426aa1cb7650c2abd20be06a534dc9b3f543207eaae3ee3403c09a202474ed302de6ade4e376353508a9208a40fe0d346a8533232e6a42de7e298e9fc617a1d6

data/CHANGELOG.md

@@ -1,6 +1,22 @@
+## [1.2.1] - 2023-08-17
+
+Changes
+
+- Ruby gem updates.
+
+## [1.2.0] - 2022-10-03
+
+Changes
+
+- Add `ImmutableStructExRedactable::Configuration#redacted_unsafe` property. If this property is `true`, redacted field values will be retained and accessible as private methods on the struct named `unredacted_<field>`.
+- Update README.md file.
+
 ## [1.1.0] - 2022-10-02
-* Changes
-  * Fix rubocop violations
+
+Changes
+
+- Fix rubocop violations
 
 ## [1.0.0] - 2022-10-02
-* Initial release
+
+Initial release

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 
 gem 'pry-byebug', '~> 3.9'
 gem 'rake', '~> 13.0'
-gem 'reek', '~> 6.1', '>= 6.1.1'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 0.81.0'
-gem 'simplecov', '~> 0.21.2'
+gem 'reek', '~> 6.1'
+gem 'rspec', '~> 3.12'
+gem 'rubocop', '~> 1.56.0'
+gem 'simplecov', '~> 0.22.0'

data/Gemfile.lock

@@ -1,78 +1,90 @@
 PATH
   remote: .
   specs:
-    immutable_struct_ex_redactable (1.1.0)
-      immutable_struct_ex (~> 0.3.0)
+    immutable_struct_ex_redactable (1.2.1)
+      immutable_struct_ex (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    immutable_struct_ex (0.3.0)
-    jaro_winkler (1.5.4)
+    immutable_struct_ex (1.0.1)
+    json (2.6.3)
     kwalify (0.7.2)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
       byebug (~> 11.0)
       pry (>= 0.13, < 0.15)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    reek (6.1.1)
+    reek (6.1.4)
       kwalify (~> 0.7.0)
-      parser (~> 3.1.0)
+      parser (~> 3.2.0)
       rainbow (>= 2.0, < 4.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (0.81.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
-      rexml
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (1.8.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   immutable_struct_ex_redactable!
   pry-byebug (~> 3.9)
   rake (~> 13.0)
-  reek (~> 6.1, >= 6.1.1)
-  rspec (~> 3.0)
-  rubocop (~> 0.81.0)
-  simplecov (~> 0.21.2)
+  reek (~> 6.1)
+  rspec (~> 3.12)
+  rubocop (~> 1.56.0)
+  simplecov (~> 0.22.0)
 
 BUNDLED WITH
    2.3.22

data/README.md

@@ -17,14 +17,13 @@
 
 `immutable_struct_ex_redactable` maintains all the functionality of the *immutable_struct_ex* gem, but allows you to create immutable structs that can be configured to redact field values using standard gem configuration (`ImmutableStructExRedactable.configure { |config| ... }`) or by passing configuration options to the appropriate method (`ImmutableStructExRedactable.create_with(config, ...)`)
 
+### Future Enhancements
+- Future functionality will probably accept regex pattern for redacting field values (e.g. 'gen***@***.com').
+
 ## Usage
 
 Follow the instructions for [Installation](#installation) first, to incorporate this gem into your code.
 
-### Enhancements
-- Future functionality may include regex pattern for redacting field values (e.g. 'gen***@***.com').
-- Availability of redacted values as private fields/methods for use in `&blocks`.
-
 ### Basic usage
 
 #### Configure Gem Global Defaults
@@ -58,9 +57,10 @@ ImmutableStructExRedactable.create(**fields)
 => #<struct  first="Jane", last="Smith", password="[REDACTED]", dob="[REDACTED]">
 
 ```
-NOTE: Setting the global defaults in the above manner will affect **every** *immutable_struct_ex_redactable* struct you create unless you override the global configuration options by passing a custom configuration.
 
-#### Overriding the Global Configuration Operions
+NOTE: Setting the global defaults in the above manner will affect **every** *immutable_struct_ex_redactable* struct instance you create unless you override the global configuration options, by passing a custom configuration.
+
+#### Overriding the Global Configuration Options
 
 To override the global configuration options, you may do so by calling the `ImmutableStructExRedactable#create_with` method in the following manner:
 
@@ -83,6 +83,45 @@ ImmutableStructExRedactable.create_with(custom_config, **fields)
 => #<struct  first="John", last="Smith", password="[NO WAY JOSE]", dob="[NO WAY JOSE]">
 ```
 
+### Access to the Original Redacted Field Values
+
+By default, *immutable_struct_ex_redactable* **will not** allow access to redacted field values; that is, field values marked for redaction via the global configuration (`ImmutableStructExRedactable::Configuration#redacted`) or by overriding the global configuration by passing a custom configuration (`ImmutableStructExRedactable.create_with(my_config, ...)`). However, if you really *need* access to redacted field values in their original, *un*redacted form, you can turn on the `ImmutableStructExRedactable::Configuration#redacted_unsafe` option in the global configuration or turn this same option on when passing a custom configuration. Turning the `redacted_unsafe` configuration option on in either scenario will instruct *immutable_struct_ex_redactable* to create *private methods* on structs created that will allow access to the original *un*redacted field values via `send:`. The *private methods* created that will allow access to the original *un*redacted field values, will have the following naming convention:
+
+```ruby
+unredacted_<redacted field>
+# Where <redacted field> == the Symbol of the redacted field.
+# For example: unredacted_password, unredacted_dob, unredacted_ssn, etc.
+```
+
+For example:
+
+```ruby
+custom_config = ImmutableStructExRedactable::Configuration.new.tap do |config|
+  config.redacted_unsafe = true
+end
+
+hash = { username: 'jsmith', password: 'p@ssw0rd' }
+struct = ImmutableStructExRedactable.create_with(custom_config, **hash) do
+  def to_h_unredacted
+    {
+      username: username,
+      password: send(:unredacted_password)
+    }
+  end
+end
+=> #<struct  username="jsmith", password="******">
+
+struct.unredacted_password
+#=> NoMethodError: private method `unredacted_password' called for #<struct username="jsmith", password="******">...
+
+struct.send :unredacted_password
+#=> "p@ssw0rd"
+
+struct.to_h_unredacted
+#=> {:username=>"jsmith", :password=>"p@ssw0rd"}
+
+```
+
 ### &blocks are Permitted
 
 Current `immutable_struct_ex` gem functionality is still available, so passing `&block` is permitted. See [immutable_struct_ex](https://rubygems.org/gems/immutable_struct_ex) gem for more details:

data/lib/immutable_struct_ex_redactable/configuration.rb

@@ -38,17 +38,33 @@ module ImmutableStructExRedactable
     # @return [String] the label that should replace redacted field values.
     attr_accessor :redacted_label
 
+    # Gets/sets the redacted unsafe switch that determines whether or not
+    # redacted field values are retained as private methods named
+    # #unredacted_<field> on the struct returned. If this configuration
+    # property is true, redacted field values will be retained and
+    # accessible as private methods on the struct.
+    #
+    # The default is false.
+    #
+    # @return [Bool] the unsafe switch value.
+    attr_accessor :redacted_unsafe
+
     # The constructor; calls {#reset}.
     def initialize
       reset
     end
 
+    def redacted_unsafe?
+      @redacted_unsafe
+    end
+
     # Resets the configuration settings to their default values.
     #
     # @return [void]
     def reset
       @redacted = %i[password]
       @redacted_label = '******'
+      @redacted_unsafe = false
     end
   end
 end

data/lib/immutable_struct_ex_redactable/redacted_accessible.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ImmutableStructExRedactable
+  module RedactedAccessible
+    class << self
+      def included(base)
+        base.extend ClassModules
+      end
+    end
+
+    module ClassModules
+      def redacted_accessible_module_for(hash:, config:)
+        Module.new do
+          config.redacted.each do |attr|
+            unredacted_attr_method = "unredacted_#{attr}"
+            code = <<~CODE
+              def #{unredacted_attr_method}
+                "#{hash[attr]}"
+              end
+              private :#{unredacted_attr_method}
+            CODE
+            class_eval code
+          end
+        end
+      end
+    end
+  end
+end

data/lib/immutable_struct_ex_redactable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ImmutableStructExRedactable
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
 end

data/lib/immutable_struct_ex_redactable.rb

@@ -2,9 +2,12 @@
 
 require 'immutable_struct_ex'
 require_relative 'immutable_struct_ex_redactable/configuration'
+require_relative 'immutable_struct_ex_redactable/redacted_accessible'
 require_relative 'immutable_struct_ex_redactable/version'
 
 module ImmutableStructExRedactable
+  include RedactedAccessible
+
   module_function
 
   def create(**hash, &block)
@@ -13,12 +16,19 @@ module ImmutableStructExRedactable
   end
 
   def create_with(config, **hash, &block)
+    if config.redacted_unsafe?
+      redacted_private_accessible_module =
+        redacted_accessible_module_for(hash: hash, config: config)
+    end
+
     config.redacted.each do |attr|
       next unless hash.key? attr
 
       hash[attr] = config.redacted_label
     end
 
-    ImmutableStructEx.new(**hash, &block)
+    ImmutableStructEx.new(**hash, &block).tap do |struct|
+      struct.extend(redacted_private_accessible_module) if config.redacted_unsafe?
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: immutable_struct_ex_redactable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-02 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: immutable_struct_ex
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
 description: Creates and initializes an immutable struct in one step and provides
   redaction functionality.
 email:
@@ -44,9 +50,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- immutable_struct_ex_redactable.gemspec
 - lib/immutable_struct_ex_redactable.rb
 - lib/immutable_struct_ex_redactable/configuration.rb
+- lib/immutable_struct_ex_redactable/redacted_accessible.rb
 - lib/immutable_struct_ex_redactable/version.rb
 - sig/immutable_struct_ex_redactable.rbs
 homepage: https://github.com/gangelo/immutable_struct_ex_redactable

data/immutable_struct_ex_redactable.gemspec

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/immutable_struct_ex_redactable/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'immutable_struct_ex_redactable'
-  spec.version = ImmutableStructExRedactable::VERSION
-  spec.authors      = ['Gene M. Angelo, Jr.']
-  spec.email        = ['public.gma@gmail.com']
-
-  spec.summary = 'The redactable version of the immutable_stuct_ex gem.'
-  spec.description = 'Creates and initializes an immutable struct in one step and provides redaction functionality.'
-  spec.homepage = 'https://github.com/gangelo/immutable_struct_ex_redactable'
-  spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.0.1'
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/gangelo/immutable_struct_ex_redactable/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 do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  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 'immutable_struct_ex', '~> 0.3.0'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-end