xcodeproj 0.3.5 → 0.4.0.rc1

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

@@ -0,0 +1,27 @@
+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
+
+        # @return [String] the name of the Target.
+        #
+        attribute :name, String
+
+        # @return [Hash] the build settings to use for building the target.
+        #
+        attribute :build_settings, Hash, {}
+
+        # @return [PBXFileReference] an optional file reference to a
+        #   configuration file (`.xcconfig`).
+        #
+        has_one :base_configuration_reference, PBXFileReference
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module Xcodeproj
+  class Project
+    module Object
+
+      # Contains the information about the build settings of a file used by an
+      # {AbstractBuildPhase}.
+      #
+      class PBXBuildFile < AbstractObject
+
+        # @return [Hash] the list of build settings for this file.
+        #
+        # The contents of this array depend on the phase of the build file.
+        #
+        # - For PBXHeadersBuildPhase is `{ "ATTRIBUTES" => [:value] }` where
+        #   `:value` can be `Public`, `Private`, or nil (Protected).
+        #
+        attribute :settings, Hash, {}
+
+        # @return [PBXFileReference] the file that to build.
+        #
+        has_one :file_ref, [PBXFileReference, PBXVariantGroup, XCVersionGroup]
+
+      end
+    end
+  end
+end

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

@@ -2,89 +2,160 @@ module Xcodeproj
   class Project
     module Object
 
-      class PBXBuildFile < AbstractPBXObject
-        # [Hash] the list of build settings for this file
-        attribute :settings
+      # @abstract
+      #
+      # This class is abstract and it doesn't appear in the project document.
+      #
+      class AbstractBuildPhase < AbstractObject
+
+
+        # @return [ObjectList<PBXBuildFile>] the files processed by this build
+        #   configuration.
+        #
+        has_many :files, PBXBuildFile
+
+        # @return [String] some kind of magic number which usually is
+        #   '2147483647' (can be also `8` and `12` in PBXCopyFilesBuildPhase,
+        #   one of the masks is run_only_for_deployment_postprocessing).
+        #
+        attribute :build_action_mask, String, '2147483647'
+
+        # @return [String] whether or not this should only be processed before
+        #   deployment. Can be either '0', or '1'.
+        #
+        # This option is exposed in Xcode in the UI of PBXCopyFilesBuildPhase as
+        # `Copy only when installing` or in PBXShellScriptBuildPhase as `Run
+        # script only when installing`.
+        #
+        attribute :run_only_for_deployment_postprocessing, String, '0'
 
-        has_one :file, :uuid => :file_ref
       end
 
-      class PBXBuildPhase < AbstractPBXObject
-        has_many :build_files, :uuids => :files, :uuids_as => :build_file_references
+      ### Phases that can appear only once in a target. ########################
 
-        # [String] some kind of magic number which seems to always be '2147483647'
-        attribute :build_action_mask
+      # The phase responsible of copying headers (aka `Copy Headers`).
+      #
+      class PBXHeadersBuildPhase < AbstractBuildPhase
 
-        # [String] wether or not this should only be processed before deployment
-        #          (I guess). This cane be either '0', or '1'
-        attribute :run_only_for_deployment_postprocessing
+      end
 
-        def initialize(*)
-          super
-          self.build_file_references ||= []
-          # These are always the same, no idea what they are.
-          self.build_action_mask ||= "2147483647"
-          self.run_only_for_deployment_postprocessing ||= "0"
-        end
+      # The phase responsible of compiling the files (aka `Compile Sources`).
+      #
+      class PBXSourcesBuildPhase < AbstractBuildPhase
 
-        def files
-          PBXObjectList.new(PBXFileReference, @project) do |list|
-            list.let(:uuid_scope) { self.build_files.map(&:file_ref) }
-            list.let(:push) do |file|
-              self.build_files << file.build_files.new
-            end
-          end
-        end
+      end
+
+      # The phase responsible on linking with frameworks (aka `Link Binary With
+      # Libraries`).
+      #
+      class PBXFrameworksBuildPhase < AbstractBuildPhase
 
-        def <<(file)
-          files << file
-        end
       end
 
-      class PBXCopyFilesBuildPhase < PBXBuildPhase
-        # [String] the path where this file should be copied to
-        attribute :dst_path
+      # The resources build phase apparently is a specialized copy build phase
+      # for resources (aka `Copy Bundle Resources`). It is unclear if this is
+      # the only one capable of optimize PNG.
+      #
+      class PBXResourcesBuildPhase < AbstractBuildPhase
+
+      end
 
-        # [String] a magic number which always seems to be "16"
-        attribute :dst_subfolder_spec
+      ### Phases that can appear multiple times in a target. ###################
+
+      # Phase that copies the files to the bundle of the target (aka `Copy
+      # Files`).
+      #
+      class PBXCopyFilesBuildPhase < AbstractBuildPhase
+
+        # @return [String] the name of the build phase.
+        #
+        attribute :name, String
+
+        # @return [String] the subpath of `dst_subfolder_spec` where this file
+        #   should be copied to.
+        #
+        #   Can accept environment variables like `$(PRODUCT_NAME)`.
+        #
+        attribute :dst_path, String, ''
+
+        # @return [String] the path (destination) where the files should be
+        #   copied to.
+        #
+        attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]
 
-        def initialize(*)
-          super
-          self.dst_path ||= '$(PRODUCT_NAME)'
-          self.dst_subfolder_spec ||= "16"
-        end
       end
 
-      class PBXResourcesBuildPhase < PBXBuildPhase;   end
-      class PBXSourcesBuildPhase < PBXBuildPhase;     end
-      class PBXFrameworksBuildPhase < PBXBuildPhase;  end
+      # A phase responsible of running a shell script (aka `Run Script`).
+      #
+      class PBXShellScriptBuildPhase < AbstractBuildPhase
+
+        # @return [String] the name of the build phase.
+        #
+        attribute :name, String
+
+        # @return [Array<String>] an array of the paths to pass to the script.
+        #
+        # @example
+        #   "$(SRCROOT)/myfile"
+        #
+        attribute :input_paths, Array, []
+
+        # @return [Array<String>] an array of output paths of the script.
+        #
+        # @example
+        #   "$(DERIVED_FILE_DIR)/myfile"
+        #
+        attribute :output_paths, Array, []
+
+        # @return [String] the path to the script interpreter.
+        #
+        # Defaults to `/bin/sh`.
+        #
+        attribute :shell_path, String, '/bin/sh'
+
+        # @return [String] the actual script to perform.
+        #
+        # Defaults to the empty string.
+        #
+        attribute :shell_script, String, ''
 
-      # @todo Should `files`, `input_paths`, and `output_paths` be has_many
-      #       associations with file references?
-      class PBXShellScriptBuildPhase < PBXBuildPhase
-        attribute :name
+      end
 
-        attribute :files
-        attribute :input_paths
-        attribute :output_paths
+      class AbstractBuildPhase < AbstractObject
 
-        # [String] The path to the script interpreter. Defaults to `/bin/sh`.
-        attribute :shell_path
+        ## CONVENIENCE METHODS #################################################
 
-        # [String] The actual script to perform.
-        attribute :shell_script
+        # @!group Convenience methods
 
-        def initialize(*)
-          super
-          self.files        ||= []
-          self.input_paths  ||= []
-          self.output_paths ||= []
+        # @return [Array<PBXFileReference>] the list of all the files
+        #   referenced by this build phase.
+        #
+        def files_references
+          files.map { |bf| bf.file_ref }.uniq
+        end
 
-          self.shell_path   ||= '/bin/sh'
-          self.shell_script ||= ''
+        # Adds a new build file, initialized with the given file reference, to
+        # the phase.
+        #
+        # @param [PBXFileReference] file
+        #   the file reference that should be added to the build phase.
+        #
+        # @return [PBXBuildFile] the build file generated.
+        #
+        def add_file_reference(file)
+          build_file = project.new(PBXBuildFile)
+          build_file.file_ref = file
+          files << build_file
+          build_file
+        end
+        
+        def remove_file_reference(file)
+          build_file = files.find { |bf| bf.file_ref == file }
+          files.delete(build_file)
+          build_file.file_ref = nil
+          build_file.remove_from_project
         end
       end
-
     end
   end
 end

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

@@ -0,0 +1,46 @@
+module Xcodeproj
+  class Project
+    module Object
+
+      # This class represents a custom build rule of a Target.
+      #
+      class PBXBuildRule < AbstractObject
+
+        # @return [String] the name of the rule.
+        #
+        attribute :name, String
+
+        # @return [String] a string representing what compiler to use.
+        #
+        #   E.g. `com.apple.compilers.proxy.script`.
+        #
+        attribute :compiler_spec, String
+
+        # @return [String] the type of the files that should be processed by
+        #   this rule.
+        #
+        #   E.g. `pattern.proxy`.
+        #
+        attribute :file_type, String
+
+        # @return [String] whether the rule is editable.
+        #
+        #   E.g. `1`.
+        #
+        attribute :is_editable, String, '1'
+
+        # @return [ObjectList<PBXFileReference>] the file references for the
+        #   output files.
+        #
+        has_many :output_files, PBXFileReference
+
+        # @return [String] the content of the script to use for the build rule.
+        #
+        #   Present if the #{#compiler_spec} is `com.apple.compilers.proxy.script`
+        #
+        attribute :script, String
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+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
+
+        # @return [String] whether the default configuration is visible.
+        #
+        # Usually `0`.
+        #
+        attribute :default_configuration_is_visible, String, '0'
+
+        # @return [String] the name of the default configuration.
+        #
+        # Usually `Release`.
+        #
+        attribute :default_configuration_name, String
+
+        # @return [ObjectList<XCBuildConfiguration>] the build
+        #   configurations of the target.
+        #
+        has_many :build_configurations, XCBuildConfiguration
+
+        ## CONVENIENCE METHODS #################################################
+
+        # @!group Convenience methods
+
+        # Returns the build settings of the build configuration with
+        # the given name.
+        #
+        # @param [String] build_configuration_name
+        #   the name of the build configuration.
+        #
+        # @return [Hash {String=>String}] the build settings
+        #
+        def build_settings(build_configuration_name)
+          if config = build_configurations.find { |bc| bc.name == build_configuration_name }
+            config.build_settings
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Xcodeproj
+  class Project
+    module Object
+
+      # Apparently a proxy for another object which might belong another
+      # project contained in the same workspace of the project document.
+      #
+      # This class is referenced by {PBXTargetDependency}; for information
+      # about it usage see the specs of that class.
+      #
+      # @note This class references the other objects by uuid instead of
+      #       creating proper relationships because the other objects might be
+      #       part of another project. This implies that the references to
+      #       other objects should not increase the retain coutn of the
+      #       targets.
+      #
+      # @todo: this class needs some work to support targets accross workspaces,
+      #        as the container portal might not be initialized leading
+      #        xcodproj to raise because ti can't find the UUID.
+      #
+      class PBXContainerItemProxy < AbstractObject
+
+        # @return [String] apparently the UUID of the root object
+        #   {PBXProject} of the project containing the represented object.
+        #
+        attribute :container_portal, String
+
+        # @return [String] the type of the proxy.
+        #
+        # - {PBXNativeTarget} is `1`.
+        #
+        attribute :proxy_type, String
+
+        # @return [String] apparently the UUID of the represented
+        #   object.
+        #
+        # @note If the object is in another project this will return nil.
+        #
+        attribute :remote_global_id_string, String
+
+        # @return [String] apparently the name of the object represented by
+        #   the proxy.
+        #
+        attribute :remote_info, String
+
+      end
+    end
+  end
+end

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

@@ -1,71 +1,103 @@
-require 'xcodeproj/project/object/group'
-
 module Xcodeproj
   class Project
     module Object
 
-      # @todo Add a list of all possible file types for `explicit_file_type`
-      #       and `last_known_file_type`.
-      class PBXFileReference < AbstractGroupEntry
-        # [String] the path to the file relative to the source tree
-        attribute :path
+      # This class represents a reference to a file in the file system.
+      #
+      class PBXFileReference < AbstractObject
 
-        # [String] the source tree to which the file is relative. It can be one
-        #          of `SOURCE_ROOT` or `SDKROOT`
-        attribute :source_tree
+        # @return [String] the name of the reference, often not present.
+        #
+        attribute :name, String
 
-        # [String] the file type regardless of what Xcode might think it is
-        attribute :explicit_file_type
+        # @return [String] the path to the file relative to the source tree
+        #
+        attribute :path, String
 
-        # [String] the file type guessed by Xcode
-        attribute :last_known_file_type
+        # @return [String] the source tree to which the file is relative.
+        #
+        # Common values are `SOURCE_ROOT`, `SDKROOT` and `BUILT_PRODUCTS_DIR`
+        #
+        attribute :source_tree, String, 'SOURCE_ROOT'
 
-        # [String] wether of not this file should be indexed. This can be
-        #          either "0" or "1".
-        attribute :include_in_index
+        # @return [String] the file type (apparently) used for products
+        #   generated by Xcode (i.e. applications, libraries).
+        #
+        attribute :explicit_file_type, String
 
-        has_many :build_files, :inverse_of => :file
+        # @return [String] the file type guessed by Xcode.
+        #
+        # This attribute is not present if there is an `explicit_file_type`.
+        #
+        attribute :last_known_file_type, String
 
-        def self.new_static_library(project, product_name)
-          new(project, nil,
-            "includeInIndex" => "0",
-            "sourceTree" => "BUILT_PRODUCTS_DIR",
-            "path" => "lib#{product_name}.a"
-          )
-        end
+        # @return [String] whether this file should be indexed. It can
+        #   be either `0` or `1`.
+        #
+        # Apparently present only for products generated by Xcode with a value
+        # of `0`.
+        #
+        attribute :include_in_index, String, '1'
 
-        def initialize(*)
-          super
-          self.path = path if path # sets default name
-          self.source_tree ||= 'SOURCE_ROOT'
-          self.include_in_index ||= "1"
-          set_default_file_type!
-        end
+        # @return [String] a string containing a number which represents the
+        #   encoding format of the file.
+        #
+        attribute :fileEncoding, String
+
+        # @return [String] a string that specifies the UTI for the syntax
+        #   highlighting.
+        #
+        #   E.g. `xcode.lang.ruby`
+        #
+        attribute :xc_language_specification_identifier, String
+
+        # @return [String] a string that specifies the UTI for the structure of
+        #   a plist file.
+        #
+        #   E.g. `com.apple.xcode.plist.structure-definition.iphone.info-plist`
+        #
+        attribute :plist_structure_definition_identifier, String
+
+
+        ## CONVENIENCE METHODS #################################################
 
-        alias_method :_path=, :path=
-        def path=(path)
-          self._path = path
-          self.name ||= pathname.basename.to_s
-          path
+        # @!group Convenience methods
+
+        # @return [String] the name of the file taking into account the path if
+        #   needed.
+        #
+        def display_name
+          name || File.basename(path)
         end
 
+        # @return [Pathname] the path of the file.
+        #
         def pathname
           Pathname.new(path)
         end
 
-        def set_default_file_type!
-          return if explicit_file_type || last_known_file_type
-          case path
-          when /\.a$/
-            self.explicit_file_type = 'archive.ar'
-          when /\.framework$/
-            self.last_known_file_type = 'wrapper.framework'
-          when /\.xcconfig$/
-            self.last_known_file_type = 'text.xcconfig'
-          end
+        # @return [PBXGroup] the group that contains the current file reference.
+        #
+        def group
+          referrers.select { |r| r.class == PBXGroup }.first
+        end
+
+        # @return [Array<PBXBuildFile>] the build files associated with the
+        #   current file reference.
+        #
+        def build_files
+          referrers.select { |r| r.class == PBXBuildFile }
         end
-      end
 
+        # Sets the last known file type according to the extension of the path.
+        #
+        # @return [String] the computed file type.
+        #
+        def update_last_known_file_type
+          self.last_known_file_type = Constants::FILE_TYPES_BY_EXTENSION[pathname.extname[1..-1]]
+        end
+        
+      end
     end
   end
 end