Class: Motion::Project::CocoaPods

Inherits:
Object
  • Object
show all
Defined in:
lib/motion/project/cocoapods.rb,
lib/motion/project/version.rb

Overview

—————————————————————————#

Constant Summary collapse

PODS_ROOT = 
'vendor/Pods'
TARGET_NAME = 
'RubyMotion'
SUPPORT_FILES = 
File.join(PODS_ROOT, "Target Support Files/Pods-#{TARGET_NAME}")
PUBLIC_HEADERS_ROOT = 
File.join(PODS_ROOT, 'Headers/Public')
VERSION = 
'1.10.0'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config, vendor_options) ⇒ CocoaPods

Returns a new instance of CocoaPods.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/motion/project/cocoapods.rb', line 80

def initialize(config, vendor_options)
  @config = config
  @vendor_options = vendor_options
  @use_frameworks = false

  case @config.deploy_platform
  when 'MacOSX'
    platform = :osx
  when 'iPhoneOS'
    platform = :ios
  when 'AppleTVOS'
    platform = :tvos
  when 'WatchOS'
    platform = :watchos
  else
    App.fail "Unknown CocoaPods platform: #{@config.deploy_platform}"
  end

  @podfile = Pod::Podfile.new(Pathname.new(Rake.original_dir) + 'Rakefile') do
    platform(platform, config.deployment_target)
    target(TARGET_NAME)
    install!('cocoapods', :integrate_targets => false)
  end
  cp_config.podfile = @podfile
  cp_config.installation_root = Pathname.new(File.expand_path(config.project_dir)) + 'vendor'

  if cp_config.verbose = !!ENV['COCOAPODS_VERBOSE']
    require 'claide'
  end
end

Instance Attribute Details

#podfile ⇒ Object

Returns the value of attribute podfile.



78
79
80
 
# File 'lib/motion/project/cocoapods.rb', line 78

def podfile
  @podfile
end

Instance Method Details

#analyzer ⇒ Object 



320
321
322
 
# File 'lib/motion/project/cocoapods.rb', line 320

def analyzer
  Pod::Installer::Analyzer.new(cp_config.sandbox, @podfile, cp_config.lockfile)
end

#configure_project ⇒ Object

Adds the Pods project to the RubyMotion config as a vendored project and



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/motion/project/cocoapods.rb', line 113

def configure_project
  if (xcconfig = self.pods_xcconfig_hash) && ldflags = xcconfig['OTHER_LDFLAGS']
    @config.resources_dirs << resources_dir.to_s

    frameworks = installed_frameworks[:pre_built]
    if frameworks
      @config.embedded_frameworks += frameworks
      @config.embedded_frameworks.uniq!
    end

    if @use_frameworks
      configure_project_frameworks
    else
      configure_project_static_libraries
    end
  end
end

#configure_project_frameworks ⇒ Object 



131
132
133
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
 
# File 'lib/motion/project/cocoapods.rb', line 131

def configure_project_frameworks
  if (xcconfig = self.pods_xcconfig_hash) && ldflags = xcconfig['OTHER_LDFLAGS']
    # Add libraries to @config.libs
    pods_libraries

    frameworks = ldflags.scan(/-framework\s+"?([^\s"]+)"?/).map { |m| m[0] }
    if build_frameworks = installed_frameworks[:build]
      build_frameworks = build_frameworks.map { |path| File.basename(path, ".framework") }
      frameworks.delete_if { |f| build_frameworks.include?(f) }
    end
    static_frameworks = pods_frameworks(frameworks)
    static_frameworks_paths = static_frameworks_paths(static_frameworks)
    search_path = static_frameworks_paths.inject("") { |s, path|
      s += " -I'#{path}' -I'#{path}/Headers'"
    }
    @vendor_options[:bridgesupport_cflags] ||= ''
    @vendor_options[:bridgesupport_cflags] << " #{header_search_path} #{framework_search_path} #{search_path}"

    @config.weak_frameworks.concat(ldflags.scan(/-weak_framework\s+([^\s]+)/).map { |m| m[0] })
    @config.weak_frameworks.uniq!

    vendors = @config.vendor_project(PODS_ROOT, :xcode, {
      :target => "Pods-#{TARGET_NAME}",
      :products => build_frameworks.map { |name| "#{name}.framework" },
      :allow_empty_products => build_frameworks.empty?,
    }.merge(@vendor_options))

    vendor = vendors.last
    if vendor.respond_to?(:build_bridgesupport)
      static_frameworks_paths.each do |path|
        path = File.expand_path(path)
        bs_file = File.join(Builder.common_build_dir, "#{path}.bridgesupport")
        headers = Dir.glob(File.join(path, '**{,/*/**}/*.h'))
        @config.vendor_project(PODS_ROOT, :bridgesupport, {
          :bs_file => bs_file,
          :headers => headers,
        }.merge(@vendor_options))
      end
    end
  end
end

#configure_project_static_libraries ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/motion/project/cocoapods.rb', line 173

def configure_project_static_libraries
  # TODO replace this all once Xcodeproj has the proper xcconfig parser.
  if (xcconfig = self.pods_xcconfig_hash) && ldflags = xcconfig['OTHER_LDFLAGS']
    # Collect the Pod products
    pods_libs = pods_libraries

    # Initialize ':bridgesupport_cflags', in case the use
    @vendor_options[:bridgesupport_cflags] ||= ''
    @vendor_options[:bridgesupport_cflags] << " #{header_search_path} #{framework_search_path}"

    frameworks = ldflags.scan(/-framework\s+"?([^\s"]+)"?/).map { |m| m[0] }
    pods_frameworks(frameworks)

    @config.weak_frameworks.concat(ldflags.scan(/-weak_framework\s+([^\s]+)/).map { |m| m[0] })
    @config.weak_frameworks.uniq!

    @config.vendor_project(PODS_ROOT, :xcode, {
      :target => "Pods-#{TARGET_NAME}",
      :headers_dir => "Headers/Public",
      :products => pods_libs.map { |lib_name| "lib#{lib_name}.a" },
      :allow_empty_products => pods_libs.empty?,
    }.merge(@vendor_options))
  end
end

#copy_cocoapods_env_and_prefix_headers ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/motion/project/cocoapods.rb', line 291

def copy_cocoapods_env_and_prefix_headers
  headers = Dir.glob(["#{PODS_ROOT}/*.h", "#{PODS_ROOT}/*.pch", "#{PODS_ROOT}/Target Support Files/**/*.h", "#{PODS_ROOT}/Target Support Files/**/*.pch"])
  headers.each do |header|
    src = File.basename(header)
    dst = src.sub(/\.pch$/, '.h')
    dst_path = File.join(PUBLIC_HEADERS_ROOT, "____#{dst}")
    unless File.exist?(dst_path)
      FileUtils.mkdir_p(PUBLIC_HEADERS_ROOT)
      FileUtils.cp(header, dst_path)
    end
  end
end

#cp_config ⇒ Object 



316
317
318
 
# File 'lib/motion/project/cocoapods.rb', line 316

def cp_config
  Pod::Config.instance
end

#dependency(*name_and_version_requirements, &block) ⇒ Object

Deprecated.



210
211
212
 
# File 'lib/motion/project/cocoapods.rb', line 210

def dependency(*name_and_version_requirements, &block)
  @podfile.dependency(*name_and_version_requirements, &block)
end

#framework_public_headers_dir(framework_path) ⇒ Object 



250
251
252
253
 
# File 'lib/motion/project/cocoapods.rb', line 250

def framework_public_headers_dir(framework_path)
  framework_name = framework_path[%r{/([^/]*)\.framework/}, 1]
  File.join(@config.project_dir, PUBLIC_HEADERS_ROOT, framework_name)
end

#framework_search_path ⇒ Object 



471
472
473
 
# File 'lib/motion/project/cocoapods.rb', line 471

def framework_search_path
  framework_search_paths.map { |p| "-F'#{File.expand_path(File.join(p, '..'))}'" }.join(' ')
end

#framework_search_paths ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/motion/project/cocoapods.rb', line 445

def framework_search_paths
  @framework_search_paths ||= begin
    xcconfig = pods_xcconfig_hash

    paths = []
    if search_paths = xcconfig['FRAMEWORK_SEARCH_PATHS']
      search_paths = search_paths.strip
      unless search_paths.empty?
        search_paths.scan(/"([^"]+)"/) do |search_path|
          path = search_path.first.gsub!(/(\$\(PODS_ROOT\))|(\$\{PODS_ROOT\})/, "#{@config.project_dir}/#{PODS_ROOT}")
          paths << path if path
        end
        # If we couldn't parse any search paths, then presumably nothing was properly quoted, so
        # fallback to just assuming the whole value is one path.
        if paths.empty?
          path = search_paths.gsub!(/(\$\(PODS_ROOT\))|(\$\{PODS_ROOT\})/, "#{@config.project_dir}/#{PODS_ROOT}")
          paths << path if path
        end
      end
    end
    paths
  end

  @framework_search_paths
end

#header_search_path ⇒ Object 



506
507
508
 
# File 'lib/motion/project/cocoapods.rb', line 506

def header_search_path
  header_search_paths.map { |p| "-I'#{p}'" }.join(' ')
end

#header_search_paths ⇒ Object 



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/motion/project/cocoapods.rb', line 475

def header_search_paths
  @header_search_paths ||= begin
    xcconfig = pods_xcconfig_hash

    paths = []
    if search_paths = xcconfig['HEADER_SEARCH_PATHS']
      search_paths = search_paths.strip
      unless search_paths.empty?
        search_paths.scan(/"([^"]+)"/) do |search_path|
          path = search_path.first.gsub!(/(\$\(PODS_ROOT\))|(\$\{PODS_ROOT\})/, "#{@config.project_dir}/#{PODS_ROOT}")
          paths << File.expand_path(path) if path
        end
        # If we couldn't parse any search paths, then presumably nothing was properly quoted, so
        # fallback to just assuming the whole value is one path.
        if paths.empty?
          path = search_paths.gsub!(/(\$\(PODS_ROOT\))|(\$\{PODS_ROOT\})/, "#{@config.project_dir}/#{PODS_ROOT}")
          paths << File.expand_path(path) if path
        end
      end
    end
    framework_search_paths.each do |framework_search_path|
      Dir.glob("#{framework_search_path}/*.framework/Headers").each do |framework_path|
        paths << framework_public_headers_dir(framework_path)
      end
    end
    paths
  end

  @header_search_paths
end

#inspect ⇒ Object

This is the output that gets shown in ‘rake config`, so it should be short and sweet.



310
311
312
313
314
 
# File 'lib/motion/project/cocoapods.rb', line 310

def inspect
  cp_config.lockfile.to_hash['PODS'].map do |pod|
    pod.is_a?(Hash) ? pod.keys.first : pod
  end.inspect
end

#install!(update) ⇒ Object

Performs a CocoaPods Installation.

For now we only support one Pods target, this will have to be expanded once we work on more spec support.

Let RubyMotion re-generate the BridgeSupport file whenever the list of installed pods changes.



238
239
240
241
242
243
244
245
246
 
# File 'lib/motion/project/cocoapods.rb', line 238

def install!(update)
  FileUtils.rm_rf(resources_dir)

  pods_installer.update = update
  pods_installer.install!
  symlink_framework_headers
  install_resources
  copy_cocoapods_env_and_prefix_headers
end

#install_resources ⇒ Object

TODO this probably breaks in cases like resource bundles etc, need to test.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/motion/project/cocoapods.rb', line 270

def install_resources
  FileUtils.mkdir_p(resources_dir)

  installed_resources = []
  resources.each do |file|
    begin
      dst = resources_dir + file.basename
      if file.exist? && !dst.exist?
        FileUtils.cp_r(file, resources_dir)
        installed_resources << dst
      end
    rescue ArgumentError => exc
      unless exc.message =~ /same file/
        raise
      end
    end
  end

  installed_resources
end

#installed_frameworks ⇒ Object 



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/motion/project/cocoapods.rb', line 551

def installed_frameworks
  return @installed_frameworks if @installed_frameworks

  @installed_frameworks = {}
  path = Pathname.new(@config.project_dir) + SUPPORT_FILES + "Pods-#{TARGET_NAME}-frameworks.sh"
  return @installed_frameworks unless path.exist?

  @installed_frameworks[:pre_built] = []
  @installed_frameworks[:build] = []

  File.open(path) { |f|
    f.each_line do |line|
      if matched = line.match(/install_framework\s+(.*)/)
        path = (matched[1].strip)[1..-2]
        if path.include?('${PODS_ROOT}')
          path = path.sub('${PODS_ROOT}', PODS_ROOT)
          @installed_frameworks[:pre_built] << File.join(@config.project_dir, path)
          @installed_frameworks[:pre_built].uniq!
        elsif path.include?('$BUILT_PRODUCTS_DIR')
          path = path.sub('$BUILT_PRODUCTS_DIR', "#{PODS_ROOT}/.build")
          @installed_frameworks[:build] << File.join(@config.project_dir, path)
          @installed_frameworks[:build].uniq!
        end
      end
    end
  }
  @installed_frameworks
end

#lib_search_path_flags ⇒ Object 



421
422
423
 
# File 'lib/motion/project/cocoapods.rb', line 421

def lib_search_path_flags
  lib_search_paths.map { |p| "-L'#{p}'" }.join(' ')
end

#lib_search_paths ⇒ Object 



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/motion/project/cocoapods.rb', line 425

def lib_search_paths
  @lib_search_paths ||= begin
    xcconfig = pods_xcconfig_hash
    @lib_search_path_flags = xcconfig['LIBRARY_SEARCH_PATHS'] || ""

    paths = []
    @lib_search_path_flags = @lib_search_path_flags.split(/\s/).map do |path|
      if path =~ /(\$\(inherited\))|(\$\{inherited\})|(\$CONFIGURATION_BUILD_DIR)|(\$PODS_CONFIGURATION_BUILD_DIR)/
        nil
      else
        path = path.gsub(/(\$\(PODS_ROOT\))|(\$\{PODS_ROOT\})/, File.join(@config.project_dir, PODS_ROOT))
        paths << path.gsub('"', '')
      end
    end.compact.join(' ')
    paths
  end

  @lib_search_paths
end

#pod(*name_and_version_requirements, &block) ⇒ Object 



205
206
207
 
# File 'lib/motion/project/cocoapods.rb', line 205

def pod(*name_and_version_requirements, &block)
  @podfile.pod(*name_and_version_requirements, &block)
end

#pods_frameworks(frameworks) ⇒ Object 



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
413
414
415
416
417
418
419
 
# File 'lib/motion/project/cocoapods.rb', line 369

def pods_frameworks(frameworks)
  frameworks = frameworks.dup
  if installed_frameworks[:pre_built]
    installed_frameworks[:pre_built].each do |pre_built|
      frameworks.delete(File.basename(pre_built, ".framework"))
    end
  end

  static_frameworks = []
  case @config.deploy_platform
  when 'MacOSX'
    @config.framework_search_paths.concat(framework_search_paths)
    @config.framework_search_paths.uniq!
    framework_search_paths.each do |framework_search_path|
      frameworks.reject! do |framework|
        path = File.join(framework_search_path, "#{framework}.framework")
        if File.exist?(path)
          @config.embedded_frameworks << path
          @config.embedded_frameworks.uniq!
          true
        else
          false
        end
      end
    end
  when 'iPhoneOS', 'AppleTVOS', 'WatchOS'
    # If we would really specify these as ‘frameworks’ then the linker
    # would not link the archive into the application, because it does not
    # see any references to any of the symbols in the archive. Treating it
    # as a static library (which it is) with `-ObjC` fixes this.
    #
    framework_search_paths.each do |framework_search_path|
      frameworks.reject! do |framework|
        path = File.join(framework_search_path, "#{framework}.framework")
        if File.exist?(path)
          @config.libs << "-ObjC '#{File.join(path, framework)}'"
          @config.libs.uniq!
          static_frameworks << framework
          true
        else
          false
        end
      end
    end
  end

  @config.frameworks.concat(frameworks)
  @config.frameworks.uniq!

  static_frameworks
end

#pods_installer ⇒ Object

Installation ————————————————————————-#



226
227
228
 
# File 'lib/motion/project/cocoapods.rb', line 226

def pods_installer
  @installer ||= Pod::Installer.new(cp_config.sandbox, @podfile, cp_config.lockfile)
end

#pods_libraries ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/motion/project/cocoapods.rb', line 338

def pods_libraries
  xcconfig = pods_xcconfig_hash
  ldflags = xcconfig['OTHER_LDFLAGS']

  # Get the name of all static libraries that come pre-built with pods
  pre_built_static_libs = lib_search_paths.map do |path|
    Dir[File.join(path, '**/*.a')].map { |f| File.basename(f) }
  end.flatten

  pods_libs = []
  @config.libs.concat(ldflags.scan(/-l"?([^\s"]+)"?/).map { |m|
    lib_name = m[0]
    next if lib_name.nil?
    if lib_name.start_with?('Pods-')
      # For CocoaPods 0.37.x or below. This block is marked as deprecated.
      pods_libs << lib_name
      nil
    elsif pre_built_static_libs.include?("lib#{lib_name}.a")
      "#{lib_search_path_flags} -ObjC -l#{lib_name}"
    elsif File.exist?("/usr/lib/lib#{lib_name}.dylib")
      "/usr/lib/lib#{lib_name}.dylib"
    else
      pods_libs << lib_name
      nil
    end
  }.compact)
  @config.libs.uniq!

  pods_libs
end

#pods_xcconfig ⇒ Object 



324
325
326
327
328
329
330
 
# File 'lib/motion/project/cocoapods.rb', line 324

def pods_xcconfig
  @pods_xcconfig ||= begin
    path = Pathname.new(@config.project_dir) + SUPPORT_FILES + "Pods-#{TARGET_NAME}.release.xcconfig"
    Xcodeproj::Config.new(path) if path.exist?
  end
  @pods_xcconfig
end

#pods_xcconfig_hash ⇒ Object 



332
333
334
335
336
 
# File 'lib/motion/project/cocoapods.rb', line 332

def pods_xcconfig_hash
  if xcconfig = pods_xcconfig
    xcconfig.to_hash
  end
end

#post_install(&block) ⇒ Object 



214
215
216
 
# File 'lib/motion/project/cocoapods.rb', line 214

def post_install(&block)
  @podfile.post_install(&block)
end

#resources ⇒ Object

Do not copy ‘.framework` bundles, these should be handled through RM’s ‘embedded_frameworks` config attribute.



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/motion/project/cocoapods.rb', line 524

def resources
  resources = []
  script = Pathname.new(@config.project_dir) + SUPPORT_FILES + "Pods-#{TARGET_NAME}-resources.sh"
  return resources unless File.exist?(script)
  File.open(script) { |f|
    f.each_line do |line|
      if matched = line.match(/install_resource\s+(.*)/)
        path = (matched[1].strip)[1..-2]
        if path.start_with?('${PODS_ROOT}')
          path = path.sub('${PODS_ROOT}/', '')
        end
        if path.include?("$PODS_CONFIGURATION_BUILD_DIR")
          path = File.join(".build", File.basename(path))
        end
        unless File.extname(path) == '.framework'
          resources << Pathname.new(@config.project_dir) + PODS_ROOT + path
        end
      end
    end
  }
  resources.uniq
end

#resources_dir ⇒ Object 



547
548
549
 
# File 'lib/motion/project/cocoapods.rb', line 547

def resources_dir
  Pathname.new(@config.project_dir) + PODS_ROOT + 'Resources'
end

#source(source) ⇒ Object

DSL ————————————————————————-#



201
202
203
 
# File 'lib/motion/project/cocoapods.rb', line 201

def source(source)
  @podfile.source(source)
end

#static_frameworks_paths(frameworks) ⇒ Object 



510
511
512
513
514
515
516
517
518
519
 
# File 'lib/motion/project/cocoapods.rb', line 510

def static_frameworks_paths(frameworks)
  paths = []
  framework_search_paths.each do |framework_search_path|
    paths += Dir.glob("#{framework_search_path}/*.framework")
  end
  paths.keep_if { |path|
    frameworks.include?(File.basename(path, ".framework"))
  }
  paths
end

#symlink_framework_headers ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/motion/project/cocoapods.rb', line 255

def symlink_framework_headers
  framework_search_paths.each do |framework_search_path|
    Dir.glob("#{framework_search_path}/*.framework/Headers").each do |framework_path|
      FileUtils.mkdir_p(framework_public_headers_dir(framework_path))

      Dir.glob("#{framework_path}/*.h").each do |header_path|
        relative_path = "../../..#{header_path.sub(File.join(@config.project_dir, PODS_ROOT), '')}"
        File.symlink(relative_path, "#{framework_public_headers_dir(framework_path)}/#{File.basename(header_path)}")
      end
    end
  end
end

#use_frameworks!(flag = true) ⇒ Object 



218
219
220
221
 
# File 'lib/motion/project/cocoapods.rb', line 218

def use_frameworks!(flag = true)
  @use_frameworks = flag
  @podfile.use_frameworks!(flag)
end