fastlane-plugin-twine 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b681ccb119a37f145ca75684c638a361b7e0f9cc
+  data.tar.gz: e10edc315e947b499c9eea326a1747062623ac73
+SHA512:
+  metadata.gz: 62b931db18e891ddd9994ae4190fe0efa2d6a3f2dcd6501ef7f93c6589eb4ba1f70c1b217d3ab874e1251c53f002c898c12aa5eeca6aecde7c89c764fa759d38
+  data.tar.gz: 1b4d4ae39c664f9ddc953f2efa4c9ae3981bc36fe82b1eb84068fe46afc00302e340f751e0f03ab91d113d0d9366b82a3d37ed234f5e20bb410ad90c527ad63b

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-present the fastlane authors
+
+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,50 @@
+# twine plugin
+
+[![Travis CI](https://img.shields.io/travis/jonasrottmann/fastlane-plugin-twine.svg?style=flat)](https://travis-ci.org/jonasrottmann/fastlane-plugin-twine)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-twine)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-twine.svg?style=flat)](http://rubygems.org/gems/fastlane-plugin-twine)
+[![License](https://img.shields.io/github/license/SiarheiFedartsou/fastlane-plugin-twine.svg)](https://github.com/jonasrottmann/fastlane-plugin-twine/blob/master/LICENSE)
+
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-twine`, add it to your project by running:
+
+```bash
+fastlane add_plugin twine
+```
+
+## About the plugin
+
+This plugin provides easy access to common actions (e.g. generating the localization files) you would normally perform with [_twine_](https://github.com/scelis/twine) and adds some extra functionality.
+
+### Configuration file
+
+Check out the [example configuration](fastlane/example_config.json).
+
+JSON file scheme:
+
+```json
+[
+    {
+        "description": "",
+        "source_path": "",
+        "twine_args": "",
+        "destination_path": ""
+    }
+]
+```
+
+* `description`: This is optional but recommended to make the output more readable.
+* `source_path`: The path to your twine file. This is required.
+* `twine_args`: Additional args to pass to twine. For example: `--lang en --format android`
+* `destination_path`: The path where the generated translation file will be found. This is required.
+
+
+## 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 all`.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.

data/lib/fastlane/plugin/twine.rb

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

data/lib/fastlane/plugin/twine/actions/twine_check_action.rb

@@ -0,0 +1,69 @@
+module Fastlane
+  module Actions
+    class TwineCheckAction < Action
+      def self.run(params)
+        require 'diffy'
+        Actions.verify_gem!('twine')
+        Helper::TwineConfigParser.parse(params).each do |config|
+          if !File.exist?(config.source_path)
+            UI.user_error!("Source file #{config.source_path} not found")
+          else
+            UI.message(config.description)
+            cmd = Helper::TwineCommandHelper.generate_command(config.source_path, config.destination_path + '.tmp', config.twine_args)
+            cmd.prepend('bundle exec ') if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+            Actions.sh(cmd, error_callback: lambda { |e|
+              UI.user_error!('Error while generating localization file ' + config.destination_path)
+            })
+            files_are_the_same = FileUtils.compare_file(config.destination_path, config.destination_path + '.tmp')
+            if params[:visualize_diff] && !files_are_the_same
+              UI.message("#{config.destination_path}:")
+              puts Diffy::Diff.new(config.destination_path, config.destination_path + '.tmp', source: 'files').to_s(:color)
+            end
+            File.delete(config.destination_path + '.tmp')
+            UI.build_failure!("Localization file #{config.destination_path} differs from the source file #{config.source_path}") unless files_are_the_same
+          end
+        end
+      end
+
+      def self.description
+        'Checks the source twine file against the localization file to make sure they are in sync'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :configuration_path,
+                                       env_name: 'TWINE_CONFIGURATION_PATH',
+                                       description: 'Location to json file with configuration information',
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :visualize_diff,
+                                       env_name: "TWINE_VISUALIZE_DIFF",
+                                       description: "Display the diff of the files in case of a failure",
+                                       is_string: false,
+                                       default_value: true),
+          FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
+                                       env_name: "TWINE_USE_BUNDLE_EXEC",
+                                       description: "Use bundle exec when there is a Gemfile presented",
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.authors
+        ['Jonas Rottmann']
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.action_name
+        name.split('::').last.gsub('Action', '').fastlane_underscore
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/twine/actions/twine_generate_action.rb

@@ -0,0 +1,56 @@
+module Fastlane
+  module Actions
+    class TwineGenerateAction < Action
+      def self.run(params)
+        Actions.verify_gem!('twine')
+        Helper::TwineConfigParser.parse(params).each do |config|
+          if !File.exist?(config.source_path)
+            UI.user_error!("Source file #{config.source_path} not found")
+          else
+            UI.message(config.description)
+            cmd = Helper::TwineCommandHelper.generate_command(config.source_path, config.destination_path, config.twine_args)
+            cmd.prepend('bundle exec ') if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+            Actions.sh(cmd, error_callback: lambda { |e|
+              UI.user_error!('Error while generating localization file ' + config.destination_path)
+            })
+          end
+        end
+      end
+
+      def self.description
+        'Generates all localization files specified by the configuration file'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :configuration_path,
+                                       env_name: 'TWINE_CONFIGURATION_PATH',
+                                       description: 'Location to json file with configuration information',
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
+                                       env_name: "TWINE_USE_BUNDLE_EXEC",
+                                       description: "Use bundle exec when there is a Gemfile presented",
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.authors
+        ['Jonas Rottmann']
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.action_name
+        name.split('::').last.gsub('Action', '').fastlane_underscore
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/twine/actions/twine_validate_action.rb

@@ -0,0 +1,61 @@
+module Fastlane
+  module Actions
+    class TwineValidateAction < Action
+      def self.run(params)
+        Actions.verify_gem!('twine')
+        Helper::TwineConfigParser.parse(params).map(&:source_path).uniq.each do |source_path|
+          if !File.exist?(source_path)
+            UI.user_error!("Source file #{source_path} not found")
+          else
+            cmd = Helper::TwineCommandHelper.validate_command(source_path, params[:pedantic])
+            cmd.prepend('bundle exec ') if params[:use_bundle_exec] && shell_out_should_use_bundle_exec?
+            Actions.sh(cmd, error_callback: lambda { |result|
+              UI.build_failure!(result)
+            })
+          end
+        end
+      end
+
+      def self.description
+        'Validates all twine files mentioned in the config file'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :configuration_path,
+                                       env_name: 'TWINE_CONFIGURATION_PATH',
+                                       description: 'Location to json file with configuration information',
+                                       is_string: true,
+                                       optional: false),
+          FastlaneCore::ConfigItem.new(key: :pedantic,
+                                       env_name: 'TWINE_VALIDATE_PEDANTIC',
+                                       description: 'Run the validation using twines `pedantic` flag',
+                                       is_string: false,
+                                       optional: true,
+                                       default_value: false),
+          FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
+                                       env_name: "TWINE_USE_BUNDLE_EXEC",
+                                       description: "Use bundle exec when there is a Gemfile presented",
+                                       is_string: false,
+                                       default_value: true)
+        ]
+      end
+
+      def self.authors
+        ['Jonas Rottmann']
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.action_name
+        name.split('::').last.gsub('Action', '').fastlane_underscore
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/twine/helper/confighelper.rb

@@ -0,0 +1,58 @@
+module Fastlane
+  module Helper
+    class TwineConfig
+      attr_accessor :description, :source_path, :twine_args, :destination_path
+      def initialize(description, source_path, twine_args, destination_path)
+        @description = description
+        @source_path = source_path
+        @twine_args = twine_args
+        @destination_path = destination_path
+      end
+    end
+
+    class TwineConfigParser
+      def self.parse(params)
+        require 'json'
+        config_json = read_config_file(params)
+        UI.user_error!("Config file " + params[:configuration_path] + " not found") if config_json.nil?
+        UI.user_error!("Config file is of wrong format") unless validate_config_schema(config_json)
+        return JSON.parse(config_json).map { |c| TwineConfig.new(c['description'], c['source_path'], c['twine_args'], c['destination_path']) }
+      end
+
+      def self.read_config_file(params)
+        require 'fileutils'
+        if File.exist?(params[:configuration_path])
+          return File.read(params[:configuration_path])
+        else
+          return nil
+        end
+      end
+
+      def self.validate_config_schema(json)
+        require "json-schema"
+        schema = {
+          "type" => "object",
+          "properties" => {
+            "source_path" => {
+              "type" => "string"
+            },
+            "twine_args" => {
+              "type" => "string"
+            },
+            "destination_path" => {
+              "type" => "string"
+            },
+            "description" => {
+              "type" => "string"
+            }
+          },
+          "required" => [
+            "source_path",
+            "destination_path"
+          ]
+        }
+        return JSON::Validator.validate(schema, json, list: true)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/twine/helper/twinehelper.rb

@@ -0,0 +1,22 @@
+module Fastlane
+  module Helper
+    class TwineCommandHelper
+      def self.generate_command(path_to_twine_file, destination_path, twine_args)
+        cmd = []
+        cmd << ['twine generate-localization-file']
+        cmd << [path_to_twine_file]
+        cmd << [destination_path]
+        cmd << [twine_args]
+        return cmd.join(' ')
+      end
+
+      def self.validate_command(path_to_twine_file, pedantic)
+        cmd = []
+        cmd << ['twine validate-twine-file']
+        cmd << [path_to_twine_file]
+        cmd << [' --pedantic'] if pedantic
+        return cmd.join(' ')
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-twine
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonas Rottmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  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: json
+  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: json-schema
+  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: twine
+  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: 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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.26.1
+- !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: 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: 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
+description: 
+email: jonasrottmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/twine.rb
+- lib/fastlane/plugin/twine/actions/twine_check_action.rb
+- lib/fastlane/plugin/twine/actions/twine_generate_action.rb
+- lib/fastlane/plugin/twine/actions/twine_validate_action.rb
+- lib/fastlane/plugin/twine/helper/confighelper.rb
+- lib/fastlane/plugin/twine/helper/twinehelper.rb
+- lib/fastlane/plugin/twine/version.rb
+homepage: https://github.com/jonasrottmann/fastlane-plugin-twine
+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.6.14
+signing_key: 
+specification_version: 4
+summary: A fastlane plugin providing actions related to twine
+test_files: []