phraseapp-in-context-editor-ruby 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08bedc61fbf888fdc0b936c856eb63d6d0bb3475
-  data.tar.gz: 3442d9094518b0890d302eab1f1d9fc1f38efec4
+  metadata.gz: cdfdab7c2d226806be3b94c62dcbf1e371139917
+  data.tar.gz: 53a0f7c4065ce2c72d8e3df1830c203fe6707b7a
 SHA512:
-  metadata.gz: bf0e674700424e314ea0fcb2bc310e6f3be03ce199bac2be6fd6cb0b0ca608a7f1cdc9c9884861ba22b5014af61871eb7a6ee917cd47c632f860c85d7b98ce42
-  data.tar.gz: 4f3c6391d340f416939a9ad2f0843f037f74cfc064570024e457814cfbaf3dabb89ee876e7df81d3b6fa885f61ab964dd65df64e54beb1169f1bde49ace4c2fe
+  metadata.gz: ce15350f192f740f52bf84838954638d4fc9743ea1c3e245cd867690903eb1e3503c2167fe32b7ce39001955fe37de2d670e352a07f837bb813ab561aaedc393
+  data.tar.gz: f36383b6b2c563a35336e94c71c8876694071445e1be698d8d9ff27e6b623dfaed26a7522cf5bff06d5ec6c981df96b0a8a63f9dccc2571e32c23f64118c3fca

data/.travis.yml

@@ -3,4 +3,5 @@ rvm:
   - "2.0"
   - "2.1"
   - "2.2"
+  - "2.3.0"
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## [v1.1.0](https://github.com/phrase/phraseapp-in-context-editor-ruby/tree/v1.1.0) (2016-10-04)
+[Full Changelog](https://github.com/phrase/phraseapp-in-context-editor-ruby/compare/v1.0.2...v1.1.0)
+
+**Closed issues:**
+
+- rails\_admin json issue with phraseapp and rails\_admin-i18n [\#16](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/16)
+- Per thread config [\#14](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/14)
+- RuntimeError: not found? [\#12](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/12)
+- Editor conflicts the angular router [\#9](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/9)
+- Edit icons missing if the enabled false by default [\#8](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/8)
+- Introduce a changelog [\#7](https://github.com/phrase/phraseapp-in-context-editor-ruby/issues/7)
+
+**Merged pull requests:**
+
+- Proper storage of config on Thread.current [\#15](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/15) ([docstun](https://github.com/docstun))
+- disable dependency loading on before as fix for rails5 [\#13](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/13) ([koljaa](https://github.com/koljaa))
+- Update LICENSE [\#11](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/11) ([sbruhns](https://github.com/sbruhns))
+- i18n set to \>= 0.6 [\#10](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/10) ([jethroo](https://github.com/jethroo))
+
 ## [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)
 
@@ -9,7 +28,7 @@
 
 **Merged pull requests:**
 
-- 18n delegate refactoring [\#6](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/6) ([segitty](https://github.com/segitty))
+- 18n delegate refactoring [\#6](https://github.com/phrase/phraseapp-in-context-editor-ruby/pull/6) ([koljaa](https://github.com/koljaa))
 
 ## [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)

data/README.md

@@ -54,18 +54,9 @@ If you don't want to use the helper but add the plain Javascript yourself, head
 
 Restart your application to see the In-Context-Editor in action!
 
-
-### Upgrading from the old phrase gem
-
-If you're upgrading from the `phrase` gem (which is now deprecated), you will notice several changes:
-
-1. The gem no longer provides the `push`/`pull` commands. This functionality is now provided by our new [command line client](https://github.com/phrase/phraseapp-client).
-2. The gem also no longer implements it's own API client, but uses the [phraseapp-ruby gem](https://github.com/phrase/phraseapp-ruby) for API communication.
-
-
 ### OpenSSL issues
 
-Please note that outdated certificates or old versions of OpenSSL may cause connection issues, especially on Mac OSX. We recommend using Ruby 2.2.2 with OpenSSL 1.0.2d or later. If you experience OpenSSL-related errors, try the following. 
+Please note that outdated certificates or old versions of OpenSSL may cause connection issues, especially on Mac OSX. We recommend using Ruby 2.2.2 with OpenSSL 1.0.2d or later. If you experience OpenSSL-related errors, try the following.
 
 Upgrade OpenSSL using Homebrew:
 
@@ -87,7 +78,7 @@ As a workaround, you can disable SSL certificate verification in your `config/in
   config.skip_ssl_verification = true
 ```
 
-This is **not recommended** and should only be used as a temporary workaround. 
+This is **not recommended** and should only be used as a temporary workaround.
 
 
 ## Further Information

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

@@ -88,7 +88,15 @@ module PhraseApp
     end
 
     def self.configure
-      yield(self.config)
+      yield(PhraseApp::InContextEditor::Config)
+    end
+
+    def self.with_config(config_options={}, &block)
+      original_config = self.config.dup
+      config.assign_values(config_options)
+      yield
+    ensure
+      self.config = original_config
     end
   end
 

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

@@ -1,142 +1,83 @@
 # -*- encoding : utf-8 -*-
-
 module PhraseApp
   module InContextEditor
     class Config
-      def project_id
-        @@project_id = "" if !defined? @@project_id or @@project_id.nil?
-        @@project_id
-      end
-
-      def project_id=(project_id)
-        @@project_id = project_id
-      end
-
-      def access_token
-        @@access_token = "" if !defined? @@access_token or @@access_token.nil?
-        @@access_token
-      end
-
-      def access_token=(access_token)
-        @@access_token = access_token
-      end
-
-      def enabled
-        @@enabled = false if !defined? @@enabled or @@enabled.nil?
-        @@enabled
-      end
-
-      def enabled=(enabled)
-        @@enabled = enabled
-      end
-
-      def skip_ssl_verification
-        @@skip_ssl_verification = false if !defined? @@skip_ssl_verification or @@skip_ssl_verification.nil?
-        @@skip_ssl_verification
-      end
-
-      def skip_ssl_verification=(skip_ssl_verification)
-        @@skip_ssl_verification = skip_ssl_verification
-      end
-
-      def backend
-        @@backend ||= PhraseApp::InContextEditor::BackendService.new
-      end
-
-      def backend=(backend)
-        @@backend = backend
+      CONFIG_OPTIONS = {
+        project_id: nil,
+        access_token: nil,
+        enabled: false,
+        skip_ssl_verification: false,
+        backend: PhraseApp::InContextEditor::BackendService.new,
+        prefix: "{{__",
+        suffix: "__}}",
+        api_host: "https://api.phraseapp.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: [],
+      }.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}]"
+
+        define_method("#{option}=") do |value|
+          instance_eval "@#{option} = value; self.class.invalidate_api_client"
+        end unless CONFIG_OPTIONS_GLOBAL_ONLY.include?(option)
+
+        define_method("#{option}") do
+          instance_eval "defined?(@#{option}) ? @#{option} : self.class.#{option}"
+        end
+
+        define_singleton_method("#{option}=") do |value|
+          instance_eval "@@#{option} = value; invalidate_api_client"
+        end
+
+        define_singleton_method("#{option}") do
+          instance_eval "@@#{option}"
+        end
+      end
+
+      def self.api_client
+        @@api_client ||= build_api_client
       end
 
       def api_client
-        @@api_client ||= authorized_api_client
-      end
-
-      def prefix
-        @@prefix ||= "{{__"
+        self.class.api_client
       end
 
-      def prefix=(prefix)
-        @@prefix = prefix
+      def assign_values(config_options={})
+        config_options.each do |config_option, value|
+          self.send("#{config_option}=", value)
+        end
       end
 
-      def suffix
-        @@suffix ||= "__}}"
+      def self.reset_to_defaults!
+        CONFIG_OPTIONS.each do |option, default_value|
+          send("#{option}=", default_value)
+        end
       end
 
-      def suffix=(suffix)
-        @@suffix = suffix
-      end
-
-      def api_host
-        @@api_host = "https://api.phraseapp.com" if !defined? @@api_host or @@api_host.nil?
-        @@api_host
-      end
-
-      def api_host=(api_host)
-        @@api_host = api_host
-      end
-
-      def js_host
-        @@js_host ||= 'phraseapp.com'
-      end
-
-      def js_host=(js_host)
-        @@js_host = js_host
-      end
-
-      def js_use_ssl
-        @@js_use_ssl = true if !defined? @@js_use_ssl or @@js_use_ssl.nil?
-        @@js_use_ssl
-      end
-
-      def js_use_ssl=(js_use_ssl)
-        @@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
-
-      def cache_key_segments_initial=(cache_key_segments_initial=[])
-        @@cache_key_segments_initial = cache_key_segments_initial
-      end
-
-      def cache_lifetime
-        @@cache_lifetime ||= 300
-      end
-
-      def cache_lifetime=(cache_lifetime)
-        @@cache_lifetime = cache_lifetime
-      end
-
-      def ignored_keys
-        @@ignored_keys ||= []
-      end
-
-      def ignored_keys=(ignored_keys)
-        @@ignored_keys = ignored_keys
+    protected
+      def self.invalidate_api_client
+        @@api_client = nil
       end
 
-    protected
-      def authorized_api_client
-        credentials = PhraseApp::Auth::Credentials.new(token: PhraseApp::InContextEditor.access_token, host: PhraseApp::InContextEditor.api_host, skip_ssl_verification: PhraseApp::InContextEditor.skip_ssl_verification)
-        client = PhraseApp::Client.new(credentials)
+      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

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

@@ -7,10 +7,8 @@ if defined? Rails
     module InContextEditor
       class Engine < Rails::Engine
         initializer 'phraseapp-in-context-editor-ruby', before: :disable_dependency_loading do |app|
-          if PhraseApp::InContextEditor.enabled?
-            require 'phraseapp-in-context-editor-ruby/adapters/i18n'
-            require 'phraseapp-in-context-editor-ruby/adapters/fast_gettext'
-          end
+          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

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

@@ -50,4 +50,4 @@ module PhraseApp
       end
     end
   end
-end
+end

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

@@ -1,5 +1,5 @@
 module PhraseApp
   module InContextEditor
-    VERSION = "1.0.6"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phraseapp-in-context-editor-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.1.0
 platform: ruby
 authors:
 - Dynport GmbH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -194,7 +194,7 @@ 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