copy_tuner_client 0.5.1 → 0.7.0

data/Rakefile

@@ -1,26 +1,16 @@
 require 'bundler/gem_tasks'
-require 'appraisal'
-require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
 require 'yard'
 
-desc 'Default: run the specs and features.'
-task :default => [:spec, :cucumber]
+desc 'Default: run the specs.'
+task default: [:spec]
 
 desc 'Test the copy_tuner_client plugin.'
 RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ['--color', "--format progress"]
+  t.rspec_opts = ['--color', '--format progress']
   t.pattern = 'spec/copy_tuner_client/**/*_spec.rb'
 end
 
-desc "Run cucumber features"
-Cucumber::Rake::Task.new do |t|
-  t.cucumber_opts = [
-    '--tags', '~@wip',
-    '--format', (ENV['CUCUMBER_FORMAT'] || 'progress')
-  ]
-end
-
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb']
+  t.files = ['lib/**/*.rb']
 end

data/copy_tuner_client.gemspec

@@ -3,15 +3,12 @@ $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.required_ruby_version = '>= 2.5.0'
   s.add_dependency 'i18n', '>= 0.5.0'
   s.add_dependency 'json'
-  s.add_development_dependency 'appraisal', '~> 2.1'
-  s.add_development_dependency 'aruba', '~> 0.6.0'
-  s.add_development_dependency 'cucumber', '~> 1.3.16'
-  s.add_development_dependency 'rails', '~> 4.2.6'
+  s.add_development_dependency 'rails', '~> 5.2.4.2'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '3.8.0' # NOTE: 3.9.0だとundefined method `synchronize'でコケるテストがある
   s.add_development_dependency 'sham_rack'
   s.add_development_dependency 'sinatra'
   s.add_development_dependency 'sqlite3'

data/gemfiles/5.2.gemfile

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

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

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

data/lib/copy_tuner_client/cache.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'copy_tuner_client/client'
 require 'copy_tuner_client/dotted_hash'
 
@@ -18,6 +17,7 @@ module CopyTunerClient
       @logger = options[:logger]
       @mutex = Mutex.new
       @exclude_key_regexp = options[:exclude_key_regexp]
+      @upload_disabled = options[:upload_disabled]
       @locales = Array(options[:locales]).map(&:to_s)
       # mutable states
       @blurbs = {}
@@ -40,9 +40,13 @@ module CopyTunerClient
     # @param value [String] the new contents of the blurb
     def []=(key, value)
       return if @exclude_key_regexp && key.match?(@exclude_key_regexp)
+      return unless key.include?('.')
       return if @locales.present? && !@locales.member?(key.split('.').first)
+      return if @upload_disabled
+
       lock do
         return if @blank_keys.member?(key) || @blurbs.key?(key)
+
         @queued[key] = value
       end
     end
@@ -61,17 +65,15 @@ module CopyTunerClient
 
     # Waits until the first download has finished.
     def wait_for_download
-      if pending?
-        logger.info 'Waiting for first download'
+      return unless pending?
 
-        if logger.respond_to? :flush
-          logger.flush
-        end
+      logger.info 'Waiting for first download'
 
-        while pending?
-          sleep 0.1
-        end
+      if logger.respond_to? :flush
+        logger.flush
       end
+
+      sleep 0.1 while pending?
     end
 
     def flush
@@ -82,8 +84,8 @@ module CopyTunerClient
       @last_uploaded_at = Time.now.utc
 
       res
-    rescue ConnectionError => error
-      logger.error error.message
+    rescue ConnectionError => e
+      logger.error e.message
     end
 
     def download
@@ -100,8 +102,8 @@ module CopyTunerClient
       @last_downloaded_at = Time.now.utc
 
       res
-    rescue ConnectionError => error
-      logger.error error.message
+    rescue ConnectionError => e
+      logger.error e.message
     ensure
       @downloaded = true
     end

data/lib/copy_tuner_client/configuration.rb

@@ -57,6 +57,9 @@ module CopyTunerClient
     # @return [Array<String>] A list of environments in which the server should not be contacted
     attr_accessor :test_environments
 
+    # @return [Array<String>] A list of environments in which the server should not be upload
+    attr_accessor :upload_disabled_environments
+
     # @return [String] The name of the environment the application is running in
     attr_accessor :environment_name
 
@@ -145,6 +148,7 @@ module CopyTunerClient
       self.sync_interval_staging = 0
       self.secure = true
       self.test_environments = %w(test cucumber)
+      self.upload_disabled_environments = []
       self.s3_host = 'copy-tuner-data-prod.s3.amazonaws.com'
       self.disable_copyray_comment_injection = false
       self.html_escape = false
@@ -163,7 +167,7 @@ module CopyTunerClient
     # Returns a hash of all configurable options
     # @return [Hash] configuration attributes
     def to_hash
-      base_options = { :public => public? }
+      base_options = { public: public?, upload_disabled: upload_disabled? }
 
       OPTIONS.inject(base_options) do |hash, option|
         hash.merge option.to_sym => send(option)
@@ -198,7 +202,11 @@ module CopyTunerClient
     # Determines if the content will fetched from the server
     # @return [Boolean] Returns +true+ if in a test environment, +false+ otherwise.
     def test?
-      test_environments.include? environment_name
+      test_environments.include?(environment_name)
+    end
+
+    def upload_disabled?
+      upload_disabled_environments.include?(environment_name)
     end
 
     # Determines if the configuration has been applied (internal)

data/lib/copy_tuner_client/engine.rb

@@ -13,7 +13,13 @@ module CopyTunerClient
         ActionView::Helpers::TranslationHelper.class_eval do
           def translate_with_copyray_comment(key, options = {})
             source = translate_without_copyray_comment(key, options)
-            if !CopyTunerClient.configuration.disable_copyray_comment_injection && (options[:rescue_format] == :html || options[:rescue_format].nil?)
+            # TODO: 0.6.0以降で options[:rescue_format] == text を消す
+            if CopyTunerClient.configuration.disable_copyray_comment_injection || options[:rescue_format] == :text
+              if options[:rescue_format] == :text
+                ActiveSupport::Deprecation.warn('rescue_format option is deprecated in copy_tuner_client@0.6.0')
+              end
+              source
+            else
               separator = options[:separator] || I18n.default_separator
               scope = options[:scope]
               normalized_key =
@@ -23,8 +29,6 @@ module CopyTunerClient
                   I18n.normalize_keys(nil, key, scope, separator).join(separator)
                 end
               CopyTunerClient::Copyray.augment_template(source, normalized_key)
-            else
-              source
             end
           end
           if CopyTunerClient.configuration.enable_middleware?

data/lib/copy_tuner_client/translation_log.rb

@@ -19,12 +19,10 @@ module CopyTunerClient
     def self.install_hook
       I18n.class_eval do
         class << self
-          def translate_with_copy_tuner_hook(*args)
-            key = args[0]
-            options  = args.last.is_a?(Hash) ? args.last : {}
+          def translate_with_copy_tuner_hook(key, **options)
             scope = options[:scope]
             scope = scope.dup if scope.is_a?(Array) || scope.is_a?(String)
-            result = translate_without_copy_tuner_hook(*args)
+            result = translate_without_copy_tuner_hook(key, **options)
 
             if key.is_a?(Array)
               key.zip(result).each { |k, v| CopyTunerClient::TranslationLog.add(I18n.normalize_keys(nil, k, scope).join('.'), v) unless v.is_a?(Array) }
@@ -33,6 +31,7 @@ module CopyTunerClient
             end
             result
           end
+
           if CopyTunerClient.configuration.enable_middleware?
             alias_method :translate_without_copy_tuner_hook, :translate
             alias_method :translate, :translate_with_copy_tuner_hook

data/lib/copy_tuner_client/version.rb

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

data/lib/tasks/copy_tuner_client_tasks.rake

@@ -6,13 +6,13 @@ namespace :copy_tuner do
   end
 
   desc "Export CopyTuner blurbs to yaml."
-  task :export => :environment do
+  task :export, %i[path] => :environment do |_, args|
+    args.with_defaults(path: "config/locales/copy_tuner.yml")
     CopyTunerClient.cache.sync
 
     if yml = CopyTunerClient.export
-      path = "config/locales/copy_tuner.yml"
-      File.new("#{Rails.root}/#{path}", 'w').write(yml)
-      puts "Successfully exported blurbs to #{path}."
+      File.new("#{Rails.root}/#{args[:path]}", 'w').write(yml)
+      puts "Successfully exported blurbs to #{args[:path]}."
     else
       raise "No blurbs have been cached."
     end

data/spec/copy_tuner_client/cache_spec.rb

@@ -9,7 +9,7 @@ describe CopyTunerClient::Cache do
     CopyTunerClient::Cache.new(client, default_config.update(config))
   end
 
-  it "provides access to downloaded data" do
+  it 'provides access to downloaded data' do
     client['en.test.key']       = 'expected'
     client['en.test.other_key'] = 'expected'
 
@@ -18,17 +18,17 @@ describe CopyTunerClient::Cache do
     cache.download
 
     expect(cache['en.test.key']).to eq('expected')
-    expect(cache.keys).to match_array(%w(en.test.key en.test.other_key))
+    expect(cache.keys).to match_array(%w[en.test.key en.test.other_key])
   end
 
-  it "exclude data if exclude_key_regexp is set" do
+  it 'exclude data if exclude_key_regexp is set' do
     cache = build_cache(exclude_key_regexp: /^en\.test\.other_key$/)
     cache['en.test.key']       = 'expected'
     cache['en.test.other_key'] = 'expected'
 
     cache.download
 
-    expect(cache.queued.keys).to match_array(%w(en.test.key))
+    expect(cache.queued.keys).to match_array(%w[en.test.key])
   end
 
   it "doesn't upload without changes" do
@@ -37,7 +37,15 @@ describe CopyTunerClient::Cache do
     expect(client).not_to be_uploaded
   end
 
-  it "uploads changes when flushed" do
+  it "Don't upload incorrect key" do
+    cache = build_cache
+    cache['ja'] = 'incorrect key'
+
+    cache.flush
+    expect(client).not_to be_uploaded
+  end
+
+  it 'uploads changes when flushed' do
     cache = build_cache
     cache['test.key'] = 'test value'
 
@@ -46,7 +54,7 @@ describe CopyTunerClient::Cache do
     expect(client.uploaded).to eq({ 'test.key' => 'test value' })
   end
 
-  it "uploads empties when nil is assigned" do
+  it 'uploads empties when nil is assigned' do
     cache = build_cache
     cache['test.key'] = nil
 
@@ -62,7 +70,7 @@ describe CopyTunerClient::Cache do
 
     cache.flush
 
-    expect(client.uploaded).to eq({'en.test.key' => 'uploaded en', 'ja.test.key' => 'uploaded ja'})
+    expect(client.uploaded).to eq({ 'en.test.key' => 'uploaded en', 'ja.test.key' => 'uploaded ja' })
   end
 
   it 'upload with locale filter' do
@@ -72,10 +80,10 @@ describe CopyTunerClient::Cache do
 
     cache.flush
 
-    expect(client.uploaded).to eq({'en.test.key' => 'uploaded'})
+    expect(client.uploaded).to eq({ 'en.test.key' => 'uploaded' })
   end
 
-  it "downloads changes" do
+  it 'downloads changes' do
     client['test.key'] = 'test value'
     cache = build_cache
 
@@ -84,7 +92,7 @@ describe CopyTunerClient::Cache do
     expect(cache['test.key']).to eq('test value')
   end
 
-  it "downloads and uploads when synced" do
+  it 'downloads and uploads when synced' do
     cache = build_cache
     client['test.key'] = 'test value'
     cache['other.key'] = 'other value'
@@ -95,7 +103,7 @@ describe CopyTunerClient::Cache do
     expect(cache['test.key']).to eq('test value')
   end
 
-  it "download included empty keys" do
+  it 'download included empty keys' do
     client['en.test.key'] = 'test value'
     client['en.test.empty'] = ''
     cache = build_cache
@@ -109,7 +117,7 @@ describe CopyTunerClient::Cache do
     expect(cache.queued).to be_empty
   end
 
-  it "Do not upload downloaded keys" do
+  it 'Do not upload downloaded keys' do
     client['en.test.key'] = 'test value'
     cache = build_cache
 
@@ -119,11 +127,11 @@ describe CopyTunerClient::Cache do
     expect(cache.queued).to be_empty
   end
 
-  it "handles connection errors when flushing" do
-    failure = "server is napping"
+  it 'handles connection errors when flushing' do
+    failure = 'server is napping'
     logger = FakeLogger.new
     expect(client).to receive(:upload).and_raise(CopyTunerClient::ConnectionError.new(failure))
-    cache = build_cache(:logger => logger)
+    cache = build_cache(logger: logger)
     cache['upload.key'] = 'upload'
 
     cache.flush
@@ -131,22 +139,22 @@ describe CopyTunerClient::Cache do
     expect(logger).to have_entry(:error, failure)
   end
 
-  it "handles connection errors when downloading" do
-    failure = "server is napping"
+  it 'handles connection errors when downloading' do
+    failure = 'server is napping'
     logger = FakeLogger.new
     expect(client).to receive(:download).and_raise(CopyTunerClient::ConnectionError.new(failure))
-    cache = build_cache(:logger => logger)
+    cache = build_cache(logger: logger)
 
     cache.download
 
     expect(logger).to have_entry(:error, failure)
   end
 
-  it "blocks until the first download is complete" do
+  it 'blocks until the first download is complete' do
     logger = FakeLogger.new
     expect(logger).to receive(:flush)
     client.delay = true
-    cache = build_cache(:logger => logger)
+    cache = build_cache(logger: logger)
 
     t_download = Thread.new { cache.download }
     sleep 0.1 until cache.pending?
@@ -154,7 +162,7 @@ describe CopyTunerClient::Cache do
     t_wait = Thread.new do
       cache.wait_for_download
     end
-    sleep 0.1 until logger.has_entry?(:info, "Waiting for first download")
+    sleep 0.1 until logger.has_entry?(:info, 'Waiting for first download')
     client.go
     expect(t_download.join(1)).not_to be_nil
     expect(cache.pending?).to be_falsey
@@ -163,7 +171,7 @@ describe CopyTunerClient::Cache do
 
   it "doesn't block if the first download fails" do
     client.delay = true
-    client.error = StandardError.new("Failure")
+    client.error = StandardError.new('Failure')
     cache = build_cache
 
     error = nil
@@ -183,12 +191,12 @@ describe CopyTunerClient::Cache do
     expect(t_download.join(1)).not_to be_nil
     expect(error).to be_kind_of(StandardError)
     expect(t_wait.join(1)).not_to be_nil
-    expect { cache.download }.to raise_error(StandardError, "Failure")
+    expect { cache.download }.to raise_error(StandardError, 'Failure')
   end
 
   it "doesn't block before downloading" do
     logger = FakeLogger.new
-    cache = build_cache(:logger => logger)
+    cache = build_cache(logger: logger)
 
     finished = false
     Thread.new do
@@ -199,7 +207,7 @@ describe CopyTunerClient::Cache do
     sleep(1)
 
     expect(finished).to eq(true)
-    expect(logger).not_to have_entry(:info, "Waiting for first download")
+    expect(logger).not_to have_entry(:info, 'Waiting for first download')
   end
 
   it "doesn't return blank copy" do
@@ -211,13 +219,13 @@ describe CopyTunerClient::Cache do
     expect(cache['en.test.key']).to be_nil
   end
 
-  describe "given locked mutex" do
+  describe 'given locked mutex' do
     RSpec::Matchers.define :finish_after_unlocking do |mutex|
       match do |thread|
         sleep(0.1)
 
         if thread.status === false
-          violated("finished before unlocking")
+          violated('finished before unlocking')
         else
           mutex.unlock
           sleep(0.1)
@@ -225,7 +233,7 @@ describe CopyTunerClient::Cache do
           if thread.status === false
             true
           else
-            violated("still running after unlocking")
+            violated('still running after unlocking')
           end
         end
       end
@@ -248,20 +256,20 @@ describe CopyTunerClient::Cache do
       allow(Mutex).to receive(:new).and_return(mutex)
     end
 
-    it "synchronizes read access to keys between threads" do
+    it 'synchronizes read access to keys between threads' do
       expect(Thread.new { cache['test.key'] }).to finish_after_unlocking(mutex)
     end
 
-    it "synchronizes read access to the key list between threads" do
+    it 'synchronizes read access to the key list between threads' do
       expect(Thread.new { cache.keys }).to finish_after_unlocking(mutex)
     end
 
-    it "synchronizes write access to keys between threads" do
+    it 'synchronizes write access to keys between threads' do
       expect(Thread.new { cache['test.key'] = 'value' }).to finish_after_unlocking(mutex)
     end
   end
 
-  it "flushes from the top level" do
+  it 'flushes from the top level' do
     cache = build_cache
     CopyTunerClient.configure do |config|
       config.cache = cache
@@ -271,7 +279,7 @@ describe CopyTunerClient::Cache do
     CopyTunerClient.flush
   end
 
-  describe "#export" do
+  describe '#export' do
     subject { cache.export }
 
     let(:cache) do
@@ -280,7 +288,7 @@ describe CopyTunerClient::Cache do
       cache
     end
 
-    it "can be invoked from the top-level constant" do
+    it 'can be invoked from the top-level constant' do
       CopyTunerClient.configure do |config|
         config.cache = cache
       end
@@ -292,7 +300,7 @@ describe CopyTunerClient::Cache do
       is_expected.to eq nil
     end
 
-    context "with single-level blurb keys" do
+    context 'with single-level blurb keys' do
       before do
         client['key']       = 'test value'
         client['other_key'] = 'other test value'