onesky-rails 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7310078e5234d06c2c9bf53aeaf4dc69c7460386
-  data.tar.gz: 01d3730c16eb8b98cee057605eb73de3c73b2ba5
+SHA256:
+  metadata.gz: 980a8350341a3615e0824dd9c47e1bd1c9ebc8359bf2e13f65835a0a76c1726a
+  data.tar.gz: 6d2fe1027039c511a7fb65be8d713fc017e9f2870e0fd2c05dc32d7d7551b445
 SHA512:
-  metadata.gz: 769551ebb66adc4badd7dbe197fa653142719a385d732cc89c4d7dd1afff2dd74a606176d6cf3a8701e55cc787b8f4db16fc11e4f980a6470d8b7730fb3f7e79
-  data.tar.gz: 02f599857a3116ef72575bc84c7f54f02ae021e9e1afc0980d5ca5e574d4dd227de2ec141c391c5ac6844ac26425e4db5119707d4cd04bc1eb549d62197fa7d3
+  metadata.gz: 321c893d64a191c1f1e65b6c5b5e74fe772537940d3f76121d2d28dd675b76db312fee7dce798898af0a0b34445b70887ea792af1df3d5fc996196f7f871405f
+  data.tar.gz: 1bf61f47c360285dbcfd3b5b929b235124e2c19845ecaa77a375406c373feaac632c2f8dc6a72e756576df9b96376ff4dca21d9de227f2a2289ee14acb46e1f2

data/.travis.yml

@@ -1,5 +1,3 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - 3.0

data/CHANGELOG.md

@@ -1,13 +1,28 @@
-### 0.0.1 - 4-NOV-2014
+### 1.6.0 - 12-AUG-2021
 
-* Generate config file
-* Upload base locale string files to OneSky
-* Download translations from OneSky
+* Update dependencies to support Ruby 3.0.x
+* Use v1.3.1 onesky-ruby gem
 
-### 1.0.0 - 31-DEC-2014
+### 1.5.0 - 18-OCT-2019
 
-* Add custom header
-* bump version to 1.0.0 as stable version
+* Use v1.2.0 onesky-ruby gem
+
+### 1.4.1 - 11-JUN-2019
+
+* Update dependencies to support Ruby 2.5.x
+
+### 1.3.1 - 17-MAY-2016
+
+* fix downloaded file naming
+
+### 1.3.0 - 13-MAY-2016
+
+* support download base language only translation files
+* support download all translation files
+
+### 1.2.0 - 13-JUL-2015
+
+* support custom locale
 
 ### 1.1.0 - 9-JUN-2015
 
@@ -15,6 +30,13 @@
 * able to parse ERB template
 * able to customize base_locale
 
-### 1.2.0 - 13-JUL-2015
+### 1.0.0 - 31-DEC-2014
 
-* support custom locale
+* Add custom header
+* bump version to 1.0.0 as stable version
+
+### 0.0.1 - 4-NOV-2014
+
+* Generate config file
+* Upload base locale string files to OneSky
+* Download translations from OneSky

data/README.md

@@ -36,12 +36,24 @@ Upload all string files of `I18n.default_locale` to [OneSky](http://www.oneskyap
 ```
 rake onesky:download
 ```
-Download translations of files uploaded in all languages activated in project.
+Download translations of files uploaded in all languages activated in project other than the base language.
+
+**Download base language translations**
+```
+rake onesky:download_base
+```
+Download translations of files uploaded only for the base language.
+
+**Download all languages translations**
+```
+rake onesky:download_all
+```
+Download translations of files uploaded for all the languages including the base language.
 
 ## TODO
 - Specify file to upload
 - Specify file and language to download
-- Support framework other than RoR
+- Support different backend
 
 ## Contributing
 

data/lib/generators/templates/onesky.yml.tt

@@ -13,3 +13,9 @@ project_id: <%= config_hash[:project_id] %>
 
 upload:
   is_keeping_all_strings: true
+  # Uncomment one of these to filter files in your locales directory
+  # only:
+  #   - cms/en.yml
+  # except:
+  #   - admin.yml
+  #   - rails.yml

data/lib/onesky/rails/file_client.rb

@@ -28,12 +28,30 @@ NOTICE
         end
       end
 
-      def download(string_path)
+      ##
+      # Download translations from OneSky platform
+      #
+      # +string_path+ specify the folder path where all localization files locate
+      # +options+     indicate which files to download
+      #               - :base_only => base language only
+      #               - :all       => all languages including base language
+      #               - <empty>    => default value; translation languages
+      #
+      def download(string_path, options = {})
         verify_languages!
 
         files = get_default_locale_files(string_path).map {|path| File.basename(path)}
 
-        @onesky_locales.each do |locale|
+        locales = if options[:base_only]
+          [@base_locale]
+        elsif options[:all]
+          [@base_locale] + @onesky_locales
+        else
+          @onesky_locales
+        end
+
+        locales.each do |locale|
+          locale = locale.to_s
           puts "#{locale_dir(locale)}/"
           onesky_locale = locale.gsub('_', '-')
           files.each do |file|
@@ -53,17 +71,27 @@ NOTICE
       end
 
       def make_translation_dir(dir_path, locale)
+        return dir_path if locale == @base_locale.to_s
+
         target_path = File.join(dir_path, locale_dir(locale))
         Dir.mkdir(target_path) unless File.directory?(target_path)
         target_path
       end
 
       def locale_file_name(file, to_locale)
-        file.sub(@base_locale.to_s, to_locale)
+        if File.basename(file, '.*') == @base_locale.to_s
+          file.sub(@base_locale.to_s, to_locale)
+        else
+          file
+        end
       end
 
       def get_default_locale_files(string_path)
+        string_path = Pathname.new(string_path)
+        locale_files_filter = generate_locale_files_filter
         Dir.glob("#{string_path}/**/*.yml").map do |path|
+          relative_path = Pathname.new(path).relative_path_from(string_path).to_s
+          next if locale_files_filter && !locale_files_filter.call(relative_path)
           content_hash = YAML.load_file(path)
           path if content_hash && content_hash.has_key?(@base_locale.to_s)
         end.compact
@@ -80,9 +108,28 @@ NOTICE
       end
 
       def is_keep_strings?
-        return true unless (@config.has_key?('upload') && @config['upload'].has_key?('is_keeping_all_strings'))
+        return true unless upload_config.has_key?('is_keeping_all_strings')
+
+        !!upload_config['is_keeping_all_strings']
+      end
+
+      def generate_locale_files_filter
+        only = Array(upload_config['only'])
+        except = Array(upload_config['except'])
+
+        if only.any? && except.any?
+          raise ArgumentError, "Invalid config. Can't use both `only` and `except` options."
+        end
+
+        if only.any?
+          ->(path) { only.include?(path) }
+        elsif except.any?
+          ->(path) { !except.include?(path) }
+        end
+      end
 
-        !!@config['upload']['is_keeping_all_strings']
+      def upload_config
+        @config['upload'] ||= {}
       end
 
     end

data/lib/onesky/rails/version.rb

@@ -1,5 +1,5 @@
 module Onesky
   module Rails
-    VERSION = "1.2.0"
+    VERSION = "1.6.0"
   end
 end

data/lib/tasks/onesky.rake

@@ -1,17 +1,29 @@
 namespace :onesky do
 
-  desc "Upload string files of base locale to OneSky platform."
+  desc 'Upload string files of base locale to OneSky platform.'
   task :upload => :environment do
     file_client.upload(locale_path)
     puts 'Done!'
   end
 
-  desc "Download translations from OneSky platform."
+  desc 'Download translations from OneSky platform.'
   task :download => :environment do
     file_client.download(locale_path)
     puts 'Done!'
   end
 
+  desc 'Download base language translations from OneSky platform.'
+  task :download_base => :environment do
+    file_client.download(locale_path, base_only: true)
+    puts 'Done!'
+  end
+
+  desc 'Download all languages translations from OneSky platform.'
+  task :download_all => :environment do
+    file_client.download(locale_path, all: true)
+    puts 'Done!'
+  end
+
   def file_client
     require 'erb'
     data = YAML::load(ERB.new(File.read(Rails.root.join('config', 'onesky.yml'))).result)
@@ -19,7 +31,7 @@ namespace :onesky do
   end
 
   def locale_path
-    Rails.root.join("config/locales")
+    Rails.root.join('config/locales')
   end
 
 end

data/onesky-rails.gemspec

@@ -19,11 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "i18n", ">= 0.5.0"
-  spec.add_dependency "onesky-ruby", "~> 1.0.0"
+  spec.add_dependency "onesky-ruby", "~> 1.3.1"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "rspec", "~> 3.1.0"
-  spec.add_development_dependency "timecop", "~> 0.7.0"
-  spec.add_development_dependency "webmock", "~> 1.19.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+  spec.add_development_dependency "timecop", "~> 0.9.0"
+  spec.add_development_dependency "webmock", "~> 3.0.0"
 end

data/spec/fixtures/sample_files/en/en.yml

@@ -0,0 +1,13 @@
+en:
+  week:
+    sun: Sunday
+    mon: Monday
+    tue: Tuesday
+    wed: Wednesday
+    thu: Thursday
+    fri: Friday
+    sat: Saturday
+  date:
+    year: Year
+    month: month
+    day: Day

data/spec/fixtures/sample_files/en/menu.yml

@@ -0,0 +1,3 @@
+en:
+  some: thing
+  i18n: internationalization

data/spec/fixtures/{locales → sample_files/ja}/ja.yml

@@ -7,3 +7,7 @@ ja:
     thu: 木曜日
     fri: 金曜日
     sat: 土曜日
+  date:
+    year: 年
+    month: 月
+    day: 日

data/spec/fixtures/sample_files/ja/menu.yml

@@ -0,0 +1,3 @@
+ja:
+  some: もの
+  i18n: 国際化

data/spec/onesky/rails/file_client_spec.rb

@@ -4,72 +4,158 @@ describe Onesky::Rails::FileClient do
 
   let(:config_hash) { create_config_hash }
   let(:client) {Onesky::Rails::FileClient.new(config_hash)}
+  let(:sample_file_path) { File.expand_path("../../../fixtures/sample_files", __FILE__) }
   let(:file_path) { File.expand_path("../../../fixtures/locales", __FILE__) }
 
   before(:each) do
     stub_language_request(config_hash['api_key'], config_hash['api_secret'], config_hash['project_id'])
+
+    # create test dir
+    FileUtils.copy_entry "#{sample_file_path}/original", file_path
+  end
+
+  after(:each) do
+    # delete test dir
+    FileUtils.remove_dir(file_path) if File.directory?(file_path)
+  end
+
+  def create_config_hash_with_upload_options(upload_options)
+    create_config_hash.tap do |config|
+      config['upload'].merge!(upload_options)
+    end
   end
 
   context '#upload' do
-    it 'all translation files to onesky' do
+    before(:each) do
       stub_request(:post, full_path_with_auth_hash("/projects/#{config_hash['project_id']}/files", config_hash['api_key'], config_hash['api_secret']))
         .to_return(status: 201)
+    end
 
-      expect(client.upload(file_path)).to match_array(["#{file_path}/en.yml","#{file_path}/special_en.yml"])
+    it 'all translation files to onesky' do
+      expect(client.upload(file_path)).to match_array(["#{file_path}/en.yml","#{file_path}/menu.yml"])
     end
-  end
 
-  context 'download' do
+    context 'with `only` option' do
+      let(:config_hash) { create_config_hash_with_upload_options('only' => 'menu.yml') }
 
-    let(:expected_locale_files) do
-      ["#{locale_dir}/ja.yml", "#{locale_dir}/special_ja.yml"]
+      it 'matching translation files to onesky' do
+        expect(client.upload(file_path)).to match_array(["#{file_path}/menu.yml"])
+      end
     end
 
-    let(:file_names) {['en.yml', 'special_en.yml']}
+    context 'with `except` option' do
+      let(:config_hash) { create_config_hash_with_upload_options('except' => 'menu.yml') }
 
-    def locale_dir
-      File.join(file_path, 'onesky_ja')
+      it 'matching translation files to onesky' do
+        expect(client.upload(file_path)).to match_array(["#{file_path}/en.yml"])
+      end
     end
+  end
 
-    def locale_files
-      Dir.glob("#{locale_dir}/*.yml")
+  context 'download' do
+
+    let(:file_names) do
+      # source filename => downloaded filename
+      {
+        'en.yml' => {'en' => 'en.yml', 'ja' => 'ja.yml'},
+        'menu.yml' => {'en' => 'menu.yml', 'ja' => 'menu.yml'}
+      }
     end
 
-    def delete_test_dir
-      if File.directory?(locale_dir)
-        File.delete(*Dir.glob("#{locale_dir}/**/*"))
-        Dir.delete(locale_dir)
-      end
+    def locale_dir(locale)
+      locale == I18n.default_locale.to_s ? file_path : File.join(file_path, 'onesky_ja')
     end
 
-    before(:each) do
-      delete_test_dir
+    def locale_files(locale)
+      Dir.glob("#{locale_dir(locale)}/*.yml")
     end
 
-    after(:each) do
-      delete_test_dir
+    def expected_locale_files(locale)
+      ["#{locale_dir(locale)}/#{locale}.yml", "#{locale_dir(locale)}/menu.yml"]
     end
 
     it 'download translations from OneSky and save as YAML files' do
-      prepare_download_requests!
+      locale = 'ja'
+      prepare_download_requests!(locale)
 
-      expect(locale_files).to be_empty
+      expect(locale_files(locale)).to be_empty
       client.download(file_path)
-      expect(locale_files).to match_array(expected_locale_files)
+      expect(locale_files(locale)).to match_array(expected_locale_files(locale))
+    end
+
+    it 'download translations of base language from OneSky' do
+      locale = 'en'
+      prepare_download_requests!(locale)
+
+      client.download(file_path, base_only: true)
+
+      # test files created
+      expected_files = expected_locale_files(locale)
+      expect(locale_files(locale)).to match_array(expected_files)
+
+      # test file content
+      content = YAML.load_file(expected_files.pop)
+      expected_content = YAML.load_file(File.join(sample_file_path, locale, 'menu.yml'))
+      expect(content).to eq(expected_content)
+    end
+
+    it 'download all translations including base language from OneSky' do
+      locales = ['en', 'ja']
+      locales.each { |locale| prepare_download_requests!(locale) }
+
+      client.download(file_path, all: true)
+
+      locales.each do |locale|
+        # test files created
+        expected_files = expected_locale_files(locale)
+        expect(locale_files(locale)).to match_array(expected_files)
+
+        # test file content
+        content = YAML.load_file(expected_files.pop)
+        expected_content = YAML.load_file(File.join(sample_file_path, locale, "menu.yml"))
+        expect(content).to eq(expected_content)
+      end
+    end
+
+    context 'with `only` option' do
+      let(:config_hash) { create_config_hash_with_upload_options('only' => 'menu.yml') }
+      let(:expected_locale_files) { ["#{locale_dir(locale)}/menu.yml"] }
+      let(:locale) { 'ja' }
+
+      it 'downloads matching translation from OneSky and save as YAML files' do
+        prepare_download_requests!(locale)
+        expect(locale_files(locale)).to be_empty
+        client.download(file_path)
+        expect(locale_files(locale)).to match_array(expected_locale_files)
+      end
+    end
+
+    context 'with `except` option' do
+      let(:config_hash) { create_config_hash_with_upload_options('except' => 'menu.yml') }
+      let(:expected_locale_files) { ["#{locale_dir(locale)}/ja.yml"] }
+      let(:locale) { 'ja' }
+
+      it 'downloads matching translation from OneSky and save as YAML files' do
+        prepare_download_requests!(locale)
+        expect(locale_files(locale)).to be_empty
+        client.download(file_path)
+        expect(locale_files(locale)).to match_array(expected_locale_files)
+      end
     end
 
-    def prepare_download_requests!
+    def prepare_download_requests!(locale)
       Timecop.freeze
-      file_names.each do |file_name|
+      file_names.keys.each do |file_name|
+        downloaded_file_name = file_names[file_name][locale]
         response_headers = {
           'Content-Type'        => 'text/plain',
-          'Content-Disposition' => "attachment; filename=#{file_name}",
+          'Content-Disposition' => "attachment; filename=#{downloaded_file_name}",
         }
-        query_string = "&source_file_name=#{file_name}&locale=ja"
+        query_string = "&source_file_name=#{file_name}&locale=#{locale}"
         stub_request(:get, full_path_with_auth_hash("/projects/#{config_hash['project_id']}/translations", config_hash['api_key'], config_hash['api_secret']) + query_string)
           .to_return(
             status: 200,
-            body: File.read(File.join(file_path, file_name)),
+            body: File.read(File.join(sample_file_path, locale, downloaded_file_name)),
             headers: response_headers)
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onesky-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Victor Lam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 3.0.0
 description: Integrate Rails app with OneSky that provide `upload` and `download`
   rake command to sync string files
 email:
@@ -133,10 +133,12 @@ files:
 - lib/onesky/rails/version.rb
 - lib/tasks/onesky.rake
 - onesky-rails.gemspec
-- spec/fixtures/locales/en.json
-- spec/fixtures/locales/en.yml
-- spec/fixtures/locales/ja.yml
-- spec/fixtures/locales/special_en.yml
+- spec/fixtures/sample_files/en/en.yml
+- spec/fixtures/sample_files/en/menu.yml
+- spec/fixtures/sample_files/ja/ja.yml
+- spec/fixtures/sample_files/ja/menu.yml
+- spec/fixtures/sample_files/original/en.yml
+- spec/fixtures/sample_files/original/menu.yml
 - spec/onesky/rails/client_spec.rb
 - spec/onesky/rails/file_client_spec.rb
 - spec/spec_helper.rb
@@ -159,16 +161,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.2.19
 signing_key: 
 specification_version: 4
 summary: Rails plugin to sync string files with OneSky
 test_files:
-- spec/fixtures/locales/en.json
-- spec/fixtures/locales/en.yml
-- spec/fixtures/locales/ja.yml
-- spec/fixtures/locales/special_en.yml
+- spec/fixtures/sample_files/en/en.yml
+- spec/fixtures/sample_files/en/menu.yml
+- spec/fixtures/sample_files/ja/ja.yml
+- spec/fixtures/sample_files/ja/menu.yml
+- spec/fixtures/sample_files/original/en.yml
+- spec/fixtures/sample_files/original/menu.yml
 - spec/onesky/rails/client_spec.rb
 - spec/onesky/rails/file_client_spec.rb
 - spec/spec_helper.rb

data/spec/fixtures/locales/en.json

@@ -1,13 +0,0 @@
-{
-  "en": {
-    "week": {
-      "sun": "Sunday",
-      "mon": "Monday",
-      "tue": "Tuesday",
-      "wed": "Wednesday",
-      "thu": "Thursday",
-      "fri": "Friday",
-      "sat": "Saturday"
-    }
-  }
-}