fastlane-plugin-simple_loco 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d0b03ff11d3b9284852f029335b41b29e1812f8f056603cd6a288191992f778
+  data.tar.gz: f30e75b6cb230097052838aec6990a1c547f3b38f09d2678d31f28d8a5d4a08d
+SHA512:
+  metadata.gz: 3881301e1e63a7629d8a2895ad19e578eb1c80852e98cb2ab97af1c26753787e18f9570b9945b73d17714b26515a64ffbb92a5a8ed941d15b5a29083d8e63971
+  data.tar.gz: 0cb0a2d45a955f4bf897c7b040bb8d261cfb7557a6703aca506d6c7f1d039f675e0b68752a5a0bbab5de909ead6457bc809ea683acf4f216239e7accc69ab86f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Yves Delcoigne <yves_delcoigne@hotmail.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,121 @@
+# simple_loco plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-simple_loco)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-simple_loco`, add it to your project by running:
+
+```bash
+fastlane add_plugin simple_loco
+```
+
+## About simple_loco
+
+A simple implementation for exporting translations from [Loco](https://localise.biz/).
+
+This plugin is heavily inspired by https://github.com/JohnPaulConcierge/fastlane-plugin-loco, but some functionality has been removed and added. This plugin acts primarily as a wrapper implementation around the export single locale API call of Loco (see https://localise.biz/api/docs/export/exportlocale for full details).
+
+There is advanced support for the following platforms:
+- Android
+- iOS
+- Xamarin (with resx resource files)
+- Flutter (with arb files)
+
+For the platforms above, an extra adapter is available to create the correct folder and files needed to use the translations.
+
+For other platforms, a default implementation is provided (translation files will be saved like \<provided folder\>/\<provided file name\>.\<locale\>.\<extension\>)
+
+This plugin contains a single action `simple_loco`.
+
+This action uses a configuration file to generate the correct API call.
+
+The config file specifies the following properties:
+- locales: List of locales to fetch
+- directory: Directory to move translation files to
+- platform: Platform for the translations: choice between:
+    - Android
+    - iOS
+    - Xamarin
+    - Flutter
+    - Custom
+- key: Key of the Loco project
+- Optional parameters:
+  - format
+  - filter
+  - index
+  - source
+  - namespace
+  - fallback
+  - order
+  - status
+  - printf
+  - charset
+  - breaks
+  - no_comments
+  - no_folding
+
+For an explanation of the optional parameters, please see the official API reference: https://localise.biz/api/docs/export/exportlocale
+
+Example of a JSON config file:
+```
+{
+    "locales" : [
+      "en",
+      "fr",
+      "nl",
+      "de"
+    ],
+    "directory" : "src/main/res",
+    "platform" : "android",
+    "key" : "<Your key here>",
+    "fallback_locale" : "en",
+    "order": "id",
+    "filter": ["android"]
+}
+```
+
+Or in YAML:
+```
+locales:
+  - en
+  - fr
+  - nl
+  - de
+directory: src/main/res
+platform: custom
+key: <your key here>
+fallback: en
+order: id
+custom_extension: .xml
+custom_file_name: strings
+```
+
+## 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/simple_loco.rb

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

data/lib/fastlane/plugin/simple_loco/actions/simple_loco_action.rb

@@ -0,0 +1,48 @@
+require 'fastlane/action'
+require_relative '../helper/simple_loco_helper'
+
+module Fastlane
+  module Actions
+    class SimpleLocoAction < Action
+      def self.run(params)
+        config = Helper::Config.read_conf(params[:conf_file_path])
+
+        UI.message('Exporting files')
+
+        config.export_locales
+
+        UI.success('Finished exporting files')
+      end
+
+      def self.description
+        "A simple implementation for exporting translations from Loco."
+      end
+
+      def self.authors
+        ["Yves Delcoigne"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        "A wrapper implementation around the Localize export single-file API. See https://localise.biz/api/docs/export/exportlocale for all options. Common mobile platforms (Android, iOS, Xamarin, Flutter) have some extra logic to create the correct paths, and a custom implementation is provided for other platforms."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :conf_file_path,
+                                       env_name: 'LOCO_CONF_FILE_PATH',
+                                       description: 'The config file path',
+                                       optional: true,
+                                       type: String,
+                                       default_value: 'fastlane/Loco.platform.json')
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/simple_loco/helper/simple_loco_helper.rb

@@ -0,0 +1,396 @@
+require 'fastlane_core/ui/ui'
+require 'fileutils'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    PLATFORM_IOS = 'ios'
+    PLATFORM_ANDROID = 'android'
+    PLATFORM_FLUTTER = 'flutter'
+    PLATFORM_XAMARIN = 'xamarin'
+    PLATFORM_CUSTOM = 'custom'
+
+    class Config
+      def initialize(platform:,
+                     directory:,
+                     locales:,
+                     key:,
+                     format: "",
+                     filter: [],
+                     index: "",
+                     source: "",
+                     namespace: "",
+                     fallback: "",
+                     order: "",
+                     status: "",
+                     printf: "",
+                     charset: "",
+                     breaks: "",
+                     no_comments: "",
+                     no_folding: "",
+                     custom_extension: "",
+                     custom_file_name: "")
+
+        # Check for required fields
+        missing_fields = []
+        if platform.to_s.empty?
+          missing_fields.push 'platform'
+        end
+        if directory.to_s.empty?
+          missing_fields.push 'directory'
+        end
+        if key.to_s.empty?
+          missing_fields.push 'key'
+        end
+        if locales.to_s.empty?
+          missing_fields.push 'locales'
+        end
+
+        if !missing_fields.empty?
+          raise "Not all required fields are filled: #{missing_fields.join(", ")}"
+        end
+
+        @platform = platform
+        @directory = directory
+        @locales = locales
+        @key = key
+        @format = format
+        @filter = filter
+        @index = index
+        @source = source
+        @namespace = namespace
+        @fallback = fallback
+        @order = order
+        @status = status
+        @printf = printf
+        @charset = charset
+        @breaks = breaks
+        @no_comments = no_comments
+        @no_folding = no_folding
+  
+        if platform == PLATFORM_ANDROID
+          @adapter = AndroidAdapter.new
+        elsif platform == PLATFORM_IOS
+          @adapter = CocoaAdapter.new
+        elsif platform == PLATFORM_FLUTTER
+          @adapter = FlutterAdapter.new
+        elsif platform == PLATFORM_XAMARIN
+          @adapter = XamarinAdapter.new
+        elsif platform == PLATFORM_CUSTOM
+          @adapter = CustomAdapter.new(
+            custom_extension: custom_extension,
+            custom_file_name: custom_file_name)
+        else
+          raise "Unsupported platform '#{platform}'"
+        end
+      end
+  
+      attr_reader :platform
+      attr_reader :directory
+      attr_reader :locales
+      attr_reader :key
+      attr_reader :format
+      attr_reader :filter
+      attr_reader :index
+      attr_reader :source
+      attr_reader :namespace
+      attr_reader :fallback
+      attr_reader :order
+      attr_reader :status
+      attr_reader :printf
+      attr_reader :charset
+      attr_reader :breaks
+      attr_reader :no_comments
+      attr_reader :no_folding
+
+      def export_locales
+
+        FileUtils.mkdir_p @directory unless File.directory? @directory
+
+        @locales.each_with_index do |locale, index|
+
+          @adapter.allowed_extensions.each do |extension|
+
+            # Download
+  
+            result = export locale, extension
+  
+            if result.nil?
+              raise "Could not export locale #{locale} with extension #{extension}"
+            end
+  
+            # Write
+  
+            result_directory = locale_directory locale, index.zero?
+            FileUtils.mkdir_p result_directory unless File.directory? result_directory
+
+            @adapter.write_locale(result_directory,
+                                  result,
+                                  locale,
+                                  extension,
+                                  index.zero?)
+
+          end
+        end  
+      end
+
+      # Exports the locale for the corresponding extension
+      #
+      # @param [String] the locale
+      # @param [String] the extension, must include the `.`
+      def export(locale, extension)
+
+        optional_query_params = {}
+        if !@format.to_s.empty?
+          optional_query_params["format"] = @format 
+        end
+        if @filter != nil && !filter.empty?
+          optional_query_params["filter"] = @filter.join(',') 
+        end
+        if !@index.to_s.empty?
+          optional_query_params["index"] = @index 
+        end
+        if !@source.to_s.empty?
+          optional_query_params["source"] = @source 
+        end
+        if !@namespace.to_s.empty?
+          optional_query_params["namespace"] = @namespace 
+        end
+        if !@fallback.to_s.empty?
+          optional_query_params["fallback"] = @fallback 
+        end
+        if !@order.to_s.empty?
+          optional_query_params["order"] = @order 
+        end
+        if !@status.to_s.empty?
+          optional_query_params["status"] = @status 
+        end
+        if !@printf.to_s.empty?
+          optional_query_params["printf"] = @printf 
+        end
+        if !@charset.to_s.empty?
+          optional_query_params["charset"] = @charset 
+        end
+        if !@breaks.to_s.empty?
+          optional_query_params["breaks"] = @breaks 
+        end
+        if !@no_comments.to_s.empty?
+          optional_query_params["no-comments"] = @no_comments 
+        end
+        if !@no_folding.to_s.empty?
+          optional_query_params["no-folding"] = @no_folding 
+        end
+
+        uri = URI::HTTPS.build(scheme: 'https',
+                               host: 'localise.biz',
+                               path: "/api/export/locale/#{locale}#{extension}",
+                               query: URI.encode_www_form(optional_query_params)
+                              )
+
+        res = Net::HTTP.start(uri.host, uri.port,
+          :use_ssl => uri.scheme == 'https') do |http|
+            req = Net::HTTP::Get.new(uri)
+            req['Authorization'] = "Loco #{@key}"
+            http.request req
+        end
+  
+        if res.code == '200'
+          body = res.body
+  
+          # Extracting charset because Net does not do it
+          content_type = res['Content-Type']
+          charset = /charset=([^ ;]*)/.match content_type
+          unless charset.nil?
+            body = body.force_encoding(charset.captures[0])
+                       .encode('utf-8')
+          end
+  
+          return body
+        end
+  
+        warn 'URL failed: ' + uri.to_s
+        nil
+      end
+  
+      def locale_directory(locale, is_default)  
+        return File.join(@directory,
+                  @adapter.directory(locale, is_default))
+      end
+  
+      # Static method used to read a config file
+      def self.read_conf(path)
+        accepted_formats = [".json", ".yaml", ".yml"]
+        extension = File.extname(path)
+
+        if !accepted_formats.include?(extension)
+          raise "Unsupported config file format #{extension}, only JSON and YAML files are supported."
+        end
+
+        if extension == ".json"
+          json = JSON.parse(File.read(path))        
+          return Config.new(json.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; })
+        end
+
+        yaml = YAML.safe_load(File.read(path))
+        return Config.new(yaml.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; })
+      end
+    end
+
+    class BaseAdapter
+      # ====================================
+      # Methods to override
+  
+      # All the extensions allowed for that adapter
+      #
+      # This method is also used to determine what to load from the server
+      #
+      # Must be written with the '.' like '.xml'
+      #
+      # @return [Array] an array of all the allowed extensions
+      def allowed_extensions
+        return []
+      end
+  
+      # Returns res directory for the mapped locale
+      #
+      # Base implementation does nothing
+      #
+      # @param [String] the mapped locale name
+      # @param [true] whether the locale is the default one
+      def directory(locale, is_default)
+        return ''
+      end
+  
+      # Returns the default name
+      def default_file_name
+        return ''
+      end
+  
+      # Writes the locale to a directory
+      def write_locale(directory,
+                        result, 
+                        locale, 
+                        extension,
+                        is_default)
+        path = File.join(directory, default_file_name + extension)
+        File.write path, result
+      end
+    end
+
+    class AndroidAdapter < BaseAdapter  
+      def allowed_extensions
+        return ['.xml']
+      end
+  
+      def directory(locale, is_default)
+        return is_default ? 'values' : "values-#{locale}"
+      end
+  
+      def default_file_name
+        return 'strings'
+      end
+    end
+
+    class CocoaAdapter < BaseAdapter
+      def allowed_extensions
+        return ['.strings', '.stringsdict']
+      end
+  
+      def directory(locale, is_default)
+        return "#{locale}.lproj"
+      end
+  
+      def default_file_name
+        return 'Localizable'
+      end
+    end
+
+    class FlutterAdapter < BaseAdapter
+      def allowed_extensions
+        return ['.arb']
+      end
+
+      def default_file_name
+        return 'intl_messages_'
+      end
+
+      def write_locale(directory,
+                        result, 
+                        locale, 
+                        extension,
+                        is_default)
+        path = File.join(directory, default_file_name + locale + extension)
+        File.write path, result
+      end
+    end
+
+    class XamarinAdapter < BaseAdapter
+      def allowed_extensions
+        return ['.resx']
+      end
+  
+      def default_file_name
+        return 'AppResources'
+      end
+
+      def write_locale(directory,
+        result, 
+        locale, 
+        extension,
+        is_default)
+
+        path = nil
+        if is_default
+          path = File.join(directory, default_file_name + extension)
+        else
+          path = File.join(directory, default_file_name + ".#{locale}" + extension)
+        end
+
+        File.write path, result
+      end
+    end
+
+    class CustomAdapter < BaseAdapter
+      def initialize(custom_extension:,
+                    custom_file_name:)
+        @custom_extension = custom_extension
+        @custom_file_name = custom_file_name
+      end
+
+      attr_reader :custom_extension
+      attr_reader :custom_file_name
+  
+      def allowed_extensions
+        return [@custom_extension]
+      end
+  
+      def default_file_name
+        return @custom_file_name
+      end
+
+      def write_locale(directory,
+        result, 
+        locale, 
+        extension,
+        is_default)
+
+        path = nil
+
+        used_extension = extension
+        if !used_extension.start_with?('.')
+          used_extension = ".#{used_extension}"
+        end
+
+        if is_default
+          path = File.join(directory, default_file_name + used_extension)
+        else
+          path = File.join(directory, default_file_name + ".#{locale}" + used_extension)
+        end
+
+        File.write path, result
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SimpleLoco
+    VERSION = "2.0.0"
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-simple_loco
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Yves Delcoigne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-28 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.157.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.157.1
+description: 
+email: yves_delcoigne@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/simple_loco.rb
+- lib/fastlane/plugin/simple_loco/actions/simple_loco_action.rb
+- lib/fastlane/plugin/simple_loco/helper/simple_loco_helper.rb
+- lib/fastlane/plugin/simple_loco/version.rb
+homepage: https://github.com/DelcoigneYves/fastlane-plugin-simple_loco
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple implementation for exporting translations from Loco.
+test_files: []