Class: CocoapodsPodMerge::PodMerger

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods-pod-merge/Main.rb

Instance Method Summary collapse

Instance Method Details

#add_mergefile_to_project(installer_context) ⇒ Object 



75
76
77
78
79
80
81
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 75

def add_mergefile_to_project(installer_context) 
  pods_project = Xcodeproj::Project.open(installer_context.pods_project.path)
  mergefile = pods_project.new_file('../MergeFile')
  mergefile.explicit_file_type = 'text.script.ruby'
  mergefile.include_in_index = '1'
  pods_project.save
end

#add_to_gitignore ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 83

def add_to_gitignore
  gitignore_file = '.gitignore'

  return unless File.file?(gitignore_file)

  contents = File.read(gitignore_file)
  cache_folder = contents.scan(/#{CacheDirectory}/)
  contents += "\n#{CacheDirectory}/" unless cache_folder&.last

  merged_folder = contents.scan(/#{InstallationDirectory}/)
  contents += "\n#{InstallationDirectory}/" unless merged_folder&.last

  File.open(gitignore_file, 'w') { |file| file.puts contents }
end

#array_wrapped(object) ⇒ Object 



414
415
416
417
418
419
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 414

def array_wrapped(object)
  return [] unless object

  return object if object.class == Array
  return [object] if object.class == String || object.class == Hash
end

#begin(_installer_context) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 47

def begin(_installer_context)
  merge_groups = parse_mergefile
  podfile_info = read_podfile

  unless install_and_merge_required
    Pod::UI.puts 'The pods are already merged according to the MergeFile, no changes required.'.yellow
    add_to_gitignore
    return
  end

  # Delete existing merged frameworks & cache
  if File.directory?(InstallationDirectory)
    FileUtils.rm_rf(InstallationDirectory)
  end
  FileUtils.rm_rf(CacheDirectory) if File.directory?(CacheDirectory)

  unless File.directory?(InstallationDirectory)
    FileUtils.mkdir(InstallationDirectory)
  end

  merge_groups.each do |group, group_contents|
    merge(group, group_contents, podfile_info)
  end

  create_mergefile_lock
  add_to_gitignore
end

#create_cache_podfile(podfile_info, pods, swift_language_version) ⇒ Object 



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 421

def create_cache_podfile(podfile_info, pods, swift_language_version)
  FileUtils.touch("#{CacheDirectory}/Podfile")
  file = File.new("#{CacheDirectory}/Podfile", 'w')

  uses_swift = !swift_language_version.empty?

  # Create a temporary Xcode project for pods missing Swift_Version in the Podspec
  if uses_swift
    project = Xcodeproj::Project.new("#{CacheDirectory}/Dummy.xcodeproj")
    target = project.new_target(:application, 'Dummy', :ios, '13.1', nil, :swift)
    swift_file = project.main_group.new_file('./dummy.swift')
    target.add_file_references([swift_file])
    project.targets.each do |target|
      target.build_configurations.each do |config|
        config.build_settings['SWIFT_VERSION'] ||= swift_language_version
      end
    end
    project.save
  end

  file.puts("require 'json'")
  podfile_info.sources.each do |source|
    file.puts source
  end
  podfile_info.platforms.each do |platform|
    file.puts platform
  end

  if uses_swift
    file.puts("install! 'cocoapods', :lock_pod_sources => false")
  else
    file.puts("install! 'cocoapods', :integrate_targets => false, :lock_pod_sources => false")
  end

  file.puts("target 'Dummy' do")
  pods.each do |line|
    file.puts line.to_s
  end
rescue IOError => e
  Pod::UI.puts "Error Writing Podfile for group #{pods}: #{e}".red
ensure
  file.puts 'end'
  file.puts PodSpecWriter_Hook
  file&.close
end

#create_mergefile_lock ⇒ Object 



128
129
130
131
132
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 128

def create_mergefile_lock
  mergefile_lock_path = "#{InstallationDirectory}/#{MergeFileName}.lock"
  current_mergefile_hash = Digest::MD5.hexdigest(File.read(MergeFileName))
  File.open(mergefile_lock_path, 'w') { |file| file.puts current_mergefile_hash }
end

#create_podspec(merged_framework_name, pods_to_merge, podspec_info, mixed_language_group) ⇒ Object 



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 481

def create_podspec(merged_framework_name, pods_to_merge, podspec_info, mixed_language_group)
  frameworks = podspec_info.frameworks
  prefix_header_contents = podspec_info.prefix_header_contents
  private_header_files = podspec_info.private_header_files
  resources = podspec_info.resources
  script_phases = podspec_info.script_phases
  compiler_flags = podspec_info.compiler_flags
  libraries = podspec_info.libraries
  prepare_command = podspec_info.prepare_command
  resource_bundles = podspec_info.resource_bundles
  vendored_libraries = podspec_info.vendored_libraries
  swift_versions = podspec_info.swift_versions

  mergedPodspec = %(
    Pod::Spec.new do |s|
      s.name             = '#{merged_framework_name}'
      s.version          = '1.0.0'
      s.summary          = 'Merged Pod generated by cocoapods pod-merge plugin'
      s.description      = 'Merged Framework containing the pods: #{pods_to_merge}'
      s.homepage         = 'https://github.com/grab/cocoapods-pod-merge'
      s.license          = { :type => 'MIT', :text => 'Merged Pods by cocoapods-pod-merge plugin  ' }
      s.author           = { 'GrabTaxi Pte Ltd' => '[email protected]' }
      s.source           = { :git => 'https://github.com/grab/cocoapods-pod-merge', :tag => '1.0.0' }
      s.ios.deployment_target = '8.0'
      s.source_files = 'Sources/**/*.{h,m,mm,swift}'
    )

  podspec = File.new("#{InstallationDirectory}/#{merged_framework_name}/#{merged_framework_name}.podspec", 'w')
  podspec.puts(mergedPodspec)

  if mixed_language_group
    podspec.puts("s.swift_version = #{swift_versions}")
  else
    podspec.puts("s.module_map = 'Sources/module.modulemap'")
  end

  unless resources.empty?
    podspec.puts("s.resource = #{resources.to_s.delete('[').delete(']')}")
  end

  unless frameworks.empty?
    podspec.puts("s.frameworks = #{frameworks.to_s.delete('[').delete(']')}")
  end

  unless prefix_header_contents.empty?
    podspec.puts("s.prefix_header_contents = #{prefix_header_contents.to_s.delete('[').delete(']')}")
  end

  unless private_header_files.empty?
    podspec.puts("s.private_header_files = #{private_header_files.to_s.delete('[').delete(']')}")
  end

  unless libraries.empty?
    podspec.puts("s.libraries = #{libraries.to_s.delete('[').delete(']')}")
  end

  unless prepare_command.empty?
    podspec.puts("s.prepare_command = #{prepare_command.to_s.delete('[').delete(']')}")
  end

  unless resource_bundles.empty?
    podspec.puts("s.resource_bundles = #{resource_bundles}")
  end

  unless vendored_libraries.empty?
    podspec.puts("s.vendored_libraries = #{vendored_libraries.to_s.delete('[').delete(']')}")
  end

  podspec.puts('end')
  podspec.close
end

#extract_info_from_podspec(pod, mixed_language_group) ⇒ Object 



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 345

def extract_info_from_podspec(pod, mixed_language_group)
  podspec_file = File.open "#{pod}.json"
  podspec = JSON.load podspec_file

  frameworks = []
  prefix_header_contents = []
  private_header_files = []
  resources = []
  script_phases = []
  compiler_flags = []
  libraries = []
  prepare_command = []
  vendored_libraries = []
  resource_bundles = {}
  swift_versions = []

  frameworks += array_wrapped(podspec['frameworks'])
  compiler_flags += array_wrapped(podspec['compiler_flags'])
  private_header_files += array_wrapped(podspec['private_header_files']).map { |path| "Sources/#{pod}/#{path}" }
  prefix_header_contents += array_wrapped(podspec['prefix_header_contents'])
  resources += array_wrapped(podspec['resource']).map { |path| "Sources/#{pod}/#{path}" }
  resources += array_wrapped(podspec['resources']).map { |path| "Sources/#{pod}/#{path}" }
  script_phases += array_wrapped(podspec['script_phases'])
  libraries += array_wrapped(podspec['library'])
  libraries += array_wrapped(podspec['libraries'])
  prepare_command += array_wrapped(podspec['prepare_command'])
  vendored_libraries += array_wrapped(podspec['vendored_library']).map { |path| "Sources/#{pod}/#{path}" }
  vendored_libraries += array_wrapped(podspec['vendored_libraries']).map { |path| "Sources/#{pod}/#{path}" }
  if mixed_language_group
    swift_versions += array_wrapped(podspec['swift_version'])
    swift_versions += array_wrapped(podspec['swift_versions'])
  end

  if podspec['resource_bundles']
    resource_bundles = resource_bundles.merge(podspec['resource_bundles'])
  end

  if podspec['resource_bundle']
    resource_bundles = resource_bundles.merge(podspec['resource_bundle'])
  end

  resource_bundles.each do |key, paths|
    paths = array_wrapped(paths).map { |path| "Sources/#{pod}/#{path}" }
    resource_bundles[key] = paths
  end

  subspecs = array_wrapped(podspec['default_subspec'])
  subspecs += array_wrapped(podspec['default_subspecs'])

  subspecs.each do |subspec|
    Pod::UI.puts "\t\tRecursively Collecting Podspecs for Subspec #{pod}/#{subspec}".magenta
    info = extract_info_from_podspec("#{pod}_#{subspec}", false) # Passing false assuming subspecs will not have a different swift version from the base spec
    frameworks += info.frameworks
    prefix_header_contents += info.prefix_header_contents
    private_header_files += info.private_header_files.map { |path| "Sources/#{pod}/#{path}" }
    resources += info.resources.map { |path| "Sources/#{pod}/#{path}" }
    script_phases += info.script_phases
    compiler_flags += info.compiler_flags
    libraries += info.libraries
    prepare_command += info.prepare_command
    vendored_libraries += info.vendored_libraries
    if info.resource_bundles
      resource_bundles = resource_bundles.merge(info.resource_bundles)
    end
  end

  PodspecInfo.new(frameworks, prefix_header_contents, private_header_files, resources, script_phases, compiler_flags, libraries, prepare_command, resource_bundles, vendored_libraries, swift_versions)
end

#generate_module_map(merged_framework_name, public_headers) ⇒ Object 



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 467

def generate_module_map(merged_framework_name, public_headers)
  module_map = File.new("#{InstallationDirectory}/#{merged_framework_name}/Sources/module.modulemap", 'w')
  module_map.puts("framework module #{merged_framework_name} {")
  public_headers.each do |pod, headers|
    module_map.puts("\n\texplicit module #{pod.delete('+').delete('_')} {")
    headers.each do |header|
      module_map.puts("\t\theader \"#{header}\"")
    end
    module_map.puts("\t}")
  end
  module_map.puts("\n}")
  module_map.close
end

#install_and_merge_required ⇒ Object 



119
120
121
122
123
124
125
126
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 119

def install_and_merge_required
  mergefile_lock_path = "#{InstallationDirectory}/#{MergeFileName}.lock"
  return true unless File.file?(mergefile_lock_path)

  current_mergefile_hash = Digest::MD5.hexdigest(File.read(MergeFileName))
  locked_mergefile_hash = File.read(mergefile_lock_path)
  current_mergefile_hash.strip != locked_mergefile_hash.strip
end

#merge(merged_framework_name, group_contents, podfile_info) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 186

def merge(merged_framework_name, group_contents, podfile_info)
  Pod::UI.puts "Preparing to Merge: #{merged_framework_name}"

  pods_to_merge = group_contents['titles']
  flags = group_contents['flags']
  forced_swift_language_version = group_contents['swift_version']
  public_headers_by_pod = {}
  frameworks = []
  prefix_header_contents = []
  private_header_files = []
  resources = []
  script_phases = []
  compiler_flags = []
  libraries = []
  prepare_command = []
  vendored_libraries = []
  resource_bundles = {}
  swift_versions = {}

  # Flags
  has_dependencies = false
  mixed_language_group = false

  flags.each do |flag, _|
    case flag.strip
    when 'has_dependencies'
      has_dependencies = true
    end
  end

  # Download the Pods to be merged
  Pod::UI.puts 'Downloading Pods in the group'.cyan
  FileUtils.mkdir CacheDirectory unless File.directory?(CacheDirectory)

  create_cache_podfile(podfile_info, group_contents['lines'], forced_swift_language_version)

  Dir.chdir(CacheDirectory) do
    system('pod install') || raise('Failed to download pods to merge')
  end

  # Create a directory for the merged framework
  FileUtils.mkdir("#{InstallationDirectory}/#{merged_framework_name}")
  FileUtils.mkdir("#{InstallationDirectory}/#{merged_framework_name}/Sources")

  Pod::UI.puts 'Merging Pods'.cyan
  pods_to_merge.each do |pod|
    # Capture all resources to specify in the final podspec
    Pod::UI.puts "\t#{pod.cyan}"

    Dir.chdir("#{CacheDirectory}/Pods/#{pod}") do
      # Validate the Pod
      Pod::UI.puts "\t\tValidating Pod".magenta

      unless Dir.glob('**/*.swift').empty? # Make sure the pod is not a Swift or Mixed Pod
        mixed_language_group = true
        Pod::UI.puts "\t\tExperimental: ".yellow + "The group #{merged_framework_name} consists of Swift Pods. This can lead to import pollution.".magenta
      end

      unless Dir.glob('**/*.a').empty? # Log an experimental warning when merging pods with static libraries inside
        Pod::UI.puts "\t\tExperimental: ".yellow + "#{pod} contains static libraries inside, this can lead to errors or undefined behaviours".magenta
      end

      unless Dir.glob('**/*.framework').empty? # Make sure the pod does not contain a pre-compiled framework
        abort('Pods with precompiled frameworks inside cannot be merged.'.red)
      end

      Pod::UI.puts "\t\tCollecting Public Headers".magenta
      public_headers_by_pod[pod] = Dir.glob('**/*.h').map { |header| File.basename(header) }

      Dir.glob('**/*.{h,m,mm,swift}').each do |source_file|
        contents = File.read(source_file)
        if has_dependencies
          # Fix imports of style import xx
          pods_to_merge.each do |pod|
            modular_imports = contents.scan(%r{<#{pod}/(.+)>})
            next unless modular_imports&.last

            Pod::UI.puts "\t\tExperimental: ".yellow + "Found Modular Imports in #{source_file}, fixing this by converting to local #import".magenta
            contents_with_imports_fixed = contents.gsub(%r{<#{pod}/(.+)>}) do |match|
              match.gsub(%r{<#{pod}/(.+)>}, "\"#{Regexp.last_match(1)}\"")
            end
            File.open(source_file, 'w') { |file| file.puts contents_with_imports_fixed }
          end

          # Fix imports of style import xx
          pods_to_merge.each do |pod|
            modular_imports = contents.scan("import #{pod}")
            next unless modular_imports&.last

            Pod::UI.puts "\t\tExperimental: ".yellow + "Found a module import in #{source_file}, fixing this by removing it".magenta
            File.open(source_file, 'w') { |file| file.puts contents.gsub("import #{pod}", '') }
          end
        else
          modular_imports = contents.scan(%r{<#{pod}/(.+)>})
          next unless modular_imports&.last

          Pod::UI.puts "\t\tExperimental: ".yellow + "Found Modular Imports in #{source_file}, fixing this by converting to local #import".magenta
          contents_with_imports_fixed = contents.gsub(%r{<#{pod}/(.+)>}) do |match|
            match.gsub(%r{<#{pod}/(.+)>}, "\"#{Regexp.last_match(1)}\"")
          end
          File.open(source_file, 'w') { |file| file.puts contents_with_imports_fixed }
        end
      end
    end

    # Read each pod's podspec, and collect configuration for the final merged podspec
    Pod::UI.puts "\t\tExtracting Detailed Podspecs".magenta
    Dir.chdir("#{CacheDirectory}/Podspecs") do
      info = extract_info_from_podspec(pod, mixed_language_group)
      frameworks += info.frameworks
      prefix_header_contents += info.prefix_header_contents
      private_header_files += info.private_header_files
      resources += info.resources
      script_phases += info.script_phases
      compiler_flags += info.compiler_flags
      libraries += info.libraries
      prepare_command += info.prepare_command
      vendored_libraries += info.vendored_libraries
      swift_versions[pod] = info.swift_versions.map(&:to_f)
      resource_bundles = resource_bundles.merge(info.resource_bundles)
    end

    # Copy over the Pods to be merged
    Pod::UI.puts "\t\tCopying Sources".magenta
    Dir.chdir("#{CacheDirectory}/Pods") do
      FileUtils.copy_entry pod.to_s, "../../#{InstallationDirectory}/#{merged_framework_name}/Sources/#{pod}"
    end
  end

  # Generate Module Map
  unless mixed_language_group
    Pod::UI.puts "\tGenerating module map".magenta
    generate_module_map(merged_framework_name, public_headers_by_pod)
  end

  # Verify there's a common Swift language version across the group
  if mixed_language_group
    if !forced_swift_language_version.empty?
      swift_version = [forced_swift_language_version]
    else
      swift_version = swift_versions.each_value.reduce { |final_swift_version, versions| final_swift_version & versions }
      unless swift_version&.first
        Pod::UI.puts "Could not find a common compatible Swift version across the pods to be merged group #{merged_framework_name}: #{swift_versions}".red
        abort("or specify a swift version in this group using the swift_version! flag, example: swift_version! '5.0'".red)
      end
    end
    Pod::UI.puts "\tUsing Swift Version #{swift_version.first} for the group: #{merged_framework_name}".yellow
  end

  # Create the local podspec
  Pod::UI.puts "\tCreating Podspec for the merged framework".magenta
  create_podspec(merged_framework_name, pods_to_merge, PodspecInfo.new(frameworks.uniq, prefix_header_contents.uniq, private_header_files.uniq, resources.uniq, script_phases.uniq, compiler_flags.uniq, libraries.uniq, prepare_command.uniq, resource_bundles, vendored_libraries.uniq, swift_version), mixed_language_group)

  Pod::UI.puts 'Cleaning up cache'.cyan
  FileUtils.rm_rf(CacheDirectory)

  Pod::UI.puts 'Merge Complete!'.green
end

#parse_mergefile ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
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/cocoapods-pod-merge/Main.rb', line 134

def parse_mergefile
  unless File.file?(MergeFileName)
    sample_mergefile = File.new(MergeFileName, 'w')
    sample_mergefile.puts(MergeFileSample)
    sample_mergefile.close
    abort('You need a MergeFile in your current directory to use cocoapods-pod-merge. A sample one has been created for you.'.green)
  end
  merge_groups = {}
  File.open(MergeFileName, 'r') do |f|
    parsing_a_group = false
    group_name = ''
    f.each_line do |line|
      next if line.strip.empty?

      line = line.gsub(/\#.+/, '') if line.include?('#') # Remove any comments
      if parsing_a_group
        if line.strip == 'end'
          parsing_a_group = false
        elsif line.strip.include?('!')
          if line.strip.include?('swift_version!')
            extracted_swift_version = line.strip.delete('swift_version!').delete('\'').delete('\"').strip.to_f
            if extracted_swift_version == 0
              abort("Found an invalid Swift version specified for group \'#{group_name}\' in the MergeFile. Please specify one like: swift_version! '5.0'".red)
            end
            merge_groups[group_name]['swift_version'] = extracted_swift_version.to_s
          else
            merge_groups[group_name]['flags'][line.strip.delete('!')] = true
          end
        else
          merge_groups[group_name]['lines'].append(line)
          line = line.split(',').first
          title = line.scan(/\'(.+)\'/)
          title ||= line.scan(/\"(.+)\"/)
          merge_groups[group_name]['titles'].append(title.last.first.to_s.delete(',').delete("\''").delete('"'))
        end
      else
        unless line.scan(/\'(.+)\'/).last.empty?
          group_name = line.scan(/\'(.+)\'/).last.first.to_s

          if merge_groups[group_name]
            abort("Duplicate Group Name: #{group_name}. Please make sure all groups have different names!".red)
          end

          merge_groups[group_name] = { 'titles' => [], 'lines' => [], 'flags' => {}, 'swift_version' => '' }
          parsing_a_group = true
        end
      end
    end
  end
  merge_groups
end

#read_podfile ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cocoapods-pod-merge/Main.rb', line 98

def read_podfile
  unless File.file?('Podfile')
    abort('You don\'t seem to have a Podfile. What\'s good a Mergefile, without a Podfile?\n\nPlease run pod init to begin.'.red)
  end

  sources = []
  platforms = []

  File.open('Podfile', 'r') do |f|
    f.each_line do |line|
      next if line.strip.empty?

      unless line.scan(/platform :(.+),/).empty?
        platforms.append(line.strip)
      end
      sources.append(line.strip) unless line.scan(/source '(.+)'/).empty?
    end
  end
  PodfileInfo.new(sources, platforms)
end