fastlane-plugin-debug_file 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32d867b8c00c73dbc4c6c11bee6d330574e993acb58fea78ed93e1a84f32eb45
+  data.tar.gz: d344092f370bdaca14b4aff2fd9061ece8f18d2a375807d19a0bc59cb9c5ebe3
+SHA512:
+  metadata.gz: d7969e5a6c16ea58f817a404c7f34fed8dd470f3f1ad12ad4b5373f593845d6962c8aed097f3ce3f45d145b918d34a8793e74b14c60ba26898ac6e5efff77557
+  data.tar.gz: 9c3230369026fa755edefcc26325a92c7815662986f1be9198a9acde734c2e06c7d5ccb59a6cdf7df581fa393fe1f935c7908b68a98656a7ea2fa4918df6b011

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 icyleaf <icyleaf.cn@gmail.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,61 @@
+# debug_file plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-debug_file)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-debug_file`, add it to your project by running:
+
+```bash
+fastlane add_plugin debug_file
+```
+
+## About debug_file
+
+debug_file plugin includes two actions:
+
+- `dsym`: Find iOS/macOS app dSYM and compress automatically
+- `proguard`: Find Android proguard and compress automatically
+
+### dsym
+
+Why another `dsym` action? fastlane was built-in simlar action named [dsym_zip](https://docs.fastlane.tools/actions/dsym_zip/) which it only accepts spetical path, our `dsym` it counld find dSYM
+file automatically, even accpets multiple dSYM to compress.
+
+### proguard
+
+If Android app set `minifyEnabled = true`, it called proguard, `proguard` could find `mapping.txt`,
+`R.txt` and `AndroidManifest.xml` automatically.
+
+## 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`.
+
+## 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/debug_file/actions/dsym_action.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'fastlane/action'
+require_relative '../helper/debug_file_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      DF_DSYM_ZIP_PATH = :DF_DSYM_ZIP_PATH
+    end
+
+    class DsymAction < Action
+      ARCHIVE_PATH = File.expand_path('~/Library/Developer/Xcode/Archives')
+      OUTPUT_PATH = '.'
+
+      def self.run(params)
+        archive_path = File.expand_path(params[:archive_path])
+        scheme = params[:scheme]
+        overwrite = params[:overwrite]
+
+        app_dsym_filename = "#{scheme}.app.dsym"
+
+        output_path = params[:output_path]
+        output_file = File.join(output_path, "#{app_dsym_filename}.zip")
+
+        Helper::DebugFileHelper.determine_output_file(output_file, overwrite)
+
+        archive_dsym_path = last_created_dsym(scheme, archive_path)
+        if archive_dsym_path && !Dir.exist?(archive_dsym_path)
+          UI.user_error! "Not matched any archive with scheme: #{scheme}"
+        end
+
+        UI.success "Selected dSYM archive path: #{File.basename(File.dirname(archive_dsym_path))}"
+
+        extra_dsym = params[:extra_dsym] || []
+        dsym_files = [app_dsym_filename].concat(extra_dsym).uniq
+        dsym_files.each_with_index do |filename, i|
+          path = File.join(archive_dsym_path, filename)
+          if Dir.exist?(path)
+            dsym_files[i] = path
+          else
+            dsym_files.delete_at(i)
+          end
+        end
+        UI.success "Prepare #{dsym_files.size} dSYM file(s) compressing"
+        Helper::DebugFileHelper.compress(dsym_files, output_file)
+
+        UI.success "Compressed proguard files: #{output_file}"
+        Helper::DebugFileHelper.store_shard_value SharedValues::DF_DSYM_ZIP_PATH, output_file
+      end
+
+      def self.last_created_dsym(scheme, archive_path)
+        info_path = File.join(archive_path, '**', '*.xcarchive', 'Info.plist')
+        matched_paths = []
+        Dir.glob(info_path) do |path|
+          name = get_plist_value(path, 'Name')
+          if scheme == name
+            matched_paths << path
+          end
+        end
+
+        return if matched_paths.empty?
+
+        UI.verbose "Found #{matched_paths.size} matched dSYM archive(s)"
+        last_created_path = matched_paths.size == 1 ? matched_paths.first : matched_paths.max_by { |p| File.stat(p).mtime }
+        File.join(File.dirname(last_created_path), 'dSYMs')
+      end
+      private_class_method :last_created_dsym
+
+      def self.get_plist_value(file, key)
+        plist = read_plist(file)
+        plist[key.to_s]
+      end
+      private_class_method :get_plist_value
+
+      def self.read_plist(file)
+        require 'plist'
+        Plist.parse_xml(file)
+      end
+      private_class_method :read_plist
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Find and generate iOS/MacOS dSYM file(s) to zip file'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :archive_path,
+                                       env_name: 'DF_DSYM_ARCHIVE_PATH',
+                                       description: 'The archive path of xcode',
+                                       type: String,
+                                       default_value: Actions.lane_context[SharedValues::XCODEBUILD_ARCHIVE] || ARCHIVE_PATH,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :scheme,
+                                       env_name: 'DF_DSYM_SCHEME',
+                                       description: 'The scheme name of app',
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :extra_dsym,
+                                       env_name: 'DF_DSYM_EXTRA_DSYM',
+                                       description: 'A set file name of dSYM',
+                                       optional: true,
+                                       default_value: [],
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       env_name: 'DF_DSYM_OUTPUT_PATH',
+                                       description: "The output path of compressed dSYM file",
+                                       default_value: OUTPUT_PATH,
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :overwrite,
+                                       env_name: 'DF_DSYM_OVERWRITE',
+                                       description: "Overwrite output compressed file if it existed",
+                                       default_value: false,
+                                       type: Boolean)
+        ]
+      end
+
+      def self.example_code
+        [
+          'dsym',
+          'dsym(
+            archive_path: "~/Library/Developer/Xcode/Archives",
+            overwrite: true,
+            extra_dsym: [
+              "AFNetworking.framework.dSYM",
+              "Masonry.framework.dSYM"
+            ]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.return_value
+        String
+      end
+
+      def self.output
+        [
+          ['DF_DSYM_ZIP_PATH', 'the path of compressed proguard file']
+        ]
+      end
+
+      def self.authors
+        ['icyleaf']
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/debug_file/actions/proguard_action.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'fastlane/action'
+require_relative '../helper/debug_file_helper'
+
+module Fastlane
+  module Actions
+    module SharedValues
+      DF_PROGUARD_ZIP_PATH = :DF_PROGUARD_ZIP_PATH
+    end
+
+    class ProguardAction < Action
+      MATCHES_FILES = {
+        mapping: {
+          name: 'mapping.txt',
+          path: 'build/outputs/mapping'
+        },
+        manifest: {
+          name: 'AndroidManifest.xml',
+          path: 'build/intermediates/manifests/full'
+        },
+        symbol: {
+          name: 'R.txt',
+          path: 'build/intermediates/symbols'
+        }
+      }
+
+      APP_PATH = 'app'
+      RELEASE_TYPE = 'release'
+      OUTPUT_PATH = '.'
+
+      def self.run(params)
+        app_path = params[:app_path]
+        build_type = params[:build_type]
+        flavor = params[:flavor]
+        overwrite = params[:overwrite]
+        extra_files = params[:extra_files]
+        output_path = params[:output_path]
+        output_file = File.join(output_path, zip_filename(build_type, flavor))
+
+        Helper::DebugFileHelper.determine_output_file(output_file, overwrite)
+
+        src_files = find_proguard_files(app_path, build_type, flavor, extra_files)
+        UI.user_error! 'No found any proguard file' if src_files.empty?
+
+        UI.success "Found #{src_files.size} debug information files"
+        Helper::DebugFileHelper.compress(src_files, output_file)
+
+        UI.success "Compressed proguard files: #{output_file}"
+        Helper::DebugFileHelper.store_shard_value SharedValues::DF_PROGUARD_ZIP_PATH, output_file
+      end
+
+      def self.find_proguard_files(app_path, build_type, flavor, extra_files)
+        src_files = []
+        MATCHES_FILES.each do |_, file|
+          path, existed = find_file(app_path, file, build_type, flavor)
+          UI.verbose("File path `#{path}` exist: #{existed}")
+          next unless existed
+
+          src_files << path
+        end
+
+        extra_files.each do |file|
+          existed = File.exist?(file)
+          UI.verbose("File path `#{file}` exist: #{existed}")
+          next unless existed
+
+          src_files << file
+        end
+
+        src_files.uniq
+      end
+
+      def self.find_file(app_path, file, build_type, flavor)
+        flavor ||= ''
+        path = File.join(app_path, file[:path], flavor, build_type, file[:name])
+        [path, File.exist?(path)]
+      end
+      private_class_method :find_file
+
+      def self.zip_filename(build_type, flavor = nil)
+        flavor = flavor.to_s.empty? ? '' : "#{flavor}-"
+        "#{flavor}#{build_type}-proguard.zip"
+      end
+      private_class_method :zip_filename
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        'Find and generate Android proguard file(s) to zip file'
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :app_path,
+                                       env_name: 'DF_PROGUARD_PATH',
+                                       description: 'The path of app project',
+                                       default_value: APP_PATH,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :build_type,
+                                       env_name: 'DF_PROGUARD_BUILD_TYPE',
+                                       description: 'The build type of app',
+                                       default_value: RELEASE_TYPE,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :flavor,
+                                       env_name: 'DF_PROGUARD_FLAVOR',
+                                       description: 'The product flavor of app',
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :extra_files,
+                                       env_name: 'DF_PROGUARD_EXTRA_FILES',
+                                       description: 'The extra files of app project',
+                                       optional: true,
+                                       default_value: [],
+                                       type: Array),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       env_name: 'DF_PROGUARD_OUTPUT_PATH',
+                                       description: "The output path of compressed proguard file",
+                                       default_value: OUTPUT_PATH,
+                                       optional: true,
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :overwrite,
+                                       env_name: 'DF_PROGUARD_OVERWRITE',
+                                       description: "Overwrite output compressed file if it existed",
+                                       default_value: false,
+                                       type: Boolean)
+        ]
+      end
+
+      def self.example_code
+        [
+          'proguard',
+          'proguard(
+            build_type: "release",
+            flavor: "full"
+          )',
+          'proguard(
+            extra_files: [
+              "app/src/main/AndroidManifest.xml"
+            ]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
+      def self.return_value
+        String
+      end
+
+      def self.output
+        [
+          ['DF_PROGUARD_ZIP_PATH', 'the path of compressed proguard file']
+        ]
+      end
+
+      def self.authors
+        ['icyleaf']
+      end
+
+      def self.is_supported?(platform)
+        platform == :android
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/debug_file/helper/debug_file_helper.rb

@@ -0,0 +1,36 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class DebugFileHelper
+      def self.compress(src_files, desc_file)
+        require 'zip'
+
+        output_path = File.dirname(desc_file)
+        FileUtils.mkdir_p output_path unless Dir.exist?(output_path)
+        ::Zip::File.open(desc_file, ::Zip::File::CREATE) do |zipfile|
+          src_files.each do |file|
+            zipfile.add File.basename(file), file
+          end
+        end
+      end
+
+      def self.determine_output_file(output_file, overwrite)
+        if File.exist?(output_file)
+          if overwrite
+            FileUtils.rm_f output_file
+          else
+            UI.user_error! "Compressed file was existed: #{output_file}"
+          end
+        end
+      end
+
+      def self.store_shard_value(key, value)
+        Actions.lane_context[key] = value
+        ENV[key.to_s] = value
+      end
+    end
+  end
+end

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

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

data/lib/fastlane/plugin/debug_file.rb

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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-debug_file
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- icyleaf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-03 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.139.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.139.0
+description: 
+email: icyleaf.cn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/debug_file.rb
+- lib/fastlane/plugin/debug_file/actions/dsym_action.rb
+- lib/fastlane/plugin/debug_file/actions/proguard_action.rb
+- lib/fastlane/plugin/debug_file/helper/debug_file_helper.rb
+- lib/fastlane/plugin/debug_file/version.rb
+homepage: https://github.com/icyleaf/fastlane-plugin-debug_file
+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.6
+signing_key: 
+specification_version: 4
+summary: Compress iOS/macApp dSYM or Android Proguard(mapping/R/AndroidManifest) to
+  zip file
+test_files: []