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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 959f0ae7643190cc4795de334ab0d9b64fb52486b1de166ccdcfab9d50f29c78
-  data.tar.gz: c12667b6c1da8dea65ff830647828c34216d723de98c815e6628265d639e1e7b
+  metadata.gz: 1d26e42fffd5138a7fecf9273413a584f2e0bac55f0c9ec280f2ff3f2c48701b
+  data.tar.gz: 675aa580225c7edf371c0b031a9b4dba485e36c72a71ebdbc991738548eb9ae3
 SHA512:
-  metadata.gz: 5e7f7de78f617562fe35effa1162c97d5dc0b938549155ed5ff9d6223821f3380bc361956c5b78d00c5d8a2470bc6802ea8cc2a97989d0c93c880f5188d1904b
-  data.tar.gz: 8467589b50d701dd648efe7546cce5b3680f282b3545ed11f698d9424438f4721e69be95ffee7e16ef972db0f7525c83df397c2d494611155069fb6b2eb05e3a
+  metadata.gz: 45d475e3a53d156711097c0926df63c9bc89a0ad78ffb56b908e48d11b5db0cc70267ac629edd0d24c7a0835572411fce36ff08b9de021e2787a1c389a11ae7d
+  data.tar.gz: 546bd0fa0eca47a62078b7f20b0e2ed1215fad2c73dcb0367f01c25fe235e64a16c4301d0a48ff665f67ed93a293b5556e5aadeadbe1fc2911f2b419e0ee074a

data/.github/workflows/release.yml

@@ -3,9 +3,20 @@ on:
   push:
     branches:
       - master
+
+permissions:
+  contents: read
+
 jobs:
   release:
     runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+      issues: write
+      pull-requests: write
+
     steps:
       - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac
       - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
@@ -13,14 +24,11 @@ jobs:
           node-version: 20
       - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939
         with:
-          ruby-version: '3.2' # Not needed with a .ruby-version file
+          ruby-version: "3.2" # Not needed with a .ruby-version file
 
       - name: Install dependencies
         run: npm install && bundle install
 
-      - name: Build and validate gem
-        run: gem build
-
       - name: Semantic Release
         uses: cycjimmy/semantic-release-action@61680d0e9b02ff86f5648ade99e01be17f0260a4
         env:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.1.1](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v3.1.0...v3.1.1) (2024-06-14)
+
+
+### Bug Fixes
+
+* Adjust workflow permissions so it can bump version ([#85](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/85)) ([42e00ed](https://github.com/phrase/phraseapp-in-context-editor-ruby/commit/42e00ed821fb594415a1b12d3c3e3ac2c24f951f))
+
+# [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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phraseapp-in-context-editor-ruby (3.0.0)
+    phraseapp-in-context-editor-ruby (3.1.0)
       i18n (~> 1.0)
       json (~> 2.0)
       request_store (~> 1.2)

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.1"
 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.1
 platform: ruby
 authors:
 - Phrase