xcodeproj 0.28.2 → 1.0.0

data/lib/xcodeproj/scheme/environment_variables.rb

@@ -0,0 +1,170 @@
+require 'xcodeproj/scheme/xml_element_wrapper'
+
+module Xcodeproj
+  class XCScheme
+    VARIABLES_NODE = 'EnvironmentVariables'
+    VARIABLE_NODE = 'EnvironmentVariable'
+
+    # This class wraps the EnvironmentVariables node of a .xcscheme XML file. This
+    # is just a container of EnvironmentVariable objects. It can either appear on a
+    # LaunchAction or TestAction scheme group.
+    #
+    class EnvironmentVariables < XMLElementWrapper
+      # @param [nil,REXML::Element,Array<EnvironmentVariable>,Array<Hash{Symbol => String,Bool}>] node_or_variables
+      #        The 'EnvironmentVariables' XML node, or list of environment variables, that this object represents.
+      #          - If nil, an empty 'EnvironmentVariables' XML node will be created
+      #          - If an REXML::Element, it must be named 'EnvironmentVariables'
+      #          - If an Array of objects or Hashes, they'll each be passed to {#assign_variable}
+      #
+      def initialize(node_or_variables = nil)
+        create_xml_element_with_fallback(node_or_variables, VARIABLES_NODE) do
+          @all_variables = []
+          node_or_variables.each { |var| assign_variable(var) } unless node_or_variables.nil?
+        end
+      end
+
+      # @return [Array<EnvironmentVariable>]
+      #         The key value pairs currently set in @xml_element
+      #
+      def all_variables
+        @all_variables ||= @xml_element.get_elements(VARIABLE_NODE).map { |variable| EnvironmentVariable.new(variable) }
+      end
+
+      # Adds a given variable to the set of environment variables, or replaces it if that key already exists
+      #
+      # @param [EnvironmentVariable,Hash{Symbol => String,Bool}] variable
+      #        The variable to add or update, backed by an EnvironmentVariable node.
+      #          - If an EnvironmentVariable, the previous reference will still be valid
+      #          - If a Hash, must conform to {EnvironmentVariable#initialize} requirements
+      # @return [Array<EnvironmentVariable>]
+      #         The new set of environment variables after addition
+      #
+      def assign_variable(variable)
+        env_var = variable.is_a?(EnvironmentVariable) ? variable : EnvironmentVariable.new(variable)
+        all_variables.each { |existing_var| remove_variable(existing_var) if existing_var.key == env_var.key }
+        @xml_element.add_element(env_var.xml_element)
+        @all_variables << env_var
+      end
+
+      # Removes a specified variable (by string or object) from the set of environment variables
+      #
+      # @param [EnvironmentVariable,String] variable
+      #        The variable to remove
+      # @return [Array<EnvironmentVariable>]
+      #         The new set of environment variables after removal
+      #
+      def remove_variable(variable)
+        env_var = variable.is_a?(EnvironmentVariable) ? variable : all_variables.find { |var| var.key == variable }
+        raise "Unexpected parameter type: #{env_var.class}" unless env_var.is_a?(EnvironmentVariable)
+        @xml_element.delete_element(env_var.xml_element)
+        @all_variables -= [env_var]
+      end
+
+      # @param [String] key
+      #        The key to lookup
+      # @return [EnvironmentVariable] variable
+      #         Returns the matching environment variable for a specified key
+      #
+      def [](key)
+        all_variables.find { |var| var.key == key }
+      end
+
+      # Assigns a value for a specified key
+      #
+      # @param [String] key
+      #        The key to update in the environment variables
+      # @param [String] value
+      #        The value to lookup
+      # @return [EnvironmentVariable] variable
+      #         The newly updated environment variable
+      #
+      def []=(key, value)
+        assign_variable(:key => key, :value => value)
+        self[key]
+      end
+
+      # @return [Array<Hash{Symbol => String,Bool}>]
+      #         The current environment variables represented as an array
+      #
+      def to_a
+        all_variables.map(&:to_h)
+      end
+    end
+
+    # This class wraps the EnvironmentVariable node of a .xcscheme XML file.
+    # Environment variables are accessible via the NSDictionary returned from
+    # [[NSProcessInfo processInfo] environment] in your app code.
+    #
+    class EnvironmentVariable < XMLElementWrapper
+      # @param [nil,REXML::Element,Hash{Symbol => String,Bool}] node_or_variable
+      #        - If nil, it will create a default XML node to use
+      #        - If a REXML::Element, should be a <EnvironmentVariable> XML node to wrap
+      #        - If a Hash, must contain keys :key and :value (Strings) and optionally :enabled (Boolean)
+      #
+      def initialize(node_or_variable)
+        create_xml_element_with_fallback(node_or_variable, VARIABLE_NODE) do
+          raise "Must pass a Hash with 'key' and 'value'!" unless node_or_variable.is_a?(Hash) &&
+              node_or_variable.key?(:key) && node_or_variable.key?(:value)
+
+          @xml_element.attributes['key'] = node_or_variable[:key]
+          @xml_element.attributes['value'] = node_or_variable[:value]
+
+          @xml_element.attributes['isEnabled'] = if node_or_variable.key?(:enabled)
+                                                   bool_to_string(node_or_variable[:enabled])
+                                                 else
+                                                   bool_to_string(true)
+                                                 end
+        end
+      end
+
+      # Returns the EnvironmentValue's key
+      # @return [String]
+      #
+      def key
+        @xml_element.attributes['key']
+      end
+
+      # Sets the EnvironmentValue's key
+      # @param [String] key
+      #
+      def key=(key)
+        @xml_element.attributes['key'] = key
+      end
+
+      # Returns the EnvironmentValue's value
+      # @return [String]
+      #
+      def value
+        @xml_element.attributes['value']
+      end
+
+      # Sets the EnvironmentValue's value
+      # @param [String] value
+      #
+      def value=(value)
+        @xml_element.attributes['value'] = value
+      end
+
+      # Returns the EnvironmentValue's enabled state
+      # @return [Bool]
+      #
+      def enabled
+        string_to_bool(@xml_element.attributes['isEnabled'])
+      end
+
+      # Sets the EnvironmentValue's enabled state
+      # @param [Bool] enabled
+      #
+      def enabled=(enabled)
+        @xml_element.attributes['isEnabled'] = bool_to_string(enabled)
+      end
+
+      # @return [Hash{:key => String, :value => String, :enabled => Bool}]
+      #         The environment variable XML node with attributes converted to a representative Hash
+      #
+      def to_h
+        { :key => key, :value => value, :enabled => enabled }
+      end
+    end
+  end
+end

data/lib/xcodeproj/scheme/launch_action.rb

@@ -62,6 +62,22 @@ module Xcodeproj
         @xml_element.add_element(runnable.xml_element) if runnable
       end
 
+      # @return [EnvironmentVariables]
+      #         Returns the EnvironmentVariables that will be defined at app launch
+      #
+      def environment_variables
+        EnvironmentVariables.new(@xml_element.elements[XCScheme::VARIABLES_NODE])
+      end
+
+      # @param [EnvironmentVariables,nil] env_vars
+      #        Sets the EnvironmentVariables that will be defined at app launch
+      #
+      def environment_variables=(env_vars)
+        @xml_element.delete_element(XCScheme::VARIABLES_NODE)
+        @xml_element.add_element(env_vars.xml_element) if env_vars
+        env_vars
+      end
+
       # @todo handle 'AdditionalOptions' tag
     end
   end

data/lib/xcodeproj/scheme/test_action.rb

@@ -1,4 +1,5 @@
 require 'xcodeproj/scheme/abstract_scheme_action'
+require 'xcodeproj/scheme/environment_variables'
 
 module Xcodeproj
   class XCScheme
@@ -84,6 +85,23 @@ module Xcodeproj
         @xml_element.add_element(macro_expansion.xml_element)
       end
 
+      # @return [EnvironmentVariables]
+      #         Returns the EnvironmentVariables that will be defined at test launch
+      #
+      def environment_variables
+        EnvironmentVariables.new(@xml_element.elements[XCScheme::VARIABLES_NODE])
+      end
+
+      # @param [EnvironmentVariables,nil] env_vars
+      #        Sets the EnvironmentVariables that will be defined at test launch
+      # @return [EnvironmentVariables]
+      #
+      def environment_variables=(env_vars)
+        @xml_element.delete_element(XCScheme::VARIABLES_NODE)
+        @xml_element.add_element(env_vars.xml_element) if env_vars
+        env_vars
+      end
+
       #-------------------------------------------------------------------------#
 
       class TestableReference < XMLElementWrapper

data/lib/xcodeproj/scheme.rb

@@ -300,11 +300,11 @@ module Xcodeproj
     #   scheme.save_as('path/to/Project.xcodeproj') #=> true
     #
     def save_as(project_path, name, shared = true)
-      if shared
-        scheme_folder_path = self.class.shared_data_dir(project_path)
-      else
-        scheme_folder_path = self.class.user_data_dir(project_path)
-      end
+      scheme_folder_path = if shared
+                             self.class.shared_data_dir(project_path)
+                           else
+                             self.class.user_data_dir(project_path)
+                           end
       scheme_folder_path.mkpath
       scheme_path = scheme_folder_path + "#{name}.xcscheme"
       File.open(scheme_path, 'w') do |f|

data/lib/xcodeproj/workspace/file_reference.rb

@@ -76,10 +76,9 @@ module Xcodeproj
         when 'absolute'
           File.expand_path(path)
         when 'developer'
-          raise 'Developer workspace file reference type is not yet ' \
-            "#{self}"
+          raise "Developer workspace file reference type is not yet supported (#{path})"
         else
-          raise "Unsupported workspace file reference type #{type}"
+          raise "Unsupported workspace file reference type `#{type}`"
         end
       end
     end

data/lib/xcodeproj/workspace/group_reference.rb

@@ -0,0 +1,64 @@
+module Xcodeproj
+  class Workspace
+    # Describes a group reference of a Workspace.
+    #
+    class GroupReference
+      # @return [String] the name of the group
+      #
+      attr_reader :name
+
+      # @return [String] the type of reference to the project
+      #
+      # This can be of the following values:
+      # - absolute
+      # - group
+      # - container (only supported value)
+      # - developer
+      #
+      attr_reader :type
+
+      # @param [#to_s] name @see name
+      # @param [#to_s] type @see type
+      #
+      def initialize(name, type = 'container')
+        @name = name.to_s
+        @type = type.to_s
+      end
+
+      # @return [Bool] Whether a group reference is equal to another.
+      #
+      def ==(other)
+        name == other.name && type == other.type
+      end
+      alias_method :eql?, :==
+
+      # @return [Fixnum] A hash identical for equals objects.
+      #
+      def hash
+        [name, type].hash
+      end
+
+      # Returns a group reference given XML representation.
+      #
+      # @param  [REXML::Element] xml_node
+      #         the XML representation.
+      #
+      # @return [GroupReference] The new group reference instance.
+      #
+      def self.from_node(xml_node)
+        type = xml_node.attribute('location').value.split(':', 2).first
+        name = xml_node.attribute('name').value
+        new(name, type)
+      end
+
+      # @return [REXML::Element] the XML representation of the group reference.
+      #
+      def to_node
+        REXML::Element.new('Group').tap do |element|
+          element.add_attribute('location', "#{type}:")
+          element.add_attribute('name', "#{name}")
+        end
+      end
+    end
+  end
+end

data/lib/xcodeproj/workspace.rb

@@ -1,24 +1,56 @@
 require 'fileutils'
 require 'rexml/document'
 require 'xcodeproj/workspace/file_reference'
+require 'xcodeproj/workspace/group_reference'
 
 module Xcodeproj
   # Provides support for generating, reading and serializing Xcode Workspace
   # documents.
   #
   class Workspace
-    # @return [Array<String>] the paths of the projects contained in the
+    # @return [REXML::Document] the parsed XML model for the workspace contents
+    attr_reader :document
+
+    # @return [Hash<String => String>] a mapping from scheme name to project full path
+    #         containing the scheme
+    attr_reader :schemes
+
     # @return [Array<FileReference>] the paths of the projects contained in the
     #         workspace.
     #
-    attr_reader :file_references
-    attr_reader :schemes
+    def file_references
+      return [] unless @document
+      @document.get_elements('/Workspace//FileRef').map do |node|
+        FileReference.from_node(node)
+      end
+    end
+
+    # @return [Array<GroupReference>] the groups contained in the workspace
+    #
+    def group_references
+      return [] unless @document
+      @document.get_elements('/Workspace//Group').map do |node|
+        GroupReference.from_node(node)
+      end
+    end
 
-    # @param  [Array] file_references @see file_references
+    # @param [REXML::Document] document @see document
+    # @param [Array<FileReference>] file_references additional projects to add
+    #
+    # @note The document parameter is passed to the << operator if it is not a
+    #       valid REXML::Document. It is optional, but may also be passed as nil
     #
-    def initialize(*file_references)
-      @file_references = file_references.flatten
+    def initialize(document, *file_references)
       @schemes = {}
+      if document.nil?
+        @document = REXML::Document.new(root_xml(''))
+      elsif document.is_a?(REXML::Document)
+        @document = document
+      else
+        @document = REXML::Document.new(root_xml(''))
+        self << document
+      end
+      file_references.each { |ref| self << ref }
     end
 
     #-------------------------------------------------------------------------#
@@ -31,9 +63,10 @@ module Xcodeproj
     # @return [Workspace] the generated workspace.
     #
     def self.new_from_xcworkspace(path)
-      from_s(File.read(File.join(path, 'contents.xcworkspacedata')), File.expand_path(File.dirname(path)))
+      from_s(File.read(File.join(path, 'contents.xcworkspacedata')),
+             File.expand_path(File.dirname(path)))
     rescue Errno::ENOENT
-      new
+      new(nil)
     end
 
     #-------------------------------------------------------------------------#
@@ -48,28 +81,53 @@ module Xcodeproj
     #
     def self.from_s(xml, workspace_path = '')
       document = REXML::Document.new(xml)
-      file_references = document.get_elements('/Workspace/FileRef').map do |node|
-        FileReference.from_node(node)
-      end
-      instance = new(file_references)
+      instance = new(document)
       instance.load_schemes(workspace_path)
       instance
     end
 
-    #-------------------------------------------------------------------------#
-
     # Adds a new path to the list of the of projects contained in the
     # workspace.
+    # @param [String, Xcodeproj::Workspace::FileReference] path_or_reference
+    #        A string or Xcode::Workspace::FileReference containing a path to an Xcode project
     #
-    # @param  [String] projpath
-    #         The path of the project to add.
+    # @raise [ArgumentError] Raised if the input is neither a String nor a FileReference
     #
     # @return [void]
     #
-    def <<(projpath)
-      project_file_reference = Xcodeproj::Workspace::FileReference.new(projpath)
-      @file_references << project_file_reference
-      load_schemes_from_project File.expand_path(projpath)
+    def <<(path_or_reference)
+      return unless @document && @document.respond_to?(:root)
+      case
+      when path_or_reference.is_a?(String)
+        project_file_reference = Xcodeproj::Workspace::FileReference.new(path_or_reference)
+      when path_or_reference.is_a?(Xcodeproj::Workspace::FileReference)
+        project_file_reference = path_or_reference
+        projpath = nil
+      else
+        raise ArgumentError, 'Input to the << operator must be a file path or FileReference'
+      end
+      @document.root.add_element(project_file_reference.to_node)
+      load_schemes_from_project File.expand_path(projpath || project_file_reference.path)
+    end
+
+    #-------------------------------------------------------------------------#
+
+    # Adds a new group container to the workspace
+    # workspace.
+    #
+    # @param  [String] name The name of the group
+    #
+    # @yield [Xcodeproj::Workspace::GroupReference, REXML::Element]
+    #        Yields the GroupReference and underlying XML element for mutation
+    #
+    # @return [Xcodeproj::Workspace::GroupReference] The added group reference
+    #
+    def add_group(name)
+      return nil unless @document
+      group = Xcodeproj::Workspace::GroupReference.new(name)
+      elem = @document.root.add_element(group.to_node)
+      yield group, elem if block_given?
+      group
     end
 
     # Checks if the workspace contains the project with the given file
@@ -81,14 +139,32 @@ module Xcodeproj
     # @return [Boolean] whether the project is contained in the workspace.
     #
     def include?(file_reference)
-      @file_references.include?(file_reference)
+      file_references.include?(file_reference)
     end
 
     # @return [String] the XML representation of the workspace.
     #
     def to_s
-      contents = file_references.map { |reference| file_reference_xml(reference) }
-      root_xml(contents.join(''))
+      contents = ''
+      stack = []
+      @document.root.each_recursive do |elem|
+        until stack.empty?
+          last = stack.last
+          break if last == elem.parent
+          contents += xcworkspace_element_end_xml(stack.length, last)
+          stack.pop
+        end
+
+        stack << elem
+        contents += xcworkspace_element_start_xml(stack.length, elem)
+      end
+
+      until stack.empty?
+        contents += xcworkspace_element_end_xml(stack.length, stack.last)
+        stack.pop
+      end
+
+      root_xml(contents)
     end
 
     # Saves the workspace at the given `xcworkspace` path.
@@ -115,7 +191,7 @@ module Xcodeproj
     # @return [void]
     #
     def load_schemes(workspace_dir_path)
-      @file_references.each do |file_reference|
+      file_references.each do |file_reference|
         project_full_path = file_reference.absolute_path(workspace_dir_path)
         load_schemes_from_project(project_full_path)
       end
@@ -146,21 +222,38 @@ module Xcodeproj
 <?xml version="1.0" encoding="UTF-8"?>
 <Workspace
    version = "1.0">
-   #{contents.strip}
+#{contents.rstrip}
 </Workspace>
-      DOC
+DOC
     end
 
-    # @return [String] The XML representation of a file reference.
     #
-    # @param  [FileReference] file_reference The file reference.
+    # @param  [Integer] depth The depth of the element in the tree
+    # @param  [REXML::Document::Element] elem The XML element to format.
     #
-    def file_reference_xml(file_reference)
-      <<-DOC
-   <FileRef
-      location = "#{file_reference.type}:#{file_reference.path}">
-   </FileRef>
-      DOC
+    # @return [String] The Xcode-specific XML formatting of an element start
+    #
+    def xcworkspace_element_start_xml(depth, elem)
+      attributes = case elem.name
+                   when 'Group'
+                     %w(location name)
+                   when 'FileRef'
+                     %w(location)
+                   end
+      contents = "<#{elem.name}"
+      indent = '   ' * depth
+      attributes.each { |name| contents += "\n   #{name} = \"#{elem.attribute(name)}\"" }
+      contents.split("\n").map { |line| "#{indent}#{line}" }.join("\n") + ">\n"
+    end
+
+    #
+    # @param  [Integer] depth The depth of the element in the tree
+    # @param  [REXML::Document::Element] elem The XML element to format.
+    #
+    # @return [String] The Xcode-specific XML formatting of an element end
+    #
+    def xcworkspace_element_end_xml(depth, elem)
+      "#{'   ' * depth}</#{elem.name}>\n"
     end
 
     #-------------------------------------------------------------------------#

data/lib/xcodeproj.rb

@@ -20,7 +20,7 @@ module Xcodeproj
   autoload :Constants,        'xcodeproj/constants'
   autoload :Differ,           'xcodeproj/differ'
   autoload :Helper,           'xcodeproj/helper'
-  autoload :PlistHelper,      'xcodeproj/plist_helper'
+  autoload :Plist,            'xcodeproj/plist'
   autoload :Project,          'xcodeproj/project'
   autoload :Workspace,        'xcodeproj/workspace'
   autoload :XCScheme,         'xcodeproj/scheme'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xcodeproj
 version: !ruby/object:Gem::Version
-  version: 0.28.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Eloy Duran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,16 +42,22 @@ dependencies:
   name: claide
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - <
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '2.0'
 description: Xcodeproj lets you create and modify Xcode projects from Ruby. Script
   boring management tasks or build Xcode-friendly libraries. Also includes support
   for Xcode workspaces (.xcworkspace) and configuration files (.xcconfig).
@@ -61,22 +67,30 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - LICENSE
+- README.md
+- bin/xcodeproj
+- lib/xcodeproj.rb
+- lib/xcodeproj/command.rb
 - lib/xcodeproj/command/config_dump.rb
 - lib/xcodeproj/command/project_diff.rb
 - lib/xcodeproj/command/show.rb
 - lib/xcodeproj/command/sort.rb
 - lib/xcodeproj/command/target_diff.rb
-- lib/xcodeproj/command.rb
-- lib/xcodeproj/config/other_linker_flags_parser.rb
 - lib/xcodeproj/config.rb
+- lib/xcodeproj/config/other_linker_flags_parser.rb
 - lib/xcodeproj/constants.rb
 - lib/xcodeproj/differ.rb
 - lib/xcodeproj/gem_version.rb
 - lib/xcodeproj/helper.rb
-- lib/xcodeproj/plist_helper.rb
+- lib/xcodeproj/plist.rb
+- lib/xcodeproj/plist/ffi.rb
+- lib/xcodeproj/plist/ffi/core_foundation.rb
+- lib/xcodeproj/plist/ffi/dev_tools_core.rb
+- lib/xcodeproj/plist/plist_gem.rb
+- lib/xcodeproj/project.rb
 - lib/xcodeproj/project/case_converter.rb
+- lib/xcodeproj/project/object.rb
 - lib/xcodeproj/project/object/build_configuration.rb
 - lib/xcodeproj/project/object/build_file.rb
 - lib/xcodeproj/project/object/build_phase.rb
@@ -91,31 +105,29 @@ files:
 - lib/xcodeproj/project/object/reference_proxy.rb
 - lib/xcodeproj/project/object/root_object.rb
 - lib/xcodeproj/project/object/target_dependency.rb
-- lib/xcodeproj/project/object.rb
 - lib/xcodeproj/project/object_attributes.rb
 - lib/xcodeproj/project/object_dictionary.rb
 - lib/xcodeproj/project/object_list.rb
 - lib/xcodeproj/project/project_helper.rb
 - lib/xcodeproj/project/uuid_generator.rb
-- lib/xcodeproj/project.rb
+- lib/xcodeproj/scheme.rb
 - lib/xcodeproj/scheme/abstract_scheme_action.rb
 - lib/xcodeproj/scheme/analyze_action.rb
 - lib/xcodeproj/scheme/archive_action.rb
 - lib/xcodeproj/scheme/build_action.rb
 - lib/xcodeproj/scheme/buildable_product_runnable.rb
 - lib/xcodeproj/scheme/buildable_reference.rb
+- lib/xcodeproj/scheme/environment_variables.rb
 - lib/xcodeproj/scheme/launch_action.rb
 - lib/xcodeproj/scheme/macro_expansion.rb
 - lib/xcodeproj/scheme/profile_action.rb
 - lib/xcodeproj/scheme/test_action.rb
 - lib/xcodeproj/scheme/xml_element_wrapper.rb
-- lib/xcodeproj/scheme.rb
 - lib/xcodeproj/user_interface.rb
-- lib/xcodeproj/workspace/file_reference.rb
 - lib/xcodeproj/workspace.rb
+- lib/xcodeproj/workspace/file_reference.rb
+- lib/xcodeproj/workspace/group_reference.rb
 - lib/xcodeproj/xcodebuild_helper.rb
-- lib/xcodeproj.rb
-- bin/xcodeproj
 homepage: https://github.com/cocoapods/xcodeproj
 licenses:
 - MIT
@@ -136,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 3
 summary: Create and modify Xcode projects from Ruby.