spinjector 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a068bf03bec2f55c4ba35e21837e5646448925c15022befe1fe0cc78f4421ea7
-  data.tar.gz: 480fb32fd1468e9aaa2de729ffc06e21340e254fd4bc90ad2e235ff7c90e477b
+  metadata.gz: 13754e7fa2165ee93579dd1d2064c9eb5e692ef67a2e2b7cd59f8a755b14a21b
+  data.tar.gz: 21e6d78086b4ed644eaf628c1548fc6570f198d2ad3aaf224d51da41e4d065ba
 SHA512:
-  metadata.gz: 62be7e320e8094f6f434d082c9ee030c8fb7de9f3214d28137d538b4b16e603c67d108d895f0f7cad954474667aac604e961b2ced5191c6bcc4a26f6b11ab660
-  data.tar.gz: 7dbd3c4596b209de43caecab5db28248b330d87ca925ab6bcf8c1d55d73fb64a1886eadaa5949ca14a8df5cc82237eeb2473ba8e8aea7c9e25368f9015e1fc95
+  metadata.gz: f44c4b944a3a1859d5e2d9396bcc5a4ca4820d4d1b1f9633f1657b5b4f4430a60ab26bdedfa725bccba05c695a109d9e2d8e254c247a45b4d651639a88733463
+  data.tar.gz: 45a06ffa00166fa35326be22ac1156f1930d42e5737906e6c0f3d9a34c904ff3d5490bf3ab3e5f3403d18e9ac6bfd2f9e9f589b6a62e1b85dae45e6bdb709952

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

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

data/Examples/Configuration/spinjector_configuration.yaml

@@ -1,11 +1,18 @@
-# TargetNameFoo:
-#     - <script path A> to inject
-#     - <script path B> to inject
-# TargetNameBar:
-#     - <script path A> to inject
-#     - <script path C> to inject
+scripts:
+  foo:
+    name: "Foo"
+    script_path: "Scripts/helloworld.sh"
+  bar:
+    name: "Bar"
+    script: |
+      echo Bar
+    execution_position: :after_compile
 
-TargetNameA:
-  - "helloworld.yaml"
-TargetNameB:
-  - "helloworld_short.yaml"
+targets:
+  TargetNameA:
+    - foo
+    - "helloworld.yaml"
+    - bar
+    - "helloworld_explicit_script.yaml"
+  TargetNameB:
+    - "helloworld_short.yaml"

data/README.md

@@ -12,33 +12,58 @@ gem install spinjector
 First, create a YAML configuration file under `./Configuration/spinjector_configuration.yaml` (default path where spinjector looks for a configuration file).
 
 ```
-TargetNameFoo:
-    - <scriptA config path> to inject
-    - <scriptB config path> to inject
-TargetNameBar:
-    - <scriptA config path> to inject
-    - <scriptC config path> to inject
+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, create:
-- A configuration file for this script
+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].
 ```
 
-- The script file defined under `script_path` in your script configuration file
+- If you use the `script_path option, create the script file
 ```
 echo Hello World
 ```
@@ -47,5 +72,8 @@ echo Hello World
 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/lib/spinjector.rb

@@ -42,9 +42,19 @@ end
 # 
 def inject_script_phases(project, configuration_file_path)
   configuration_file = load_yml_content(configuration_file_path)
-  configuration_file.each do |target_name, script_paths|
+  # 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)
@@ -77,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"]
@@ -96,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

data/spinjector.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinjector
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Guillaume Berthier, Fabernovel
@@ -60,9 +60,14 @@ 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