poeditor-cli 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3981c762a561c1d20ae5e66b5f200f00a2e3e6b
-  data.tar.gz: adfdd3ff5b171bc1d4098af35299e87d677bb086
+  metadata.gz: 6fbda657a807e50916c5267d8fce2241ada1d793
+  data.tar.gz: d9fdd116dd94f743e15ba290b1ab25ba24712ce3
 SHA512:
-  metadata.gz: 21c12379f59d9d8bfd10c4f56e5f22c6c230906cf9053d0ab358247ed46db22ef3d2d088623ebd35ccb249f20f8d8e5ad903811f374f96bcc8435b3af8ad3bfd
-  data.tar.gz: 8cd8959d0dec9bd5e33b962ecb493fe75d936df16eac5bda2d9dff3e41afdb624e7bbd24781986c1dc8d69d39a23b4af89072c7529702a22118f06ad63f9310e
+  metadata.gz: 9fadb20d2c78f046d02aca7ad03dd1d7eaa7543d7bb46facff717366491944f7c81afe0b49c3b4a206b57b657ea81b7ee4411a448dc0cca5d6fae1de8f4c842e
+  data.tar.gz: 3a485b69c6e1d4ad31b0daef4fa5ca6f73aa199cc12c7b210631ad2a0efa644ff5a3ff217f4bbf5ef02f8086a84f03a67aa74a49d2ee4a8949f1cd462053a60f

data/README.md

@@ -1,49 +1,138 @@
 # poeditor-cli
 
-[![Gem](https://img.shields.io/gem/v/cocoaseeds.svg)](https://rubygems.org/gems/cocoaseeds)
+[![Gem](https://img.shields.io/gem/v/poeditor-cli.svg)](https://rubygems.org/gems/poeditor-cli)
 [![Build Status](https://travis-ci.org/StyleShare/poeditor-cli.svg?branch=master)](https://travis-ci.org/StyleShare/poeditor-cli)
 
 Command line application for [POEditor](https://poeditor.com).
 
-<img width="682" alt="poeditor-cli" src="https://cloud.githubusercontent.com/assets/931655/22509884/2aebebc2-e8d3-11e6-86e2-a9915ca755b5.png">
+<img alt="poeditor-cli" src="https://cloud.githubusercontent.com/assets/931655/22522393/c6d3db32-e8fe-11e6-97f1-259445bc04d1.png" width="680">
+
+## Features
+
+* Exporting translation files directly from POEditor to your project directory
+* Mapping translation directory dynamically
+* Replacing `%s` with `%@` for Apple strings
+* We use it on our products
+
+## Installation
+
+```console
+$ [sudo] gem install poeditor-cli
+```
 
 ## Usage
 
-1. **Create `poeditor.yml` file**
+A single command will do almost everything for you.
+
+```console
+$ poeditor pull
+```
+
+Before you do this, you have to create a **poeditor.yml** file. This is a configuration file for poeditor-cli. Here is an example **`poeditor.yml`**:
+
+```yaml
+api_key: YOUR_API_KEY
+project_id: PROJECT_ID
+type: apple_strings
+tags: [ios]
+
+languages: [en, ko, ja, zh-Hans, zh-Hant, fr, es]
+language_alias:
+  zh: zh-Hans
+
+path: Resources/{LANGUAGE}.lproj/Localizable.strings
+path_replace:
+  en: Resources/Base.lproj/Localizable.strings
+```
+
+> See **[Example `poeditor.yml` files](#example-poeditoryml-files)** section for more examples.
+
+* **api_key**
+
+    Your POEditor API key. You can check it on [POEditor API Access](https://poeditor.com/account/api). Use such like `$MY_API_KEY` to use environment variable.
+
+* **project_id**
+
+    POEditor project ID. You can check this value on the web browser's address bar. (For example: `https://poeditor.com/projects/view?id=XXXXX`) Use such like `$MY_PROJECT_ID` to use environment variable.
+
+* **languages**
+
+    Language codes to export. Use the language codes that your project uses. For example, use `zh-Hans` for Xcode project and `zh-rCN` for Android project even though POEditor uses `zh-CN` for simplified chinese.
+
+* **language_alias** *(Optional)*
+
+    Specify this value to copy the translation file to another language. For example, `zh` is same with the translation of `zh-Hans` or `zh-rCN`. In this case, you can specify the `language_alias` value as follows:
 
-    Here is an example.
+    ```yaml
+    languages: [ko, ja, zh-Hans, zh-Hant]
+    language_alias:
+      zh: zh-Hans
+    ```
+
+* **path**
+
+    The path for translation files to be downloaded. Each values of `languages` will be used for filling `{LANGUAGE}` placeholder.
+
+* **path_replace** *(Optional)*
+
+    Specify this value to enforce the translation file path. For example, Android uses `values/strings.xml` for default language and `values-ko/strings.xml` or `values-ja/strings.xml` for others. In this case, you can specify the `path_replace` as follows:
 
     ```yaml
-    api_key: YOUR_API_KEY
-    project_id: PROJECT_ID
-    languages: [en, ko, jp, zh-Hans, zh-Hant, fr, es]
-    path: example/Resources/{LANGUAGE}.lproj/Localizable.strings
+    path: myapp/src/main/res/values-{LANGUAGE}/strings.xml
+    path_replace:
+      en: myapp/src/main/res/values/strings.xml
+    ```
+
+* **type**
+
+    Translation file format. (po, pot, mo, xls, csv, resw, resx, android_strings, apple_strings, xliff, properties, key_value_json, json, xmb, xtb)
+
+* **tags** *(Optional)*
+
+    Terms which contain whole tags will be exported. (`&&`)
+
+## Example `poeditor.yml` files
+
+* Xcode project
+
+    ```yaml
+    api_key: $POEDITOR_API_KEY        # from envvar
+    project_id: $POEDITOR_PROJECT_ID  # from envvar
     type: apple_strings
-    tags: [ios]  # optional
+    tags: [ios]
+
+    languages: [en, ko, ja, zh-Hans, zh-Hant]
+    path: Resources/{LANGUAGE}.lproj/Localizable.strings
     ```
 
-    | Field | Description |
-    |---|---|
-    | `api_key` | Your POEditor API key. You can check it on [POEditor API Access](https://poeditor.com/account/api). |
-    | `project_id` | POEditor project ID. You can check this value on the web browser's address bar.<br />For example: `https://poeditor.com/projects/view?id=XXXXX` |
-    | `languages` | Language codes to export. Use your project's language code.<br />For example, use `zh-Hans` if you're working on Xcode project even though POEditor uses `zh-CN` for simplified chinese. |
-    | `path` | The path for translation files to be downloaded. Each values of `languages` will be used for filling `{LANGUAGE}` placeholder. |
-    | `type` | Translation file format. (po, pot, mo, xls, csv, resw, resx, android_strings, apple_strings, xliff, properties, key_value_json, json, xmb, xtb) |
-    | `tags` | (Optional) Terms which contain whole tags will be exported. (`&&`) |
+* Android project
 
-2. **Export using CLI**
+    ```yaml
+    api_key: $POEDITOR_API_KEY        # from envvar
+    project_id: $POEDITOR_PROJECT_ID  # from envvar
+    type: android_strings
+    tags: [android]
+
+    languages: [en, ko, ja, zh-rCN, zh-rTW]
 
-    ```console
-    $ poeditor export
+    path: myapp/src/main/res/values-{LANGUAGE}/strings.xml
+    path_replace:
+      en: myapp/src/main/res/values/strings.xml
     ```
 
-3. **You're done! 🎉**
+* Projects using gettext
 
-## Installation
+    ```yaml
+    api_key: $POEDITOR_API_KEY        # from envvar
+    project_id: $POEDITOR_PROJECT_ID  # from envvar
+    type: po
 
-```console
-$ [sudo] gem install poeditor-cli
-```
+    languages: [en, ko, ja, zh_Hans, zh_Hant]
+    language_alias:
+      zh: zh_Hans
+
+    path: myservice/translations/{LANGUAGE}/LC_MESSAGES/messages.po
+    ```
 
 ## License
 

data/lib/poeditor.rb

@@ -9,15 +9,14 @@ module POEditor
   autoload :UI,        "poeditor/ui"
 
   # core
-  autoload :Exporter,   "poeditor/core/exporter"
-  autoload :Formatter,  "poeditor/core/formatter"
+  autoload :Core,   "poeditor/core"
 
   # command
   autoload :Command,        "poeditor/commands/command"
-  autoload :ExportCommand,  "poeditor/commands/export_command"
+  autoload :PullCommand,    "poeditor/commands/pull_command"
   autoload :HelpCommand,    "poeditor/commands/help_command"
   autoload :VersionCommand, "poeditor/commands/version_command"
 
   # configuration
-  autoload :ExportConfiguration, "poeditor/configurations/export_configuration"
+  autoload :Configuration, "poeditor/configuration"
 end

data/lib/poeditor/commands/command.rb

@@ -13,8 +13,8 @@ module POEditor
 
     def self.command_class(argv)
       case argv[0]
-      when "export"
-        ExportCommand
+      when "pull"
+        PullCommand
       when "--version"
         VersionCommand
       else

data/lib/poeditor/commands/help_command.rb

@@ -1,7 +1,7 @@
 module POEditor
   class HelpCommand
     def run(argv)
-      puts "Usage: poeditor export"
+      puts "Usage: poeditor [pull|help]"
     end
   end
 end

data/lib/poeditor/commands/{export_command.rb → pull_command.rb}

@@ -1,11 +1,11 @@
 module POEditor
-  class ExportCommand
+  class PullCommand
     def run(argv)
       UI.puts "Reading configuration"
       configuration = get_configuration(argv)
       UI.puts configuration
-      exporter = POEditor::Exporter.new(configuration)
-      exporter.export_all()
+      client = POEditor::Core.new(configuration)
+      client.pull()
     end
 
     # Detects and returns the location of `poeditor.yml` file from the given
@@ -23,11 +23,11 @@ module POEditor
       end
     end
 
-    # Returns {#POEditor::ExportConfiguration} from the given system arguments.
+    # Returns {#POEditor::Configuration} from the given system arguments.
     #
     # @param argv [Array<String>] System arguments
     #
-    # @return [POEditor::ExportConfiguration] The export configuration
+    # @return [POEditor::Configuration] The export configuration
     def get_configuration(argv)
       config_path = get_configuration_file_path(argv)
       unless File.exist?(config_path)
@@ -37,13 +37,15 @@ Configuration file doesn't exist: #{config_path}.
         }
       end
       yaml = YAML.load(File.read(config_path))
-      ExportConfiguration.new(
+      Configuration.new(
         api_key: get_or_raise(yaml, "api_key"),
         project_id: get_or_raise(yaml, "project_id"),
-        languages: get_or_raise(yaml, "languages"),
         type: get_or_raise(yaml, "type"),
         tags: yaml["tags"],
+        languages: get_or_raise(yaml, "languages"),
+        language_alias: yaml["language_alias"],
         path: get_or_raise(yaml, "path"),
+        path_replace: yaml["path_replace"],
       )
     end
 

data/lib/poeditor/configuration.rb

@@ -0,0 +1,73 @@
+module POEditor
+  class Configuration
+    # @return [String] POEditor API key
+    # @see https://poeditor.com/account/api POEditor API Access
+    attr_accessor :api_key
+
+    # @return [String] POEditor project ID
+    attr_accessor :project_id
+
+    # @return [String] Export file type (po, apple_strings, android_strings)
+    attr_accessor :type
+
+    # @return [Array<String>] Tag filters (optional)
+    attr_accessor :tags
+
+    # @return [Array<String>] The languages codes
+    attr_accessor :languages
+
+    # @return [Hash{Sting => String}] The languages aliases
+    attr_accessor :language_alias
+
+    # @return [String] The path template
+    attr_accessor :path
+
+    # @return [Hash{Sting => String}] The path replacements
+    attr_accessor :path_replace
+
+    def initialize(api_key:, project_id:, type:, tags:nil,
+                   languages:, language_alias:nil,
+                   path:, path_replace:nil)
+      @api_key = from_env(api_key)
+      @project_id = from_env(project_id.to_s)
+      @type = type
+      @tags = tags || []
+
+      @languages = languages
+      @language_alias = language_alias || {}
+
+      @path = path
+      @path_replace = path_replace || {}
+    end
+
+    def from_env(value)
+      if value.start_with?("$")
+        key = value[1..-1]
+        ENV[key]
+      else
+        value
+      end
+    end
+
+    def to_s
+      values = {
+        "type" => self.type,
+        "tags" => self.tags,
+        "languages" => self.languages,
+        "language_alias" => self.language_alias,
+        "path" => self.path,
+        "path_replace" => self.path_replace,
+      }
+      YAML.dump(values)[4..-2]
+        .each_line
+        .map { |line|
+          if line.start_with?("-") or line.start_with?(" ")
+            "    #{line}"
+          else
+            "  - #{line}"
+          end
+        }
+        .join("")
+    end
+  end
+end

data/lib/poeditor/{core/exporter.rb → core.rb}

@@ -2,15 +2,15 @@ require "json"
 require "net/http"
 
 module POEditor
-  class Exporter
-    # @return [POEditor::ExportConfiguration] The configuration for export
+  class Core
+    # @return [POEditor::Configuration] The configuration for export
     attr_accessor :configuration
 
-    # @param configuration [POEditor::ExportConfiguration]
+    # @param configuration [POEditor::Configuration]
     def initialize(configuration)
-      unless configuration.is_a? ExportConfiguration
+      unless configuration.is_a? Configuration
         raise POEditor::Exception.new \
-          "`configuration` should be an `ExportConfiguration`"
+          "`configuration` should be an `Configuration`"
       end
       @configuration = configuration
     end
@@ -31,8 +31,8 @@ module POEditor
       return Net::HTTP.post_form(uri, options)
     end
 
-    # Exports all translations
-    def export_all()
+    # Pull translations
+    def pull()
       UI.puts "\nExport translations"
       for language in @configuration.languages
         UI.puts "  - Exporting '#{language}'"
@@ -41,7 +41,13 @@ module POEditor
                               :language => language,
                               :type => @configuration.type,
                               :tags => @configuration.tags)
-        Formatter.write(@configuration.path, language, content)
+        write(language, content)
+
+        for alias_to, alias_from in @configuration.language_alias
+          if language == alias_from
+            write(alias_to, content)
+          end
+        end
       end
     end
 
@@ -83,14 +89,32 @@ module POEditor
     end
 
     def convert_to_poeditor_language(language)
-      if language.downcase.match(/zh.+hans/)
+      if language.downcase.match(/zh.+(hans|cn)/)
         'zh-CN'
-      elsif language.downcase.match(/zh.+hant/)
+      elsif language.downcase.match(/zh.+(hant|tw)/)
         'zh-TW'
       else
         language
       end
     end
 
+    # Write translation file
+    def write(language, content)
+      path = path_for_language(language)
+      unless File.exist?(path)
+        raise POEditor::Exception.new "#{path} doesn't exist"
+      end
+      File.write(path, content)
+      UI.puts "      #{"\xe2\x9c\x93".green} Saved at '#{path}'"
+    end
+
+    def path_for_language(language)
+      if @configuration.path_replace[language]
+        @configuration.path_replace[language]
+      else
+        @configuration.path.gsub("{LANGUAGE}", language)
+      end
+    end
+
   end
 end

data/lib/poeditor/version.rb

@@ -1,3 +1,3 @@
 module POEditor
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: poeditor-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Suyeol Jeon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -36,12 +36,11 @@ files:
 - bin/poeditor
 - lib/poeditor.rb
 - lib/poeditor/commands/command.rb
-- lib/poeditor/commands/export_command.rb
 - lib/poeditor/commands/help_command.rb
+- lib/poeditor/commands/pull_command.rb
 - lib/poeditor/commands/version_command.rb
-- lib/poeditor/configurations/export_configuration.rb
-- lib/poeditor/core/exporter.rb
-- lib/poeditor/core/formatter.rb
+- lib/poeditor/configuration.rb
+- lib/poeditor/core.rb
 - lib/poeditor/exception.rb
 - lib/poeditor/ui.rb
 - lib/poeditor/version.rb

data/lib/poeditor/configurations/export_configuration.rb

@@ -1,46 +0,0 @@
-module POEditor
-  class ExportConfiguration
-    # @return [String] POEditor API key
-    # @see https://poeditor.com/account/api POEditor API Access
-    attr_accessor :api_key
-
-    # @return [String] POEditor project ID
-    attr_accessor :project_id
-
-    # @return [Array<String>] The languages codes
-    attr_accessor :languages
-
-    # @return [String] Export file type (po, apple_strings, android_strings)
-    attr_accessor :type
-
-    # @return [Array<String>] Tag filters (optional)
-    attr_accessor :tags
-
-    attr_accessor :path
-
-    def initialize(api_key:, project_id:, languages:, type:, tags:nil, path:)
-      @api_key = api_key
-      @project_id = project_id
-      @languages = languages
-      @type = type
-      @tags = tags or []
-      @path = path
-    end
-
-    def default_path(type)
-      Formatter.cls(type).default_path
-    end
-
-    def to_s
-      values = {
-        "api_key" => self.api_key,
-        "project_id" => self.project_id,
-        "languages" => self.languages,
-        "type" => self.type,
-        "tags" => self.tags,
-        "path" => self.path,
-      }
-      values.map { |key, value| "  - #{key}: #{value}" }.join "\n"
-    end
-  end
-end

data/lib/poeditor/core/formatter.rb

@@ -1,16 +0,0 @@
-module POEditor
-  class Formatter
-    def self.build_path(path_template, language)
-      path_template.gsub "{LANGUAGE}", language
-    end
-
-    def self.write(path_template, language, content)
-      path = build_path(path_template, language)
-      unless File.exist?(path)
-        raise POEditor::Exception.new "#{path} doesn't exist"
-      end
-      File.write(path, content)
-      UI.puts "      #{"\xe2\x9c\x93".green} Saved at '#{path}'"
-    end
-  end
-end