xcodebuild-rb 0.1.0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Luke Redpath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# xcodebuild-rb: Building Xcode projects with Rake
+
+[![Build Status](https://secure.travis-ci.org/lukeredpath/xcodebuild-rb.png)](http://travis-ci.org/lukeredpath/xcodebuild-rb])
+
+xcodebuild-rb is a RubyGem that provides a Ruby interface to the `xcodebuild` utility that ships with Xcode in the form of a series of Rake tasks. This gem only supports Xcode 4 (you can try it with 3.x, but YMMV). It makes it simple to run your builds from the command line, especially on remote machines such as Continuous Integration servers.
+
+In addition, it provides configurable output parsing that enables better formatting of Xcode build results and eventually, test results. This is done through a series of output translations, reporters and formatters. All of this can be extended with a bit of Ruby knowledge (more on that soon).
+
+This library is still under development but it should be more or less usable out of the box.
+
+## Getting started
+
+After installing the gem, you need to create a `Rakefile` in the root of your project if you don't already have one. If you aren't familiar with `rake`, you can think of it as a Ruby equivalent to `make`. You can find out more about `rake` [here](http://rake.rubyforge.org/).
+
+A simple Rakefile will look like this:
+
+    require 'rubygems'
+    require 'xcodebuild-rb'
+    
+    XcodeBuild::Tasks::BuildTask.new
+
+With only those three lines, you will now have access to a variety of tasks such as clean and build. A full list of tasks can be viewed by running `rake -T`:
+
+    $ rake -T
+    rake xcode:build       # Builds the specified target(s).
+    rake xcode:clean       # Cleans the build using the same build settings.
+    rake xcode:cleanbuild  # Builds the specified target(s) from a clean slate.
+    
+## Configuring your tasks
+    
+When you run `rake xcode:build`, `xcodebuild` will be invoked without any arguments, which will in turn cause the default build to run. For this to be more useful, we need to configure the task. We could, for instance, configure the target and configuration:
+
+    XcodeBuild::Tasks::BuildTask.new do |t|
+      t.target = "MyApp"
+      t.configuration = "Release"
+    end
+
+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.
+
+    XcodeBuild::Tasks::BuildTask.new do |t|
+      t.formatter = XcodeBuild::Formatters::ProgressFormatter.new
+    end
+    
+Now when you run your build, your output will look something like this:
+
+    Building target: ExampleProject (in ExampleProject.xcproject)
+    =============================================================
+
+    Configuration: Release
+    ..............
+
+    Finished in 2.226883 seconds.
+    Build succeeded.
+
+## License
+
+This library is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).

data/bin/rbxcb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require_relative "../lib/xcodebuild"
+XcodeBuild.run(ARGV[0] || "")

data/lib/xcode_build.rb

@@ -0,0 +1,27 @@
+module XcodeBuild
+  def self.run(args = "", output_buffer = STDOUT)
+    IO.popen("xcodebuild #{args} 2>&1") do |io|
+      begin
+        while line = io.readline
+          begin
+            output_buffer << line
+          rescue StandardError => e
+            puts "Error from output buffer: #{e.inspect}"
+            puts e.backtrace
+          end
+        end
+      rescue EOFError
+      end
+    end
+  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'
+
+# configure the default translations for general use
+XcodeBuild::OutputTranslator.use_translation(:building)
+XcodeBuild::OutputTranslator.use_translation(:cleaning)

data/lib/xcode_build/build_action.rb

@@ -0,0 +1,72 @@
+require 'state_machine'
+
+require_relative "build_step"
+
+module XcodeBuild
+  class BuildAction
+    attr_reader :steps_completed
+    attr_writer :finished_at
+
+    def initialize(metadata)
+      @steps_completed = []
+      @metadata = metadata
+      @started_at = Time.now
+      super()
+    end
+
+    state_machine :state, :initial => :running do
+      event :success do
+        transition :running => :successful
+      end
+
+      event :failure do
+        transition :running => :failed
+      end
+
+      after_transition :running => [:successful, :failed] do |build|
+        build.finished_at = Time.now
+      end
+    end
+
+    def add_step(params)
+      @steps_completed << BuildStep.new(params)
+    end
+
+    def failed_steps
+      @steps_completed.select { |a| a.failed? }
+    end
+
+    def step_with_params(params)
+      @steps_completed.detect { |a| a == BuildStep.new(params) }
+    end
+
+    def last_step
+      @steps_completed.last
+    end
+
+    def finished?
+      successful? || failed?
+    end
+
+    def duration
+      return nil unless finished?
+      @finished_at - @started_at
+    end
+
+    def project_name
+      @metadata[:project]
+    end
+
+    def target
+      @metadata[:target]
+    end
+
+    def configuration
+      @metadata[:configuration]
+    end
+
+    def default_configuration?
+      @metadata[:default]
+    end
+  end
+end

data/lib/xcode_build/build_step.rb

@@ -0,0 +1,47 @@
+require "ostruct"
+
+module XcodeBuild
+  class BuildStep
+    attr_accessor :failed
+    attr_reader :errors
+
+    def initialize(metadata)
+      @metadata = metadata
+      @errors = []
+    end
+
+    def add_error(params)
+      @errors << Error.new(params)
+    end
+
+    def has_errors?
+      @errors.any?
+    end
+
+    def ==(other_action)
+      (other_action.type == type &&
+       other_action.arguments == arguments)
+    end
+
+    def type
+      @metadata[:type]
+    end
+
+    def arguments
+      @metadata[:arguments]
+    end
+
+    def failed?
+      @failed
+    end
+
+    def inspect
+      [type, arguments]
+    end
+    
+    private
+    
+    class Error < OpenStruct
+    end
+  end
+end

data/lib/xcode_build/formatters.rb

@@ -0,0 +1,6 @@
+module XcodeBuild
+  module Formatters
+  end
+end
+
+require_relative "formatters/progress_formatter"

data/lib/xcode_build/formatters/progress_formatter.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+require_relative '../utilities/colorize'
+
+module XcodeBuild
+  module Formatters
+    class ProgressFormatter
+      include XcodeBuild::Utilities::Colorize
+      
+      def initialize(output = STDOUT)
+        @output = output
+      end
+      
+      def clean_started(clean)
+        report_started("Cleaning", clean)
+      end
+      
+      def clean_step_finished(step)
+        report_step_finished(step)
+      end
+      
+      def clean_finished(clean)
+        report_finished("Clean", clean)
+      end
+      
+      def build_started(build)
+        report_started("Building", build)
+      end
+      
+      def build_step_finished(step)
+        report_step_finished(step)
+      end
+      
+      def build_finished(build)
+        report_finished("Build", build)
+      end
+      
+      def report_finished(type, object)
+        puts
+        puts
+        puts "Finished in #{object.duration} seconds."
+        
+        if object.successful?
+          puts green("#{type} succeeded.")
+        else
+          puts red("#{type} failed.")
+          puts
+          puts "Failed #{type.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
+              puts
+            end
+            
+            error_counter += 1
+          end
+        end
+        puts
+      end
+      
+      private
+      
+      def puts(str = "")
+        @output.puts( str)
+      end
+      
+      def color_enabled?
+        true
+      end
+      
+      def indent(string)
+        "  #{string}"
+      end
+      
+      def report_started(type, object)
+        puts
+        banner = "#{type} target: #{object.target} (in #{object.project_name}.xcproject)"
+        puts bold(banner)
+        puts banner.length.times.map { "=" }.join
+        puts
+        puts "Configuration: #{object.configuration}"
+      end
+      
+      def report_step_finished(step)
+        if step.has_errors?
+          print red("F")
+        else
+          print green(".")
+        end
+      end
+    end
+  end
+end

data/lib/xcode_build/output_translator.rb

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+require_relative 'translations'
+
+module XcodeBuild
+  class OutputTranslator
+    attr_reader :translations, :delegate
+    
+    def initialize(delegate, options = {})
+      @delegate = delegate
+      @translation_modules = []
+      @translations = []
+      OutputTranslator.prepare_instance(self) unless options[:ignore_global_translations]
+    end
+    
+    def <<(line)
+      notify_delegate(:beginning_translation_of_line, args: line)
+      translations.each { |translation| translation.attempt_to_translate(line) }
+    end
+    
+    def use_translation(translation_module)
+      unless translation_module.nil? || @translation_modules.include?(translation_module)
+        @translation_modules << translation_module
+        @translations << ConcreteTranslation.new(@delegate, translation_module)
+      end
+    end
+    
+    class << self
+      def use_translation(translation_module_or_key)
+        if translation_module_or_key.is_a?(Symbol)
+          translation_module = Translations.registered_translation(translation_module_or_key)
+        else
+          translation_module = translation_module_or_key
+        end
+        
+        @any_instance_translations ||= []
+        @any_instance_translations << translation_module
+      end
+      
+      def prepare_instance(translator)
+        @any_instance_translations.each do |translation|
+          translator.use_translation(translation)
+        end
+      end
+    end
+    
+    class MissingDelegateMethodError < StandardError
+      def initialize(method)
+        @method = method
+      end
+      
+      def message
+        "Delegate must implement the #{@method.to_sym} method."
+      end
+    end
+    
+    private
+    
+    module TranslationHelpers
+      def notify_delegate(message, options = {args: []})
+        if @delegate.respond_to?(message)
+          @delegate.send(message, *options[:args])
+        else
+          if options[:required]
+            raise MissingDelegateMethodError.new(message)
+          end
+        end
+      end
+    end
+    
+    class ConcreteTranslation
+      include TranslationHelpers
+      
+      def initialize(delegate, translation)
+        @delegate = delegate
+        extend translation
+      end
+    end
+    
+    include TranslationHelpers
+  end
+end
+

data/lib/xcode_build/reporter.rb

@@ -0,0 +1,22 @@
+require_relative "reporting/build_reporting"
+require_relative "reporting/clean_reporting"
+
+module XcodeBuild
+  class Reporter
+    include Reporting::BuildReporting
+    include Reporting::CleanReporting
+    
+    attr_accessor :delegate
+
+    def initialize(delegate = nil)
+      @delegate = delegate
+    end
+
+    private
+
+    def notify(event, *args)
+      return unless @delegate
+      @delegate.send(event, *args) if @delegate.respond_to?(event)
+    end
+  end
+end