spinjector 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13754e7fa2165ee93579dd1d2064c9eb5e692ef67a2e2b7cd59f8a755b14a21b
-  data.tar.gz: 21e6d78086b4ed644eaf628c1548fc6570f198d2ad3aaf224d51da41e4d065ba
+  metadata.gz: c73f5e26de7982019f85fa697d310590caf4750b75981e7bbcef7023a27e6c8c
+  data.tar.gz: 81933229a9142400ad0ae4ca2c9494064a384a73d9d88d091fda299749ddda5c
 SHA512:
-  metadata.gz: f44c4b944a3a1859d5e2d9396bcc5a4ca4820d4d1b1f9633f1657b5b4f4430a60ab26bdedfa725bccba05c695a109d9e2d8e254c247a45b4d651639a88733463
-  data.tar.gz: 45a06ffa00166fa35326be22ac1156f1930d42e5737906e6c0f3d9a34c904ff3d5490bf3ab3e5f3403d18e9ac6bfd2f9e9f589b6a62e1b85dae45e6bdb709952
+  metadata.gz: 2e766f518c4d1420ffaa5a28b4eedc69a9d4e94836bf0f5574cbc257efcb332f5797b77597681f04ee9824016498069a66eaebd3548f584a24befc4f5576fbc9
+  data.tar.gz: 61a8228e352c8c3f06770fcde3c5aeef9ffa3068b16986beb4cef7c91fa5e16e5c57bdd8ff2d566638fb914fe254c400da0f99f2f03ea4075aea74408bb022bc

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

@@ -63,7 +63,7 @@ dependency_file:                     # optional.
 execution_position:                  # optional. [:before-compile | :after-compile | :before-headers | :after-headers].
 ```
 
-- 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
 ```
@@ -77,3 +77,12 @@ 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).

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,45 @@
+
+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
+        else
+            raise ArgumentError, "Unknown execution position `#{execution_position}`"
+        end
+    end
+end

data/lib/spinjector/entity/target.rb

@@ -0,0 +1,10 @@
+
+class Target
+
+    attr_reader :name, :scripts
+
+    def initialize(name, scripts)
+        @name = name
+        @scripts = scripts || []
+    end
+end

data/lib/spinjector/project_service.rb

@@ -0,0 +1,120 @@
+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)
+        @project = project
+    end
+
+    # Remove all script phases prefixed by BUILD_PHASE_PREFIX from project
+    #
+    def remove_all_scripts
+        @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 [Configuration] configuration containing all scripts to add in each target
+    #
+    def add_scripts_in_targets(configuration)
+        configuration.targets.each do |target|
+            xcode_target = app_target(target.name)
+            add_scripts_in_target(target.scripts, xcode_target)
+        end
+    end
+
+    private
+
+    # @param [String] target_name
+    # @return [Xcodeproj::Project::Object::PBXNativeTarget] the target named by target_name
+    #
+    def app_target(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<Script>] scripts the script phases defined in configuration files
+    # @param [Xcodeproj::Project::Object::PBXNativeTarget] target to add the script phases
+    #
+    def add_scripts_in_target(scripts, target)
+        scripts.each do |script|
+            name_with_prefix = BUILD_PHASE_PREFIX + script.name
+            phase = target.new_shell_script_build_phase(name_with_prefix)
+            phase.shell_script = script.source_code
+            phase.shell_path = script.shell_path
+            phase.input_paths = script.input_paths
+            phase.output_paths = script.output_paths
+            phase.input_file_list_paths = script.input_file_list_paths
+            phase.output_file_list_paths = script.output_file_list_paths
+            phase.dependency_file = script.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.show_env_vars_in_log == '0'
+                phase.show_env_vars_in_log = script.show_env_vars_in_log
+            end
+            execution_position = script.execution_position
+            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
+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,65 @@
+require 'yaml'
+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)
+        @configuration_description = load_yml_content(yaml_file_path)
+        @configuration = Configuration.new(targets)
+    end
+
+    private
+
+    def targets
+        if @configuration_description["targets"].nil?
+            puts "[Warning] There is no target in your configuration file."
+            return
+        end
+        @configuration_description["targets"].map do |target_name, script_entries|
+            if script_entries.nil?
+                puts "[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)
+        script_description = @configuration_description["scripts"][name]
+        ScriptMapper.new(script_description).map()
+    end
+
+    def get_script_by_path(path)
+        script_description = load_yml_content(path)
+        ScriptMapper.new(script_description).map()
+    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/project_service'
+require_relative 'spinjector/yaml_parser'
 
 CONFIGURATION_FILE_PATH = 'Configuration/spinjector_configuration.yaml'.freeze
 
@@ -18,165 +14,21 @@ 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)
+configuration = YAMLParser.new(configuration_file_path).configuration
+
+project_service = ProjectService.new(project)
+project_service.remove_all_scripts()
+project_service.add_scripts_in_targets(configuration)
+
 project.save()
 puts "Success."

data/spinjector.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'spinjector'
-  s.version     = '0.0.5'
+  s.version     = '0.0.6'
   s.executables << 'spinjector'
   s.summary     = "Inject script phases into your Xcode project"
   s.description = ""
@@ -8,7 +8,7 @@ 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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinjector
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Guillaume Berthier, Fabernovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-21 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optparse
@@ -60,8 +60,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- Examples/Configuration/hello_world_input
-- Examples/Configuration/hello_world_output
 - Examples/Configuration/helloworld.yaml
 - Examples/Configuration/helloworld_explicit_script.yaml
 - Examples/Configuration/helloworld_short.yaml
@@ -69,11 +67,18 @@ files:
 - Examples/Images/build_phases.png
 - Examples/Images/hello_world_explicit.png
 - Examples/Scripts/helloworld.sh
+- Makefile
 - README.md
 - bin/spinjector
 - lib/spinjector.rb
+- lib/spinjector/entity/configuration.rb
+- lib/spinjector/entity/script.rb
+- lib/spinjector/entity/target.rb
+- lib/spinjector/project_service.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: {}