xcodeproj 0.28.2 → 1.0.0.beta.1

data/lib/xcodeproj/plist/plist_gem.rb

@@ -0,0 +1,27 @@
+module Xcodeproj
+  module Plist
+    # @visibility private
+    module PlistGem
+      def self.attempt_to_load!
+        return @attempt_to_load if defined?(@attempt_to_load)
+        @attempt_to_load = begin
+          require 'plist/parser'
+          require 'plist/generator'
+          nil
+        rescue LoadError
+          'Xcodeproj relies on a library called `plist` to read and write ' \
+          'Xcode project files. Ensure you have the `plist` gem installed ' \
+          'and try again.'
+        end
+      end
+
+      def self.write_to_path(hash, path)
+        ::Plist::Emit.save_plist(hash, path)
+      end
+
+      def self.read_from_path(path)
+        ::Plist.parse_xml(path)
+      end
+    end
+  end
+end

data/lib/xcodeproj/project.rb

@@ -4,7 +4,7 @@ require 'securerandom'
 require 'xcodeproj/project/object'
 require 'xcodeproj/project/project_helper'
 require 'xcodeproj/project/uuid_generator'
-require 'xcodeproj/plist_helper'
+require 'xcodeproj/plist'
 
 module Xcodeproj
   # This class represents a Xcode project document.
@@ -55,19 +55,26 @@ module Xcodeproj
     # @example Creating a project
     #         Project.new("path/to/Project.xcodeproj")
     #
+    # @note When initializing the project, Xcodeproj mimics the Xcode behaviour
+    #       including the setup of a debug and release configuration. If you want a
+    #       clean project without any configurations, you should override the
+    #       `initialize_from_scratch` method to not add these configurations and
+    #       manually set the object version.
+    #
     def initialize(path, skip_initialization = false, object_version = Constants::DEFAULT_OBJECT_VERSION)
       @path = Pathname.new(path).expand_path
       @objects_by_uuid = {}
       @generated_uuids = []
       @available_uuids = []
-      unless skip_initialization
-        initialize_from_scratch
-        @object_version = object_version.to_s
-      end
+      @dirty           = true
       unless skip_initialization.is_a?(TrueClass) || skip_initialization.is_a?(FalseClass)
         raise ArgumentError, '[Xcodeproj] Initialization parameter expected to ' \
           "be a boolean #{skip_initialization}"
       end
+      unless skip_initialization
+        initialize_from_scratch
+        @object_version = object_version.to_s
+      end
     end
 
     # Opens the project at the given path.
@@ -190,12 +197,13 @@ module Xcodeproj
     #
     def initialize_from_file
       pbxproj_path = path + 'project.pbxproj'
-      plist = Xcodeproj.read_plist(pbxproj_path.to_s)
+      plist = Plist.read_from_path(pbxproj_path.to_s)
       root_object.remove_referrer(self) if root_object
-      @root_object = new_from_plist(plist['rootObject'], plist['objects'], self)
-      @archive_version =  plist['archiveVersion']
-      @object_version  =  plist['objectVersion']
-      @classes         =  plist['classes']
+      @root_object     = new_from_plist(plist['rootObject'], plist['objects'], self)
+      @archive_version = plist['archiveVersion']
+      @object_version  = plist['objectVersion']
+      @classes         = plist['classes']
+      @dirty           = false
 
       unless root_object
         raise "[Xcodeproj] Unable to find a root object in #{pbxproj_path}."
@@ -318,9 +326,25 @@ module Xcodeproj
     #
     def save(save_path = nil)
       save_path ||= path
+      @dirty = false if save_path == path
       FileUtils.mkdir_p(save_path)
       file = File.join(save_path, 'project.pbxproj')
-      Xcodeproj.write_plist(to_hash, file)
+      Plist.write_to_path(to_hash, file)
+    end
+
+    # Marks the project as dirty, that is, modified from what is on disk.
+    #
+    # @return [void]
+    #
+    def mark_dirty!
+      @dirty = true
+    end
+
+    # @return [Boolean] Whether this project has been modified since read from
+    #         disk or saved.
+    #
+    def dirty?
+      @dirty == true
     end
 
     # Replaces all the UUIDs in the project with deterministic MD5 checksums.
@@ -736,7 +760,7 @@ module Xcodeproj
       end
 
       xcschememanagement_path = schemes_dir + 'xcschememanagement.plist'
-      Xcodeproj.write_plist(xcschememanagement, xcschememanagement_path)
+      Plist.write_to_path(xcschememanagement, xcschememanagement_path)
     end
 
     #-------------------------------------------------------------------------#

data/lib/xcodeproj/project/object.rb

@@ -59,11 +59,12 @@ module Xcodeproj
         # @visibility private
         #
         def initialize(project, uuid)
-          @project, @uuid = project, uuid
+          @project = project
+          @uuid = uuid
           @isa = self.class.isa
           @referrers = []
           unless @isa.match(/^(PBX|XC)/)
-            raise '[Xcodeproj] Attempt to initialize an abstract class.'
+            raise "[Xcodeproj] Attempt to initialize an abstract class (#{self.class})."
           end
         end
 
@@ -98,6 +99,7 @@ module Xcodeproj
         # @return [void]
         #
         def remove_from_project
+          mark_project_as_dirty!
           project.objects_by_uuid.delete(uuid)
 
           referrers.dup.each do |referrer|
@@ -214,6 +216,7 @@ module Xcodeproj
         def remove_referrer(referrer)
           @referrers.delete(referrer)
           if @referrers.count == 0
+            mark_project_as_dirty!
             @project.objects_by_uuid.delete(uuid)
           end
         end
@@ -241,6 +244,16 @@ module Xcodeproj
           end
         end
 
+        # Marks the project that this object belongs to as having been modified.
+        #
+        # @return [void]
+        #
+        # @visibility private
+        #
+        def mark_project_as_dirty!
+          project.mark_dirty!
+        end
+
         #---------------------------------------------------------------------#
 
         public

data/lib/xcodeproj/project/object/group.rb

@@ -264,6 +264,34 @@ module Xcodeproj
           group
         end
 
+        # Creates a new variant group and adds it to the group
+        #
+        # @note   @see new_group
+        #
+        # @param  [#to_s] name
+        #         the name of the new group.
+        #
+        # @param  [#to_s] path
+        #         The, preferably absolute, path of the variant group.
+        #         Pass the path of the folder containing all the .lproj bundles,
+        #         that contain files for the variant group.
+        #         Do not pass the path of a specific bundle (such as en.lproj)
+        #
+        # @param  [Symbol] source_tree
+        #         The source tree key to use to configure the path (@see
+        #         GroupableHelper::SOURCE_TREES_BY_KEY).
+        #
+        # @return [PBXVariantGroup] the new variant group.
+        #
+        def new_variant_group(name, path = nil, source_tree = :group)
+          group = project.new(PBXVariantGroup)
+          children << group
+          group.name = name
+          group.set_source_tree(source_tree)
+          group.set_path(path)
+          group
+        end
+
         # Traverses the children groups and finds the group with the given
         # path, if exists.
         #

data/lib/xcodeproj/project/object/helpers/file_references_factory.rb

@@ -139,7 +139,7 @@ module Xcodeproj
                   new_file_reference(ref, child_path, :group)
                 elsif File.basename(child_path) == '.xccurrentversion'
                   full_path = path + File.basename(child_path)
-                  xccurrentversion = Xcodeproj.read_plist(full_path)
+                  xccurrentversion = Plist.read_from_path(full_path)
                   current_version_name = xccurrentversion['_XCCurrentVersionName']
                 end
               end

data/lib/xcodeproj/project/object/native_target.rb

@@ -108,15 +108,34 @@ module Xcodeproj
           sdk.scan(/[0-9.]+/).first
         end
 
+        # @visibility private
+        #
+        # @return [Hash<Symbol, String>]
+        #         The name of the setting for the deployment target by platform
+        #         name.
+        #
+        DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME = {
+          :ios => 'IPHONEOS_DEPLOYMENT_TARGET',
+          :osx => 'MACOSX_DEPLOYMENT_TARGET',
+          :tvos => 'TVOS_DEPLOYMENT_TARGET',
+          :watchos => 'WATCHOS_DEPLOYMENT_TARGET',
+        }.freeze
+
         # @return [String] the deployment target of the target according to its
         #         platform.
         #
         def deployment_target
-          case platform_name
-          when :ios then common_resolved_build_setting('IPHONEOS_DEPLOYMENT_TARGET')
-          when :osx then common_resolved_build_setting('MACOSX_DEPLOYMENT_TARGET')
-          when :tvos then common_resolved_build_setting('TVOS_DEPLOYMENT_TARGET')
-          when :watchos then common_resolved_build_setting('WATCHOS_DEPLOYMENT_TARGET')
+          return unless setting = DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME[platform_name]
+          common_resolved_build_setting(setting)
+        end
+
+        # @param  [String] deployment_target the deployment target to set for
+        #         the target according to its platform.
+        #
+        def deployment_target=(deployment_target)
+          return unless setting = DEPLOYMENT_TARGET_SETTING_BY_PLATFORM_NAME[platform_name]
+          build_configurations.each do |config|
+            config.build_settings[setting] = deployment_target
           end
         end
 
@@ -515,8 +534,8 @@ module Xcodeproj
           unless phase_class < AbstractBuildPhase
             raise ArgumentError, "#{phase_class} must be a subclass of #{AbstractBuildPhase.class}"
           end
-          @phases[phase_class] ||= build_phases.find { |bp| bp.class == phase_class } \
-            || project.new(phase_class).tap { |bp| build_phases << bp }
+          @phases[phase_class] ||= build_phases.find { |bp| bp.class == phase_class } ||
+            project.new(phase_class).tap { |bp| build_phases << bp }
         end
 
         public

data/lib/xcodeproj/project/object_attributes.rb

@@ -316,6 +316,14 @@ module Xcodeproj
             define_method("#{attrb.name}=") do |value|
               @simple_attributes_hash ||= {}
               attrb.validate_value(value)
+
+              existing = @simple_attributes_hash[attrb.plist_name]
+              if existing.is_a?(Hash) && value.is_a?(Hash)
+                return value if existing.keys == value.keys && existing == value
+              elsif existing == value
+                return value if existing == value
+              end
+              mark_project_as_dirty!
               @simple_attributes_hash[attrb.plist_name] = value
             end
           end
@@ -352,6 +360,8 @@ module Xcodeproj
               attrb.validate_value(value)
 
               previous_value = send(attrb.name)
+              return value if previous_value == value
+              mark_project_as_dirty!
               previous_value.remove_referrer(self) if previous_value
               instance_variable_set("@#{attrb.name}", value)
               value.add_referrer(self) if value

data/lib/xcodeproj/project/object_dictionary.rb

@@ -187,6 +187,7 @@ module Xcodeproj
       # @return [void]
       #
       def perform_additions_operations(object, key)
+        owner.mark_project_as_dirty!
         object.add_referrer(owner)
         attribute.validate_value_for_key(object, key)
       end
@@ -197,6 +198,7 @@ module Xcodeproj
       # @return [void]
       #
       def perform_deletion_operations(objects)
+        owner.mark_project_as_dirty!
         objects.remove_referrer(owner)
       end
     end

data/lib/xcodeproj/project/object_list.rb

@@ -151,6 +151,7 @@ module Xcodeproj
       # @return [void]
       #
       def move(object, new_index)
+        return if index(object) == new_index
         if obj = delete(object)
           insert(new_index, obj)
         else
@@ -169,6 +170,7 @@ module Xcodeproj
       # @return [void]
       #
       def move_from(current_index, new_index)
+        return if current_index == new_index
         if obj = delete_at(current_index)
           insert(new_index, obj)
         else
@@ -176,6 +178,14 @@ module Xcodeproj
         end
       end
 
+      def sort!
+        return super if owner.project.dirty?
+        previous = to_a
+        super
+        owner.mark_project_as_dirty! unless previous == to_a
+        self
+      end
+
       private
 
       # @!group Notification Methods
@@ -190,6 +200,7 @@ module Xcodeproj
       def perform_additions_operations(objects)
         objects = [objects] unless objects.is_a?(Array)
         objects.each do |obj|
+          owner.mark_project_as_dirty!
           obj.add_referrer(owner)
           attribute.validate_value(obj) unless obj.is_a?(ObjectDictionary)
         end
@@ -203,6 +214,7 @@ module Xcodeproj
       def perform_deletion_operations(objects)
         objects = [objects] unless objects.is_a?(Array)
         objects.each do |obj|
+          owner.mark_project_as_dirty!
           obj.remove_referrer(owner) unless obj.is_a?(ObjectDictionary)
         end
       end

data/lib/xcodeproj/project/uuid_generator.rb

@@ -66,6 +66,7 @@ module Xcodeproj
       end
 
       def switch_uuids(objects)
+        @project.mark_dirty!
         objects.each do |object|
           next unless path = @paths_by_object[object]
           uuid = uuid_for_path(path)

data/lib/xcodeproj/scheme/build_action.rb

@@ -76,7 +76,8 @@ module Xcodeproj
         def initialize(target_or_node = nil)
           create_xml_element_with_fallback(target_or_node, 'BuildActionEntry') do
             # Check target type to configure the default entry attributes accordingly
-            is_test_target, is_app_target = [false, false]
+            is_test_target = false
+            is_app_target = false
             if target_or_node && target_or_node.is_a?(::Xcodeproj::Project::Object::PBXNativeTarget)
               test_types = [Constants::PRODUCT_TYPE_UTI[:octest_bundle], Constants::PRODUCT_TYPE_UTI[:unit_test_bundle]]
               app_types = [Constants::PRODUCT_TYPE_UTI[:application]]

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]
+
+          if node_or_variable.key?(:enabled)
+            @xml_element.attributes['isEnabled'] = bool_to_string(node_or_variable[:enabled])
+          else
+            @xml_element.attributes['isEnabled'] = 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