crowdin-cli 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec62d7630395f2ae965291604abd246301af25c7
-  data.tar.gz: d7bb48ee1d3ee17812851cefbd9b447cba80a3aa
+  metadata.gz: ca670246e92cc0a4e9af4f79a32762d67b4c33c6
+  data.tar.gz: deec43f00c30bb9d2c7cdeafa0142da169e0c1e2
 SHA512:
-  metadata.gz: 36045d1831fb72b6de47919cf8399e5c169ee14bcfdf4babf97ac7c37605cc315e00a62ab02ae57f7856ab8bcd2bf1db8ca438bf785dae21baac773f0f8a8583
-  data.tar.gz: c2ba7e4bf0d09d544cb2af5f15411a5ae1ff2840ff77ab6298171dccdf63c8b2ca74ed89366689c46d08519fbd7d27417dad0755d3985aecf92dc4cc0a73d50f
+  metadata.gz: 7009d7b1074c12834278b452c25ecd1f16cc337c071210e10e693201f00868b1dcdd8783a0b743eeb83a71b87f239b3e3767966d55fef3b46b007a517c71da6c
+  data.tar.gz: 7b8d0757f24bbfa593cf6a5137c0370a5fd5328fba279b2861354f0a427e3c1228c30edaf0f58c98e08b94baa026c9414f150383c8e7dda43a0ab15ac3deb137

data/README.md

@@ -74,7 +74,7 @@ files:
       * `%file_extension%` - Original file extension
       * `%file_name%` - File name without extension
       * `%osx_code%` - OS X Locale identifier used to name ".lproj" directories
-      * `%osx_xliff%` - OS X Locale used to name xliff files (i.e. uk.xliff)
+      * `%osx_locale%` - OS X Locale identifier
 
          Example for Android projects:
           ```

data/bin/crowdin-cli

@@ -20,14 +20,16 @@ I18n.locale = :en
 #
 # +files+ - basically, it's project files details from API method `project_info`
 #
-def get_remote_files_hierarchy(files, root = '/', hierarchy = { dirs: [], files: [] })
+def get_remote_files_hierarchy(files, root = '/', hierarchy: { dirs: [], files: [] }, include_branches: true)
   files.each do |node|
     case node['node_type']
     when 'branch'
-      get_remote_files_hierarchy(node['files'], root + node['name'] + '/', hierarchy)
+      if include_branches
+        get_remote_files_hierarchy(node['files'], root + node['name'] + '/', hierarchy: hierarchy)
+      end
     when 'directory'
       hierarchy[:dirs] << "#{root}#{node['name']}"
-      get_remote_files_hierarchy(node['files'], root + node['name'] + '/', hierarchy)
+      get_remote_files_hierarchy(node['files'], root + node['name'] + '/', hierarchy: hierarchy)
     when 'file'
       hierarchy[:files] << "#{root}#{node['name']}"
     end
@@ -36,6 +38,14 @@ def get_remote_files_hierarchy(files, root = '/', hierarchy = { dirs: [], files:
   return hierarchy
 end
 
+# Return branches in Crowdin project
+#
+# +files+ - basically, it's project files details from API method `project_info`
+#
+def get_branches(files)
+  files.select { |node| node["node_type"] == "branch" }.map { |branch| branch["name"] }
+end
+
 # Return +hierarchy+ of local directories and files
 #
 # @params [Array] files a list of files in a local directory.
@@ -102,7 +112,7 @@ end
 #
 def construct_export_pattern(path, source, translation)
   pattern_regexp = translate_pattern_to_regexp(source)
-  if pattern_regexp.names.include?('double_asterisk') and path.match(pattern_regexp)
+  if pattern_regexp.names.include?('double_asterisk') && path.match(pattern_regexp)
     double_asterisk = path.match(pattern_regexp)['double_asterisk']
     translation = translation.sub('**', double_asterisk)
   end
@@ -136,7 +146,7 @@ def translate_pattern_to_regexp(pat)
     i = i + 1
     if c == '*'
       j = i
-      if j < n and pat[j] == '*'
+      if j < n && pat[j] == '*'
         res[-1] = '(\/)?(?<double_asterisk>.*)?'
         i = j + 1
       else
@@ -149,16 +159,16 @@ def translate_pattern_to_regexp(pat)
       # The following two statements check if the sequence we stumbled
       # upon is '[]' or '[^]' because those are not valid character
       # classes.
-      if j < n and pat[j] == '^'
+      if j < n && pat[j] == '^'
         j = j + 1
       end
-      if j < n and pat[j] == ']'
+      if j < n && pat[j] == ']'
         j = j + 1
       end
       # Look for the closing ']' right off the bat. If one is not found,
       # escape the opening '[' and continue.  If it is found, process
       # he contents of '[...]'.
-      while j < n and pat[j] != ']'
+      while j < n && pat[j] != ']'
         j = j + 1
       end
       if j >= n
@@ -226,36 +236,37 @@ end
 # +files_list+ is a Hash of key-value pairs. Where key is a possible archive filename based on current project configuration
 # and value is the expanded filename
 #
-def unzip_file_with_translations(zipfile_name, dest_path, files_list, ignore_match)
+def unzip_file_with_translations(zipfile_name, dest_path, files_list, ignore_match, ignored_paths = [])
   # overwrite files if they already exist inside of the extracted path
   Zip.on_exists_proc = true
 
   # files that exists in archive and doesn't match current project configuration
   unmatched_files = []
 
-  Zip::File.open(zipfile_name) do |zipfile|
-    zipfile.restore_permissions = false
-    zipfile.select { |zip_entry| zip_entry.file? }.each do |f|
-      filename = f.name
-      if @branch_name and @base_path_contains_branch_subfolders
+  Zip::File.open(zipfile_name) do |zip_file|
+    zip_file.restore_permissions = false
+    zip_file.select(&:file?).each do |zip_entry|
+      next if zip_entry.name.start_with?(*ignored_paths)
+
+      filename = zip_entry.name
+      if @branch_name && @base_path_contains_branch_subfolders
         # strip branch from filename
-        filename = f.name.sub(File.join(@branch_name, '/'), '')
+        filename = zip_entry.name.sub(File.join(@branch_name, '/'), '')
       end
 
-      # `f' - relative path in archive
       file = files_list[filename]
       if file
         fpath = File.join(dest_path, file)
         FileUtils.mkdir_p(File.dirname(fpath))
         puts "Extracting: `#{file}'"
-        zipfile.extract(f, fpath)
+        zip_file.extract(zip_entry, fpath)
       else
-        unmatched_files << f
+        unmatched_files << zip_entry
       end
     end
   end
 
-  unless unmatched_files.empty? or ignore_match
+  unless unmatched_files.empty? || ignore_match
     puts "Warning: Downloaded translations do not match current project configuration. The following files will be omitted:"
     unmatched_files.each { |file| puts " - `#{file}'" }
   end
@@ -309,14 +320,6 @@ def display_tree(files_tree, level = -2, branches = [])
   end
 end
 
-class String
-  def strip_heredoc
-    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
-    gsub(/^[ \t]{#{indent}}/, '')
-  end
-end
-
-###
 include GLI::App
 
 version Crowdin::CLI::VERSION
@@ -719,18 +722,16 @@ command :download do |c|
   c.desc I18n.t('app.commands.download.switches.ignore_match.desc')
   c.switch ['ignore-match'], negatable: false
 
-  c.desc I18n.t('app.commands.download.switches.include_unchanged')
+  c.desc I18n.t('app.commands.download.switches.include_unchanged.desc')
   c.switch ['include-unchanged'], negatable: false
 
   c.action do |global_options, options, args|
-    if @branch_name
-      branch = @project_info['files'].find { |h| h['node_type'] == 'branch' && h['name'] == @branch_name }
+    branches = get_branches(@project_info['files'])
 
-      unless branch
-        exit_now! <<-EOS.strip_heredoc
-            path `#{@branch_name}' did not match any branch known to Crowdin
-        EOS
-      end
+    if @branch_name && !branches.include?(@branch_name)
+      exit_now! <<~HEREDOC
+          path `#{@branch_name}' did not match any branch known to Crowdin
+      HEREDOC
     end
 
     language = options[:language]
@@ -842,7 +843,7 @@ command :download do |c|
     begin
       @crowdin.download_translation(language, params)
 
-      unzip_file_with_translations(zipfile_name, @base_path, downloadable_files_hash, options['ignore-match'])
+      unzip_file_with_translations(zipfile_name, @base_path, downloadable_files_hash, options['ignore-match'], branches)
     ensure
       tempfile.close
       tempfile.unlink # delete the tempfile
@@ -865,20 +866,21 @@ command :list do |ls_cmd|
     prj_cmd.flag [:b, :branch]
 
     prj_cmd.action do |global_options, options, args|
+      branches = get_branches(@project_info['files'])
       if @branch_name
         branch = @project_info['files'].find { |h| h['node_type'] == 'branch' && h['name'] == @branch_name }
 
         unless branch
-          exit_now! <<-EOS.strip_heredoc
+          exit_now! <<~HEREDOC
             path `#{@branch_name}' did not match any branch known to Crowdin
-          EOS
+          HEREDOC
         end
 
         branch_files = [] << branch
 
         remote_project_tree = get_remote_files_hierarchy(branch_files)
       else
-        remote_project_tree = get_remote_files_hierarchy(@project_info['files'])
+        remote_project_tree = get_remote_files_hierarchy(@project_info['files'], include_branches: false)
       end
 
       if options[:tree]
@@ -890,6 +892,17 @@ command :list do |ls_cmd|
     end
   end
 
+  ls_cmd.desc I18n.t('app.commands.list.commands.branches.desc')
+  ls_cmd.command :branches do |branches_cmd|
+    branches_cmd.action do |global_options, options, args|
+      branches = get_branches(@project_info['files'])
+      branches.each do |branch|
+        puts "- #{branch}"
+      end
+    end
+  end
+
+
   ls_cmd.desc I18n.t('app.commands.list.commands.sources.desc')
   ls_cmd.command :sources do |src_cmd|
     src_cmd.desc I18n.t('app.commands.list.switches.tree.desc')
@@ -1046,12 +1059,12 @@ pre do |globals, command, options, args|
   ]
 
   unless File.exist?(globals[:config])
-    exit_now! <<-EOS.strip_heredoc
+    exit_now! <<~HEREDOC
       Can't find configuration file (default `crowdin.yaml').
       Type `crowdin-cli help` to know how to specify custom configuration file
 
       See http://crowdin.com/page/cli-tool#configuration-file for more details
-    EOS
+    HEREDOC
   end
 
   # load project-specific configuration
@@ -1063,12 +1076,12 @@ pre do |globals, command, options, args|
     #
     @config = YAML.load(ERB.new(File.read(globals[:config])).result) || {}
   rescue Psych::SyntaxError => err
-    exit_now! <<-EOS.strip_heredoc
+    exit_now! <<~HEREDOC
       Could not parse YAML: #{err.message}
 
       We were unable to successfully parse the crowdin.yaml file that you provided - most likely it is not well-formatted YAML.
       Please check whether your crowdin.yaml is valid YAML - you can use the http://yamllint.com/ validator to do this - and make any necessary changes to fix it.
-    EOS
+    HEREDOC
   end
 
   # try to load the API credentials from an environment variable, e.g.
@@ -1096,37 +1109,37 @@ pre do |globals, command, options, args|
 
   ['api_key', 'project_identifier'].each do |key|
     unless @config[key]
-      exit_now! <<-EOS.strip_heredoc
+      exit_now! <<~HEREDOC
         Configuration file misses required option `#{key}`
 
         See http://crowdin.com/page/cli-tool#configuration-file for more details
-      EOS
+      HEREDOC
     end
   end
 
   unless @config['files']
-    exit_now! <<-EOS.strip_heredoc
+    exit_now! <<~HEREDOC
       Configuration file misses required section `files`
 
       See https://crowdin.com/page/cli-tool#configuration-file for more details
-    EOS
+    HEREDOC
   end
 
   @config['files'].each do |file|
     unless file['source']
-      exit_now! <<-EOS.strip_heredoc
+      exit_now! <<~HEREDOC
         Files section misses required parameter `source`
 
         See https://crowdin.com/page/cli-tool#configuration-file for more details
-      EOS
+      HEREDOC
     end
 
     unless file['translation']
-      exit_now! <<-EOS.strip_heredoc
+      exit_now! <<~HEREDOC
         Files section misses required parameter `translation`
 
         See https://crowdin.com/page/cli-tool#configuration-file for more details
-      EOS
+      HEREDOC
     end
 
     file['source'] = '/' + file['source'] unless file['source'].start_with?('/')
@@ -1134,20 +1147,20 @@ pre do |globals, command, options, args|
 
     if file['source'].include?('**')
       if file['source'].scan('**').size > 1
-        exit_now! <<-EOS.strip_heredoc
+        exit_now! <<~HEREDOC
           Source pattern `#{file['source']}` is not valid. The mask `**` can be used only once in the source pattern.
-        EOS
-      elsif file['source'].scan('**').size == 1 and !file['source'].match(/\/\*\*\//)
-        exit_now! <<-EOS.strip_heredoc
+        HEREDOC
+      elsif file['source'].scan('**').size == 1 && !file['source'].match(/\/\*\*\//)
+        exit_now! <<~HEREDOC
           Source pattern `#{file['source']}` is not valid. The mask `**` must be surrounded by slashes `/` in the source pattern.
-        EOS
+        HEREDOC
       end
     else
       if file['translation'].include?('**')
-        exit_now! <<-EOS.strip_heredoc
+        exit_now! <<~HEREDOC
           Translation pattern `#{file['translation']}` is not valid. The mask `**` can't be used.
           When using `**` in 'translation' pattern it will always contain sub-path from 'source' for certain file.
-        EOS
+        HEREDOC
       end
     end
 
@@ -1157,9 +1170,9 @@ pre do |globals, command, options, args|
     @base_path = @config['base_path']
   else
     @base_path = Dir.pwd
-    puts <<-EOS.strip_heredoc
+    puts <<~HEREDOC
       Warning: Configuration file misses parameter `base_path` that defines your project root directory. Using `#{@base_path}` as a root directory.
-    EOS
+    HEREDOC
   end
 
   @base_path_contains_branch_subfolders = false
@@ -1170,21 +1183,21 @@ pre do |globals, command, options, args|
       when false
         false
       else
-        exit_now! <<-EOS.strip_heredoc
+        exit_now! <<~HEREDOC
           Parameter `base_path_contains_branch_subfolders` allows values of true or false.
-        EOS
+        HEREDOC
     end
   end
 
   @branch_name = options[:branch] || nil
-  if @branch_name and @base_path_contains_branch_subfolders
+  if @branch_name && @base_path_contains_branch_subfolders
     @base_path = File.join(@base_path, @branch_name)
   end
 
   unless Dir.exist?(@base_path)
-    exit_now! <<-EOS.strip_heredoc
+    exit_now! <<~HEREDOC
       No such directory `#{@base_path}`. Please make sure that the `base_path` is properly set.
-    EOS
+    HEREDOC
   end
 
   @preserve_hierarchy = false
@@ -1195,9 +1208,9 @@ pre do |globals, command, options, args|
       when false
         false
       else
-        exit_now! <<-EOS.strip_heredoc
+        exit_now! <<~HEREDOC
           Parameter `preserve_hierarchy` allows values of true or false.
-        EOS
+        HEREDOC
     end
   end
 

data/lib/crowdin-cli/version.rb

@@ -1,5 +1,5 @@
 module Crowdin
   module CLI
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

data/locales/en.yml

@@ -68,7 +68,6 @@ en:
           include_unchanged:
             desc: |
               Download all translation files whether or not they have changes
-
       list:
         desc: Show a list of files (the current project)
         long_desc: |
@@ -76,6 +75,8 @@ en:
         commands:
           project:
             desc: List information about the files that already exists in current project
+          branches:
+            desc: List remote-tracking branches
           sources:
             desc: List information about the sources files in current project that match the wild-card pattern
           translations:
@@ -83,3 +84,5 @@ en:
         switches:
           tree:
             desc: list contents of directories in a tree-like format
+          include_branches:
+            desc: include branches

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: crowdin-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Crowdin
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="