immutable_struct_ex_redactable 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 163f8c7094c8255005b9ff1912d6993707e756024f652c2c78a29fec22a2d6cb
-  data.tar.gz: 05dbd70e92271dfe52a049a404c0c15afb962b584fd18d4c9b7a2823c03d7ce6
+  metadata.gz: 321fc8418eb84c3fa0c62cb687e6811c2584c7f6a30575244b0b0468185bfbf3
+  data.tar.gz: dfeae468c5bdc53aaf6872e247c92bac995a736434ee0eff32acfb1a8970ad20
 SHA512:
-  metadata.gz: 443ce94ada0122523164187c162a422816c5142455eecbe0831ef3b196fbf3d4c7919679b2dd8ebcee402a4099ada92c04feda2653c3d49b835390b6474aec07
-  data.tar.gz: 6ef92da7762b45fb9f99097a46d42de9ccf70c58868950e333a11526577251d1142993162c614d18a7d8a05b237d16cb7b8b17a1836418aa760da41a86ea3cec
+  metadata.gz: 38f3992c16fd65c313a95988ac4dd76cba8c8765d9cba60b91fa97f94845f988c83c081ee8d4fa091946b3731c34935e91e2a1ccb7542dff1fe2319a47d867ac
+  data.tar.gz: 81a4e7d9caad199dcf5a207321ae1ba3f8122cb295cf3f396ca5c113e7ceb08565f327aea2ccbc57d858d60db5d53c39b2cdc718a5399f6d227fc913d9d9409b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
-## [1.0.0] - 2022-10-02
+## [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
 
-- Initial release
+## [1.0.0] - 2022-10-02
+* Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    immutable_struct_ex_redactable (1.0.0)
+    immutable_struct_ex_redactable (1.2.0)
       immutable_struct_ex (~> 0.3.0)
 
 GEM

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/immutable_struct_ex_redactable.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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 and provides redaction.'
+  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'

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.0.0'
+  VERSION = '1.2.0'
 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.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-02 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: immutable_struct_ex
@@ -24,7 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
-description: Creates and initializes an immutable struct in one and provides redaction.
+description: Creates and initializes an immutable struct in one step and provides
+  redaction functionality.
 email:
 - public.gma@gmail.com
 executables: []
@@ -46,6 +47,7 @@ files:
 - 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