phraseapp-in-context-editor-ruby 1.3.1 → 2.0.0

data/config/license_finder.yml

@@ -0,0 +1,2 @@
+---
+decisions_file: './config/license-decisions.yml'

data/lib/generators/phraseapp_in_context_editor/install_generator.rb

@@ -1,21 +1,15 @@
-# -*- encoding : utf-8 -*-
-
 module PhraseappInContextEditor
   module Generators
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../templates", __FILE__)
 
-      desc "Creates a PhraseApp In-Context-Editor initializer for your application."
-      class_option :access_token, type: :string, desc: "Your PhraseApp access token", required: true
-      class_option :project_id, type: :string, desc: "Your PhraseApp project id", required: true
+      desc "Creates a Phrase In-Context-Editor initializer for your application."
+      class_option :account_id, type: :string, desc: "Your Phrase account id", required: true
+      class_option :project_id, type: :string, desc: "Your Phrase project id", required: true
 
       def copy_initializer
         template "phraseapp_in_context_editor.rb", "config/initializers/phraseapp_in_context_editor.rb"
       end
-
-      def show_readme
-        readme "README" if behavior == :invoke
-      end
     end
   end
 end

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

@@ -2,26 +2,18 @@ PhraseApp::InContextEditor.configure do |config|
   # Enable or disable the In-Context-Editor in general
   config.enabled = true
 
-  # Fetch your project id after creating your first project
-  # in Translation Center.
-  # You can find the project id in your project settings
-  # page (https://phraseapp.com/projects)
+  # Configure with your project id and account id. You can find the
+  # project id in your project settings and account id in your account
+  # settings (https://app.phrase.com/)
   config.project_id = "<%= options[:project_id] %>"
+  config.account_id = "<%= options[:account_id] %>"
+  config.datacenter = "eu"
 
-  # You can create and manage access tokens in your profile settings
-  # in Translation Center or via the Authorizations API
-  # (https://developers.phraseapp.com/api/#authorizations).
-  config.access_token = "<%= options[:access_token] %>"
-
-  # Configure an array of key names that should not be handled
-  # by the In-Context-Editor.
-  config.ignored_keys = ["number.*", "breadcrumb.*"]
-
-  # PhraseApp uses decorators to generate a unique identification key
+  # 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.
   # If you encounter this problem, you might want to change this decorator pattern.
-  # More information: https://help.phraseapp.com/phraseapp-for-developers/how-to-setup-and-configure-the-phraseapp-in-context-editor-ice/configure-in-context-editor
-  # config.prefix = "{{__"
-  # config.suffix = "__}}"
+  # More information: https://help.phrase.com/hc/en-us/articles/5784095916188-In-Context-Editor-Strings-
+  # config.prefix = "[[__"
+  # config.suffix = "__]]"
 end

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

@@ -1,25 +1,25 @@
-# -*- encoding : utf-8 -*-
+require "phraseapp-in-context-editor-ruby/delegate/fast_gettext"
 
-require 'phraseapp-in-context-editor-ruby/delegate/fast_gettext'
+if defined? FastGettext::Translation
+  module FastGettext
+    module Translation
+      def __with_phraseapp(*args)
+        PhraseApp::InContextEditor::Delegate::FastGettext.new(:_, *args)
+      end
+      alias_method :__without_phraseapp, :_
+      alias_method :_, :__with_phraseapp
 
-module FastGettext
-  module Translation
-    def __with_phraseapp(*args)
-      PhraseApp::InContextEditor::Delegate::FastGettext.new(:_, *args)
-    end
-    alias_method :__without_phraseapp, :_
-    alias_method :_, :__with_phraseapp
-
-    def n__with_phraseapp(*args)
-      PhraseApp::InContextEditor::Delegate::FastGettext.new(:n_, *args)
-    end
-    alias_method :n__without_phraseapp, :n_
-    alias_method :n_, :n__with_phraseapp
+      def n__with_phraseapp(*args)
+        PhraseApp::InContextEditor::Delegate::FastGettext.new(:n_, *args)
+      end
+      alias_method :n__without_phraseapp, :n_
+      alias_method :n_, :n__with_phraseapp
 
-    def s__with_phraseapp(*args)
-      PhraseApp::InContextEditor::Delegate::FastGettext.new(:s_, *args)
+      def s__with_phraseapp(*args)
+        PhraseApp::InContextEditor::Delegate::FastGettext.new(:s_, *args)
+      end
+      alias_method :s__without_phraseapp, :s_
+      alias_method :s_, :s__with_phraseapp
     end
-    alias_method :s__without_phraseapp, :s_
-    alias_method :s_, :s__with_phraseapp
   end
-end if defined? FastGettext::Translation
+end

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

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

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

@@ -1,11 +1,8 @@
-# -*- encoding : utf-8 -*-
-require 'phraseapp-in-context-editor-ruby/api_collection'
-require 'phraseapp-in-context-editor-ruby/delegate/i18n_delegate'
+require_relative "delegate/i18n_delegate"
 
 module PhraseApp
   module InContextEditor
     class BackendService
-
       attr_accessor :blacklisted_keys
 
       def initialize(args = {})
@@ -14,53 +11,46 @@ module PhraseApp
 
       def translate(*args)
         if to_be_translated_without_phraseapp?(args)
-          I18n.translate_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
         else
           phraseapp_delegate_for(args)
         end
       end
 
-    protected
-      def to_be_translated_without_phraseapp?(args)
-        PhraseApp::InContextEditor.disabled? or has_been_given_blacklisted_key?(args) or has_been_given_ignored_key?(args) or has_been_forced_to_resolve_with_phraseapp?(args)
-      end
+      protected
 
-      def has_been_given_blacklisted_key?(args)
-        key = given_key_from_args(args)
-        has_blacklist_entry_for_key?(key)
-      end
-
-      def has_been_given_ignored_key?(args)
-        key = given_key_from_args(args)
-        key_is_ignored?(key)
+      def to_be_translated_without_phraseapp?(args)
+        PhraseApp::InContextEditor.disabled? || has_been_forced_to_resolve_with_phraseapp?(args)
       end
 
       def has_been_forced_to_resolve_with_phraseapp?(args)
-        (args.last.is_a?(Hash) and args.last[:resolve] == false)
+        (args.last.is_a?(Hash) && args.last[:resolve] == false)
       end
 
       def given_key_from_args(args)
         extract_normalized_key_from_args(args)
       end
 
-      def has_blacklist_entry_for_key?(key)
-        blacklisted_keys.each do |blacklisted_key|
-          return true if present?(key.to_s[/\A#{blacklisted_key.gsub("*", ".*")}\Z/])
-        end
-        false
-      end
-
-      def key_is_ignored?(key)
-        PhraseApp::InContextEditor.ignored_keys.each do |ignored_key|
-          return true if present?(key.to_s[/\A#{ignored_key.gsub("*", ".*")}\Z/])
-        end
-        false
-      end
-
-      def blacklisted_keys
-        @blacklisted_keys ||= api_wrapper.blacklisted_keys
-      end
-
       def phraseapp_delegate_for(args)
         key = given_key_from_args(args)
         return nil unless present?(key)
@@ -75,15 +65,14 @@ module PhraseApp
       end
 
       def transform_args(args)
-        duped_args = args.map { |item| (item.is_a?(Symbol) or item.nil?) ? item : item.dup }
-        transform_args_based_on_caller(duped_args)
+        duped_args = args.map { |item| (item.is_a?(Symbol) || item.nil?) ? item : item.dup }
       end
 
       def normalized_key(duped_args)
         splitted_args = split_args(duped_args)
         key = I18n::Backend::Flatten.normalize_flat_keys(*splitted_args)
         key.gsub!("..", ".")
-        key.gsub!(/^\./, '')
+        key.gsub!(/^\./, "")
         key
       end
 
@@ -91,77 +80,21 @@ module PhraseApp
         options = options_from_args(args)
         key ||= args.shift
         locale = options.delete(:locale) || I18n.locale
-        return [locale, key, options[:scope], nil]
+        [locale, key, options[:scope], nil]
       end
 
       def options_from_args(args)
         args.last.is_a?(Hash) ? args.pop : {}
       end
 
-      def transform_args_based_on_caller(args)
-        translation_caller = identify_caller
-
-        if translation_caller and args.first =~ /^\./
-          options = options_from_args(args)
-
-          if not present?(options[:scope]) and present?(translation_caller)
-            options[:scope] = translation_caller
-          end
-
-          args.push(options)
-          parts = args.first.to_s.split(".").select { |e| not blank?(e) }
-          args[0] = parts[0] if parts.size == 1
-        end
-
-        args
-      end
-
-      def identify_caller
-        translation_caller = nil
-        send(:caller)[0..6].each do |intermediate_caller|
-          translation_caller = calling_template(intermediate_caller) unless translation_caller
-        end
-
-        if present?(translation_caller)
-          find_lookup_scope(translation_caller)
-        else
-          nil
-        end
-      end
-
-      def calling_template(string)
-        string.match(/(views)(\/.+)(?>:[0-9]+:in)/)
-      end
-
       def blank?(str)
-        raise "blank?(str) can only be given a String or nil" unless str.is_a?(String) or str.nil?
-        str.nil? or str == ''
+        raise "blank?(str) can only be given a String or nil" unless str.is_a?(String) || str.nil?
+        str.nil? || str == ""
       end
 
       def present?(str)
-        raise "present?(str) can only be given a String or nil" unless str.is_a?(String) or str.nil?
-        not blank?(str)
-      end
-
-      def find_lookup_scope(caller)
-        split_path = caller[2][1..-1].split(".")[0].split("/")
-
-        template_or_partial = remove_underscore_form_partial(split_path[-1])
-        split_path[-1] = template_or_partial
-
-        split_path.map!(&:to_sym)
-      end
-
-      def remove_underscore_form_partial(template_or_partial)
-        if template_or_partial.to_s[0,1] == "_"
-          template_or_partial.to_s[1..-1]
-        else
-          template_or_partial.to_s
-        end
-      end
-
-      def api_wrapper
-        @api_wrapper ||= PhraseApp::InContextEditor::ApiWrapper.new
+        raise "present?(str) can only be given a String or nil" unless str.is_a?(String) || str.nil?
+        !blank?(str)
       end
     end
   end

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

@@ -1,62 +1,39 @@
-# -*- encoding : utf-8 -*-
 module PhraseApp
   module InContextEditor
     class Config
       CONFIG_OPTIONS = {
+        account_id: nil,
         project_id: nil,
-        access_token: nil,
+        datacenter: "eu",
         enabled: false,
-        skip_ssl_verification: false,
         backend: PhraseApp::InContextEditor::BackendService.new,
         prefix: "{{__",
-        suffix: "__}}",
-        api_host: "https://api.phrase.com",
-        js_host: "phraseapp.com",
-        js_use_ssl: true,
-        js_path: "/assets/in-context-editor/2.0/app.js",
-        js_options: {},
-        cache_key_segments_initial: ["simple_form"],
-        cache_lifetime: 300,
-        ignored_keys: [],
+        suffix: "__}}"
       }.freeze
 
-      CONFIG_OPTIONS_GLOBAL_ONLY = [
-        :access_token,
-        :skip_ssl_verification,
-        :api_host
-      ].freeze
-
       CONFIG_OPTIONS.each do |option, default_value|
-        class_eval "@@#{option} = CONFIG_OPTIONS[:#{option}]"
+        class_eval "@@#{option} = CONFIG_OPTIONS[:#{option}]", __FILE__, __LINE__
 
         define_method("#{option}=") do |value|
-          instance_eval "@#{option} = value; self.class.invalidate_api_client"
-        end unless CONFIG_OPTIONS_GLOBAL_ONLY.include?(option)
+          instance_eval "@#{option} = value", __FILE__, __LINE__
+        end
 
-        define_method("#{option}") do
-          instance_eval "defined?(@#{option}) ? @#{option} : self.class.#{option}"
+        define_method(option.to_s) do
+          instance_eval "defined?(@#{option}) ? @#{option} : self.class.#{option}", __FILE__, __LINE__
         end
 
         define_singleton_method("#{option}=") do |value|
-          instance_eval "@@#{option} = value; invalidate_api_client"
+          instance_eval "@@#{option} = value", __FILE__, __LINE__
         end
 
-        define_singleton_method("#{option}") do
-          instance_eval "@@#{option}"
+        define_singleton_method(option.to_s) do
+          instance_eval "@@#{option}", __FILE__, __LINE__
         end
       end
 
-      def self.api_client
-        @@api_client ||= build_api_client
-      end
-
-      def api_client
-        self.class.api_client
-      end
-
-      def assign_values(config_options={})
+      def assign_values(config_options = {})
         config_options.each do |config_option, value|
-          self.send("#{config_option}=", value)
+          send("#{config_option}=", value)
         end
       end
 
@@ -65,20 +42,6 @@ module PhraseApp
           send("#{option}=", default_value)
         end
       end
-
-    protected
-      def self.invalidate_api_client
-        @@api_client = nil
-      end
-
-      def self.build_api_client
-        credentials = PhraseApp::Auth::Credentials.new(
-          token: @@access_token,
-          host: @@api_host,
-          skip_ssl_verification: @@skip_ssl_verification
-        )
-        PhraseApp::Client.new(credentials)
-      end
     end
   end
 end

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

@@ -1,6 +1,4 @@
-# -*- encoding : utf-8 -*-
-
-require 'phraseapp-in-context-editor-ruby/delegate'
+require_relative "../delegate"
 
 module PhraseApp
   module InContextEditor
@@ -12,20 +10,20 @@ module PhraseApp
           @display_key = params[:msgid]
         end
 
-      private
+        private
+
         def params_from_args(args)
-          params = case @method
-            when :_
-              {msgid: args.first}
-            when :n_
-              {msgid: args.first, msgid_plural: args[1], count: args.last}
-            when :s_
-              {msgid: args.first}
-            else
-              self.class.log("Unsupported FastGettext method #{@method}")
-              {}
+          case @method
+          when :_
+            {msgid: args.first}
+          when :n_
+            {msgid: args.first, msgid_plural: args[1], count: args.last}
+          when :s_
+            {msgid: args.first}
+          else
+            self.class.log("Unsupported FastGettext method #{@method}")
+            {}
           end
-          params
         end
       end
     end

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

@@ -1,12 +1,4 @@
-# -*- encoding : utf-8 -*-
-
-require 'phraseapp-in-context-editor-ruby/cache'
-require 'phraseapp-in-context-editor-ruby/hash_flattener'
-require 'phraseapp-in-context-editor-ruby/delegate'
-require 'phraseapp-in-context-editor-ruby/api_wrapper'
-require 'phraseapp-in-context-editor-ruby/displayable_key_identifier'
-
-require 'set'
+require_relative "../delegate"
 
 module PhraseApp
   module InContextEditor
@@ -14,11 +6,11 @@ module PhraseApp
       class I18nDelegate < Base
         attr_accessor :key, :display_key, :options, :api_client, :fallback_keys, :original_args
 
-        def initialize(key, options={}, original_args=nil)
+        def initialize(key, options = {}, original_args = nil)
           @key = key
           @options = options
           @original_args = original_args
-          @display_key = DisplayableKeyIdentifier.new(api_wrapper).identify(@key, @options)
+          @display_key = @key
           super(decorated_key_name)
         end
 
@@ -27,7 +19,7 @@ module PhraseApp
           if @key.respond_to?(args.first)
             to_s.send(*args)
           else
-            data = translation_or_subkeys
+            data = [@key]
             if data.respond_to?(args.first)
               data.send(*args, &block)
             else
@@ -37,44 +29,6 @@ module PhraseApp
             end
           end
         end
-
-        private
-
-        def translation_or_subkeys
-          return nil if @key.nil? || @key.to_s == ""
-
-          keys = api_wrapper.keys_with_prefix(@key)
-          return nil unless keys.present?
-
-          if keys.size == 1
-            translation_content_for_key(keys.first)
-          else
-            translation_hash = keys.inject({}) do |hash, key|
-              hash[key.name] = translation_content_for_key(key)
-              hash
-            end
-
-            PhraseApp::InContextEditor::HashFlattener.expand_flat_hash(translation_hash, @key)
-          end
-        end
-
-        def translation_content_for_key(key)
-          default_translations = api_wrapper.default_translation(key)
-          return unless default_translations.present?
-
-          if key.plural
-            default_translations.inject({}) do |hash, translation|
-              hash[translation.plural_suffix.to_sym] = translation.content
-              hash
-            end
-          else
-            default_translations.first.content
-          end
-        end
-
-        def api_wrapper
-          @api_wrapper ||= InContextEditor::ApiWrapper.new
-        end
       end
     end
   end

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

@@ -1,17 +1,15 @@
-# -*- encoding : utf-8 -*-
-
 module PhraseApp
   module InContextEditor
     module Delegate
       class Base < String
         def to_s
-          "#{decorated_key_name}"
+          decorated_key_name.to_s
         end
-        alias :camelize :to_s
-        alias :underscore :to_s
-        alias :classify :to_s
-        alias :dasherize :to_s
-        alias :tableize :to_s
+        alias_method :camelize, :to_s
+        alias_method :underscore, :to_s
+        alias_method :classify, :to_s
+        alias_method :dasherize, :to_s
+        alias_method :tableize, :to_s
 
         # Delegate .html_safe from accessing Delegate object as if it was a hash,
         # but instead perform it on the resulting string
@@ -19,23 +17,24 @@ module PhraseApp
 
         def self.log(message)
           message = "phrase: #{message}"
-          if defined?(Rails) and Rails.respond_to?(:logger)
+          if defined?(Rails) && Rails.respond_to?(:logger)
             Rails.logger.warn(message)
           else
-            $stderr.puts message
+            warn message
           end
         end
 
-      protected
+        protected
+
         def decorated_key_name
           "#{PhraseApp::InContextEditor.prefix}phrase_#{normalized_display_key}#{PhraseApp::InContextEditor.suffix}"
         end
 
         def normalized_display_key
-          unless @display_key.nil?
-            @display_key.gsub("<", "[[[[[[html_open]]]]]]").gsub(">", "[[[[[[html_close]]]]]]")
-          else
+          if @display_key.nil?
             @display_key
+          else
+            @display_key.gsub("<", "[[[[[[html_open]]]]]]").gsub(">", "[[[[[[html_close]]]]]]")
           end
         end
       end

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

@@ -1,14 +1,13 @@
-# -*- encoding : utf-8 -*-
-require 'phraseapp-in-context-editor-ruby'
-require 'i18n'
+require "phraseapp-in-context-editor-ruby"
+require "i18n"
 
 if defined? Rails
   module PhraseApp
     module InContextEditor
       class Engine < Rails::Engine
-        initializer 'phraseapp-in-context-editor-ruby', before: :disable_dependency_loading do |app|
-          require 'phraseapp-in-context-editor-ruby/adapters/i18n'
-          require 'phraseapp-in-context-editor-ruby/adapters/fast_gettext'
+        initializer "phraseapp-in-context-editor-ruby", before: :disable_dependency_loading do |app|
+          require "phraseapp-in-context-editor-ruby/adapters/i18n"
+          require "phraseapp-in-context-editor-ruby/adapters/fast_gettext"
 
           ActionView::Base.send :include, PhraseApp::InContextEditor::ViewHelpers
         end