poesie 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f8bff2658b4d9825300ecb79bd1836dec4aa4cb
+  data.tar.gz: c8a17bc54ad8bcc73bf98c5edaede5aafcba2a4c
+SHA512:
+  metadata.gz: 31faa35c132decdc0bcc018eca372d767dbe951b5b3ad09c03180f6cb41a3c1fc0fc1d1d6960e39dc1adb716f746a2f51690f77663b174072ff1aeb8b83e0e1b
+  data.tar.gz: 4d54dbbbc8abbdd960fd4e3af1074d862469e4d0e57cc10788b82882190e8c06e1baff590c88e286f10877b1506b75485484e98bceffaeeb554164d0ec485d78

data/LICENSE

@@ -0,0 +1,201 @@
+                          Apache License
+                    Version 2.0, January 2004
+                http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,178 @@
+# Poesie
+
+Poesie is the **POE**ditor **S**tring **I**nternationalization **E**xtractor.
+
+![Poesie Logo](logo.png)
+
+_("poésie" also happens to be the French word for "poetry")_
+
+---
+
+This repository contains a script to generate `iOS`' and `Android`'s localized strings files extracted from a [poeditor.com](https://poeditor.com) project:
+
+Using [poeditor.com](https://poeditor.com), you will typically enter all your terms to translate, then all the translations for each language for those terms, using the web interface of the tool.
+
+This tool can then automate the extraction / export of those translations to generate `Localizable.strings` and `Localizable.stringsdict` files for iOS, and `strings.xml` files for Android.
+
+## Advantages
+
+Even though POEditor's web interface allows you to export the strings in those format already, the script has the following advantages:
+
+* It **automates the process**, which can be very welcome if you update your localized strings quite often (instead of having to download the file for each language and each platform, then move the downloaded files from your Downloads folder to the correct location in your project, etc)
+* It **post-processes** the exported files, including:
+  * Sorting the terms **alphabetically**
+  * **Filtering** out terms ending with `_ios` when exporting for Android, and filtering out terms ending with `_android` when exporting for iOS
+  * **Normalize the string placeholder** so you can use `%s` everywhere in your POEditor strings in the web interface — the script will automatically replace `%s` and `%n$s` with `%@` and `%n$@` when exporting to iOS, so no need to have different translations for those for each platform
+  * Allowing you to provide **text substitutions**, like replacing `"..."` with `"…"` and similar for all your translations (useful when your translator isn't always consistent with those typographical rules for example)
+* Allows you to extract the **context strings** in a JSON file if you want to use them for whatever use case in your app
+
+
+## Installation
+
+<details>
+<summary>Solution 1: Clone the repo</summary>
+
+* `git clone` the project on you computer
+* Install `bundler` using `gem install bundler` if you don't have it already
+* Install `poesie`'s dependencies by running `bundle install` from the directory where you cloned the repository
+* Invoke the tool using its full path `<path/where/you/cloned/Poesie>/bin/poesie`.
+
+You could also add the `<path/where/you/cloned/Poesie>/bin/` path to your `PATH` environment variable if you prefer.
+
+</details>
+
+<details>
+<summary>Solution 2: Build and install it as a gem</summary>
+
+* `git clone` the project on you computer
+* Run `gem build poesie.gemspec` to build the gem
+* Run `gem install poesie-*.gem` to install the gem you just built (`*` will be the version of the gem)
+* Now that it's installed in your system, you can invoke the tool using `poesie` from anywhere
+
+</details>
+
+
+## Using POEditor properly
+
+### Add your terms in POEditor's web interface
+
+* If you don't have a project in POEditor, start by creating one.
+* Then add some terms to translate. You can also indicate for each term if it will have a plural form or not (using the "P" button in POEditor web interface)
+* Then add at least a language, and translate your terms for that language in the POEditor web interface
+
+Of course, only list in POEditor the strings that needs a translation (user-facing strings), not JSON keys or constants, etc!
+
+💡 **Tip**: When adding a string to translate, be sure it doesn't already exist and hasn't already been added by another teammate (maybe using a different key) for example, by searching the text to translate in the POEditor web interface. This is especially worth checking because POEditor is typically limiting the maximum number of terms by a quota depending on your plan, so better not duplicate those terms!
+
+
+### Naming your terms
+
+* Find a name for your term that is consistent with existing keys
+* As a convention, for Niji projects, we structure the name of terms in a reverse-dns hierarchical text, using `_` as a separator. For example `home_banner_text` and `home_weather_temperature` (use `_` and not `.` because `.` causes issues in Android)
+* If a key should only be exported for Android, use the `_android` suffix. If a key should only be exported for iOS, use the `_ios` suffix.
+
+### Using `%…` placeholders
+
+* For keys that use string placeholders, use `%s` and not `%@`. Android doesn't know about `%@` (which is an iOS/macOS-only placeholder) and `%s` placeholders will be translated to `%@` automatically by this script
+* Use positional placeholders like `%n$s`, instead of just `%s`, whenever possible.
+
+> **Note**
+> 
+> The `%n$s` syntax allows you to indicate the index of the parameter to use. This allows you to invert the order of the parameters in the translation, which can sometimes be needed for some languages (e.g. In English you'll use `%1$s's %2$d phones` to have "John's 3 phones", but in French you'll use `Les %2$d téléphones de %1$s` to have "Les 3 téléphones de John", where the number of phones comes before the person's name).
+> 
+> If you don't specify the `n$` position number (but only e.g. `%s`), the parameters will be consumed in order.
+> It's recommended to use the `n$` positional placeholders though, even if they are in order, so that the order is explict and not implicit.
+
+### Handling plurals
+
+There's an oddity in POEditor when handling plurals: for a term to be marked to support plurals, you must activate the "P" round button next to the term… which will then display a field to enter the name of the term… when used for the plural variants.
+
+I haven't seen any point of having a different term for the pluralized term and the singular term. Using a different name for the term and the plural term doesn't make sense to me.
+
+Therefore, and given how the script interprets those terms, for terms with plurals, you should **always use the same name for the "term" and the "plural term"** when declaring them in the POEditor web interface:
+
+![Plurals example](plurals_example.png)
+
+### Handling newlines
+
+* You can add newlines, either using actual newlines or using `\n`, in the translations in the web interface. Both (literal or escaped) should be interpreted and translated correctly by the script
+
+
+## Executing the script
+
+Multiple options can be used when invoking the tool from the commandline:
+
+```
+$ poesie -h
+Usage: poesie [options]
+    -t, --token API_TOKEN            Your POEditor API token
+    -p, --project PROJECT_ID         Your POEditor project identifier
+    -l, --lang LANGUAGE              The POEditor project language code to extract
+    -i, --ios PATH                   Path of the iOS Localizable.strings[dict] file to generate
+    -a, --android PATH               Path of the Android strings.xml file path to generate
+    -c, --context PATH               Path of the *.json file to generate for contexts
+    -d, --date                       Generate the current date in file headers
+    -r, --replacements FILE          Path to a YAML file listing all replacements
+    -h, --help                       Show this message
+    -v, --version                    Show version
+```
+
+* You'll typically always need to provide a token (`--token`) and a project ID (`--project`). Those can be found [here on the POEditor web interface](https://poeditor.com/account/api)
+
+* You'll also always need to provide the language (`--lang`) you wish to extract and for which you want to generate the files. You can invoke the `poesie` script multiple times, one for each language you need to extract, if needed.
+
+* Depending if you want to generate the localization files for Android (`strings.xml`) or iOS (`Localizable.strings` & `Localizable.stringsdict`), you'll use either `--ios PATH` or `--android PATH`. _(Note: for iOS, you give the path and name of the `Localizable.strings` file to generate, and the script will deduce itself the path for the `Localizable.stringsdict` to generate next to it)_
+
+**Exemples** :
+
+```
+$ poesie -t abcd1234efab5678abcd1234efab5678 -p 12345 -l fr -a /Users/me/Documents/Dev/MyApp/app/src/main/res/values/strings.xml
+```
+
+```
+$ poesie -t abcd1234efab5678abcd1234efab5678 -p 12345 -l fr -i /Users/me/Documents/Dev/MyApp/Resources/Localizable.strings
+```
+
+
+## Using the --context flag
+
+When running the `poesie` script using the `--context FILE` option, it will generate a JSON file at the provided path, containing all the terms for which you provided a "Context" (the "C" round button) in the POEditor web interface.
+
+```
+$ poesie --token "..." --project "..." --lang fr --ios .../localizable.strings --context .../context.json
+```
+
+This can be useful:
+
+* Either to use that JSON file directly in your project to do whatever you want with the contexts (e.g. parsing the JSON file at runtime using `JSONSerialization`, and use it as you please)
+* Or use that JSON file with a template engine (like [Liquid](https://github.com/Shopify/liquid)) to generate code specific to your needs. See the example script in `examples/gen-context-with-liquid.rb`.
+
+## Providing text replacements
+
+In case you need replacements to be applied to your translations, you can use the `--replacements` flag (`-r` for short) to provide a YAML file listing all replacements to be applied.
+
+```
+$ poesie --token "..." --project "..." --lang fr --ios .../localizable.strings -r replacements.yaml
+```
+
+This can be useful:
+
+* To replace standard spaces with non-breaking spaces before punctuation characters
+* To replace "..." with "…" and similar
+* To replace smiley strings like ";-)" with actual emoji characters like 😉
+* To ensure proper capitalization and orthography of your brand name every time it's spelled in the translations
+* etc.
+
+The YAML file provided must be of the form of a single Hash of String pairs, for example:
+
+```yaml
+" :": "\u00A0:"
+" ;": "\u00A0;"
+" !": "\u00A0!"
+" ?": "\u00A0?"
+"...": "…"
+```
+
+_Note: given that the JSON format is a subset of the YAML format, using a JSON file is also possible, as long as it still represents a dictionary with Strings as keys and as values._
+
+You can find an example of a YAML file in `examples/replacements.yaml` in this repository.

data/bin/poesie

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+
+if RUBY_VERSION < '2.0.0'
+  abort 'error: poesie requires Ruby 2 or higher.'
+end
+
+if $0 == __FILE__
+  $:.unshift File.expand_path('../lib', File.dirname(__FILE__))
+end
+
+begin
+  require 'optparse'
+  require 'yaml'
+  require 'poesie'
+rescue LoadError => e
+  abort 'error: missing some dependencies for poesie. Be sure to install it using `gem install` or to run `bundle installl` to install dependencies - ' + e.message
+end
+
+options = {
+    :api_token => 'fc1881292605d21bc5531c6ffcf3e410',
+    :project_id => nil,
+    :lang => nil,
+    :localizable_strings => nil,
+    :strings_xml => nil,
+    :context_file => nil,
+    :print_date => false,
+    :replacements => nil
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = 'Usage: poesie [options]'
+  opts.on('-t API_TOKEN', '--token API_TOKEN', %q(Your POEditor API token)) do |api_token|
+    options[:api_token] = api_token
+  end
+  opts.on('-p PROJECT_ID', '--project PROJECT_ID', %q(Your POEditor project identifier)) do |project_id|
+    options[:project_id] = project_id
+  end
+  opts.on('-l LANGUAGE', '--lang LANGUAGE', %q(The POEditor project language code to extract)) do |lang|
+    options[:lang] = lang
+  end
+  opts.on('-i PATH', '--ios PATH', %q(Path of the iOS Localizable.strings[dict] file to generate)) do |path|
+    options[:localizable_strings] = path
+  end
+  opts.on('-a PATH', '--android PATH', %q(Path of the Android strings.xml file path to generate)) do |path|
+    options[:strings_xml] = path
+  end
+  opts.on('-c PATH', '--context PATH', %q(Path of the *.json file to generate for contexts)) do |path|
+    options[:context_file] = path
+  end
+  opts.on('-d', '--date', %q(Generate the current date in file headers)) do
+    options[:print_date] = true
+  end
+  opts.on('-r FILE', '--replacements FILE', %q(Path to a YAML file listing all replacements)) do |path|
+    Poesie.exit_with_error("The replacements file #{path} was not found") unless File.exists?(path)  
+    begin
+      dict = YAML.load_file(path)
+    rescue Psych::SyntaxError => e
+      Poesie.exit_with_error("Invalid YAML file #{e.message}")  
+    end
+    valid = dict.keys.all? { |k| k.is_a?(String) } && dict.values.all? { |k| k.is_a?(String) }
+    Poesie.exit_with_error("The provided replacements file #{path} should only contain a Dictionary with String keys and values") unless valid
+    options[:replacements] = dict
+  end
+  opts.on_tail('-h', '--help', %q(Show this message)) { puts opts; exit 1 }
+  opts.on_tail('-v', '--version', 'Show version') { puts Poesie::VERSION; exit }
+end
+
+begin
+  opts.parse!
+rescue OptionParser::InvalidOption => error
+  puts error
+  puts opts
+  exit 1
+end
+
+### Main ###
+
+Poesie.exit_with_error('You need to specify your POEditor project identifier using --project option (see --help for more info)') if options[:project_id].nil?
+exporter = Poesie::Exporter.new(options[:api_token], options[:project_id])
+Poesie.exit_with_error('You need to specify your POEditor project language using --lang option (see --help for more info)') if options[:lang].nil?
+
+# iOS
+unless options[:localizable_strings].nil?
+  Log::title('== iOS ==')
+  exporter.run(options[:lang]) do |terms|
+    # Localizable.strings
+    Log::subtitle("== Language #{options[:lang]} ==")
+    Poesie::AppleFormatter::write_strings_file(
+      terms,
+      options[:localizable_strings],
+      replacements: options[:replacements],
+      print_date: options[:print_date]
+    )
+
+    # Localizable.stringsdict
+    strings_dict_path = options[:localizable_strings].gsub(/\.strings$/,'.stringsdict')
+    Poesie::AppleFormatter::write_stringsdict_file(
+      terms,
+      strings_dict_path,
+      replacements: options[:replacements],
+      print_date: options[:print_date]
+    )
+
+    # Context.json (if specified)
+    if options[:context_file]
+      Log::subtitle("== Context #{options[:context_file]} ==")
+      Poesie::AppleFormatter::write_context_json(terms, options[:context_file])
+    end
+  end
+end
+
+# Android
+unless options[:strings_xml].nil?
+  Log::title('== Android ==')
+  exporter.run(options[:lang]) do |terms|
+    # Strings.xml
+    Log::subtitle("== Language #{options[:lang]} ==")
+    Poesie::AndroidFormatter::write_strings_xml(
+      terms,
+      options[:strings_xml],
+      replacements: options[:replacements],
+      print_date: options[:print_date]
+    )
+  end
+end

data/lib/android_formatter.rb

@@ -0,0 +1,51 @@
+require 'builder'
+
+module Poesie
+  module AndroidFormatter
+
+    # Write the strings.xml output file
+    #
+    # @param [Hash] terms
+    #        The json parsed terms exported by POEditor and sorted alphabetically
+    # @param [String] file
+    #        The path to the file to write the content to
+    # @param [Hash<String,String>] replacements
+    #        The list of replacements to apply to the translations
+    # @param [Bool] print_date
+    #        Should we print the date in the header of the generated file
+    #
+    def self.write_strings_xml(terms, file, replacements: nil, print_date: false)
+      Log::info(" - Save to file: #{file}")
+      fh = File.open(file, "w")
+      begin
+        xml_builder = Builder::XmlMarkup.new(:target => fh, :indent => 4)
+        xml_builder.instruct!
+        xml_builder.comment!("Exported from POEditor   ")
+        xml_builder.comment!(Time.now) if print_date
+        xml_builder.comment!("see https://poeditor.com ")
+        xml_builder.resources do |resources_node|
+          terms.each do |term|
+            (term, definition, plurals, comment, context) = ['term', 'definition', 'term_plural', 'comment', 'context'].map { |k| term[k] }
+            # Skip ugly cases if POEditor is buggy for some entries
+            next if term.nil? || term.empty? || definition.nil?
+            next if term =~ /_ios$/
+            xml_builder.comment!(context) unless context.empty?
+            if plurals.empty?
+              definition = Poesie::process(definition, replacements).gsub('"', '\\"')
+              resources_node.string("\"#{definition}\"", :name => term)
+            else
+              resources_node.plurals(:name => plurals) do |plurals_node|
+                definition.each do |plural_quantity, plural_value|
+                  plural_value = Poesie::process(plural_value, replacements).gsub('"', '\\"')
+                  plurals_node.item("\"#{plural_value}\"", :quantity => plural_quantity)
+                end
+              end
+            end
+          end
+        end
+      ensure
+        fh.close
+      end
+    end
+  end
+end

data/lib/apple_formatter.rb

@@ -0,0 +1,173 @@
+require 'builder'
+
+module Poesie
+  module AppleFormatter
+
+    # Write the Localizable.strings output file
+    #
+    # @param [Array<Hash<String, Any>>] terms
+    #        JSON returned by the POEditor API
+    # @param [String] file
+    #        The path of the file to write
+    # @param [Hash<String,String>] replacements
+    #        The list of replacements to apply to the translations
+    # @param [Bool] print_date
+    #        Should we print the date in the header of the generated file
+    #
+    def self.write_strings_file(terms, file, replacements: nil, print_date: false)
+      out_lines = ['/'+'*'*79, ' * Exported from POEditor - https://poeditor.com']
+      out_lines << " * #{Time.now}" if print_date
+      out_lines += [' '+'*'*79+'/', '']
+      last_prefix = ''
+      stats = { :android => 0, :nil => 0, :count => 0 }
+
+      terms.each do |term|
+        (term, definition, comment, context) = ['term', 'definition', 'comment', 'context'].map { |k| term[k] }
+
+        # Filter terms and update stats
+        next if (term.nil? || term.empty? || definition.nil? || definition.empty?) && stats[:nil] += 1
+        next if (term =~ /_android$/) && stats[:android] += 1 # Remove android-specific strings
+        stats[:count] += 1
+
+        # Generate MARK from prefixes
+        prefix = %r(([^_]*)_.*).match(term)
+        if prefix && prefix[1] != last_prefix
+          last_prefix = prefix[1]
+          mark = last_prefix[0].upcase + last_prefix[1..-1].downcase
+          out_lines += ['', '/'*80, "// MARK: #{mark}"]
+        end
+
+        # If plural, use the text for the "one" (singular) entry
+        if definition.is_a? Hash
+          definition = definition["one"]
+        end
+
+        definition = Poesie::process(definition, replacements)
+                    .gsub("\u2028", '') # Sometimes inserted by the POEditor exporter
+                    .gsub("\n", '\n') # Replace actual CRLF with '\n'
+                    .gsub('"', '\\"') # Escape quotes
+                    .gsub(/%(\d+\$)?s/, '%\1@') # replace %s with %@ for iOS
+        out_lines << %Q(// CONTEXT: #{context.gsub("\n", '\n')}) unless context.empty?
+        out_lines << %Q("#{term}" = "#{definition}";)
+      end
+
+      content = out_lines.join("\n") + "\n"
+
+
+      Log::info("   [Stats] #{stats[:count]} strings processed (Filtered out #{stats[:android]} android strings, #{stats[:nil]} nil entries)")
+      Log::info(" - Save to file: #{file}")
+      File.open(file, "w") do |fh|
+        fh.write(content)
+      end
+    end
+
+    # Write the Localizable.stringsdict output file
+    #
+    # @param [Array<Hash<String, Any>>] terms
+    #        JSON returned by the POEditor API
+    # @param [String] file
+    #        The path of the file to write
+    # @param [Hash<String,String>] replacements
+    #        The list of replacements to apply to the translations
+    # @param [Bool] print_date
+    #        Should we print the date in the header of the generated file
+    #
+    def self.write_stringsdict_file(terms, file, replacements: nil, print_date: false)
+      stats = { :android => 0, :nil => 0, :count => 0 }
+
+      Log::info(" - Save to file: #{file}")
+      fh = File.open(file, "w")
+      begin
+        xml_builder = Builder::XmlMarkup.new(:target => fh, :indent => 4)
+        xml_builder.instruct!
+        xml_builder.comment!("Exported from POEditor   ")
+        xml_builder.comment!(Time.now) if print_date
+        xml_builder.comment!("see https://poeditor.com ")
+        xml_builder.plist(:version => '1.0') do |plist_node|
+          plist_node.dict do |root_node|
+            terms.each do |term|
+              (term, term_plural, definition) = ['term', 'term_plural', 'definition'].map { |k| term[k] }
+
+              # Filter terms and update stats
+              next if (term.nil? || term.empty? || definition.nil?) && stats[:nil] += 1
+              next if (term =~ /_android$/) && stats[:android] += 1 # Remove android-specific strings
+              next unless definition.is_a? Hash
+              stats[:count] += 1
+              
+              key = term_plural || term
+
+              
+              root_node.key(key)
+              root_node.dict do |dict_node|
+                dict_node.key('NSStringLocalizedFormatKey')
+                dict_node.string('%#@format@')
+                dict_node.key('format')
+                dict_node.dict do |format_node|
+                  format_node.key('NSStringFormatSpecTypeKey')
+                  format_node.string('NSStringPluralRuleType')
+                  format_node.key('NSStringFormatValueTypeKey')
+                  format_node.string('d')
+
+                  definition.each do |(quantity, text)|
+                    text = Poesie::process(text, replacements)
+                              .gsub("\u2028", '') # Sometimes inserted by the POEditor exporter
+                              .gsub('\n', "\n") # Replace '\n' with actual CRLF
+                              .gsub(/%(\d+\$)?s/, '%\1@') # replace %s with %@ for iOS
+                    format_node.key(quantity)
+                    format_node.string(text)
+                  end
+                end
+              end
+            end
+          end
+        end
+      ensure
+        fh.close
+      end
+    end
+
+    # Write the JSON output file containing all context keys
+    #
+    # @param [Array<Hash<String, Any>>] terms
+    #        JSON returned by the POEditor API
+    # @param [String] file
+    #        The path of the file to write
+    #
+    def self.write_context_json(terms, file)
+      json_hash = { "date" => "#{Time.now}" }
+
+      stats = { :android => 0, :nil => 0, :count => 0 }
+
+      #switch on term / context
+      array_context = Array.new
+      terms.each do |term|
+        (term, definition, comment, context) = ['term', 'definition', 'comment', 'context'].map { |k| term[k] }
+
+        # Filter terms and update stats
+        next if (term.nil? || term.empty? || context.nil? || context.empty?) && stats[:nil] += 1
+        next if (term =~ /_android$/) && stats[:android] += 1 # Remove android-specific strings
+        stats[:count] += 1
+
+        # Escape some chars
+        context = context
+                    .gsub("\u2028", '') # Sometimes inserted by the POEditor exporter
+                    .gsub("\\", "\\\\\\") # Replace actual \ with \\
+                    .gsub('\\\\"', '\\"') # Replace actual \\" with \"
+                    .gsub(/%(\d+\$)?s/, '%\1@') # replace %s with %@ for iOS
+
+        array_context << { "term" => "#{term}", "context" => "#{context}" }
+      end
+
+      json_hash[:"contexts"] = array_context
+
+      context_json = JSON.pretty_generate(json_hash)
+
+      Log::info("   [Stats] #{stats[:count]} contexts processed (Filtered out #{stats[:android]} android entries, #{stats[:nil]} nil contexts)")
+      Log::info(" - Save to file: #{file}")
+      File.open(file, "w") do |fh|
+        fh.write(context_json)
+      end
+    end
+
+  end
+end

data/lib/exporter.rb

@@ -0,0 +1,56 @@
+require 'net/http'
+
+module Poesie
+  class Exporter
+    # @param [String] api_token
+    #        POEditor API Token
+    # @param [String] project_id
+    #        ID of the project in your POEditor Dashboard
+    #
+    def initialize(api_token, project_id)
+      @api_token = api_token
+      @project_id = project_id
+    end
+
+    # Use the POEditor API to download the terms for a given language, then call a block
+    # to post-process those terms (exported as a JSON structure)
+    #
+    # @param [String] lang
+    #        The language to export
+    # @block [[JSON] -> Void]
+    #        The action to do with the exported terms
+    #        Typically call one of AppleFormatter::… or AndroidFormatter::… methods here
+    #
+    def run(lang)
+        Log::info(' - Generating export...')
+        uri = generate_export_uri(lang)
+        Log::info(' - Downloading exported file...')
+        json_string = Net::HTTP.get(URI(uri))
+        json = JSON.parse(json_string)
+        terms = json.sort { |item1, item2| item1['term'] <=> item2['term'] }
+        if block_given?
+          Log::info(' - Processing generated strings...')
+          yield terms
+        end
+    end
+
+    private
+
+    # @param [String] lang
+    #        Language code, like 'fr', 'en', etc
+    # @return [String] URL of the exported file ready to be downloaded
+    #
+    def generate_export_uri(lang)
+      uri = URI('https://poeditor.com/api/')
+      res = Net::HTTP.post_form(uri, 'api_token' => @api_token, 'action' => 'export', 'id' => @project_id, 'type' => 'json', 'language' => lang)
+      json = JSON.parse(res.body)
+      if json['response']['status'] != 'success'
+        r = json['response']
+        puts "Error #{r['code']} (#{r['status']})\n#{r['message']}"
+        exit 1
+      else
+        json['item']
+      end
+    end
+  end
+end

data/lib/poesie.rb

@@ -0,0 +1,30 @@
+require File.expand_path('utils/log', File.dirname(__FILE__))
+
+require File.expand_path('exporter', File.dirname(__FILE__))
+require File.expand_path('android_formatter', File.dirname(__FILE__))
+require File.expand_path('apple_formatter', File.dirname(__FILE__))
+
+require 'json'
+
+module Poesie
+  def self.exit_with_error(message)
+    Log::error message
+    exit 1
+  end
+
+  # Apply the list of text replacements to the given string
+  #
+  # @param [String] text
+  #        The text to process
+  # @param [Hash<String,String>] replacements
+  #        The replacements to apply
+  #
+  def self.process(text, replacements)
+    return text if replacements.nil?
+    replaced = text.dup
+    replacements.each do |k,v|
+      replaced.gsub!(k, v)
+    end
+    replaced
+  end
+end

data/lib/utils/log.rb

@@ -0,0 +1,23 @@
+module Log
+  @@quiet = false
+  def self.quiet=(value)
+    @@quiet = value
+  end
+
+  def self.title(str) # bg yellow
+    puts "\e[44;37m#{str}\e[0m" unless @@quiet
+  end
+
+  def self.error(str)
+    puts "\e[1;31m! #{str}\e[0m" unless @@quiet
+  end
+
+  def self.info(str)
+    puts "\e[1;32m√ #{str}\e[0m" unless @@quiet
+  end
+
+  def self.subtitle(str)
+    puts "\e[1;33m√ #{str}\e[0m" unless @@quiet
+  end
+
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Poesie
+  VERSION = '1.3.0'
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: poesie
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Olivier Halligon
+- NijiDigital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This script automates the export of POEditor strings to iOS and Android
+  files
+email: devs-ios@niji.fr
+executables:
+- poesie
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/poesie
+- lib/android_formatter.rb
+- lib/apple_formatter.rb
+- lib/exporter.rb
+- lib/poesie.rb
+- lib/utils/log.rb
+- lib/version.rb
+homepage: https://github.com/NijiDigital/poesie
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Automate and post-process the export of POEditor strings
+test_files: []
+has_rdoc: