xcodeproj 0.4.3 → 0.5.0

data/ext/xcodeproj/xcodeproj_ext.c

@@ -168,7 +168,7 @@ str_to_url(VALUE path) {
 #else
   VALUE p = rb_String(path);
 #endif
-  CFURLRef fileURL = CFURLCreateFromFileSystemRepresentation(NULL, RSTRING_PTR(p), RSTRING_LEN(p), false);
+  CFURLRef fileURL = CFURLCreateFromFileSystemRepresentation(NULL, (const UInt8 *)RSTRING_PTR(p), RSTRING_LEN(p), false);
   if (!fileURL) {
     rb_raise(rb_eArgError, "Unable to create CFURL from `%s'.", RSTRING_PTR(rb_inspect(path)));
   }

data/lib/xcodeproj.rb

@@ -1,5 +1,5 @@
 module Xcodeproj
-  VERSION = '0.4.3'
+  VERSION = '0.5.0' unless defined? Xcodeproj::VERSION
 
   class PlainInformative < StandardError
   end
@@ -10,10 +10,12 @@ module Xcodeproj
     end
   end
 
-  autoload :Config,    'xcodeproj/config'
-  autoload :Command,   'xcodeproj/command'
-  autoload :Constants, 'xcodeproj/constants'
-  autoload :Helper,    'xcodeproj/helper'
-  autoload :Project,   'xcodeproj/project'
-  autoload :Workspace, 'xcodeproj/workspace'
+  autoload :Command,        'xcodeproj/command'
+  autoload :Config,         'xcodeproj/config'
+  autoload :Constants,      'xcodeproj/constants'
+  autoload :Differ,         'xcodeproj/differ'
+  autoload :Helper,         'xcodeproj/helper'
+  autoload :Project,        'xcodeproj/project'
+  autoload :UI,             'xcodeproj/user_interface'
+  autoload :Workspace,      'xcodeproj/workspace'
 end

data/lib/xcodeproj/command/project_diff.rb

@@ -32,20 +32,20 @@ module Xcodeproj
 
 
       def run
-        hash_1 = Project.new(@path_project1).to_tree_hash
-        hash_2 = Project.new(@path_project2).to_tree_hash
-        (@keys_to_ignore).each do |key|
-          hash_1.recursive_delete(key)
-          hash_2.recursive_delete(key)
+        hash_1 = Project.new(@path_project1).to_tree_hash.dup
+        hash_2 = Project.new(@path_project2).to_tree_hash.dup
+        @keys_to_ignore.each do |key|
+          Differ.clean_hash!(hash_1, key)
+          Differ.clean_hash!(hash_2, key)
         end
 
-        diff = hash_1.recursive_diff(hash_2, @path_project1, @path_project2)
-        diff.recursive_delete('displayName')
+        diff = Differ.project_diff(hash_1, hash_2, @path_project1, @path_project2)
 
         require 'yaml'
         yaml = diff.to_yaml
         yaml = yaml.gsub(@path_project1, @path_project1.cyan)
         yaml = yaml.gsub(@path_project2, @path_project2.magenta)
+        yaml = yaml.gsub(":diff:", "diff:".yellow)
         puts yaml
       end
     end

data/lib/xcodeproj/command/show.rb

@@ -18,8 +18,17 @@ module Xcodeproj
 
       def run
         require 'yaml'
-        yaml = xcodeproj.to_tree_hash.to_yaml
-        puts yaml
+        pretty_print = xcodeproj.pretty_print
+        sections = []
+        pretty_print.each do |key, value|
+        section = key.green
+          yaml = value.to_yaml
+          yaml.gsub!(/^---$/,'')
+          yaml.gsub!(/^-/,"\n-")
+          section << yaml
+          sections << section
+        end
+        puts sections * "\n\n"
       end
     end
   end

data/lib/xcodeproj/config.rb

@@ -1,40 +1,39 @@
 module Xcodeproj
 
   # This class holds the data for a Xcode build settings file (xcconfig) and
-  # serializes it.
+  # provides support for serialization.
   #
   class Config
 
     require 'set'
 
     # @return [Hash{String => String}] The attributes of the settings file
-    #   excluding frameworks, weak_framework and libraries.
+    #         excluding frameworks, weak_framework and libraries.
     #
     attr_accessor :attributes
 
     # @return [Set<String>] The list of the frameworks required by this
-    #   settings file.
+    #         settings file.
     #
     attr_accessor :frameworks
 
     # @return [Set<String>] The list of the *weak* frameworks required by
-    #   this settings file.
+    #         this settings file.
     #
     attr_accessor :weak_frameworks
 
     # @return [Set<String>] The list of the libraries required by this
-    #   settings file.
+    #         settings file.
     #
     attr_accessor :libraries
 
     # @return [Array] The list of the configuration files included by this
-    #   configuration file (`#include "SomeConfig"`).
+    #         configuration file (`#include "SomeConfig"`).
     #
     attr_accessor :includes
 
-    # Returns a new instance of Config
-    #
-    # @param [Hash, File, String] xcconfig_hash_or_file  Initial data.
+    # @param  [Hash, File, String] xcconfig_hash_or_file
+    #         The initial data.
     #
     def initialize(xcconfig_hash_or_file = {})
       @attributes = {}
@@ -43,8 +42,18 @@ module Xcodeproj
       merge!(extract_hash(xcconfig_hash_or_file))
     end
 
+    def inspect
+      to_hash.inspect
+    end
+
+    def ==(other)
+      other.respond_to?(:to_hash) && other.to_hash == self.to_hash
+    end
+
     #-------------------------------------------------------------------------#
 
+    public
+
     # @!group Serialization
 
     # Sorts the internal data by setting name and serializes it in the xcconfig
@@ -55,23 +64,32 @@ module Xcodeproj
     #   config = Config.new('PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2')
     #   config.to_s # => "OTHER_LDFLAGS = -lxml2\nPODS_ROOT = \"$(SRCROOT)/Pods\""
     #
-    # @return [String]  The serialized internal data.
+    # @return [String] The serialized internal data.
+    #
     def to_s
       to_hash.sort_by(&:first).map { |k, v| "#{k} = #{v}" }.join("\n")
     end
 
-    # @return [void] Writes the serialized representation of the internal data
-    # to the given path.
+    # Writes the serialized representation of the internal data to the given
+    # path.
     #
-    # @param [Pathname] pathname  The file that the data should be written to.
+    # @param  [Pathname] pathname
+    #         The file where the data should be written to.
+    #
+    # @return [void]
     #
     def save_as(pathname)
       pathname.open('w') { |file| file << to_s }
     end
 
-    # @return [Hash] The hash reppresentation of the framework. The hash
-    # includes the frameworks, the weak frameworks and the libraries in the
-    # `Other Linker Flags` (`OTHER_LDFLAGS`).
+    # The hash representation of the xcconfig. The hash includes the
+    # frameworks, the weak frameworks and the libraries in the `Other Linker
+    # Flags` (`OTHER_LDFLAGS`).
+    #
+    # @note   All the values are sorted to have a consistent output in Ruby
+    #         1.8.7.
+    #
+    # @return [Hash] The hash representation
     #
     def to_hash
       hash = @attributes.dup
@@ -87,12 +105,11 @@ module Xcodeproj
 
     #-------------------------------------------------------------------------#
 
+    public
+
     # @!group Merging
 
-    # Merges the given xcconfig hash or Config into the internal data.
-    #
-    # If a key in the given hash already exists in the internal data then its
-    # value is appended to the value in the internal data.
+    # Merges the given xcconfig representation in the receiver.
     #
     # @example
     #
@@ -100,7 +117,16 @@ module Xcodeproj
     #   config.merge!('OTHER_LDFLAGS' => '-lz', 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers"')
     #   config.to_hash # => { 'PODS_ROOT' => '"$(SRCROOT)/Pods"', 'OTHER_LDFLAGS' => '-lxml2 -lz', 'HEADER_SEARCH_PATHS' => '"$(PODS_ROOT)/Headers"' }
     #
-    # @param [Hash, Config] xcconfig  The data to merge into the internal data.
+    # @note   If a key in the given hash already exists in the internal data
+    #         then its value is appended.
+    #
+    # @param  [Hash, Config] config
+    #         The xcconfig representation to merge.
+    #
+    # @todo   The logic to normalize an hash should be extracted and the
+    #         initializer should not call this method.
+    #
+    # @return [void]
     #
     def merge!(xcconfig)
       if xcconfig.is_a? Config
@@ -110,7 +136,8 @@ module Xcodeproj
         @weak_frameworks.merge(xcconfig.weak_frameworks)
       else
         @attributes.merge!(xcconfig.to_hash) { |key, v1, v2| "#{v1} #{v2}" }
-        # Parse frameworks and libraries. Then remove the from the linker flags
+        # Parse frameworks and libraries. Then remove them from the linker
+        # flags
         flags = @attributes['OTHER_LDFLAGS']
         return unless flags
 
@@ -130,45 +157,57 @@ module Xcodeproj
     end
     alias_method :<<, :merge!
 
+    # Creates a new #{Config} with the data of the receiver merged with the
+    # given xcconfig representation.
+    #
+    # @param  [Hash, Config] config
+    #         The xcconfig representation to merge.
+    #
+    # @return [Config] the new xcconfig.
+    #
     def merge(config)
       self.dup.tap { |x| x.merge!(config) }
     end
 
+    # @return [Config] A copy of the receiver.
+    #
     def dup
       Xcodeproj::Config.new(self.to_hash.dup)
     end
 
     #-------------------------------------------------------------------------#
 
-    # @!group Object methods
-
-    def inspect
-      to_hash.inspect
-    end
-
-    def ==(other)
-      other.respond_to?(:to_hash) && other.to_hash == self.to_hash
-    end
-
-    #-------------------------------------------------------------------------#
+    private
 
     # @!group Private Helpers
 
-    private
-
+    # Returns a hash from the given argument reading it from disk if necessary.
+    #
+    # @param  [String, Pathname, Hash] argument
+    #         The source from where the hash should be extracted.
+    #
+    # @return [Hash]
+    #
     def extract_hash(argument)
       if argument.respond_to? :read
         hash_from_file_content(argument.read)
-      elsif File.readable? argument.to_s
+      elsif File.readable?(argument.to_s)
         hash_from_file_content(File.read(argument))
       else
         argument
       end
     end
 
-    def hash_from_file_content(raw_string)
+    # Returns a hash from the string representation of an Xcconfig file.
+    #
+    # @param  [String] string
+    #         The string representation of an xcconfig file.
+    #
+    # @return [Hash] the hash containing the xcconfig data.
+    #
+    def hash_from_file_content(string)
       hash = {}
-      raw_string.split("\n").each do |line|
+      string.split("\n").each do |line|
         uncommented_line = strip_comment(line)
         if include = extract_include(uncommented_line)
           @includes.push include
@@ -180,16 +219,39 @@ module Xcodeproj
       hash
     end
 
+    # Strips the comments from a line of an xcconfig string.
+    #
+    # @param  [String] line
+    #         the line to process.
+    #
+    # @return [String] the uncommented line.
+    #
     def strip_comment(line)
       line.partition('//').first
     end
 
+    # Returns the file included by a line of an xcconfig string if present.
+    #
+    # @param  [String] line
+    #         the line to process.
+    #
+    # @return [String] the included file.
+    # @return [Nil] if no include was found in the line.
+    #
     def extract_include(line)
       regexp = /#include\s*"(.+)"/
       match = line.match(regexp)
       match[1] if match
     end
 
+    # Returns the key and the value described by the given line of an xcconfig.
+    #
+    # @param  [String] line
+    #         the line to process.
+    #
+    # @return [Array] A tuple where the first entry is the key and the second
+    #         entry is the value.
+    #
     def extract_key_value(line)
       key, value = line.split('=', 2)
       if key && value
@@ -199,5 +261,7 @@ module Xcodeproj
       end
     end
 
+    #-------------------------------------------------------------------------#
+
   end
 end

data/lib/xcodeproj/constants.rb

@@ -4,23 +4,23 @@ module Xcodeproj
   #
   module Constants
 
-    # The last known iOS SDK (stable).
+    # @return [String] The last known iOS SDK (stable).
     #
-    LAST_KNOWN_IOS_SDK = '6.0'
+    LAST_KNOWN_IOS_SDK = '6.1'
 
-    # The last known OS X SDK (stable).
+    # @return [String] The last known OS X SDK (stable).
     #
     LAST_KNOWN_OSX_SDK  = '10.8'
 
-    # The last known archive version to Xcodeproj.
+    # @return [String] The last known archive version to Xcodeproj.
     #
     LAST_KNOWN_ARCHIVE_VERSION = 1
 
-    # The last known object version to Xcodeproj.
+    # @return [String] The last known object version to Xcodeproj.
     #
     LAST_KNOWN_OBJECT_VERSION  = 46
 
-    # The all the known ISAs grouped by superclass.
+    # @return [Hash] The all the known ISAs grouped by superclass.
     #
     KNOWN_ISAS = {
       'AbstractObject' => %w[
@@ -58,11 +58,11 @@ module Xcodeproj
       ]
     }.freeze
 
-    # The list of the super classes for each ISA.
+    # @return [Array] The list of the super classes for each ISA.
     #
     ISAS_SUPER_CLASSES = %w[ AbstractObject AbstractBuildPhase PBXGroup ]
 
-    # The known file types corresponding to each extension.
+    # @return [Hash] The known file types corresponding to each extension.
     #
     FILE_TYPES_BY_EXTENSION = {
       'a'           => 'archive.ar',
@@ -75,7 +75,7 @@ module Xcodeproj
       'xcdatamodel' => 'wrapper.xcdatamodel',
     }.freeze
 
-    # The uniform type identifier of various product types.
+    # @return [Hash] The uniform type identifier of various product types.
     #
     PRODUCT_TYPE_UTI = {
       :application     => 'com.apple.product-type.application',
@@ -83,8 +83,8 @@ module Xcodeproj
       :static_library  => 'com.apple.product-type.library.static',
     }.freeze
 
-    # The common build settings grouped by platform, and build configuration
-    # name.
+    # @return [Hash] The common build settings grouped by platform, and build
+    #         configuration name.
     #
     COMMON_BUILD_SETTINGS = {
       :all => {
@@ -107,7 +107,8 @@ module Xcodeproj
         'COPY_PHASE_STRIP'                  => 'NO',
       }.freeze,
       :release => {
-        # Empty?
+        'OTHER_CFLAGS'                      => '-DNS_BLOCK_ASSERTIONS=1',
+        'OTHER_CPLUSPLUSFLAGS'              => '-DNS_BLOCK_ASSERTIONS=1',
       }.freeze,
       :ios => {
         'ARCHS'                             => "$(ARCHS_STANDARD_32_BIT)",
@@ -137,7 +138,8 @@ module Xcodeproj
       }.freeze,
     }.freeze
 
-    # The corresponding numeric value of each copy build phase destination.
+    # @return [Hash] The corresponding numeric value of each copy build phase
+    #         destination.
     #
     COPY_FILES_BUILD_PHASE_DESTINATIONS = {
       :absolute_path      =>  '0',
@@ -152,7 +154,7 @@ module Xcodeproj
       :plug_ins           => '13'
     }.freeze
 
-    # The extensions which are associated with header files
+    # @return [Hash] The extensions which are associated with header files.
     #
     HEADER_FILES_EXTENSIONS = %w| .h .hh .hpp |.freeze
 

data/lib/xcodeproj/differ.rb

@@ -0,0 +1,243 @@
+module Xcodeproj
+
+  # Computes the recursive diff of Hashes, Array and other objects.
+  #
+  # Useful to compare two projects. Inspired from
+  # 'active_support/core_ext/hash/diff'.
+  #
+  # @example
+  #   h1 = { :common => 'value', :changed => 'v1' }
+  #   h2 = { :common => 'value', :changed => 'v2', :addition => 'new_value' }
+  #   h1.recursive_diff(h2) == {
+  #     :changed => {
+  #       :self  => 'v1',
+  #       :other => 'v2'
+  #     },
+  #     :addition => {
+  #       :self  => nil,
+  #       :other => 'new_value'
+  #     }
+  #   } #=> true
+  #
+  #
+  #
+  #
+  module Differ
+
+    # Computes the recursive difference of two given values.
+    #
+    # @param  [Object] value_1
+    #         The first value to compare.
+    #
+    # @param  [Object] value_2
+    #         The second value to compare.
+    #
+    # @param  [Object] key_1
+    #         The key for the diff of value_1.
+    #
+    # @param  [Object] key_2
+    #         The key for the diff of value_2.
+    #
+    # @param  [Object] id_key
+    #         The key used to identify correspondent hashes in an array.
+    #
+    # @return [Hash] The diff
+    # @return [Nil] if the given values are equal.
+    #
+    def self.diff(value_1, value_2, options = {})
+      options[:key_1]  ||= 'value_1'
+      options[:key_2]  ||= 'value_2'
+      options[:id_key] ||= nil
+
+      if value_1.class == value_2.class
+        method = case value_1
+                 when Hash  then :hash_diff
+                 when Array then :array_diff
+                 else :generic_diff
+                 end
+      else
+        method = :generic_diff
+      end
+      self.send(method, value_1, value_2, options)
+    end
+
+    # Optimized for reducing the noise from the tree hash of projects
+    #
+    def self.project_diff(project_1, project_2, key_1 = 'project_1', key_2 = 'project_2')
+      project_1 = project_1.to_tree_hash unless project_1.is_a?(Hash)
+      project_2 = project_2.to_tree_hash unless project_2.is_a?(Hash)
+      options = {
+        :key_1  => key_1,
+        :key_2  => key_2,
+        :id_key => 'displayName',
+      }
+      diff(project_1, project_2, options)
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Type specific handlers
+
+    # Computes the recursive difference of two hashes.
+    #
+    # @see diff
+    #
+    def self.hash_diff(value_1, value_2, options)
+      ensure_class(value_1, Hash)
+      ensure_class(value_2, Hash)
+      return nil if value_1 == value_2
+
+      result = {}
+      all_keys = (value_1.keys + value_2.keys).uniq
+      all_keys.each do |key|
+        key_value_1 = value_1[key]
+        key_value_2 = value_2[key]
+        diff = diff(key_value_1, key_value_2, options)
+        if diff
+          result[key] = diff if diff
+        end
+      end
+      if result.empty?
+        nil
+      else
+        result
+      end
+    end
+
+    # Returns the recursive diff of two arrays.
+    #
+    # @see diff
+    #
+    def self.array_diff(value_1, value_2, options)
+      ensure_class(value_1, Array)
+      ensure_class(value_2, Array)
+      return nil if value_1 == value_2
+
+      new_objects_value_1 = (value_1 - value_2)
+      new_objects_value_2 = (value_2 - value_1)
+      return nil if value_1.empty? && value_2.empty?
+
+      matched_diff = {}
+      if id_key = options[:id_key]
+        matched_value_1 = []
+        matched_value_2 = []
+        new_objects_value_1.each do |entry_value_1|
+          if entry_value_1.is_a?(Hash)
+            id_value = entry_value_1[id_key]
+            entry_value_2 = new_objects_value_2.find do |entry|
+              entry[id_key] == id_value
+            end
+            if entry_value_2
+              matched_value_1 << entry_value_1
+              matched_value_2 << entry_value_2
+              diff = diff(entry_value_1, entry_value_2, options)
+              matched_diff[id_value] = diff if diff
+            end
+          end
+        end
+
+        new_objects_value_1 = new_objects_value_1 - matched_value_1
+        new_objects_value_2 = new_objects_value_2 - matched_value_2
+      end
+
+      if new_objects_value_1.empty? && new_objects_value_2.empty?
+        if matched_diff.empty?
+          nil
+        else
+          matched_diff
+        end
+      else
+        result = {}
+        result[options[:key_1]] = new_objects_value_1 unless new_objects_value_1.empty?
+        result[options[:key_2]] = new_objects_value_2 unless new_objects_value_2.empty?
+        result[:diff] = matched_diff unless matched_diff.empty?
+        result
+      end
+    end
+
+    # Returns the diff of two generic objects.
+    #
+    # @see diff
+    #
+    def self.generic_diff(value_1, value_2, options)
+      return nil if value_1 == value_2
+
+      {
+        options[:key_1] => value_1,
+        options[:key_2] => value_2
+      }
+    end
+
+    #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Cleaning
+
+    # Returns a copy of the hash where the given key is removed recursively.
+    #
+    # @param  [Hash] hash
+    #         The hash to clean
+    #
+    # @param  [Object] key
+    #         The key to remove.
+    #
+    # @return [Hash] A copy of the hash without the key.
+    #
+    def self.clean_hash(hash, key)
+      new_hash = hash.dup
+      self.clean_hash!(new_hash, key)
+      new_hash
+    end
+
+    # Recursively cleans a key from the given hash.
+    #
+    # @param  [Hash] hash
+    #         The hash to clean
+    #
+    # @param  [Object] key
+    #         The key to remove.
+    #
+    # @return [void]
+    #
+    def self.clean_hash!(hash, key)
+      hash.delete(key)
+      hash.each do |_, value|
+        case value
+        when Hash
+          clean_hash!(value, key)
+        when Array
+          value.each { |entry| clean_hash!(entry, key) if entry.is_a?(Hash)}
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # @! Helpers
+
+    # Ensures that the given object belongs to the given class.
+    #
+    # @param  [Object] object
+    #         The object to check.
+    #
+    # @param  [Class] klass
+    #         the expected class of the object.
+    #
+    # @raise  If the object doesn't belong to the given class.
+    #
+    # @return [void]
+    #
+    def self.ensure_class(object, klass)
+      raise "Wrong type `#{object.inspect}`" unless object.is_a?(klass)
+    end
+
+    #-------------------------------------------------------------------------#
+
+  end
+end
+