fastlane-plugin-google_sheet_localize 0.1.6 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a4897b4267a2b1ec85e0decd035d4bbcaeec53b481a9c9d672476aad6065b6
-  data.tar.gz: ea0718e1d745c797e1ccf9c79d08dd299f8848381521652f4a524ad5f2a2ff47
+  metadata.gz: 3e981832345e489a2346adcc3901d5fae7700b379b1e02009cca1e55e8ab5fc6
+  data.tar.gz: df90ee04b2d43aac2229738b8b06f85426331771730acbbbbd83b036e313b70e
 SHA512:
-  metadata.gz: e252a54b79b9728660ad3307d99caaec6500219fd11dbd4ffbf437340a9ae791be4e2879278c2f77fadfb1ecc5c787eac168883f0db2ced044ffeca68d67e031
-  data.tar.gz: 06e2fbf3ab587f03d94fd915abd7268daabaeef07a3a4bc9738aaf78eb87a48bb940de0ecfc3524ac9a123138cc64f01d8696d592bd2ee915660ec8361a023c8
+  metadata.gz: 293d36b523297fd849f035d85709610f9c8760774b64604d47b30480d117a236243c0b0cbe1d78f578af6045989d3857ea6e63fba07717b30e73b24957581577
+  data.tar.gz: 1b493e47d984de4e389fefad74eca3692dea3bd9d82eb4b25fb1d6834321a2fb4a8ed8fbe65f8838b0592e57e4d1c49b76b668d67c57102870f1fcc8a014dc67

data/README.md

@@ -14,13 +14,30 @@ fastlane add_plugin google_sheet_localize
 
 Creates .strings files for iOS and strings.xml files for Android
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+to use our plugin you have to duplicate this google sheet: https://docs.google.com/spreadsheets/d/1fwRj1ZFPu2XlrDqkaqmIpJulqR5OVFEZnN35a9v37yc/edit?usp=sharing
+
+Google Drive access token: 
+https://medium.com/@osanda.deshan/getting-google-oauth-access-token-using-google-apis-18b2ba11a11a
+
+* The language_titles (the columns which should be exported)
+* The default_language (If a string is not present in a specific language, this is the fallback)
+* The base_language (The language which is placed in the base values folder)
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+```ruby
+  lane :localize do
+    google_sheet_localize(service_account_path: "./fastlane/google_drive_credentials.json",
+                                      sheet_id: "sheet id",
+                                      platform: "ios",
+                                          tabs: ["3TV"], #array of tab titles in google sheet
+                             localization_path: "./Kit/TVKit",
+                               language_titles: ["de", "en"], #language titles in google sheet
+                              default_language: "de", #default language for google sheet
+                                 base_language: "en") #ios: Base.lproj android: values 
+  end
+```
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/google_sheet_localize/actions/google_sheet_localize_action.rb

@@ -15,6 +15,7 @@ module Fastlane
         path = params[:localization_path]
         language_titles = params[:language_titles]
         default_language = params[:default_language]
+        base_language = params[:base_language]
 
         spreadsheet = session.spreadsheet_by_url(spreadsheet_id)
         worksheet = spreadsheet.worksheets.first
@@ -48,7 +49,7 @@ module Fastlane
             result.push(language)
           end
         end
-        self.createFiles(result, platform, path, default_language)
+        self.createFiles(result, platform, path, default_language, base_language)
       end
 
       def self.generateJSONObject(contentRows, index)
@@ -82,15 +83,15 @@ module Fastlane
 
       end
 
-      def filterUnusedRows(items, identifier)
+      def self.filterUnusedRows(items, identifier)
         return items.select { |item|
-            iosIdentifier = item[identifier]
-            iosIdentifier != "NR" && iosIdentifier != ""
+            currentIdentifier = item[identifier]
+            currentIdentifier != "NR" && currentIdentifier != "" && currentIdentifier != "TBD"
         }
       end
 
-      def self.createFiles(languages, platform, destinationPath, defaultLanguage)
-          self.createFilesForLanguages(languages, platform, destinationPath, defaultLanguage)
+      def self.createFiles(languages, platform, destinationPath, defaultLanguage, base_language)
+          self.createFilesForLanguages(languages, platform, destinationPath, defaultLanguage, base_language)
 
           if platform == "ios"
 
@@ -99,27 +100,37 @@ module Fastlane
 
             filteredItems = languages[0]["items"].select { |item|
                 iosIdentifier = item['identifierIos']
-                iosIdentifier != "NR" && iosIdentifier != "" && !iosIdentifier.include?('//')
+                iosIdentifier != "NR" && iosIdentifier != "" && !iosIdentifier.include?('//') && iosIdentifier != "TBD"
             }
 
             File.open(swiftFilepath, "w") do |f|
-              f.write("import Foundation\n\n\npublic struct Localization {\n")
+              f.write("import Foundation\n\n// swiftlint:disable all\npublic struct Localization {\n")
               filteredItems.each { |item|
 
                 identifier = item['identifierIos']
 
-                values = identifier.dup.gsub('.', ' ').split(" ")
+                values = identifier.dup.split(".")
 
                 constantName = ""
 
                 values.each_with_index do |item, index|
                   if index == 0
-                    constantName += item.downcase
+                    item[0] = item[0].downcase
+                    constantName += item
                   else
-                    constantName += item.capitalize
+                    item[0] = item[0].upcase
+                    constantName += item
                   end
                 end
 
+                if constantName == "continue"
+                  constantName = "`continue`"
+                end
+
+                if constantName == "switch"
+                  constantName = "`switch`"
+                end
+
                 text = self.mapInvalidPlaceholder(item['text'])
 
                 arguments = self.findArgumentsInText(text)
@@ -137,7 +148,7 @@ module Fastlane
           end
       end
 
-      def self.createFilesForLanguages(languages, platform, destinationPath, defaultLanguage)
+      def self.createFilesForLanguages(languages, platform, destinationPath, defaultLanguage, base_language)
 
         languages.each { |language|
 
@@ -145,10 +156,20 @@ module Fastlane
 
           filteredItems = self.filterUnusedRows(language["items"],'identifierIos')
 
-          filename = "Localizable.strings"
-          filepath = "#{destinationPath}/#{language['language']}.lproj/#{filename}"
-          FileUtils.mkdir_p "#{destinationPath}/#{language['language']}.lproj"
-          File.open(filepath, "w") do |f|
+          stringFileName = "Localizable.strings"
+          pluralsFileName = "Plurals.stringsdict"
+
+          languageName = language['language']
+
+          if languageName == base_language
+            languageName = "Base"
+          end
+
+          stringFilepath = "#{destinationPath}/#{languageName}.lproj/#{stringFileName}"
+          pluralsFilepath = "#{destinationPath}/#{languageName}.lproj/#{pluralsFileName}"
+          FileUtils.mkdir_p "#{destinationPath}/#{languageName}.lproj"
+
+          File.open(stringFilepath, "w") do |f|
             filteredItems.each_with_index { |item, index|
 
               text = self.mapInvalidPlaceholder(item['text'])
@@ -160,32 +181,86 @@ module Fastlane
                 line = "\n\n#{identifier}\n"
               else
 
+                if !text.include?("one|")
+
+                  if text == "" || text == "TBD"
+                    default_language_object = languages.select { |languageItem| languageItem['language'] == defaultLanguage }.first["items"]
+                    default_language_object = self.filterUnusedRows(default_language_object,'identifierIos')
+
+                    defaultLanguageText = default_language_object[index]['text']
+                    puts "found empty text for:\n\tidentifier: #{identifier}\n\tlanguage:#{language['language']}\n\treplacing it with: #{defaultLanguageText}"
+                    text = self.mapInvalidPlaceholder(defaultLanguageText)
+                  end
+
+                  line = "\"#{identifier}\" = \"#{text}\";"
+                  if !comment.to_s.empty?
+                    line = line + " //#{comment}\n"
+                  else
+                    line = line + "\n"
+                  end
+                end
+              end
+              f.write(line)
+            }
+          end
+
+          File.open(pluralsFilepath, "w") do |f|
+
+            f.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
+            f.write("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n")
+            f.write("<plist version=\"1.0\">\n")
+            f.write("<dict>\n")
+
+            filteredItems.each_with_index { |item, index|
+
+              text = self.mapInvalidPlaceholder(item['text'])
+              identifier = item['identifierIos']
+
+              if !identifier.include?('//') && text.include?("one|")
                 if text == "" || text == "TBD"
                   default_language_object = languages.select { |languageItem| languageItem['language'] == defaultLanguage }.first["items"]
                   default_language_object = self.filterUnusedRows(default_language_object,'identifierIos')
 
                   defaultLanguageText = default_language_object[index]['text']
-                  puts "found empty text for identifier: #{identifier} for language:#{language['language']}, replaceing it with #{defaultLanguageText}"
+                  puts "found empty text for:\n\tidentifier: #{identifier}\n\tlanguage:#{language['language']}\n\treplacing it with: #{defaultLanguageText}"
                   text = self.mapInvalidPlaceholder(defaultLanguageText)
                 end
 
-                line = "\"#{identifier}\" = \"#{text}\";"
-              if !comment.to_s.empty?
-                 line = line + " //#{comment}\n"
-               else
-                 line = line + "\n"
-              end
-              end
+                text = text.gsub("\n", "|")
 
-              f.write(line)
+                formatIdentifier = identifier.gsub(".", "")
+
+                f.write("\t\t<key>#{identifier}</key>\n")
+                f.write("\t\t<dict>\n")
+                f.write("\t\t\t<key>NSStringLocalizedFormatKey</key>\n")
+                f.write("\t\t\t<string>%#@#{formatIdentifier}@</string>\n")
+                f.write("\t\t\t<key>#{formatIdentifier}</key>\n")
+                f.write("\t\t\t<dict>\n")
+                f.write("\t\t\t\t<key>NSStringFormatSpecTypeKey</key>\n")
+                f.write("\t\t\t\t<string>NSStringPluralRuleType</string>\n")
+                f.write("\t\t\t\t<key>NSStringFormatValueTypeKey</key>\n")
+                f.write("\t\t\t\t<string>d</string>\n")
+
+                text.split("|").each_with_index { |word, wordIndex|
+                  if wordIndex % 2 == 0
+                    f.write("\t\t\t\t<key>#{word}</key>\n")
+                  else
+                    f.write("\t\t\t\t<string>#{word}</string>\n")
+                  end
+                }
+                f.write("\t\t\t</dict>\n")
+                f.write("\t\t</dict>\n")
+              end
             }
+            f.write("</dict>\n")
+            f.write("</plist>\n")
           end
         end
 
         if platform == "android"
           languageDir = language['language']
 
-          if languageDir == "en"
+          if languageDir == base_language
             languageDir = "values"
           else
             languageDir = "values-#{languageDir}"
@@ -195,23 +270,54 @@ module Fastlane
           File.open("#{destinationPath}/#{languageDir}/strings.xml", "w") do |f|
             f.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
             f.write("<resources>\n")
-            language["items"].each { |item|
+
+            filteredItems = self.filterUnusedRows(language["items"],'identifierAndroid')
+
+            filteredItems.each_with_index { |item, index|
 
               comment = item['comment']
               identifier = item['identifierAndroid']
               text = item['text']
 
-              if !identifier.to_s.empty? && identifier != "NR"
-                line = ""
+              line = ""
 
-                if !comment.to_s.empty?
-                  line = line + "\t<!--#{comment}-->\n"
-                end
+              if !comment.to_s.empty?
+                line = line + "\t<!--#{comment}-->\n"
+              end
 
-                line = line + "\t<string name=\"#{identifier}\"><![CDATA[#{text}]]></string>\n"
+              if text == "" || text == "TBD"
+                default_language_object = languages.select { |languageItem| languageItem['language'] == defaultLanguage }.first["items"]
+                default_language_object = self.filterUnusedRows(default_language_object,'identifierAndroid')
 
-                f.write(line)
+                defaultLanguageText = default_language_object[index]['text']
+                puts "found empty text for:\n\tidentifier: #{identifier}\n\tlanguage:#{language['language']}\n\treplacing it with: #{defaultLanguageText}"
+                text = defaultLanguageText
               end
+
+              text = text.gsub(/\\?'/, "\\\\'")
+
+              if text.include?("one|")
+
+                text = text.gsub("\n", "|")
+
+                line = line + "\t<plurals name=\"#{identifier}\">\n"
+
+                plural = ""
+
+                text.split("|").each_with_index { |word, wordIndex|
+                  if wordIndex % 2 == 0
+                    plural = "\t\t<item quantity=\"#{word}\">"
+                  else
+                    plural = plural + "<![CDATA[\"#{word}\"]]></item>\n"
+                    line = line + plural
+                  end
+                }
+                line = line + "\t</plurals>\n"
+              else
+                line = line + "\t<string name=\"#{identifier}\"><![CDATA[#{text}]]></string>\n"
+              end
+
+              f.write(line)
             }
             f.write("</resources>\n")
           end
@@ -220,14 +326,13 @@ module Fastlane
       end
 
       def self.createiOSFileEndString()
-        return "\n\nextension Localization {\n\tprivate static func localized(identifier key: String, _ args: CVarArg...) -> String {\n\t\tlet format = NSLocalizedString(key, tableName: nil, bundle: Bundle.main, comment: \"\")\n\n\t\tguard !args.isEmpty else { return format }\n\n\t\treturn String(format: format, locale: Locale.current, arguments: args)\n\t}\n}"
+        return "\n\nprivate class LocalizationHelper { }\n\nextension Localization {\n\tprivate static func localized(identifier key: String, _ args: CVarArg...) -> String {\n\t\tlet format = NSLocalizedString(key, tableName: nil, bundle: Bundle(for: LocalizationHelper.self), comment: \"\")\n\n\t\tguard !args.isEmpty else { return format }\n\n\t\treturn String(format: format, locale: .current, arguments: args)\n\t}\n}"
       end
 
       def self.createiOSFunction(constantName, identifier, arguments, comment)
           functionTitle = "\n\t///Sheet comment: #{comment}\n\tpublic static func #{constantName}("
 
           arguments.each_with_index do |item, index|
-            puts item
             functionTitle = functionTitle + "_ arg#{index}: #{item[:type]}"
             if index < arguments.count - 1
               functionTitle = functionTitle + ", "
@@ -249,6 +354,11 @@ module Fastlane
       end
 
       def self.findArgumentsInText(text)
+
+        if text.include?("one|")
+          text = text.dup.split("|")[1]
+        end
+
         result = Array.new
         filtered = self.mapInvalidPlaceholder(text)
 
@@ -319,7 +429,8 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :tabs,
                                   env_name: "TABS",
                                description: "Array of all Google Sheet Tabs",
-                                  optional: false,
+                               default_value: [],
+                                  optional: true,
                                       type: Array),
           FastlaneCore::ConfigItem.new(key: :language_titles,
                                   env_name: "LANGUAGE_TITLES",
@@ -331,6 +442,11 @@ module Fastlane
                                description: "Default Language",
                                   optional: false,
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :base_language,
+                                  env_name: "BASE_LANGUAGE",
+                               description: "Base language for Xcode projects",
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :localization_path,
                                   env_name: "LOCALIZATION_PATH",
                                description: "Output path",

data/lib/fastlane/plugin/google_sheet_localize/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module GoogleSheetLocalize
-    VERSION = "0.1.6"
+    VERSION = "0.1.20"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-google_sheet_localize
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.20
 platform: ruby
 authors:
 - Mario Hahn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement