fastlane-plugin-translation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e7a31c74e6cc591cd4799f4419ca6e8691eabe5
+  data.tar.gz: 7f8e1bab54481514263847f31499436f1b9b3ea9
+SHA512:
+  metadata.gz: ca0153bd137bbc975e09f7bc10b1ea56ff97325807f91f20bb6ddf84e65711457badb085d5560363ed4c1118bd97fe666494dd2e4c8d52576f932984cb5e8465
+  data.tar.gz: 9a97b32244d6343e2169a3128cf07194d8c3e3fc77a048e8b48f579aaef1f73a3f5fb7b96b6eb5237668c4651ef837bc556ee3b07c9e356ea4668acb268c7a91

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jakob Jensen <jje@trifork.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 @@
+# translation plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-translation)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-translations`, add it to your project by running:
+
+```bash
+fastlane add_plugin translation
+```
+
+## About translation
+
+Fetch application for translations from Google sheet.
+
+**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/translation.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/translation/version'
+
+module Fastlane
+  module Translation
+    # 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::Translation.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/translation/actions/create_translation_action.rb

@@ -0,0 +1,74 @@
+module Fastlane
+  module Actions
+    class CreateTranslationAction < Action
+      require 'google_drive'
+
+      def self.run(params)
+        UI.message "Logging into google using #{params[:config_path]}"
+        session = GoogleDrive::Session.from_config(params[:config_path])
+
+        UI.message "Creating document with title '#{params[:doc_name]}'"
+
+        file = session.spreadsheet_by_title(params[:doc_name])
+        if file
+          raise "Document already exists, please change to a different doc_name".red
+        else
+          tmp_file = "#{FastlaneCore::FastlaneFolder.path}/translations"
+          f = File.open(tmp_file, "w")
+          f.close
+          file = session.upload_from_file(File.absolute_path(tmp_file).to_s, params[:doc_name], convert: true, content_type: "text/csv")
+
+          File.delete(tmp_file)
+
+          file.acl.push({ type: 'user', value: params[:owner_email], role: 'owner' })
+          file.acl.push({ type: 'user', value: params[:seed_email], role: 'writer' }) unless params[:owner_email] == params[:seed_email]
+          UI.message "Done creating document, use doc_id:'#{file.id}' for pulling translations.".yellow
+        end
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Create sheet for translations in Google sheets."
+      end
+
+      def self.authors
+        ["Krzysztof Piatkowski", "Jakob Jensen"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        nil
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :config_path,
+                                       env_name: "FL_TRANSLATION_CONFIG_PATH",
+                                       description: "reference for the config json file, see https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md for more info",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :doc_name,
+                                       env_name: "FL_TRANSLATION_DOC_NAME",
+                                       description: "unique name of the google sheet",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :owner_email,
+                                       env_name: "FL_TRANSLATION_OWNER_EMAIL",
+                                       description: "The mail to give ownership over the the document",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :seed_email,
+                                       env_name: "FL_TRANSLATION_SEED_EMAIL",
+                                       description: "The mail to give rights when initializing the document",
+                                       optional: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/translation/actions/translation_action.rb

@@ -0,0 +1,182 @@
+module Fastlane
+  module Actions
+    class TranslationAction < Action
+      require 'google_drive'
+      require 'csv'
+
+      def self.run(params)
+        UI.message "Logging into google using #{params[:config_path]}"
+        session = GoogleDrive::Session.from_config(params[:config_path])
+
+        UI.message "Downloading CVS to #{params[:cvs_output_path]}"
+        file = session.file_by_id(params[:doc_id])
+        file.export_as_file(params[:cvs_output_path], "text/csv")
+
+        if params[:ios_output_paths]
+          self.convert_csv_to_ios_paths(params[:key], params[:cvs_output_path], params[:ios_output_paths])
+        end
+
+        if params[:android_output_paths]
+          convert_csv_to_android_paths(params[:key], params[:cvs_output_path], params[:android_output_paths])
+        end
+
+        if params[:swift_struct_path]
+          self.create_swift_struct(params[:key], params[:ios_output_paths].values.first, params[:cvs_output_path], params[:swift_struct_path])
+        end
+
+        if params[:dotnet_class_path]
+          self.create_dotnet_class(params[:key], params[:cvs_output_path], params[:dotnet_class_path])
+        end
+
+        File.delete(params[:cvs_output_path])
+      end
+
+      def self.convert_csv_to_ios_paths(key, cvs_path, output_paths)
+        output_paths.each do |file_path, index|
+          FileUtils.mkdir_p(File.dirname(file_path))
+          UI.message("Writing #{file_path}")
+          file = open(file_path, 'w')
+          CSV.foreach(cvs_path) do |row|
+            if row[key] && row[key].length > 0 && !row[index].nil?
+              key_row = row[key]
+              value_row = row[index].gsub("\"", "\\\"")
+              value_row = value_row.gsub("\n", "\\n")
+              file.write("#{key_row} = \"#{value_row}\";\n")
+            end
+          end
+          file.close
+        end
+      end
+
+      def self.convert_csv_to_android_paths(key, cvs_path, output_paths)
+        output_paths.each do |file_path, index|
+          FileUtils.mkdir_p(File.dirname(file_path))
+          UI.message("Writing #{file_path}")
+          file = open(file_path, 'w')
+          file.write("<resources>\n")
+          CSV.foreach(cvs_path) do |row|
+            if row[key] && row[key].length > 0
+              key_row = row[key]
+              file.write("\t<string name=\"#{key_row}\">#{row[index]}</string>\n")
+            end
+          end
+          file.write('</resources>')
+          file.close
+        end
+      end
+
+      def self.create_swift_struct(key, master_index, cvs_path, swift_path)
+        UI.message("Writing swift struct #{swift_path}")
+        FileUtils.mkdir_p(File.dirname(swift_path))
+        file = open(swift_path, 'w')
+        file.write("import Foundation\nstruct Translations {\n")
+
+        CSV.foreach(cvs_path) do |row|
+          if row[key] && row[key].length > 0 && row.compact.length > 1
+            key_row = row[key]
+            master = row[master_index]
+            parameters = master.scan(/\%\d+/)
+            if parameters.count > 0
+              args_str = parameters.map { |e| e.sub('%', 'p') + ': String' }.join(', _ ')
+              file.write("\tstatic func #{key_row}(_ #{args_str}) -> String {")
+              file.write(" return NSLocalizedString(\"#{key_row}\", comment: \"\")")
+              parameters.each { |e| file.write(".replacingOccurrences(of: \"#{e}\", with: #{e.sub('%', 'p')})") }
+              file.write(" }\n")
+            else
+              file.write("\tstatic let #{key_row} = NSLocalizedString(\"#{keyRow}\", comment: \"\");\n")
+            end
+          end
+        end
+        file.write("}")
+        file.close
+      end
+
+      def self.create_dotnet_class(key, cvs_path, dotnet_path)
+        UI.message("Writing dotnet struct #{dotnet_path}")
+        FileUtils.mkdir_p(File.dirname(dotnet_path))
+        file = open(dotnet_path, 'w')
+        file.write("using Foundation;\nstatic class Translations {\n")
+
+        CSV.foreach(cvs_path) do |row|
+          if row[key] && row[key].length > 0
+            key_row = row[key]
+            file.write("\tpublic static string #{key_row} { get { return NSBundle.MainBundle.LocalizedString (\"#{key_row}\", null); } }\n")
+          end
+        end
+        file.write("}")
+        file.close
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Output translations from Google sheet into templates."
+      end
+
+      def self.authors
+        ["Krzysztof Piatkowski", "Jakob Jensen"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        nil
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :config_path,
+                                       env_name: "FL_TRANSLATION_CONFIG_PATH",
+                                       description: "refrence for the config json file, see https://github.com/gimite/google-drive-ruby/blob/master/doc/authorization.md for more info",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :doc_id,
+                                       env_name: "FL_TRANSLATION_DOC_ID",
+                                       description: "id of the google sheet, can be used instead of doc_name after creation",
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :cvs_output_path,
+                                       default_value: FastlaneCore::FastlaneFolder.path + "translation.cvs",
+                                       env_name: "FL_TRANSLATION_CVS_OUTPUT_PATH",
+                                       description: "The path where the cvs is placed",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :ios_output_paths,
+                                       default_value: nil,
+                                       env_name: "FL_TRANSLATION_IOS_OUTPUT_PATH",
+                                       is_string: false,
+                                       description: "An map from path to a column in the google sheet outputs a localized .strings file",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :android_output_paths,
+                                       default_value: nil,
+                                       env_name: "FL_TRANSLATION_ANDROID_OUTPUT_PATH",
+                                       is_string: false,
+                                       description: "An map from path to a column in the google sheet outputs a strings.xml",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :swift_struct_path,
+                                       default_value: nil,
+                                       env_name: "FL_TRANSLATION_SWIFT_STRUCT_PATH",
+                                       is_string: false,
+                                       description: "Creates a swift struct with all the translations as properties",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :dotnet_class_path,
+                                       default_value: nil,
+                                       env_name: "FL_TRANSLATION_DOTNET_CLASS_PATH",
+                                       is_string: false,
+                                       description: "Creates a .net class with all the translations as properties",
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       default_value: 1,
+                                       is_string: false,
+                                       env_name: "FL_TRANSLATION_KEY",
+                                       description: "index of key column",
+                                       optional: true)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/translation/helper/translation_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class TranslationHelper
+      # class methods that you define here become available in your action
+      # as `Helper::TranslationsHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the translation plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Translation
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-translation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jakob Jensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+- !ruby/object:Gem::Dependency
+  name: google_drive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+- !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: 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'
+  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.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: 
+email: jje@trifork.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fastlane/plugin/translation/actions/create_translation_action.rb
+- lib/fastlane/plugin/translation/actions/translation_action.rb
+- lib/fastlane/plugin/translation/helper/translation_helper.rb
+- lib/fastlane/plugin/translation/version.rb
+- lib/fastlane/plugin/translation.rb
+- README.md
+- LICENSE
+homepage: https://github.com/trifork/fastlane-plugin-translation
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Handling translations from Google sheet.
+test_files: []