fastlane-plugin-google_sheet_localize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa84006d7058d1cc9649efb0b0c8f7c540976c22621c9e07c5d1d9d3aa87d5df
+  data.tar.gz: 9ebb44a052366f2274aaf1434063b0136f2b56e6c36f9a3527258a2bdcf4d893
+SHA512:
+  metadata.gz: f8079ccd415ce7c7277251915966b7a5da501b9e2619f1dad4c8c777a234de0ca9543b88b6aa8597bc51fa6d816e7086c8a5119a8804f1a4015b5aa253bb11f5
+  data.tar.gz: 3bd3dd582afe25d12b26a6c34ea72c3f3362323debd7c5eca0045f4d01e57b9284f5def274260a5e5f519bfdab23dbdfcc5a199b55f761e7c6386ca3155ef141

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mario Hahn <mario_hahn@me.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# google_sheet_localize plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-google_sheet_localize)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-google_sheet_localize`, add it to your project by running:
+
+```bash
+fastlane add_plugin google_sheet_localize
+```
+
+## About 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.
+
+## 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`.
+
+**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
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

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

@@ -0,0 +1,295 @@
+require 'fastlane/action'
+require_relative '../helper/google_sheet_localize_helper'
+
+module Fastlane
+  module Actions
+    class GoogleSheetLocalizeAction < Action
+      def self.run(params)
+
+        session = GoogleDrive::Session.from_service_account_key(params[:service_account_path])
+        spreadsheet_id = "https://docs.google.com/spreadsheets/d/#{params[:sheet_id]}"
+        tabs = params[:tabs]
+        plaform = params[:platform]
+
+        spreadsheet = session.spreadsheet_by_url(spreadsheet_id)
+
+        # Get the first worksheet
+        worksheet = spreadsheet.worksheets.first
+
+        languages = numberOfLanguages(worksheet)
+
+        result = []
+
+        for i in 2..1+languages
+          title = worksheet.rows[0][i]
+
+          language = {
+            'language' => title,
+            'items' => []
+          }
+
+          filterdWorksheets = []
+
+          if tabs.count == 0
+            filterdWorksheets = spreadsheet.worksheets
+          else
+            filterdWorksheets = spreadsheet.worksheets.select { |item| tabs.include?(item.title) }
+          end
+
+          filterdWorksheets.each { |worksheet|
+            contentRows = worksheet.rows.drop(1)
+            language['items'].concat(generateJSONObject(contentRows, i))
+          }
+
+          result.push(language)
+
+        end
+        createFiles(result, platform, path)
+      end
+
+      def generateJSONObject(contentRows, index)
+          result = Array.new
+          for i in 0..contentRows.count - 1
+              item = generateSingleObject(contentRows[i], index)
+
+              if item[:identifierIos] != "" && item[:identifierAndroid] != ""
+                result.push(item)
+              end
+          end
+
+          return result
+
+      end
+
+      def writeToJSONFile(languages)
+        File.open("output.json","w") do |f|
+          f.write(JSON.pretty_generate(languages))
+        end
+      end
+
+      def generateSingleObject(row, column)
+        identifierIos = row[0]
+        identifierAndroid = row[1]
+
+        text = row[column]
+        comment = row.last
+
+        object = { 'identifierIos' => identifierIos,
+                   'identifierAndroid' => identifierAndroid,
+                   'text' => text,
+                   'comment' => comment
+        }
+
+        return object
+
+      end
+
+      def createFiles(languages, platform, destinationPath)
+          languages.each { |language| createFileForLanguage(language, platform, destinationPath) }
+
+          if platform == "ios"
+
+            swiftFilename = "Localization.swift"
+            swiftFilepath = "#{destinationPath}/#{swiftFilename}"
+
+            #removes all identififiers with the label Not Required
+            filteredItems = languages[0]["items"].select { |item| item['identifierIos'] != "NR" }
+
+            File.open(swiftFilepath, "w") do |f|
+              f.write("import Foundation\n\n\npublic struct Localization {\n")
+              filteredItems.each { |item|
+
+                identifier = item['identifierIos']
+
+                values = identifier.dup.gsub('.', ' ').split(" ")
+
+                constantName = ""
+
+                values.each_with_index do |item, index|
+                  if index == 0
+                    constantName += item.downcase
+                  else
+                    constantName += item.capitalize
+                  end
+                end
+
+                text = mapInvalidPlaceholder(item['text'])
+
+                arguments = findArgumentsInText(text)
+
+                puts "Arguments"
+                puts arguments.count
+
+                if arguments.count == 0
+                  f.write("\n\t///Sheet comment: #{item['comment']}\n\tpublic static let #{constantName} = localized(identifier: \"#{identifier}\")\n")
+                else
+                  f.write(createiOSFunction(constantName, identifier, arguments, item['comment']))
+                end
+              }
+              f.write("\n}")
+              f.write(createiOSFileEndString())
+            end
+
+          end
+      end
+
+      def createFileForLanguage(language, platform, destinationPath)
+        if platform == "ios"
+
+          swiftFilename = "Localization.swift"
+          swiftFilepath = "#{destinationPath}/#{swiftFilename}"
+
+          #removes all identififiers with the label Not Required
+          filteredItems = language["items"].select { |item| item['identifierIos'] != "NR" }
+
+          filename = "Localizable.strings"
+          filepath = "#{destinationPath}/#{language['language']}.lproj/#{filename}"
+          FileUtils.mkdir_p language['language']
+          File.open(filepath, "w") do |f|
+            filteredItems.each { |item|
+
+              text = mapInvalidPlaceholder(item['text'])
+
+              f.write("//#{item['comment']}\n\"#{item['identifierIos']}\" = \"#{text}\";\n")
+            }
+          end
+        end
+
+        if platform == "android"
+          FileUtils.mkdir_p "values-#{language['language']}"
+          File.open("values-#{language['language']}/strings.xml", "w") do |f|
+            f.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
+            f.write("<resources>\n")
+            language["items"].each { |item|
+              f.write("\t<!--#{item['comment']}-->\n\t<string name=\"#{item['identifierAndroid']}\"><![CDATA[#{item['text']}]]></string>\n")
+            }
+            f.write("</resources>\n")
+          end
+        end
+      end
+
+      def 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}"
+      end
+
+      def 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 + ", "
+            else
+              functionTitle = functionTitle + ") -> String {\n"
+            end
+          end
+          functionTitle = functionTitle + "\t\treturn localized(identifier: \"#{identifier}\", "
+          arguments.each_with_index do |item, index|
+            functionTitle = functionTitle + "arg#{index}"
+            if index < arguments.count - 1
+              functionTitle = functionTitle + ", "
+            else
+              functionTitle = functionTitle + ")\n\t}"
+            end
+          end
+
+          return functionTitle
+      end
+
+      def findArgumentsInText(text)
+        result = Array.new
+        filtered = mapInvalidPlaceholder(text)
+
+        puts filtered
+
+        stringIndexes = (0 ... filtered.length).find_all { |i| filtered[i,2] == '%@' }
+        intIndexes = (0 ... filtered.length).find_all { |i| filtered[i,2] == '%d' }
+        floatIndexes = (0 ... filtered.length).find_all { |i| filtered[i,2] == '%f' }
+        doubleIndexes = (0 ... filtered.length).find_all { |i| filtered[i,3] == '%ld' }
+
+        if stringIndexes.count > 0
+          result = result.concat(stringIndexes.map { |e| { "index": e, "type": "String" }})
+        end
+
+        if intIndexes.count > 0
+          result = result.concat(intIndexes.map { |e| { "index": e, "type": "Int" }})
+        end
+
+        if floatIndexes.count > 0
+          result = result.concat(floatIndexes.map { |e| { "index": e, "type": "Float" }})
+        end
+
+        if doubleIndexes.count > 0
+          result = result.concat(doubleIndexes.map { |e| { "index": e, "type": "Double" }})
+        end
+
+        puts result
+        result = result.sort { |a, b| a[:index] <=> b[:index] }
+        puts result
+
+        puts "count"
+        puts result.count
+
+
+        return result
+      end
+
+      def mapInvalidPlaceholder(text)
+        filtered = text.gsub('%s', '%@')
+        return filtered
+      end
+
+      def numberOfLanguages(worksheet)
+        i = worksheet.num_cols
+        return i - 3
+      end
+
+      def self.description
+        "Creates .strings files for iOS and strings.xml files for Android"
+      end
+
+      def self.authors
+        ["Mario Hahn"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Creates .strings files for iOS and strings.xml files for Android. The localization is mananged on a google sheet."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :service_account_path,
+                                  env_name: "SERVICE_ACCOUNT_PATH",
+                               description: "Credentials path",
+                                  optional: false,
+                                      type: String),
+           FastlaneCore::ConfigItem.new(key: :sheet_id,
+                                   env_name: "SHEET_ID",
+                                description: "Your Google-spreadsheet id",
+                                   optional: false,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                  env_name: "PLATFORM",
+                               description: "Plaform, ios or android",
+                                  optional: "ios",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :tabs,
+                                  env_name: "TABS",
+                               description: "Array of all Google Sheet Tabs",
+                                  optional: false,
+                                      type: Array)
+        ]
+      end
+
+      def self.is_supported?(platform)
+         [:ios, :mac, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/google_sheet_localize/helper/google_sheet_localize_helper.rb

@@ -0,0 +1,11 @@
+require 'fastlane_core/ui/ui'
+require 'google_drive'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class GoogleSheetLocalizeHelper
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module GoogleSheetLocalize
+    VERSION = "0.1.0"
+  end
+end

data/lib/fastlane/plugin/google_sheet_localize.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/google_sheet_localize/version'
+
+module Fastlane
+  module GoogleSheetLocalize
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::GoogleSheetLocalize.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-google_sheet_localize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mario Hahn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.111.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.111.0
+description: 
+email: mario_hahn@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/google_sheet_localize.rb
+- lib/fastlane/plugin/google_sheet_localize/actions/google_sheet_localize_action.rb
+- lib/fastlane/plugin/google_sheet_localize/helper/google_sheet_localize_helper.rb
+- lib/fastlane/plugin/google_sheet_localize/version.rb
+homepage: https://github.com/tailoredmedia/fastlane-plugin-localize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Creates .strings files for iOS and strings.xml files for Android
+test_files: []