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

data/package.json

@@ -0,0 +1,13 @@
+{
+  "scripts": {
+    "release": "semantic-release"
+  },
+  "devDependencies": {
+    "@semantic-release/commit-analyzer": "^8.0.1",
+    "@semantic-release/release-notes-generator": "^9.0.1",
+    "@semantic-release/changelog": "^5.0.1",
+    "@semantic-release/git": "^9.0.0",
+    "semantic-release": "^17.0.7",
+    "semantic-release-rubygem": "^1.2.0"
+  }
+}

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

@@ -1,43 +1,30 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
+# frozen_string_literal: true
 
-require 'phraseapp-in-context-editor-ruby/version'
+require "./lib/phraseapp-in-context-editor-ruby/version"
 
 Gem::Specification.new do |s|
   s.name = "phraseapp-in-context-editor-ruby"
-  s.version = PhraseApp::InContextEditor::VERSION
+  s.version = PhraseApp::VERSION
   s.platform = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.1'
-  s.authors = ["Dynport GmbH"]
+  s.required_ruby_version = ">= 3.1.0"
+  s.authors = ["Phrase"]
   s.email = ["info@phrase.com"]
   s.homepage = "https://phrase.com"
-  s.summary = %q{Translation management solution for web and mobile applications}
-  s.licenses = ['MIT']
-  s.description = %q{Phrase In-Context-Editor allows you to edit translations directly on the website. More information: phrase.com}
+  s.summary = "Translation management solution for web and mobile applications"
+  s.licenses = ["MIT"]
+  s.description = "Phrase In-Context-Editor allows you to edit translations directly on the website. More information: phrase.com"
   s.required_rubygems_version = ">= 1.3.6"
-  s.rubyforge_project = "phraseapp-in-context-editor-ruby"
-  git_files = `git ls-files | grep -v spec/`.split("\n") rescue ''
+  git_files = begin
+    `git ls-files | grep -v spec/`.split("\n")
+  rescue
+    ""
+  end
   s.files = git_files
-  s.test_files = s.files.grep(%r{^(spec)/})
   s.require_paths = ["lib"]
-  if RUBY_VERSION >= '2.4'
-    s.add_dependency('json', '>= 1.8', '< 3')
-  else
-    s.add_dependency('json', '>= 1.7', '< 3')
-  end
-  s.add_dependency('i18n', '>= 0.6')
-  s.add_dependency('phraseapp-ruby', '~> 1.3')
-  s.add_dependency('request_store', '~> 1.3')
-  s.add_development_dependency('rspec', '~> 3.2')
-  s.add_development_dependency('webmock', '~> 1.21')
-  s.add_development_dependency('vcr', '~> 2.9')
-  s.add_development_dependency('timecop', '~> 0.7')
-  if RUBY_VERSION < '2.2'
-    s.add_development_dependency('mime-types', '< 3.0') # for 1.9.3 to work
-    s.add_development_dependency('rails', '~> 4.2')
-  else
-    s.add_development_dependency('rails', '>= 4.2', '< 5.1')
-  end
-  s.add_development_dependency('github_changelog_generator')
+  s.add_dependency("json", "~> 2.0")
+  s.add_dependency("i18n", "~> 1.0")
+  s.add_dependency("request_store", "~> 1.2")
+  s.add_development_dependency("rspec", "~> 3.0")
+  s.add_development_dependency("rails", "~> 7.0")
+  s.add_development_dependency("github_changelog_generator", "~> 1.16")
 end

data/release.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/changelog",
+        "@semantic-release/git",
+        "semantic-release-rubygem",
+    ],
+    "branches": 'master',
+};

metadata

@@ -1,167 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.1.1
 platform: ruby
 authors:
-- Dynport GmbH
+- Phrase
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: phraseapp-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '7.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: github_changelog_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 description: 'Phrase In-Context-Editor allows you to edit translations directly on
   the website. More information: phrase.com'
 email:
@@ -170,40 +102,124 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/workflows/close_inactive_issues.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".package-licenses.yml"
 - ".tool-versions"
 - CHANGELOG.md
+- CODEOWNERS
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
+- RELEASING.md
 - cacert.pem
 - config/license-decisions.yml
 - config/license_finder.yml
+- docs/CHANGELOG.md
+- examples/demo/.gitattributes
+- examples/demo/.gitignore
+- examples/demo/Gemfile
+- examples/demo/Gemfile.lock
+- examples/demo/README.md
+- examples/demo/Rakefile
+- examples/demo/app/assets/config/manifest.js
+- examples/demo/app/assets/images/.keep
+- examples/demo/app/assets/stylesheets/application.css
+- examples/demo/app/channels/application_cable/channel.rb
+- examples/demo/app/channels/application_cable/connection.rb
+- examples/demo/app/controllers/application_controller.rb
+- examples/demo/app/controllers/concerns/.keep
+- examples/demo/app/controllers/main_controller.rb
+- examples/demo/app/helpers/application_helper.rb
+- examples/demo/app/helpers/main_helper.rb
+- examples/demo/app/javascript/application.js
+- examples/demo/app/javascript/controllers/application.js
+- examples/demo/app/javascript/controllers/hello_controller.js
+- examples/demo/app/javascript/controllers/index.js
+- examples/demo/app/jobs/application_job.rb
+- examples/demo/app/mailers/application_mailer.rb
+- examples/demo/app/models/application_record.rb
+- examples/demo/app/models/concerns/.keep
+- examples/demo/app/views/layouts/application.html.erb
+- examples/demo/app/views/layouts/mailer.html.erb
+- examples/demo/app/views/layouts/mailer.text.erb
+- examples/demo/app/views/main/index.html.erb
+- examples/demo/bin/bundle
+- examples/demo/bin/importmap
+- examples/demo/bin/rails
+- examples/demo/bin/rake
+- examples/demo/bin/setup
+- examples/demo/config.ru
+- examples/demo/config/application.rb
+- examples/demo/config/boot.rb
+- examples/demo/config/cable.yml
+- examples/demo/config/credentials.yml.enc
+- examples/demo/config/database.yml
+- examples/demo/config/environment.rb
+- examples/demo/config/environments/development.rb
+- examples/demo/config/environments/production.rb
+- examples/demo/config/environments/test.rb
+- examples/demo/config/importmap.rb
+- examples/demo/config/initializers/assets.rb
+- examples/demo/config/initializers/content_security_policy.rb
+- examples/demo/config/initializers/filter_parameter_logging.rb
+- examples/demo/config/initializers/inflections.rb
+- examples/demo/config/initializers/permissions_policy.rb
+- examples/demo/config/initializers/phraseapp_in_context_editor.rb
+- examples/demo/config/locales/en.yml
+- examples/demo/config/puma.rb
+- examples/demo/config/routes.rb
+- examples/demo/config/storage.yml
+- examples/demo/db/seeds.rb
+- examples/demo/lib/assets/.keep
+- examples/demo/lib/tasks/.keep
+- examples/demo/log/.keep
+- examples/demo/public/404.html
+- examples/demo/public/422.html
+- examples/demo/public/500.html
+- examples/demo/public/apple-touch-icon-precomposed.png
+- examples/demo/public/apple-touch-icon.png
+- examples/demo/public/favicon.ico
+- examples/demo/public/robots.txt
+- examples/demo/storage/.keep
+- examples/demo/test/application_system_test_case.rb
+- examples/demo/test/channels/application_cable/connection_test.rb
+- examples/demo/test/controllers/.keep
+- examples/demo/test/controllers/main_controller_test.rb
+- examples/demo/test/fixtures/files/.keep
+- examples/demo/test/helpers/.keep
+- examples/demo/test/integration/.keep
+- examples/demo/test/mailers/.keep
+- examples/demo/test/models/.keep
+- examples/demo/test/system/.keep
+- examples/demo/test/test_helper.rb
+- examples/demo/tmp/.keep
+- examples/demo/tmp/pids/.keep
+- examples/demo/tmp/storage/.keep
+- examples/demo/vendor/.keep
+- examples/demo/vendor/javascript/.keep
 - lib/generators/phraseapp_in_context_editor/install_generator.rb
-- lib/generators/phraseapp_in_context_editor/templates/README
 - lib/generators/phraseapp_in_context_editor/templates/phraseapp_in_context_editor.rb
 - lib/phraseapp-in-context-editor-ruby.rb
 - lib/phraseapp-in-context-editor-ruby/adapters/fast_gettext.rb
 - lib/phraseapp-in-context-editor-ruby/adapters/i18n.rb
-- lib/phraseapp-in-context-editor-ruby/api_collection.rb
-- lib/phraseapp-in-context-editor-ruby/api_wrapper.rb
 - lib/phraseapp-in-context-editor-ruby/backend_service.rb
-- lib/phraseapp-in-context-editor-ruby/cache.rb
 - lib/phraseapp-in-context-editor-ruby/config.rb
 - lib/phraseapp-in-context-editor-ruby/delegate.rb
 - lib/phraseapp-in-context-editor-ruby/delegate/fast_gettext.rb
 - lib/phraseapp-in-context-editor-ruby/delegate/i18n_delegate.rb
-- lib/phraseapp-in-context-editor-ruby/displayable_key_identifier.rb
 - lib/phraseapp-in-context-editor-ruby/engine.rb
-- lib/phraseapp-in-context-editor-ruby/fallback_keys_fetcher.rb
-- lib/phraseapp-in-context-editor-ruby/hash_flattener.rb
-- lib/phraseapp-in-context-editor-ruby/key_names_cache.rb
 - lib/phraseapp-in-context-editor-ruby/version.rb
 - lib/phraseapp-in-context-editor-ruby/view_helpers.rb
+- package-lock.json
+- package.json
 - phraseapp-in-context-editor-ruby.gemspec
+- release.config.js
 homepage: https://phrase.com
 licenses:
 - MIT
@@ -216,14 +232,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Translation management solution for web and mobile applications

data/lib/generators/phraseapp_in_context_editor/templates/README

@@ -1,10 +0,0 @@
-===============================================================================
-Welcome to PhraseApp!
-
-PhraseApp is the translation management solution for web and mobile applications. Collaborate with your team, find professional translators and stay on top of the process.
-
-How awesome would it be if translators could simply browse your website and edit text along the way? Our In-Context Editor offers just that. It provides translators with useful contextual information which improves overall translation quality.
-
-Login: https://phraseapp.com/account/login
-Documentation: https://help.phraseapp.com/translate-website-and-app-content/use-in-context-editor-to-translate/translate-directly-on-your-website
-===============================================================================

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

@@ -1,41 +0,0 @@
-module PhraseApp
-  module InContextEditor
-    class ApiCollection
-      def initialize(api_client, action, ids=[], query=nil)
-        raise "PhraseApp API client can't handle action #{action}" unless api_client.respond_to?(action)
-
-        @api_client = api_client
-        @action = action
-        @ids = ids
-        @query = query
-      end
-
-      def collection
-        results = []
-        page = 1
-        per_page = 100
-        paginated, err = send_request(page, per_page)
-        results << paginated
-
-        while paginated.size == per_page
-          break if page > 100
-
-          page = page + 1
-          paginated, err = send_request(page, per_page)
-          results << paginated if paginated.present?
-        end
-
-        results.flatten.uniq
-      end
-
-    private
-      def send_request(page, per_page)
-        if @query.present?
-          @api_client.send(@action, *@ids, page, per_page, @query)
-        else
-          @api_client.send(@action, *@ids, page, per_page)
-        end
-      end
-    end
-  end
-end

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

@@ -1,59 +0,0 @@
-require 'phraseapp-in-context-editor-ruby/api_collection'
-
-module PhraseApp
-  module InContextEditor
-    class ApiWrapper
-      def initialize
-        @api_client = PhraseApp::InContextEditor.api_client
-      end
-
-      def default_locale
-        @default_locale ||= select_default_locale
-      end
-
-      def default_translation(key)
-        params = PhraseApp::RequestParams::TranslationsByKeyParams.new
-        translations = PhraseApp::InContextEditor::ApiCollection.new(@api_client, "translations_by_key", project_and_key_id(key), params).collection
-        return unless translations.present?
-
-        translations.select{ |translation| translation.locale["id"] == default_locale.id }
-      end
-
-      def keys_with_prefix(prefix)
-        params = PhraseApp::RequestParams::KeysSearchParams.new(q:"#{prefix}*")
-        keys_list(params)
-      end
-
-      def keys_by_names(names)
-        names = names.join(',')
-        params = PhraseApp::RequestParams::KeysSearchParams.new(:q => "name:#{names}")
-        keys_list(params)
-      end
-
-      def keys_list(params)
-        PhraseApp::InContextEditor::ApiCollection.new(@api_client, "keys_search", project_id, params).collection
-      end
-
-      def blacklisted_keys
-        PhraseApp::InContextEditor::ApiCollection.new(@api_client, "blacklisted_keys_list", project_id).collection.map{ |rule| rule.name }
-      end
-
-      private
-
-      def select_default_locale
-        locales = PhraseApp::InContextEditor::ApiCollection.new(@api_client, "locales_list", project_id).collection
-        return unless locales.present?
-
-        locales.select{ |loc| loc.default }.first
-      end
-
-      def project_id
-        [PhraseApp::InContextEditor.project_id]
-      end
-
-      def project_and_key_id(key)
-        project_id << key.id
-      end
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-# -*- encoding : utf-8 -*-
-
-require 'phraseapp-in-context-editor-ruby'
-
-module PhraseApp
-  module InContextEditor
-    class Cache
-      attr_accessor :lifetime
-
-      def initialize(args={})
-        @store = {}
-        @lifetime = args.fetch(:lifetime, PhraseApp::InContextEditor.cache_lifetime)
-      end
-
-      def cached?(cache_key)
-        @store.has_key?(cache_key) && !expired?(cache_key)
-      end
-
-      def get(cache_key)
-        begin
-          @store.fetch(cache_key)[:payload]
-        rescue
-          nil
-        end
-      end
-
-      def set(cache_key, value)
-        @store[cache_key] = {timestamp: Time.now, payload: value}
-      end
-
-    private
-      def expired?(cache_key)
-        @store.fetch(cache_key)[:timestamp] < (Time.now - @lifetime)
-      end
-    end
-  end
-end

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

@@ -1,46 +0,0 @@
-require 'phraseapp-in-context-editor-ruby/fallback_keys_fetcher'
-require 'phraseapp-in-context-editor-ruby/key_names_cache'
-
-module PhraseApp
-  module InContextEditor
-    class DisplayableKeyIdentifier
-      attr_reader :api_wrapper, :key_names_cache
-
-      def initialize(api_wrapper)
-        @api_wrapper = api_wrapper
-        @key_names_cache = KeyNamesCache.new(@api_wrapper)
-      end
-
-      def identify(key_name, options)
-        fallback_key_names = FallbackKeysFetcher.extract_fallback_keys(key_name, options)
-        return key_name if fallback_key_names.empty?
-
-        key_names = [key_name] | fallback_key_names
-        available_key_names = find_keys_within_phraseapp(key_names)
-
-        key_names.each do |item|
-          if available_key_names.include?(item)
-            return item
-          end
-        end
-
-        return key_name
-      end
-
-      private
-
-      def find_keys_within_phraseapp(key_names)
-        key_names_to_check_against_api = key_names - @key_names_cache.pre_fetched(key_names)
-        @key_names_cache.pre_cached(key_names) | key_names_returned_from_api_for(key_names_to_check_against_api)
-      end
-
-      def key_names_returned_from_api_for(key_names)
-        if key_names.size > 0
-          api_wrapper.keys_by_names(key_names).map { |key| key.name }
-        else
-          []
-        end
-      end
-    end
-  end
-end

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

@@ -1,44 +0,0 @@
-module PhraseApp
-  module InContextEditor
-    class FallbackKeysFetcher
-
-      def self.extract_fallback_keys(key, options)
-        fallback_items = []
-        if options.has_key?(:default)
-          if options[:default].kind_of?(Array)
-            fallback_items = options[:default]
-          else
-            fallback_items << options[:default]
-          end
-        end
-
-        return fallback_items.map{ |item| process_fallback_item(item, key, options) }.flatten.uniq
-      end
-
-      def self.process_fallback_item(item, key, options)
-        fallback_keys = []
-        if item.kind_of?(Symbol)
-          fallback_key_name = item.to_s
-          if options.has_key?(:scope)
-            if options[:scope].is_a?(Array)
-              fallback_key_name = "#{options[:scope].join(".")}.#{item}"
-            else
-              fallback_key_name = "#{options[:scope]}.#{item}"
-            end
-          end
-          fallback_keys << fallback_key_name
-
-          if key == "helpers.label.#{fallback_key_name}" # http://apidock.com/rails/v3.1.0/ActionView/Helpers/FormHelper/label
-            fallback_keys << "activerecord.attributes.#{fallback_key_name}"
-          end
-
-          if key.start_with?("simple_form.") # special treatment for simple form
-            fallback_keys << "activerecord.attributes.#{item}"
-          end
-        end
-
-        return fallback_keys
-      end
-    end
-  end
-end