spinjector 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbdf7ea58d76021bcd8302180796917e5d7558f0731f7d75291600bdb0b45667
-  data.tar.gz: adb9363c4fe050493327d9dd891c97a300961ad546ba87bd0f0b0a1d7e8a0167
+  metadata.gz: 502f8d32df2be80b74853a2dff98674e1726c25bba12ae93ad3cc0410bcf19b3
+  data.tar.gz: f4ded6c2bf3ca6010b540dbdf4690c1b6e829bfd3731013172a1600e9141ab9d
 SHA512:
-  metadata.gz: aa16a38ffd1126bd84cec774493a8ee465b8e4df545d508ae990e7800b1afac346418cc74d7d1f006b8e4ad975406c53a812c0149e172013ecbf9a7f95da9e98
-  data.tar.gz: 2a07ff2f2c8e0ae2cbdcfaf108bfcf32910cf97e893c5c71fe3ba49d85fbd51a946319268e7375c0bbaacd9d5751fa6a2ce4f090a286d479744313340724e7ff
+  metadata.gz: 22cc30ca7469dd43ae33f475436270d423287b57e9a3ed67ab9a2ff35e50ecca51e4596d814057baf137ea400aca7ae955fe56a582814fa257c913c618dda1f1
+  data.tar.gz: 0eb28a729035d9d8a23db43cd1c7ff4e6b688c56a2e8a46f405497449da068009c7fe05d0af6dc2ab44b934d4564402afe118b5a675a5a5f9214539b0c76133b

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_short.yaml

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

data/Examples/Configuration/spinjector_configuration.yaml

@@ -0,0 +1,11 @@
+# TargetNameFoo:
+#     - <script path A> to inject
+#     - <script path B> to inject
+# TargetNameBar:
+#     - <script path A> to inject
+#     - <script path C> to inject
+
+TargetNameA:
+  - "helloworld.yaml"
+TargetNameB:
+  - "helloworld_short.yaml"

data/Examples/Scripts/helloworld.sh

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

data/README.md

@@ -0,0 +1,51 @@
+# 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).
+
+```
+TargetNameFoo:
+    - <scriptA config path> to inject
+    - <scriptB config path> to inject
+TargetNameBar:
+    - <scriptA config path> to inject
+    - <scriptC config path> to inject
+```
+
+## Script configuration file
+Then, for each script you want to inject in your Xcode project, create:
+- A configuration file for this script
+```
+name: "Hello World"                  # required. Script phase name.
+script_path: "Script/helloworld.sh"  # required. Script file path.
+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
+```
+echo Hello World
+```
+
+## Execution
+Finally, inject script phases
+```
+spinjector [-c] <path-to-your-global-configuration-file>
+
+```

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,13 @@ end
 
 # @param [Xcodeproj::Project] project
 # 
-def inject_script_phases(project)
-  configuration_file = load_yml_content(CONFIGURATION_FILE_PATH)
+def inject_script_phases(project, configuration_file_path)
+  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
+    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 +56,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 +66,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
 
@@ -135,7 +143,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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinjector
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Guillaume Berthier, Fabernovel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: guillaume.berthier@fabernovel.com
@@ -18,10 +18,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- README
+- Examples/Configuration/helloworld.yaml
+- Examples/Configuration/helloworld_short.yaml
+- Examples/Configuration/spinjector_configuration.yaml
+- Examples/Scripts/helloworld.sh
+- README.md
 - bin/spinjector
 - lib/spinjector.rb
-- spinjector-0.0.1.gem
 - spinjector.gemspec
 homepage: https://www.fabernovel.com
 licenses: