Class: Pod::Installer::Xcode::PodsProjectGenerator::AppHostInstaller

Inherits:
Object
  • Object
show all
Includes:
TargetInstallerHelper
Defined in:
lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb

Overview

Installs an app host target to a given project.

Constant Summary collapse

ADDITIONAL_INFO_PLIST_ENTRIES = 
{
  'NSAppTransportSecurity' => {
    'NSAllowsArbitraryLoads' => true,
  },
}.freeze
ADDITIONAL_IOS_INFO_PLIST_ENTRIES = 
{
  'UILaunchStoryboardName' => 'LaunchScreen',
  'UISupportedInterfaceOrientations' => %w(
    UIInterfaceOrientationPortrait
    UIInterfaceOrientationLandscapeLeft
    UIInterfaceOrientationLandscapeRight
  ),
  'UISupportedInterfaceOrientations~ipad' => %w(
    UIInterfaceOrientationPortrait
    UIInterfaceOrientationPortraitUpsideDown
    UIInterfaceOrientationLandscapeLeft
    UIInterfaceOrientationLandscapeRight
  ),
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TargetInstallerHelper

create_info_plist_file_with_sandbox, #create_info_plist_file_with_sandbox, #create_prefix_header, create_prefix_header, update_changed_file, #update_changed_file

Constructor Details

#initialize(sandbox, project, platform, subgroup_name, group_name, app_target_label, add_main: true, add_launchscreen_storyboard: platform == :ios, info_plist_entries: {}) ⇒ AppHostInstaller

Initialize a new instance

Parameters:

  • sandbox (Sandbox) —

    @see #sandbox

  • project (Pod::Project) —

    @see #project

  • platform (Platform) —

    @see #platform

  • subgroup_name (String) —

    @see #subgroup_name

  • group_name (String) —

    @see #group_name

  • app_target_label (String) —

    see #app_target_label

  • add_main (Boolean) (defaults to: true) —

    see #add_main

  • info_plist_entries (Hash) (defaults to: {}) —

    see #info_plist_entries


59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 59

def initialize(sandbox, project, platform, subgroup_name, group_name, app_target_label, add_main: true, add_launchscreen_storyboard: platform == :ios, info_plist_entries: {})
  @sandbox = sandbox
  @project = project
  @platform = platform
  @subgroup_name = subgroup_name
  @group_name = group_name
  @app_target_label = app_target_label
  @add_main = add_main
  @add_launchscreen_storyboard = add_launchscreen_storyboard
  @info_plist_entries = info_plist_entries
  target_group = project.pod_group(group_name)
  @group = target_group[subgroup_name] || target_group.new_group(subgroup_name)
end

Instance Attribute Details

#add_launchscreen_storyboard ⇒ Boolean (readonly)

Returns whether the app host installer should add a launch screen storyboard.

Returns:

  • (Boolean) —

    whether the app host installer should add a launch screen storyboard


42
43
44
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 42

def add_launchscreen_storyboard
  @add_launchscreen_storyboard
end

#add_main ⇒ Boolean (readonly)

Returns whether the app host installer should add main.m.

Returns:

  • (Boolean) —

    whether the app host installer should add main.m


38
39
40
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 38

def add_main
  @add_main
end

#app_target_label ⇒ String (readonly)

Returns the name of the app target label that will be used.

Returns:

  • (String) —

    the name of the app target label that will be used.


34
35
36
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 34

def app_target_label
  @app_target_label
end

#group_name ⇒ String (readonly)

Returns the name of the group the app host installer will be installing within.

Returns:

  • (String) —

    the name of the group the app host installer will be installing within.


30
31
32
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 30

def group_name
  @group_name
end

#info_plist_entries ⇒ Hash (readonly)

Returns Info.plist entries for the app host.

Returns:

  • (Hash) —

    Info.plist entries for the app host


46
47
48
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 46

def info_plist_entries
  @info_plist_entries
end

#platform ⇒ Platform (readonly)

Returns the platform to use for this app host.

Returns:

  • (Platform) —

    the platform to use for this app host.


22
23
24
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 22

def platform
  @platform
end

#project ⇒ Pod::Project (readonly)

Returns The project to install the app host into.

Returns:

  • (Pod::Project) —

    The project to install the app host into.


18
19
20
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 18

def project
  @project
end

#sandbox ⇒ Sandbox (readonly)

Returns The sandbox used for this installation.

Returns:

  • (Sandbox) —

    The sandbox used for this installation.


13
14
15
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 13

def sandbox
  @sandbox
end

#subgroup_name ⇒ String (readonly)

Returns the name of the sub group.

Returns:

  • (String) —

    the name of the sub group.


26
27
28
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 26

def subgroup_name
  @subgroup_name
end

Instance Method Details

#additional_info_plist_entries ⇒ Hash (private)

Returns the additional Info.plist entries to be included.

Returns:

  • (Hash) —

    the additional Info.plist entries to be included


119
120
121
122
123
124
125
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 119

def additional_info_plist_entries
  result = {}
  result.merge!(ADDITIONAL_INFO_PLIST_ENTRIES)
  result.merge!(ADDITIONAL_IOS_INFO_PLIST_ENTRIES) if platform == :ios
  result.merge!(info_plist_entries) if info_plist_entries
  result
end

#app_host_info_plist_path ⇒ Pathname (private)

Returns The absolute path of the Info.plist to use for an app host.

Returns:

  • (Pathname) —

    The absolute path of the Info.plist to use for an app host.


129
130
131
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 129

def app_host_info_plist_path
  project.path.dirname.+(subgroup_name).+("#{app_target_label}-Info.plist")
end

#deployment_target ⇒ String (private)

Returns The deployment target.

Returns:

  • (String) —

    The deployment target.


135
136
137
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 135

def deployment_target
  platform.deployment_target.to_s
end

#install! ⇒ PBXNativeTarget

Returns the app host native target that was installed.

Returns:

  • (PBXNativeTarget) —

    the app host native target that was installed.


75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cocoapods/installer/xcode/pods_project_generator/app_host_installer.rb', line 75

def install!
  platform_name = platform.name
  app_host_target = Pod::Generator::AppTargetHelper.add_app_target(project, platform_name, deployment_target,
                                                                   app_target_label)
  app_host_target.build_configurations.each do |configuration|
    configuration.build_settings['PRODUCT_NAME'] = app_target_label
    configuration.build_settings['PRODUCT_BUNDLE_IDENTIFIER'] = 'org.cocoapods.${PRODUCT_NAME:rfc1034identifier}'
    configuration.build_settings['CODE_SIGN_IDENTITY'] = '' if platform == :osx
    configuration.build_settings['CURRENT_PROJECT_VERSION'] = '1'
  end

  Pod::Generator::AppTargetHelper.add_app_host_main_file(project, app_host_target, platform_name, @group, app_target_label) if add_main
  Pod::Generator::AppTargetHelper.add_launchscreen_storyboard(project, app_host_target, @group, deployment_target, app_target_label) if add_launchscreen_storyboard
  create_info_plist_file_with_sandbox(sandbox, app_host_info_plist_path, app_host_target, '1.0.0', platform,
                                      :appl, :additional_entries => additional_info_plist_entries)
  @group.new_file(app_host_info_plist_path)
  app_host_target
end