>PBXCopyFilesBuildPhase

PBXCopyFilesBuildPhase

Phase that copies the files to the bundle of the target (aka Copy Files).

Inherits from:

Xcodeproj::Project::Object::AbstractBuildPhase

Attributes

name

dst_path

dst_subfolder_spec

files

build_action_mask

run_only_for_deployment_postprocessing

comments

Helpers

files_references

add_file_reference

remove_file_reference

remove_build_file

clear_build_files

AbstractObject

isa

initialize

initialize_defaults

uuid

project

remove_from_project

display_name

to_s

Reference counting

referrers

add_referrer

remove_referrer

remove_reference

Object methods

==

<=>

inspect

xcodeproj format attributes

name

Signature

name #=> String 

Returns

String The name of the build phase.

Source

167 attribute :name, String

Source Files

lib/xcodeproj/project/object/build_phase.rb:167

spec/project/object/build_phase_spec.rb

dst_path

Signature

dst_path #=> String 

Returns

String

The subpath of dst_subfolder_spec where this file should be copied to.

Source

174 attribute :dst_path, String, ''

Source Files

lib/xcodeproj/project/object/build_phase.rb:174

spec/project/object/build_phase_spec.rb

dst_subfolder_spec

Signature

dst_subfolder_spec #=> String 

Returns

String

The path (destination) where the files should be copied to.

Source

179 attribute :dst_subfolder_spec, String, Constants::COPY_FILES_BUILD_PHASE_DESTINATIONS[:resources]

Source Files

lib/xcodeproj/project/object/build_phase.rb:179

spec/project/object/build_phase_spec.rb

filesinherited

Signature

files #=> ObjectList<PBXBuildFile> 

Returns

ObjectList

The files processed by this build configuration.

Source

16 has_many :files, PBXBuildFile

Source Files

lib/xcodeproj/project/object/build_phase.rb:16

spec/project/object/build_phase_spec.rb

build_action_maskinherited

Signature

build_action_mask #=> String 

Returns

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).

Source

23 attribute :build_action_mask, String, '2147483647'

Source Files

lib/xcodeproj/project/object/build_phase.rb:23

spec/project/object/build_phase_spec.rb

run_only_for_deployment_postprocessinginherited

Signature

run_only_for_deployment_postprocessing #=> String 

Returns

String

Whether or not this should only be processed before deployment. Can be either '0', or '1'.

Source

33 attribute :run_only_for_deployment_postprocessing, String, '0'

Source Files

lib/xcodeproj/project/object/build_phase.rb:33

spec/project/object/build_phase_spec.rb

commentsinherited

Signature

comments #=> String 

Returns

String Comments associated with this build phase.

Source

39 attribute :comments, String

Source Files

lib/xcodeproj/project/object/build_phase.rb:39

spec/project/object/build_phase_spec.rb

files_referencesinherited

Signature

files_references #=> Array<PBXFileReference> 

Returns

Array

The list of all the files referenced by this build phase.

Source

50 def files_references
51   files.map { |bf| bf.file_ref }.uniq
52 end

Source Files

lib/xcodeproj/project/object/build_phase.rb:50

spec/project/object/build_phase_spec.rb

add_file_referenceinherited

Signature

add_file_reference(file) #=> PBXBuildFile 

Parameters

PBXFileReference file

The file reference that should be added to the build phase.

Returns

PBXBuildFile The build file generated.

Source

62 def add_file_reference(file)
63   build_file = project.new(PBXBuildFile)
64   build_file.file_ref = file
65   files << build_file
66   build_file
67 end

Source Files

lib/xcodeproj/project/object/build_phase.rb:62

spec/project/object/build_phase_spec.rb

remove_file_referenceinherited

Signature

remove_file_reference(file) #=> void 

Parameters

PBXFileReference file

The file to remove

Returns

void

Source

76 def remove_file_reference(file)
77   build_file = files.find { |bf| bf.file_ref == file }
78   if build_file
79     build_file.file_ref = nil
80     build_file.remove_from_project
81   end
82 end

Source Files

lib/xcodeproj/project/object/build_phase.rb:76

spec/project/object/build_phase_spec.rb

remove_build_fileinherited

Signature

remove_build_file(build_file) #=> void 

Parameters

PBXBuildFile build_file

The file to remove

Returns

void

Source

91 def remove_build_file(build_file)
92   build_file.file_ref = nil
93   build_file.remove_from_project
94 end

Source Files

lib/xcodeproj/project/object/build_phase.rb:91

spec/project/object/build_phase_spec.rb

clear_build_filesinherited

Signature

clear_build_files #=> void 

Returns

void

Source

101 def clear_build_files
102   files.objects.each do |bf|
103     remove_build_file(bf)
104   end
105 end

Source Files

lib/xcodeproj/project/object/build_phase.rb:101

spec/project/object/build_phase_spec.rb

isaclass methodinherited

Signature

isa #=> String 

Returns

String The ISA of the class.

Signature

isa #=> String 

Returns

String The object's class name.

Source

42 def self.isa
43   @isa ||= name.split('::').last
44 end

Source Files

lib/xcodeproj/project/object.rb:42

spec/project/object_spec.rb

initializeinherited

Signature

initialize(project, uuid) #=> AbstractObject 

Parameters

Project project

The project that will host the object.

String uuid

The UUID of the new object.

Returns

AbstractObject A new instance of AbstractObject

Source

64 def initialize(project, uuid)
65   @project, @uuid = project, uuid
66   @isa = self.class.isa
67   @referrers = []
68   raise "[Xcodeproj] Attempt to initialize an abstract class." unless @isa.match(/^(PBX|XC)/)
69 end

Source Files

lib/xcodeproj/project/object.rb:64

spec/project/object_spec.rb

initialize_defaultsinherited

Signature

initialize_defaults #=> void 

Returns

void

Source

81 def initialize_defaults
82   simple_attributes.each { |a| a.set_default(self) }
83 end

Source Files

lib/xcodeproj/project/object.rb:81

spec/project/object_spec.rb

uuidattribute readerinherited

Signature

uuid #=> String 

Returns

String The object universally unique identifier.

Source Files

lib/xcodeproj/project/object.rb:87

spec/project/object_spec.rb

projectattribute readerinherited

Signature

project #=> Project 

Returns

Project The project that owns the object.

Source Files

lib/xcodeproj/project/object.rb:91

spec/project/object_spec.rb

remove_from_projectinherited

Signature

remove_from_project #=> void 

Returns

void

Source

101 def remove_from_project
102   @project.objects_by_uuid.delete(uuid)
103   @referrers.each { |referrer| referrer.remove_reference(self) }
104   raise "[Xcodeproj] BUG: #{self} should have no referrers instead the following objects are still referencing it #{referrers}" unless referrers.count == 0
105 end

Source Files

lib/xcodeproj/project/object.rb:101

spec/project/object_spec.rb

display_nameinherited

Signature

display_name #=> String 

Returns

String A name for the object.

Aliases

Xcodeproj::Project::Object::AbstractObject#to_s

Source

115 def display_name
116   declared_name = name if self.respond_to?(:name)
117   if declared_name && !declared_name.empty?
118     declared_name
119   else
120     isa.gsub(/^(PBX|XC)/, '')
121   end
122 end

Source Files

lib/xcodeproj/project/object.rb:115

spec/project/object_spec.rb

to_sinherited

Signature

to_s #=> String 

Returns

String A name for the object.

Source

124 def display_name
125   declared_name = name if self.respond_to?(:name)
126   if declared_name && !declared_name.empty?
127     declared_name
128   else
129     isa.gsub(/^(PBX|XC)/, '')
130   end
131 end

Source Files

lib/xcodeproj/project/object.rb:124

spec/project/object_spec.rb

referrersattribute readerinherited

Signature

referrers #=> Array<ObjectList> 

Returns

Array

The list of the objects that have a reference to this object.

Source Files

lib/xcodeproj/project/object.rb:133

spec/project/object_spec.rb

add_referrerinherited

Signature

add_referrer(referrer) #=> void 

Returns

void

Source

143 def add_referrer(referrer)
144   @referrers << referrer
145   @project.objects_by_uuid[uuid] = self
146 end

Source Files

lib/xcodeproj/project/object.rb:143

spec/project/object_spec.rb

remove_referrerinherited

Signature

remove_referrer(referrer) #=> void 

Returns

void

Source

156 def remove_referrer(referrer)
157   @referrers.delete(referrer)
158   if @referrers.count == 0
159     @project.objects_by_uuid.delete(uuid)
160   end
161 end

Source Files

lib/xcodeproj/project/object.rb:156

spec/project/object_spec.rb

remove_referenceinherited

Signature

remove_reference(object) #=> void 

Returns

void

Source

169 def remove_reference(object)
170   to_one_attributes.each do |attrb|
171     value = attrb.get_value(self)
172     attrb.set_value(self, nil) if value.equal?(object)
173   end
174 
175   to_many_attributes.each do |attrb|
176     list = attrb.get_value(self)
177     list.delete(object)
178   end
179 
180   references_by_keys_attributes.each do |attrb|
181     list = attrb.get_value(self)
182     list.each { |dictionary| dictionary.remove_reference(object) }
183   end
184 end

Source Files

lib/xcodeproj/project/object.rb:169

spec/project/object_spec.rb

configure_with_plistinherited

Signature

configure_with_plist(objects_by_uuid_plist) #=> void 

Returns

void

Source

202 def configure_with_plist(objects_by_uuid_plist)
203   object_plist = objects_by_uuid_plist[uuid].dup
204 
205   raise "[Xcodeproj] Attempt to initialize `#{isa}` from plist with different isa `#{object_plist}`" unless object_plist['isa'] == isa
206   object_plist.delete('isa')
207 
208   simple_attributes.each do |attrb|
209     attrb.set_value(self, object_plist[attrb.plist_name])
210     object_plist.delete(attrb.plist_name)
211   end
212 
213   to_one_attributes.each do |attrb|
214     ref_uuid = object_plist[attrb.plist_name]
215     if ref_uuid
216       ref = object_with_uuid(ref_uuid, objects_by_uuid_plist, attrb)
217       attrb.set_value(self, ref) if ref
218     end
219     object_plist.delete(attrb.plist_name)
220   end
221 
222   to_many_attributes.each do |attrb|
223     ref_uuids = object_plist[attrb.plist_name] || []
224     list = attrb.get_value(self)
225     ref_uuids.each do |uuid|
226       ref = object_with_uuid(uuid, objects_by_uuid_plist, attrb)
227       list << ref if ref
228     end
229     object_plist.delete(attrb.plist_name)
230   end
231 
232   references_by_keys_attributes.each do |attrb|
233     hashes = object_plist[attrb.plist_name] || {}
234     list = attrb.get_value(self)
235     hashes.each do |hash|
236       dictionary = ObjectDictionary.new(attrb, self)
237       hash.each do |key, uuid|
238         ref = object_with_uuid(uuid, objects_by_uuid_plist, attrb)
239         dictionary[key] = ref if ref
240       end
241       list << dictionary
242     end
243     object_plist.delete(attrb.plist_name)
244   end
245 
246   unless object_plist.empty?
247     raise "[!] Xcodeproj doesn't know about the following attributes " \
248           "#{object_plist.inspect} for the '#{isa}' isa.\n" \
249           "Please file an issue: https://github.com/CocoaPods/Xcodeproj/issues/new"
250   end
251 end

Source Files

lib/xcodeproj/project/object.rb:202

spec/project/object_spec.rb

object_with_uuidinherited

Signature

object_with_uuid(uuid, objects_by_uuid_plist, attribute) #=> AbstractObject, Nil 

Parameters

String uuid

The UUID of the object that should be initialized.

Hash{String=>String} objects_by_uuid_plist

The hash contained by objects key of the plist containing the information about the object that should be initialized.

AbstractObjectAttribute attribute

The attribute that requested the object. It is used only for exceptions.

Returns

AbstractObject The initialized object.

Nil

If the UUID could not be found in the objects hash. In this case a warning is printed to STDERR.

Source

274 def object_with_uuid(uuid, objects_by_uuid_plist, attribute)
275   unless object = project.objects_by_uuid[uuid] || project.new_from_plist(uuid, objects_by_uuid_plist)
276     UI.warn "`#{inspect}` attempted to initialize an object with " \
277       "an unknown UUID. `#{uuid}` for attribute: `#{attribute.name}`."\
278       " This can be the result of a merge and the unknown UUID is "    \
279       "being discarded."
280   end
281   object
282 rescue NameError
283   attributes = objects_by_uuid_plist[uuid]
284   raise "`#{isa}` attempted to initialize an object with unknown ISA "\
285         "`#{attributes['isa']}` from attributes: `#{attributes}`\n"   \
286         "Please file an issue: https://github.com/CocoaPods/Xcodeproj/issues/new"
287 end

Source Files

lib/xcodeproj/project/object.rb:274

spec/project/object_spec.rb

to_hashinherited

Signature

to_hash #=> Hash 

Returns

Hash A hash representation of the project.

Source

299 def to_hash
300   plist = {}
301   plist['isa'] = isa
302 
303   simple_attributes.each do |attrb|
304     value = attrb.get_value(self)
305     plist[attrb.plist_name] = value if value
306   end
307 
308   to_one_attributes.each do |attrb|
309     obj = attrb.get_value(self)
310     plist[attrb.plist_name] = obj.uuid if obj
311   end
312 
313   to_many_attributes.each do |attrb|
314   list = attrb.get_value(self)
315     plist[attrb.plist_name] = list.uuids
316   end
317 
318   references_by_keys_attributes.each do |attrb|
319     list = attrb.get_value(self)
320     plist[attrb.plist_name] = list.map { |dictionary| dictionary.to_hash }
321   end
322 
323   plist
324 end

Source Files

lib/xcodeproj/project/object.rb:299

spec/project/object_spec.rb

to_tree_hashinherited

Signature

to_tree_hash #=> Hash 

Returns

Hash

A hash representation of the project different from the plist one.

Source

339 def to_tree_hash
340   hash = {}
341   hash['displayName'] = display_name
342   hash['isa'] = isa
343 
344   simple_attributes.each do |attrb|
345     value = attrb.get_value(self)
346     hash[attrb.plist_name] = value if value
347   end
348 
349   to_one_attributes.each do |attrb|
350     obj = attrb.get_value(self)
351     hash[attrb.plist_name] = obj.to_tree_hash if obj
352   end
353 
354   to_many_attributes.each do |attrb|
355     list = attrb.get_value(self)
356     hash[attrb.plist_name] = list.map { |obj| obj.to_tree_hash }
357   end
358 
359   references_by_keys_attributes.each do |attrb|
360     list = attrb.get_value(self)
361     hash[attrb.plist_name] = list.map { |dictionary| dictionary.to_tree_hash }
362   end
363 
364   hash
365 end

Source Files

lib/xcodeproj/project/object.rb:339

spec/project/object_spec.rb

pretty_printinherited

Signature

pretty_print #=> Hash{String => Hash} 

Returns

Hash{String => Hash}

A hash suitable to display the object to the user.

Source

370 def pretty_print
371   if to_many_attributes.count == 1
372     children = to_many_attributes.first.get_value(self)
373     {display_name => children.map(&:pretty_print)}
374   else
375     display_name
376   end
377 end

Source Files

lib/xcodeproj/project/object.rb:370

spec/project/object_spec.rb

==inherited

Signature

==(other) #=> undefined

Source

385 def ==(other)
386   other.is_a?(AbstractObject) && self.to_hash == other.to_hash
387 end

Source Files

lib/xcodeproj/project/object.rb:385

spec/project/object_spec.rb

<=>inherited

Signature

<=>(other) #=> undefined

Source

389 def <=>(other)
390   self.uuid <=> other.uuid
391 end

Source Files

lib/xcodeproj/project/object.rb:389

spec/project/object_spec.rb

inspectinherited

Signature

inspect #=> undefined

Source

393 def inspect
394   name_part = " name=#{self.name}" if respond_to?(:name)
395   "<#{self.class}#{name_part} UUID=#{uuid}>"
396 end

Source Files

lib/xcodeproj/project/object.rb:393

spec/project/object_spec.rb