poesie 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3faa652a9f6ad87e650ba88a394d2f5d577e66b3
-  data.tar.gz: 40ede2cb29bea6fd4abc16d0b27bb13daf00a308
+  metadata.gz: 147a5398c7444cb641b250e3b38a8394bf335d02
+  data.tar.gz: 944bde3b16366fa7ebf8cf1fba0721fc14bb5561
 SHA512:
-  metadata.gz: 3d20a015a7232e8973d5a86ff956c5bb35fa1295889db5d3d70af44eee44077aa7d0b5dd9ec238a5a44b14457964baf4db7daeca4cef56a0531e2417b6389548
-  data.tar.gz: dc1cfc402b131d401c0f0c0384ec5e06246f7882ce9d87002bc41cf59c19bd705d9a2fd1c7bae5f3d18a3d270e8fe50710106fcc58f20f820a8fff0e30dd79db
+  metadata.gz: 759e06722d8d15a7a73b728abe2cff5e07acbcecd0c00a9a2ffdd3cbdda6f8695ec1245e3b2fef37f6afd0b52821d76a8edbe576184c7aa62269852dcee99fc7
+  data.tar.gz: 5644643aaca8bcf56e24ea9989b2959c426b2eccaabd21dd935e90afd570da48db547595dd8e35d03a8ac38004ec9bb735d855a4135fbdb8392774c894ed73cc

data/README.md

@@ -77,7 +77,8 @@ Of course, only list in POEditor the strings that needs a translation (user-faci
 ### 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)
+* 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`.
+* For Android, if you have `.` in term names, they will be replaced with `_` (as `R.string.foo.bar` won't work in Android but `R.string.foo_bar` will)
 * 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

data/bin/poesie

@@ -52,11 +52,11 @@ opts = OptionParser.new do |opts|
     options[:print_date] = true
   end
   opts.on('-s FILE', '--subst FILE', %q(Path to a YAML file listing all substitutions)) do |path|
-    Poesie.exit_with_error("The substitutions file #{path} was not found") unless File.exists?(path)  
+    Poesie.exit_with_error("The substitutions file #{path} was not found") unless File.exists?(path)
     begin
       subst = YAML.load_file(path)
     rescue Psych::SyntaxError => e
-      Poesie.exit_with_error("Invalid YAML file #{e.message}")  
+      Poesie.exit_with_error("Invalid YAML file #{e.message}")
     end
     subst = [subst] if subst.is_a?(Hash)
     valid = subst.all? { |hash| hash.keys.all? { |k| k.is_a?(String) } && hash.values.all? { |k| k.is_a?(String) } }
@@ -81,12 +81,14 @@ Poesie.exit_with_error('You need to specify your POEditor project identifier usi
 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?
-  Poesie::Log::title('== iOS ==')
-  exporter.run(options[:lang]) do |terms|
+exporter.run(options[:lang]) do |terms|
+  Poesie::Log::title("== Language #{options[:lang]} ==")
+
+  # iOS
+  unless options[:localizable_strings].nil?
+    Poesie::Log::subtitle('== iOS ==')
+
     # Localizable.strings
-    Poesie::Log::subtitle("== Language #{options[:lang]} ==")
     Poesie::AppleFormatter::write_strings_file(
       terms,
       options[:localizable_strings],
@@ -102,21 +104,13 @@ unless options[:localizable_strings].nil?
       substitutions: options[:substitutions],
       print_date: options[:print_date]
     )
-
-    # Context.json (if specified)
-    if options[:context_file]
-      Poesie::Log::subtitle("== Context #{options[:context_file]} ==")
-      Poesie::AppleFormatter::write_context_json(terms, options[:context_file])
-    end
   end
-end
 
-# Android
-unless options[:strings_xml].nil?
-  Poesie::Log::title('== Android ==')
-  exporter.run(options[:lang]) do |terms|
+  # Android
+  unless options[:strings_xml].nil?
+    Poesie::Log::subtitle('== Android ==')
+
     # Strings.xml
-    Poesie::Log::subtitle("== Language #{options[:lang]} ==")
     Poesie::AndroidFormatter::write_strings_xml(
       terms,
       options[:strings_xml],
@@ -124,4 +118,13 @@ unless options[:strings_xml].nil?
       print_date: options[:print_date]
     )
   end
+
+  # Context.json (if specified)
+  if options[:context_file]
+    filters = nil
+    filters = Poesie::Filters::EXCLUDE_IOS if options[:localizable_strings].nil?
+    filters = Poesie::Filters::EXCLUDE_ANDROID if options[:strings_xml].nil?
+    Poesie::Log::subtitle("== Context ==")
+    Poesie::ContextFormatter::write_context_json(terms, options[:context_file], exclude: filters)
+  end
 end

data/lib/android_formatter.rb

@@ -13,9 +13,12 @@ module Poesie
     #        The list of substitutions to apply to the translations
     # @param [Bool] print_date
     #        Should we print the date in the header of the generated file
+    # @param [Regexp] exclude
+    #        A regular expression to filter out terms.
+    #        Terms matching this Regexp will be ignored and won't be part of the generated file
     #
-    def self.write_strings_xml(terms, file, substitutions: nil, print_date: false)
-      stats = { :ios => 0, :nil => [], :count => 0 }
+    def self.write_strings_xml(terms, file, substitutions: nil, print_date: false, exclude: Poesie::Filters::EXCLUDE_IOS)
+      stats = { :excluded => 0, :nil => [], :count => 0 }
 
       Log::info(" - Save to file: #{file}")
       File.open(file, "w") do |fh|
@@ -30,9 +33,13 @@ module Poesie
             
             # Filter terms and update stats
             next if (term.nil? || term.empty? || definition.nil?) && stats[:nil] << term
-            next if (term =~ /_ios$/) && stats[:ios] += 1
+            next if (term =~ exclude) && stats[:excluded] += 1
             stats[:count] += 1
 
+            # Terms with dots are invalid in Android ("R.string.foo.bar" won't work), so replace dots with underscores
+            term.gsub!('.', '_')
+            plurals.gsub!('.', '_')
+
             xml_builder.comment!(context) unless context.empty?
             if plurals.empty?
               definition = Poesie::process(definition, substitutions).gsub('"', '\\"')
@@ -49,7 +56,10 @@ module Poesie
         end
       end
 
-      Log::info("   [Stats] #{stats[:count]} strings processed (Filtered out #{stats[:ios]} iOS strings)")
+      Log::info("   [Stats] #{stats[:count]} strings processed")
+      unless exclude.nil?
+        Log::info("   Filtered out #{stats[:excluded]} strings matching #{exclude.inspect})")
+      end
       unless stats[:nil].empty?
         Log::error("   Found #{stats[:nil].count} empty value(s) for the following term(s):")
         stats[:nil].each { |key| Log::error("    - #{key.inspect}") }

data/lib/apple_formatter.rb

@@ -13,20 +13,23 @@ module Poesie
     #        The list of substitutions to apply to the translations
     # @param [Bool] print_date
     #        Should we print the date in the header of the generated file
+    # @param [Regexp] exclude
+    #        A regular expression to filter out terms.
+    #        Terms matching this Regexp will be ignored and won't be part of the generated file
     #
-    def self.write_strings_file(terms, file, substitutions: nil, print_date: false)
+    def self.write_strings_file(terms, file, substitutions: nil, print_date: false, exclude: Poesie::Filters::EXCLUDE_ANDROID)
       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 => [], :count => 0 }
+      stats = { :excluded => 0, :nil => [], :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] << term
-        next if (term =~ /_android$/) && stats[:android] += 1 # Remove android-specific strings
+        next if (term =~ exclude) && stats[:excluded] += 1
         stats[:count] += 1
 
         # Generate MARK from prefixes
@@ -57,7 +60,10 @@ module Poesie
       File.open(file, "w") do |fh|
         fh.write(content)
       end
-      Log::info("   [Stats] #{stats[:count]} strings processed (Filtered out #{stats[:android]} android strings)")
+      Log::info("   [Stats] #{stats[:count]} strings processed")
+      unless exclude.nil?
+        Log::info("   Filtered out #{stats[:excluded]} strings matching #{exclude.inspect})")
+      end
       unless stats[:nil].empty?
         Log::error("   Found #{stats[:nil].count} empty value(s) for the following term(s):")
         stats[:nil].each { |key| Log::error("    - #{key.inspect}") }
@@ -74,9 +80,12 @@ module Poesie
     #        The list of substitutions to apply to the translations
     # @param [Bool] print_date
     #        Should we print the date in the header of the generated file
+    # @param [Regexp] exclude
+    #        A regular expression to filter out terms.
+    #        Terms matching this Regexp will be ignored and won't be part of the generated file
     #
-    def self.write_stringsdict_file(terms, file, substitutions: nil, print_date: false)
-      stats = { :android => 0, :nil => [], :count => 0 }
+    def self.write_stringsdict_file(terms, file, substitutions: nil, print_date: false, exclude: Poesie::Filters::EXCLUDE_ANDROID)
+      stats = { :excluded => 0, :nil => [], :count => 0 }
 
       Log::info(" - Save to file: #{file}")
       File.open(file, "w") do |fh|
@@ -92,10 +101,10 @@ module Poesie
 
               # Filter terms and update stats
               next if (term.nil? || term.empty? || definition.nil?) && stats[:nil] << term
-              next if (term =~ /_android$/) && stats[:android] += 1 # Remove android-specific strings
+              next if (term =~ exclude) && stats[:excluded] += 1
               next unless definition.is_a? Hash
               stats[:count] += 1
-              
+
               key = term_plural || term
 
               root_node.key(key)
@@ -124,55 +133,15 @@ module Poesie
           end
         end
       end
-      Log::info("   [Stats] #{stats[:count]} strings processed (Filtered out #{stats[:android]} android strings)")
+
+      Log::info("   [Stats] #{stats[:count]} strings processed")
+      unless exclude.nil?
+        Log::info("   Filtered out #{stats[:excluded]} strings matching #{exclude.inspect})")
+      end
       unless stats[:nil].empty?
         Log::error("   Found #{stats[:nil].count} empty value(s) for the following term(s):")
         stats[:nil].each { |key| Log::error("    - #{key.inspect}") }
       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(" - Save to file: #{file}")
-      File.open(file, "w") do |fh|
-        fh.write(context_json)
-      end
-      Log::info("   [Stats] #{stats[:count]} contexts processed (Filtered out #{stats[:android]} android entries, #{stats[:nil]} nil contexts)")
-    end
-
   end
 end

data/lib/context_formatter.rb

@@ -0,0 +1,55 @@
+module Poesie
+  module ContextFormatter
+
+    # 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
+    # @param [Regexp] exclude
+    #        A regular expression to filter out terms.
+    #        Terms matching this Regexp will be ignored and won't be part of the generated file
+    #
+    def self.write_context_json(terms, file, exclude: nil)
+
+      json_hash = { "date" => "#{Time.now}" }
+
+      stats = { :excluded => 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 =~ exclude) && stats[:excluded] += 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(" - Save to file: #{file}")
+      File.open(file, "w") do |fh|
+        fh.write(context_json)
+      end
+      Log::info("   [Stats] #{stats[:count]} strings processed")
+      unless exclude.nil?
+        Log::info("   Filtered out #{stats[:excluded]} strings matching #{exclude.inspect})")
+      end
+    end
+  end
+end

data/lib/filters.rb

@@ -0,0 +1,6 @@
+module Poesie
+	module Filters
+	    EXCLUDE_IOS = /_ios$/
+    	EXCLUDE_ANDROID = /_android$/
+	end
+end

data/lib/poesie.rb

@@ -1,7 +1,9 @@
 require File.expand_path('log', File.dirname(__FILE__))
 require File.expand_path('exporter', File.dirname(__FILE__))
+require File.expand_path('filters', File.dirname(__FILE__))
 require File.expand_path('android_formatter', File.dirname(__FILE__))
 require File.expand_path('apple_formatter', File.dirname(__FILE__))
+require File.expand_path('context_formatter', File.dirname(__FILE__))
 
 require 'json'
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Poesie
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: poesie
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Olivier Halligon
@@ -9,48 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-10 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
@@ -66,7 +66,9 @@ files:
 - bin/poesie
 - lib/android_formatter.rb
 - lib/apple_formatter.rb
+- lib/context_formatter.rb
 - lib/exporter.rb
+- lib/filters.rb
 - lib/log.rb
 - lib/poesie.rb
 - lib/version.rb
@@ -80,12 +82,12 @@ 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: []