phraseapp-in-context-editor-ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 604cd00f00973ae2d407cb71c7a30368f9bea5ad
-  data.tar.gz: 29d19946b640f989bede4f58f901de106f514235
+  metadata.gz: 01523b055b91761df927cdf84848aef55c6290ed
+  data.tar.gz: 784a66ff617287b86f09610e775164ea10dfa20b
 SHA512:
-  metadata.gz: 828075464a99ba279d918bfb7402b47fd76d669cb425cfb031af26d1e267525eba43f24f56234c3dae3ccc65b8e0d5901c2d91cd148af78be141626ca8bb058b
-  data.tar.gz: 1d4af8782257326396c0847adc79161389b8e3f0bdd5872c7e6954af83de303a0e3e34eaf97d369d89ef4245778efdce282c17cfdd3c89da3866eb101a7b26f1
+  metadata.gz: 0a54b0688e2c1fba44dc024ab69c712dcd3bebec6148767b0a412603a4d72ef595fa18bccc2e9ff38e4153aedad9dd8f3341ef609c5a32b5f9f3e3d03703158a
+  data.tar.gz: a35d23543c9f8c2c8c21a11b3b077a398406c3266435581b50ae92d996eecc225d552d851ed2f2cf75bb2d9ebbc7d5b363ca1798a9625d00ae6e005ff5d8d5ad

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## [v1.0.2](https://github.com/phrase/phraseapp-in-context-editor-ruby/tree/v1.0.2) (2015-10-12)
+[Full Changelog](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v1.0.1...v1.0.2)
+
+**Closed issues:**
+
+- Method missing error [\#5](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/5)
+
+**Merged pull requests:**
+
+- 18n delegate refactoring [\#6](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/6) ([segitty](https://github.com/segitty))
+
+## [v1.0.1](https://github.com/phrase/phraseapp-in-context-editor-ruby/tree/v1.0.1) (2015-10-07)
+[Full Changelog](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v1.0.0...v1.0.1)
+
+**Closed issues:**
+
+- Two translations in one HTML element [\#4](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/4)
+- Why PhraseApp In-Context Editor can be enabled/disabled only for entire application? [\#3](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/3)
+- Why Access Token is mandatory in configuration for In-Context Editor?  [\#2](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/2)
+- Problems chaneging suffix and prefix [\#1](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/1)
+
+## [v1.0.0](https://github.com/phrase/phraseapp-in-context-editor-ruby/tree/v1.0.0) (2015-08-21)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

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

@@ -70,6 +70,14 @@ module PhraseApp
         config.js_host
       end
 
+      def js_path
+        config.js_path
+      end
+
+      def js_options
+        config.js_options
+      end
+
       def api_host
         config.api_host
       end

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

@@ -1,6 +1,6 @@
 # -*- encoding : utf-8 -*-
 require 'phraseapp-in-context-editor-ruby/api_collection'
-require 'phraseapp-in-context-editor-ruby/delegate/i18n'
+require 'phraseapp-in-context-editor-ruby/delegate/i18n_delegate'
 
 module PhraseApp
   module InContextEditor
@@ -64,8 +64,9 @@ module PhraseApp
       def phraseapp_delegate_for(args)
         key = given_key_from_args(args)
         return nil unless present?(key)
+
         options = args[1].nil? ? {} : args[1]
-        PhraseApp::InContextEditor::Delegate::I18n.new(key, options, args)
+        PhraseApp::InContextEditor::Delegate::I18nDelegate.new(key, options, args)
       end
 
       def extract_normalized_key_from_args(args)

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

@@ -93,6 +93,22 @@ module PhraseApp
         @@js_use_ssl = js_use_ssl
       end
 
+      def js_path
+        @@js_path ||= "/assets/in-context-editor/2.0/app.js"
+      end
+
+      def js_path=(js_path)
+        @@js_path = js_path
+      end
+
+      def js_options
+        @@js_options ||= {}
+      end
+
+      def js_options=(js_options)
+        @@js_options = js_options
+      end
+
       def cache_key_segments_initial
         @@cache_key_segments_initial ||= ["simple_form"]
       end

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

@@ -0,0 +1,79 @@
+# -*- 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'
+
+module PhraseApp
+  module InContextEditor
+    module Delegate
+      class I18nDelegate < Base
+        attr_accessor :key, :display_key, :options, :api_client, :fallback_keys, :original_args
+
+        def initialize(key, options={}, original_args=nil)
+          @key = key
+          @options = options
+          @original_args = original_args
+          @display_key = DisplayableKeyIdentifier.new(api_wrapper).identify(@key, @options)
+          super(decorated_key_name)
+        end
+
+        def method_missing(*args, &block)
+          self.class.log "Trying to execute missing method ##{args.first} on key #{@key}"
+          if @key.respond_to?(args.first)
+            to_s.send(*args)
+          else
+            data = translation_or_subkeys
+            if data.respond_to?(args.first)
+              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.send(*args, &block)
+            end
+          end
+        end
+
+        private
+
+        def translation_or_subkeys
+          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
+end

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

@@ -0,0 +1,46 @@
+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

@@ -0,0 +1,44 @@
+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

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

@@ -0,0 +1,53 @@
+module PhraseApp
+  module InContextEditor
+    class KeyNamesCache
+      attr_reader :api_wrapper
+
+      def initialize(api_wrapper)
+        @api_wrapper = api_wrapper
+      end
+
+      def pre_cached(key_names)
+        unless cache.cached?(:translation_key_names)
+          cache.set(:translation_key_names, prefetched_key_names)
+        end
+
+        return key_names.select { |key_name| key_name_precached?(key_name) }
+      end
+
+      def pre_fetched(key_names)
+        key_names.select { |key_name| covered_by_initial_caching?(key_name) }
+      end
+
+      private
+
+      def prefetched_key_names
+        prefetched = Set.new
+        PhraseApp::InContextEditor.cache_key_segments_initial.each do |prefix|
+          api_wrapper.keys_with_prefix(prefix).each do |key|
+            prefetched.add(key.name)
+          end
+        end
+        prefetched
+      end
+
+      def covered_by_initial_caching?(key_name)
+        key_name.start_with?(*PhraseApp::InContextEditor.cache_key_segments_initial)
+      end
+
+      def key_name_is_in_cache?(key_name)
+        cache.get(:translation_key_names).include?(key_name)
+      end
+
+      def key_name_precached?(key_name)
+        covered = covered_by_initial_caching?(key_name)
+        in_cache = key_name_is_in_cache?(key_name)
+        return covered && in_cache
+      end
+
+      def cache
+        Thread.current[:phraseapp_cache] ||= PhraseApp::InContextEditor::Cache.new
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module PhraseApp
   module InContextEditor
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

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

@@ -6,20 +6,24 @@ module PhraseApp
       def phraseapp_in_context_editor_js(opts={})
         return "" unless PhraseApp::InContextEditor.enabled?
 
-        opts = opts.nil? ? {} : opts.inject({}) { |conf, (k,v)| conf[k.to_s] = v; conf} # stringify to reduce possible errors when passing symbols
+        # stringify to reduce possible errors when passing symbols
+        js_default_options = PhraseApp::InContextEditor.js_options.inject({}) { |conf, (k,v)| conf[k.to_s] = v; conf}
+        opts = opts.nil? ? {} : opts.inject({}) { |conf, (k,v)| conf[k.to_s] = v; conf}
+
+        # js options
         configuration = {
           'projectId' => PhraseApp::InContextEditor.project_id,
           'prefix' => PhraseApp::InContextEditor.prefix,
           'suffix' => PhraseApp::InContextEditor.suffix,
           'apiBaseUrl' => "#{PhraseApp::InContextEditor.api_host}/api/v2",
-        }.merge(opts)
+        }.merge(js_default_options).merge(opts)
 
         snippet = <<-eos
           <script>
             window.PHRASEAPP_CONFIG = #{configuration.to_json};
             (function() {
               var phraseapp = document.createElement('script'); phraseapp.type = 'text/javascript'; phraseapp.async = true;
-              phraseapp.src = ['#{PhraseApp::InContextEditor.js_use_ssl ? 'https' : 'http'}://', '#{PhraseApp::InContextEditor.js_host}/assets/in-context-editor/2.0/app.js?', new Date().getTime()].join('');
+              phraseapp.src = ['#{PhraseApp::InContextEditor.js_use_ssl ? 'https' : 'http'}://', '#{PhraseApp::InContextEditor.js_host}#{PhraseApp::InContextEditor.js_path}?', new Date().getTime()].join('');
               var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(phraseapp, s);
             })();
           </script>

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

@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('vcr', '~> 2.9')
   s.add_development_dependency('timecop', '~> 0.7')
   s.add_development_dependency('rails', '~> 4.2')
+  s.add_development_dependency('github_changelog_generator')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Dynport GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !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'
 description: 'PhraseApp In-Context-Editor allows you to edit translations directly
   on the website. More information: phraseapp.com'
 email:
@@ -132,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -150,9 +165,12 @@ files:
 - 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.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
 - phraseapp-in-context-editor-ruby.gemspec
@@ -176,8 +194,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: phraseapp-in-context-editor-ruby
-rubygems_version: 2.2.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Translation management solution for web and mobile applications
 test_files: []
+has_rdoc: 

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

@@ -1,192 +0,0 @@
-# -*- 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 'set'
-
-module PhraseApp
-  module InContextEditor
-    module Delegate
-      class I18n < Base
-        attr_accessor :key, :display_key, :options, :api_client, :fallback_keys, :original_args
-
-        def initialize(key, options={}, original_args=nil)
-          @display_key = @key = key
-          @options = options
-          @original_args = original_args
-
-          @fallback_keys = []
-
-          extract_fallback_keys
-          identify_key_to_display if @fallback_keys.any?
-          super(decorated_key_name)
-        end
-
-        def method_missing(*args, &block)
-          self.class.log "Trying to execute missing method ##{args.first} on key #{@key}"
-          if @key.respond_to?(args.first)
-            to_s.send(*args)
-          else
-            data = translation_or_subkeys
-            if data.respond_to?(args.first)
-              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.send(*args, &block)
-            end
-          end
-        end
-
-      private
-        def identify_key_to_display
-          key_names = [@key] | @fallback_keys
-          available_key_names = find_keys_within_phraseapp(key_names)
-          @display_key = @key
-          key_names.each do |item|
-            if available_key_names.include?(item)
-              @display_key = item
-              break
-            end
-          end
-        end
-
-        def find_keys_within_phraseapp(key_names)
-          key_names_to_check_against_api = key_names - pre_fetched(key_names)
-          pre_cached(key_names) | key_names_returned_from_api_for(key_names_to_check_against_api)
-        end
-
-        def pre_cached(key_names)
-          warm_translation_key_names_cache unless cache.cached?(:translation_key_names)
-          pre_cached_key_names = key_names.select { |key_name| key_name_precached?(key_name) }
-          pre_cached_key_names
-        end
-
-        def pre_fetched(key_names)
-          key_names.select { |key_name| covered_by_initial_caching?(key_name) }
-        end
-
-        def key_name_precached?(key_name)
-          covered = covered_by_initial_caching?(key_name)
-          in_cache = key_name_is_in_cache?(key_name)
-          covered && in_cache
-        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
-
-        def key_name_is_in_cache?(key_name)
-          cache.get(:translation_key_names).include?(key_name)
-        end
-
-        def covered_by_initial_caching?(key_name)
-          key_name.start_with?(*PhraseApp::InContextEditor.cache_key_segments_initial)
-        end
-
-        def extract_fallback_keys
-          fallback_items = []
-          if @options.has_key?(:default)
-            if @options[:default].kind_of?(Array)
-              fallback_items = @options[:default]
-            else
-              fallback_items << @options[:default]
-            end
-          end
-
-          fallback_items.each do |item|
-            process_fallback_item(item)
-          end
-        end
-
-        def scoped(item)
-          @options.has_key?(:scope) ? "#{@options[:scope]}.#{item}" : item
-        end
-
-        def process_fallback_item(item)
-          if item.kind_of?(Symbol)
-            entry = scoped(item.to_s)
-            @fallback_keys << entry
-            if @key == "helpers.label.#{entry}" # http://apidock.com/rails/v3.1.0/ActionView/Helpers/FormHelper/label
-              @fallback_keys << "activerecord.attributes.#{entry}"
-            end
-
-            if @key.start_with?("simple_form.") # special treatment for simple form
-              @fallback_keys << "activerecord.attributes.#{item.to_s}"
-            end
-          end
-        end
-
-        def translation_or_subkeys
-          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 cache
-          Thread.current[:phraseapp_cache] ||= build_cache
-        end
-
-        def build_cache
-          cache = PhraseApp::InContextEditor::Cache.new
-        end
-
-        def warm_translation_key_names_cache
-          cache.set(:translation_key_names, prefetched_key_names)
-        end
-
-        def prefetched_key_names
-          prefetched = Set.new
-          PhraseApp::InContextEditor.cache_key_segments_initial.each do |prefix|
-            api_wrapper.keys_with_prefix(prefix).each do |key|
-              prefetched.add(key.name)
-            end
-          end
-          prefetched
-        end
-
-        def key_names_from_nested(segment, data)
-          key_names = Set.new
-          PhraseApp::InContextEditor::HashFlattener.flatten(data, nil) do |key, value|
-            key_names.add("#{segment}.#{key}") unless value.is_a?(Hash)
-          end unless (data.is_a?(String) || data.nil?)
-          key_names
-        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
-end