phraseapp-in-context-editor-ruby 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959f0ae7643190cc4795de334ab0d9b64fb52486b1de166ccdcfab9d50f29c78
-  data.tar.gz: c12667b6c1da8dea65ff830647828c34216d723de98c815e6628265d639e1e7b
+  metadata.gz: 900986756f3ba71519a83b5168774f3fbcccde7956535ced2a907e1a1725978c
+  data.tar.gz: 33ed4e6bc473b1b456a4955f5253aeb637864fde544968051f88d95948a21666
 SHA512:
-  metadata.gz: 5e7f7de78f617562fe35effa1162c97d5dc0b938549155ed5ff9d6223821f3380bc361956c5b78d00c5d8a2470bc6802ea8cc2a97989d0c93c880f5188d1904b
-  data.tar.gz: 8467589b50d701dd648efe7546cce5b3680f282b3545ed11f698d9424438f4721e69be95ffee7e16ef972db0f7525c83df397c2d494611155069fb6b2eb05e3a
+  metadata.gz: 4eb5593cd10987c04b61726aa051b6c962b3b1f2bf83841f1ab0c3f80c319881cf71517f47a5f1c2ca3c73c6e4d86eca90532b87f476b887a11c3b72bdae255e
+  data.tar.gz: 0eed67e1f200e262044f3cb936f3e88c1f1bea485565345ad3a24f1f6ca34109a61b20878500f6911b12f9d69e81f2eac0b8dcfa26784dddeaf673b2008d821a

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.1.0](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v3.0.1...v3.1.0) (2024-06-14)
+
+
+### Features
+
+* Add config option to ignore keys ([#82](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/82)) ([657b9f3](https://github.com/phrase/phraseapp-in-context-editor-ruby/commit/657b9f3ebce1ca2a364af1b9b84b0b28ee733983))
+
 ## [3.0.1](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v3.0.0...v3.0.1) (2024-06-14)
 
 

data/lib/generators/phraseapp_in_context_editor/templates/phraseapp_in_context_editor.rb

@@ -9,6 +9,10 @@ PhraseApp::InContextEditor.configure do |config|
   config.account_id = "<%= options[:account_id] %>"
   config.datacenter = "eu"
 
+  # Configure an array of key names that should not be handled
+  # by the In-Context-Editor.
+  # config.ignored_keys = ["number.*", "foo.bar"]
+
   # Phrase uses decorators to generate a unique identification key
   # in context of your document. However, this might result in conflicts
   # with other libraries (e.g. client-side template engines) that use a similar syntax.

data/lib/phraseapp-in-context-editor-ruby/backend_service.rb

@@ -3,8 +3,6 @@ require_relative "delegate/i18n_delegate"
 module PhraseApp
   module InContextEditor
     class BackendService
-      attr_accessor :blacklisted_keys
-
       def initialize(args = {})
         self
       end
@@ -20,7 +18,14 @@ module PhraseApp
       protected
 
       def to_be_translated_without_phraseapp?(...)
-        PhraseApp::InContextEditor.disabled? || has_been_forced_to_resolve_with_phraseapp?(...)
+        PhraseApp::InContextEditor.disabled? || ignored_key?(...) || has_been_forced_to_resolve_with_phraseapp?(...)
+      end
+
+      def ignored_key?(*args)
+        key = given_key_from_args(args)
+        PhraseApp::InContextEditor.ignored_keys.any? do |ignored_key|
+          key.to_s[/\A#{ignored_key.gsub("*", ".*")}\Z/]
+        end
       end
 
       def has_been_forced_to_resolve_with_phraseapp?(*args)

data/lib/phraseapp-in-context-editor-ruby/config.rb

@@ -9,7 +9,8 @@ module PhraseApp
         backend: PhraseApp::InContextEditor::BackendService.new,
         prefix: "{{__",
         suffix: "__}}",
-        origin: "in-context-editor-ruby"
+        origin: "in-context-editor-ruby",
+        ignored_keys: []
       }.freeze
 
       CONFIG_OPTIONS.each do |option, default_value|

data/lib/phraseapp-in-context-editor-ruby/version.rb

@@ -1,3 +1,3 @@
 module PhraseappInContextEditor
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/lib/phraseapp-in-context-editor-ruby.rb

@@ -37,6 +37,10 @@ module PhraseApp
         config.datacenter
       end
 
+      def ignored_keys
+        config.ignored_keys
+      end
+
       def enabled=(value)
         config.enabled = value
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Phrase