Class: FrameworkGenerate::Target

Inherits:
Object
  • Object
show all
Defined in:
lib/framework-generate/target.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, platforms = nil, language = nil, info_plist = nil, bundle_id = nil, header = nil, include_files = nil, exclude_files = nil, resource_files = nil, dependencies = nil, type = :framework, pre_build_scripts = nil, post_build_scripts = nil, test_target = nil, is_safe_for_extensions = false, enable_code_coverage = false) {|_self| ... } ⇒ Target

Returns a new instance of Target.

Yields:

  • (_self)

Yield Parameters:



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/framework-generate/target.rb', line 8

def initialize(name = nil, platforms = nil, language = nil, info_plist = nil, bundle_id = nil, header = nil, include_files = nil, exclude_files = nil, resource_files = nil, dependencies = nil, type = :framework, pre_build_scripts = nil, post_build_scripts = nil, test_target = nil, is_safe_for_extensions = false, enable_code_coverage = false)
  @name = name
  @platforms = platforms
  @language = language
  @info_plist = info_plist
  @bundle_id = bundle_id
  @header = header
  @include_files = include_files
  @exclude_files = exclude_files
  @resource_files = resource_files
  @dependencies = dependencies
  @type = type
  @pre_build_scripts = pre_build_scripts
  @post_build_scripts = post_build_scripts
  @test_target = test_target
  @is_safe_for_extensions = is_safe_for_extensions
  @enable_code_coverage = enable_code_coverage

  yield(self) if block_given?
end

Instance Attribute Details

#bundle_id ⇒ Object

Returns the value of attribute bundle_id.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def bundle_id
  @bundle_id
end

#dependencies ⇒ Object

Returns the value of attribute dependencies.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def dependencies
  @dependencies
end

#enable_code_coverage ⇒ Object

Returns the value of attribute enable_code_coverage.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def enable_code_coverage
  @enable_code_coverage
end

#exclude_files ⇒ Object

Returns the value of attribute exclude_files.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def exclude_files
  @exclude_files
end

#header ⇒ Object

Returns the value of attribute header.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def header
  @header
end

#include_files ⇒ Object

Returns the value of attribute include_files.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def include_files
  @include_files
end

#info_plist ⇒ Object

Returns the value of attribute info_plist.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def info_plist
  @info_plist
end

#is_safe_for_extensions ⇒ Object

Returns the value of attribute is_safe_for_extensions.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def is_safe_for_extensions
  @is_safe_for_extensions
end

#language ⇒ Object

Returns the value of attribute language.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def language
  @language
end

#name ⇒ Object

Returns the value of attribute name.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def name
  @name
end

#platforms ⇒ Object

Returns the value of attribute platforms.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def platforms
  @platforms
end

#post_build_scripts ⇒ Object

Returns the value of attribute post_build_scripts.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def post_build_scripts
  @post_build_scripts
end

#pre_build_scripts ⇒ Object

Returns the value of attribute pre_build_scripts.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def pre_build_scripts
  @pre_build_scripts
end

#resource_files ⇒ Object

Returns the value of attribute resource_files.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def resource_files
  @resource_files
end

#test_target ⇒ Object

Returns the value of attribute test_target.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def test_target
  @test_target
end

#type ⇒ Object

Returns the value of attribute type.



6
7
8
 
# File 'lib/framework-generate/target.rb', line 6

def type
  @type
end

Instance Method Details

#add_build_scripts(target, scripts) ⇒ Object 



221
222
223
224
225
226
227
228
229
 
# File 'lib/framework-generate/target.rb', line 221

def add_build_scripts(target, scripts)
  return if scripts.nil?

  scripts.each do |script|
    build_phase = target.new_shell_script_build_phase(script.name)
    build_phase.shell_script = script.script
    build_phase.input_paths = script.inputs
  end
end

#add_dependencies(project, target) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/framework-generate/target.rb', line 142

def add_dependencies(project, target)
  return if @dependencies.nil?

  dependency_names = @dependencies.map do |dependency|
    append_framework_extension(dependency)
  end

  frameworks = dependency_names.reject do |name|
    !project.products.any? { |x| x.path == name }
  end

  frameworks = frameworks.map do |name|
    project.products.find { |x| x.path == name }
  end

  frameworks.each do |path|
    target.frameworks_build_phase.add_file_reference(path, true)
  end
end

#add_framework_header(project, target) ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/framework-generate/target.rb', line 75

def add_framework_header(project, target)
  return if @header.nil?
  header_path = @header
  header_file_group = find_group(project, header_path)
  header_file = header_file_group.new_reference(header_path)
  header_build_file = target.headers_build_phase.add_file_reference(header_file, true)
  header_build_file.settings ||= {}
  header_build_file.settings['ATTRIBUTES'] = ['Public']
end

#add_framework_to_copy_phase(project, build_phase) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/framework-generate/target.rb', line 186

def add_framework_to_copy_phase(project, build_phase)
  return if @dependencies.nil?

  dependency_names = @dependencies.map do |dependency|
    append_framework_extension(dependency)
  end

  frameworks = dependency_names.reject do |name|
    project.products.any? { |x| x.path == name }
  end

  frameworks.each do |path|
    build_phase.input_paths << path
  end
end

#add_info_plist(project) ⇒ Object 



85
86
87
88
89
90
91
 
# File 'lib/framework-generate/target.rb', line 85

def add_info_plist(project)
  info_plist_path = @info_plist
  info_plist_group = find_group(project, info_plist_path)
  has_info_plist = info_plist_group.find_file_by_path(info_plist_path)

  info_plist_group.new_reference(@info_plist) unless has_info_plist
end

#add_post_build_scripts(target) ⇒ Object 



235
236
237
 
# File 'lib/framework-generate/target.rb', line 235

def add_post_build_scripts(target)
  add_build_scripts(target, @post_build_scripts)
end

#add_pre_build_scripts(target) ⇒ Object 



231
232
233
 
# File 'lib/framework-generate/target.rb', line 231

def add_pre_build_scripts(target)
  add_build_scripts(target, @pre_build_scripts)
end

#add_resource_files(project, target) ⇒ Object 



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/framework-generate/target.rb', line 202

def add_resource_files(project, target)
  return if @resource_files.nil?

  files = @resource_files.map do |files|
    Dir[files]
  end

  files.each do |file_directory|
    file_directory.each do |path|
      file_group = find_group(project, path)
      has_file = file_group.find_file_by_path(path)
      unless has_file
        file = file_group.new_reference(path)
        target.resources_build_phase.add_file_reference(file, true)
      end
    end
  end
end

#add_source_files(project, target) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/framework-generate/target.rb', line 109

def add_source_files(project, target)
  exclude_files = if @exclude_files.nil?
                    []
                  else
                    @exclude_files.map do |files|
                      Dir[files]
                    end
                  end

  source_files = @include_files.map do |files|
    Dir[files].reject do |path|
      reject_excluded_files(exclude_files, path)
    end
  end

  source_files.each do |file_directory|
    file_directory.each do |path|
      source_file_group = find_group(project, path)
      has_source_file = source_file_group.find_file_by_path(path)
      unless has_source_file
        source_file = source_file_group.new_reference(path)
        target.source_build_phase.add_file_reference(source_file, true)
      end
    end
  end
end

#add_supporting_files(project, target) ⇒ Object 



93
94
95
96
97
 
# File 'lib/framework-generate/target.rb', line 93

def add_supporting_files(project, target)
  add_info_plist(project)
  return if target.test_target_type?
  add_framework_header(project, target)
end

#append_framework_extension(framework) ⇒ Object 



136
137
138
139
140
 
# File 'lib/framework-generate/target.rb', line 136

def append_framework_extension(framework)
  return framework if File.extname(framework) == '.framework'

  "#{framework}.framework"
end

#copy_carthage_frameworks(project, build_phase, scripts_directory) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/framework-generate/target.rb', line 162

def copy_carthage_frameworks(project, build_phase, scripts_directory)
  script_file_name = 'copy-carthage-frameworks.sh'
  script_file_path = File.join(File.dirname(__FILE__), script_file_name)

  if scripts_directory.nil?
    script_file = File.open(script_file_path)

    build_phase.shell_script = script_file.read

    script_file.close
  else
    script_path = File.join(Dir.pwd, scripts_directory, script_file_name)
    dirname = File.dirname(script_path)
    FileUtils.mkdir_p(dirname) unless File.directory?(dirname)

    FileUtils.cp(script_file_path, script_path, preserve: true)

    xcode_path = File.join('${SRCROOT}', scripts_directory, script_file_name)
    build_phase.shell_script = " exec \"#{xcode_path}\""
  end

  add_framework_to_copy_phase(project, build_phase)
end

#create(project, language, scripts_directory) ⇒ Object 



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/framework-generate/target.rb', line 239

def create(project, language, scripts_directory)
  name = @name
  type = @type

  # Target
  target = project.new(Xcodeproj::Project::Object::PBXNativeTarget)
  project.targets << target
  target.name = name
  target.product_name = name
  target.product_type = Xcodeproj::Constants::PRODUCT_TYPE_UTI[type]
  target.build_configuration_list = Xcodeproj::Project::ProjectHelper.configuration_list(project, :osx, nil, type, language.type)

  # Pre build script
  add_pre_build_scripts(target)

  add_supporting_files(project, target)
  add_source_files(project, target)

  target.build_configurations.each do |configuration|
    target_build_settings(configuration.build_settings)
  end

  # Product
  product = project.products_group.new_product_ref_for_target(name, type)
  target.product_reference = product

  # Build phases

  target.build_phases << project.new(Xcodeproj::Project::Object::PBXResourcesBuildPhase)
  target.build_phases << project.new(Xcodeproj::Project::Object::PBXFrameworksBuildPhase)

  # Post build script
  add_post_build_scripts(target)

  # Dependencies
  add_dependencies(project, target)

  # Resource files
  add_resource_files(project, target)

  # Copy frameworks to test target
  if target.test_target_type?
    build_phase = target.new_shell_script_build_phase('Copy Carthage Frameworks')
    copy_carthage_frameworks(project, build_phase, scripts_directory)
  end

  target
end

#find_group(project, path) ⇒ Object 



70
71
72
73
 
# File 'lib/framework-generate/target.rb', line 70

def find_group(project, path)
  folder_path = File.dirname(path)
  project.main_group.find_subpath(folder_path, true)
end

#reject_excluded_files(exclude_files, path) ⇒ Object 



99
100
101
102
103
104
105
106
107
 
# File 'lib/framework-generate/target.rb', line 99

def reject_excluded_files(exclude_files, path)
  exclude_files.each do |files_to_exclude|
    files_to_exclude.each do |file_to_exclude|
      return true if File.fnmatch(file_to_exclude, path)
    end
  end

  false
end

#target_build_settings(settings) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/framework-generate/target.rb', line 33

def target_build_settings(settings)
  settings.delete('CODE_SIGN_IDENTITY')

  settings['INFOPLIST_FILE'] = @info_plist
  settings['PRODUCT_BUNDLE_IDENTIFIER'] = @bundle_id
  settings['APPLICATION_EXTENSION_API_ONLY'] = @is_safe_for_extensions ? 'YES' : 'NO'
  settings['SUPPORTED_PLATFORMS'] = FrameworkGenerate::Platform.supported_platforms(@platforms)

  macos = FrameworkGenerate::Platform.find_platform(@platforms, :macos)
  unless macos.nil?
    settings['MACOSX_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform.deployment_target(macos)
    settings['FRAMEWORK_SEARCH_PATHS[sdk=macosx*]'] = FrameworkGenerate::Platform.search_paths(macos)
  end

  ios = FrameworkGenerate::Platform.find_platform(@platforms, :ios)
  unless ios.nil?
    settings['IPHONEOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform.deployment_target(ios)
    settings['FRAMEWORK_SEARCH_PATHS[sdk=iphone*]'] = FrameworkGenerate::Platform.search_paths(ios)
  end

  watchos = FrameworkGenerate::Platform.find_platform(@platforms, :watchos)
  unless watchos.nil?
    settings['WATCHOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform.deployment_target(watchos)
    settings['FRAMEWORK_SEARCH_PATHS[sdk=watch*]'] = FrameworkGenerate::Platform.search_paths(watchos)
  end

  tvos = FrameworkGenerate::Platform.find_platform(@platforms, :tvos)
  unless tvos.nil?
    settings['TVOS_DEPLOYMENT_TARGET'] = FrameworkGenerate::Platform.deployment_target(tvos)
    settings['FRAMEWORK_SEARCH_PATHS[sdk=appletv*]'] = FrameworkGenerate::Platform.search_paths(tvos)
  end

  settings['SWIFT_VERSION'] = @language.version

  settings
end

#to_s ⇒ Object 



29
30
31
 
# File 'lib/framework-generate/target.rb', line 29

def to_s
  "Target<#{name}, #{info_plist}, #{bundle_id}, #{header}, #{include_files}, #{exclude_files}, #{dependencies}, #{type}, #{test_target}, #{is_safe_for_extensions}, #{enable_code_coverage}>"
end