xcodebuild-rb 0.1.0 → 0.2.0

data/CHANGES.md

@@ -0,0 +1,11 @@
+# xcodebuild-rb changes
+
+## 0.2.0
+* Added archive task
+* Support Ruby 1.8.7
+* Added after_(build|clean|archive) hooks for rake tasks
+* Support capturing environment variables when a Run Script Phase with 'Show Environment Variables' is added.
+* Ensure rake tasks exit with an appropriate exit code when the builds fail.
+
+## 0.1.0
+* Initial release.

data/README.md

@@ -15,7 +15,7 @@ After installing the gem, you need to create a `Rakefile` in the root of your pr
 A simple Rakefile will look like this:
 
     require 'rubygems'
-    require 'xcodebuild-rb'
+    require 'xcodebuild'
     
     XcodeBuild::Tasks::BuildTask.new
 
@@ -35,6 +35,8 @@ When you run `rake xcode:build`, `xcodebuild` will be invoked without any argume
       t.configuration = "Release"
     end
 
+_Note that in order to be able to use the `xcode:archive` task, a scheme **has** to be provided_
+
 When you run the rake tasks provided, the default behaviour is to simply output the exact output from `xcodebuild`. However, `xcodebuild-rb` can go one better and allow you to configure custom formatters that change the way the build output is displayed. Some formatters are built-in, or you can write your own.
 
 For instance, we could use the "progress" formatter that ships with `xcodebuild-rb`. Anybody who is used to the output of Ruby's Test::Unit library or RSpec library will be familiar with this.
@@ -56,4 +58,4 @@ Now when you run your build, your output will look something like this:
 
 ## License
 
-This library is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
+This library is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).

data/bin/rbxcb

@@ -1,3 +1,9 @@
 #!/usr/bin/env ruby
-require_relative "../lib/xcodebuild"
+
+if __FILE__ == $0
+  require 'rubygems'
+  $:.unshift(File.expand_path('../../lib', __FILE__))
+end
+
+require "xcode_build"
 XcodeBuild.run(ARGV[0] || "")

data/lib/xcode_build.rb

@@ -13,14 +13,17 @@ module XcodeBuild
       rescue EOFError
       end
     end
+    
+    $?.exitstatus
   end
 end
 
-require_relative "xcode_build/build_action"
-require_relative "xcode_build/build_step"
-require_relative 'xcode_build/output_translator'
-require_relative 'xcode_build/reporter'
-require_relative 'xcode_build/formatters'
+require 'xcode_build/build_action'
+require 'xcode_build/build_step'
+require 'xcode_build/output_translator'
+require 'xcode_build/reporter'
+require 'xcode_build/formatters'
+require 'xcode_build/tasks'
 
 # configure the default translations for general use
 XcodeBuild::OutputTranslator.use_translation(:building)

data/lib/xcode_build/build_action.rb

@@ -1,6 +1,6 @@
 require 'state_machine'
 
-require_relative "build_step"
+require "xcode_build/build_step"
 
 module XcodeBuild
   class BuildAction
@@ -47,11 +47,19 @@ module XcodeBuild
     def finished?
       successful? || failed?
     end
+    
+    def has_errors?
+      failed_steps.any?
+    end
 
     def duration
       return nil unless finished?
       @finished_at - @started_at
     end
+    
+    def label
+      @label.downcase.capitalize
+    end
 
     def project_name
       @metadata[:project]
@@ -69,4 +77,4 @@ module XcodeBuild
       @metadata[:default]
     end
   end
-end
+end

data/lib/xcode_build/build_step.rb

@@ -11,6 +11,7 @@ module XcodeBuild
     end
 
     def add_error(params)
+      @failed = true
       @errors << Error.new(params)
     end
 
@@ -42,6 +43,13 @@ module XcodeBuild
     private
     
     class Error < OpenStruct
+      def error_detail
+        if self.file
+          "in #{err.file}:#{err.line.to_s}"
+        elsif self.command
+          "#{self.command} failed with exit code #{self.exit_code}"
+        end
+      end
     end
   end
 end

data/lib/xcode_build/formatters.rb

@@ -3,4 +3,4 @@ module XcodeBuild
   end
 end
 
-require_relative "formatters/progress_formatter"
+require "xcode_build/formatters/progress_formatter"

data/lib/xcode_build/formatters/progress_formatter.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require_relative '../utilities/colorize'
+require 'xcode_build/utilities/colorize'
 
 module XcodeBuild
   module Formatters
@@ -19,7 +19,7 @@ module XcodeBuild
       end
       
       def clean_finished(clean)
-        report_finished("Clean", clean)
+        report_finished(clean)
       end
       
       def build_started(build)
@@ -31,30 +31,34 @@ module XcodeBuild
       end
       
       def build_finished(build)
-        report_finished("Build", build)
+        report_finished(build)
       end
       
-      def report_finished(type, object)
+      def report_finished(object)
         puts
         puts
         puts "Finished in #{object.duration} seconds."
         
         if object.successful?
-          puts green("#{type} succeeded.")
+          puts green("#{object.label} succeeded.")
         else
-          puts red("#{type} failed.")
+          puts red("#{object.label} failed.")
           puts
-          puts "Failed #{type.downcase} steps:"
+          puts "Failed #{object.label.downcase} steps:"
           puts
           error_counter = 1
           object.steps_completed.each do |step|
             next unless step.has_errors?
-            
+
             puts indent("#{error_counter}) #{step.type} #{step.arguments.join(" ")}")
 
             step.errors.each do |err|
-              puts indent("   #{red(err.message)}")
-              puts indent(cyan("   in #{err.file}:#{err.line.to_s}")) if err.file
+              print indent("   #{red(err.message)}")
+              if err.error_detail
+                puts indent(cyan(err.error_detail)) 
+              else
+                puts
+              end
               puts
             end
             

data/lib/xcode_build/output_translator.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-require_relative 'translations'
+require 'xcode_build/translations'
 
 module XcodeBuild
   class OutputTranslator
@@ -13,7 +13,7 @@ module XcodeBuild
     end
     
     def <<(line)
-      notify_delegate(:beginning_translation_of_line, args: line)
+      notify_delegate(:beginning_translation_of_line, :args => line)
       translations.each { |translation| translation.attempt_to_translate(line) }
     end
     
@@ -56,7 +56,8 @@ module XcodeBuild
     private
     
     module TranslationHelpers
-      def notify_delegate(message, options = {args: []})
+      def notify_delegate(message, options = {})
+        options[:args] ||= []
         if @delegate.respond_to?(message)
           @delegate.send(message, *options[:args])
         else

data/lib/xcode_build/reporter.rb

@@ -1,5 +1,5 @@
-require_relative "reporting/build_reporting"
-require_relative "reporting/clean_reporting"
+require "xcode_build/reporting/build_reporting"
+require "xcode_build/reporting/clean_reporting"
 
 module XcodeBuild
   class Reporter
@@ -11,6 +11,14 @@ module XcodeBuild
     def initialize(delegate = nil)
       @delegate = delegate
     end
+    
+    def direct_raw_output_to=(stream)
+      @output_stream = stream
+    end
+    
+    def beginning_translation_of_line(line)
+      (@output_stream << line) if @output_stream
+    end
 
     private
 

data/lib/xcode_build/reporting/build_reporting.rb

@@ -11,35 +11,48 @@ module XcodeBuild
       
       def build_started(params)
         @build = Build.new(params)
-        notify :build_started, @build
+        notify :build_started, build
       end
 
       def build_step(params)
-        if @build.last_step
-          notify :build_step_finished, @build.last_step
+        if build.last_step
+          notify :build_step_finished, build.last_step
         end
 
-        @build.add_step(params)
+        build.add_step(params)
 
-        notify :build_step_started, @build.last_step
+        notify :build_step_started, build.last_step
       end
 
       def build_error_detected(params)
-        @build.last_step.add_error(params)
+        build.last_step.add_error(params)
+      end
+      
+      def build_env_variable_detected(key, value)
+        build.set_environment_variable(key, value)
       end
 
-      def build_succeeded
-        @build.success!
+      def build_succeeded(archive_or_build)
+        build.label = archive_or_build
+        
+        # for some reason, archive reports a success even if there was an error
+        if build.has_errors?
+          build.failure!
+        else
+          build.success!
+        end
+        
         build_finished
       end
 
-      def build_failed
-        @build.failure!
+      def build_failed(archive_or_build)
+        build.label = archive_or_build
+        build.failure!
         build_finished
       end
 
       def build_step_failed(params)
-        if step = @build.step_with_params(params)
+        if step = build.step_with_params(params)
           step.failed = true
         end
       end
@@ -47,14 +60,30 @@ module XcodeBuild
       private
 
       def build_finished
-        if @build.last_step
-          notify :build_step_finished, @build.last_step
+        if build.last_step
+          notify :build_step_finished, build.last_step
         end
 
-        notify :build_finished, @build
+        notify :build_finished, build
       end
       
       class Build < BuildAction
+        attr_reader :environment
+        attr_writer :label
+        
+        def initialize(metadata)
+          super(metadata)
+          @environment = {}
+          @label = "Build"
+        end
+        
+        def set_environment_variable(key, value)
+          @environment[key] = value
+        end
+        
+        def target_build_directory
+          @environment["TARGET_BUILD_DIR"]
+        end
       end
     end
   end

data/lib/xcode_build/reporting/clean_reporting.rb

@@ -9,7 +9,7 @@ module XcodeBuild
       
       def clean_started(params)
         @clean = Clean.new(params)
-        notify :clean_started, @clean
+        notify :clean_started, clean
       end
       
       def clean_step(params)
@@ -53,6 +53,10 @@ module XcodeBuild
       end
       
       class Clean < BuildAction
+        def initialize(metadata)
+          super(metadata)
+          @label = "Clean"
+        end
       end
     end
   end

data/lib/xcode_build/tasks.rb

@@ -0,0 +1,6 @@
+module XcodeBuild
+  module Tasks
+  end
+end
+
+require 'xcode_build/tasks/build_task'

data/lib/xcode_build/tasks/build_task.rb

@@ -3,6 +3,8 @@ require 'rake/tasklib'
 module XcodeBuild
   module Tasks
     class BuildTask < ::Rake::TaskLib
+      include Rake::DSL if defined?(Rake::DSL)
+
       attr_accessor :project_name
       attr_accessor :target
       attr_accessor :workspace
@@ -14,16 +16,36 @@ module XcodeBuild
       attr_accessor :output_to
       attr_accessor :formatter
       attr_accessor :invoke_from_within
-      attr_accessor :reporter
+      attr_accessor :reporter_klass
 
       def initialize(namespace = :xcode, &block)
         @namespace = namespace
         @output_to = STDOUT
         @invoke_from_within = "."
+        @reporter_klass = XcodeBuild::Reporter
+        @hooks = {}
         
         yield self if block_given?
         define
       end
+      
+      def after_build(&block)
+        @hooks[:after_build] = block
+      end
+      
+      def after_clean(&block)
+        @hooks[:after_clean] = block
+      end
+      
+      def after_archive(&block)
+        @hooks[:after_archive] = block
+      end
+      
+      def execute_hook(name, *args)
+        if hook = @hooks[name.to_sym]
+          hook.call(*args)
+        end
+      end
 
       def run(task)
         Rake::Task["#{@namespace}:#{task}"].invoke
@@ -41,44 +63,72 @@ module XcodeBuild
           opts << "-xcconfig #{xcconfig}" if xcconfig
         end
       end
+      
+      def reporter
+        @reporter ||= @reporter_klass.new(formatter)
+      end
 
       private
       
       def output_buffer
-        if reporter
-          XcodeBuild::OutputTranslator.new(reporter)
-        elsif formatter
-          default_reporter = XcodeBuild::Reporter.new(formatter)
-          XcodeBuild::OutputTranslator.new(default_reporter)
-        else
-          output_to
-        end
+        @output_buffer ||= XcodeBuild::OutputTranslator.new(reporter)
       end
       
       def build_opts_string(*additional_opts)
-        (build_opts + additional_opts).join(" ")
+        (build_opts + additional_opts).compact.join(" ")
+      end
+
+      def xcodebuild(action)
+        reporter.direct_raw_output_to = output_to unless formatter
+        
+        status = Dir.chdir(invoke_from_within) do
+          XcodeBuild.run(build_opts_string(action), output_buffer)
+        end
+        
+        check_status(status)
+        
+        if reporter.build && reporter.build.failed?
+          # sometimes, a build/archive can fail and xcodebuild won't return a non-zero code
+          raise "xcodebuild failed (#{reporter.build.failed_steps.length} steps failed)"
+        end
+        
+        case action
+        when :build
+          execute_hook(:after_build, reporter.build)
+        when :archive
+          execute_hook(:after_build, reporter.build)
+          execute_hook(:after_archive, reporter.build)
+        when :clean
+          execute_hook(:after_clean, reporter.clean)
+        end
       end
 
       def define
         namespace(@namespace) do
+          desc "Creates an archive build of the specified target(s)."
+          task :archive do
+            raise "You need to specify a `scheme' in order to be able to create an archive build!" unless scheme
+            xcodebuild :archive
+          end
+
           desc "Builds the specified target(s)."
           task :build do
-            Dir.chdir(invoke_from_within) do
-              XcodeBuild.run(build_opts_string, output_buffer)
-            end
+            xcodebuild :build
           end
           
           desc "Cleans the build using the same build settings."
           task :clean do
-            Dir.chdir(invoke_from_within) do
-              XcodeBuild.run(build_opts_string("clean"), output_buffer)
-            end
+            xcodebuild :clean
           end
           
           desc "Builds the specified target(s) from a clean slate."
           task :cleanbuild => [:clean, :build]
         end
       end
+      
+      def check_status(status)
+        raise "xcodebuild failed (exited with status: #{status})" unless status == 0
+      end
     end
   end
 end