xcoder 0.1.1 → 0.1.2

data/lib/xcode/file_reference.rb

@@ -0,0 +1,77 @@
+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.file(properties)
+      default_properties = { 'isa' => 'PBXFileReference', 
+        'path' => nil,
+        'sourceTree' => '<group>' }
+  
+      default_properties.merge(properties)
+    end
+    
+    #
+    # Generate the properties for a framework. A name and a path option need
+    # to be specified in the properties
+    # 
+    # @note a 'name' and 'path' key need to be specified in the framework for
+    #   the framework to be added correctly.
+    # 
+    # @param [Hash] properties to override for the Framework
+    # @return [Hash] properties for a framework
+    #
+    def self.framework(properties)
+      default_properties = { 'isa' => "PBXFileReference",
+        'lastKnownFileType' => "wrapper.framework",
+        'name' => "FRAMEWORK.framework",
+        'path' => "FRAMEWORK.framework",
+        'sourceTree' => "<group>" }
+        
+      default_properties.merge(properties)
+    end
+    
+    #
+    # Generate the properties for a system framework.
+    # 
+    # @param [String] name of the system framework
+    # @param [Hash] properties the parameters to override for the system framework
+    #
+    def self.system_framework(name,properties = {})
+      default_properties = { 'isa' => 'PBXFileReference',
+        'lastKnownFileType' => 'wrapper.framework', 
+        'name' => "#{name}.framework",
+        'path' => "System/Library/Frameworks/#{name}.framework",
+        "sourceTree" => "SDKROOT" }
+        
+      default_properties.merge(properties)
+    end
+    
+    #
+    # @example app product properties
+    # 
+    #     E21D8AAA14E0F817002E56AA /* newtarget.app */ = {
+    #       isa = PBXFileReference; 
+    #       explicitFileType = wrapper.application; 
+    #       includeInIndex = 0; 
+    #       path = newtarget.app; 
+    #       sourceTree = BUILT_PRODUCTS_DIR; };
+    # 
+    def self.app_product(name)
+      { 'isa' => 'PBXFileReference',
+        'explicitFileType' => 'wrapper.application',
+        'includeInIndex' => 0,
+        'path' => "#{name}.app",
+        'sourceTree' => "BUILT_PRODUCTS_DIR" }
+    end
+    
+  end
+  
+end

data/lib/xcode/group.rb

@@ -0,0 +1,197 @@
+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.
+  # 
+  # Group here provides the methods to traverse the groups to find these 
+  # children resources as well as provide the ability to generate child
+  # resources.
+  # 
+  #     7165D451146B4EA100DE2F0E /* Products */ = {
+  #       isa = PBXGroup;
+  #       children = (
+  #         7165D450146B4EA100DE2F0E /* TestProject.app */,
+  #         7165D46B146B4EA100DE2F0E /* TestProjectTests.octest */,
+  #         E21EB9D614E357CF0058122A /* Specs.app */,
+  #       );
+  #       name = Products;
+  #       sourceTree = "<group>";
+  #     };
+  # 
+  module Group
+    
+    #
+    # Return the hash that maps to the properties for a logical group
+    # 
+    # @param [String] name of the logical group
+    # 
+    def self.logical_group(name)
+      { 'isa' => 'PBXGroup', 
+        'name' => name,
+        'sourceTree' => '<group>',
+        'children' => [] }
+    end
+    
+    
+    # This is the group for which this file is contained within.
+    # @note this value is only set if the group has been discovered 
+    #   by traversing groups to this group.
+    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.find_all {|child| child.is_a?(Group) }.map do |group|
+        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<Group>] 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 or group.path == name }
+    end
+    
+    #
+    # Find all the non-group objects within the group and return them
+    # @return [Array] the children of the group, excluding the groups
+    # 
+    def files
+      children.reject {|child| child.is_a?(Group) }
+    end
+    
+    #
+    # Find all the files that have have a name that matches the specified name.
+    #
+    # @param [String] name of the file that you are looking to return.
+    # @return [Array<FileReference>] the files with the same mathching
+    #   name. This could be no files, one file, or multiple files.
+    #
+    def file(name)
+      files.find_all {|file| file.name == name or file.path == name }
+    end
+    
+    #
+    # Check whether a file or group is contained within this group.
+    #
+    def exists?(name)
+      children.find_all {|child| child.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 create_group(name)
+      new_group = create_child_object Group.logical_group(name)
+      new_group.supergroup = self
+      new_group
+    end
+    
+    #
+    # Add a file to the specified group. Currently the file creation requires
+    # the path to the physical file.
+    # 
+    # @param [String,Hash] path to the file that is being added or a hash that 
+    #   contains the values would be merged with the default values.
+    #
+    def create_file(file_properties)
+      # This allows both support for the string value or the hash as the parameter
+      file_properties = { 'path' => file_properties } if file_properties.is_a? String
+      
+      # IF the file already exists then we will not create the file with the
+      # parameters that are being supplied, instead we will return what we
+      # found.
+      
+      find_file_by = file_properties['name'] || file_properties['path']
+      found_or_created_file = exists?(find_file_by).first
+      
+      unless found_or_created_file
+        found_or_created_file = create_child_object FileReference.file(file_properties)
+      end
+      
+      found_or_created_file
+    end
+    
+    #
+    # Create a framework within this group.
+    # 
+    # @param [Hash] framework_properties the properties to merge with the default
+    #   properties.
+    #
+    def create_framework(framework_properties)
+      create_child_object FileReference.framework(framework_properties)
+    end
+    
+    #
+    # Create a system framework reference within this group
+    #
+    # @param [String] name the name of the System framework to add to this group.
+    #
+    def create_system_framework(name)
+      create_child_object FileReference.system_framework(name)
+    end
+    
+    #
+    # Create an infoplist within this group.
+    # 
+    # @param [Hash] infoplist_properties the properties to merge with the default
+    #   properties.
+    # 
+    # @see VariantGroup#info_plist
+    #
+    def create_infoplist(infoplist_properties)
+      create_child_object VariantGroup.info_plist(infoplist_properties)
+    end
+    
+    #
+    # Create a product reference witin this group.
+    # 
+    # @note this is usually performed through the target as it is necessary within
+    #   the target to specify what is the product reference.
+    # 
+    # @see Target#create_product_reference
+    # 
+    # @param [String] name the name of the product to generate
+    # 
+    def create_product_reference(name)
+      create_child_object FileReference.app_product(name)
+    end
+    
+    private
+    
+    #
+    # This method is used internally to add objects to the registry and add the
+    # object as a child of this group.
+    # 
+    # @param [Hash] child_as_properties the hash of resource to add as a child
+    #   object of this group.
+    # 
+    # @return [Resource] returns the resource that was added a child
+    def create_child_object(child_properties)
+      child_object = @registry.add_object child_properties
+      @properties['children'] << child_object.identifier
+      child_object
+    end
+    
+  end
+  
+end

data/lib/xcode/info_plist.rb

@@ -0,0 +1,41 @@
+require 'plist'
+require 'pp'
+
+module Xcode
+  
+  #
+  # @see https://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html
+  # 
+  class InfoPlist
+    def initialize(config, plist_location)
+      @config = config
+      
+      @plist_location = File.expand_path("#{File.dirname(@config.target.project.path)}/#{plist_location}")
+      unless File.exists?(@plist_location)
+        puts 'Plist not found ' + @plist_location
+        exit 1
+      end
+      @plist = Plist::parse_xml(@plist_location)
+    end
+
+    def marketing_version
+      @plist['CFBundleShortVersionString']
+    end
+
+    def marketing_version=(version)
+      @plist['CFBundleShortVersionString'] = version
+    end
+
+    def version
+      @plist['CFBundleVersion']
+    end
+
+    def version=(version)
+      @plist['CFBundleVersion'] = version.to_s
+    end
+
+    def save
+      File.open(@plist_location, 'w') {|f| f << @plist.to_plist}
+    end
+  end
+end

data/lib/xcode/keychain.rb

@@ -0,0 +1,122 @@
+module Xcode
+  class Keychain
+    attr_accessor :name, :path
+    
+    TEMP_PASSWORD = "build_keychain_password"
+    
+    #
+    # Open the keychain with the specified name.  It is assumed that keychains reside in the 
+    # ~/Library/Keychains directory
+    # 
+    # @param [String] the name of the keychain
+    #
+    def initialize(name)
+      @name = name
+      @path = File.expand_path "~/Library/Keychains/#{name}"
+    end
+    
+    #
+    # Import the .p12 certificate file into the keychain using the provided password
+    # 
+    # @param [String] the path to the .p12 certificate file
+    # @param [String] the password to open the certificate file
+    #
+    def import(cert, password)
+      cmd = []
+      cmd << "security"
+      cmd << "import '#{cert}'"
+      cmd << "-k '#{@path}'"
+      cmd << "-P #{password}"
+      cmd << "-T /usr/bin/codesign"
+      Xcode::Shell.execute(cmd)
+    end
+    
+    #
+    # Returns a list of identities in the keychain. 
+    # 
+    # @return [Array<String>] a list of identity names
+    #
+    def identities
+      names = []
+      cmd = []
+      cmd << "security"
+      cmd << "find-certificate"
+      cmd << "-a"
+      cmd << "#{@name}"
+      data = Xcode::Shell.execute(cmd, false).join("")
+      data.scan /\s+"labl"<blob>="([^"]+)"/ do |m|
+        names << m[0]
+      end
+      names
+    end
+    
+    #
+    # Unlock the keychain using the provided password
+    # 
+    # @param [String] the password to open the keychain
+    #
+    def unlock(password)
+      cmd = []
+      cmd << "security"
+      cmd << "unlock-keychain"
+      cmd << "-p #{password}"
+      cmd << "#{@name}"
+      Xcode::Shell.execute(cmd)
+    end
+    
+    #
+    # Create a new keychain with the given name and password
+    # 
+    # @param [String] the name for the new keychain
+    # @param [String] the password for the new keychain
+    # @return [Xcode::Keychain] an object representing the new keychain
+    #
+    def self.create(name, password)
+      cmd = []
+      cmd << "security"
+      cmd << "create-keychain"
+      cmd << "-p #{password}"
+      cmd << "#{name}"
+      Xcode::Shell.execute(cmd)
+      
+      Xcode::Keychain.new(name)
+    end
+    
+    #
+    # Remove the keychain from the filesystem
+    #
+    # FIXME: dangerous
+    #
+    def delete
+      cmd = []
+      cmd << "security"
+      cmd << "delete-keychain #{name}"
+      Xcode::Shell.execute(cmd)
+    end
+    
+    #
+    # Creates a keychain with the given name that lasts for the duration of the provided block.  
+    # The keychain is deleted even if the block throws an exception.
+    # 
+    # @param [String] the name of the temporary keychain to create
+    #
+    def self.temp_keychain(name, &block)
+      kc = Xcode::Keychain.create(name, TEMP_PASSWORD)
+      begin
+        kc.unlock(TEMP_PASSWORD)
+        block.call(kc)
+      ensure
+        kc.delete
+      end
+    end
+    
+    #
+    # Opens the default login.keychain for current user
+    # 
+    # @return [Xcode::Keychain] the current user's login keychain
+    #
+    def self.login_keychain
+      Xcode::Keychain.new("login.keychain")
+    end
+  end
+end

data/lib/xcode/parsers/plutil_project_parser.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'plist'
+
+module Xcode
+  
+  module PLUTILProjectParser
+    extend self
+  
+    #
+    # Using the sytem tool plutil, the specified project file is parsed and 
+    # converted to XML, and then converted into a ruby hash object.
+    # 
+    def parse path
+      xml = `plutil -convert xml1 -o - "#{path}"`
+      Plist::parse_xml(xml)
+    end
+  
+  end
+  
+end