xcframework_converter 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed8ad6ac521bd6f26cae4e1ed130e7faf4c861c9367d10a591f65ace5e0d0180
-  data.tar.gz: 3a214bc46c53d8413a4082783d24d9fc4ebecdcf9bc695edd3a1908561eb952c
+  metadata.gz: 105e63e07d147cd791c478f9351e73e1f71bbd861160b5a1391d99c7c0affc9d
+  data.tar.gz: cf2e6a358aeb0a7018d06a2bf48382ab01d768eb870589da0abddab7044278e3
 SHA512:
-  metadata.gz: 23717de292d647163e52c8c2055878b45c7e79dceb01e000bcb29830edb9c26c44e928c1dea8df1ec33f1f224fc7f9bbeb79ca876cd4a14d80cafe0eddfad87e
-  data.tar.gz: d00b1bf35a52d2d42bba03f84ce88f35e19edab370465acb08d20bb886ced4e534bf5385e0f036aa3ee2ff5b341f612c080873a200142badc79b517fe2493cf4
+  metadata.gz: fe005277c05790de2d906188fbc0ab3818b9dd27980bf68bdeb2e56ec3ef2f0184fc61224ddeb32c29689ad316f3179eb51dd4a3345bf423bdd7cd5d75569697
+  data.tar.gz: '0805b456eebbfc655bd5991c001b241b29bf614f154615be67be7124d3bc1fc95532a0612647ac1d56e05d10373c97c7f6e14489adb68481e24e6b5a03ff89c6'

data/lib/xcframework_converter/arm_patcher.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'cocoapods'
+require 'cocoapods/xcode/xcframework'
+require 'fileutils'
+require 'xcodeproj'
+
+# rubocop:disable Metrics/AbcSize
+
+module XCFrameworkConverter
+  # Patches a binary (static or dynamic), turning an arm64-device into an arm64-simualtor.
+  # For more info:
+  # static libs: https://bogo.wtf/arm64-to-sim.html
+  # dylibs: https://bogo.wtf/arm64-to-sim-dylibs.html
+  module ArmPatcher
+    class << self
+      def patch_arm_binary(slice)
+        require 'macho'
+
+        case slice.build_type.linkage
+        when :dynamic
+          patch_arm_binary_dynamic(slice)
+        when :static
+          patch_arm_binary_static(slice)
+        end
+
+        slice.path.glob('**/arm64*.swiftinterface').each do |interface_file|
+          `sed -i '' -E 's/target arm64-apple-ios([0-9.]+) /target arm64-apple-ios\\1-simulator /g' "#{interface_file}"`
+        end
+      end
+
+      private
+
+      def patch_arm_binary_dynamic(slice)
+        extracted_path = slice.path.join('arm64.dylib')
+        `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
+
+        file = MachO::MachOFile.new(extracted_path)
+        sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string
+        `xcrun vtool -arch arm64 -set-build-version 7 #{sdk_version} #{sdk_version} -replace -output \"#{extracted_path}\" \"#{extracted_path}\"`
+        `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
+        extracted_path.rmtree
+      end
+
+      def arm2sim_path
+        Pathname.new(__FILE__).dirname.join('../arm2sim.swift')
+      end
+
+      def patch_arm_binary_static(slice)
+        extracted_path = slice.path.join('arm64.a')
+        `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
+        extracted_path_dir = slice.path.join('arm64-objects')
+        extracted_path_dir.mkdir
+        `cd \"#{extracted_path_dir}\" ; ar x \"#{extracted_path}\"`
+        Dir[extracted_path_dir.join('*.o')].each do |object_file|
+          file = MachO::MachOFile.new(object_file)
+          sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string.to_i
+          `xcrun swift \"#{arm2sim_path}\" \"#{object_file}\" \"#{sdk_version}\" \"#{sdk_version}\"`
+        end
+        `cd \"#{extracted_path_dir}\" ; ar crv \"#{extracted_path}\" *.o`
+
+        `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
+        extracted_path_dir.rmtree
+        extracted_path.rmtree
+      end
+
+      public
+
+      def cleanup_unused_archs(slice)
+        supported_archs = slice.supported_archs
+        unsupported_archs = `xcrun lipo \"#{slice.binary_path}\" -archs`.split - supported_archs
+        unsupported_archs.each do |arch|
+          `xcrun lipo \"#{slice.binary_path}\" -remove \"#{arch}\" -output \"#{slice.binary_path}\"`
+        end
+      end
+    end
+  end
+end

data/lib/xcframework_converter/creation.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'arm_patcher'
+require_relative 'xcframework_ext'
+
+require 'cocoapods'
+require 'cocoapods/xcode/xcframework'
+require 'fileutils'
+require 'xcodeproj'
+
+# rubocop:disable Metrics/AbcSize
+
+# Converts a framework (static or dynamic) to an XCFramework, adding an arm64 simulator patch.
+# For more info:
+# static libs: https://bogo.wtf/arm64-to-sim.html
+# dylibs: https://bogo.wtf/arm64-to-sim-dylibs.html
+module XCFrameworkConverter
+  class << self
+    def plist_template_path
+      Pathname.new(__FILE__).dirname.join('../xcframework_template.plist')
+    end
+
+    def convert_framework_to_xcframework(path)
+      plist = Xcodeproj::Plist.read_from_path(plist_template_path)
+      xcframework_path = Pathname.new(path).sub_ext('.xcframework')
+      xcframework_path.mkdir
+      plist['AvailableLibraries'].each do |slice|
+        slice_path = xcframework_path.join(slice['LibraryIdentifier'])
+        slice_path.mkdir
+        slice['LibraryPath'] = File.basename(path)
+        FileUtils.cp_r(path, slice_path)
+      end
+      Xcodeproj::Plist.write_to_path(plist, xcframework_path.join('Info.plist'))
+      FileUtils.rm_rf(path)
+      final_framework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
+      final_framework.slices.each do |slice|
+        ArmPatcher.patch_arm_binary(slice) if slice.platform == :ios && slice.platform_variant == :simulator
+        ArmPatcher.cleanup_unused_archs(slice)
+      end
+    end
+  end
+end

data/lib/xcframework_converter/patching.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'arm_patcher'
+require_relative 'xcframework_ext'
+
+require 'cocoapods'
+require 'cocoapods/xcode/xcframework'
+require 'fileutils'
+require 'xcodeproj'
+
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+# Converts a framework (static or dynamic) to an XCFramework, adding an arm64 simulator patch.
+# For more info:
+# static libs: https://bogo.wtf/arm64-to-sim.html
+# dylibs: https://bogo.wtf/arm64-to-sim-dylibs.html
+module XCFrameworkConverter
+  class << self
+    def patch_xcframework(xcframework_path)
+      xcframework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
+
+      return nil if xcframework.slices.any? do |slice|
+        slice.platform == :ios &&
+        slice.platform_variant == :simulator &&
+        slice.supported_archs.include?('arm64')
+      end
+
+      original_arm_slice_identifier = xcframework.slices.find do |slice|
+        slice.platform == :ios && slice.supported_archs.include?('arm64')
+      end.identifier
+
+      patched_arm_slice_identifier = 'ios-arm64-simulator'
+
+      STDERR.puts "Will patch #{xcframework_path}: #{original_arm_slice_identifier} -> #{patched_arm_slice_identifier}"
+
+      plist = xcframework.plist
+      slice_plist_to_add = plist['AvailableLibraries'].find { |s| s['LibraryIdentifier'] == original_arm_slice_identifier }.dup
+      slice_plist_to_add['LibraryIdentifier'] = patched_arm_slice_identifier
+      slice_plist_to_add['SupportedArchitectures'] = ['arm64']
+      slice_plist_to_add['SupportedPlatformVariant'] = 'simulator'
+      plist['AvailableLibraries'] << slice_plist_to_add
+
+      FileUtils.rm_rf(xcframework_path.join(patched_arm_slice_identifier))
+      FileUtils.cp_r(xcframework_path.join(original_arm_slice_identifier), xcframework_path.join(patched_arm_slice_identifier))
+
+      Xcodeproj::Plist.write_to_path(plist, xcframework_path.join('Info.plist'))
+
+      xcframework = Pod::Xcode::XCFramework.open_xcframework(xcframework_path)
+
+      slice = xcframework.slices.find { |s| s.identifier == patched_arm_slice_identifier }
+
+      ArmPatcher.patch_arm_binary(slice)
+      ArmPatcher.cleanup_unused_archs(slice)
+
+      xcframework_path
+    end
+  end
+end

data/lib/xcframework_converter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module XCFrameworkConverter
-  VERSION = '0.1.3'
+  VERSION = '0.2.0'
 end

data/lib/xcframework_converter/xcframework_ext.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'cocoapods'
+require 'cocoapods/xcode/xcframework'
+
+module Pod
+  module Xcode
+    # open XCFramework
+    class XCFramework
+      def self.open_xcframework(xcframework_path)
+        if instance_method(:initialize).arity == 2
+          new(File.basename(xcframework_path), xcframework_path.realpath)
+        else
+          new(xcframework_path.realpath)
+        end
+      end
+    end
+  end
+end

data/lib/xcframework_converter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'xcframework_converter/creation'
+require_relative 'xcframework_converter/patching'
 require_relative 'xcframework_converter/version'
 
 require 'cocoapods'
@@ -7,7 +9,7 @@ require 'cocoapods/xcode/xcframework'
 require 'fileutils'
 require 'xcodeproj'
 
-# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/ModuleLength, Metrics/PerceivedComplexity
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
 # Converts a framework (static or dynamic) to XCFrameworks, adding an arm64 simulator patch.
 # For more info:
@@ -19,6 +21,16 @@ module XCFrameworkConverter
       installer.analysis_result.specifications.each do |spec|
         next if spec.source && spec.local?
 
+        pod_path = installer.sandbox.pod_dir(Pod::Specification.root_name(spec.name))
+
+        xcframeworks_to_patch = spec.available_platforms.map do |platform|
+          consumer = Pod::Specification::Consumer.new(spec, platform)
+          consumer.vendored_frameworks.select { |f| File.extname(f) == '.xcframework' }
+                  .map { |f| pod_path.join(f) }
+        end.flatten.uniq
+
+        patch_xcframeworks_if_needed(spec, xcframeworks_to_patch)
+
         frameworks_to_convert = spec.available_platforms.map do |platform|
           consumer = Pod::Specification::Consumer.new(spec, platform)
           before_rename = consumer.vendored_frameworks.select { |f| File.extname(f) == '.framework' }
@@ -27,112 +39,36 @@ module XCFrameworkConverter
           after_rename = before_rename.map { |f| Pathname.new(f).sub_ext('.xcframework').to_s }
           proxy = Pod::Specification::DSL::PlatformProxy.new(spec, platform.symbolic_name)
           proxy.vendored_frameworks = consumer.vendored_frameworks - before_rename + after_rename
-          before_rename
+          before_rename.map { |f| pod_path.join(f) }
         end.flatten.uniq
 
-        next if frameworks_to_convert.empty?
-
-        pod_path = installer.sandbox.pod_dir(Pod::Specification.root_name(spec.name))
-        convert_xcframeworks_if_present(frameworks_to_convert.map { |f| pod_path.join(f) })
-
-        # some pods put these as a way to NOT support arm64 sim
-        # may stop working if a pod decides to put these in a platform proxy
-        spec.attributes_hash['pod_target_xcconfig']&.delete('EXCLUDED_ARCHS[sdk=iphonesimulator*]')
-        spec.attributes_hash['user_target_xcconfig']&.delete('EXCLUDED_ARCHS[sdk=iphonesimulator*]')
+        convert_xcframeworks_if_present(spec, frameworks_to_convert)
       end
     end
 
-    def convert_xcframeworks_if_present(frameworks_to_convert)
+    def convert_xcframeworks_if_present(spec, frameworks_to_convert)
       frameworks_to_convert.each do |path|
         convert_framework_to_xcframework(path) if Dir.exist?(path)
       end
+      remove_troublesome_xcconfig_items(spec) unless frameworks_to_convert.empty?
     end
 
-    def plist_template_path
-      Pathname.new(__FILE__).dirname.join('xcframework_template.plist')
-    end
-
-    def convert_framework_to_xcframework(path)
-      plist = Xcodeproj::Plist.read_from_path(plist_template_path)
-      xcframework_path = Pathname.new(path).sub_ext('.xcframework')
-      xcframework_path.mkdir
-      plist['AvailableLibraries'].each do |slice|
-        slice_path = xcframework_path.join(slice['LibraryIdentifier'])
-        slice_path.mkdir
-        slice['LibraryPath'] = File.basename(path)
-        FileUtils.cp_r(path, slice_path)
-      end
-      Xcodeproj::Plist.write_to_path(plist, xcframework_path.join('Info.plist'))
-      FileUtils.rm_rf(path)
-      final_framework = open_xcframework(xcframework_path)
-      final_framework.slices.each do |slice|
-        patch_arm_binary(slice) if slice.platform == :ios && slice.platform_variant == :simulator
-        cleanup_unused_archs(slice)
-      end
-    end
+    def patch_xcframeworks_if_needed(spec, xcframeworks)
+      patched = xcframeworks.map do |path|
+        next nil unless Dir.exist?(path)
 
-    def open_xcframework(xcframework_path)
-      if Pod::Xcode::XCFramework.instance_method(:initialize).arity == 2
-        Pod::Xcode::XCFramework.new(File.basename(xcframework_path), xcframework_path.realpath)
-      else
-        Pod::Xcode::XCFramework.new(xcframework_path.realpath)
-      end
+        patch_xcframework(path)
+      end.compact
+      remove_troublesome_xcconfig_items(spec) unless patched.empty?
     end
 
-    def patch_arm_binary(slice)
-      require 'macho'
-
-      case slice.build_type.linkage
-      when :dynamic
-        patch_arm_binary_dynamic(slice)
-      when :static
-        patch_arm_binary_static(slice)
-      end
-
-      slice.path.glob('**/arm64*.swiftinterface').each do |interface_file|
-        `sed -i '' -E 's/target arm64-apple-ios([0-9.]+) /target arm64-apple-ios\\1-simulator /g' "#{interface_file}"`
-      end
-    end
-
-    def patch_arm_binary_dynamic(slice)
-      extracted_path = slice.path.join('arm64.dylib')
-      `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
-
-      file = MachO::MachOFile.new(extracted_path)
-      sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string
-      `xcrun vtool -arch arm64 -set-build-version 7 #{sdk_version} #{sdk_version} -replace -output \"#{extracted_path}\" \"#{extracted_path}\"`
-      `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
-      extracted_path.rmtree
-    end
-
-    def arm2sim_path
-      Pathname.new(__FILE__).dirname.join('arm2sim.swift')
-    end
-
-    def patch_arm_binary_static(slice)
-      extracted_path = slice.path.join('arm64.a')
-      `xcrun lipo \"#{slice.binary_path}\" -thin arm64 -output \"#{extracted_path}\"`
-      extracted_path_dir = slice.path.join('arm64-objects')
-      extracted_path_dir.mkdir
-      `cd \"#{extracted_path_dir}\" ; ar x \"#{extracted_path}\"`
-      Dir[extracted_path_dir.join('*.o')].each do |object_file|
-        file = MachO::MachOFile.new(object_file)
-        sdk_version = file[:LC_VERSION_MIN_IPHONEOS].first.version_string.to_i
-        `xcrun swift \"#{arm2sim_path}\" \"#{object_file}\" \"#{sdk_version}\" \"#{sdk_version}\"`
-      end
-      `cd \"#{extracted_path_dir}\" ; ar crv \"#{extracted_path}\" *.o`
-
-      `xcrun lipo \"#{slice.binary_path}\" -replace arm64 \"#{extracted_path}\" -output \"#{slice.binary_path}\"`
-      extracted_path_dir.rmtree
-      extracted_path.rmtree
-    end
-
-    def cleanup_unused_archs(slice)
-      supported_archs = slice.supported_archs
-      unsupported_archs = `xcrun lipo \"#{slice.binary_path}\" -archs`.split - supported_archs
-      unsupported_archs.each do |arch|
-        `xcrun lipo \"#{slice.binary_path}\" -remove \"#{arch}\" -output \"#{slice.binary_path}\"`
-      end
+    def remove_troublesome_xcconfig_items(spec)
+      # some pods put these as a way to NOT support arm64 sim
+      # may stop working if a pod decides to put these in a platform proxy
+      spec.attributes_hash['pod_target_xcconfig']&.delete('EXCLUDED_ARCHS[sdk=iphonesimulator*]')
+      spec.attributes_hash['user_target_xcconfig']&.delete('EXCLUDED_ARCHS[sdk=iphonesimulator*]')
+      spec.attributes_hash['pod_target_xcconfig']&.delete('VALID_ARCHS[sdk=iphonesimulator*]')
+      spec.attributes_hash['user_target_xcconfig']&.delete('VALID_ARCHS[sdk=iphonesimulator*]')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcframework_converter
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Igor Makarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -63,7 +63,11 @@ files:
 - bin/xcfconvert
 - lib/arm2sim.swift
 - lib/xcframework_converter.rb
+- lib/xcframework_converter/arm_patcher.rb
+- lib/xcframework_converter/creation.rb
+- lib/xcframework_converter/patching.rb
 - lib/xcframework_converter/version.rb
+- lib/xcframework_converter/xcframework_ext.rb
 - lib/xcframework_template.plist
 homepage: https://github.com/igor-makarov/XCFrameworkConverter
 licenses: