top_secret 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cef5c9c267dd71870fd244408a3f9a020d19978381810f99e7ed5defc67f12a7
-  data.tar.gz: ec20793792721a47371cc6a7cf3c687ad4284b9c9f1f9b14c57e002118c5532a
+  metadata.gz: c6f07bbe9856d60d42dc7b7e334c734b6613db3601461d70821ac1933d094961
+  data.tar.gz: 630437ccebb58c67b2e6b85adf3f32043aed2bd87c5a438c0152ceff6187fb27
 SHA512:
-  metadata.gz: 0eea9a1087e5082e245b73cdbb434543dbfcff277b6d58b7a89e463b1162215e0058f5190df3863a73fd32223fdf42fa65a253781193ea7e44ecc6b68c359e45
-  data.tar.gz: 6626056578ec3feecf27d843a994f782c144b363a6b7473e6e0be0fa80044c2283c329ae068c4f0f66af13f021743039864e13f220174489bd822e0c162872a7
+  metadata.gz: f973d27a7df49c7e30b3d715ebb1bd0cc6a9e42803bbf023bb24ac91f74814a418f088aa03ea32e4159b0e3650cbc4d62a705c67c494490046b78f8cec85a155
+  data.tar.gz: 5aedf48c31dd3132ef8a7151f26dbfe09e6ef4e005839f5b0e0e09ffdd9fd21956cd814b328381bc36da252552f5736835d1ee6f7dfe831795d9bbf7016975eb

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.4.0] - 2025-10-31
+
+### Added
+
+-   Added automatic caching of MITIE NER model to improve performance by avoiding expensive reinitialization
+-   Added `TopSecret::Text.clear_model_cache!` method to clear the cached model when needed
+
 ## [0.3.0] - 2025-09-19
 
 ### Added

data/README.md

@@ -568,6 +568,16 @@ TopSecret.configure do |config|
 end
 ```
 
+### Model caching
+
+The MITIE NER model is automatically cached after the first initialization to avoid expensive reloading. All `TopSecret::Text` instances share the same cached model, significantly improving performance.
+
+If you need to clear the cache (e.g., after changing the model path), use:
+
+```ruby
+TopSecret::Text.clear_model_cache!
+```
+
 ### Disabling NER filtering
 
 For improved performance or when the MITIE model file cannot be deployed, you can disable NER-based filtering entirely. This will disable people and location detection but retain all regex-based filters (credit cards, emails, phone numbers, SSNs):

data/lib/top_secret/text.rb

@@ -10,6 +10,36 @@ require_relative "text/global_mapping"
 module TopSecret
   # Processes text to identify and redact sensitive information using configured filters.
   class Text
+    @mutex = Mutex.new
+
+    class << self
+      # Returns a cached MITIE model instance to avoid expensive reinitialization
+      #
+      # @return [Mitie::NER, NullModel] The cached model instance
+      def shared_model
+        return @shared_model if @shared_model
+
+        @mutex.synchronize do
+          return @shared_model if @shared_model
+
+          @shared_model = if TopSecret.model_path
+            Mitie::NER.new(TopSecret.model_path)
+          else
+            NullModel.new
+          end
+        end
+      end
+
+      # Clears the cached model, forcing reinitialization on next access
+      #
+      # @return [void]
+      def clear_model_cache!
+        @mutex.synchronize do
+          @shared_model = nil
+        end
+      end
+    end
+
     # @param input [String] The original text to be filtered
     # @param filters [Hash, nil] Optional set of filters to override the defaults
     # @param custom_filters [Array] Additional custom filters to apply
@@ -224,15 +254,11 @@ module TopSecret
     end
 
     # Creates the default model based on configuration.
-    # Returns a MITIE NER model if a model path is configured, otherwise returns a null model.
+    # Returns the cached shared model to avoid expensive reinitialization.
     #
     # @return [Mitie::NER, NullModel] The model instance to use for NER processing
     def default_model
-      if TopSecret.model_path
-        Mitie::NER.new(TopSecret.model_path)
-      else
-        NullModel.new
-      end
+      Text.shared_model
     end
   end
 end

data/lib/top_secret/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module TopSecret
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
   MINIMUM_RAILS_VERSION = ">= 7.0.8"
   MAXIMUM_RAILS_VERSION = "< 9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: top_secret
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Steve Polito
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Filter sensitive information from free text.
 test_files: []