xcoder 0.1.4 → 0.1.6

data/lib/xcode/simple_identifier_generator.rb

@@ -1,17 +1,64 @@
 module SimpleIdentifierGenerator
   extend self
   
+  MAX_IDENTIFIER_GENERATION_ATTEMPTS = 10
+  
   #
   # Generate an identifier string
   # 
+  # @example generating a new identifier
+  # 
+  #     SimpleIdentifierGenerator.generate # => "E21EB9EE14E359840058122A"
+  # 
+  # @example generating a new idenitier ensuring it does not match existing keys
+  # 
+  #     SimpleIdentifierGenerator.generate :existing_keys => [ "E21EB9EE14E359840058122A" ] # => "2574D65B0D2FFDB5D0372B4A"
+  # 
+  # @param [Hash] options contains any additional parameters; namely the 
+  #   `:existing_keys` parameters which will help ensure uniqueness.
+  # 
+  # @return [String] a 24-length string that contains only hexadecimal characters.
+  # 
+  def generate(options = {})
+    
+    existing_keys = options[:existing_keys] || []
+    
+    # Ensure that the identifier generated is unique
+    identifier_generation_count = 0
+    
+    new_identifier = generate_new_key
+    
+    while existing_keys.include?(new_identifier)
+      
+      new_identifier = generate_new_key
+      
+      # Increment our identifier generation count and if we reach our max raise
+      # an exception as something has gone horribly wrong.
+
+      identifier_generation_count += 1
+      if identifier_generation_count > MAX_IDENTIFIER_GENERATION_ATTEMPTS
+        raise "SimpleIdentifierGenerator is unable to generate a unique identifier"
+      end
+    end
+    
+    new_identifier
+    
+  end
+  
+  private
+  
+  #
+  # Generates a new identifier string
+  # 
   # @example identifier string
   # 
   #     "E21EB9EE14E359840058122A"
   # 
-  # @return [String] a 24-length string that contains only hexadecimal characters.
+  # @return [String] a new identifier string
   # 
-  def generate
+  def generate_new_key
     range = ('A'..'F').to_a + (0..9).to_a
     24.times.inject("") {|ident| "#{ident}#{range.sample}" }
   end
+  
 end

data/lib/xcode/target.rb

@@ -1,4 +1,4 @@
-require_relative 'build_file'
+require 'xcode/build_file'
 
 module Xcode
   
@@ -49,13 +49,13 @@ module Xcode
         'productType' => 'com.apple.product-type.application' }
     end
     
-    # A reference to the project for which these targets reside.
+    # @return [Project] the reference to the project for which these targets reside.
     attr_accessor :project
     
     #
-    # @return [PBXBuildConfiguration] the configurations that this target supports.
-    #   these are generally 'Debug' or 'Release' but may be custom designed
-    #   configurations.
+    # @return [Array<BuildConfiguration>] the configurations that this target 
+    #   supports. These are generally 'Debug' or 'Release' but may be custom 
+    #   created configurations.
     # 
     def configs
       build_configuration_list.build_configurations.map do |config|
@@ -65,11 +65,14 @@ module Xcode
     end
     
     #
-    # Return a specific build configuration. When one is not found to match,
-    # an exception is raised.
+    # Return a specific build configuration. 
+    # 
+    # @note an exception is raised if no configuration matches the specified name.
+    # 
     # 
     # @param [String] name of a configuration to return
-    # @return [PBXBuildConfiguration] a specific build configuration that 
+    # 
+    # @return [BuildConfiguration] a specific build configuration that 
     #   matches the specified name.
     #
     def config(name)

data/lib/xcode/test/formatters/junit_formatter.rb

@@ -6,7 +6,12 @@ module Xcode
     module Formatters
       class JunitFormatter
         def initialize(dir)
-          @dir = dir
+          @dir = File.expand_path(dir)
+          FileUtils.mkdir_p(@dir)
+        end
+        
+        def after_suite(suite)
+          write(suite)
         end
 
         def write(report)
@@ -15,7 +20,7 @@ module Xcode
           end
           xml = ::Builder::XmlMarkup.new( :indent => 2 )
           xml.instruct! :xml, :encoding => "UTF-8"
-          xml.testsuite(:errors     => report.total_error_tests,
+          xml.testsuite(:errors     => report.total_errors,
             :failures   => report.total_failed_tests,
             :hostname   => Socket.gethostname,
             :name       => report.name,
@@ -28,10 +33,10 @@ module Xcode
               p.testcase(:classname  => report.name,
                 :name       => t.name,
                 :time       => t.time
-                ) do |e|
+                ) do |testcase|
   
-                if t.error?
-                  e.failure t.error_location, :message => t.error_message, :type => 'Failure'
+                t.errors.each do |error|
+                  testcase.failure error[:location], :message => error[:message], :type => 'Failure'
                 end
               end
             end

data/lib/xcode/test/formatters/stdout_formatter.rb

@@ -0,0 +1,62 @@
+module Xcode
+  module Test
+    module Formatters
+      class StdoutFormatter
+        
+        def initialize
+          @errors = []
+        end
+                
+        def before(report)
+          puts "Begin tests"
+        end
+        
+        def after(report)
+          puts "\n\nThe following failures occured:" if @errors.count>0
+          @errors.each do |e|
+            puts "[#{e.suite.name} #{e.name}]"
+            e.errors.each do |error|
+              puts "  #{error[:message]}"
+              puts "    at #{error[:location]}"
+              if error[:data].count>0
+                puts "\n   Test Output:"
+                puts "   > #{error[:data].join("   > ")}\n\n"
+              end
+            end       
+            
+            # if there is left over data in the test report, show that
+            if e.data.count>0
+              puts "\n  There was this trailing output after the above failures"
+              puts "   > #{e.data.join("   > ")}\n\n"
+            end
+          end
+          
+          puts "\n\nEnd tests (#{report.failed? ? 'FAILED' : 'PASSED'}).  Took #{report.duration}s"
+        end
+        
+        def before_suite(suite)
+          print "#{suite.name}: "
+        end
+        
+        def after_suite(suite)
+          puts " [#{suite.total_passed_tests}/#{suite.tests.count}]"
+        end
+        
+        def before_test(test)
+          # puts "[#{test.suite.name} #{test.name}] << BEGIN"
+        end
+        
+        def after_test(test)
+          if test.passed?
+            print "." 
+          elsif test.failed?
+            print "F"
+            @errors << test 
+          end 
+          # puts "[#{test.suite.name} #{test.name}] << END"
+      end
+                
+      end # StdoutFormatter
+    end # Formatters
+  end # Test
+end # Xcode

data/lib/xcode/test/ocunit_report_parser.rb

@@ -11,58 +11,155 @@ module Xcode
   
     class OCUnitReportParser
 
-      attr_reader :exit_code, :reports
+      attr_reader :reports, :end_time, :start_time
+      attr_accessor :debug, :formatters
   
       def initialize
+        @debug = false
         @exit_code = 0
         @reports = []
+        @formatters = []
+        @failed = false
+        @start_time = nil
+        @end_time = nil
+        
+        add_formatter :junit, 'test-reports'
+        add_formatter :stdout
+      end
+      
+      def failed?
+        @failed
+      end
+      
+      def finished?
+        !@end_time.nil?
+      end
+      
+      def duration
+        return Time.now - @start_time if @end_time.nil?
+        @end_time - @start_time
       end
-
-      def write(dir, format=:junit)
-        dir = File.expand_path(dir)
-        FileUtils.mkdir_p(dir)
       
+      def add_formatter(format, *args)
         require "xcode/test/formatters/#{format.to_s}_formatter"
-        formatter = Formatters.const_get("#{format.to_s.capitalize}Formatter").new(dir)
-        @reports.each do |r|
-          formatter.write(r)
+        formatter = Formatters.const_get("#{format.to_s.capitalize}Formatter").new(*args)
+        @formatters << formatter
+      end
+      
+      def flush
+        return if finished?
+        
+        # if there is a current, unfinished test - fail it
+        unless current_test.nil? or current_test.passed?
+          fail_current_test(0) 
+          @failed = true
+        end
+        
+        # if there is a current suite which isnt finished - finish it
+        unless current_suite.nil? or current_suite.finished? 
+          @failed = true # It may not have failed, but we want to indicate an unexpected end
+          current_suite.finish
+          notify_formatters(:after_suite, current_suite)
         end
+        
+        # finish all tests
+        @end_time = Time.now
+        notify_formatters(:after, self)
       end
     
       def <<(piped_row)
+        puts piped_row if @debug
+        
         case piped_row
     
           when /Test Suite '(\S+)'.*started at\s+(.*)/
             name = $1
             time = Time.parse($2)
-            @reports << SuiteResult.new(name, time) unless name=~/\// # ignore if its a file path
-
+            if name=~/\//
+              # all tests begin
+              @start_time = Time.now
+              notify_formatters(:before, self)
+            else
+              @reports << SuiteResult.new(name, time) 
+              notify_formatters(:before_suite, current_suite)
+            end
+            
           when /Test Suite '(\S+)'.*finished at\s+(.*)./
-            @reports.last.finish(Time.parse($2))
+            time = Time.parse($2)
+            name = $1
+            if name=~/\//
+              # all tests ended
+              @end_time = Time.now
+              notify_formatters(:after, self)
+            else
+              @reports.last.finish(time)
+              notify_formatters(:after_suite, current_suite)
+            end
 
           when /Test Case '-\[\S+\s+(\S+)\]' started./
-            test = TestResult.new($1)
+            test = TestResult.new($1, current_suite)
             @reports.last.tests << test
+            notify_formatters(:before_test, test)
 
           when /Test Case '-\[\S+\s+(\S+)\]' passed \((.*) seconds\)/
             @reports.last.tests.last.passed($2.to_f)
+            notify_formatters(:after_test, current_test)
 
           when /(.*): error: -\[(\S+) (\S+)\] : (.*)/
-            @reports.last.tests.last.error(error_message,error_location)
-            @exit_code = 1 # should terminate
+            current_test.add_error($4,$1)
+            @failed = true
+            # notify_formatters(:after_test, @reports.last.tests.last)
             
           when /Test Case '-\[\S+ (\S+)\]' failed \((\S+) seconds\)/
-            @reports.last.tests.last.failed($2.to_f)
-            @exit_code = 1  # should terminate
-
-          when /failed with exit code (\d+)/
-            @exit_code = $1.to_i
+            fail_current_test($2.to_f)
+            @failed = true
+            
+          # when /failed with exit code (\d+)/, 
+          when /BUILD FAILED/ 
+            flush
+            
+          when /Run test case (\w+)/
+            # ignore
+          when /Run test suite (\w+)/
+            # ignore
+          when /Executed (\d+) test, with (\d+) failures \((\d+) unexpected\) in (\S+) \((\S+)\) seconds/
+            # ignore
+          else
+            append_line_to_current_test piped_row
+        end # case
+        
+      end # <<
       
-          when
-            /BUILD FAILED/
-            @exit_code = -1;
+      private 
+      
+      def notify_formatters(event, obj=nil)
+        @formatters.each do |f|
+          f.send event, obj if f.respond_to? event
         end
       end
-    end
-  end
-end
+      
+      def current_suite
+        @reports.last
+      end
+      
+      def current_test
+        @reports.last.tests.last unless current_suite.nil?
+      end
+      
+      def fail_current_test(duration=0)
+        return if current_test.nil?
+        
+        current_test.failed(duration)
+        notify_formatters(:after_test, current_test)
+      end
+      
+      def append_line_to_current_test(line)
+        return if current_suite.nil? or !current_suite.end_time.nil?
+        return if current_test.nil?
+        current_test << line
+      end
+      
+      
+    end # OCUnitReportParser
+  end # Test
+end # Xcode

data/lib/xcode/test/suite_result.rb

@@ -9,13 +9,21 @@ module Xcode
         @tests = []
       end
 
-      def finish(time)
+      def finish(time=Time.now)
         raise "Time is nil" if time.nil?
         @end_time = time
       end
-
-      def total_error_tests
-        @tests.select {|t| t.error? }.count
+      
+      def finished?
+        !@end_time.nil?
+      end
+      
+      def total_errors
+        errors = 0
+        @tests.each do |t| 
+          errors = errors + t.errors.count if t.failed?
+        end
+        errors
       end
 
       def total_passed_tests

data/lib/xcode/test/test_result.rb

@@ -1,10 +1,13 @@
 module Xcode
   module Test
     class TestResult
-      attr_reader :name, :time, :error_message, :error_location
+      attr_reader :name, :time, :errors, :suite, :data
     
-      def initialize(name)
+      def initialize(name, suite)
         @name = name
+        @data = []
+        @suite = suite
+        @errors = []
       end
     
       def passed?
@@ -12,11 +15,7 @@ module Xcode
       end
     
       def failed?
-        error? or !@passed
-      end
-      
-      def error?
-        !@error_message.nil?
+        !@passed
       end
     
       def passed(time)
@@ -28,10 +27,16 @@ module Xcode
         @passed = false
         @time = time
       end
+      
+      def << (line)
+        # puts "[#{@suite.name} #{@name}] << #{line}"
+        return if @data.count==0 and line.strip.empty?
+        @data << line
+      end
     
-      def error(error_message,error_location)
-        @error_message = error_message
-        @error_location = error_location
+      def add_error(error_message,error_location)
+        @errors << {:message => error_message, :location => error_location, :data => @data}
+        @data = []
       end
     end
   end

data/lib/xcode/variant_group.rb

@@ -2,6 +2,10 @@ require_relative 'group'
 
 module Xcode
   
+  #
+  # A VariantGroup is generally a special group reserved for InfoPlist.strings
+  # folders that contain additional files within it that are referenced.
+  # 
   module VariantGroup
     include Group ; extend Group
     

data/lib/xcode/version.rb

@@ -1,3 +1,3 @@
 module Xcode
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/xcoder.rb

@@ -10,20 +10,43 @@ require 'xcode/workspace'
 require 'xcode/buildfile'
 
 module Xcode
+  
   @@projects = nil
   @@workspaces = nil
   @@sdks = nil
   
+  #
+  # Find all the projects within the current working directory.
+  # 
+  # @return [Array<Project>] an array of the all the Projects found.
+  # 
   def self.projects
     @@projects = parse_projects if @@projects.nil?
     @@projects  
   end
   
+  #
+  # Find all the workspaces within the current working directory.
+  # 
+  # @return [Array<Workspaces>] an array of all the Workspaces found.
+  # 
   def self.workspaces
     @@workspaces = parse_workspaces if @@workspaces.nil?
     @@workspaces
   end
   
+  #
+  # Find the project with the specified name within the current working directory.
+  # 
+  # @note this method will raise an error when it is unable to find the project
+  #   specified.
+  # 
+  # @param [String] name of the project (e.g. NAME.xcodeproj) that is attempting
+  #   to be found.
+  # 
+  # @return [Project] the project found; an error is raise if a project is unable
+  #   to be found.
+  # 
   def self.project(name)
     name = name.to_s
     
@@ -35,6 +58,18 @@ module Xcode
     raise "Unable to find a project named #{name}.  However, I did find these projects: #{self.projects.map {|p| p.name}.join(', ') }"
   end
   
+  #
+  # Find the workspace with the specified name within the current working directory.
+  # 
+  # @note this method will raise an error when it is unable to find the workspace
+  #   specified.
+  # 
+  # @param [String] name of the workspace (e.g. NAME.xcworkspace) that is attempting
+  #   to be found.
+  # 
+  # @return [Project] the workspace found; an error is raise if a workspace is unable
+  #   to be found.
+  # 
   def self.workspace(name)
     name = name.to_s
     
@@ -46,15 +81,30 @@ module Xcode
     raise "Unable to find a workspace named #{name}.  However, I did find these workspaces: #{self.workspaces.map {|p| p.name}.join(', ') }"
   end
   
+  #
+  # @param [String] dir the path to search for projects; defaults to using
+  #   the current working directory.
+  # 
+  # @return [Array<Project>] the projects found at the specified directory.
+  #
   def self.find_projects(dir='.')
     parse_projects(dir)
   end
 
+  #
+  # @param [String] sdk name of the sdk that is being asked to see if available.
+  # @return [TrueClass,FalseClass] true if the sdk is available; false otherwise.
+  #
   def self.is_sdk_available?(sdk)
     parse_sdks if @@sdks.nil?
     @@sdks.values.include? sdk
   end
   
+  #
+  # Available SDKs available on this particular system.
+  # 
+  # @return [Array<String>] the available SDKs on the current system.
+  # 
   def self.available_sdks
     parse_sdks if @@sdks.nil?
     @@sdks

data/spec/builder_spec.rb

@@ -86,6 +86,7 @@ describe Xcode::Builder do
       let(:default_clean_parameters) do
         [ "xcodebuild", 
           "-project \"#{configuration.target.project.path}\"", 
+          "-sdk iphoneos",
           "-target \"#{configuration.target.name}\"", 
           "-configuration \"#{configuration.name}\"", 
           "OBJROOT=\"#{File.dirname(configuration.target.project.path)}/build/\"", 
@@ -132,6 +133,7 @@ describe Xcode::Builder do
       let(:default_clean_parameters) do
         [ "xcodebuild",
           "-project \"#{scheme.project.path}\"",
+          "-sdk iphoneos",
           "-scheme #{scheme.name}",
           "OBJROOT=\"#{File.dirname(scheme.project.path)}/build/\"", 
           "SYMROOT=\"#{File.dirname(scheme.project.path)}/build/\"",