Allow custom ordering of script phases (#204)

defaults/liftoffrc

@@ -19,7 +19,8 @@ strict_prompts: false
 deployment_target: 8.0
 
 run_script_phases:
-  - todo.sh: Warn for TODO and FIXME comments
+  - file: todo.sh
+    name: Warn for TODO and FIXME comments
 
 templates:
   - travis.yml: .travis.yml

lib/liftoff/xcodeproj_helper.rb

@@ -1,5 +1,7 @@
 module Liftoff
   class XcodeprojHelper
+    LAST_INDEX = -1
+
     def treat_warnings_as_errors(enable_errors)
       if enable_errors
         puts 'Setting GCC_TREAT_WARNINGS_AS_ERRORS for Release builds'
@@ -40,9 +42,13 @@ def set_indentation_level(level, use_tabs)
     def add_script_phases(scripts)
       if scripts
         scripts.each do |script|
-          key, value = script.first
-          puts "Adding shell script build phase '#{value}'"
-          add_shell_script_build_phase(file_manager.template_contents(key), value)
+
+          file = script['file']
+          name = script['name']
+          index = script.fetch('index', LAST_INDEX)
+
+          puts "Adding shell script build phase '#{name}'"
+          add_shell_script_build_phase(file_manager.template_contents(file), name, index)
         end
       end
     end
@@ -79,10 +85,14 @@ def available_targets
       xcode_project.targets.to_a.reject { |t| t.name.end_with?('Tests') }
     end
 
-    def add_shell_script_build_phase(script, name)
+    def add_shell_script_build_phase(script, name, index)
       if build_phase_does_not_exist_with_name?(name)
         build_phase = target.new_shell_script_build_phase(name)
         build_phase.shell_script = script
+
+        target.build_phases.delete(build_phase)
+        target.build_phases.insert(index, build_phase)
+
         xcode_project.save
       end
     end

man/liftoffrc.5

@@ -301,14 +301,26 @@ for more information on the format of this key.
 .Ic liftoff
 installs a single Run Script Build Phase by default:
 .Bd -literal
-  - todo.sh: Warn for TODO and FIXME comments
+  - file: todo.sh
+    name: Warn for TODO and FIXME comments
 .Ed
 .Pp
 This script turns any
 .Ic TODO
 or
 .Ic FIXME
 comments into warnings at compilation time.
+.Pp
+You can also customize when your build phase is executed by using the following
+syntax:
+.Bd -literal
+  - file: todo.sh
+    name: Warn for TODO and FIXME comments
+    index: 1
+.Ed
+.Pp
+This will insert the same script phase at the index 1 in the build phase list.
+Indexes are zero-based and optional. If you skip it, it will default to the end of the list.
 .
 .Sh WARNINGS
 .Ic liftoff