xcodeproj 0.3.5 → 0.4.0.rc1

data/lib/xcodeproj/project/object_list.rb

@@ -1,146 +1,92 @@
 module Xcodeproj
   class Project
 
-    # In case `scoped` is an Array the list's order is maintained.
-    class PBXObjectList
-      include Enumerable
-
-      def initialize(represented_class, project)
-        @represented_class = represented_class
-        @project           = project
-        @callbacks         = {}
-
-        yield self if block_given?
-      end
-
-      # Specify callbacks for:
-      # * :uuid_scope  Returns the list of UUIDs to scope this list to.
-      # * :push        When an object is added to the list.
-      def let(callback_name, &block)
-        raise ArgumentError, "Incorrect callback `#{callback_name}'." unless [:uuid_scope, :push].include?(callback_name)
-        @callbacks[callback_name] = block
-      end
-
-      def uuid_scope
-        @callbacks[:uuid_scope].call
-      end
-
-      def empty?
-        uuid_scope.empty?
-      end
-
-      def [](uuid)
-        if uuid_scope.include?(uuid) && hash = @project.objects_hash[uuid]
-          Object.const_get(hash['isa']).new(@project, uuid, hash)
-        end
-      end
-
-      def add(klass, hash = {})
-        object = klass.new(@project, nil, hash)
-        self << object
-        object
+    # This class represents an ordered relationship to many objects.
+    #
+    # It works in conjunction with the {AbstractObject} class to ensure that
+    # the project is not serialized with unreachable objects by updating the
+    # with reference count on modifications.
+    #
+    # @note Concerning the mutations methods it is safe to call only those
+    #       which are overridden to inform objects reference count. Ideally all
+    #       the array methods should be covered, but this is not done yet.
+    #       Moreover it is a moving target because the methods of array 
+    #       usually are implemented in C
+    #
+    # @todo Cover all the array methods.
+    #
+    class ObjectList < Array
+
+      # {Xcodeproj} clients are not expected to create instances of
+      # {ObjectList}, it is always initialized empty and automatically by the
+      # synthesized methods generated by {AbstractObject.has_many}.
+      #
+      def initialize(attribute, owner)
+        @attribute = attribute
+        @owner = owner
       end
 
-      def new(hash = {})
-        add(@represented_class, hash)
-      end
+      # @return [Array<Class>] The attribute that generated the list.
+      #
+      attr_reader :attribute
 
-      # Run Ruby in debug mode to receive warnings about calls to :push when a
-      # list does not have a callback registered for :push.
-      def push(object)
-        if @callbacks[:push]
-          @callbacks[:push].call(object)
-        else
-          if $DEBUG
-            warn "Pushed object onto a PBXObjectList that does not have a :push callback from: #{caller.first}"
-          end
-        end
-        self
-      end
-      alias_method :<<, :push
+      # @return [Array<Class>] The object that owns the list.
+      #
+      attr_reader :owner
 
-      def each
-        uuid_scope.each do |uuid|
-          yield self[uuid]
-        end
+      # @return [Array<String>] The UUIDs of all the objects referenced by this
+      #   list.
+      #
+      def uuids
+        map { |obj| obj.uuid }
       end
 
-      def ==(other)
-        self.to_a == other.to_a
-      end
+      # @!group Notification enabled methods
 
-      def size
-        uuid_scope.size
-      end
+      # TODO: the overridden methods are incomplete.
 
-      # Since order can't always be guaranteed, these might need to move to an order specific subclass.
-      def first
-        to_a.first
-      end
-      def last
-        to_a.last
+      def +(objects)
+        super
+        perform_additions_operations(objects)
       end
 
-      def inspect
-        "<PBXObjectList: #{map(&:inspect).join(', ')}>"
+      def <<(object)
+        super
+        perform_additions_operations(object)
       end
 
-      def where(attributes)
-        find { |o| o.matches_attributes?(attributes) }
+      def delete(object)
+        super
+        perform_deletion_operations(object)
       end
 
-      # @todo is it really necessary to have an extra method for this?
-      def object_named(name)
-        where :name => name
-      end
+      private
 
-      # Returns a PBXObjectList instance of objects in the list.
-      #
-      # By default this list will scope the list by objects matching the
-      # specified class and add objects, pushed onto the list, to the parent
-      # list
-      #
-      # If a block is given the list instance is yielded so that the default
-      # callbacks can be overridden.
-      #
-      # @param  [AbstractPBXObject] klass  The AbstractPBXObject subclass to
-      #                                    which the list should be scoped.
+      # Informs an object that it was added to the list. In practice it adds
+      # the owner of the list as referrer to the objects. It also validates the
+      # value.
       #
-      # @yield  [PBXObjectList]            The list instance, allowing you to
-      #                                    easily override the callbacks.
+      # @return [void]
       #
-      # @return [PBXObjectList<klass>]     The list of matching objects.
-      def list_by_class(klass)
-        parent = self
-        PBXObjectList.new(klass, @project) do |list|
-          list.let(:push) do |object|
-            # Objects added to the subselection should still use the same
-            # callback as this list.
-            parent << object
-          end
-          list.let(:uuid_scope) do
-            parent.uuid_scope.select do |uuid|
-              @project.objects_hash[uuid]['isa'] == klass.isa
-            end
-          end
-          yield list if block_given?
+      def perform_additions_operations(objects)
+        objects = [objects] unless objects.is_a?(Array)
+        objects.each do |obj|
+          obj.add_referrer(owner)
+          attribute.validate_value(obj)
         end
       end
 
-      # This only makes sense on those with a specific represented class. Not the main objects list.
-      def method_missing(name, *args, &block)
-        if @represented_class.respond_to?(name)
-          object = @represented_class.send(name, @project, *args)
-          # The callbacks are only for AbstractPBXObject instances instantiated
-          # from the class method that we forwarded the message to.
-          self << object if object.is_a?(Object::AbstractPBXObject)
-          object
-        else
-          super
+      # Informs an object that it was removed from to the list, so it can
+      # remove it from its referrers and take the appropriate actions.
+      #
+      # @return [void]
+      #
+      def perform_deletion_operations(objects)
+        objects = [objects] unless objects.is_a?(Array)
+        objects.each do |obj|
+          obj.remove_referrer(owner)
         end
       end
-
     end
-
   end
 end

data/lib/xcodeproj/project/recursive_diff.rb

@@ -0,0 +1,116 @@
+class Hash
+
+  # Computes the recursive difference of two hashes.
+  #
+  # 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
+  #
+  # @return [Hash] Returns the recursive difference of a hash.
+  #
+  def recursive_diff(other, self_key = 'self', other_key = 'other')
+    if other.is_a?(Hash)
+      r = {}
+      all_keys = self.keys + other.keys
+      all_keys.each do |key|
+        v1 = self[key]
+        v2 = other[key]
+        diff = v1.recursive_diff(v2, self_key, other_key)
+        r[key] = diff if diff
+      end
+      r unless r == {}
+    else
+      super
+    end
+  end
+
+  # @return [void]
+  #
+  def recursive_delete(key_to_delete)
+    delete(key_to_delete)
+    self.each do |key, value|
+      case value
+      when Hash
+        value.recursive_delete(key_to_delete)
+      when Array
+        value.each { |v| v.recursive_delete(key_to_delete) if v.is_a?(Hash)}
+      end
+    end
+  end
+end
+
+
+class Array
+
+  # @return [Array]
+  #
+  def recursive_diff(other, self_key = 'self', other_key = 'other')
+    if other.is_a?(Array)
+      new_objects_self  = (self - other)
+      new_objects_other = (other - self)
+      unmatched_objects_self = []
+      array_result = []
+
+      # Try to match objects to reduce noise
+      new_objects_self.each do |value|
+        if value.is_a?(Hash)
+          other_value = new_objects_other.find do |other|
+            other.is_a?(Hash) && (value['displayName'] == other['displayName'])
+          end
+
+          if other_value
+            new_objects_other.delete(other_value)
+            match_diff = value.recursive_diff(other_value, self_key, other_key)
+            array_result << { value['displayName'] => match_diff} unless match_diff == {}
+          else
+            unmatched_objects_self << value
+          end
+        end
+      end
+
+      unless unmatched_objects_self.empty?
+        array_result << {
+          self_key => unmatched_objects_self.map do |v|
+            { v['displayName'] => v }
+          end
+        }
+      end
+
+      unless new_objects_other.empty?
+        array_result << {
+          other_key => new_objects_other.map do |v|
+            { v['displayName'] => v }
+          end
+        }
+      end
+
+      array_result unless array_result == []
+    else
+      super
+    end
+  end
+end
+
+class Object
+
+  # @return [Hash]
+  #
+  def recursive_diff(other, self_key = 'self', other_key = 'other')
+    { self_key => self, other_key => other } unless self == other
+  end
+end

data/lib/xcodeproj/workspace.rb

@@ -2,11 +2,33 @@ require 'fileutils'
 require 'rexml/document'
 
 module Xcodeproj
+
+  # The {Workspace} allows to generate, read and serialize Xcode Workspace
+  # documents.
+  #
   class Workspace
+
+    # @return [Array<String>] the paths of the projects contained in the
+    #   workspace.
+    #
+    attr_reader :projpaths
+
+    # Returns a new workspace initialized with the given `xcodeproj` paths.
+    #
+    # @param [String] projpaths
+    #   one or more `xcodeproj` paths.
+    #
     def initialize(*projpaths)
       @projpaths = projpaths
     end
 
+    # Returns a workspace generated by reading the contents of the given path.
+    #
+    # @param [String] path
+    #   the path of the `xcworkspace` file.
+    #
+    # @return [Workspace] the generated workspace.
+    #
     def self.new_from_xcworkspace(path)
       begin
         from_s(File.read(File.join(path, 'contents.xcworkspacedata')))
@@ -15,6 +37,14 @@ module Xcodeproj
       end
     end
 
+    # Returns a workspace generated by reading the contents of the given
+    # XML representation.
+    #
+    # @param [String] xml
+    #   the XML representation of the workspace.
+    #
+    # @return [Workspace] the generated workspace.
+    #
     def self.from_s(xml)
       document = REXML::Document.new(xml)
       projpaths = document.get_elements("/Workspace/FileRef").map do |node|
@@ -23,18 +53,35 @@ module Xcodeproj
       new(*projpaths)
     end
 
-    attr_reader :projpaths
-
+    # Adds a new path to the list of the of projects contained in the
+    #   workspace.
+    #
+    # @param [String] projpath
+    #   The path of the project to add.
+    #
+    # @return [void]
+    #
     def <<(projpath)
       @projpaths << projpath
     end
 
+    # Checks if the workspace contains the project with the given path.
+    #
+    # @param [String] projpath
+    #   The path of the project to add.
+    #
+    # @return [Boolean] whether the project is contained in the workspace.
+    #
     def include?(projpath)
       @projpaths.include?(projpath)
     end
 
+    # The template to generate a workspace XML representation.
+    #
     TEMPLATE = %q[<?xml version="1.0" encoding="UTF-8"?><Workspace version="1.0"></Workspace>]
 
+    # @return [String] the XML representation of the workspace.
+    #
     def to_s
       REXML::Document.new(TEMPLATE).tap do |document|
         @projpaths.each do |projpath|
@@ -45,6 +92,13 @@ module Xcodeproj
       end.to_s
     end
 
+    # Saves the workspace at the given `xcworkspace` path.
+    #
+    # @param [String] path
+    #   the path where to save the project.
+    #
+    # @return [void]
+    #
     def save_as(path)
       FileUtils.mkdir_p(path)
       File.open(File.join(path, 'contents.xcworkspacedata'), 'w') do |out|

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: xcodeproj
 version: !ruby/object:Gem::Version
-  version: 0.3.5
-  prerelease: 
+  version: 0.4.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - Eloy Duran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,27 +27,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.6
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 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).
 email: eloy.de.enige@gmail.com
-executables: []
+executables:
+- xcodeproj
 extensions:
 - ext/xcodeproj/extconf.rb
 extra_rdoc_files: []
 files:
+- lib/xcodeproj/command/project_diff.rb
+- lib/xcodeproj/command/show.rb
+- lib/xcodeproj/command/target_diff.rb
+- lib/xcodeproj/command.rb
 - lib/xcodeproj/config.rb
-- lib/xcodeproj/project/association/has_many.rb
-- lib/xcodeproj/project/association/has_one.rb
-- lib/xcodeproj/project/association/reflection.rb
-- lib/xcodeproj/project/association.rb
+- lib/xcodeproj/constants.rb
+- lib/xcodeproj/helper.rb
+- lib/xcodeproj/project/object/build_configuration.rb
+- lib/xcodeproj/project/object/build_file.rb
 - lib/xcodeproj/project/object/build_phase.rb
-- lib/xcodeproj/project/object/configuration.rb
+- lib/xcodeproj/project/object/build_rule.rb
+- lib/xcodeproj/project/object/configuration_list.rb
+- lib/xcodeproj/project/object/container_item_proxy.rb
 - lib/xcodeproj/project/object/file_reference.rb
 - lib/xcodeproj/project/object/group.rb
 - lib/xcodeproj/project/object/native_target.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_list.rb
+- lib/xcodeproj/project/recursive_diff.rb
 - lib/xcodeproj/project.rb
 - lib/xcodeproj/workspace.rb
 - lib/xcodeproj.rb
@@ -55,6 +82,7 @@ files:
 - ext/xcodeproj/xcodeproj_ext.c
 - README.md
 - LICENSE
+- bin/xcodeproj
 homepage: https://github.com/cocoapods/xcodeproj
 licenses:
 - MIT
@@ -71,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1845437969595669642
+      hash: 1378880103836164332
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: