xcodeproj 0.18.0 → 0.19.0

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

@@ -1,14 +1,12 @@
 module Xcodeproj
   class Project
     module Object
-
       # Apparently a proxy for a reference object which might belong another
       # project contained in the same workspace of the project document.
       #
       # This class is used for referencing the products of another project.
       #
       class PBXReferenceProxy < AbstractObject
-
         # @!group Attributes
 
         # @return [String] the path of the referenced filed.
@@ -46,9 +44,7 @@ module Xcodeproj
         end
 
         #---------------------------------------------------------------------#
-
       end
     end
   end
 end
-

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

@@ -1,11 +1,9 @@
 module Xcodeproj
   class Project
     module Object
-
       # This class represents the root object of a project document.
       #
       class PBXProject < AbstractObject
-
         # @!group Attributes
 
         # @return [ObjectList<PBXNativeTarget>] a list of all the targets in
@@ -22,7 +20,7 @@ module Xcodeproj
         #         - `LastUpgradeCheck`
         #         - `ORGANIZATIONNAME`
         #
-        attribute :attributes, Hash, {'LastUpgradeCheck' => Constants::LAST_UPGRADE_CHECK }
+        attribute :attributes, Hash, 'LastUpgradeCheck' => Constants::LAST_UPGRADE_CHECK
 
         # @return [XCConfigurationList] the configuration list of the project.
         #
@@ -64,11 +62,9 @@ module Xcodeproj
 
         # @return [Array<ObjectDictionary>] any reference to other projects.
         #
-        has_many_references_by_keys :project_references, {
-          :project_ref   => PBXFileReference,
-          :product_group => PBXGroup
-        }
-
+        has_many_references_by_keys :project_references,
+                                    :project_ref   => PBXFileReference,
+                                    :product_group => PBXGroup
       end
     end
   end

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

@@ -1,11 +1,9 @@
 module Xcodeproj
   class Project
     module Object
-
       # Represents a dependency of a target on another one.
       #
       class PBXTargetDependency < AbstractObject
-
         # @!group Attributes
 
         # @return [PBXNativeTarget] the target that needs to be built to
@@ -28,7 +26,6 @@ module Xcodeproj
         #
         attribute :name, String
 
-
         public
 
         # @!group AbstractObject Hooks
@@ -47,7 +44,7 @@ module Xcodeproj
         #
         # @see AbstractObject#sort_recursively
         #
-        def sort_recursively(options = nil)
+        def sort_recursively(_options = nil)
         end
       end
     end

data/lib/xcodeproj/project/object_attributes.rb

@@ -1,7 +1,6 @@
 module Xcodeproj
   class Project
     module Object
-
       # This class represents an attribute of {AbstractObject} subclasses.
       # Attributes are created by the {AbstractObject} DSL methods and allow to
       # mirror the underlying attributes of the xcodeproj document model.
@@ -13,7 +12,6 @@ module Xcodeproj
       #       validated before serialization ?
       #
       class AbstractObjectAttribute
-
         require 'active_support/inflector'
 
         # @return [Symbol] the type of the attribute. It can be `:simple`,
@@ -49,27 +47,14 @@ module Xcodeproj
           @owner = owner
         end
 
-        # @return[String] The name of the attribute in camel case.
+        # @return [String] The name of the attribute in camel case.
         #
         # @example
         #   attribute.new(:simple, :project_root)
         #   attribute.plist_name #=> projectRoot
         #
         def plist_name
-          case name
-          when :remote_global_id_string
-            # `_id_` would become `Id`
-            'remoteGlobalIDString'
-          else
-            self.class.plist_name_store[name] ||= name.to_s.camelize(:lower)
-          end
-        end
-
-        # @return [Hash] a shared store which caches the plist name of the
-        #         attributes.
-        #
-        def self.plist_name_store
-          @plist_name_store ||= {}
+          CaseConverter.convert_to_plist(name, :lower)
         end
 
         # @return [Array<Class>] the list of the classes accepted by the
@@ -77,6 +62,11 @@ module Xcodeproj
         #
         attr_accessor :classes
 
+        # @return [{Symbol, Array<Class>}] the list of the classes accepted by
+        #   each key for attributes which store a dictionary.
+        #
+        attr_accessor :classes_by_key
+
         # @return [String, Array, Hash] the default value, if any, for simple
         #   attributes.
         #
@@ -110,7 +100,9 @@ module Xcodeproj
         # @return [void]
         #
         def set_value(object, new_value)
-          raise "[Xcodeproj] Set value called for a to-many attribute" if type == :to_many
+          if type == :to_many
+            raise '[Xcodeproj] Set value called for a to-many attribute'
+          end
           object.send("#{name}=", new_value)
         end
 
@@ -127,7 +119,9 @@ module Xcodeproj
         # @return [void]
         #
         def set_default(object)
-          raise "[Xcodeproj] Set value called for a #{type} attribute" unless type == :simple
+          unless type == :simple
+            raise "[Xcodeproj] Set value called for a #{type} attribute"
+          end
           set_value(object, default_value.dup) if default_value
         end
 
@@ -144,23 +138,57 @@ module Xcodeproj
           return unless object
           acceptable = classes.find { |klass| object.class == klass || object.class < klass }
           if type == :simple
-            raise "[Xcodeproj] Type checking error: got `#{object.class}` for attribute: #{inspect}" unless acceptable
+            raise "[Xcodeproj] Type checking error: got `#{object.class}` " \
+              "for attribute: #{inspect}" unless acceptable
           else
-            raise "[Xcodeproj] Type checking error: got `#{object.isa}` for attribute: #{inspect}" unless acceptable
+            raise "[Xcodeproj] Type checking error: got `#{object.isa}` for " \
+              "attribute: #{inspect}" unless acceptable
+          end
+        end
+
+        # Checks that a given value is compatible with a key for attributes
+        # which store references by key.
+        #
+        # This method is used by the #{ObjectDictionary} class.
+        #
+        # @raise If the class of the value is not compatible with the given
+        #  key.
+        #
+        def validate_value_for_key(object, key)
+          unless type == :references_by_keys
+            raise '[Xcodeproj] This method should be called only for ' \
+              'attributes of type `references_by_keys`'
+          end
+
+          unless classes_by_key.keys.include?(key)
+            raise "[Xcodeproj] unsupported key `#{key}` " \
+              "(accepted `#{classes_by_key.keys}`) for attribute `#{inspect}`"
+          end
+
+          return unless object
+          classes = Array(classes_by_key[key])
+          acceptable = classes.find { |klass| object.class == klass || object.class < klass }
+          unless acceptable
+            raise "[Xcodeproj] Type checking error: got `#{object.isa}` " \
+              "for key `#{key}` (which accepts `#{classes}`) of " \
+              "attribute: `#{inspect}`"
           end
         end
 
+        # @return [String] A string suitable for debugging the object.
+        #
         def inspect
           if type == :simple
-            "Attribute `#{plist_name}` (type: `#{type}`, classes: `#{classes}`, owner class: `#{owner.isa}`)"
+            "Attribute `#{plist_name}` (type: `#{type}`, classes: " \
+              "`#{classes}`, owner class: `#{owner.isa}`)"
           else
-            "Attribute `#{plist_name}` (type: `#{type}`, classes: `#{classes.map(&:isa)}`, owner class: `#{owner.isa}`)"
+            "Attribute `#{plist_name}` (type: `#{type}`, classes: " \
+              "`#{classes.map(&:isa)}`, owner class: `#{owner.isa}`)"
           end
         end
       end
 
       class AbstractObject
-
         # The {AbstractObject} DSL methods allow to specify with fidelity the
         # underlying model of the xcodeproj document format. {AbstractObject}
         # subclasses should specify their attributes through the following
@@ -177,7 +205,6 @@ module Xcodeproj
         # @note Attributes are typed and are validated at runtime.
         #
         class << self
-
           # @return [Array<AbstractObjectAttribute>] the attributes associated
           #   with the class.
           #
@@ -191,9 +218,14 @@ module Xcodeproj
           def attributes
             unless @full_attributes
               attributes = @attributes || []
-              super_attributes = superclass.respond_to?(:attributes) ? superclass.attributes : []
+              if superclass.respond_to?(:attributes)
+                super_attributes = superclass.attributes
+              else
+                super_attributes = []
+              end
               # The uniqueness of the attributes is very important because the
-              # initialization from plist deletes the values from the dictionary.
+              # initialization from plist deletes the values from the
+              # dictionary.
               @full_attributes = attributes.concat(super_attributes).uniq
             end
             @full_attributes
@@ -288,6 +320,8 @@ module Xcodeproj
             end
           end
 
+          # rubocop:disable Style/PredicateName
+
           # Defines a new relationship to a single and synthesises the
           # corresponding methods.
           #
@@ -373,16 +407,17 @@ module Xcodeproj
           # @param [String] plural_name
           #   the name of the relationship.
           #
-          # @param [Class, Array<Class>] isas_hash
+          # @param [{Symbol, Array<Class>}] classes_by_key
           #   the list of the classes corresponding to the accepted isas for
           #   this relationship.
           #
           # @macro [attach] has_many
           #   @!attribute [r] $1
           #
-          def has_many_references_by_keys(plural_name, isas_hash)
+          def has_many_references_by_keys(plural_name, classes_by_key)
             attrb = AbstractObjectAttribute.new(:references_by_keys, plural_name, self)
-            attrb.classes = isas_hash.values
+            attrb.classes = classes_by_key.values
+            attrb.classes_by_key = classes_by_key
             add_attribute(attrb)
 
             define_method(attrb.name) do
@@ -396,6 +431,8 @@ module Xcodeproj
             end
           end
 
+          # rubocop:enable Style/PredicateName
+
           protected
 
           # Adds an attribute to the list of attributes of the class.
@@ -406,8 +443,14 @@ module Xcodeproj
           # @return [void]
           #
           def add_attribute(attribute)
-            raise "[Xcodeproj] BUG - missing classes for #{attribute.inspect}" unless attribute.classes
-            raise "[Xcodeproj] BUG - classes:#{attribute.classes} for #{attribute.inspect}" unless attribute.classes.all? { |klass| klass.is_a?(Class) }
+            unless attribute.classes
+              raise "[Xcodeproj] BUG - missing classes for #{attribute.inspect}"
+            end
+
+            unless attribute.classes.all? { |klass| klass.is_a?(Class) }
+              raise "[Xcodeproj] BUG - classes:#{attribute.classes} for #{attribute.inspect}"
+            end
+
             @attributes ||= []
             @attributes << attribute
           end
@@ -462,7 +505,7 @@ module Xcodeproj
         def references_by_keys_attributes
           self.class.references_by_keys_attributes
         end
-      end # AbstractObject
+      end
     end
   end
 end

data/lib/xcodeproj/project/object_dictionary.rb

@@ -1,6 +1,5 @@
 module Xcodeproj
   class Project
-
     # This class represents relationships to other objects stored in a
     # Dictionary.
     #
@@ -8,10 +7,7 @@ module Xcodeproj
     # the project is not serialized with unreachable objects by updating the
     # with reference count on modifications.
     #
-    # @note This class is a stub currently only being used by
-    #       {PBXProject#project_references}. It doesn't perform type cheeking
-    #       and the keys of the dictionary are in camel-case. To provide full
-    #       support as the other classes the dictionary should be able to
+    # @note To provide full support as the other classes the dictionary should:
     #
     #       Give the following attribute:
     #
@@ -28,7 +24,7 @@ module Xcodeproj
     #            #=> This should raise:
     #            root_object.project_references.product_group = file
     #
-    #       generate setters and getters from the specification hash.
+    #       I.e. generate setters and getters from the specification hash.
     #
     #       Also the interface is a dirty hybrid between the
     #       {AbstractObjectAttribute} and the {ObjectList}.
@@ -37,110 +33,119 @@ module Xcodeproj
     #       which are overridden to inform objects reference count. Ideally all
     #       the hash 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
+    #       usually are implemented in C.
     #
-    # @todo Cover all the mutations methods of the {Hash} class.
+    # @todo This class should use a {Hash} as a backing store instead of
+    #       inheriting from it. This would prevent the usage of methods which
+    #       don't notify the objects.
     #
     class ObjectDictionary < Hash
-
-      # {Xcodeproj} clients are not expected to create instances of
-      # {ObjectDictionary}, it is always initialized empty and automatically by
-      # the synthesized methods generated by {AbstractObject.has_many}.
+      # @param  [Object::AbstractObjectAttribute] attribute @see #attribute
+      # @param  [Object] owner @see #owner
       #
       def initialize(attribute, owner)
         @attribute = attribute
         @owner = owner
       end
 
-      # @return [Array<Class>] The attribute that generated the list.
+      # @return [Object::AbstractObjectAttribute] The attribute that generated
+      #         the list.
       #
       attr_reader :attribute
 
-      # @return [Array<Class>] The object that owns the list.
+      # @return [Object] The object that owns the list.
       #
       attr_reader :owner
 
-      #------------------------------------------------------------------------#
+      # @return [Array<Symbol>] The list of the allowed keys.
+      #
+      def allowed_keys
+        attribute.classes_by_key.keys
+      end
 
-      # @!group Notification enabled methods
+      # @return [String] A string suitable for debugging.
+      #
+      def inspect
+        "<ObjectDictionary attribute:`#{@attribute.name}` " \
+          "owner:`#{@owner.display_name}` values:#{super.inspect}>"
+      end
 
-      # TODO: the overridden methods are incomplete.
+      # @!group Notification enabled methods
+      #------------------------------------------------------------------------#
 
       # Associates an object to the given key and updates its references count.
       #
-      # @param [String] key
-      #   the key
+      # @param  [String] key
+      #         The key.
       #
-      # @param [AbstractObject] object
-      #   the object to add to the dictionary.
+      # @param  [AbstractObject] object
+      #         The object to add to the dictionary.
       #
-      # @return [void]
+      # @return [AbstractObject] The given object.
       #
       def []=(key, object)
+        key = normalize_key(key)
         if object
-          perform_additions_operations(object)
+          perform_additions_operations(object, key)
         else
           perform_deletion_operations(self[key])
         end
-        super
+        super(key, object)
       end
 
       # Removes the given key from the dictionary and informs the object that
       # is not longer referenced by the owner.
       #
-      # @param [String] key
-      #   the key
-      #
-      # @return [void]
+      # @param  [String] key
+      #         The key.
       #
       def delete(key)
+        key = normalize_key(key)
         object = self[key]
         perform_deletion_operations(object)
         super
       end
 
-      #------------------------------------------------------------------------#
-
-      # @!group AbstractObject
+      # @!group AbstractObject Methods
+      #-----------------------------------------------------------------------#
 
-      # The plist representation of the dictionary where the objects are
-      # replaced by their UUIDs.
-      #
-      # @return [Hash<String => String>]
+      # @return [Hash<String => String>] The plist representation of the
+      #         dictionary where the objects are replaced by their UUIDs.
       #
       def to_hash
         result = {}
-        each { |key, obj| result[key] = obj.uuid }
+        each do |key, obj|
+          if obj
+            plist_key = Object::CaseConverter.convert_to_plist(key, nil)
+            result[plist_key] = obj.uuid
+          end
+        end
         result
       end
 
-      # Returns a cascade representation of the object without UUIDs.
-      #
-      # @return [Hash<String => String>]
+      # @return [Hash<String => String>] Returns a cascade representation of
+      #         the object without UUIDs.
       #
       def to_tree_hash
         result = {}
-        each { |key, obj| result[key] = obj.to_tree_hash }
+        each do |key, obj|
+          if obj
+            plist_key = Object::CaseConverter.convert_to_plist(key, nil)
+            result[plist_key] = obj.to_tree_hash
+          end
+        end
         result
       end
 
       # Removes all the references to a given object.
       #
-      # @return [void]
-      #
       def remove_reference(object)
         each { |key, obj| self[key] = nil if obj == object }
       end
 
-      #------------------------------------------------------------------------#
-
-      # @!group ObjectList
-
       # Informs the objects contained in the dictionary that another object is
       # referencing them.
       #
-      # @return [void]
-      #
       def add_referrer(referrer)
         values.each { |obj| obj.add_referrer(referrer) }
       end
@@ -148,17 +153,32 @@ module Xcodeproj
       # Informs the objects contained in the dictionary that another object
       # stopped referencing them.
       #
-      # @return [void]
-      #
       def remove_referrer(referrer)
         values.each { |obj| obj.remove_referrer(referrer) }
       end
 
+      private
+
+      # @!group Private helpers
       #------------------------------------------------------------------------#
 
-      # @!group Notification Methods
+      # @return [Symbol] Normalizes a key to a symbol converting the camel case
+      #         format with underscores.
+      #
+      # @param  [String, Symbol] key
+      #         The key to normalize.
+      #
+      def normalize_key(key)
+        if key.is_a?(String)
+          key = Object::CaseConverter.convert_to_ruby(key)
+        end
 
-      private
+        unless allowed_keys.include?(key)
+          raise "[Xcodeproj] Unsupported key `#{key}` (allowed " \
+            "`#{allowed_keys}`) for `#{inspect}`"
+        end
+        key
+      end
 
       # Informs an object that it was added to the dictionary. In practice it
       # adds the owner of the list as referrer to the objects. It also
@@ -166,12 +186,9 @@ module Xcodeproj
       #
       # @return [void]
       #
-      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
+      def perform_additions_operations(object, key)
+        object.add_referrer(owner)
+        attribute.validate_value_for_key(object, key)
       end
 
       # Informs an object that it was removed from to the dictionary, so it can
@@ -180,12 +197,8 @@ module Xcodeproj
       # @return [void]
       #
       def perform_deletion_operations(objects)
-        objects = [objects] unless objects.is_a?(Array)
-        objects.each do |obj|
-          obj.remove_referrer(owner)
-        end
+        objects.remove_referrer(owner)
       end
     end
   end
 end
-