spinjector 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1df47e374d69631e9106daf013bd0b2e57cea05f9e99e4f2fa3fd5d019a5036c
+  data.tar.gz: 8b29d180bab07ea5b1d40c14cca971674f9b5cffba2cc918fbb2dec59074ed64
+SHA512:
+  metadata.gz: c71c9217b566eba894bc6ea1d9e6173c1a3ae6e1039ee0073e533d115861199364c7692e0d1753a1fcd655582b190c4955199668d3d7c055a940140444eba7fe
+  data.tar.gz: 464e24d8fb992378ee8fe306daca6e1241363e38771290e7004eef0eea731ff622355636db8f2025a560cd8835d8cfe9872ce98924897f49953b3a1d5e573bb7

data/lib/spinjector.rb

@@ -0,0 +1,141 @@
+# Inject script phases into your Xcode project
+#
+# @author Guillaume Berthier
+#
+
+require 'xcodeproj'
+require 'yaml'
+
+# @return [String] prefix used for all the build phase injected by this script
+# [SPI] stands for Script Phase Injector
+#
+BUILD_PHASE_PREFIX = '[SPI] '.freeze
+
+CONFIGURATION_FILE_PATH = 'Configuration/spinjector_configuration.yaml'.freeze
+
+# @param [Xcodeproj::Project] project
+#
+def remove_all_spi_script_phases(project)
+  project.targets.each do |target|
+    # Delete script phases no longer present in the target.
+    native_target_script_phases = target.shell_script_build_phases.select do |bp|
+      !bp.name.nil? && bp.name.start_with?(BUILD_PHASE_PREFIX)
+    end
+    native_target_script_phases.each do |script_phase|
+      target.build_phases.delete(script_phase)
+    end
+  end
+end
+
+# @param [Xcodeproj::Project] project
+# 
+def inject_script_phases(project)
+  configuration_file = load_yml_content(CONFIGURATION_FILE_PATH)
+  configuration_file.each do |target_name, script_paths|
+    return unless !target_name.nil?
+    script_phases = (script_paths || []).flat_map do |script_path|
+      load_yml_content(script_path)
+    end
+    target = app_target(project, target_name)
+    create_script_phases(script_phases, target)
+  end
+end
+
+# @param [String] configuration_path
+# @return [Hash] the hash in the configuration file
+#
+def load_yml_content(configuration_path)
+  if !File.exist?(configuration_path)
+    puts "Script phase #{configuration_path} unknown"
+    return {}
+  end
+  YAML.load(File.read(configuration_path)) || {}
+end
+
+# @param [Xcodeproj::Project] project
+# @param [String] target_name
+# @return [Xcodeproj::Project::Object::PBXNativeTarget] the target named by target_name
+#
+def app_target(project, target_name)
+  target = project.targets.find { |t| t.name == target_name }
+  puts "Invalid #{target_name} target." unless !target.nil?
+  return target
+end
+
+# @param [Array<Hash>] script_phases the script phases defined in configuration files
+# @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phases
+#
+def create_script_phases(script_phases, target)
+  script_phases.each do |script_phase|
+    name_with_prefix = BUILD_PHASE_PREFIX + script_phase["name"]
+    phase = target.new_shell_script_build_phase(name_with_prefix)
+    script = File.read(script_phase["script_path"])
+    phase.shell_script = script
+    phase.shell_path = script_phase["shell_path"] || '/bin/sh'
+    phase.input_paths = script_phase["input_paths"]
+    phase.output_paths = script_phase["output_paths"]
+    phase.input_file_list_paths = script_phase["input_file_list_paths"]
+    phase.output_file_list_paths = script_phase["output_file_list_paths"]
+    phase.dependency_file = script_phase["dependency_file"]
+    # At least with Xcode 10 `showEnvVarsInLog` is *NOT* set to any value even if it's checked and it only
+    # gets set to '0' if the user has explicitly disabled this.
+    if (show_env_vars_in_log = script_phase.fetch("show_env_vars_in_log", '1')) == '0'
+      phase.show_env_vars_in_log = show_env_vars_in_log
+    end
+
+    execution_position = script_phase["execution_position"] || :before_compile
+    reorder_script_phase(target, phase, execution_position)
+  end
+end
+
+# @param [Xcodeproj::Project::Object::PBXNativeTarget] target where build phases should be reordered
+# @param [Hash] script_phase to reorder
+# @param [Symbol] execution_position could be :before_compile, :after_compile, :before_headers, :after_headers
+#
+def reorder_script_phase(target, script_phase, execution_position)
+  return if execution_position == :any || execution_position.to_s.empty?
+
+  # Find the point P where to add the script phase
+  target_phase_type = case execution_position
+                      when :before_compile, :after_compile
+                        Xcodeproj::Project::Object::PBXSourcesBuildPhase
+                      when :before_headers, :after_headers
+                        Xcodeproj::Project::Object::PBXHeadersBuildPhase
+                      else
+                        raise ArgumentError, "Unknown execution position `#{execution_position}`"
+                      end
+
+  # Decide whether to add script_phase before or after point P
+  order_before = case execution_position
+                 when :before_compile, :before_headers
+                   true
+                 when :after_compile, :after_headers
+                   false
+                 else
+                   raise ArgumentError, "Unknown execution position `#{execution_position}`"
+                 end
+
+  # Get the first build phase index of P
+  target_phase_index = target.build_phases.index do |bp|
+    bp.is_a?(target_phase_type)
+  end
+  return if target_phase_index.nil?
+
+  # Get the script phase we want to reorder index
+  script_phase_index = target.build_phases.index do |bp|
+    bp.is_a?(Xcodeproj::Project::Object::PBXShellScriptBuildPhase) && !bp.name.nil? && bp.name == script_phase.name
+  end
+
+  # Move script phase to P if needed
+  if (order_before && script_phase_index > target_phase_index) ||
+    (!order_before && script_phase_index < target_phase_index)
+    target.build_phases.move_from(script_phase_index, target_phase_index)
+  end
+end
+
+project_path = Dir.glob("*.xcodeproj").first
+project = Xcodeproj::Project.open(project_path)
+remove_all_spi_script_phases(project)
+inject_script_phases(project)
+project.save()
+puts "Success"

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: spinjector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guillaume Berthier, Fabernovel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-20 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email: guillaume.berthier@fabernovel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/spinjector.rb
+homepage: https://www.fabernovel.com
+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: Inject script phases into your Xcode project
+test_files: []