copy_tuner_client 0.4.12 → 0.5.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 065504cc3f7dfc961ad953d04a27337c74e54adb
-  data.tar.gz: bb3a4c5e3d9b3915b7564aea2a086a353069d2de
+  metadata.gz: 6fe18af1c45ea03ac6fe080c00f4121c4c447db6
+  data.tar.gz: fa4cedc35cd14f755ec8d75fd3e2b16c2bcd7aed
 SHA512:
-  metadata.gz: 60d5977669c7801caea1b016ac47546e2597c7c78e291b7c216d846f076c012676b2bfced6f965d5b2de62c1ede85c22253017ef6a26fc03f9df3c0cc150ca14
-  data.tar.gz: 9cda0e40938c1e7e5b8d69ddd7791484fa9bda4b165306d270852eaf0f0d80d25e87ba5e97829cd862ad526590b364ef77ec1d996035e5a2d85de0bd9783a74b
+  metadata.gz: b15c3fc421a0393bb0aa7e8fd8efe71c9fe91c19b1ba8a41d479058ca044726a06d227425ce6e03997c94b9a0fc5d0d8afefe4784903649bff39cd205e48546a
+  data.tar.gz: 2f347762328d8d2e1dbe528508c5a86c3714c1c0cb98c3fc39c1101950758a6e5c71abca7f7c8f21c0d346715cdc5a658984e146fa99e247caaecfb29ae63ace

data/.ruby-version

@@ -1 +1 @@
-2.3.6
+2.4.6

data/.travis.yml

@@ -1,19 +1,19 @@
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4.1
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 
 gemfile:
-  - gemfiles/4.0.gemfile
-  - gemfiles/4.1.gemfile
-  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
 
 matrix:
   exclude:
-    - rvm: 2.4.1
-      gemfile: gemfiles/4.0.gemfile
-    - rvm: 2.4.1
-      gemfile: gemfiles/4.1.gemfile
+    - rvm: 2.6.3
+      gemfile: gemfiles/5.0.gemfile
+    - rvm: 2.6.3
+      gemfile: gemfiles/5.1.gemfile
 
 before_install:
   - gem update bundler

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0
+- Not support ruby 2.3
+- Add copy_tuner:detect_conflict_keys task
+- Do not re-upload empty keys
+- Fix dual loading tasks
+- Remove config.copyray_js_injection_regexp_for_debug
+- Remove config.copyray_js_injection_regexp_for_precompiled
+- Download translation when initialization
+
 ## 0.4.11
 - changes
   - Fix hide toggle button on mobile device.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copy_tuner_client (0.4.12)
+    copy_tuner_client (0.5.0.pre)
       i18n (>= 0.5.0)
       json
 
@@ -76,7 +76,7 @@ GEM
       activesupport (>= 4.1.0)
     hashdiff (0.3.2)
     i18n (0.8.1)
-    json (2.1.0)
+    json (2.2.0)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)

data/README.md

@@ -17,6 +17,7 @@ Create config/initializers/copy_tuner.rb
 CopyTunerClient.configure do |config|
   config.api_key = 'YOUR-API-KEY'
   config.host = 'COPY-TUNER-HOST-NAME'
+  config.html_escape = true
 
   # I18n keys and messages will be sent to server if the locale matches
   config.locales = [:ja, :en]
@@ -72,4 +73,3 @@ $ npm run build   # Compile to a <script> containing a self-executing function
     $ bundle exec rake build      # build gem to pkg/ dir
     $ bundle exec rake install    # install to local gem
     $ bundle exec rake release    # release gem to rubygems.org
-

data/copy_tuner_client.gemspec

@@ -3,6 +3,7 @@ $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'copy_tuner_client/version'
 
 Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 2.4.0'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'json'
   s.add_development_dependency 'appraisal', '~> 2.1'

data/gemfiles/{4.1.gemfile → 5.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "4.1.16"
+gem "rails", "5.0.7.2"
 
 gemspec :path => "../"

data/gemfiles/{4.2.gemfile → 5.1.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "4.2.8"
+gem "rails", "5.1.7"
 
 gemspec :path => "../"

data/gemfiles/{4.0.gemfile → 5.2.gemfile}

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "4.0.13"
+gem "rails", "5.2.3"
 
 gemspec :path => "../"

data/lib/copy_tuner_client/cache.rb

@@ -1,5 +1,6 @@
 require 'thread'
 require 'copy_tuner_client/client'
+require 'copy_tuner_client/dotted_hash'
 
 module CopyTunerClient
   # Manages synchronization of copy between {I18nBackend} and {Client}. Acts
@@ -20,6 +21,7 @@ module CopyTunerClient
       @locales = Array(options[:locales]).map(&:to_s)
       # mutable states
       @blurbs = {}
+      @blank_keys = Set.new
       @queued = {}
       @started = false
       @downloaded = false
@@ -37,9 +39,12 @@ module CopyTunerClient
     # @param key [String] the key of the blurb to update
     # @param value [String] the new contents of the blurb
     def []=(key, value)
-      return if key =~ @exclude_key_regexp
+      return if @exclude_key_regexp && key.match?(@exclude_key_regexp)
       return if @locales.present? && !@locales.member?(key.split('.').first)
-      lock { @queued[key] = value }
+      lock do
+        return if @blank_keys.member?(key)
+        @queued[key] = value
+      end
     end
 
     # Keys for all blurbs stored on the server.
@@ -51,30 +56,7 @@ module CopyTunerClient
     # Yaml representation of all blurbs
     # @return [String] yaml
     def export
-      keys = {}
-      lock do
-        @blurbs.sort.each do |(blurb_key, value)|
-          current = keys
-          yaml_keys = blurb_key.split('.')
-
-          0.upto(yaml_keys.size - 2) do |i|
-            key = yaml_keys[i]
-
-            # Overwrite en.key with en.sub.key
-            unless current[key].class == Hash
-              current[key] = {}
-            end
-
-            current = current[key]
-          end
-
-          current[yaml_keys.last] = value
-        end
-      end
-
-      unless keys.size < 1
-        keys.to_yaml
-      end
+      lock { @blurbs.present? ? DottedHash.to_h(@blurbs).to_yaml : nil }
     end
 
     # Waits until the first download has finished.
@@ -108,8 +90,11 @@ module CopyTunerClient
       @started = true
 
       res = client.download do |downloaded_blurbs|
-        downloaded_blurbs.reject! { |key, value| value == '' }
-        lock { @blurbs = downloaded_blurbs }
+        blank_blurbs, blurbs = downloaded_blurbs.partition { |_key, value| value == '' }
+        lock do
+          @blank_keys = Set.new(blank_blurbs.to_h.keys)
+          @blurbs = blurbs.to_h
+        end
       end
 
       @last_downloaded_at = Time.now.utc
@@ -127,7 +112,7 @@ module CopyTunerClient
       flush
     end
 
-    attr_reader :last_downloaded_at, :last_uploaded_at, :queued
+    attr_reader :last_downloaded_at, :last_uploaded_at, :queued, :blurbs
 
     def inspect
       "#<CopyTunerClient::Cache:#{object_id}>"

data/lib/copy_tuner_client/client.rb

@@ -16,6 +16,8 @@ module CopyTunerClient
                    Net::ProtocolError, SocketError, OpenSSL::SSL::SSLError,
                    Errno::ECONNREFUSED]
 
+    USER_AGENT = "copy_tuner_client #{CopyTunerClient::VERSION}"
+
     # Usually instantiated from {Configuration#apply}. Copies options.
     # @param options [Hash]
     # @option options [String] :api_key API key of the project to connect to
@@ -67,7 +69,7 @@ module CopyTunerClient
     # @raise [ConnectionError] if the connection fails
     def upload(data)
       connect(host) do |http|
-        response = http.post(uri('draft_blurbs'), data.to_json, 'Content-Type' => 'application/json')
+        response = http.post(uri('draft_blurbs'), data.to_json, 'Content-Type' => 'application/json', 'User-Agent' => USER_AGENT)
         check response
         log 'Uploaded missing translations'
       end
@@ -77,7 +79,7 @@ module CopyTunerClient
     # @raise [ConnectionError] if the connection fails
     def deploy
       connect(host) do |http|
-        response = http.post(uri('deploys'), '')
+        response = http.post(uri('deploys'), '', 'User-Agent' => USER_AGENT)
         check response
         log 'Deployed'
       end

data/lib/copy_tuner_client/configuration.rb

@@ -119,12 +119,6 @@ module CopyTunerClient
     # @return [String] The S3 host to connect to (defaults to +copy-tuner-us.s3.amazonaws.com+).
     attr_accessor :s3_host
 
-    # @return [Regexp] Copyray js injection pattern for debug
-    attr_accessor :copyray_js_injection_regexp_for_debug
-
-    # @return [Regexp] Copyray js injection pattern for precompiled
-    attr_accessor :copyray_js_injection_regexp_for_precompiled
-
     # @return [Boolean] To disable Copyray comment injection, set true
     attr_accessor :disable_copyray_comment_injection
 
@@ -136,14 +130,6 @@ module CopyTunerClient
 
     alias_method :secure?, :secure
 
-    def copyray_js_injection_regexp_for_debug=(value)
-      logger.warn 'DEPRECATION WARNING: copyray_js_injection_regexp_for_debug is deprecated'
-    end
-
-    def copyray_js_injection_regexp_for_precompiled=(value)
-      logger.warn 'DEPRECATION WARNING: copyray_js_injection_regexp_for_precompiled is deprecated'
-    end
-
     # Instantiated from {CopyTunerClient.configure}. Sets defaults.
     def initialize
       self.client_name = 'CopyTuner Client'
@@ -269,7 +255,7 @@ module CopyTunerClient
         process_guard.start
       end
 
-      if test? and !disable_test_translation
+      if !(test? && disable_test_translation)
         logger.info "Download translation now"
         cache.download
       end

data/lib/copy_tuner_client/dotted_hash.rb

@@ -0,0 +1,32 @@
+module CopyTunerClient
+  module DottedHash
+    def to_h(dotted_hash)
+      hash = {}
+      dotted_hash.to_h.transform_keys(&:to_s).sort.each do |key, value|
+        _hash = key.split('.').reverse.inject(value) { |memo, key| { key => memo } }
+        hash.deep_merge!(_hash)
+      end
+      hash
+    end
+
+    def conflict_keys(dotted_hash)
+      all_keys = dotted_hash.keys.sort
+      results = {}
+
+      all_keys.each_with_index do |key, index|
+        prefix = "#{key}."
+        conflict_keys = ((index + 1)..Float::INFINITY)
+          .take_while { |i| all_keys[i]&.start_with?(prefix) }
+          .map { |i| all_keys[i] }
+
+        if conflict_keys.present?
+          results[key] = conflict_keys
+        end
+      end
+
+      results
+    end
+
+    module_function :to_h, :conflict_keys
+  end
+end

data/lib/copy_tuner_client/engine.rb

@@ -45,9 +45,5 @@ module CopyTunerClient
     initializer "copy_tuner.assets.precompile", group: :all do |app|
       app.config.assets.precompile += ["copyray.js", "copyray.css"]
     end
-
-    rake_tasks do
-      load "tasks/copy_tuner_client_tasks.rake"
-    end
   end
 end

data/lib/copy_tuner_client/version.rb

@@ -1,6 +1,6 @@
 module CopyTunerClient
   # Client version
-  VERSION = '0.4.12'.freeze
+  VERSION = '0.5.0.pre'.freeze
 
   # API version being used to communicate with the server
   API_VERSION = '2.0'.freeze

data/lib/tasks/copy_tuner_client_tasks.rake

@@ -17,4 +17,16 @@ namespace :copy_tuner do
       raise "No blurbs have been cached."
     end
   end
+
+  desc "Detect invalid keys."
+  task :detect_conflict_keys => :environment do
+    conflict_keys = CopyTunerClient::DottedHash.conflict_keys(CopyTunerClient.cache.blurbs)
+
+    if conflict_keys.empty?
+      puts 'All success'
+    else
+      pp conflict_keys
+      raise 'Exists invalid keys'
+    end
+  end
 end

data/spec/copy_tuner_client/cache_spec.rb

@@ -95,6 +95,20 @@ describe CopyTunerClient::Cache do
     expect(cache['test.key']).to eq('test value')
   end
 
+  it "download included empty keys" do
+    client['en.test.key'] = 'test value'
+    client['en.test.empty'] = ''
+    cache = build_cache
+
+    cache.download
+
+    expect(cache['en.test.key']).to eq('test value')
+    expect(cache['en.test.empty']).to eq(nil)
+
+    cache['en.test.empty'] = ''
+    expect(cache.queued).to be_empty
+  end
+
   it "handles connection errors when flushing" do
     failure = "server is napping"
     logger = FakeLogger.new
@@ -248,65 +262,33 @@ describe CopyTunerClient::Cache do
   end
 
   describe "#export" do
-    before do
-      save_blurbs
-      @cache = build_cache
-      @cache.download
-    end
+    subject { cache.export }
 
-    let(:save_blurbs) {}
+    let(:cache) do
+      cache = build_cache
+      cache.download
+      cache
+    end
 
     it "can be invoked from the top-level constant" do
       CopyTunerClient.configure do |config|
-        config.cache = @cache
+        config.cache = cache
       end
-      expect(@cache).to receive(:export)
-
+      expect(cache).to receive(:export)
       CopyTunerClient.export
     end
 
-    it "returns no yaml with no blurb keys" do
-      expect(@cache.export).to eq(nil)
+    it 'returns no yaml with no blurb keys' do
+      is_expected.to eq nil
     end
 
     context "with single-level blurb keys" do
-      let(:save_blurbs) do
+      before do
         client['key']       = 'test value'
         client['other_key'] = 'other test value'
       end
 
-      it "returns blurbs as yaml" do
-        exported = YAML.load(@cache.export)
-        expect(exported['key']).to eq('test value')
-        expect(exported['other_key']).to eq('other test value')
-      end
-    end
-
-    context "with multi-level blurb keys" do
-      let(:save_blurbs) do
-        client['en.test.key']       = 'en test value'
-        client['en.test.other_key'] = 'en other test value'
-        client['fr.test.key']       = 'fr test value'
-      end
-
-      it "returns blurbs as yaml" do
-        exported = YAML.load(@cache.export)
-        expect(exported['en']['test']['key']).to eq('en test value')
-        expect(exported['en']['test']['other_key']).to eq('en other test value')
-        expect(exported['fr']['test']['key']).to eq('fr test value')
-      end
-    end
-
-    context "with conflicting blurb keys" do
-      let(:save_blurbs) do
-        client['en.test']     = 'test value'
-        client['en.test.key'] = 'other test value'
-      end
-
-      it "retains the new key" do
-        exported = YAML.load(@cache.export)
-        expect(exported['en']['test']['key']).to eq('other test value')
-      end
+      it { is_expected.to eq "---\nkey: test value\nother_key: other test value\n" }
     end
   end
 end

data/spec/copy_tuner_client/dotted_hash_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe CopyTunerClient::DottedHash do
+  describe ".to_h" do
+    subject { CopyTunerClient::DottedHash.to_h(dotted_hash) }
+
+    context 'empty keys' do
+      let(:dotted_hash) { {} }
+
+      it { is_expected.to eq({}) }
+    end
+
+    context 'with single-level keys' do
+      let(:dotted_hash) { { 'key' => 'test value', other_key: 'other value' } }
+
+      it { is_expected.to eq({ 'key' => 'test value', 'other_key' => 'other value' }) }
+    end
+
+    context 'array of key value pairs' do
+      let(:dotted_hash) { [['key', 'test value'], ['other_key', 'other value']] }
+
+      it { is_expected.to eq({ 'key' => 'test value', 'other_key' => 'other value' }) }
+    end
+
+    context "with multi-level blurb keys" do
+      let(:dotted_hash) do
+        {
+          'en.test.key' => 'en test value',
+          'en.test.other_key' => 'en other test value',
+          'fr.test.key' => 'fr test value',
+        }
+      end
+
+      it do
+        is_expected.to eq({
+          'en' => {
+            'test' => {
+              'key' => 'en test value',
+              'other_key' => 'en other test value',
+            },
+          },
+          'fr' => {
+            'test' => {
+              'key' => 'fr test value',
+            },
+          },
+        })
+      end
+    end
+
+    context "with conflicting keys" do
+      let(:dotted_hash) do
+        {
+          'en.test' => 'invalid value',
+          'en.test.key' => 'en test value',
+        }
+      end
+
+      it { is_expected.to eq({ 'en' => { 'test' => { 'key' => 'en test value' } } }) }
+    end
+  end
+
+  describe ".conflict_keys" do
+    subject { CopyTunerClient::DottedHash.conflict_keys(dotted_hash) }
+
+    context 'valid keys' do
+      let(:dotted_hash) do
+        {
+          'ja.hoge.test' => 'test',
+          'ja.hoge.fuga' => 'test',
+        }
+      end
+
+      it { is_expected.to eq({}) }
+    end
+
+    context 'invalid keys' do
+      let(:dotted_hash) do
+        {
+          'ja.hoge.test' => 'test',
+          'ja.hoge.test.hoge' => 'test',
+          'ja.hoge.test.fuga' => 'test',
+          'ja.fuga.test.hoge' => 'test',
+          'ja.fuga.test' => 'test',
+        }
+      end
+
+      it do
+        is_expected.to eq({
+          'ja.fuga.test' => %w[ja.fuga.test.hoge],
+          'ja.hoge.test' => %w[ja.hoge.test.fuga ja.hoge.test.hoge],
+        })
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copy_tuner_client
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.5.0.pre
 platform: ruby
 authors:
 - SonicGarden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -233,9 +233,9 @@ files:
 - features/step_definitions/rails_steps.rb
 - features/support/env.rb
 - features/support/rails_server.rb
-- gemfiles/4.0.gemfile
-- gemfiles/4.1.gemfile
-- gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
 - init.rb
 - lib/copy_tuner_client.rb
 - lib/copy_tuner_client/cache.rb
@@ -243,6 +243,7 @@ files:
 - lib/copy_tuner_client/configuration.rb
 - lib/copy_tuner_client/copyray.rb
 - lib/copy_tuner_client/copyray_middleware.rb
+- lib/copy_tuner_client/dotted_hash.rb
 - lib/copy_tuner_client/engine.rb
 - lib/copy_tuner_client/errors.rb
 - lib/copy_tuner_client/i18n_backend.rb
@@ -263,6 +264,7 @@ files:
 - spec/copy_tuner_client/client_spec.rb
 - spec/copy_tuner_client/configuration_spec.rb
 - spec/copy_tuner_client/copyray_spec.rb
+- spec/copy_tuner_client/dotted_hash_spec.rb
 - spec/copy_tuner_client/i18n_backend_spec.rb
 - spec/copy_tuner_client/poller_spec.rb
 - spec/copy_tuner_client/prefixed_logger_spec.rb
@@ -299,15 +301,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: Client for the CopyTuner copy management service
@@ -321,6 +323,7 @@ test_files:
 - spec/copy_tuner_client/client_spec.rb
 - spec/copy_tuner_client/configuration_spec.rb
 - spec/copy_tuner_client/copyray_spec.rb
+- spec/copy_tuner_client/dotted_hash_spec.rb
 - spec/copy_tuner_client/i18n_backend_spec.rb
 - spec/copy_tuner_client/poller_spec.rb
 - spec/copy_tuner_client/prefixed_logger_spec.rb