redaction 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c7c1ab9e4c83779e70bd6cc332671fd69a007281c34b4c64ea4ce309ca1eb49
-  data.tar.gz: b2c8ef0998df228f1062b91e6a3d4cff740071c3d41cb5082d34431254e2b446
+  metadata.gz: d9ba1c11cd9618292859be01f037bb64da083a5873020ea489ab07e5f54411b2
+  data.tar.gz: 85f6bc9d21d79b37a9d061d002e1fec8b00841dd135b1d40a6b1d1c5146d891d
 SHA512:
-  metadata.gz: 1ec8127de732264971eef233c3ee8366db0eb660e84b427901180729c0f5d7c253d227c3591c6a3ab403b1e930dbcf709935d224382dd4cdc79b2736fee9056e
-  data.tar.gz: 0fb500148ce2f328f96d59bf0ff497bc908a6d2641e363d9fa5e7f9d6301cc0c2a1ba429025c6986c91103d0ae70036b11198c20225921cb9b5628389ab1c853
+  metadata.gz: 29a8813e86d71875213d8ae10531ce9582a2c590c5918716339e035efbd2472b758822cb53fcafa79b356485208cdea72d64cf76d676c18761a91f92284cbe70
+  data.tar.gz: 27cbf2162fda8b3e0dc80aeecf477df6ea872adc8b6743b09c90e6153090b8707e0e85a68a96f0ca478d2d528796d7b0b9c5f99307f0d9760986aaba593deac9

data/README.md

@@ -114,6 +114,16 @@ class User < ApplicationRecord
 end
 ```
 
+### Configuration
+Redaction has the following configuration options:
+| Option       | Default      | Description  |
+|:------------|:------------|:------------|
+| `email_domain`     | `nil`  | Set to a string to use a custom domain for redacted emails. i.e. `Redaction.config.email_domain = "my-domain.dev" |
+| `progress_bar`| `true`  | Set to false to not use the built in progress bar when redacting |
+| `force_redaction`     | `false` | Set to true to alway fill a column with redacted content even if the attribute is `nil` or empty |
+
+It is reccomended that you put your configuration in an initializer like `config/initializers/redaction.rb`
+
 ## Roadmap
 - [ ] Raise Error or at least a message when skipping a passed in Model
 - [ ] Configuration (touch, email domains, etc)

data/lib/redaction/railtie.rb

@@ -12,6 +12,8 @@ module Redaction
       options = config.redaction
 
       options.email_domain = options.email_domain
+      options.progress_bar = options.key?(:progress_bar) ? options.progress_bar : true
+      options.force_redaction = options.key?(:force_redaction) ? options.force_redaction : false
 
       ActiveSupport.on_load(:active_record) do
         include Redaction::Redactable

data/lib/redaction/redactable.rb

@@ -17,7 +17,7 @@ module Redaction
           redactor = Redaction.find(redactor_type)
 
           attributes.each do |attribute|
-            if send(attribute).present?
+            if Redaction.config.force_redaction || send(attribute).present?
               send("#{attribute}=", redactor.call(self, {attribute: attribute}))
             end
           end

data/lib/redaction/redactor.rb

@@ -14,11 +14,11 @@ module Redaction
       models_to_redact.each do |model|
         next if model.redacted_attributes.empty?
 
-        model_progress = progress_bar(model.name, model.count)
+        model_progress = progress_bar(model.name, model.count) if Redaction.config.progress_bar
 
         model.all.unscoped.find_each do |record|
           record.redact!
-          model_progress.increment
+          model_progress.increment if Redaction.config.progress_bar
         end
       end
     end

data/lib/redaction/version.rb

@@ -1,3 +1,3 @@
 module Redaction
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redaction
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Drew Bragg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.20.0
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement