easyop 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b880af1b623158d3acfac130198bd96ce8c268195fd073554283738a880a45a
-  data.tar.gz: 0c4f5554b456ac252b13734d0964155e2a80909e81946e28f89c529cc60f9081
+  metadata.gz: c649ea27731299fcf70421b41e0a19cca45612aa621310bf1bb87a70f5100da6
+  data.tar.gz: 7589af6ce926df84ccafb1df8b705430aaabc82b0929a0b9d8ed9bb4b7db818d
 SHA512:
-  metadata.gz: c408d6d42a357ba1a6df4da21e13a7b0498d36fa4252e86c68aff289e8843d94d056c430f654f023e6d801ee650fc1bc4c400cb6d058a6b209129e1fbda644fd
-  data.tar.gz: e89087c84c8fbc77abe96b6713a144dd34b78c2cfd35066f28a14e37516f0e7ae8b0f0cbbcfe0ca9eb9de646c7890552b64d7d2848c9976ff6f51637531a4a8a
+  metadata.gz: fc1a7e1c0427da2abb6588c61ece675431708b3b2a2bb623e62356ebfb6edf69025f6c13004ef6967d62f9381cb6c003793958f1c98326c34ba6266a9a56f774
+  data.tar.gz: d40f2a49035f449f95bfcefaae66dacc6c4d2e015d03d66c88f5f74e1680f8d7713d3f079ece4011d77ea238fc6181cf7072fbfe651a4be9be0876e5c8839eb2

data/CHANGELOG.md

@@ -7,6 +7,43 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.5] — 2026-04-14
+
+### Added
+
+- **`scrub_params` DSL for `Easyop::Plugins::Recording`** — declare additional params keys/patterns to scrub from `params_data` on a per-class basis. Accepts `Symbol`, `String`, or `Regexp`. Additive with `SCRUBBED_KEYS` and never replaces the built-in list. Inherited by subclasses; any level of the hierarchy can override.
+
+  ```ruby
+  class ApplicationOperation < ...
+    scrub_params :api_token, /access.?key/i
+  end
+
+  class Orders::CreateOrder < ApplicationOperation
+    scrub_params :card_number   # stacks on top of parent's scrub list
+  end
+  ```
+
+- **`scrub_keys:` option on `plugin Easyop::Plugins::Recording`** — supply a list of extra keys/patterns to scrub at plugin install time. Inherited by all classes that share the same `plugin` declaration.
+
+  ```ruby
+  plugin Easyop::Plugins::Recording,
+         model: OperationLog,
+         scrub_keys: [:stripe_token, /secret/i]
+  ```
+
+- **`Easyop::Configuration#recording_scrub_keys`** — new global config key. Set once at boot and every recorded operation will scrub these keys in addition to `SCRUBBED_KEYS` and any class-level declarations. Accepts `Symbol`, `String`, or `Regexp`.
+
+  ```ruby
+  Easyop.configure do |c|
+    c.recording_scrub_keys = [:api_token, /token/i]
+  end
+  ```
+
+  **Scrub precedence (all layers are additive):**
+  1. `SCRUBBED_KEYS` — always applied (built-in list)
+  2. `Easyop.config.recording_scrub_keys` — global config
+  3. `scrub_keys:` plugin option + `scrub_params` DSL — class hierarchy
+
 ## [0.1.4] — 2026-04-14
 
 ### Added
@@ -258,6 +295,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `examples/easyop_test_app/` — full Rails 8 blog application demonstrating all features in real-world code
 - `examples/usage.rb` — 13 runnable plain-Ruby examples
 
-[Unreleased]: https://github.com/pniemczyk/easyop/compare/v0.1.4...HEAD
+[Unreleased]: https://github.com/pniemczyk/easyop/compare/v0.1.5...HEAD
+[0.1.5]: https://github.com/pniemczyk/easyop/compare/v0.1.4...v0.1.5
 [0.1.4]: https://github.com/pniemczyk/easyop/compare/v0.1.3...v0.1.4
 [0.1.3]: https://github.com/pniemczyk/easyop/compare/v0.1.2...v0.1.3

data/README.md

@@ -647,6 +647,7 @@ end
 | `model:` | required | ActiveRecord class to write logs into |
 | `record_params:` | `true` | Set `false` to skip serializing ctx params |
 | `record_result:` | `nil` | Plugin-level default for result capture (Hash/Proc/Symbol — see below) |
+| `scrub_keys:` | `[]` | Extra keys/patterns to scrub from `params_data` (Symbol, String, Regexp) — additive with built-in list |
 
 **Required model columns:**
 
@@ -696,7 +697,28 @@ root_log = OperationLog.find_by(operation_name: "FullCheckout", parent_reference
 OperationLog.for_tree(root_log.root_reference_id)
 ```
 
-The plugin automatically scrubs these keys from `params_data` before persisting: `:password`, `:password_confirmation`, `:token`, `:secret`, `:api_key`. ActiveRecord objects are serialized as `{ id:, class: }` rather than their full representation.
+**Scrubbing params** — all layers are additive (none replaces the built-in list):
+
+1. **Built-in `SCRUBBED_KEYS`** — always applied: `:password`, `:password_confirmation`, `:token`, `:secret`, `:api_key`
+2. **Global config** — applied to every recorded operation:
+   ```ruby
+   Easyop.configure { |c| c.recording_scrub_keys = [:api_token, /token/i] }
+   ```
+3. **Plugin `scrub_keys:` option** — applied to all subclasses that share the plugin install:
+   ```ruby
+   plugin Easyop::Plugins::Recording, model: OperationLog, scrub_keys: [:stripe_secret]
+   ```
+4. **`scrub_params` DSL** — per-class, inheritable, and stackable at any level of the hierarchy:
+   ```ruby
+   class ApplicationOperation < ...
+     scrub_params :internal_token, /access.?key/i
+   end
+   class Payments::ChargeCard < ApplicationOperation
+     scrub_params :card_number   # stacks on top of parent's list
+   end
+   ```
+
+Internal tracing keys (`__recording_*`) are always excluded. ActiveRecord objects are serialized as `{ id:, class: }` rather than their full representation.
 
 **`record_result` DSL — capture output data:**
 
@@ -1459,7 +1481,7 @@ Edit `lib/easyop/version.rb` and increment the version string following [Semanti
 ```ruby
 # lib/easyop/version.rb
 module Easyop
-  VERSION = "0.1.4"   # was 0.1.3
+  VERSION = "0.1.5"   # was 0.1.4
 end
 ```
 
@@ -1470,45 +1492,45 @@ In `CHANGELOG.md`, move everything under `[Unreleased]` into a new versioned sec
 ```markdown
 ## [Unreleased]
 
-## [0.1.4] — YYYY-MM-DD   # ← new section
+## [0.1.5] — YYYY-MM-DD   # ← new section
 
 ### Added
 - …
 
-## [0.1.3] — 2026-04-14
+## [0.1.4] — 2026-04-14
 ```
 
 Add a comparison link at the bottom of the file:
 
 ```markdown
-[Unreleased]: https://github.com/pniemczyk/easyop/compare/v0.1.4...HEAD
+[Unreleased]: https://github.com/pniemczyk/easyop/compare/v0.1.5...HEAD
+[0.1.5]: https://github.com/pniemczyk/easyop/compare/v0.1.4...v0.1.5
 [0.1.4]: https://github.com/pniemczyk/easyop/compare/v0.1.3...v0.1.4
-[0.1.3]: https://github.com/pniemczyk/easyop/compare/v0.1.2...v0.1.3
 ```
 
 ### 3. Commit the release changes
 
 ```bash
 git add lib/easyop/version.rb CHANGELOG.md
-git commit -m "Release v0.1.4"
+git commit -m "Release v0.1.5"
 ```
 
 ### 4. Tag the commit
 
 ```bash
-git tag -a v0.1.4 -m "Release v0.1.4"
+git tag -a v0.1.5 -m "Release v0.1.5"
 ```
 
 ### 5. Push the commit and tag
 
 ```bash
 git push origin master
-git push origin v0.1.4
+git push origin v0.1.5
 ```
 
 ### 6. Build and push the gem (optional)
 
 ```bash
 gem build easyop.gemspec
-gem push easyop-0.1.4.gem
+gem push easyop-0.1.5.gem
 ```

data/lib/easyop/configuration.rb

@@ -15,10 +15,19 @@ module Easyop
     #   Easyop.configure { |c| c.event_bus = :active_support }
     attr_accessor :event_bus
 
+    # Extra keys to scrub from params_data across all recorded operations.
+    # Appended to Recording::SCRUBBED_KEYS — never replaces the built-in list.
+    # Accepts Symbol, String, or Regexp (matched against the stringified key name).
+    #
+    # @example
+    #   Easyop.configure { |c| c.recording_scrub_keys = [:api_token, /token/i] }
+    attr_accessor :recording_scrub_keys
+
     def initialize
-      @type_adapter = :native
-      @strict_types = false
-      @event_bus    = nil  # nil = Memory bus (see Easyop::Events::Registry)
+      @type_adapter         = :native
+      @strict_types         = false
+      @event_bus            = nil  # nil = Memory bus (see Easyop::Events::Registry)
+      @recording_scrub_keys = []
     end
   end
 

data/lib/easyop/plugins/recording.rb

@@ -38,8 +38,10 @@ module Easyop
     #   model:         (required) ActiveRecord class
     #   record_params: true       pass false to skip params serialization
     #   record_result: nil        configure result capture at plugin level (Hash/Proc/Symbol)
+    #   scrub_keys:    []         additional keys/patterns to scrub from params_data
+    #                             (Symbol, String, or Regexp — additive with SCRUBBED_KEYS)
     module Recording
-      # Sensitive keys scrubbed from params_data before persisting.
+      # Sensitive keys always scrubbed from params_data before persisting.
       SCRUBBED_KEYS = %i[password password_confirmation token secret api_key].freeze
 
       # Internal ctx keys used for flow tracing — excluded from params_data.
@@ -49,12 +51,13 @@ module Easyop
         __recording_parent_reference_id
       ].freeze
 
-      def self.install(base, model:, record_params: true, record_result: nil, **_options)
+      def self.install(base, model:, record_params: true, record_result: nil, scrub_keys: [], **_options)
         base.extend(ClassMethods)
         base.prepend(RunWrapper)
         base.instance_variable_set(:@_recording_model,         model)
         base.instance_variable_set(:@_recording_record_params,  record_params)
         base.instance_variable_set(:@_recording_record_result,  record_result)
+        base.instance_variable_set(:@_recording_scrub_keys,     Array(scrub_keys))
       end
 
       module ClassMethods
@@ -109,6 +112,32 @@ module Easyop
             nil
           end
         end
+
+        # DSL to declare additional keys/patterns to scrub from params_data.
+        # Accepts Symbol, String, or Regexp. Additive with SCRUBBED_KEYS and
+        # any scrub_keys declared on parent classes or at the plugin install level.
+        #
+        # @example
+        #   class ApplicationOperation < ...
+        #     scrub_params :api_token, /access.?key/i
+        #   end
+        def scrub_params(*keys)
+          @_recording_scrub_keys = _own_recording_scrub_keys + keys
+        end
+
+        # Returns the merged scrub list: parent class keys + this class's own keys.
+        # Does NOT include SCRUBBED_KEYS or the global config list — those are
+        # merged at persist time so they stay hot-reloadable.
+        def _recording_scrub_keys
+          parent = superclass.respond_to?(:_recording_scrub_keys) ? superclass._recording_scrub_keys : []
+          parent + _own_recording_scrub_keys
+        end
+
+        private
+
+        def _own_recording_scrub_keys
+          instance_variable_defined?(:@_recording_scrub_keys) ? @_recording_scrub_keys : []
+        end
       end
 
       module RunWrapper
@@ -182,14 +211,35 @@ module Easyop
         end
 
         def _recording_safe_params(ctx)
+          # Merge all scrub layers (additive, never replaces built-ins):
+          #   1. SCRUBBED_KEYS          — built-in sensitive keys, always applied
+          #   2. Easyop.config          — global extra keys set in an initializer
+          #   3. self.class             — plugin install scrub_keys: + class scrub_params DSL
+          extra = Easyop.config.recording_scrub_keys.to_a + self.class._recording_scrub_keys
           ctx.to_h
-             .except(*SCRUBBED_KEYS, *INTERNAL_CTX_KEYS)
+             .except(*INTERNAL_CTX_KEYS)
+             .reject { |k, _| _recording_scrub_key?(k, extra) }
              .transform_values { |v| v.is_a?(ActiveRecord::Base) ? { id: v.id, class: v.class.name } : v }
              .to_json
         rescue
           nil
         end
 
+        # Returns true when +key+ matches any entry in +scrub_list+.
+        # Regexp entries match against the stringified key name (case-sensitive
+        # unless the Regexp itself uses /i). Symbol/String entries match by value.
+        def _recording_scrub_key?(key, extra_list)
+          return true if SCRUBBED_KEYS.include?(key.to_sym)
+
+          extra_list.any? do |pattern|
+            case pattern
+            when Regexp then pattern.match?(key.to_s)
+            when Symbol then pattern == key.to_sym
+            else             pattern.to_s == key.to_s
+            end
+          end
+        end
+
         def _recording_safe_result(ctx)
           config = self.class._recording_record_result_config
           return nil unless config

data/lib/easyop/version.rb

@@ -1,3 +1,3 @@
 module Easyop
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easyop
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Pawel Niemczyk