Class: NotificationExtensionIntegrator

Inherits:
Object
  • Object
show all
Defined in:
lib/mmine/notification_extension_integrator.rb

Instance Method Summary collapse

Constructor Details

#initialize(application_code, project_file_path, app_group, main_target_name, cordova = false, xcframework = false, swift_ver, override_signing) ⇒ NotificationExtensionIntegrator

Returns a new instance of NotificationExtensionIntegrator.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/mmine/notification_extension_integrator.rb', line 17

def initialize(application_code, project_file_path, app_group, main_target_name, cordova = false, xcframework = false, swift_ver, override_signing)
  @project_file_path = project_file_path
  @app_group = app_group
  @main_target_name = main_target_name
  @logger = nil
  @cordova = cordova
  @xcframework = xcframework
  @swift_version = swift_ver
  @application_code = application_code
  @override_signing = override_signing

  @project_dir = Pathname.new(@project_file_path).parent.to_s
  @project = Xcodeproj::Project.open(@project_file_path)
  @project_name = @project.root_object.name
  @framework_file_name = "MobileMessaging.framework"

  @main_target = @project.native_targets.select { |target| target.name == @main_target_name }.first
  @main_build_configurations_debug = @main_target.build_configurations.select { |config| config.type == :debug }
  @main_build_configurations_release = @main_target.build_configurations.select { |config| config.type == :release }
  @main_build_settings_debug = @main_build_configurations_debug.map(&:build_settings)
  @main_build_settings_release = @main_build_configurations_release.map(&:build_settings)
end

Instance Method Details

#add_notification_extension_source_code ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/mmine/notification_extension_integrator.rb', line 178

def add_notification_extension_source_code
  if File.exist?(@extension_code_destination_filepath)
    @logger.info("Notification extension source code already exists on path: #{@extension_code_destination_filepath}")
  else
    @logger.info("Copying notification extension source code to path: #{@extension_code_destination_filepath}")
    FileUtils.cp(@extension_source_name_filepath, @extension_code_destination_filepath)
    filereference = get_notification_extension_group_reference.new_reference(@extension_code_destination_filepath)
    @extension_target.add_file_references([filereference])
  end
  put_application_code_in_source_code
end

#align_notification_extension_build_settings(key, main_configurations) ⇒ Object 



509
510
511
512
513
514
515
 
# File 'lib/mmine/notification_extension_integrator.rb', line 509

def align_notification_extension_build_settings(key, main_configurations)
  main_configurations.each do |config|
    value = config.resolve_build_setting(key)
    @logger.info("\tSetting extension build settings:\n\t\t#{config.name}:  \t#{key}\t#{value}")
    @extension_target.build_configuration_list[config.name].build_settings[key] = value
  end
end

#create_entitlements_file(_entitlements_name) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/mmine/notification_extension_integrator.rb', line 282

def create_entitlements_file(_entitlements_name)
  entitlements_destination_filepath = File.join(@project_dir, _entitlements_name)
  entitlements_source_filepath = File.join(Mmine.root, 'resources', "MobileMessagingNotificationExtension.entitlements")
  if File.exist?(entitlements_destination_filepath)
    @logger.info("\tEntitlements file already exists on path: #{entitlements_destination_filepath}")
  else
    @logger.info("\tCopying entitlements file to path: #{entitlements_destination_filepath}")
    FileUtils.cp(entitlements_source_filepath, entitlements_destination_filepath)
    ref = @project.main_group.new_reference(entitlements_destination_filepath)
    ref.last_known_file_type = "text.xml"
  end
  return resolve_xcode_path(entitlements_destination_filepath)
end

#create_notification_extension_dir ⇒ Object 



169
170
171
172
173
174
175
176
 
# File 'lib/mmine/notification_extension_integrator.rb', line 169

def create_notification_extension_dir
  if File.directory?(@extension_destination_dir)
    @logger.info("Notification extension directory already exists: #{@extension_destination_dir}")
  else
    @logger.info("Creating directory: #{@extension_destination_dir}")
    FileUtils.mkdir_p(@extension_destination_dir)
  end
end

#create_notification_extension_target ⇒ 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
 
# File 'lib/mmine/notification_extension_integrator.rb', line 131

def create_notification_extension_target
  @extension_target_name = 'MobileMessagingNotificationExtension'
  @extension_source_name_filepath = File.join(Mmine.root, 'resources', 'NotificationService.swift')
  @extension_dir_name = 'NotificationExtension'
  @extension_destination_dir = File.join(@project_dir, @extension_dir_name)
  @extension_code_destination_filepath = File.join(@extension_destination_dir, 'NotificationService.swift')
  @extension_group_name = 'NotificationExtensionGroup'
  @extension_plist_name = 'MobileMessagingNotificationServiceExtension.plist'
  @extension_plist_source_filepath = File.join(Mmine.root, 'resources', @extension_plist_name)
  @extension_info_plist_path = File.join(@project_dir, @extension_dir_name, @extension_plist_name)
  @extension_target = @project.native_targets.select { |target| target.name == @extension_target_name }.first
  if @extension_target == nil
    @logger.info("Creating notification extension target with name #{@extension_target_name}")
    @extension_target = @project.new_target(:app_extension, @extension_target_name, :ios)
  else
    @logger.info("Notification extension target already exists, reusing...")
  end

  @extension_build_configurations_debug = @extension_target.build_configurations.select { |config| config.type == :debug }
  @extension_build_configurations_release = @extension_target.build_configurations.select { |config| config.type == :release }
  @extension_build_settings_debug = @extension_build_configurations_debug.map(&:build_settings)
  @extension_build_settings_release = @extension_build_configurations_release.map(&:build_settings)

  @extension_target.frameworks_build_phase.files_references.each { |ref|
    @extension_target.frameworks_build_phase.remove_file_reference(ref)
  }

  unless @main_target.build_configurations.any? { |config| config.name == "Release"}
    @extension_target.build_configuration_list.build_configurations.delete_if { |config| config.name == "Release"}
  end
  unless @main_target.build_configurations.any? { |config| config.name == "Debug"}
    @extension_target.build_configuration_list.build_configurations.delete_if { |config| config.name == "Debug"}
  end

  @logger.info("Notification extension target debug build settings:\n#{JSON.pretty_generate(@extension_build_settings_debug)}")
  @logger.info("Notification extension target release build settings:\n#{JSON.pretty_generate(@extension_build_settings_release)}")
end

#erease_bridging_header ⇒ Object 



385
386
387
 
# File 'lib/mmine/notification_extension_integrator.rb', line 385

def erease_bridging_header
  set_notification_extension_build_settings('SWIFT_OBJC_BRIDGING_HEADER', '')
end

#get_notification_extension_group_reference ⇒ Object 



517
518
519
520
521
522
523
 
# File 'lib/mmine/notification_extension_integrator.rb', line 517

def get_notification_extension_group_reference
  group_reference = @project.groups.select { |group| group.name == @extension_group_name }.first
  if group_reference == nil
    group_reference = @project.new_group(@extension_group_name, @extension_destination_dir)
  end
  return group_reference
end

#get_xml_string_value(key, plist_path) ⇒ Object 



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/mmine/notification_extension_integrator.rb', line 553

def get_xml_string_value(key, plist_path)
  plist_path = resolve_absolute_paths([plist_path]).first
  doc = Nokogiri::XML(IO.read(plist_path))
  key_node = doc.search("//dict//key[text() = '#{key}']").first
  if key_node == nil
    return nil
  else
    existing_string_value_node = key_node.xpath("following-sibling::*").first
    if existing_string_value_node.name == 'string'
      return existing_string_value_node.content
    else
      return nil
    end
  end
end

#logger ⇒ Object 



44
45
46
 
# File 'lib/mmine/notification_extension_integrator.rb', line 44

def logger
  @logger
end

#logger=(_logger) ⇒ Object 



40
41
42
 
# File 'lib/mmine/notification_extension_integrator.rb', line 40

def logger=(_logger)
  @logger = _logger
end

#put_application_code_in_source_code ⇒ Object 



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/mmine/notification_extension_integrator.rb', line 190

def put_application_code_in_source_code
  source_code = File.read(@extension_code_destination_filepath)
  modified_source_code = source_code.gsub(/<# put your Application Code here #>/, "\"#{@application_code}\"")
  unless source_code == modified_source_code
    File.open(@extension_code_destination_filepath, "w") do |file|
      @logger.info("\tWriting application code to source code at #{@extension_code_destination_filepath}")
      file.puts modified_source_code
    end
  end
end

#put_key_array_element(key, value, file_paths) ⇒ Object

check if it appends to existing array



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/mmine/notification_extension_integrator.rb', line 603

def put_key_array_element(key, value, file_paths) # check if it appends to existing array
  @logger.debug("put_key_array_element #{key} #{value} #{file_paths}")
  file_paths.each do |file_path|
    file_path = resolve_absolute_paths([file_path]).first
    doc = Nokogiri::XML(IO.read(file_path))
    key_node = doc.search("//dict//key[text() = '#{key}']").first
    string_app_group_value = Nokogiri::XML::Node.new("string", doc)
    string_app_group_value.content = value
    if key_node == nil
      @logger.info("\tAdding 'key' node with content #{key}")
      key_node = Nokogiri::XML::Node.new("key", doc)
      key_node.content = key
      array_node = Nokogiri::XML::Node.new("array", doc)
      array_node.add_child(string_app_group_value)

      doc.xpath("//dict").first.add_child(key_node)
      key_node.add_next_sibling(array_node)
    else
      @logger.info("\t'Key' node with content #{key} already exists.")
      array_node = key_node.xpath("following-sibling::*").first
      if array_node.name == 'array'
        @logger.info("\tFollowing array sibling already exists")
        if array_node.xpath("//string[text() = '#{value}']").first
          @logger.info("\tArray string element with content #{value} already exists")
        else
          @logger.info("\tAdding child string element with content #{value}")
          array_node.add_child(string_app_group_value)
        end
      else
        @logger.info("\tFollowing array sibling is missing. Adding array node containing a string element.")
        array_node = Nokogiri::XML::Node.new("array", doc)
        array_node.add_child(string_app_group_value)
        key_node.add_next_sibling(array_node)
      end
    end

    File.open(file_path, 'w') do |file|
      @logger.info("\tWriting changes to entitlements: #{file_path}")
      file.puts Nokogiri::XML(doc.to_xml) { |x| x.noblanks }
    end
  end
end

#put_string_value_into_xml(key, value, plist_paths) ⇒ Object 



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/mmine/notification_extension_integrator.rb', line 569

def put_string_value_into_xml(key, value, plist_paths)
  plist_paths.each do |plist_path|
    plist_path = resolve_absolute_paths([plist_path]).first
    @logger.info("\tConfiguring plist on path: #{plist_path}")
    doc = Nokogiri::XML(IO.read(plist_path))
    key_node = doc.search("//dict//key[text() = '#{key}']").first
    string_value_node = Nokogiri::XML::Node.new("string", doc)
    string_value_node.content = value
    if key_node == nil
      @logger.info("\tAdding 'key' node with content #{key}")
      key_node = Nokogiri::XML::Node.new("key", doc)
      key_node.content = key
      doc.xpath("//dict").first.add_child(key_node)
      @logger.info("\tAdding next string sibling with content #{string_value_node}")
      key_node.add_next_sibling(string_value_node)
    else
      @logger.info("\t'Key' node with content #{key} already exists.")
      existing_string_value_node = key_node.xpath("following-sibling::*").first
      if existing_string_value_node.name == 'string'
        @logger.info("\tUpdating following string sibling value with #{value}")
        existing_string_value_node.content = value
      else
        @logger.info("\tAdding next string sibling with content #{string_value_node}")
        key_node.add_next_sibling(string_value_node)
      end
    end

    File.open(plist_path, 'w') do |file|
      @logger.info("\tWriting changes to plist: #{plist_path}")
      file.puts Nokogiri::XML(doc.to_xml) { |x| x.noblanks }
    end
  end
end

#remove_embed_framework_phase ⇒ Object 



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/mmine/notification_extension_integrator.rb', line 484

def remove_embed_framework_phase
  @logger.info("Setting up embed framework script")
  @main_target.copy_files_build_phases
      .select { |phase|
        phase.dst_subfolder_spec == '10'
      }
      .each { |phase|
        phase.files.select { |file|
          file.display_name == @framework_file_name
        }.each { |file|
          @logger.info("\tRemoving embeddin #{@framework_file_name} from phase #{phase.display_name}")
          phase.remove_build_file(file)
        }
      }
end

#resolve_absolute_paths(paths) ⇒ Object 



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/mmine/notification_extension_integrator.rb', line 525

def resolve_absolute_paths(paths)
  paths.map do |path|
    ret = path
    ["$(PROJECT_DIR)", "$PROJECT_DIR"].each do |proj_dir|
      ret = ret.sub(proj_dir, @project_dir)
    end

    ["$(PROJECT_NAME)", "$PROJECT_NAME"].each do |proj_name|
      ret = ret.sub(proj_name, @project_name)
    end

    if ret.include?("$")
      puts "Could not resolve absolute path for #{path}. Make sure you don't misuse Xcode paths variables, contact Infobip Mobile Messaging support via email [email protected]"
      exit
    end

    if ret == path && !ret.include?("$") # no aliases found/replaced, no aliases left in path
      if path.start_with? "/"
        ret = path # it's already an absolute path
      else
        ret = File.join(@project_dir, path) # it's a relative project path
      end
    end

    ret
  end
end

#resolve_recursive_build_setting(config, setting) ⇒ Object

github.com/CocoaPods/Xcodeproj/issues/505#issuecomment-584699008 Augments config.resolve_build_setting from xcproject to continue expanding build settings and evaluate modifiers



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
 
# File 'lib/mmine/notification_extension_integrator.rb', line 242

def resolve_recursive_build_setting(config, setting)
  resolution = config.resolve_build_setting(setting)

  # finds values with one of
  # $VALUE
  # $(VALLUE)
  # $(VALUE:modifier)
  # ${VALUE}
  # ${VALUE:modifier}
  resolution.gsub(/\$[\(\{]?.+[\)\}]?/) do |raw_value|
    # strip $() characters
    unresolved = raw_value.gsub(/[\$\(\)\{\}]/, '')

    # Get the modifiers after the ':' characters
    name, *modifiers = unresolved.split(':')

    # Expand variable name
    subresolution = resolve_recursive_build_setting(config, name)

    # Apply modifiers
    # NOTE: not all cases accounted for
    #
    # See http://codeworkshop.net/posts/xcode-build-setting-transformations
    # for various modifier options
    modifiers.each do |modifier|
      case modifier
      when 'lower'
        subresolution.downcase!
      when 'upper'
        subresolution.upcase!
      else
        # Fastlane message
        @logger.info("Unknown modifier: `#{modifier}` in `#{raw_value}")
      end
    end

    subresolution
  end
end

#resolve_xcode_path(path) ⇒ Object 



500
501
502
 
# File 'lib/mmine/notification_extension_integrator.rb', line 500

def resolve_xcode_path(path)
  return path.sub(@project_dir, '$(PROJECT_DIR)')
end

#set_notification_extension_build_settings(key, value) ⇒ Object 



504
505
506
507
 
# File 'lib/mmine/notification_extension_integrator.rb', line 504

def set_notification_extension_build_settings(key, value)
  @logger.info("\tSetting extension build settings across all configurations :\n\t\t#{key}\t#{value}")
  @extension_target.build_configuration_list.set_setting(key, value)
end

#setup_background_modes_plist_value ⇒ Object 



363
364
365
366
 
# File 'lib/mmine/notification_extension_integrator.rb', line 363

def setup_background_modes_plist_value
  plist_paths = (@main_build_configurations_debug + @main_build_configurations_release).map { |config| config.resolve_build_setting("INFOPLIST_FILE") }
  put_key_array_element("UIBackgroundModes", "remote-notification", resolve_absolute_paths(plist_paths))
end

#setup_copy_framework_script ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/mmine/notification_extension_integrator.rb', line 427

def setup_copy_framework_script
  phase_name = "Copy Frameworks"
  shell_script = "/usr/local/bin/carthage copy-frameworks"
  input_path = "$SRCROOT/$PROJECT/Plugins/com-infobip-plugins-mobilemessaging/#{@framework_file_name}"
  output_path = "$(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/#{@framework_file_name}"
  existing_phase = @main_target.shell_script_build_phases.select { |phase| phase.shell_script.include? shell_script }.first

  if existing_phase
    existing_phase.input_paths |= [input_path]
    existing_phase.output_paths |= [output_path]
    @logger.info("Main target already has #{phase_name} shell script set up")
  else
    @logger.info("Setting up #{phase_name} shell script for main target")
    new_phase = @main_target.new_shell_script_build_phase(phase_name)
    new_phase.shell_path = "/bin/sh"
    new_phase.shell_script = shell_script
    new_phase.input_paths << input_path
    new_phase.output_paths << output_path
  end

  remove_embed_framework_phase
end

#setup_deployment_target ⇒ Object 



206
207
208
 
# File 'lib/mmine/notification_extension_integrator.rb', line 206

def setup_deployment_target
  set_notification_extension_build_settings('IPHONEOS_DEPLOYMENT_TARGET', "10.0")
end

#setup_development_team ⇒ Object 



201
202
203
204
 
# File 'lib/mmine/notification_extension_integrator.rb', line 201

def setup_development_team
  align_notification_extension_build_settings('DEVELOPMENT_TEAM',
                                              @main_target.build_configurations)
end

#setup_embed_extension_action ⇒ Object 



368
369
370
371
372
373
374
375
376
 
# File 'lib/mmine/notification_extension_integrator.rb', line 368

def setup_embed_extension_action
  phase_name = 'Embed App Extensions'
  unless @main_target.copy_files_build_phases.select { |phase| phase.name == phase_name }.first
    @logger.info("Adding copy files build phase: #{phase_name}")
    new_phase = @main_target.new_copy_files_build_phase(phase_name)
    new_phase.dst_subfolder_spec = '13'
    new_phase.add_file_reference(@extension_target.product_reference)
  end
end

#setup_entitlements(entitlements_debug_file_paths, entitlements_release_file_paths, target_name, _build_settings_debug, _build_settings_release) ⇒ Object 



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
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/mmine/notification_extension_integrator.rb', line 296

def setup_entitlements(entitlements_debug_file_paths, entitlements_release_file_paths, target_name, _build_settings_debug, _build_settings_release)
  entitlements_debug_file_paths = entitlements_debug_file_paths ? entitlements_debug_file_paths.compact : nil
  entitlements_release_file_paths = entitlements_release_file_paths ? entitlements_release_file_paths.compact :  nil
  @logger.debug("setup_entitlements #{entitlements_debug_file_paths} #{entitlements_release_file_paths} #{target_name} #{_build_settings_debug} #{_build_settings_release}")
  code_sign_entitlements_key = 'CODE_SIGN_ENTITLEMENTS'
  aps_env_key = 'aps-environment'
  development = 'development'
  production = 'production'
  if (entitlements_debug_file_paths == nil or entitlements_debug_file_paths.empty?) and (entitlements_release_file_paths == nil or entitlements_release_file_paths.empty?) and target_name != nil
    @logger.info("\tEntitlements are not set for both release and debug schemes, setting up...")
    entitlements_destination_filepath = create_entitlements_file("#{target_name}.entitlements")

    @logger.info("\tSetting build settings:\n\t\tdebug:  \t#{code_sign_entitlements_key}\t#{entitlements_destination_filepath}\n\t\trelease:\t#{code_sign_entitlements_key}\t#{entitlements_destination_filepath}")

    _build_settings_debug.each do |setting|
      setting[code_sign_entitlements_key] = entitlements_destination_filepath
    end
    _build_settings_release.each do |setting|
      setting[code_sign_entitlements_key] = entitlements_destination_filepath
    end
    entitlements_debug_file_paths = [entitlements_destination_filepath]
    entitlements_release_file_paths = [entitlements_destination_filepath]
  end

  if entitlements_debug_file_paths.to_set == entitlements_release_file_paths.to_set
    @logger.info("\tEntitlements settings are equal for debug and release schemes.")

    put_key_array_element("com.apple.security.application-groups", @app_group, entitlements_debug_file_paths)

    #aps env should be set only for main target
    if (target_name != @extension_target_name)
      put_string_value_into_xml(aps_env_key, development, entitlements_debug_file_paths)
    end
  else
    if (entitlements_debug_file_paths == nil or entitlements_debug_file_paths.empty?) and target_name != nil
      @logger.error("\tEntitlements debug settings are not set, creating entitlements file")
      entitlements_destination_filepath = create_entitlements_file("#{target_name}_debug.entitlements")
      _build_settings_debug.each do |setting|
        setting[code_sign_entitlements_key] = entitlements_destination_filepath
      end
      entitlements_debug_file_paths = [entitlements_destination_filepath]
    end

    if (entitlements_release_file_paths == nil or entitlements_release_file_paths.empty?) and target_name != nil
      @logger.error("\tEntitlements release settings are not set, creating entitlements file")
      entitlements_destination_filepath = create_entitlements_file("#{target_name}_release.entitlements")
      _build_settings_release.each do |setting|
        setting[code_sign_entitlements_key] = entitlements_destination_filepath
      end
      entitlements_release_file_paths = [entitlements_destination_filepath]
    end

    put_key_array_element("com.apple.security.application-groups", @app_group, entitlements_debug_file_paths + entitlements_release_file_paths)

    #aps env should be set only for main target
    if (target_name != @extension_target_name)
      put_string_value_into_xml(aps_env_key, development, entitlements_debug_file_paths)
      put_string_value_into_xml(aps_env_key, production, entitlements_release_file_paths)
    end
  end
end

#setup_extension_build_number ⇒ Object 



405
406
407
408
409
410
 
# File 'lib/mmine/notification_extension_integrator.rb', line 405

def setup_extension_build_number
  version_key = "CFBundleShortVersionString"
  build_key = "CFBundleVersion"
  put_string_value_into_xml(version_key, '1.0', [@extension_info_plist_path])
  put_string_value_into_xml(build_key, '1', [@extension_info_plist_path])
end

#setup_extension_lib_cordova_link ⇒ Object 



412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/mmine/notification_extension_integrator.rb', line 412

def setup_extension_lib_cordova_link
  lib_cordova_name = 'libCordova.a'
  if @extension_target.frameworks_build_phase.files_references.select { |ref| ref.path == lib_cordova_name }.first
    @logger.info("Notification Extension target already has libCordova.a linked.")
  else
    @logger.info("Adding libCordova.a to Notification Extension target...")
    ref = @main_target.frameworks_build_phase.files_references.select { |ref| ref.path == lib_cordova_name }.first
    if ref
      @extension_target.frameworks_build_phase.add_file_reference(ref)
    else
      @logger.error("Main target has no libCordova.a as a linked library. Unable to add libCordova.a to Notification Extension target!")
    end
  end
end

#setup_extension_target_signing(override_signing) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mmine/notification_extension_integrator.rb', line 106

def setup_extension_target_signing(override_signing)
  @logger.info("Overriding extension target signing: #{override_signing}")

  signing_settings = {
      'DEVELOPMENT_TEAM' => '$MM_EXTENSION_DEVELOPMENT_TEAM',
      'CODE_SIGN_IDENTITY' => '$MM_EXTENSION_CODE_SIGN_IDENTITY',
  }

  signing_settings.keys.each do |key|
    value = signing_settings[key]
    @logger.info("Checking extension signing for key: #{key} value: #{value}")
    if override_signing
      set_notification_extension_build_settings(key, value)
    else
      # Delete setting if it was previously overridden
      @extension_target.build_configurations.each do |config|
        if config.resolve_build_setting(key) == value
          @logger.info("Deletes extension setting for key: #{key} value: #{value}")
          config.build_settings[key] = ''
        end
      end
    end
  end
end

#setup_framework_search_paths ⇒ Object 



389
390
391
 
# File 'lib/mmine/notification_extension_integrator.rb', line 389

def setup_framework_search_paths
  set_notification_extension_build_settings('FRAMEWORK_SEARCH_PATHS', '$SRCROOT/$PROJECT/Plugins/com-infobip-plugins-mobilemessaging/**')
end

#setup_main_target_dependency ⇒ Object 



378
379
380
381
382
383
 
# File 'lib/mmine/notification_extension_integrator.rb', line 378

def setup_main_target_dependency
  unless @main_target.dependency_for_target(@extension_target)
    @logger.info("Adding extension target dependency for main target")
    @main_target.add_dependency(@extension_target)
  end
end

#setup_notification_extension ⇒ Object 



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
74
75
76
77
78
79
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
 
# File 'lib/mmine/notification_extension_integrator.rb', line 48

def setup_notification_extension
  puts "🏎  Integration starting... ver. #{Mmine::VERSION}"
  @logger.debug("\n@main_target_build_configurations_debug #{@main_build_configurations_debug}\n@main_target_build_configurations_release #{@main_build_configurations_release}")
  @logger.debug("\n@main_target_build_configurations_debug #{JSON.pretty_generate(@main_build_settings_debug)}\n@main_target_build_configurations_release #{JSON.pretty_generate(@main_build_settings_release)}")
  create_notification_extension_target
  create_notification_extension_dir
  add_notification_extension_source_code
  setup_extension_target_signing(@override_signing)
  if @override_signing == false
    setup_development_team
  end
  setup_deployment_target
  setup_notification_extension_info_plist
  setup_notification_extension_bundle_id

  setup_user_app_group_value
  setup_background_modes_plist_value

  setup_target_capabilities_for_extension_target
  setup_target_capabilities_for_main_target

  setup_embed_extension_action
  setup_main_target_dependency
  setup_swift_version
  setup_product_name
  setup_extension_build_number
  setup_run_path_search_paths
  erease_bridging_header

  if @cordova
    setup_entitlements(nil,
                       nil,
                       @extension_target_name,
                       @extension_build_settings_debug,
                       @extension_build_settings_release)
    #setup_extension_lib_cordova_link
    setup_framework_search_paths
    unless @xcframework
      setup_copy_framework_script
    end
  else
    setup_entitlements(@main_build_configurations_debug.map { |config| config.resolve_build_setting('CODE_SIGN_ENTITLEMENTS') },
                       @main_build_configurations_release.map { |config| config.resolve_build_setting('CODE_SIGN_ENTITLEMENTS') },
                       @main_target_name,
                       @main_build_settings_debug,
                       @main_build_settings_release)

    setup_entitlements(@extension_build_configurations_debug.map { |config| config.resolve_build_setting('CODE_SIGN_ENTITLEMENTS') },
                       @extension_build_configurations_release.map { |config| config.resolve_build_setting('CODE_SIGN_ENTITLEMENTS') },
                       @extension_target_name,
                       @extension_build_settings_debug,
                       @extension_build_settings_release)
  end

  @project.save
  puts "🏁 Integration has been finished successfully!"
end

#setup_notification_extension_bundle_id ⇒ Object

todo test it



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/mmine/notification_extension_integrator.rb', line 221

def setup_notification_extension_bundle_id #todo test it
  suffix = 'notification-extension'
  key = 'PRODUCT_BUNDLE_IDENTIFIER'
  (@main_build_configurations_release + @main_build_configurations_debug).each do |config|
    bundleId = resolve_recursive_build_setting(config, key)
    if bundleId == nil
      plist_path = resolve_absolute_paths([config.resolve_build_setting("INFOPLIST_FILE")]).first
      bundleId = get_xml_string_value(key, plist_path)
      @logger.info("Composing #{key} from main target info plist: #{bundleId}.")
    else
      @logger.info("Composing #{key} from main target config build setting: #{bundleId}.")
    end
    value = "#{bundleId}.#{suffix}"
    @logger.info("\tSetting extension build settings:\n\t\t#{config.name}:  \t#{key}\t#{value}")
    @extension_target.build_configuration_list[config.name].build_settings[key] = value
  end
end

#setup_notification_extension_info_plist ⇒ Object 



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/mmine/notification_extension_integrator.rb', line 210

def setup_notification_extension_info_plist
  if File.exist?(@extension_info_plist_path)
    @logger.info("Notification extension info plist already exists on path: #{@extension_info_plist_path}")
  else
    @logger.info("Copying extension plist file to path: #{@extension_info_plist_path}")
    FileUtils.cp(@extension_plist_source_filepath, @extension_info_plist_path)
    get_notification_extension_group_reference.new_reference(@extension_info_plist_path) #check if additional plist manipulations needed (target membership?)
  end
  set_notification_extension_build_settings('INFOPLIST_FILE', resolve_xcode_path(@extension_info_plist_path))
end

#setup_product_name ⇒ Object 



401
402
403
 
# File 'lib/mmine/notification_extension_integrator.rb', line 401

def setup_product_name
  set_notification_extension_build_settings('PRODUCT_NAME', @extension_target_name)
end

#setup_run_path_search_paths ⇒ Object 



393
394
395
 
# File 'lib/mmine/notification_extension_integrator.rb', line 393

def setup_run_path_search_paths
  set_notification_extension_build_settings('LD_RUNPATH_SEARCH_PATHS', '@executable_path/../../Frameworks')
end

#setup_swift_version ⇒ Object 



397
398
399
 
# File 'lib/mmine/notification_extension_integrator.rb', line 397

def setup_swift_version
  set_notification_extension_build_settings('SWIFT_VERSION', @swift_version)
end

#setup_target_capabilities(target_uuid, capabilities) ⇒ Object 



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/mmine/notification_extension_integrator.rb', line 470

def setup_target_capabilities(target_uuid, capabilities)
  unless @project.root_object.attributes["TargetAttributes"]
    @project.root_object.attributes["TargetAttributes"] = Hash.new
  end
  existing_capabilities = @project.root_object.attributes["TargetAttributes"][target_uuid]
  if existing_capabilities == nil
    @logger.info("\tSetting TargetAttributes #{capabilities} for target #{target_uuid}")
    @project.root_object.attributes["TargetAttributes"][target_uuid] = capabilities
  else
    @logger.info("\tMerging TargetAttributes #{capabilities} for target #{target_uuid}")
    @project.root_object.attributes["TargetAttributes"][target_uuid] = existing_capabilities.merge(capabilities)
  end
end

#setup_target_capabilities_for_extension_target ⇒ Object 



450
451
452
453
454
455
456
457
 
# File 'lib/mmine/notification_extension_integrator.rb', line 450

def setup_target_capabilities_for_extension_target
  mobile_messaging_capabilities = {"SystemCapabilities" =>
                                         {
                                             "com.apple.ApplicationGroups.iOS" => {"enabled" => 1},
                                         }
  }
  setup_target_capabilities(@extension_target.uuid, mobile_messaging_capabilities)
end

#setup_target_capabilities_for_main_target ⇒ Object 



459
460
461
462
463
464
465
466
467
468
 
# File 'lib/mmine/notification_extension_integrator.rb', line 459

def setup_target_capabilities_for_main_target
  mobile_messaging_capabilities = {"SystemCapabilities" =>
                                       {
                                           "com.apple.ApplicationGroups.iOS" => {"enabled" => 1},
                                           "com.apple.Push" => {"enabled" => 1},
                                           "com.apple.BackgroundModes" => {"enabled" => 1}
                                       }
  }
  setup_target_capabilities(@main_target.uuid, mobile_messaging_capabilities)
end

#setup_user_app_group_value ⇒ Object 



358
359
360
361
 
# File 'lib/mmine/notification_extension_integrator.rb', line 358

def setup_user_app_group_value
  plist_paths = (@main_build_configurations_debug + @main_build_configurations_release).map { |config| config.resolve_build_setting("INFOPLIST_FILE") }
  put_string_value_into_xml("com.mobilemessaging.app_group", @app_group, resolve_absolute_paths(plist_paths))
end