Skip to content

Commit

Permalink
Update installation instruction for CP 1.7+ (#522)
Browse files Browse the repository at this point in the history 
Summary:
This PR updates the installation instruction for Cocoapods 1.7+ as the previous installation instruction was broken for the latest Cocoapods version

Solves #478 and #495

## Changelog

- Updated the Documentation
- Updated the sample app
Pull Request resolved: #522

Test Plan:
- Travis CI
- Also tested locally by building sample app.

Reviewed By: jknoxville

Differential Revision: D16902023

Pulled By: priteshrnandgaonkar

fbshipit-source-id: 19cc01c842f93ab3565c302f8258ca88dbdecfb2
  • Loading branch information
@priteshrnandgaonkar @facebook-github-bot
priteshrnandgaonkar authored and facebook-github-bot committed Aug 20, 2019
1 parent a2a2881 commit 6056e85
Show file tree
Hide file tree
Showing 5 changed files with 114 additions and 18 deletions.
4 changes: 4 additions & 0 deletions .travis.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ matrix:
cache: cocoapods

before_install:
- gem install cocoapods
- pod --version
- rm -rf iOS/Sample/Pods
- rm -f iOS/Sample/Podfile.lock
- rm -f iOS/Sample/build.log
Expand All @@ -64,6 +66,8 @@ matrix:
- language: objective-c

before_install:
- gem install cocoapods
- pod --version
- rm -rf iOS/SampleSwift/Pods
- rm -f iOS/SampleSwift/Podfile.lock
- rm -f iOS/SampleSwift/build.log
Expand Down
55 changes: 45 additions & 10 deletions docs/getting-started.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,26 +99,54 @@ dependencies {

## Setup your iOS app

We support both Swift and Objective-C for Flipper with CocoaPods as build and distribution mechanism.
We support both Swift and Objective-C for Flipper with CocoaPods as build and distribution mechanism. For CocoaPods 1.7+ following is the configuration.

### CocoaPods

<!--DOCUSAURUS_CODE_TABS-->
<!--Objective-C-->
```ruby
project 'MyApp.xcodeproj'
swift_version = "4.1"
flipperkit_version = '0.23.4'

target 'MyApp' do
platform :ios, '9.0'

# use_framework!
pod 'FlipperKit', '~>' + flipperkit_version
pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', '~>' + flipperkit_version
pod 'FlipperKit/SKIOSNetworkPlugin', '~>' + flipperkit_version
pod 'FlipperKit/FlipperKitUserDefaultsPlugin', '~>' + flipperkit_version

# If you use `use_frameworks!` in your Podfile,
# uncomment the below $static_framework array and also
# the pre_install section. This will cause Flipper and
# it's dependencies to be built as a static library and all other pods to
# be dynamic.
# $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
# 'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion',
# 'glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
# 'CocoaLibEvent', 'openssl-ios-bitcode', 'boost-for-react-native']
#
# pre_install do |installer|
# Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
# installer.pod_targets.each do |pod|
# if $static_framework.include?(pod.name)
# def pod.build_type;
# Pod::Target::BuildType.static_library
# end
# end
# end
# end

# This post_install hook adds the -DFB_SONARKIT_ENABLED=1 flag to OTHER_CFLAGS, necessary to expose Flipper classes in the header files
post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name == 'YogaKit'
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.1'
end
end
end
file_name = Dir.glob("*.xcodeproj")[0]
app_project = Xcodeproj::Project.open(file_name)
app_project.native_targets.each do |target|
Expand All @@ -139,7 +167,6 @@ end
<!--Swift-->
```ruby
project 'MyApp.xcodeproj'
swift_version = "4.1"
flipperkit_version = '0.23.4'

target 'MyApp' do
Expand All @@ -154,26 +181,34 @@ target 'MyApp' do
# If you use `use_frameworks!` in your Podfile,
# uncomment the below $static_framework array and also
# the pre_install section. This will cause Flipper and
# it's dependencies to be static and all other pods to
# it's dependencies to be built as a static library and all other pods to
# be dynamic.

# $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
# 'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion',
# 'glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
# 'CocoaLibEvent', 'OpenSSL-Static', 'boost-for-react-native']
# 'CocoaLibEvent', 'openssl-ios-bitcode', 'boost-for-react-native']
#
# pre_install do |installer|
# Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
# installer.pod_targets.each do |pod|
# if $static_framework.include?(pod.name)
# pod.instance_variable_set(:@host_requires_frameworks, false)
# if $static_framework.include?(pod.name)
# def pod.build_type;
# Pod::Target::BuildType.static_library
# end
# end
# end
# end
# end


# This post_install hook adds the -DFB_SONARKIT_ENABLED flag to OTHER_SWIFT_FLAGS, necessary to build swift target
post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name == 'YogaKit'
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.1'
end
end
end
file_name = Dir.glob("*.xcodeproj")[0]
app_project = Xcodeproj::Project.open(file_name)
app_project.native_targets.each do |target|
Expand Down
30 changes: 29 additions & 1 deletion iOS/Sample/Podfile
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
project 'Sample.xcodeproj'
source 'https://github.com/facebook/Sonar.git'
source 'https://github.com/CocoaPods/Specs'
swift_version = "4.1"

target 'Sample' do
platform :ios, '9.0'
Expand All @@ -11,8 +10,37 @@ target 'Sample' do
pod 'FlipperKit/FlipperKitUserDefaultsPlugin', :path => '../../FlipperKit.podspec'
pod 'FlipperKit/FlipperKitExamplePlugin', :path => '../../FlipperKit.podspec'
pod 'Flipper', :path => '../../Flipper.podspec'

# If you use `use_frameworks!` in your Podfile,
# uncomment the below $static_framework array and also
# the pre_install section. This will cause Flipper and
# it's dependencies to be built as a static library and all other pods to
# be dynamic.
# $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
# 'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion',
# 'glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
# 'CocoaLibEvent', 'openssl-ios-bitcode', 'boost-for-react-native']
#
# pre_install do |installer|
# Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
# installer.pod_targets.each do |pod|
# if $static_framework.include?(pod.name)
# def pod.build_type;
# Pod::Target::BuildType.static_library
# end
# end
# end
# end

# It also adds -DFB_SONARKIT_ENABLED=1 flag to OTHER_CFLAGS, necessary to build expose Flipper classes in the header files
post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name == 'YogaKit'
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.1'
end
end
end
file_name = Dir.glob("*.xcodeproj")[0]
app_project = Xcodeproj::Project.open(file_name)
app_project.native_targets.each do |target|
Expand Down
30 changes: 29 additions & 1 deletion iOS/SampleSwift/Podfile
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
project 'SampleSwift.xcodeproj'
source 'https://github.com/facebook/Sonar.git'
source 'https://github.com/CocoaPods/Specs'
swift_version = "4.1"

target 'SampleSwift' do
platform :ios, '9.0'
Expand All @@ -11,7 +10,36 @@ target 'SampleSwift' do
pod 'FlipperKit/FlipperKitUserDefaultsPlugin', :path => '../../FlipperKit.podspec'
pod 'FlipperKit/FlipperKitExamplePlugin', :path => '../../FlipperKit.podspec'
pod 'FlipperKit/FlipperKitLayoutComponentKitSupport', :path => '../../FlipperKit.podspec'

# If you use `use_frameworks!` in your Podfile,
# uncomment the below $static_framework array and also
# the pre_install section. This will cause Flipper and
# it's dependencies to be built as a static library and all other pods to
# be dynamic.
# $static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
# 'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion',
# 'glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
# 'CocoaLibEvent', 'openssl-ios-bitcode', 'boost-for-react-native']
#
# pre_install do |installer|
# Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
# installer.pod_targets.each do |pod|
# if $static_framework.include?(pod.name)
# def pod.build_type;
# Pod::Target::BuildType.static_library
# end
# end
# end
# end

post_install do |installer|
installer.pods_project.targets.each do |target|
if target.name == 'YogaKit'
target.build_configurations.each do |config|
config.build_settings['SWIFT_VERSION'] = '4.1'
end
end
end
file_name = Dir.glob("*.xcodeproj")[0]
app_project = Xcodeproj::Project.open(file_name)
app_project.native_targets.each do |target|
Expand Down
13 changes: 7 additions & 6 deletions iOS/Tutorial/Podfile
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
project 'Tutorial.xcodeproj'
swift_version = "4.1"
flipperkit_version = '0.20.0'
flipperkit_version = '0.23.4'
use_frameworks!

target 'Tutorial' do
Expand All @@ -17,19 +17,20 @@ target 'Tutorial' do
# the pre_install section. This will cause Flipper and
# it's dependencies to be static and all other pods to
# be dynamic.

$static_framework = ['FlipperKit', 'Flipper', 'Flipper-Folly',
'CocoaAsyncSocket', 'ComponentKit', 'DoubleConversion',
'glog', 'Flipper-PeerTalk', 'Flipper-RSocket', 'Yoga', 'YogaKit',
'CocoaLibEvent', 'OpenSSL-Static', 'boost-for-react-native']
'CocoaLibEvent', 'openssl-ios-bitcode', 'boost-for-react-native']

pre_install do |installer|
Pod::Installer::Xcode::TargetValidator.send(:define_method, :verify_no_static_framework_transitive_dependencies) {}
installer.pod_targets.each do |pod|
if $static_framework.include?(pod.name)
pod.instance_variable_set(:@host_requires_frameworks, false)
if $static_framework.include?(pod.name)
def pod.build_type;
Pod::Target::BuildType.static_library
end
end
end
end
end


Expand Down

0 comments on commit 6056e85

Please sign in to comment.