xcoder 0.0.21 → 0.1.0

data/.gitignore

@@ -2,3 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+spec/TestProject/TestProject.xcodeproj/xcuserdata
+spec/TestProject/TestProject.xcodeproj/project.xcworkspace/
+spec/TestProject/build

data/Gemfile

@@ -5,4 +5,7 @@ gem 'rspec'
 gem 'builder'
 gem 'json'
 gem 'plist'
-gem 'rest-client'
+gem 'rest-client'
+gem 'guard'
+gem 'guard-rspec'
+gem 'ruby-debug19'

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => "--color --format d --fail-fast" do
+  watch(%r{^spec/.+_spec\.rb$})
+  # As the registry and resource file affect most every file, the entire
+  # suite should be run when they are changed
+  watch(%r{^lib/xcode/(?:registry|resource)\.rb$}) { "spec" }
+  watch(%r{^lib/xcode/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/README.md

@@ -74,6 +74,8 @@ Or, access them by name:
 	
 Note: The builder behaves the same as the builder for the target/config approach and will force xcodebuild to use the local build/ directory (as per xcode3) rather than a generated temporary directory in DerivedData.  This may or may not be a good thing.
 
+Note: Shared schemes and user (current logged in user) specific schemes are both loaded. They may share names and other similarities that make them hard to distinguish. Currently the priority loading order is shared schemes and then user specific schemes.
+
 ### Provisioning profiles
 
 The library provides a mechanism to install/uninstall a provisioning profile.  This normally happens as part of a build (if a profile is provided to the builder, see above), but you can do this manually:

data/Rakefile

@@ -1 +1,16 @@
 require "bundler/gem_tasks"
+
+task :default => :specs
+
+task :specs do
+  system "rspec -c spec"
+end
+
+namespace :test_project do
+  
+  task :reset do
+    system "git co -- spec/TestProject"
+  end
+  
+end
+

data/lib/xcode/build_file.rb

@@ -0,0 +1,22 @@
+module Xcode
+  
+  #
+  # PBXBuildFile are entries within the project that create a link between the
+  # file and the PBXFileReference. One is created for each file added to a build
+  # target.
+  # 
+  module BuildFile
+    
+    #
+    # Create the properties hash for a build file with the given file reference
+    # identifier.
+    # 
+    # @param [String] file_identifier the unique identifier for the file
+    # @return [Hash] the properties hash for a default BuildFile.
+    # 
+    def self.with_properties file_identifier
+      { 'isa' => "PBXBuildFile", 'fileRef' => file_identifier }
+    end
+    
+  end
+end

data/lib/xcode/build_phase.rb

@@ -0,0 +1,46 @@
+module Xcode
+  
+  module BuildPhase
+    
+    #
+    # Return the files that are referenced by the build files. This traverses
+    # the level of indirection to make it easier to get to the FileReference.
+    # 
+    # Another method, file, exists which will return the BuildFile references.
+    # 
+    # @return [Array<FileReference>] the files referenced by the build files.
+    # 
+    def build_files
+      files.map {|file| file.fileRef }
+    end
+    
+    #
+    # Find the first file that has the name or path that matches the specified
+    # parameter. 
+    # 
+    # @param [String] name the name or the path of the file.
+    # @return [FileReference] the file referenced that matches the name or path;
+    #   nil if no file is found.
+    # 
+    def build_file(name)
+      build_files.find {|file| file.name == name || file.path == name }
+    end
+    
+    #
+    # Add the specified file to the Build Phase.
+    # 
+    # First a BuildFile entry is created for the file and then the build file
+    # entry is added to the particular build phase. A BuildFile identifier must
+    # exist for each target.
+    # 
+    # @param [FileReference] file the FileReference Resource to add to the build 
+    # phase.
+    #
+    def add_build_file(file)
+      build_identifier = @registry.add_object BuildFile.with_properties(file.identifier)
+      @properties['files'] << build_identifier 
+    end
+    
+  end
+  
+end

data/lib/xcode/builder.rb

@@ -12,6 +12,8 @@ module Xcode
         @scheme = config
         config = config.launch
       end
+      
+      puts "CONFIG: #{config}"
       @target = config.target
       @sdk = @target.project.sdk
       @config = config

data/lib/xcode/configuration.rb

@@ -1,14 +1,115 @@
 require 'xcode/builder'
 
 module Xcode
-  class Configuration
-    attr_reader :target
+  
+  #
+  # Projects have a number of build configurations. These configurations are 
+  # usually the default 'Debug' and 'Release'. However, custom ones can be 
+  # defined.
+  # 
+  # @see https://developer.apple.com/library/ios/#documentation/ToolsLanguages/Conceptual/Xcode4UserGuide/Building/Building.html
+  # 
+  # Each configuration is defined and then a reference of that configuration is
+  # maintained in the Target through the XCConfigurationList.
+  # 
+  # @example Xcode configuration
+  #                                                                
+  #     E21D8ABB14E0F817002E56AA /* Debug */ = {                     
+  #       isa = XCBuildConfiguration;                                
+  #       buildSettings = {                                          
+  #         "CODE_SIGN_IDENTITY[sdk=iphoneos*]" = "iPhone Developer";
+  #         GCC_PRECOMPILE_PREFIX_HEADER = YES;                      
+  #         GCC_PREFIX_HEADER = "newtarget/newtarget-Prefix.pch";    
+  #         INFOPLIST_FILE = "newtarget/newtarget-Info.plist";       
+  #         PRODUCT_NAME = "$(TARGET_NAME)";                         
+  #         WRAPPER_EXTENSION = app;                                 
+  #       };                                                         
+  #       name = Debug;                                              
+  #     };                                                           
+  # 
+  module Configuration
+
+    #
+    # The configuration is defined within a target.
+    # @see PBXNativeTarget
+    # 
+    attr_accessor :target
+    
+    #
+    # @return the location for the InfoPlist file for the configuration.
+    # @see InfoPlist
+    # 
+    def info_plist_location
+      buildSettings['INFOPLIST_FILE']
+    end
     
-    def initialize(target, json)
-      @target = target
-      @json = json
+    #
+    # Opens the info plist associated with the configuration and allows you to 
+    # edit the configuration.
+    # 
+    # @example Editing the configuration
+    # 
+    #     config = Xcode.project('MyProject.xcodeproj').target('Application').config('Debug')
+    #     config.info_plist do |plist|
+    #       puts plist.version  # => 1.0
+    #       plist.version = 1.1
+    #       marketing_version = 12.1
+    #     end
+    # 
+    # @see InfoPlist
+    # 
+    def info_plist
+      # puts @json.inspect
+      info = Xcode::InfoPlist.new(self, info_plist_location)  
+      yield info if block_given?
+      info.save
+      info
     end
     
+    #
+    # @return the name of the product that this configuration will generate.
+    # 
+    def product_name
+      substitute(buildSettings['PRODUCT_NAME'])
+    end
+    
+    def set_other_linker_flags(value)
+      set 'OTHER_LDFLAGS', value
+    end
+    
+    def get(name)
+      buildSettings[name]
+    end
+    
+    def set name, value
+      buildSettings[name] = value
+    end
+    
+    
+    #
+    # Create a builder for this given project->target->configuration.
+    # 
+    # @return [Builder] this is a builder for the configuration.
+    # @see Builder
+    # 
+    def builder
+      puts "Making a Builder with #{self} #{self.methods}"
+      Xcode::Builder.new(self)
+    end
+    
+    
+    private
+    
+    #
+    # Within the configuration properties variables reference the target,
+    # i.e."$(TARGET_NAME)". This method will find and replace the target
+    # constant with the appropriate value.
+    # 
+    # @param [String] value is a property of the configuration that may contain
+    #   the target variable to replace.
+    # 
+    # @return [String] a string without the variable reference.
+    #
     def substitute(value)
       if value=~/\$\(.*\)/
         value.gsub(/\$\((.*)\)/) do |match|
@@ -23,29 +124,6 @@ module Xcode
         value
       end
     end
-        
-    def info_plist_location
-      @json['buildSettings']['INFOPLIST_FILE']
-    end
-    
-    def product_name
-      substitute(@json['buildSettings']['PRODUCT_NAME'])
-    end
-        
-    def name
-      @json['name']
-    end
-    
-    def info_plist
-      # puts @json.inspect
-      info = Xcode::InfoPlist.new(self, info_plist_location)  
-      yield info if block_given?
-      info.save
-      info
-    end
-    
-    def builder
-      Xcode::Builder.new(self)
-    end
+
   end
-end
+end

data/lib/xcode/core_ext/array.rb

@@ -0,0 +1,23 @@
+class Array
+  
+  #
+  # Arrays in an Xcode project take a particular format.
+  # 
+  # @note the last element in the array can have a comma; it is optional.
+  # 
+  # @example output format:
+  # 
+  #     (
+  #       ITEM1,
+  #       ITEM2,
+  #       ITEM3
+  #     )
+  # 
+  def to_xcplist
+    plist_of_items = map {|item| item.to_xcplist }.join(",\n")
+    
+    %{(
+      #{plist_of_items}
+    )}
+  end
+end

data/lib/xcode/core_ext/boolean.rb

@@ -0,0 +1,21 @@
+
+
+class TrueClass
+  
+  #
+  # Xcode project's expect boolean trues to be the word YES.
+  # 
+  def to_xcplist
+    "YES"
+  end
+end
+
+class FalseClass
+  
+  #
+  # Xcode project's expect boolean trues to be the word NO.
+  # 
+  def to_xcplist
+    "NO"
+  end
+end

data/lib/xcode/core_ext/fixnum.rb

@@ -0,0 +1,5 @@
+class Fixnum
+  def to_xcplist
+    to_s
+  end
+end

data/lib/xcode/core_ext/hash.rb

@@ -0,0 +1,27 @@
+class Hash
+  
+  # 
+  # Hashes in an Xcode project take a particular format.
+  # 
+  # @note the keys are represeted in this output with quotes; this is actually
+  #   optional for certain keys based on their format. This is done to ensure
+  #   that all keys that do not conform are ensured proper output.
+  # 
+  # @example output format:
+  # 
+  #     {
+  #       "KEY" = "VALUE";
+  #       "KEY" = "VALUE";
+  #       "KEY" = "VALUE";
+  #     }
+  # 
+  def to_xcplist
+    plist_of_items = map do |k,v| 
+      "\"#{k}\" = #{v.to_xcplist};"
+    end.join("\n")
+    
+    %{{
+      #{plist_of_items}
+    }}
+  end
+end

data/lib/xcode/core_ext/string.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+class String
+  
+  #
+  # Xcode format for a string is exactly the same as you would expect in JSON
+  # 
+  def to_xcplist
+    to_json
+  end
+end

data/lib/xcode/file_reference.rb

@@ -0,0 +1,29 @@
+module Xcode
+  
+  #
+  # Within the project file the PBXFileReference represents the object 
+  # representation to the file on the file sytem. This is usually your source
+  # files within your project.
+  # 
+  module FileReference
+    
+    # This is the group for which this file is contained within.
+    attr_accessor :supergroup
+    
+    def self.with_properties_for_framework(name)
+      { 'isa' => "PBXFileReference",
+        'lastKnownFileType' => "wrapper.framework",
+        'name' => "#{name}.framework",
+        'path' => "System/Library/Frameworks/#{name}.framework",
+        'sourceTree' => "SDKROOT" }
+    end
+    
+    def self.with_properties_for_path(path)
+      { 'isa' => 'PBXFileReference', 
+        'path' => path,
+        'sourceTree' => '<group>' }
+    end
+    
+  end
+  
+end

data/lib/xcode/group.rb

@@ -0,0 +1,118 @@
+module Xcode
+  
+  #
+  # Within the project file there are logical separation of resources into groups
+  # these groups may contain subgroups, files, or other objects. They have
+  # children.
+  # 
+  # PBXGroup here provides the methods to traverse the groups to find these 
+  # children resources as well as provide the ability to generate child
+  # resources.
+  # 
+  module Group
+    
+    #
+    # Return the hash that maps to the properties for a logical group
+    # 
+    # @param [String] name of the logical group
+    # 
+    def self.with_properties_for_logical_group(name)
+      { 'isa' => 'PBXGroup', 
+        'name' => name,
+        'sourceTree' => '<group>',
+        'children' => [] }
+    end
+    
+    
+    # This is the group for which this file is contained within.
+    attr_accessor :supergroup
+    
+    # 
+    # @example Return all the sub-groups of the main group
+    # 
+    #   main_group = Xcode.project('MyProject.xcodeproj').groups
+    #   main_group.groups
+    # 
+    # @return [Array] the sub-groups contained within this group.
+    # 
+    def groups
+      children.map do |group|
+        # TODO: this will return all children when it should just return subgroups
+        group.supergroup = self
+        group
+      end
+    end
+    
+    #
+    # Find all the child groups that have a name that matches the specified name.
+    # 
+    # @param [String] name of the group that you are looking to return.
+    # @return [Array<PBXGroup>] the groups with the same matching name. This
+    #   could be no groups, one group, or multiple groups.
+    #
+    def group(name)
+      groups.find_all {|group| group.name == name }
+    end
+    
+    
+    #
+    # Adds a group as a child to current group with the given name. 
+    # 
+    # @note A group may be added that has the same name as another group as they
+    #   are distinguished by a unique identifier and not by name.
+    # 
+    # @param [String] name of the group that you want to add as a child group of
+    #   the specified group.
+    #
+    def add_group(name)
+      
+      # Groups that represent a physical path often have the key 'path' with
+      # the value being it's path name.
+      # 
+      # Groups that represent a logical group often have the key 'name' with 
+      # the value being it's group name.
+      
+      new_identifier = @registry.add_object Group.with_properties_for_logical_group(name)
+      
+      # Add the group's identifier to the list of children
+      
+      @properties['children'] << new_identifier
+      
+      # Find the newly added group to return
+      
+      groups.find {|group| group.identifier == new_identifier }
+      
+    end
+    
+    #
+    # Add a file to the specified group. Currently the file creation requires
+    # the path to the physical file.
+    # 
+    # @param [String] path to the file that is being added.
+    #
+    def add_file(path)
+      
+      new_identifier = @registry.add_object FileReference.with_properties_for_path(path)
+        
+      @properties['children'] << new_identifier
+      
+      children.find {|file| file.identifier == new_identifier }
+      
+    end
+    
+    
+    def add_framework framework_name
+      new_identifier = @registry.add_object FileReference.with_properties_for_framework(framework_name)
+      
+      # Add the framework to the group
+      
+      @properties['children'] << new_identifier
+      
+      children.find {|file| file.identifier == new_identifier }
+      
+    end
+    
+    
+  end
+  
+end