crowdin-cli 0.1.6 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c178a88fbbd85d28ee2bbc8e3b88a79eb4d0cd46
-  data.tar.gz: d5032076e80d9bc7fff12c3cf9a40ad27759018d
+  metadata.gz: a3ff7f5862e6cdfc6f19faa22a7c6e9d2a1aba5c
+  data.tar.gz: e8f7cc6f44b5a4109f4ef5405e1bb914c339344a
 SHA512:
-  metadata.gz: c6d09b538ad1efc838e1abe5b1d6ae7da6336ef954a505fbc5cf3a9804c7cbb37bbde3dd15ad090c33026c86ae9500b1304aadd9a6cc7aaebcdb69146afdf002
-  data.tar.gz: aab99a8aeeff33da9f056d4816109be366379cd8d57a3c8f48c1a578eaec3323d74c7c5ff74709cc251532f7e760f8a09092291ebabc93be88583c38afe516d2
+  metadata.gz: 7e6356eee6ca194d2e6a29c2082b60ff1a04761076718d48c499bd6a9b3698eacd68ca6a42442774e7fe733e82f762687a4b346d7d4d997d5fb01f144cef685d
+  data.tar.gz: feb7abd1dccf237b26b65b609828de63a5d33d07c6a884edc16540ef97fc3f04bbc1e967ae96a3632d5a9431c50520b10cfdfa2cf612682e0d64c4f2a69f3733

data/README.md

@@ -255,4 +255,4 @@ Author: Anton Maminov (anton.maminov@gmail.com)
 
 Copyright: 2012-2013 [Crowdin.net](http://crowdin.net/)
 
-This library is distributed under the MIT license.  Please see the LICENSE file.
+This project is licensed under the MIT license, a copy of which can be found in the LICENSE file.

data/bin/crowdin-cli

@@ -5,6 +5,11 @@ require 'crowdin-cli'
 
 # GLI_DEBUG=true bundle exec bin/crowdin-cli
 
+# Setup i18n
+# tell the I18n library where to find your translations
+I18n.load_path += Dir[Pathname(__FILE__).dirname.expand_path + '../locales/*.yml']
+I18n.locale = :en
+
 # Return +hierarchy+ of directories and files in Crowdin project
 #
 # +files+ - basically, it's project files details from API method `project_info`
@@ -72,7 +77,7 @@ def export_pattern_to_path(path, export_pattern, lang, languages_mapping = nil)
   placeholders = pattern.inject([]){ |memo, h| memo << h.first[/%(.*)%/, 1] }
 
   unless languages_mapping.nil?
-    pattern = Hash[pattern.map{|placeholder, str| [
+    pattern = Hash[pattern.map{ |placeholder, str| [
       placeholder,
       (languages_mapping[placeholder[/%(.*)%/, 1]][lang['crowdin_code']] rescue nil) || str]
     }]
@@ -181,7 +186,7 @@ def unzip_file(zip, dest, files_list)
       if file
         f_path = File.join(dest, file)
         FileUtils.mkdir_p(File.dirname(f_path))
-        puts "Download: #{file}"
+        puts "Download: `#{file}'"
         zip_file.extract(f, f_path)
       else
         unmatched_files << f
@@ -201,33 +206,30 @@ include GLI::App
 
 version Crowdin::CLI::VERSION
 
-program_desc 'is a command line tool that allows you to manage and synchronize your localization resources with Crowdin project'
-program_long_desc 'This tool requires configuration file to be created. See http://crowdin.net/page/cli-tool#configuration-file for more details.'
+subcommand_option_handling :normal
+
+program_desc I18n.t('app.desc')
+program_long_desc I18n.t('app.long_desc')
 sort_help :manually # help commands are ordered in the order declared
 wrap_help_text :to_terminal
 
-desc 'Be verbose'
-switch [:v, :verbose]
+desc I18n.t('app.switches.verbose.desc')
+switch [:verbose, :v], :negatable => false
 
-desc 'Configuration file'
+desc I18n.t('app.flags.config.desc')
 default_value File.join(Dir.pwd, 'crowdin.yaml')
 arg_name '<s>'
-flag [:c, :config]
-
-desc 'Allows you to upload source files and existing translations to Crowdin project'
-long_desc 'This command is used to upload source files and translations to Crowdin. This command is used in combination with sub-commands `sources` and `translations`.'
+flag [:config,:c]
 
+desc I18n.t('app.commands.upload.desc')
+long_desc I18n.t('app.commands.upload.long_desc')
 command :upload do |c|
 
-  c.desc 'safely upload source files to Crowdin'
-  c.long_desc <<EOS
-Upload source files to Crowdin project. If there are new localization files locally they will be added to Crowdin project.
-Othervice files will be updated (if no --no-auto-update option specified).
-EOS
-
+  c.desc I18n.t('app.commands.upload.commands.sources.desc')
+  c.long_desc I18n.t('app.commands.upload.commands.sources.long_desc')
   c.command :sources do |c|
 
-    c.desc 'Defines whether to update source files in Crowdin project. --no-auto-update is useful when you just want to upload new files without updating existing ones.'
+    c.desc I18n.t('app.commands.upload.commands.sources.switches.auto_update.desc')
     c.switch ['auto-update']
 
     c.action do |global_options, options, args|
@@ -276,7 +278,11 @@ EOS
       end # @config['files']
 
       if dest_files.empty?
-        exit_now!("nothing to upload. See http://crowdin.net/page/cli-tool#configuration-file for more details.")
+        exit_now! <<EOS
+No source files to upload.
+Check your configuration file to ensure that they contain valid directives.
+See http://crowdin.net/page/cli-tool#configuration-file for more details.
+EOS
       end
 
       common_dir = @preserve_hierarchy ? '' : find_common_directory_path(dest_files)
@@ -334,28 +340,22 @@ EOS
     end # action
   end # command
 
-  c.desc 'upload existing translations to Crowdin project'
-  c.long_desc <<EOS
-Upload existing translations to Crowdin.
-See below available options that can be used in combination with this command.
-If no options specified uploaded translations will be not approved,
-imported to Crowdin project even if they are duplicated and imported even they are equal to souce string.
-(In many localization formats they can be considered as not actually translations).
-EOS
+  c.desc I18n.t('app.commands.upload.commands.translations.desc')
+  c.long_desc I18n.t('app.commands.upload.commands.translations.long_desc')
   c.command :translations do |c|
 
-    c.desc 'Defines what language upload translations to. By default translations will be uploaded for all Crowdin project target languages'
+    c.desc I18n.t('app.commands.upload.commands.translations.flags.language.desc')
     c.default_value 'all'
     c.arg_name 'crowdin_language_code'
-    c.flag [:l, :language]
+    c.flag [:language, :l]
 
-    c.desc 'Defines whether to add translation if there is the same translation already existing in Crowdin project'
+    c.desc I18n.t('app.commands.upload.commands.translations.switches.import_duplicates.desc')
     c.switch ['import-duplicates']
 
-    c.desc 'Defines whether to add translation if it is equal to source string in Crowdin project'
+    c.desc I18n.t('app.commands.upload.commands.translations.switches.import_eq_suggestions.desc')
     c.switch ['import-eq-suggestions']
 
-    c.desc 'Automatically approve uploaded translations'
+    c.desc I18n.t('app.commands.upload.commands.translations.switches.auto_approve_imported.desc')
     c.switch ['auto-approve-imported']
 
     c.action do |global_options, options, args|
@@ -370,10 +370,13 @@ EOS
 
       remote_project_tree = get_remote_files_hierarchy(project_info['files'])
 
-      if language == 'all'
-        project_languages = project_info['languages'].collect{ |h| h['code'] }
-      else
-        project_languages = [] << language
+      project_languages = project_info['languages'].collect{ |h| h['code'] }
+      if language != 'all'
+        if project_languages.include?(language)
+          project_languages = [] << language
+        else
+          exit_now!("language '#{language}' doesn't exist in a project")
+        end
       end
 
       supported_languages = @crowdin.supported_languages
@@ -417,14 +420,18 @@ EOS
       end # @config['files']
 
       if dest_files.empty?
-        exit_now!("Warning: nothing to upload. See http://crowdin.net/page/cli-tool#configuration-file for more details.")
+        exit_now! <<EOS
+No translation files to upload.
+Check your configuration file to ensure that they contain valid directives.
+See http://crowdin.net/page/cli-tool#configuration-file for more details.
+EOS
       end
 
       common_dir = @preserve_hierarchy ? '' : find_common_directory_path(dest_files)
 
-      translated_files.each do |language, files|
+      translated_files.each_pair do |language, files|
         files.each do |file|
-          file[:dest].sub!(common_dir, '')
+          file[:dest] = file[:dest].sub(common_dir, '')
 
           if remote_project_tree[:files].include?(file[:dest])
             if File.exist?(file[:source])
@@ -433,9 +440,9 @@ EOS
               resp = @crowdin.upload_translation([] << file, language, params)
               case resp['files'].first[1]
               when 'skipped'
-                puts "\rUploading translation `#{file[:source].sub(@base_path, '')}' - Skipped"
+                puts "\rUploading translation file `#{file[:source].sub(@base_path, '')}' - Skipped"
               when 'uploaded'
-                puts "\rUploading translation `#{file[:source].sub(@base_path, '')}' - OK"
+                puts "\rUploading translation file `#{file[:source].sub(@base_path, '')}' - OK"
               end
             else
               puts "Warning: Local file `#{file[:source]}' does not exists"
@@ -444,7 +451,6 @@ EOS
             # if source file not exist, don't upload translation
             puts "Warning: Skip `#{file[:source].sub(@base_path, '')}'"
           end
-
         end
       end
 
@@ -453,29 +459,33 @@ EOS
 
 end
 
-desc 'Download latest translations from Crowdin and put them to the right places in your project'
+desc I18n.t('app.commands.download.desc')
 #arg_name 'Describe arguments to download here'
 command :download do |c|
 
-  c.desc 'If the option is defined the translations will be downloaded for single specified language. Othervice (by default) translations are downloaded for all languages'
+  c.desc I18n.t('app.commands.download.flags.language.desc')
   c.arg_name 'language_code'
-  c.flag :l, :language, :default_value => 'all'
+  c.flag [:language, :l], :default_value => 'all'
 
   c.action do |global_options ,options, args|
-    # use export API method before to download the most recent translations
-    @crowdin.export_translations
-
     language = options[:language]
+
     project_info = @crowdin.project_info
 
     remote_project_tree = get_remote_files_hierarchy(project_info['files'])
 
-    if language == 'all'
-      project_languages = project_info['languages'].collect{ |h| h['code'] }
-    else
-      project_languages = [] << language
+    project_languages = project_info['languages'].collect{ |h| h['code'] }
+    if language != 'all'
+      if project_languages.include?(language)
+        project_languages = [] << language
+      else
+        exit_now!("language '#{language}' doesn't exist in a project")
+      end
     end
 
+    # use export API method before to download the most recent translations
+    @crowdin.export_translations
+
     supported_languages = @crowdin.supported_languages
     translation_languages = supported_languages.select{ |lang| project_languages.include?(lang['crowdin_code']) }
 
@@ -504,7 +514,7 @@ command :download do |c|
           dest = source.sub("#{@base_path}", '') # relative path in Crowdin
 
           export_pattern = construct_export_pattern(dest, file['source'], file['translation'])
-          
+
           translation_languages.each do |lang|
             zipped_file = export_pattern_to_path(dest, export_pattern, lang)
             local_file  = export_pattern_to_path(dest, export_pattern, lang, languages_mapping)
@@ -520,7 +530,7 @@ command :download do |c|
     file = Tempfile.new(language)
     path = file.path
     begin
-      @crowdin.download_translation(language, :output => path)
+      @crowdin.download_translation(language, output: path)
       unzip_file(path, @base_path, downloadable_files)
     ensure
       file.close
@@ -530,15 +540,15 @@ command :download do |c|
 
 end
 
-pre do |global ,command, options, args|
+pre do |globals ,command, options, args|
   # Pre logic here
   # Return true to proceed; false to abourt and not call the
   # chosen command
   # Use skips_pre before a command to skip this block
   # on that command only
 
-  if File.exists?(global[:config])
-    @config = YAML.load_file(global[:config])
+  if File.exists?(globals[:config])
+    @config = YAML.load_file(globals[:config])
 
     ['api_key', 'project_identifier'].each do |key|
       unless @config[key]
@@ -601,10 +611,11 @@ Warning: Configuration file misses parameter `base_path` that defines your proje
 EOS
   end
 
-  if @config['target_path']
-    @target_path = @config['target_path']
+  if @config['remote_path']
+    @remote_path = @config['remote_path']
+    @remote_path = '/' + @remote_path unless @remote_path.start_with?('/')
   else
-    @target_path = ''
+    @remote_path = ''
   end
 
   @preserve_hierarchy = false
@@ -621,7 +632,7 @@ EOS
     end
   end
 
-  Crowdin::API.log = Logger.new($stderr) if global[:v]
+  Crowdin::API.log = Logger.new($stderr) if globals[:verbose]
   @crowdin = Crowdin::API.new(api_key: @config['api_key'], project_id: @config['project_identifier'], base_url: @config['base_url'] || 'http://api.crowdin.net')
   begin
     @crowdin.project_info
@@ -631,15 +642,15 @@ EOS
     exit_now!("Seems Crowdin server API URL is not valid. Please check the `base_url` parameter in the configuration file.")
   end
 
-  #puts "Executing #{command.name}" if global[:v]
+  #puts "Executing #{command.name}" if globals[:verbose]
   true
 end
 
-post do |global, command, options, args|
+post do |globals, command, options, args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only
-  #puts "Executed #{command.name}" if global[:v]
+  #puts "Executed #{command.name}" if globals[:verbose]
 end
 
 on_error do |exception|

data/lib/crowdin-cli.rb

@@ -8,4 +8,5 @@ require 'json'
 require 'logger'
 require 'gli'
 require 'zip/zip'
+require 'i18n'
 require 'crowdin-api'

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.1.6'
+    VERSION = '0.1.8'
   end
 end

data/locales/en.yml

@@ -0,0 +1,57 @@
+en:
+  app:
+    desc: is a command line tool that allows you to manage and synchronize your localization resources with Crowdin project
+    long_desc: |
+      This tool requires configuration file to be created.
+      See http://crowdin.net/page/cli-tool#configuration-file for more details.
+    flags:
+      config:
+        desc: The configuration file
+    switches:
+      verbose:
+        desc: Be verbose
+    commands:
+      upload:
+        desc: Allows you to upload source files and existing translations to Crowdin project.
+        long_desc: |
+          This command is used to upload source files and translations to Crowdin.
+          This command is used in combination with sub-commands `sources` and `translations`
+        commands:
+          sources:
+            desc: safely upload source files to Crowdin
+            long_desc: |
+              Upload source files to Crowdin project.
+              If there are new localization files locally they will be added to Crowdin project.
+              Othervice files will be updated (if no --no-auto-update option specified).
+            switches:
+              auto_update:
+                desc: |
+                  Defines whether to update source files in Crowdin project.
+                  --no-auto-update is useful when you just want to upload new files without updating existing ones.
+          translations:
+            desc: upload existing translations to Crowdin project
+            long_desc: |
+              Upload existing translations to Crowdin.
+              See below available options that can be used in combination with this command.
+              If no options specified uploaded translations will be not approved,
+              imported to Crowdin project even if they are duplicated and imported even they are equal to souce string.
+              (In many localization formats they can be considered as not actually translations).
+            flags:
+              language:
+                desc: |
+                  Defines what language upload translations to.
+                  By default translations will be uploaded for all Crowdin project target languages
+            switches:
+              import_duplicates:
+                desc: Defines whether to add translation if there is the same translation already existing in Crowdin project
+              import_eq_suggestions:
+                desc: Defines whether to add translation if it is equal to source string in Crowdin project
+              auto_approve_imported:
+                desc: Automatically approve uploaded translations
+      download:
+        desc: Download latest translations from Crowdin and put them to the right places in your project
+        flags:
+          language:
+            desc: |
+              If the option is defined the translations will be downloaded for single specified language.
+              Othervice (by default) translations are downloaded for all languages

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.8
 platform: ruby
 authors:
 - Crowdin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 2.4.1
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.0.11
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 description: 
 email:
 - support@crowdin.net
@@ -105,6 +119,7 @@ files:
 - bin/crowdin-cli
 - lib/crowdin-cli/version.rb
 - lib/crowdin-cli.rb
+- locales/en.yml
 - README.md
 - LICENSE
 homepage: https://github.com/crowdin/crowdin-cli/