spinjector 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13754e7fa2165ee93579dd1d2064c9eb5e692ef67a2e2b7cd59f8a755b14a21b
-  data.tar.gz: 21e6d78086b4ed644eaf628c1548fc6570f198d2ad3aaf224d51da41e4d065ba
+  metadata.gz: 770afb3d2da618abf0c2f12be01a8638d6190c5b21085d8ee6cbc89a05159e50
+  data.tar.gz: 6d371c30b8a6fa185a7775bf5b63e34f76269b25beb63cd738d0a0627ca48237
 SHA512:
-  metadata.gz: f44c4b944a3a1859d5e2d9396bcc5a4ca4820d4d1b1f9633f1657b5b4f4430a60ab26bdedfa725bccba05c695a109d9e2d8e254c247a45b4d651639a88733463
-  data.tar.gz: 45a06ffa00166fa35326be22ac1156f1930d42e5737906e6c0f3d9a34c904ff3d5490bf3ab3e5f3403d18e9ac6bfd2f9e9f589b6a62e1b85dae45e6bdb709952
+  metadata.gz: f627ae1db194c15105e591e3d7f1c43000df84b72b47701e3c587b6962f6ba25978ad6b52763be3f11d1550eebc454bbd5b858adfa112557f1e1f4bbc8583d6e
+  data.tar.gz: 884f0b622a6f4bc9c3d421200e0651970f961831fc4cada4dc87c3e1814ed0cc2d8f85a7ccf4b3adc293f6a57b48a2428241452d4edce84202301aee0a54fc11

data/.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.6.6", "2.7.3", "3.0.1"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Build and test with Rake
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake test

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+`spinjector` adheres to [Semantic Versioning](http://semver.org/).
+
+## [NEXT] - Date
+
+### Created
+
+### Fixed
+
+### Removed
+
+## [1.0.0] - 2022-12-19
+
+### Created
+
+- Make the script idempotent. Successive calls to configure don’t modify the pbxproj file anymore
+- Added tests
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ad_localize.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    spinjector (0.0.6)
+      optparse (~> 0.1)
+      xcodeproj (~> 1.21)
+      yaml (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (3.0.5)
+      rexml
+    ansi (1.5.0)
+    atomos (0.1.3)
+    builder (3.2.4)
+    claide (1.1.0)
+    colored2 (3.1.2)
+    minitest (5.15.0)
+    minitest-hooks (1.5.0)
+      minitest (> 5.3)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    nanaimo (0.3.0)
+    optparse (0.2.0)
+    rake (12.3.3)
+    rexml (3.2.5)
+    ruby-progressbar (1.11.0)
+    xcodeproj (1.21.0)
+      CFPropertyList (>= 2.3.3, < 4.0)
+      atomos (~> 0.1.3)
+      claide (>= 1.0.2, < 2.0)
+      colored2 (~> 3.1)
+      nanaimo (~> 0.3.0)
+      rexml (~> 3.2.4)
+    yaml (0.2.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  bundler (>= 1.12.0, < 3.0.0)
+  minitest (~> 5.11)
+  minitest-hooks (~> 1.5)
+  minitest-reporters (~> 1.3)
+  rake (~> 12.3)
+  spinjector!
+
+BUNDLED WITH
+   2.2.26

data/Makefile

@@ -0,0 +1,11 @@
+build:
+	gem build spinjector.gemspec
+
+install: clean build
+	gem install spinjector-*.gem
+
+publish: clean build
+	gem push spinjector-*.gem
+
+clean:
+	rm -f spinjector-*.gem

data/README.md

@@ -1,4 +1,5 @@
 # spinjector
+
 Inject Script phase in your Xcode project easily.
 
 # How to install
@@ -8,7 +9,9 @@ gem install spinjector
 ```
 
 # How to use
+
 ## Global configuration file
+
 First, create a YAML configuration file under `./Configuration/spinjector_configuration.yaml` (default path where spinjector looks for a configuration file).
 
 ```
@@ -31,7 +34,9 @@ targets:
 ```
 
 ## Script configuration file
+
 Then, for each script you want to inject in your Xcode project:
+
 - You can use `scripts` section in the global configuration file to define your script directly (eg. `foo`)...
 
 - ...Or create a script configuration file (eg. `helloworld.yaml`)
@@ -60,16 +65,19 @@ output_file_list_paths:              # optional.
 
 dependency_file:                     # optional.
 
-execution_position:                  # optional. [:before-compile | :after-compile | :before-headers | :after-headers].
+execution_position:                  # optional. [:before_compile | :after_compile | :before_headers | :after_headers | :after_all].
 ```
 
-- If you use the `script_path option, create the script file
+- If you use the `script_path option`, create the script file
+
 ```
 echo Hello World
 ```
 
 ## Execution
+
 Finally, inject script phases
+
 ```
 spinjector [-c] <path-to-your-global-configuration-file>
 ```
@@ -77,3 +85,20 @@ spinjector [-c] <path-to-your-global-configuration-file>
 Enjoy your build phases
 ![Image of your build phases](/Examples/Images/build_phases.png)
 ![Image of hello world 2 build phase](/Examples/Images/hello_world_explicit.png)
+
+## How to contribute
+
+1. After all your changes are reviewed and merged
+2. Create a `release` branch
+3. Update the version in field `s.version` from file `spinjector.gemspec`
+4. Execute `make publish`
+
+You may need to configure your account at step `4.` if you've never pushed any gem. You can find all the informations you need on [the official documentation](https://guides.rubygems.org/make-your-own-gem/#your-first-gem).
+
+## Tests
+
+To run the tests, simply run:
+
+```sh
+rake test
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/lib/spinjector/entity/configuration.rb

@@ -0,0 +1,9 @@
+
+class Configuration
+
+    attr_reader :targets
+
+    def initialize(targets)
+        @targets = targets || []
+    end
+end

data/lib/spinjector/entity/script.rb

@@ -0,0 +1,47 @@
+
+class Script
+
+    attr_reader :name, :source_code, :shell_path, :input_paths, :output_paths, :input_file_list_paths, :output_file_list_paths, :dependency_file, :execution_position, :show_env_vars_in_log
+
+    def initialize(
+        name,
+        source_code,
+        shell_path,
+        input_paths,
+        output_paths,
+        input_file_list_paths,
+        output_file_list_paths,
+        dependency_file,
+        execution_position,
+        show_env_vars_in_log
+    )
+        @name = name
+        @source_code = source_code
+        @shell_path = shell_path
+        @input_paths = input_paths
+        @output_paths = output_paths
+        @input_file_list_paths = input_file_list_paths
+        @output_file_list_paths = output_file_list_paths
+        @dependency_file = dependency_file
+        @execution_position = execution_position
+        @show_env_vars_in_log = show_env_vars_in_log
+        verify()
+    end
+
+    def verify
+        verify_execution_position()
+    end
+
+    def verify_execution_position
+        case execution_position
+        when :before_compile, :before_headers
+            true
+        when :after_compile, :after_headers
+            false
+        when :after_all,
+            false
+        else
+            raise ArgumentError, "Unknown execution position `#{execution_position}`"
+        end
+    end
+end

data/lib/spinjector/entity/target.rb

@@ -0,0 +1,14 @@
+
+class Target
+
+    attr_reader :name, :scripts
+
+    def initialize(name, scripts)
+        @name = name
+        @scripts = scripts || []
+    end
+
+    def scripts_names
+        @scripts.map { |script| script.name }
+    end
+end

data/lib/spinjector/logger.rb

@@ -0,0 +1,16 @@
+class Logger
+  def log(content)
+    raise "Abstract class, should be overriden"
+  end
+end
+
+class EmptyLogger < Logger
+  def log(content)
+  end
+end
+
+class VerboseLogger < Logger
+  def log(content)
+    puts content
+  end
+end

data/lib/spinjector/project_service.rb

@@ -0,0 +1,191 @@
+require 'xcodeproj'
+require_relative 'entity/configuration'
+require_relative 'entity/script'
+require_relative 'entity/target'
+
+# @return [String] prefix used for all the build phase injected by this script
+# [SPI] stands for Script Phase Injector
+#
+BUILD_PHASE_PREFIX = '[SPI] '.freeze
+
+class ProjectService
+
+    # @param [Xcodeproj::Project] project
+    #
+    def initialize(project, logger)
+        @project = project
+        @logger = logger
+    end
+
+    # @param [Configuration] configuration containing all scripts to add in each target
+    #
+    def update_scripts_in_targets(configuration)
+        @project.targets.each do |target|
+            @insertion_offset_after_compile = 0
+            @insertion_offset_after_headers = 0
+            target_configuration = configuration.targets.find { |conf_target| conf_target.name == target.name }
+            if target_configuration == nil
+                @logger.log "No Spinjector managed build phases in target #{target}"
+                remove_all_scripts(target)
+                next
+            end
+            @logger.log "Configurating target #{target}"
+            scripts_to_apply = target_configuration.scripts_names.map { |name| BUILD_PHASE_PREFIX + name }.to_set
+            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|
+                if scripts_to_apply.include?(script_phase.name)
+                    # Update existing script phase with new values
+                    script_configuration = target_configuration.scripts.find { |script|
+                        BUILD_PHASE_PREFIX + script.name == script_phase.name
+                    }
+                    update_script_in_target(script_phase, script_configuration, target)
+                    scripts_to_apply.delete(script_phase.name)
+                elsif
+                    target.build_phases.delete(script_phase)
+                    # Remove now defunct script phase
+                end
+            end
+            # We may miss scripts that are yet to be added to the pbxproj target, this is fixed in the following method
+            reorder_and_add_missing_script_phases_of(target, target_configuration)
+        end
+    end
+
+    private
+
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to remove the script phases
+    # @return [<Xcodeproj::Project::Object::PBXShellScriptBuildPhase>] the newly created build phase
+    #
+    def spinjector_managed_phases(target)
+        spinjector_managed_phases = target.shell_script_build_phases.select do |bp|
+            !bp.name.nil? && bp.name.start_with?(BUILD_PHASE_PREFIX)
+        end
+        return spinjector_managed_phases
+    end
+
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to remove the script phases
+    #
+    def remove_all_scripts(target)
+        # Delete all the spinjector managed scripts from the selected target
+        spinjector_managed_phases(target).each do |script_phase|
+            target.build_phases.delete(script_phase)
+        end
+    end
+
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phases
+    # @param [Target] the target configuration describing the scripts to be added
+    #
+    def reorder_and_add_missing_script_phases_of(target, target_configuration)
+        target_configuration.scripts.each do |script|
+            current_phase = spinjector_managed_phases(target).find { |phase| phase.name == BUILD_PHASE_PREFIX + script.name }
+            if current_phase == nil && should_add_script_in_target(script, target)
+                current_phase = add_script_in_target(script, target)
+            end
+            execution_position = script.execution_position
+            reorder_script_phase(target, current_phase, execution_position)
+        end
+    end
+
+    # Checks If the target contains a build phase associated to the script execution position
+    # For instance, it checks if the Headers build phase is present when the script has a :after_headers position
+    # @param [Script] script the script phase defined in configuration files to add to the target
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phases
+    # @return [Boolean] If the script should be added to the target
+    #
+    def should_add_script_in_target(script, target)
+        return true if script.execution_position === :after_all
+
+        target_phase_type = case script.execution_position
+            when :before_compile, :after_compile
+                Xcodeproj::Project::Object::PBXSourcesBuildPhase
+            when :before_headers, :after_headers
+                Xcodeproj::Project::Object::PBXHeadersBuildPhase
+            else
+                nil
+            end
+
+        found_phase_in_target = target.build_phases.find { |bp| bp.is_a?(target_phase_type) }
+        @logger.log("Can't find build phase associated to execution position #{script.execution_position} in target #{target.name}") if found_phase_in_target.nil?
+        return !found_phase_in_target.nil?
+    end
+
+    # @param [Script] script the script phase defined in configuration files to add to the target
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phases
+    # @return [Xcodeproj::Project::Object::PBXShellScriptBuildPhase] the newly created build phase
+    #
+    def add_script_in_target(script, target)
+        name_with_prefix = BUILD_PHASE_PREFIX + script.name
+        phase = target.new_shell_script_build_phase(name_with_prefix)
+        update_script_in_target(phase, script, target)
+        return phase
+    end
+
+    # @param [Xcodeproj::Project::Object::PBXShellScriptBuildPhase] phase to update with the values from the script
+    # @param [Script] script the script phase defined in configuration files to add to the target
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phase
+    #
+    def update_script_in_target(existing_phase, script_configuration, target)
+        existing_phase.shell_script = script_configuration.source_code
+        existing_phase.shell_path = script_configuration.shell_path
+        existing_phase.input_paths = script_configuration.input_paths
+        existing_phase.output_paths = script_configuration.output_paths
+        existing_phase.input_file_list_paths = script_configuration.input_file_list_paths
+        existing_phase.output_file_list_paths = script_configuration.output_file_list_paths
+        existing_phase.dependency_file = script_configuration.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 script_configuration.show_env_vars_in_log == '0'
+            existing_phase.show_env_vars_in_log = script_configuration.show_env_vars_in_log
+        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? || script_phase.nil?
+        if execution_position == :after_all
+            target.build_phases.move(script_phase, target.build_phases.count - 1)
+            return
+        end
+
+        offset = -1
+        # Find the point P where to add the script phase
+        target_phase_type = case execution_position
+                            when :before_compile
+                                Xcodeproj::Project::Object::PBXSourcesBuildPhase
+                            when :after_compile
+                                offset = @insertion_offset_after_compile
+                                @insertion_offset_after_compile += 1
+                                Xcodeproj::Project::Object::PBXSourcesBuildPhase
+                            when :before_headers
+                                Xcodeproj::Project::Object::PBXHeadersBuildPhase
+                            when :after_headers
+                                offset = @insertion_offset_after_headers
+                                @insertion_offset_after_headers += 1
+                                Xcodeproj::Project::Object::PBXHeadersBuildPhase
+                            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
+        if target_phase_index < script_phase_index
+          offset += 1
+        end
+
+        target.build_phases.move_from(script_phase_index, target_phase_index + offset)
+    end
+
+end
+

data/lib/spinjector/runner.rb

@@ -0,0 +1,32 @@
+# Inject script phases into your Xcode project
+#
+# @author Guillaume Berthier
+#
+
+require 'xcodeproj'
+require_relative './project_service'
+require_relative './yaml_parser'
+
+class Runner
+
+  attr_reader :project
+
+  def initialize(project_path, configuration_file_path, logger)
+    raise "[Error] No xcodeproj found at #{project_path}" unless File.exist?(project_path)
+    @project = Xcodeproj::Project.open(project_path)
+    @configuration_file_path = configuration_file_path
+    @logger = logger
+  end
+
+  def run
+    configuration = YAMLParser.new(@configuration_file_path, @logger).configuration
+
+    project_service = ProjectService.new(project, @logger)
+    project_service.update_scripts_in_targets(configuration)
+
+    @project.save()
+    @logger.log "Success."
+  end
+
+end
+

data/lib/spinjector/script_mapper.rb

@@ -0,0 +1,36 @@
+require_relative 'entity/script'
+
+class ScriptMapper
+
+    def initialize(script_hash)
+        @script_hash = script_hash
+        verify_syntax
+    end
+
+    def map
+        script_code = @script_hash["script"] || load_script(@script_hash["script_path"])
+        Script.new(
+            @script_hash["name"],
+            script_code,
+            @script_hash["shell_path"] || '/bin/sh',
+            @script_hash["input_paths"] || [],
+            @script_hash["output_paths"] || [],
+            @script_hash["input_file_list_paths"] || [],
+            @script_hash["output_file_list_paths"] || [],
+            @script_hash["dependency_file"],
+            @script_hash["execution_position"] || :before_compile,
+            @script_hash["show_env_vars_in_log"]
+        )
+    end
+
+    def verify_syntax
+        raise "[Error] Invalid script description #{@script_hash}" unless @script_hash.is_a?(Hash)
+        raise "[Error] Script must have a name and an associated script" unless @script_hash.has_key?("name") && @script_hash.has_key?("script") || @script_hash.has_key?("script_path")
+        raise "[Error] Invalid name in script #{@script_hash}" unless !@script_hash["name"].nil?
+    end
+
+    def load_script(path)
+        raise "[Error] File #{path} does not exist" unless !path.nil? && File.exist?(path)
+        File.read(path)
+    end
+end

data/lib/spinjector/yaml_parser.rb

@@ -0,0 +1,83 @@
+require 'yaml'
+require 'set'
+require_relative 'entity/configuration'
+require_relative 'entity/script'
+require_relative 'entity/target'
+require_relative 'script_mapper'
+
+class YAMLParser
+
+    # The configuration to use in order to add scripts in your project
+    #
+    attr_reader :configuration
+
+    def initialize(yaml_file_path, logger)
+        @logger = logger
+        @inlined_scripts_ids = Set[]
+        @inlined_scripts_names = Set[]
+        @other_scripts_paths = Set[]
+        @other_scripts_names = Set[]
+        @configuration_description = load_yml_content(yaml_file_path)
+        @configuration = Configuration.new(targets)
+    end
+
+    private
+
+    def targets
+        if @configuration_description["targets"].nil?
+            @logger.log "[Warning] There is no target in your configuration file."
+            return
+        end
+        @configuration_description["targets"].map do |target_name, script_entries|
+            if script_entries.nil?
+                @logger.log "[Warning] There is no scripts in your configuration file under target #{target_name}"
+                return
+            end
+            scripts = script_entries.map do |entry|
+                get_script(entry)
+            end
+            Target.new(target_name, scripts)
+        end
+    end
+
+    def get_script(entry)
+        script =
+            if !@configuration_description["scripts"].nil? && !@configuration_description["scripts"][entry].nil?
+                get_script_by_name(entry)
+            elsif File.exist?(entry)
+                get_script_by_path(entry)
+            else
+                raise "[Error] Script #{entry} does not exist" unless !script.nil?
+            end
+    end
+
+    def get_script_by_name(name)
+        @inlined_scripts_ids.add(name)
+        script_description = @configuration_description["scripts"][name]
+        script = ScriptMapper.new(script_description).map()
+        @inlined_scripts_names.add(script.name)
+        error = "[Error] Multiple scripts with same name \'#{script.name}\'"
+        raise error unless @inlined_scripts_ids.count == @inlined_scripts_names.count
+        raise error unless !@inlined_scripts_names.intersect?(@other_scripts_names)
+        return script
+    end
+
+    def get_script_by_path(path)
+        @other_scripts_paths.add(path)
+        script_description = load_yml_content(path)
+        script = ScriptMapper.new(script_description).map()
+        @other_scripts_names.add(script.name)
+        error = "[Error] Multiple scripts with same name \'#{script.name}\'"
+        raise error unless @other_scripts_paths.count == @other_scripts_names.count
+        raise error unless !@inlined_scripts_names.intersect?(@other_scripts_names)
+        return script
+    end
+
+    # @param [String] configuration_path
+    # @return [Hash] the hash in the configuration file
+    #
+    def load_yml_content(configuration_path)
+        raise "[Error] YAML file #{configuration_path} not found." unless File.exist?(configuration_path)
+        YAML.load(File.read(configuration_path)) || {}
+    end
+end

data/lib/spinjector.rb

@@ -5,12 +5,8 @@
 
 require 'optparse'
 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
+require_relative 'spinjector/runner'
+require_relative 'spinjector/logger'
 
 CONFIGURATION_FILE_PATH = 'Configuration/spinjector_configuration.yaml'.freeze
 
@@ -18,165 +14,17 @@ options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: spinjector [options]"
 
-
   opts.on("-cName", "--configuration-path=Name", "Inject scripts using configuration file at Name location. Default is ./#{CONFIGURATION_FILE_PATH}") do |config_path|
     options[:configuration_path] = config_path
   end
 end.parse!
 
-# @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_path)
-  configuration_file = load_yml_content(configuration_file_path)
-  # Check if there are scripts in the global configuration file
-  implicit_scripts = configuration_file["scripts"] || []
-  configuration_file["targets"].each do |target_name, script_paths|
-    script_phases = (script_paths || []).flat_map do |script_path|
-      if !implicit_scripts.empty? and !implicit_scripts[script_path].nil?
-        # Target uses script from the global configuration file
-        script = implicit_scripts[script_path]
-      else
-        # Target uses script from a dedicated configuration file
-        script = load_yml_content(script_path)
-      end
-      raise "[Error] Could not find script #{script_path}" unless !script.nil?
-      script
-    end
-    warn "[Warning] No script phases found for #{target_name} target. You can add them in your configuration file at #{configuration_file_path}" unless !script_phases.empty?
-    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)
-  raise "[Error] YAML file #{configuration_path} not found." unless File.exist?(configuration_path)
-  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 }
-  raise "[Error] 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)
-    shell_script = get_script(script_phase)
-    phase.shell_script = shell_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 [Hash] script_phase the script phase defined in configuration files
-# @return [String] script to add in script phase
-#
-# If script is in a dedicated file, find the URL under <script_path>.
-# Otherwise, it may be written directly in the configuration file, find it under <script>.
-#
-def get_script(script_phase)
-  if !script_phase["script"].nil? and !script_phase["script_path"].nil?
-    raise "[Error] Script phase #{script_phase["name"]} contains 2 script sources. Please use one of :script_path or :script option"
-  end
-  if !script_phase["script_path"].nil?
-    raise "[Error] File #{script_phase["script_path"]} does not exist" unless File.exist?(script_phase["script_path"])
-    File.read(script_phase["script_path"])
-  elsif !script_phase["script"].nil?
-    script_phase["script"]
-  else
-    warn "[Warning] Script phase #{script_phase["name"]} contains no script"
-    return ""
-  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)
-raise "[Error] No xcodeproj found" unless !project.nil?
-remove_all_spi_script_phases(project)
-configuration_file_path = options[:configuration_path] || CONFIGURATION_FILE_PATH
-inject_script_phases(project, configuration_file_path)
-project.save()
-puts "Success."
+raise "[Error] No xcodeproj found in #{Dir.pwd}" if project_path.nil?
+
+runner = Runner.new(
+  project_path,
+  options[:configuration_path] || CONFIGURATION_FILE_PATH,
+  VerboseLogger.new
+)
+runner.run

data/spinjector.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'spinjector'
-  s.version     = '0.0.5'
+  s.version     = '1.0.0'
   s.executables << 'spinjector'
   s.summary     = "Inject script phases into your Xcode project"
   s.description = ""
@@ -8,10 +8,16 @@ Gem::Specification.new do |s|
   s.email       = 'guillaume.berthier@fabernovel.com'
   # use `git ls-files -coz -x *.gem` for development
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  s.homepage    = 'https://github.com/guillaumeberthier/spinjector'
+  s.homepage    = 'https://github.com/faberNovel/spinjector'
   s.license     = 'MIT'
 
   s.add_dependency 'optparse', '~> 0.1'
   s.add_dependency 'xcodeproj', '~> 1.21'
   s.add_dependency 'yaml', '~> 0.2'
-end
+
+  s.add_development_dependency 'bundler', '>= 1.12.0', '< 3.0.0'
+  s.add_development_dependency 'rake', '~> 12.3'
+  s.add_development_dependency 'minitest', '~> 5.11'
+  s.add_development_dependency 'minitest-reporters', '~> 1.3'
+  s.add_development_dependency 'minitest-hooks', '~> 1.5'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinjector
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Guillaume Berthier, Fabernovel
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -52,6 +52,82 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: ''
 email: guillaume.berthier@fabernovel.com
 executables:
@@ -59,9 +135,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- Examples/Configuration/hello_world_input
-- Examples/Configuration/hello_world_output
+- CHANGELOG.md
 - Examples/Configuration/helloworld.yaml
 - Examples/Configuration/helloworld_explicit_script.yaml
 - Examples/Configuration/helloworld_short.yaml
@@ -69,15 +145,27 @@ files:
 - Examples/Images/build_phases.png
 - Examples/Images/hello_world_explicit.png
 - Examples/Scripts/helloworld.sh
+- Gemfile
+- Gemfile.lock
+- Makefile
 - README.md
+- Rakefile
 - bin/spinjector
 - lib/spinjector.rb
+- lib/spinjector/entity/configuration.rb
+- lib/spinjector/entity/script.rb
+- lib/spinjector/entity/target.rb
+- lib/spinjector/logger.rb
+- lib/spinjector/project_service.rb
+- lib/spinjector/runner.rb
+- lib/spinjector/script_mapper.rb
+- lib/spinjector/yaml_parser.rb
 - spinjector.gemspec
-homepage: https://github.com/guillaumeberthier/spinjector
+homepage: https://github.com/faberNovel/spinjector
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,8 +180,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Inject script phases into your Xcode project
 test_files: []