fastlane-plugin-common_fastfile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1079e557a1e5165c798bef4f0a4ed9d8a6a98c6c2b1b38607f325f5cfebacd9e
+  data.tar.gz: cecddc6aa04d0c10e1d8b95ad2c3b6c1e089238eaf38def245b9c7ec27e8192f
+SHA512:
+  metadata.gz: a9ce116de15c3d70df76d15333ad215a3e9d4f910937d4782f990d2338f26f399072fa8687ed520dd2a77e713df634af58eb7059bc359baec99ae1848842134b
+  data.tar.gz: 83d1266b4cb96feb33ce5e104ed22979d59bee4051f8c531b411fb033f2b4b53b136b379f0886201a4b4e5a8847b3f7536dd0a8748e7fde80884d63df2294171

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pawel Szymanski <pawel.szymanski@grandparade.co.uk>
+
+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,58 @@
+# common_fastfile plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-common_fastfile)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-common_fastfile`, add it to your project by running:
+
+```bash
+fastlane add_plugin common_fastfile
+```
+
+## About common_fastfile
+
+Get's the requested file, saves it into ./fastlane/imports and return a path .
+
+**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
+
+In order to be able to test it first you need to have a Gitlab repository with some example of common Fastfiles, so the you can refer to them later.
+
+```ruby
+import common_gitlab_fastfile(file: 'path/to/a/fastfile', version: 'develop', repository: 'someGitlabGroup/subgroup/repository')
+```
+
+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`.
+
+
+
+## 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/common_fastfile.rb

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

data/lib/fastlane/plugin/common_fastfile/actions/common_gitlab_fastfile_action.rb

@@ -0,0 +1,78 @@
+require 'fastlane/action'
+require_relative '../helper/common_fastfile_helper'
+
+module Fastlane
+  module Actions
+    class CommonGitlabFastfileAction < Action
+      def self.run(params)
+        require 'fileutils'
+        require 'gitlab'
+
+        begin
+          if not file = params[:file] then raise StandardError.new "Cannot import due to missing 'file' value. Please provide the path to your file from ios-lib-scripts." end
+          if not version = params[:version] then raise StandardError.new "Cannot import due to missing 'version' value. Please provide the [branch | tag | commit] for '#{file}'" end
+          if not repository = params[:repository] || ENV['GITLAB_FASTFILES_REPOSITORY'] then raise StandardError.new "Cannot import due to missing 'repository' value. Please provide the Gitlab project ID or name or set 'GITLAB_FASTFILES_REPOSITORY' variable" end
+        
+          import_filename = "#{version.gsub(/[^0-9a-zA-Z-]/i, '_')}/#{file}"
+          import_relative_path = "#{FastlaneCore::FastlaneFolder.path}imports/#{import_filename}"
+          import_path = File.expand_path(import_relative_path)
+          puts "Requested by: #{Thread.current.backtrace.find { |e| e.end_with?("in `parsing_binding'") }.gsub(/:\d*:in `parsing_binding'/i, '')}"
+          puts " Downloading: #{file} [#{version}] from #{repository}"
+          content = Gitlab.repo_file_contents(repository, file, version) 
+          FileUtils.mkdir_p File.dirname(import_path)
+          File.write(import_path, content)
+          puts "    Saved in: #{import_relative_path}"          
+          import_path
+        rescue StandardError => e
+          UI.important "Please check:
+- if you have 'GITLAB_API_ENDPOINT' set, usually 'https://gitlab.com/api/v4'
+- if you have 'GITLAB_API_PRIVATE_TOKEN' set, usually you can use 'https://gitlab.com/-/profile/personal_access_tokens' to set up one
+- if you have 'GITLAB_FASTFILES_REPOSITORY' set with a Gitlab project ID or name, e.g. 'group/subgroup/repository'
+Consider adding them to your .bash_profile, .zshrc or other shell configuration file"
+          UI.user_error!("[common_fastfile] Download failure with:\n#{e}")
+        end
+      end
+
+      def self.description
+        "Gets the requested file, saves it into ./fastlane/imports and return the path"
+      end
+
+      def self.authors
+        ["Pawel Szymanski"]
+      end
+
+      def self.return_value
+        "The path to a file within ./fastlane/imports with requested common fastfile"
+      end
+
+      def self.details
+        # Optional:
+        "Gets the requested file, saves it into ./fastlane/imports and return the path"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :file,
+                               description: "Path to the file within repository",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :version,
+                               description: "Version of the file [branch, tag, commit]",
+                                  optional: false,
+                                 is_string: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :repository,
+                               description: "Gitlab repository ID, e.g. 26259886 or group/subgroup/repository",
+                                  optional: true,
+                                 is_string: true,
+                                      type: String),
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/common_fastfile/helper/common_fastfile_helper.rb

@@ -0,0 +1,16 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class CommonFastfileHelper
+      # class methods that you define here become available in your action
+      # as `Helper::CommonFastfileHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the common_fastfile plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-common_fastfile
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pawel Szymanski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab
+  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.191.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.191.0
+- !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: 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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.12.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+description: 
+email: pawel.szymanski@grandparade.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/common_fastfile.rb
+- lib/fastlane/plugin/common_fastfile/actions/common_gitlab_fastfile_action.rb
+- lib/fastlane/plugin/common_fastfile/helper/common_fastfile_helper.rb
+- lib/fastlane/plugin/common_fastfile/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+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: Gets the requested file, saves it into ./fastlane/imports and return the
+  path
+test_files: []