spinjector 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df47e374d69631e9106daf013bd0b2e57cea05f9e99e4f2fa3fd5d019a5036c
-  data.tar.gz: 8b29d180bab07ea5b1d40c14cca971674f9b5cffba2cc918fbb2dec59074ed64
+  metadata.gz: 13754e7fa2165ee93579dd1d2064c9eb5e692ef67a2e2b7cd59f8a755b14a21b
+  data.tar.gz: 21e6d78086b4ed644eaf628c1548fc6570f198d2ad3aaf224d51da41e4d065ba
 SHA512:
-  metadata.gz: c71c9217b566eba894bc6ea1d9e6173c1a3ae6e1039ee0073e533d115861199364c7692e0d1753a1fcd655582b190c4955199668d3d7c055a940140444eba7fe
-  data.tar.gz: 464e24d8fb992378ee8fe306daca6e1241363e38771290e7004eef0eea731ff622355636db8f2025a560cd8835d8cfe9872ce98924897f49953b3a1d5e573bb7
+  metadata.gz: f44c4b944a3a1859d5e2d9396bcc5a4ca4820d4d1b1f9633f1657b5b4f4430a60ab26bdedfa725bccba05c695a109d9e2d8e254c247a45b4d651639a88733463
+  data.tar.gz: 45a06ffa00166fa35326be22ac1156f1930d42e5737906e6c0f3d9a34c904ff3d5490bf3ab3e5f3403d18e9ac6bfd2f9e9f589b6a62e1b85dae45e6bdb709952

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/Examples/Configuration/helloworld.yaml

@@ -0,0 +1,8 @@
+name: "HelloWorld"
+script_path: "Scripts/helloworld.sh"
+input_paths:
+output_paths:
+input_file_list_paths:
+output_file_list_paths:
+dependency_file:
+execution_position: :before_compile

data/Examples/Configuration/helloworld_explicit_script.yaml

@@ -0,0 +1,9 @@
+name: "HelloWorldExplicit"
+script: |
+  echo Hello
+  echo World
+input_paths:
+  - "Configuration/hello_world_input"
+output_paths:
+  - "Configuration/hello_world_output"
+execution_position: :before_compile

data/Examples/Configuration/helloworld_short.yaml

@@ -0,0 +1,3 @@
+name: "HelloWorldShort"
+script_path: "Scripts/helloworld.sh"
+execution_position: :after_compile

data/Examples/Configuration/spinjector_configuration.yaml

@@ -0,0 +1,18 @@
+scripts:
+  foo:
+    name: "Foo"
+    script_path: "Scripts/helloworld.sh"
+  bar:
+    name: "Bar"
+    script: |
+      echo Bar
+    execution_position: :after_compile
+
+targets:
+  TargetNameA:
+    - foo
+    - "helloworld.yaml"
+    - bar
+    - "helloworld_explicit_script.yaml"
+  TargetNameB:
+    - "helloworld_short.yaml"

data/Examples/Scripts/helloworld.sh

@@ -0,0 +1 @@
+echo "Hello World"

data/README.md

@@ -0,0 +1,79 @@
+# spinjector
+Inject Script phase in your Xcode project easily.
+
+# How to install
+
+```
+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).
+
+```
+scripts:
+  foo:
+    name: "Foo"
+    script: |
+      echo Foo
+    execution_position: :after_compile
+
+targets:
+  TargetNameA:
+    - foo
+    - "helloworld.yaml"
+    - "helloworld_explicit_script.yaml"
+  TargetNameB:
+    - "helloworld_short.yaml"
+    - foo
+
+```
+
+## 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`)
+
+```
+name: "Hello World"                  # required. Script phase name.
+
+# One and only one :script_path or :script may appear.
+# For now, it makes no sense to have 2 differents script sources.
+script_path: "Script/helloworld.sh"  # required. Script file path.
+script: |                            # required. Script.
+  <some code lines>
+  <other code lines>
+
+input_paths:                         # optional.
+  - ""
+
+output_paths: # optional.
+  - ""
+
+input_file_list_paths:               # optional.
+  - ""
+
+output_file_list_paths:              # optional.
+  - ""
+
+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
+```
+echo Hello World
+```
+
+## Execution
+Finally, inject script phases
+```
+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)

data/bin/spinjector

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'spinjector'

data/lib/spinjector.rb

@@ -3,6 +3,7 @@
 # @author Guillaume Berthier
 #
 
+require 'optparse'
 require 'xcodeproj'
 require 'yaml'
 
@@ -13,6 +14,16 @@ BUILD_PHASE_PREFIX = '[SPI] '.freeze
 
 CONFIGURATION_FILE_PATH = 'Configuration/spinjector_configuration.yaml'.freeze
 
+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)
@@ -29,13 +40,23 @@ 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?
+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|
-      load_yml_content(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
@@ -45,10 +66,7 @@ end
 # @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
+  raise "[Error] YAML file #{configuration_path} not found." unless File.exist?(configuration_path)
   YAML.load(File.read(configuration_path)) || {}
 end
 
@@ -58,7 +76,7 @@ end
 #
 def app_target(project, target_name)
   target = project.targets.find { |t| t.name == target_name }
-  puts "Invalid #{target_name} target." unless !target.nil?
+  raise "[Error] Invalid #{target_name} target." unless !target.nil?
   return target
 end
 
@@ -69,8 +87,8 @@ 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
+    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"]
@@ -88,6 +106,27 @@ def create_script_phases(script_phases, target)
   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
@@ -135,7 +174,9 @@ 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)
-inject_script_phases(project)
+configuration_file_path = options[:configuration_path] || CONFIGURATION_FILE_PATH
+inject_script_phases(project, configuration_file_path)
 project.save()
-puts "Success"
+puts "Success."

data/spinjector.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name        = 'spinjector'
+  s.version     = '0.0.5'
+  s.executables << 'spinjector'
+  s.summary     = "Inject script phases into your Xcode project"
+  s.description = ""
+  s.authors     = ["Guillaume Berthier, Fabernovel"]
+  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.license     = 'MIT'
+
+  s.add_dependency 'optparse', '~> 0.1'
+  s.add_dependency 'xcodeproj', '~> 1.21'
+  s.add_dependency 'yaml', '~> 0.2'
+end

metadata

@@ -1,23 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: spinjector
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Guillaume Berthier, Fabernovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: ''
 email: guillaume.berthier@fabernovel.com
-executables: []
+executables:
+- spinjector
 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
+- Examples/Configuration/spinjector_configuration.yaml
+- Examples/Images/build_phases.png
+- Examples/Images/hello_world_explicit.png
+- Examples/Scripts/helloworld.sh
+- README.md
+- bin/spinjector
 - lib/spinjector.rb
-homepage: https://www.fabernovel.com
+- spinjector.gemspec
+homepage: https://github.com/guillaumeberthier/spinjector
 licenses:
 - MIT
 metadata: {}