vendor 0.1.5 → 0.1.6

data/lib/vendor/vendor_file/loader.rb

@@ -23,6 +23,14 @@ module Vendor
         self.libraries = @dsl.libraries
       end
 
+      def libraries_to_install
+        unless @graph.version_conflicts?
+          @graph.libraries_to_install.each do |library,targets|
+            yield library, targets if block_given?
+          end
+        end
+      end
+      
       def install(project)
         unless @graph.version_conflicts?
           @graph.libraries_to_install.each do |lib|

data/lib/vendor/vendor_spec/builder.rb

@@ -43,37 +43,48 @@ module Vendor
 
       private
 
+        # Find all the files within the vendor spec to install
+        def vendor_spec_files_to_install
+          Array(@vendor_spec.files) + Array(@vendor_spec.resources)
+        end
+
         def copy_files(data_dir)
           data_files = []
 
           raise NoFilesError.new("No file definition found for #{@name}") if @vendor_spec.files.nil?
 
-          # Remove files that are within folders with a ".", such as ".bundle"
-          # and ".frameworks"
-          copy_files = @vendor_spec.files.reject { |file| file =~ /\/?[^\/]+\.[^\/]+\// }
+          copy_files = vendor_spec_files_to_install
 
           raise NoFilesError.new("No files found for packaging") if copy_files.empty?
 
           copy_files.each do |file|
             dir = File.dirname(file)
             path = File.join(@folder, file)
-            copy_to_dir = File.expand_path(File.join(data_dir, dir))
-            copy_to_file = File.join(copy_to_dir, File.basename(file))
+            if File.directory? path
+              copy_to_dir = File.expand_path(File.join(data_dir, dir, File.basename(file)))
+              copy_to_file = File.expand_path(copy_to_dir)
+            else
+              copy_to_dir = File.expand_path(File.join(data_dir, dir))
+              copy_to_file = File.join(copy_to_dir, File.basename(file))
+            end
 
             Vendor.ui.debug "Creating dir #{copy_to_dir}"
             FileUtils.mkdir_p copy_to_dir
 
             Vendor.ui.debug "Copying #{path} to #{copy_to_file}"
-            FileUtils.cp_r path, copy_to_file
+            FileUtils.copy_entry path, copy_to_file
 
             data_files << copy_to_file
+            if File.directory?(path)
+              data_files.concat(Dir.glob(File.join(copy_to_file, "**", "*")))
+            end
           end
-
+          
           data_files
         end
 
         def zip_file(filename, files, base_dir)
-          Zip::ZipFile.open(filename, Zip::ZipFile::CREATE)do |zipfile|
+          Zip::ZipFile.open(filename, Zip::ZipFile::CREATE) do |zipfile|
 
             files.each do |file|
               path = file.gsub(base_dir, '').gsub(/^\//, '')

data/lib/vendor/xcode.rb

@@ -2,7 +2,6 @@ module Vendor
 
   module XCode
 
-    autoload :Proxy,   "vendor/xcode/proxy"
     autoload :Project, "vendor/xcode/project"
 
   end

data/lib/vendor/xcode/project.rb

@@ -1,503 +1,232 @@
-require 'json'
+require 'xcoder'
 
 module Vendor::XCode
 
   class Project
 
-    # Build settings and the format that they should be stored in
-    BUILD_SETTING_TYPES = {
-      "OTHER_LDFLAGS" => :array
-    }
-
-    require 'fileutils'
-
-    attr_reader :name
-    attr_reader :object_version
-    attr_reader :archive_version
-    attr_reader :objects
-    attr_reader :root_object
-    attr_reader :project_folder
-
-    attr_accessor :dirty
+    attr_reader :project
 
     def initialize(project_folder)
-      @project_folder = project_folder
-      @pbxproject = ::File.join(project_folder, "project.pbxproj")
-      @name = File.basename(project_folder).split(".").first
-      @dirty = false
-
-      reload
-    end
-
-    def reload
-      # We switch between our custom PList converter and the JSON format
-      # because the custom implementation isn't very reliable. We use it mainly
-      # so the gem can run on systems that don't have plutil installed (like our
-      # CI server). The plutil app is far more reliable.
-      if RUBY_PLATFORM !~ /darwin/ || ENV['PARSER'] == 'custom'
-        contents = File.readlines(@pbxproject).join("\n")
-        parsed = Vendor::Plist.parse_ascii(contents)
-      else
-        parsed = JSON.parse(`plutil -convert json -o - "#{@pbxproject}"`)
-      end
-
-      @object_version = parsed['objectVersion'].to_i
-      @archive_version = parsed['archiveVersion'].to_i
-
-      @objects_by_id = {}
-
-      @objects = parsed['objects'].map do |id, attributes|
-        begin
-          klass = Vendor::XCode::Proxy.const_get(attributes['isa'])
-        rescue NameError => e
-          klass = Vendor::XCode::Proxy::Unknown
-        end
-
-        @objects_by_id[id] = klass.new(:project => self, :id => id, :attributes => attributes)
-      end
-
-      @objects.each { |object| object.send(:after_initialize) }
-
-      @root_object = @objects_by_id[parsed['rootObject']]
-    end
-
-    def find_object(id)
-      @objects_by_id[id]
-    end
-
-    def find_target(t)
-      # Are we already a target?
-      if t.kind_of?(Vendor::XCode::Proxy::Base)
-        t
+      @project = Xcode.project project_folder
+    end
+    
+    #
+    # Install the library into the project for the selected targets.
+    # 
+    # @param [Library] library the instance that conveys the requirements to 
+    #   install.
+    # @param [Array<Symbols>] targets to install this library; The value :all 
+    #   is a special target name that means all targets.
+    #
+    def install(library,targets)
+      
+      Vendor.ui.info "## Installing __#{library.name} (#{library.version})__\n\n"
+
+      project_targets = project_targets_from_specified_targets(targets)
+      
+      if project_targets.empty?
+        Vendor.ui.warn "* The project '#{project.name}' does not have any matching targets: #{targets.join(", ")}"
+        return
+      end
+      
+      library_pathname = "Vendor/#{library.name}"
+      
+      files_added = create_library_folders_and_groups library_pathname, library.files
+      
+      resources_added = create_library_folders_and_groups library_pathname, library.resources, 'resource'
+      
+      frameworks_added = add_required_frameworks_to_project library.frameworks
+  
+     
+      source_files = files_added.find_all {|file| File.extname(file.path.to_s) =~ /\.mm?$/ }
+
+      framework_files = frameworks_added + files_added.find_all {|file| File.extname(file.path.to_s) =~ /\.a$|\.framework$/ }
+
+      
+      project_targets.each do |target|
+        
+        Vendor.ui.info "\n### Configuring Build Target '__#{target.name}__'\n\n"
+        
+        add_source_files_to_sources_build_phase source_files, target.sources_build_phase, library.per_file_flag
+        
+        add_resource_files_to_resources_build_phase resources_added, target.resources_build_phase
+        
+        add_frameworks_to_frameworks_build_phase framework_files, target.framework_build_phase
+        
+        add_build_settings_to_target_configurations target, library.build_settings
+        
+      end
+    
+      project.save!
+      
+    end
+    
+    private
+    
+    
+    #
+    # Convert the target names to the actual target objects within the project
+    # 
+    # @param [Array<Symbols>] targets to install this library; The value :all 
+    #   is a special target name that means all targets.
+    #
+    # @return [Array<Target>] the targets that match the specified target names.
+    # 
+    def project_targets_from_specified_targets(specified_targets)
+      
+      if specified_targets == [:all]
+        
+        project.targets
+        
       else
-        root_object.targets.find { |x| x.name == t }
-      end
-    end
-
-    def find_group(path)
-      current = root_object.main_group
-
-      path.split("/").each do |name|
-        current = current.children.find { |x| (x.respond_to?(:name) ? x.name : x.path) == name }
-        return nil unless current
-      end
-
-      current
-    end
-
-    def create_group(path)
-      current = root_object.main_group
-
-      path.split("/").each do |name|
-        group = current.children.find { |x| (x.respond_to?(:name) ? x.name : x.path) == name }
-
-        unless group
-          group = Vendor::XCode::Proxy::PBXGroup.new(:project => self,
-                                                          :id => Vendor::XCode::Proxy::Base.generate_id,
-                                                  :attributes => { 'path' => name, 'sourceTree' => '<group>', 'children' => [] })
-
-          # Set the parent
-          group.parent = current
-
-          @objects_by_id[group.id] = group
-
-          # This is hacky
-          current.attributes['children'] << group.id
-        end
-
-        current = group
-      end
-
-      # Mark as dirty
-      @dirty = true
-
-      current
-    end
-
-    def remove_group(path)
-      group = find_group(path)
-
-      # If we have the group
-      if group
-
-        ids_to_remove = []
-
-        # Remove the children from the file system
-        group.children.each do |child|
-          if child.group? # Is it a group?
-            remove_group child.full_path # Recursivley remove the child group
-          elsif child.file? # Or a file
-            file = File.expand_path(File.join(@project_folder, "..", child.full_path))
-
-            # Remove the file from the filesystem
-            if File.exist?(file)
-              FileUtils.rm_rf file
-            end
-          else
-            Vendor.ui.error "Couldn't remove object: #{child}"
-          end
-
-          # Remove from the targets (if we can)
-          root_object.targets.each { |t| remove_file_from_target(child, t) }
-
-          # Remove the file from the parent
-          child.parent.attributes['children'].delete child.id
-
-          # Add the id to the list of stuff to remove. If we do this
-          # during the loop, bad things happen - not sure why.
-          ids_to_remove << child.id
-        end
-
-        # Remove the group from the parent
-        group.parent.attributes['children'].delete group.id
-
-        # Add to the list of stuff to remove
-        ids_to_remove << group.id
-
-        ids_to_remove.each do |id|
-          @objects_by_id.delete id
+        
+        # Take each specified target names and compare those with the targets
+        # specified within the project. Find all that match and return them,
+        # ignoring aggregate targets that may match the name as they are
+        # not capable of love that comes with bearing files.
+        
+        # @note project#target(name) seems like it would be a better choice,
+        #    however, the Xcoder implementation raises an error when a target
+        #    does not match the specified name.
+        
+        specified_targets.uniq.map do |name| 
+          
+          project.targets.reject {|target| target.isa == "PBXAggregateTarget" }.find_all {|target| target.name == name }
+          
+        end.flatten
+      end
+      
+    end
+    
+    #
+    # 
+    # @param [String] pathname the path to create for the library
+    # @param [Array<String>] files to copy into the project and create in the
+    #   project.
+    # @return [Array<FileReference>] an array of all the files that were added 
+    #   to the project.
+    #
+    def create_library_folders_and_groups(pathname,files,section="")
+      
+      # Create the physical path for the library
+      
+      FileUtils.mkdir_p pathname
+      
+      # Create the project's logical group for the library
+      
+      library_group = project.group pathname
+      
+      Vendor.ui.info "* Installing #{files.count} #{section} file(s)\n\n"
+      
+      files.map do |file| 
+        
+        target_filepath = "#{pathname}/#{File.basename(file)}"
+        
+        Vendor.ui.debug "    > from: #{file}\n\n"
+        Vendor.ui.debug "    >   to: #{target_filepath}\n\n"
+   
+        # Copy the physical file to the library path
+        
+        FileUtils.cp_r file, target_filepath 
+        
+        # Copy the project's logical files
+        
+        library_group.create_file 'name' => File.basename(file), 'path' => target_filepath, 'sourceTree' => 'SOURCE_ROOT'
+        
+      end.compact
+      
+    end
+    
+    #
+    # @param [Array<String>] frameworks to add to the frameworks section of the
+    #   project.
+    # @return [Array<FileReference>] an array of all the frameworks and system
+    #   libraries that were added to the project.
+    #
+    def add_required_frameworks_to_project(frameworks)
+      frameworks.map do |framework_name|
+        if File.extname(framework_name) =~ /^\.dylib$/
+          project.frameworks_group.create_system_library(framework_name)
+        else
+          project.frameworks_group.create_system_framework(framework_name)
         end
-
-        # Mark as dirty
-        @dirty = true
-
-      else
-        false
       end
     end
-
-    def add_framework(framework, options = {})
-      # Find targets and filter out aggregate targets (we can't add files to
-      # those bad boys)
-      targets = targets_from_options(options, :ignore_aggregates => true)
-
-      Vendor.ui.debug %{Adding #{framework} to targets "#{targets.map(&:name)}"}
-
-      path = if framework.match(/\.dylib/)
-        "usr/lib/#{framework}"
-      else
-        "System/Library/Frameworks/#{framework}"
-      end
-
-      targets.each do |t|
-        # Does the framework already exist?
-        build_phase = build_phase_for_file("wrapper.framework", t)
-
-        if build_phase
-          # Does a framework already exist?
-          existing_framework = build_phase.files.map(&:file_ref).find do |file|
-            # Some files have names, some done. Framework references
-            # have names...
-            if file.respond_to?(:name)
-              file.name == framework
-            end
-          end
-
-          # If an existing framework was found, don't add it again
-          unless existing_framework
-            add_file :targets => t, :file => path, :name => framework,
-                     :path => "Frameworks", :source_tree => :sdkroot
-          end
-        end
+    
+    
+    def add_source_files_to_sources_build_phase files, sources_build_phase, per_file_flag
+      
+      unless sources_build_phase
+        Vendor.ui.warn "* No sources build phase exists for this target\n"
+        return
       end
-    end
-
-    def add_build_setting(name, value, options = {})
-
-      targets_from_options(options).each do |target|
-
-        target.build_configuration_list.build_configurations.each do |config|
-
-          build_settings = config.build_settings
-
-          debug_key = "#{target.name}/#{config.name}".inspect
-
-          # If the build setting already has the key
-          if build_settings.has_key?(name)
-
-            # Is this setting known to have multiple values?
-            if (setting_type = BUILD_SETTING_TYPES[name])
-
-              # If its an array
-              if setting_type == :array
-                # Is it already an array, if so, check to see if
-                # it already exists, and if it doesn't add it.
-                if build_settings[name].kind_of?(Array)
-                  unless build_settings[name].include?
-                    Vendor.ui.debug("  Added build setting (#{name.inspect} = #{value.inspect}) to #{debug_key}")
-
-                    build_settings[name] << value
-                  end
-                else
-                  Vendor.ui.debug("  Added build setting (#{name.inspect} = #{value.inspect}) to #{debug_key}")
-
-                  # Don't add it if the single build value is already there
-                  unless build_settings[name].strip == value.strip
-                    build_settings[name] = [ build_settings[name], value ]
-                  end
-                end
-              end
-
-            else
-              # If its an unknown type, then we should just throw a warning
-              # because we should'nt just change stuff willy, nilly.
-              Vendor.ui.warn("  Build setting #{name.inspect} wanted to change to #{value.inspect}, but it was already #{build_settings[name].inspect} in #{debug_key}")
-            end
-
-          else
-            Vendor.ui.debug("  Added build setting (#{name.inspect} = #{value.inspect}) to #{debug_key}")
 
-            build_settings[name] = value
-          end
+      Vendor.ui.info "* Sources Build Phase - adding #{files.count} file(s)\n\n"
+      
+      files.each do |file|
 
+        Vendor.ui.debug "    > #{file.path}\n\n"
+        
+        if per_file_flag
+          sources_build_phase.add_build_file file, { 'COMPILER_FLAGS' => per_file_flag }
+        else
+          sources_build_phase.add_build_file file
         end
-
       end
-
-      @dirty = true
-
     end
+    
+    def add_resource_files_to_resources_build_phase files, resources_build_phase
 
-    def add_file(options)
-      require_options options, :path, :file, :source_tree
-
-      # Ensure file exists if we'nre not using the sdk root source tree.
-      # The SDKROOT source tree has a virtual file on the system, so
-      # File.exist checks will always return false.
-      unless options[:source_tree] == :sdkroot
-        raise StandardError.new("Could not find file `#{options[:file]}`") unless File.exists?(options[:file])
+      unless resources_build_phase
+        Vendor.ui.warn "* No resources build phase exists for this target\n"
+        return
       end
+      
+      Vendor.ui.info "* Resources Build Phase - adding #{files.count} file(s)\n\n"
+      
+      files.each do |file|
 
-      # Find targets and filter out aggregate targets (we can't add files to
-      # those bad boys)
-      targets = targets_from_options(options, :ignore_aggregates => true)
-
-      # Create the group
-      group = create_group(options[:path])
-
-      # File type
-      type = Vendor::XCode::Proxy::PBXFileReference.file_type_from_extension(File.extname(options[:file]))
-
-      # The file name
-      name = File.basename(options[:file])
-
-      attributes = {
-        'lastKnownFileType' => type,
-        'sourceTree' => "<#{options[:source_tree].to_s}>"
-      }
-
-      # Handle the different source tree types
-      if options[:source_tree] == :group
-
-        # Ensure the path exists on the filesystem
-        path = File.join(@project_folder, "..", options[:path])
-        FileUtils.mkdir_p path
-
-        # Copy the file
-        FileUtils.cp_r options[:file], File.join(path, name)
-
-        # Set the path of the file
-        attributes['path'] = name
-
-      elsif options[:source_tree] == :absolute
-
-        # Set the path and the name of the file
-        attributes['name'] = name
-        attributes['path'] = options[:file]
-
-      elsif options[:source_tree] == :sdkroot
-
-        # Set the path and the name of the framework
-        attributes['name'] = name
-        attributes['path'] = options[:file]
-        attributes['sourceTree'] = "SDKROOT"
-
-      else
-
-        # Could not handle that option
-        raise StandardError.new("Invalid :source_tree option `#{options[:source_tree].to_s}`")
-
-      end
-
-      # Add the file to XCode
-      file = Vendor::XCode::Proxy::PBXFileReference.new(:project => self,
-                                                             :id => Vendor::XCode::Proxy::Base.generate_id,
-                                                     :attributes => attributes)
-
-      # Set the parent
-      file.parent = group
-
-      # Add the file id to the groups children
-      group.attributes['children'] << file.id
-
-      # Add the file to targets
-      targets.each do |t|
-        add_file_to_target file, t
+        Vendor.ui.debug "    > #{file.path}\n\n"
+        
+        resources_build_phase.add_build_file file
       end
-
-      # Mark as dirty
-      @dirty = true
-
-      # Add the file to the internal index
-      @objects_by_id[file.id] = file
     end
+    
+    def add_frameworks_to_frameworks_build_phase frameworks, framework_build_phase
 
-    def remove_file_from_target(file, target)
-
-      # Search through all the build phases for references to the file
-      build_files = []
-      target.build_phases.each do |phase|
-        build_files << phase.files.find_all do |build_file|
-          build_file.attributes['fileRef'] == file.id
-        end
+      unless framework_build_phase
+        Vendor.ui.warn "* No framework build phase exists for this target\n"
+        return
       end
 
-      # Remove the build files from the references
-      build_files.flatten.each do |build_file|
-        build_file.parent.attributes['files'].delete build_file.id
-        @objects_by_id.delete build_file.id
-      end
-
-    end
-
-    def add_file_to_target(file, target)
-
-      build_phase = build_phase_for_file(file.last_known_file_type, target)
-
-      if build_phase
-
-        Vendor.ui.debug "Adding #{file.attributes} to #{target.name} (build_phase = #{build_phase.class.name})"
-
-        # Add the file to XCode
-        build_file = Vendor::XCode::Proxy::PBXBuildFile.new(:project => self,
-                                                                 :id => Vendor::XCode::Proxy::Base.generate_id,
-                                                         :attributes => { 'fileRef' => file.id })
-
-        # Set the parent
-        build_file.parent = build_phase
-
-        # Add the file to the internal index
-        @objects_by_id[build_file.id] = build_file
-
-        # Add the file to the build phase
-        build_phase.attributes['files'] << build_file.id
-
+      Vendor.ui.info "* Frameworks Build Phase - adding #{frameworks.count} framework(s)\n\n"
+      
+      frameworks.each do |framework|
+        
+        Vendor.ui.debug "    > #{framework.name}\n\n"
+        
+        framework_build_phase.add_build_file framework
       end
-
-    end
-
-    def to_ascii_plist
-      plist = { :archiveVersion => archive_version,
-                :classes => {},
-                :objectVersion => object_version,
-                :objects => @objects_by_id,
-                :rootObject => @root_object.id }.to_ascii_plist
-
-      "// !$*UTF8*$!\n" << plist
-    end
-
-    def save
-      backup
-      open(@pbxproject, 'w+') do |f|
-        f << to_ascii_plist
-      end if valid?
-
-      # Not dirty anymore
-      @dirty = false
     end
+    
+    def add_build_settings_to_target_configurations target, build_settings
+     
+      Vendor.ui.info "* Build Configuration Settings\n\n"
+      
+      target.configs.each do |config|
+        
+        Vendor.ui.debug "    > #{config.name} Configuration\n\n"
+        
+        build_settings.each do |name,value| 
+          
+          Vendor.ui.debug "    > Setting `#{name}` to `#{value}`\n\n"
+          
+          config.append name, value
 
-    def backup
-      dir = File.dirname(@project_folder)
-      backup_name = "#{@name}.vendorbackup"
-      backups = Dir[File.join(dir, "#{backup_name}*")].sort
-
-      unless backups.empty?
-        if backups.last.match(/([\d]+)$/)
-          backup_name += ".#{$1.to_i + 1}"
-        else
-          backup_name += ".1"
         end
       end
-
-      backup_to = File.join(dir, backup_name)
-
-      Vendor.ui.warn "Backup created #{backup_to}"
-      FileUtils.cp_r @project_folder, backup_to
-    end
-
-    def dirty?
-      @dirty
     end
-
-    def valid?
-      begin
-        # Try and parse the plist again. If it parses, then we've
-        # got valid syntax, if it fails, it will raise a parse error. We
-        # know we've done something bad at this point.
-        Vendor::Plist.parse_ascii(to_ascii_plist)
-
-        true
-      rescue Vendor::Plist::AsciiParser::ParseError => e
-        Vendor.ui.error "There was an error converting the XCode project back to a Plist"
-        Vendor.ui.error e.inspect
-        Vendor.ui.debug to_ascii_plist
-
-        false
-      end
-    end
-
-    private
-
-      def build_phase_for_file(file_type, target)
-        # Which build phase does this file belong?
-        klass = case file_type
-          when "sourcecode.c.objc", "sourcecode.c.c"
-            Vendor::XCode::Proxy::PBXSourcesBuildPhase
-          when "wrapper.framework"
-            Vendor::XCode::Proxy::PBXFrameworksBuildPhase
-          when "compiled.mach-o.dylib"
-            Vendor::XCode::Proxy::PBXFrameworksBuildPhase
-        end
-
-        if klass
-          # Find the build phase
-          build_phase = target.build_phases.find { |phase| phase.kind_of?(klass) }
-          unless build_phase
-            Vendor.ui.error "Could not find '#{klass.name}' build phase for target '#{target.name}'"
-            exit 1
-          end
-          build_phase
-        else
-          false
-        end
-      end
-
-      def require_options(options, *keys)
-        keys.each { |k| raise StandardError.new("Missing :#{k} option") unless options[k] }
-      end
-
-      def targets_from_options(options, opts = {})
-        targets = if options[:targets]
-          [ *options[:targets] ].map do |t|
-            if t == :all
-              root_object.targets
-            else
-              target = find_target(t)
-              raise StandardError.new("Could not find target '#{t}' in project '#{name}'") unless target
-              target
-            end
-          end.flatten.uniq
-        else
-          root_object.targets
-        end
-
-        if opts[:ignore_aggregates]
-          targets.reject { |t| t.kind_of? Vendor::XCode::Proxy::PBXAggregateTarget }
-        else
-          targets
-        end
-      end
-
+    
   end
 
 end