xcodeproj 0.18.0 → 0.19.0

data/lib/xcodeproj/project/case_converter.rb

@@ -0,0 +1,59 @@
+module Xcodeproj
+  class Project
+    module Object
+      # Converts between camel case names used in the xcodeproj plist files
+      # and the ruby symbols used to represent them.
+      #
+      module CaseConverter
+        # @return [String] The plist equivalent of the given Ruby name.
+        #
+        # @param  [Symbol, String] name
+        #         The name to convert
+        #
+        # @param  [Symbol, Nil] type
+        #         The type of conversion. Pass `nil` for normal camel case and
+        #         `:lower` for camel case starting with a lower case letter.
+        #
+        # @example
+        #   CaseConverter.convert_to_plist(:project_ref) #=> ProjectRef
+        #
+        def self.convert_to_plist(name, type = nil)
+          case name
+          when :remote_global_id_string
+            'remoteGlobalIDString'
+          else
+            if type == :lower
+              cache = plist_cache[:lower] ||= {}
+              cache[name] ||= name.to_s.camelize(:lower)
+            else
+              cache = plist_cache[:normal] ||= {}
+              cache[name] ||= name.to_s.camelize
+            end
+          end
+        end
+
+        # @return [Symbol] The Ruby equivalent of the given plist name.
+        #
+        # @param  [String] name
+        #         The name to convert
+        #
+        # @example
+        #   CaseConverter.convert_to_ruby('ProjectRef') #=> :project_ref
+        #
+        def self.convert_to_ruby(name)
+          name.to_s.underscore.to_sym
+        end
+
+        # @return [Hash] A cache for the conversion to the Plist format.
+        #
+        # @note   A cache is used because this operation is performed for each
+        #         attribute of the project when it is saved and caching it has
+        #         an important performance benefit.
+        #
+        def self.plist_cache
+          @plist_cache ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/xcodeproj/project/object.rb

@@ -1,6 +1,5 @@
 module Xcodeproj
   class Project
-
     # This is the namespace in which all the classes that wrap the objects in
     # a Xcode project reside.
     #
@@ -16,7 +15,6 @@ module Xcodeproj
     #   end
     #
     module Object
-
       # @abstract
       #
       # This is the base class of all object types that can exist in a Xcode
@@ -34,7 +32,6 @@ module Xcodeproj
       # clients.
       #
       class AbstractObject
-
         # @!group AbstractObject
 
         # @return [String] the ISA of the class.
@@ -65,7 +62,9 @@ module Xcodeproj
           @project, @uuid = project, uuid
           @isa = self.class.isa
           @referrers = []
-          raise "[Xcodeproj] Attempt to initialize an abstract class." unless @isa.match(/^(PBX|XC)/)
+          unless @isa.match(/^(PBX|XC)/)
+            raise '[Xcodeproj] Attempt to initialize an abstract class.'
+          end
         end
 
         # Initializes the object with the default values of simple attributes.
@@ -100,7 +99,10 @@ module Xcodeproj
         #
         def remove_from_project
           project.objects_by_uuid.delete(uuid)
-          referrers.each { |referrer| referrer.remove_reference(self) }
+
+          referrers.dup.each do |referrer|
+            referrer.remove_reference(self)
+          end
 
           to_one_attributes.each do |attrb|
             object = attrb.get_value(self)
@@ -112,7 +114,10 @@ module Xcodeproj
             list.clear
           end
 
-          raise "[Xcodeproj] BUG: #{self} should have no referrers instead the following objects are still referencing it #{referrers}" unless referrers.count == 0
+          unless referrers.count == 0
+            raise "[Xcodeproj] BUG: #{self} should have no referrers instead" \
+              "the following objects are still referencing it #{referrers}"
+          end
         end
 
         # Returns the value of the name attribute or returns a generic name for
@@ -131,12 +136,12 @@ module Xcodeproj
             isa.gsub(/^(PBX|XC)/, '')
           end
         end
-        alias :to_s :display_name
+        alias_method :to_s, :display_name
 
         # Sorts the to many attributes of the object according to the display
         # name.
         #
-        def sort(options = nil)
+        def sort(_options = nil)
           to_many_attributes.each do |attrb|
             list = attrb.get_value(self)
             list.sort! do |x, y|
@@ -255,7 +260,10 @@ module Xcodeproj
         def configure_with_plist(objects_by_uuid_plist)
           object_plist = objects_by_uuid_plist[uuid].dup
 
-          raise "[Xcodeproj] Attempt to initialize `#{isa}` from plist with different isa `#{object_plist}`" unless object_plist['isa'] == isa
+          unless object_plist['isa'] == isa
+            raise "[Xcodeproj] Attempt to initialize `#{isa}` from plist with " \
+              "different isa `#{object_plist}`"
+          end
           object_plist.delete('isa')
 
           simple_attributes.each do |attrb|
@@ -297,9 +305,10 @@ module Xcodeproj
           end
 
           unless object_plist.empty?
-            raise "[!] Xcodeproj doesn't know about the following attributes " \
-                  "#{object_plist.inspect} for the '#{isa}' isa.\n" \
-                  "Please file an issue: https://github.com/CocoaPods/Xcodeproj/issues/new"
+            raise "[!] Xcodeproj doesn't know about the following " \
+                  "attributes #{object_plist.inspect} for the '#{isa}' isa." \
+                  "\nIf this attribute was generated by Xcode please file " \
+                  'an issue: https://github.com/CocoaPods/Xcodeproj/issues/new'
           end
         end
 
@@ -327,16 +336,17 @@ module Xcodeproj
         def object_with_uuid(uuid, objects_by_uuid_plist, attribute)
           unless object = project.objects_by_uuid[uuid] || project.new_from_plist(uuid, objects_by_uuid_plist)
             UI.warn "`#{inspect}` attempted to initialize an object with " \
-              "an unknown UUID. `#{uuid}` for attribute: `#{attribute.name}`."\
-              " This can be the result of a merge and the unknown UUID is "    \
-              "being discarded."
+              "an unknown UUID. `#{uuid}` for attribute: " \
+              "`#{attribute.name}`. This can be the result of a merge and  " \
+              'the unknown UUID is being discarded.'
           end
           object
         rescue NameError
           attributes = objects_by_uuid_plist[uuid]
           raise "`#{isa}` attempted to initialize an object with unknown ISA "\
-                "`#{attributes['isa']}` from attributes: `#{attributes}`\n"   \
-                "Please file an issue: https://github.com/CocoaPods/Xcodeproj/issues/new"
+                "`#{attributes['isa']}` from attributes: `#{attributes}`\n" \
+                'If this ISA was generated by Xcode please file an issue: ' \
+                'https://github.com/CocoaPods/Xcodeproj/issues/new'
         end
 
         # Returns a cascade representation of the object with UUIDs.
@@ -364,13 +374,13 @@ module Xcodeproj
           end
 
           to_many_attributes.each do |attrb|
-          list = attrb.get_value(self)
+            list = attrb.get_value(self)
             plist[attrb.plist_name] = list.uuids
           end
 
           references_by_keys_attributes.each do |attrb|
             list = attrb.get_value(self)
-            plist[attrb.plist_name] = list.map { |dictionary| dictionary.to_hash }
+            plist[attrb.plist_name] = list.map(&:to_hash)
           end
 
           plist
@@ -406,12 +416,12 @@ module Xcodeproj
 
           to_many_attributes.each do |attrb|
             list = attrb.get_value(self)
-            hash[attrb.plist_name] = list.map { |obj| obj.to_tree_hash }
+            hash[attrb.plist_name] = list.map(&:to_tree_hash)
           end
 
           references_by_keys_attributes.each do |attrb|
             list = attrb.get_value(self)
-            hash[attrb.plist_name] = list.map { |dictionary| dictionary.to_tree_hash }
+            hash[attrb.plist_name] = list.map(&:to_tree_hash)
           end
 
           hash
@@ -423,7 +433,7 @@ module Xcodeproj
         def pretty_print
           if to_many_attributes.count == 1
             children = to_many_attributes.first.get_value(self)
-            {display_name => children.map(&:pretty_print)}
+            { display_name => children.map(&:pretty_print) }
           else
             display_name
           end
@@ -436,27 +446,28 @@ module Xcodeproj
         # @!group Object methods
 
         def ==(other)
-          other.is_a?(AbstractObject) && self.to_hash == other.to_hash
+          other.is_a?(AbstractObject) && to_hash == other.to_hash
         end
 
         def <=>(other)
-          self.uuid <=> other.uuid
+          uuid <=> other.uuid
         end
 
         def inspect
           optional = ''
-          optional << " name=`#{self.name}`" if respond_to?(:name) && self.name
-          optional << " path=`#{self.path}`" if respond_to?(:path) && self.path
-          "<#{self.isa}#{optional} UUID=`#{uuid}`>"
+          optional << " name=`#{name}`" if respond_to?(:name) && name
+          optional << " path=`#{path}`" if respond_to?(:path) && path
+          "<#{isa}#{optional} UUID=`#{uuid}`>"
         end
       end
     end
   end
 end
 
-require 'xcodeproj/project/object_list'
-require 'xcodeproj/project/object_dictionary'
+require 'xcodeproj/project/case_converter'
 require 'xcodeproj/project/object_attributes'
+require 'xcodeproj/project/object_dictionary'
+require 'xcodeproj/project/object_list'
 
 # Required because some classes have cyclical references to each other.
 #
@@ -488,4 +499,3 @@ require 'xcodeproj/project/object/native_target'
 require 'xcodeproj/project/object/root_object'
 require 'xcodeproj/project/object/target_dependency'
 require 'xcodeproj/project/object/reference_proxy'
-

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

@@ -1,13 +1,11 @@
 module Xcodeproj
   class Project
     module Object
-
       # Encapsulates the information a specific build configuration referenced
       # by a {XCConfigurationList} which in turn might be referenced by a
       # {PBXProject} or a {PBXNativeTarget}.
       #
       class XCBuildConfiguration < AbstractObject
-
         # @!group Attributes
 
         # @return [String] the name of the Target.
@@ -23,7 +21,6 @@ module Xcodeproj
         #
         has_one :base_configuration_reference, PBXFileReference
 
-
         public
 
         # @!group AbstractObject Hooks
@@ -46,7 +43,7 @@ module Xcodeproj
         #
         # @return [void]
         #
-        def sort(options = nil)
+        def sort(_options = nil)
           sorted = {}
           build_settings.keys.sort.each do |key|
             sorted[key] = build_settings[key]
@@ -55,7 +52,6 @@ module Xcodeproj
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end

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

@@ -1,12 +1,10 @@
 module Xcodeproj
   class Project
     module Object
-
       # Contains the information about the build settings of a file used by an
       # {AbstractBuildPhase}.
       #
       class PBXBuildFile < AbstractObject
-
         # @!group Attributes
 
         # @return [Hash] the list of build settings for this file.
@@ -30,7 +28,7 @@ module Xcodeproj
           PBXGroup,
           PBXVariantGroup,
           XCVersionGroup,
-          PBXReferenceProxy
+          PBXReferenceProxy,
         ]
 
         #---------------------------------------------------------------------#
@@ -62,7 +60,6 @@ module Xcodeproj
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end

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

@@ -1,13 +1,11 @@
 module Xcodeproj
   class Project
     module Object
-
       # @abstract
       #
       # This class is abstract and it doesn't appear in the project document.
       #
       class AbstractBuildPhase < AbstractObject
-
         # @!group Attributes
 
         # @return [ObjectList<PBXBuildFile>] the files processed by this build
@@ -48,7 +46,7 @@ module Xcodeproj
         #         referenced by this build phase.
         #
         def files_references
-          files.map { |bf| bf.file_ref }
+          files.map(&:file_ref)
         end
 
         # @return [Array<String>] The display name of the build files.
@@ -128,8 +126,7 @@ module Xcodeproj
             remove_build_file(bf)
           end
         end
-        alias :clear_build_files :clear
-
+        alias_method :clear_build_files, :clear
       end
 
       #-----------------------------------------------------------------------#
@@ -140,7 +137,6 @@ module Xcodeproj
       # @note This phase can appear only once in a target.
       #
       class PBXHeadersBuildPhase < AbstractBuildPhase
-
       end
 
       #-----------------------------------------------------------------------#
@@ -151,7 +147,6 @@ module Xcodeproj
       # @note This phase can appear only once in a target.
       #
       class PBXSourcesBuildPhase < AbstractBuildPhase
-
       end
 
       #-----------------------------------------------------------------------#
@@ -162,7 +157,6 @@ module Xcodeproj
       # @note This phase can appear only once in a target.
       #
       class PBXFrameworksBuildPhase < AbstractBuildPhase
-
       end
 
       #-----------------------------------------------------------------------#
@@ -174,7 +168,6 @@ module Xcodeproj
       # @note This phase can appear only once in a target.
       #
       class PBXResourcesBuildPhase < AbstractBuildPhase
-
       end
 
       #-----------------------------------------------------------------------#
@@ -185,7 +178,6 @@ module Xcodeproj
       # @note This phase can appear multiple times in a target.
       #
       class PBXCopyFilesBuildPhase < AbstractBuildPhase
-
         # @!group Attributes
 
         # @return [String] the name of the build phase.
@@ -203,7 +195,6 @@ module Xcodeproj
         #         copied to.
         #
         attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]
-
       end
 
       #-----------------------------------------------------------------------#
@@ -213,7 +204,6 @@ module Xcodeproj
       # @note This phase can appear multiple times in a target.
       #
       class PBXShellScriptBuildPhase < AbstractBuildPhase
-
         # @!group Attributes
 
         # @return [String] the name of the build phase.
@@ -265,7 +255,6 @@ module Xcodeproj
       end
 
       #-----------------------------------------------------------------------#
-
     end
   end
 end

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

@@ -1,11 +1,9 @@
 module Xcodeproj
   class Project
     module Object
-
       # This class represents a custom build rule of a Target.
       #
       class PBXBuildRule < AbstractObject
-
         # @!group Attributes
 
         # @return [String] the name of the rule.
@@ -54,7 +52,6 @@ module Xcodeproj
         #         `com.apple.compilers.proxy.script`
         #
         attribute :script, String
-
       end
     end
   end

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

@@ -1,12 +1,10 @@
 module Xcodeproj
   class Project
     module Object
-
       # The primary purpose of this class is to maintain a collection of
       # related build configurations of a {PBXProject} or a {PBXNativeTarget}.
       #
       class XCConfigurationList < AbstractObject
-
         # @!group Attributes
 
         # @return [String] whether the default configuration is visible.
@@ -27,7 +25,6 @@ module Xcodeproj
         #
         has_many :build_configurations, XCBuildConfiguration
 
-
         public
 
         # @!group Helpers
@@ -94,7 +91,6 @@ module Xcodeproj
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end