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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1928034119cb6375765fd9dd82f1d66c859d070482da61e647abc72ddb06d6d9
-  data.tar.gz: 96ad3d6b6a686e1dbd5104cb1f8b6663072b3879142e308978ccf89d4cbe547d
+  metadata.gz: 900986756f3ba71519a83b5168774f3fbcccde7956535ced2a907e1a1725978c
+  data.tar.gz: 33ed4e6bc473b1b456a4955f5253aeb637864fde544968051f88d95948a21666
 SHA512:
-  metadata.gz: cd71b31c0f1f454af7367d0d4d194c5889613bb83d9ea166199f8634e45edd01c76677dad2911205e1bdf2b8fd95994e7ea7f5fadcb29a68e4088f77ceee9825
-  data.tar.gz: 19189182859a08240b7cfddab04b63f35c96be6c64cd2e71f6af47010b437ec44b62206fb45ef7e55a8718cd16722b8cffb8f8b249075803f6f2f82dc5fd96a3
+  metadata.gz: 4eb5593cd10987c04b61726aa051b6c962b3b1f2bf83841f1ab0c3f80c319881cf71517f47a5f1c2ca3c73c6e4d86eca90532b87f476b887a11c3b72bdae255e
+  data.tar.gz: 0eed67e1f200e262044f3cb936f3e88c1f1bea485565345ad3a24f1f6ca34109a61b20878500f6911b12f9d69e81f2eac0b8dcfa26784dddeaf673b2008d821a

data/.github/workflows/test.yml

@@ -1,10 +1,10 @@
 name: Test
-on: [ push ]
+on: [push, pull_request]
 jobs:
   test:
     strategy:
       matrix:
-        ruby: [ 3.1, 3.2 ]
+        ruby: [3.1, 3.2]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+# [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)
+
+
+### Bug Fixes
+
+* Adjust module name to fix semantic release bumps ([#84](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/84)) ([f97ed2d](https://github.com/phrase/phraseapp-in-context-editor-ruby/commit/f97ed2d81a755fa97e3a9a908e42eb8f99e78cc2))
+
+# [3.0.0](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v2.1.2...v3.0.0) (2024-05-21)
+
+
+* BREAKING CHANGE: Use ruby 2.7 'Forward all arguments' syntax: (...) to forward arguments (#78) ([99ae28e](https://github.com/phrase/phraseapp-in-context-editor-ruby/commit/99ae28e2f6fea0ba2ba0eec6eca54a043e21d121)), closes [#78](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/78)
+
+
+### BREAKING CHANGES
+
+* Hash arguments will throw an error. Keyword arguments must be used instead.
+
+## [2.1.2](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v2.1.1...v2.1.2) (2024-05-21)
+
+
+### Bug Fixes
+
+* Ruby 3.0 keyword argument error when ICE is enabled ([#79](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/79)) ([d0efad8](https://github.com/phrase/phraseapp-in-context-editor-ruby/commit/d0efad859b83b7ac78873e012aafcac2d1856481))
+
 ## [2.1.1](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v2.1.0...v2.1.1) (2024-04-23)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    phraseapp-in-context-editor-ruby (2.1.0)
+    phraseapp-in-context-editor-ruby (3.0.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/adapters/i18n.rb

@@ -1,8 +1,8 @@
 if defined?(I18n)
   module I18n
     class << self
-      def translate_with_phraseapp(*args)
-        PhraseApp::InContextEditor.backend.translate(*args)
+      def translate_with_phraseapp(...)
+        PhraseApp::InContextEditor.backend.translate(...)
       end
       alias_method :translate_without_phraseapp, :translate
       alias_method :translate, :translate_with_phraseapp

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

@@ -3,47 +3,32 @@ require_relative "delegate/i18n_delegate"
 module PhraseApp
   module InContextEditor
     class BackendService
-      attr_accessor :blacklisted_keys
-
       def initialize(args = {})
         self
       end
 
-      def translate(*args)
-        if to_be_translated_without_phraseapp?(args)
-          # *Ruby 2.7+ keyword arguments warning*
-          #
-          # This method uses keyword arguments.
-          # There is a breaking change in ruby that produces warning with ruby 2.7 and won't work as expected with ruby 3.0
-          # The "hash" parameter must be passed as keyword argument.
-          #
-          # Good:
-          #  I18n.t(:salutation, :gender => 'w', :name => 'Smith')
-          #  I18n.t(:salutation, **{ :gender => 'w', :name => 'Smith' })
-          #  I18n.t(:salutation, **any_hash)
-          #
-          # Bad:
-          #  I18n.t(:salutation, { :gender => 'w', :name => 'Smith' })
-          #  I18n.t(:salutation, any_hash)
-          #
-          kw_args = args[1]
-          if kw_args.present?
-            I18n.translate_without_phraseapp(args[0], **kw_args)
-          else
-            I18n.translate_without_phraseapp(args[0])
-          end
+      def translate(...)
+        if to_be_translated_without_phraseapp?(...)
+          I18n.translate_without_phraseapp(...)
         else
-          phraseapp_delegate_for(args)
+          phraseapp_delegate_for(...)
         end
       end
 
       protected
 
-      def to_be_translated_without_phraseapp?(args)
-        PhraseApp::InContextEditor.disabled? || has_been_forced_to_resolve_with_phraseapp?(args)
+      def to_be_translated_without_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)
+      def has_been_forced_to_resolve_with_phraseapp?(*args)
         (args.last.is_a?(Hash) && args.last[:resolve] == false)
       end
 
@@ -51,11 +36,11 @@ module PhraseApp
         extract_normalized_key_from_args(args)
       end
 
-      def phraseapp_delegate_for(args)
+      def phraseapp_delegate_for(*args)
         key = given_key_from_args(args)
         return nil unless present?(key)
 
-        options = args[1].nil? ? {} : args[1]
+        options = options_from_args(args)
         PhraseApp::InContextEditor::Delegate::I18nDelegate.new(key, options, args)
       end
 

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/delegate/i18n_delegate.rb

@@ -4,7 +4,7 @@ module PhraseApp
   module InContextEditor
     module Delegate
       class I18nDelegate < Base
-        attr_accessor :key, :display_key, :options, :api_client, :fallback_keys, :original_args
+        attr_accessor :key, :display_key
 
         def initialize(key, options = {}, original_args = nil)
           @key = key
@@ -24,7 +24,7 @@ module PhraseApp
               data.send(*args, &block)
             else
               self.class.log "You tried to execute the missing method ##{args.first} on key #{@key} which is not supported. Please make sure you treat your translations as strings only."
-              original_translation = ::I18n.translate_without_phraseapp(*@original_args)
+              original_translation = ::I18n.translate_without_phraseapp(*@original_args, **@options)
               original_translation.send(*args, &block)
             end
           end

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

@@ -1,3 +1,3 @@
-module PhraseApp
-  VERSION = "2.1.1"
+module PhraseappInContextEditor
+  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

data/phraseapp-in-context-editor-ruby.gemspec

@@ -4,7 +4,7 @@ require "./lib/phraseapp-in-context-editor-ruby/version"
 
 Gem::Specification.new do |s|
   s.name = "phraseapp-in-context-editor-ruby"
-  s.version = PhraseApp::VERSION
+  s.version = PhraseappInContextEditor::VERSION
   s.platform = Gem::Platform::RUBY
   s.required_ruby_version = ">= 3.1.0"
   s.authors = ["Phrase"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Phrase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json