fastlane-plugin-create_xcframework 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b199e1658ad27bf2635c6d0be824149ac918fb1af0882fe0961a0526a62dcf17
+  data.tar.gz: '0288aba2a3501574f4c90b0b4f242f69fb53eb89fb72d97752150ea1351fe266'
+SHA512:
+  metadata.gz: 9e1b1d76e028c043922a50b4151f8c2ef797a919e8646c7a3593db50e83048abd7188b16023ab3133e41296f3133b06d2f797ef132ad2b5df4ea3b0773ef7610
+  data.tar.gz: e4de2decf10795804c63b35966de57f4faa8725a7861ed473b4a145713616e3e33355344a958ba275b8e99cf8098c37306e6706df0215b34bc1cd824f9007dae

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Boris Bielik
+
+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,32 @@
+# create_xcframework plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-create_xcframework)
+
+## About create_xcframework
+
+Fastlane plugin that creates xcframework for given list of destinations 🚀
+
+## Requirements
+
+* Xcode 11.x or greater. Download it at the [Apple Developer - Downloads](https://developer.apple.com/downloads) or the [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835?mt=12).
+
+## Getting Started
+
+To get started with `create_xcframework`, add it to your project by running:
+
+```bash
+$ fastlane add_plugin create_xcframework
+```
+
+## Usage
+
+```ruby
+create_xcframework(
+    product_name: 'Sample',
+    scheme: 'Sample',
+    workspace: 'Sample.xcworkspace',
+    include_bitcode: true,
+    destinations: ['iOS', 'maccatalyst'],
+    xcframework_output_directory: 'Products/xcframeworks'
+)
+```

data/lib/fastlane/plugin/create_xcframework.rb

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

data/lib/fastlane/plugin/create_xcframework/actions/create_xcframework_action.rb

@@ -0,0 +1,222 @@
+module Fastlane
+  module Actions
+    module SharedValues
+      XCFRAMEWORK_OUTPUT_PATH ||= :XCFRAMEWORK_OUTPUT_PATH
+      XCFRAMEWORK_DSYM_OUTPUT_PATH ||= :XCFRAMEWORK_DSYM_OUTPUT_PATH
+      XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH ||= :XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH
+    end
+
+    require 'fastlane_core/ui/ui'
+    require 'fastlane/actions/xcodebuild'
+    require_relative '../helper/create_xcframework_helper'
+
+    class CreateXcframeworkAction < Action
+      def self.run(params)
+        if Helper.xcode_at_least?('11.0.0')
+          verify_delicate_params(params)
+          params[:destinations] = update_destinations(params)
+          params[:xcargs] = update_xcargs(params)
+
+          @xchelper = Helper::CreateXcframeworkHelper.new(params)
+
+          params[:destinations].each_with_index do |destination, framework_index|
+            params[:destination] = destination
+            params[:archive_path] = @xchelper.xcarchive_path(framework_index)
+            XcarchiveAction.run(params)
+          end
+
+          create_xcframework
+
+          copy_dSYMs(params)
+
+          copy_BCSymbolMaps(params)
+
+          clean
+
+          provide_shared_values
+        else
+          FastlaneCore::UI.important('xcframework can be produced only using Xcode 11 and above')
+        end
+      end
+
+      def self.provide_shared_values
+          Actions.lane_context[SharedValues::XCFRAMEWORK_OUTPUT_PATH] = File.expand_path(@xchelper.xcframework_path)
+          ENV[SharedValues::XCFRAMEWORK_OUTPUT_PATH.to_s] = File.expand_path(@xchelper.xcframework_path)
+          Actions.lane_context[SharedValues::XCFRAMEWORK_DSYM_OUTPUT_PATH] = File.expand_path(@xchelper.xcframework_dSYMs_path)
+          ENV[SharedValues::XCFRAMEWORK_DSYM_OUTPUT_PATH.to_s] = File.expand_path(@xchelper.xcframework_dSYMs_path)
+          Actions.lane_context[SharedValues::XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH] = File.expand_path(@xchelper.xcframework_BCSymbolMaps_path)
+          ENV[SharedValues::XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH.to_s] = File.expand_path(@xchelper.xcframework_BCSymbolMaps_path)
+      end
+
+      def self.clean
+        @xchelper.xcarchive_frameworks_path.each { |framework| FileUtils.rm_rf(framework.split('/').first) }
+      end
+
+      def self.create_xcframework
+        xcframework = @xchelper.xcframework_path
+        begin
+          FileUtils.rm_rf(xcframework) if File.exist?(xcframework)
+          framework_links = @xchelper.xcarchive_frameworks_path.map { |path| "-framework #{path}" }.join(' ')
+          Actions.sh("set -o pipefail && xcodebuild -create-xcframework #{framework_links} -output #{xcframework}")
+        rescue => err
+          UI.user_error!(err)
+        end
+      end
+
+      def self.copy_dSYMs(params)
+        dSYMs_output_dir = @xchelper.xcframework_dSYMs_path
+        FileUtils.mkdir_p(dSYMs_output_dir)
+
+        params[:destinations].each_with_index do |_, framework_index|
+          dSYM_source = "#{@xchelper.xcarchive_dSYMs_path(framework_index)}/#{@xchelper.framework}.dSYM"
+          identifier = @xchelper.library_identifier(framework_index)
+          dSYM = "#{@xchelper.framework}.#{identifier}.dSYM"
+          dSYM_destination = "#{dSYMs_output_dir}/#{dSYM}"
+
+          FastlaneCore::UI.important("▸ Copying #{dSYM} to #{dSYMs_output_dir}")
+          FileUtils.cp_r(dSYM_source, dSYM_destination)
+        end
+      end
+
+      def self.copy_BCSymbolMaps(params)
+        return unless params[:include_bitcode]
+
+        symbols_output_dir = @xchelper.xcframework_BCSymbolMaps_path
+        FileUtils.mkdir_p(symbols_output_dir)
+
+        params[:destinations].each_with_index do |_, framework_index|
+          symbols_xcarchive_dir = @xchelper.xcarchive_BCSymbolMaps_path(framework_index)
+          next unless Dir.exist?(symbols_xcarchive_dir)
+
+          FileUtils.cp_r("#{symbols_xcarchive_dir}/.", symbols_output_dir)
+          FastlaneCore::UI.important("▸ Copying #{Dir.children(symbols_xcarchive_dir)} to #{symbols_output_dir}")
+        end
+      end
+
+      def self.verify_delicate_params(params)
+        UI.user_error!("Error: :scheme is required option") if params[:scheme].nil?
+        if !params[:destinations].nil? && !params[:destinations].kind_of?(Array)
+          UI.user_error!("Error: :destinations option should be presented as Array")
+        end
+      end
+
+      def self.update_xcargs(params)
+        FastlaneCore::UI.important('Overwriting SKIP_INSTALL and BUILD_LIBRARY_FOR_DISTRIBUTION options')
+        if params[:xcargs]
+          params[:xcargs].gsub!(/SKIP_INSTALL(=|\s+)(YES|NO)/, '')
+          params[:xcargs].gsub!(/BUILD_LIBRARY_FOR_DISTRIBUTION(=|\s+)(YES|NO)/, '')
+          params[:xcargs] += ' '
+        end
+        xcargs = ['SKIP_INSTALL=NO', 'BUILD_LIBRARY_FOR_DISTRIBUTION=YES']
+
+        if params[:include_bitcode]
+          params[:xcargs].gsub!(/ENABLE_BITCODE(=|\s+)(YES|NO)/, '') if params[:xcargs]
+          xcargs << ['OTHER_CFLAGS="-fembed-bitcode"', 'BITCODE_GENERATION_MODE="bitcode"', 'ENABLE_BITCODE=YES']
+        end
+
+        params[:xcargs].to_s + xcargs.join(' ')
+      end
+
+      def self.update_destinations(params)
+        return available_destinations.values[0] if params[:destinations].nil?
+
+        requested_destinations = params[:destinations].map do |requested_de|
+          available_destinations.select { |available_de, _| available_de == requested_de }.values
+        end
+        UI.user_error!("Error: available destinations: #{available_destinations.keys}") if requested_destinations.any?(&:empty?)
+
+        requested_destinations.flatten
+      end
+
+      def self.available_destinations
+        {
+          'iOS' => ['generic/platform=iOS', 'generic/platform=iOS Simulator'],
+          'iPadOS' => ['generic/platform=iPadOS', 'generic/platform=iPadOS Simulator'],
+          'tvOS' => ['generic/platform=tvOS', 'generic/platform=tvOS Simulator'],
+          'watchOS' => ['generic/platform=watchOS', 'generic/platform=watchOS Simulator'],
+          'carPlayOS' => ['generic/platform=carPlayOS', 'generic/platform=carPlayOS Simulator'],
+          'macOS' => ['generic/platform=macOS'],
+          'maccatalyst' => ['generic/platform=macOS,variant=Mac Catalyst']
+        }
+      end
+
+      #####################################################
+      #                   Documentation                   #
+      #####################################################
+
+      def self.description
+        "Fastlane plugin that creates xcframework for given list of destinations."
+      end
+
+      def self.example_code
+        [
+          create_xcframework(
+            workspace: 'path/to/your.xcworkspace',
+            scheme: 'framework scheme',
+            include_bitcode: true,
+            destinations: ['iOS'],
+            xcframework_output_directory: 'output_directory'
+          )
+        ]
+      end
+
+      def self.output
+        [
+          ['XCFRAMEWORK_OUTPUT_PATH', 'The path to the newly generated xcframework'],
+          ['XCFRAMEWORK_DSYM_OUTPUT_PATH', 'The path to the folder with dSYMs'],
+          ['XCFRAMEWORK_BCSYMBOLMAPS_OUTPUT_PATH', 'The path to the folder with BCSymbolMaps']
+        ]
+      end
+
+      def self.authors
+        ["Boris Bielik", "Alexey Alter-Pesotskiy"]
+      end
+
+      def self.details
+        "Create xcframework plugin generates xcframework for specified destinations. The output of this action consists of the xcframework itself, dSYM and BCSymbolMaps, if bitcode is enabled."
+      end
+
+      def self.available_options
+        XcarchiveAction.available_options + [
+          FastlaneCore::ConfigItem.new(
+            key: :scheme,
+            description: "The project's scheme. Make sure it's marked as Shared",
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :include_bitcode,
+            description: "Should the xcframework include bitcode?",
+            optional: true,
+            is_string: false,
+            default_value: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :destinations,
+            description: "Use custom destinations for building the xcframework",
+            optional: true,
+            is_string: false,
+            default_value: ['iOS']
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :xcframework_output_directory,
+            description: "The directory in which the xcframework should be stored in",
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :product_name,
+            description: "The name of your module. Optional if equals to :scheme. Equivalent to CFBundleName",
+            optional: true
+          )
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/create_xcframework/helper/create_xcframework_helper.rb

@@ -0,0 +1,78 @@
+module Fastlane
+  module Helper
+    class CreateXcframeworkHelper
+      def initialize(params)
+        @params = params
+      end
+
+      def product_name
+         @params[:product_name] ||= @params[:scheme]
+      end
+
+      def xcframework
+        "#{product_name}.xcframework"
+      end
+
+      def framework
+        "#{product_name}.framework"
+      end
+
+      def xcarchive_path(framework_index)
+        "#{framework_index}_#{product_name}.xcarchive"
+      end
+
+      def xcarchive_framework_path(framework_index)
+        framework_path = "#{xcarchive_path(framework_index)}/Products/Library/Frameworks/#{framework}"
+        return framework_path if File.exist?(framework_path)
+
+        FastlaneCore::UI.user_error!("▸ PRODUCT_NAME was misdefined: `#{product_name}`. Please, provide :product_name option")
+      end
+
+      def xcarchive_frameworks_path
+        @params[:destinations].each_with_index.map { |_, i| xcarchive_framework_path(i) }
+      end
+
+      def xcarchive_dSYMs_path(framework_index)
+        "#{xcarchive_path(framework_index)}/dSYMS"
+      end
+
+      def xcframework_dSYMs_path
+        "#{output_directory}/#{product_name}.dSYMs"
+      end
+
+      def xcarchive_BCSymbolMaps_path(framework_index)
+        "#{xcarchive_path(framework_index)}/BCSymbolMaps"
+      end
+
+      def xcframework_BCSymbolMaps_path
+        "#{output_directory}/#{product_name}.BCSymbolMaps"
+      end
+
+      def xcframework_path
+        "#{output_directory}/#{xcframework}"
+      end
+
+      def output_directory
+        @params[:xcframework_output_directory] ? @params[:xcframework_output_directory] : ''
+      end
+
+      def library_identifier(framework_index)
+        framework_path = xcarchive_framework_path(framework_index)
+        framework_basename = framework_path.split('/').last
+        framework_root = framework_basename.split('.').first
+        library_identifiers = Dir.chdir(xcframework_path) do
+          Dir.glob('*').select { |f| File.directory?(f) }
+        end
+        library_identifier = library_identifiers.detect do |id|
+          FileUtils.compare_file(
+            "#{framework_path}/#{framework_root}",
+            "#{xcframework_path}/#{id}/#{framework_basename}/#{framework_root}"
+          )
+        end
+        UI.user_error!("Error: #{xcframework_path} doesn't contain #{framework_path}") if library_identifier.nil?
+
+        library_identifier
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-create_xcframework
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Boris Bielik
+- Alexey Alter-Pesotskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-27 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.144.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.144.0
+description: Fastlane plugin that creates xcframework for given list of destinations.
+email:
+- bielik.boris@gmail.com
+- a.alterpesotskiy@mail.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/create_xcframework.rb
+- lib/fastlane/plugin/create_xcframework/actions/create_xcframework_action.rb
+- lib/fastlane/plugin/create_xcframework/helper/create_xcframework_helper.rb
+- lib/fastlane/plugin/create_xcframework/version.rb
+homepage: https://github.com/bielikb/fastlane-plugin-create_xcframework
+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: Fastlane plugin that creates xcframework for given list of destinations.
+test_files: []