cocoapods-xcremotecache 0.0.13 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8929b95b00fd3885898cf18700dddc98fc22b6918f806dae77dd999848a26a35
-  data.tar.gz: f1e5cdb7db24fbc0c3b29e048424643621dc7c5fea985d0a29d26689e4441deb
+  metadata.gz: be0f0312463e793e7f6afccd9ae49ea0a0ed5f740adade59c780a0e6873f05a5
+  data.tar.gz: adbc9a76871be26f0fe19e53f92b67554db4f55a69d0e3d88118ed0c1b5cf9e5
 SHA512:
-  metadata.gz: d79a51a5c7c21a472caa1311e7208b25322b13a9190cbc29f06d302f1e8d445073d1d985ed5d6626b78de93f28ac08ffb2866195fcd80dc1fecdad4817a971a5
-  data.tar.gz: bfd2ef88c899f0e6be31ea12109aaffcc09e30582fee638d2b1a206d2e7460fe0249d5695223abcc9220a4425363ebd4deb49102f5df0b9e4daed32e594796cf
+  metadata.gz: 0ce9ed4249f55c838501321dadb012ea556441836fb07edaac8db88ff7ccd8510ab0debccbf1c92c98d9537680874a0416c68d33cdfad4c7620a52ca6d4608dd
+  data.tar.gz: 2cfed964db8d3078f35b48758e8be756938e77fd4b3937e7032327cf703cbcc5268cca67c96b6c82d1013cedac26cabc9efaae3ecb20da231ea812ba29da5687

data/lib/cocoapods-xcremotecache/command/hooks.rb

@@ -3,9 +3,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,15 +29,15 @@ module CocoapodsXCRemoteCacheModifier
     FAT_ARCHIVE_NAME_INFIX = 'arm64-x86_64'
     XCRC_COOCAPODS_ROOT_KEY = 'XCRC_COOCAPODS_ROOT'
 
-    # List of plugins' user properties that should not be copied to .rcinfo 
+    # List of plugins' user properties that should not be copied to .rcinfo
     CUSTOM_CONFIGURATION_KEYS = [
-      'enabled', 
+      'enabled',
       'xcrc_location',
       'exclude_targets',
       'exclude_build_configurations',
       'final_target',
-      'check_build_configuration', 
-      'check_platform', 
+      'check_build_configuration',
+      'check_platform',
       'modify_lldb_init',
       'fake_src_root',
     ]
@@ -45,19 +45,19 @@ module CocoapodsXCRemoteCacheModifier
     class XCRemoteCache
       @@configuration = nil
 
-      def self.configure(c) 
+      def self.configure(c)
         @@configuration = c
       end
 
       def self.set_configuration_default_values
         default_values = {
           'mode' => 'consumer',
-          'enabled' => true, 
+          'enabled' => true,
           'xcrc_location' => "XCRC",
           'exclude_build_configurations' => [],
           'check_build_configuration' => 'Debug',
-          'check_platform' => 'iphonesimulator', 
-          'modify_lldb_init' => true, 
+          'check_platform' => 'iphonesimulator',
+          'modify_lldb_init' => true,
           'xccc_file' => "#{BIN_DIR}/xccc",
           'remote_commit_file' => "#{BIN_DIR}/arc.rc",
           'exclude_targets' => [],
@@ -75,12 +75,12 @@ module CocoapodsXCRemoteCacheModifier
 
       def self.validate_configuration()
         required_values = [
-          'cache_addresses', 
+          'cache_addresses',
           'primary_repo',
           'check_build_configuration',
           'check_platform'
         ]
-        
+
         missing_configuration_values = required_values.select { |v| !@@configuration.key?(v) }
         unless missing_configuration_values.empty?
           throw "XCRemoteCache not fully configured. Make sure all required fields are provided. Missing fields are: #{missing_configuration_values.join(', ')}."
@@ -105,7 +105,7 @@ module CocoapodsXCRemoteCacheModifier
       end
 
       # @param target [Target] target to apply XCRemoteCache
-      # @param repo_distance [Integer] distance from the git repo root to the target's $SRCROOT 
+      # @param repo_distance [Integer] distance from the git repo root to the target's $SRCROOT
       # @param xc_location [String] path to the dir with all XCRemoteCache binaries, relative to the repo root
       # @param xc_cc_path [String] path to the XCRemoteCache clang wrapper, relative to the repo root
       # @param mode [String] mode name ('consumer', 'producer', 'producer-fast' etc.)
@@ -128,6 +128,7 @@ module CocoapodsXCRemoteCacheModifier
           config.build_settings['LIBTOOL'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xclibtool"]
           config.build_settings['LD'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xcld"]
           config.build_settings['LDPLUSPLUS'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xcldplusplus"]
+          config.build_settings['LIPO'] = ["$SRCROOT/#{srcroot_relative_xc_location}/xclipo"]
           config.build_settings['SWIFT_USE_INTEGRATED_DRIVER'] = ['NO']
 
           config.build_settings['XCREMOTE_CACHE_FAKE_SRCROOT'] = fake_src_root
@@ -156,7 +157,7 @@ module CocoapodsXCRemoteCacheModifier
           prebuild_script.dependency_file = "$(TARGET_TEMP_DIR)/prebuild.d"
 
           # Move prebuild (last element) to the position before compile sources phase (to make it real 'prebuild')
-          if !existing_prebuild_script 
+          if !existing_prebuild_script
             compile_phase_index = target.build_phases.index(target.source_build_phase)
             target.build_phases.insert(compile_phase_index, target.build_phases.delete(prebuild_script))
           end
@@ -184,7 +185,7 @@ module CocoapodsXCRemoteCacheModifier
         ]
         postbuild_script.dependency_file = "$(TARGET_TEMP_DIR)/postbuild.d"
         # Move postbuild (last element) to the position after compile sources phase (to make it real 'postbuild')
-        if !existing_postbuild_script 
+        if !existing_postbuild_script
           compile_phase_index = target.build_phases.index(target.source_build_phase)
           target.build_phases.insert(compile_phase_index + 1, target.build_phases.delete(postbuild_script))
         end
@@ -214,6 +215,7 @@ module CocoapodsXCRemoteCacheModifier
           config.build_settings.delete('CC') if config.build_settings.key?('CC')
           config.build_settings.delete('SWIFT_EXEC') if config.build_settings.key?('SWIFT_EXEC')
           config.build_settings.delete('LIBTOOL') if config.build_settings.key?('LIBTOOL')
+          config.build_settings.delete('LIPO') if config.build_settings.key?('LIPO')
           config.build_settings.delete('LD') if config.build_settings.key?('LD')
           config.build_settings.delete('LDPLUSPLUS') if config.build_settings.key?('LDPLUSPLUS')
           config.build_settings.delete('SWIFT_USE_INTEGRATED_DRIVER') if config.build_settings.key?('SWIFT_USE_INTEGRATED_DRIVER')
@@ -226,9 +228,9 @@ module CocoapodsXCRemoteCacheModifier
         end
 
         # User project is not generated from scratch (contrary to `Pods`), delete all previous XCRemoteCache phases
-        target.build_phases.delete_if {|phase| 
+        target.build_phases.delete_if {|phase|
           # Some phases (e.g. PBXSourcesBuildPhase) don't have strict name check respond_to?
-          if phase.respond_to?(:name) 
+          if phase.respond_to?(:name)
               phase.name != nil && phase.name.start_with?("[XCRC]")
           end
         }
@@ -240,9 +242,9 @@ module CocoapodsXCRemoteCacheModifier
       end
 
       def self.download_xcrc_if_needed(local_location)
-        required_binaries = ['xcld', 'xcldplusplus', 'xclibtool', 'xcpostbuild', 'xcprebuild', 'xcprepare', 'xcswiftc']
+        required_binaries = ['xcld', 'xcldplusplus', 'xclibtool', 'xclipo', 'xcpostbuild', 'xcprebuild', 'xcprepare', 'xcswiftc']
         binaries_exist = required_binaries.reduce(true) do |exists, filename|
-          file_path = File.join(local_location, filename) 
+          file_path = File.join(local_location, filename)
           exists = exists && File.exist?(file_path)
         end
 
@@ -256,13 +258,13 @@ module CocoapodsXCRemoteCacheModifier
 
         if !system("unzip #{local_package_location} -d #{local_location}")
           throw "Unzipping XCRemoteCache failed"
-        end 
+        end
       end
 
       def self.download_latest_xcrc_release(local_package_location)
         release_url = 'https://api.github.com/repos/spotify/XCRemoteCache/releases/latest'
         asset_url = nil
-        
+
         URI.open(release_url) do |f|
           assets_array = JSON.parse(f.read)['assets']
           # Pick fat archive
@@ -270,7 +272,7 @@ module CocoapodsXCRemoteCacheModifier
           asset_url = asset_array['url']
         end
 
-        if asset_url.nil? 
+        if asset_url.nil?
           throw "Downloading XCRemoteCache failed"
         end
 
@@ -283,7 +285,7 @@ module CocoapodsXCRemoteCacheModifier
 
       def self.add_cflags!(options, key, value)
         return if options.fetch('OTHER_CFLAGS',[]).include?(value)
-        options['OTHER_CFLAGS'] = remove_cflags!(options, key) << "#{key}=#{value}" 
+        options['OTHER_CFLAGS'] = remove_cflags!(options, key) << "#{key}=#{value}"
       end
 
       def self.remove_cflags!(options, key)
@@ -295,7 +297,7 @@ module CocoapodsXCRemoteCacheModifier
 
       def self.add_swiftflags!(options, key, value)
         return if options.fetch('OTHER_SWIFT_FLAGS','').include?(value)
-        options['OTHER_SWIFT_FLAGS'] = remove_swiftflags!(options, key) + " #{key} #{value}" 
+        options['OTHER_SWIFT_FLAGS'] = remove_swiftflags!(options, key) + " #{key} #{value}"
       end
 
       def self.remove_swiftflags!(options, key)
@@ -336,7 +338,7 @@ module CocoapodsXCRemoteCacheModifier
         File.open(lldbinit_path) { |file|
           while(line = file.gets) != nil
             line = line.strip
-            if line == LLDB_INIT_COMMENT 
+            if line == LLDB_INIT_COMMENT
               # skip current and next lines
               file.gets
               next
@@ -351,7 +353,7 @@ module CocoapodsXCRemoteCacheModifier
       def self.add_lldbinit_rewrite(lines_content, user_proj_directory,fake_src_root)
         all_lines = lines_content.clone
         all_lines << LLDB_INIT_COMMENT
-        all_lines << "settings set target.source-map #{fake_src_root} #{user_proj_directory}"    
+        all_lines << "settings set target.source-map #{fake_src_root} #{user_proj_directory}"
         all_lines << ""
         all_lines
       end
@@ -362,15 +364,76 @@ module CocoapodsXCRemoteCacheModifier
         File.write(LLDB_INIT_PATH, lldbinit_lines.join("\n"), mode: "w")
       end
 
-      Pod::HooksManager.register('cocoapods-xcremotecache', :post_install) do |installer_context|
+      Pod::HooksManager.register('cocoapods-xcremotecache', :pre_install) do |installer_context|
+        # The main responsibility of that hook is forcing Pods regeneration when XCRemoteCache is enabled for the first time
+        # In the post_install hook, this plugin adds extra build settings and steps to all Pods targets, but only when XCRemoteCache
+        # is enabled and all artifacts are available (i.e. xcprepare returns 0).
+        # If Pods projects/targets are cached from previous `pod install` action that didn't enable XCRemoteCache (e.g. artifacts
+        # are not available in the remote cache), these projects/targets should be invalidated to include XCRemoteCache-related
+        # build steps and build settings.
         if @@configuration.nil?
           Pod::UI.puts "[XCRC] Warning! XCRemoteCache not configured. Call xcremotecache({...}) in Podfile to enable XCRemoteCache"
           next
         end
 
+        begin
+          # `user_pod_directory`` and `user_proj_directory` in the 'postinstall' should be equal
+          user_pod_directory = File.dirname(installer_context.podfile.defined_in_file)
+          set_configuration_default_values
+
+          unless @@configuration['enabled']
+            # No need to check if enabling remote cache for the first time
+            next
+          end
+
+          validate_configuration()
+          mode = @@configuration['mode']
+          remote_commit_file = @@configuration['remote_commit_file']
+          xcrc_location = @@configuration['xcrc_location']
+          check_build_configuration = @@configuration['check_build_configuration']
+          check_platform = @@configuration['check_platform']
+
+          xcrc_location_absolute = "#{user_pod_directory}/#{xcrc_location}"
+          remote_commit_file_absolute = "#{user_pod_directory}/#{remote_commit_file}"
+
+          # Download XCRC
+          download_xcrc_if_needed(xcrc_location_absolute)
+
+          # Save .rcinfo
+          root_rcinfo = generate_rcinfo()
+          save_rcinfo(root_rcinfo, user_pod_directory)
+
+          # Create directory for xccc & arc.rc location
+          Dir.mkdir(BIN_DIR) unless File.exist?(BIN_DIR)
+
+          # Remove previous xccc & arc.rc
+          was_previously_enabled = File.exist?(remote_commit_file_absolute)
+          File.delete(remote_commit_file_absolute) if File.exist?(remote_commit_file_absolute)
+
+          prepare_result = YAML.load`#{xcrc_location_absolute}/xcprepare --configuration #{check_build_configuration} --platform #{check_platform}`
+          if !prepare_result['result'] && mode == 'consumer'
+            # Remote cache is still disabled - no need to force Pods projects/targets regeneration
+            next
+          end
+
+          # Force rebuilding all Pods project, because XCRC build steps and settings need to be added to Pods project/targets
+          # It is relevant only when 'incremental_installation' is enabled, otherwise installed_cache_path does not exist on a disk
+          installed_cache_path = installer_context.sandbox.project_installation_cache_path
+          if !was_previously_enabled && File.exist?(installed_cache_path)
+            Pod::UI.puts "[XCRC] Forces Pods project regenerations because XCRC is enabled for the first time."
+            File.delete(installed_cache_path)
+          end
+        end
+      end
+
+      Pod::HooksManager.register('cocoapods-xcremotecache', :post_install) do |installer_context|
+        if @@configuration.nil?
+          next
+        end
+
         user_project = installer_context.umbrella_targets[0].user_project
 
-        begin    
+        begin
           user_proj_directory = File.dirname(user_project.path)
           set_configuration_default_values
 
@@ -394,20 +457,12 @@ module CocoapodsXCRemoteCacheModifier
 
           xccc_location_absolute = "#{user_proj_directory}/#{xccc_location}"
           xcrc_location_absolute = "#{user_proj_directory}/#{xcrc_location}"
-          remote_commit_file_absolute = "#{user_proj_directory}/#{remote_commit_file}"
-
-          # Download XCRC
-          download_xcrc_if_needed(xcrc_location_absolute)
 
           # Save .rcinfo
           root_rcinfo = generate_rcinfo()
           save_rcinfo(root_rcinfo, user_proj_directory)
 
-          # Create directory for xccc & arc.rc location
-          Dir.mkdir(BIN_DIR) unless File.exist?(BIN_DIR)
-
-          # Remove previous xccc & arc.rc
-          File.delete(remote_commit_file_absolute) if File.exist?(remote_commit_file_absolute)
+          # Remove previous xccc
           File.delete(xccc_location_absolute) if File.exist?(xccc_location_absolute)
 
           # Prepare XCRC
@@ -441,12 +496,12 @@ module CocoapodsXCRemoteCacheModifier
             end
 
             # Manual Pods/.rcinfo generation
-            
+
             # all paths in .rcinfo are relative to the root so paths used in Pods.xcodeproj need to be aligned
             pods_path = Pathname.new(pods_proj_directory)
             root_path = Pathname.new(user_proj_directory)
             root_path_to_pods = root_path.relative_path_from(pods_path)
-            
+
             pods_rcinfo = root_rcinfo.merge({
               'remote_commit_file' => "#{root_path_to_pods}/#{remote_commit_file}",
               'xccc_file' => "#{root_path_to_pods}/#{xccc_location}"
@@ -458,6 +513,7 @@ module CocoapodsXCRemoteCacheModifier
 
           # Enabled/disable XCRemoteCache for the main (user) project
           begin
+            # TODO: Do not compile xcc again. `xcprepare` compiles it in pre-install anyway
             prepare_result = YAML.load`#{xcrc_location_absolute}/xcprepare --configuration #{check_build_configuration} --platform #{check_platform}`
             unless prepare_result['result'] || mode != 'consumer'
               # Uninstall the XCRemoteCache for the consumer mode

data/lib/cocoapods-xcremotecache/gem_version.rb

@@ -3,9 +3,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module CocoapodsXcremotecache
-  VERSION = "0.0.13"
+  VERSION = "0.0.15"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-xcremotecache
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Bartosz Polaczyk
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-06 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies: []
 description: CocoaPods plugin that enables XCRemoteCache with the project.
 email: