CocoaPods Plugins

Longer version of my CocoaPods Plugins talk, given at mobiconf 2014 in Krakow.

Transcript

1. COCOAPODS PLUGINS MOBICONF, OCTOBER 2014 BORIS BÜGLING - @NEONACHO
3. CORE TEAM MEMBER
4. NO
5. CORE TEAM MEMBER
6. CONTENTFUL
7. AGENDA ▸ CocoaPods itself ▸ Useful plugins ▸ How to build your own plugin ▸ Improving your workflow ▸ (Mini CocoaPods state of the union)
8. COCOAPODS
9. THE DE-FACTO DEPENDENCY MANAGER
10. CREATED BY THIS HANDSOME GUY
11. ▸ Core ▸ cocoapods-downloader ▸ Xcodeproj ▸ CLAide ▸ CocoaPods
12. CORE spec = Pod::Specification.from_file('CPDColors.podspec') puts spec.name puts spec.version $ ./core.rb CPDColors 0.1.0
13. COCOAPODS-DOWNLOADER def download_head! hg! %|clone #{url} #{@target_path.shellescape}| [...] end def download_revision! hg! %|clone "#{url}" --rev '#{options[:revision]}' #{@target_path [...] end def download_tag! hg! %|clone "#{url}" --updaterev '#{options[:tag]}' #{@target_path [...] end
14. XCODEPROJ wrkspace = Xcodeproj::Workspace.new_from_xcworkspace( 'CPDColors/Example/Demo.xcworkspace') puts wrkspace.schemes $ ./xcodeproj.rb {"Demo"=>"/Users/boris/Projects/CPDColors/Example/Demo.xcodeproj", "Pods"=>"/Users/boris/Projects/CPDColors/Example/Pods/Pods.xcodeproj"}
15. CLAIDE argv = CLAide::ARGV.new(['tea', '--no-milk', '--sweetner=honey']) argv.shift_argument # => 'tea' argv.shift_argument # => nil argv.flag?('milk') # => false argv.flag?('milk') # => nil argv.option('sweetner') # => 'honey' argv.option('sweetner') # => nil
16. COCOAPODS $ pod install Analyzing dependencies Pre-downloading: `DBCamera` from `https://github.com/[...]` Downloading dependencies Installing ARASCIISwizzle (1.1.0) Installing Bolts (1.1.0) [...] Generating Pods project Integrating client project
17. COCOAPODS PLUGINS
18. COCOAPODS PLUGINS ▸ Add subcommands to pod, the tool ▸ post_install hook ▸ Each plugin is a Gem
19. DO WHATEVER YOU WANT, BECAUSE RUBY !
20. USEFUL PLUGINS
21. $ pod trunk push
22. $ pod plugins list
23. ▸ Uses https://github.com/CocoaPods/cocoapods.org/blob/master/ plugins.json
24. $ pod try BBUSegmentedViewController
25. $ pod lib docstats
26. $ pod lib testing
27. $ pod lib coverage
28. $ pod keys set AccessToken 0xFFFFFFFF
29. $ pod package ContentfulDeliveryAPI.podspec
30. $ pod roulette
31. HOW TO BUILD YOUR OWN PLUGIN
32. $ pod plugins create cocoapods-awesome-plugin
33. $ tree . !"" Gemfile !"" LICENSE.txt !"" README.md !"" Rakefile !"" cocoapods_awesome_plugin.gemspec #"" lib !"" cocoapods_awesome_plugin.rb !"" cocoapods_plugin.rb #"" pod #"" command #"" plugin.rb 3 directories, 8 files
34. module Pod class Command class Plugin < Command self.summary = "Short description." self.arguments = [CLAide::Argument.new('NAME', true)] def initialize(argv) @name = argv.shift_argument super end def validate! super help! "A Pod name is required." unless @name end def run UI.puts "Add your implementation here" end
35. HOOKS
36. Pod::HooksManager.register(:post_install) do |options| require 'installer' UI.puts "This gets executed after installation" end
38. WHAT? ▸ Package a Pod as a static framework ▸ Including dependencies ▸ All supported platforms ▸ Generate a corresponding podspec
39. $ pod package AFNetworking.podspec
40. LET'S GET STARTED
41. $ pod plugins create cocoapods-packager
42. TEMPLATE ▸ Just a Git repo, similar to the pod template ▸ Reads as much from the environment as possible ▸ Result is installable, shippable
43. DEFINE THE COMMAND module Pod class Command class Package < Command self.summary = 'Package a podspec into a static library.' self.arguments = [['NAME', :required]] [...] end end end
44. PARSE THE SPEC def spec_with_path(path) if !path.nil? && Pathname.new(path).exist? @path = path Specification.from_file(path) end end
45. RUN def run if @spec builder = SpecBuilder.new(@spec) newspec = builder.spec_metadata @spec.available_platforms.each do |platform| build_in_sandbox(platform) newspec += builder.spec_platform(platform) end newspec += builder.spec_close File.open(@spec.name + '.podspec', 'w') { |file| file.write(newspec) } else help! 'Unable to find a podspec with path or name.' end end
46. FRAGMENT OF SPECGENERATOR s.#{platform.name}.platform = :#{platform.symbolic_name}, '#{platform.deployment_target}' s.#{platform.name}.preserve_paths = '#{fwk_base}' s.#{platform.name}.public_header_files = '#{fwk_base}/Versions/A/Headers/*.h' s.#{platform.name}.vendored_frameworks = '#{fwk_base}'
47. BUILD FOR A SPECIFIC PLATFORM def build_in_sandbox(platform) config.sandbox_root = 'Pods' config.integrate_targets = false config.skip_repo_update = true sandbox = install_pod(platform.name) UI.puts 'Building framework' xcodebuild versions_path, headers_path = create_framework_tree(platform.name.to_s) `cp #{sandbox.public_headers.root}/#{@spec.name}/*.h #{headers_path}` Pathname.new(config.sandbox_root).rmtree Pathname.new('Podfile.lock').delete end
48. INSTALL FROM GENERATED PODFILE def install_pod(platform_name) podfile = podfile_from_spec(platform_name, @spec.deployment_target(platform_name)) sandbox = Sandbox.new(config.sandbox_root) installer = Installer.new(sandbox, podfile) installer.install! sandbox end
49. GENERATE THAT PODFILE def podfile_from_spec(platform_name, deployment_target) name = @spec.name path = @path podfile = Pod::Podfile.new do platform(platform_name, deployment_target) if path pod name, :podspec => path else pod name, :path => '.' end end podfile end
50. $ rake install
51. $ pod package AFNetworking.podspec
52. ▸ Push your repo to GH ▸ Release as Ruby Gem ▸ Send a PR to the cocoapods.org repo
53. $ git push $ rake release $ gem install cocoapods-packager
54. !
55. IMPROVING YOUR WORKFLOW
56. THE CONTENTFUL.OBJC MAKEFILE WORKSPACE=ContentfulSDK.xcworkspace .PHONY: all clean doc example example-static pod really-clean static-lib test clean: rm -rf build Examples/UFO/build Examples/*.zip really-clean: clean rm -rf Pods $(HOME)/Library/Developer/Xcode/DerivedData/* all: test example-static pod: pod install example: set -o pipefail && xcodebuild -workspace $(WORKSPACE) \ -scheme ContentfulDeliveryAPI \ -sdk iphonesimulator | xcpretty -c set -o pipefail && xcodebuild -workspace $(WORKSPACE) \ -scheme 'UFO Example' \ -sdk iphonesimulator | xcpretty -c example-static: static-lib cd Examples/UFO; set -o pipefail && xcodebuild \ -sdk iphonesimulator | xcpretty -c static-lib: @sed -i '' -e 's/GCC_GENERATE_TEST_COVERAGE_FILES = YES/GCC_GENERATE_TEST_COVERAGE_FILES = NO/g' ContentfulSDK.xcodeproj/project.pbxproj @sed -i '' -e 's/GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = YES/GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = NO/g' ContentfulSDK.xcodeproj/project.pbxproj set -o pipefail && xcodebuild VALID_ARCHS='i386 x86_64 armv7 armv7s arm64' -workspace $(WORKSPACE) \ -scheme Pods-ContentfulDeliveryAPI \ -sdk iphonesimulator | xcpretty -c set -o pipefail && xcodebuild VALID_ARCHS='i386 x86_64 armv7 armv7s arm64' -workspace $(WORKSPACE) \ -scheme 'Static Framework' | xcpretty -c @cd Examples/UFO/Distribution; ./update.sh cd Examples; ./ship_it.sh @sed -i '' -e 's/GCC_GENERATE_TEST_COVERAGE_FILES = NO/GCC_GENERATE_TEST_COVERAGE_FILES = YES/g' ContentfulSDK.xcodeproj/project.pbxproj @sed -i '' -e 's/GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = NO/GCC_INSTRUMENT_PROGRAM_FLOW_ARCS = YES/g' ContentfulSDK.xcodeproj/project.pbxproj test: example set -o pipefail && xcodebuild -workspace $(WORKSPACE) \ -scheme ContentfulDeliveryAPI \ -sdk iphonesimulator -destination 'name=iPhone Retina (4-inch)' \ test | xcpretty -c doc: appledoc --project-name 'Contentful Delivery API' \ --project-version 1.0 \ --project-company 'Contentful GmbH' \ --company-id com.contentful \ --output ./doc \ --create-html \ --no-create-docset \ --no-install-docset \ --no-publish-docset \ --no-keep-intermediate-files \ --no-keep-undocumented-objects \ --no-keep-undocumented-members \ --merge-categories \ --warn-missing-output-path \ --warn-missing-company-id \ --warn-undocumented-object \ --warn-undocumented-member \ --warn-empty-description \ --warn-unknown-directive \ --warn-invalid-crossref \ --warn-missing-arg \ --logformat 1 \ --verbose 2 ./Code
57. THE CONTENTFUL-MANAGEMENT.OBJC MAKEFILE
58. ▸ cocoapods-testing ▸ cocoapods-coverage ▸ cocoapods-packager ▸ cocoapods-docstats ▸ ...
59. THANK YOU!
60. SWIFT FUNTIME
62. LINKS ▸ http://www.objc.io/issue-6/cocoapods-under-the-hood.html ▸ http://guides.cocoapods.org ▸ https://github.com/CocoaPods/Rainforest
63. ▸ http://buegling.com/talks ▸ @NeoNacho ▸ boris@contentful.com
64. MINI STATE OF THE UNION
65. 0.34 ▸ Dependencies per build configuration ▸ Private spec repositories ▸ Faster downloads ▸ Reorganisation of the Pods directory ▸ Foundation work
66. DETERMINISTIC PODFILE source 'https://github.com/CocoaPods/Specs' source 'https://github.com/Organization/Specs'
67. DO NOT USE PODS_ROOT
68. 0.34.2
69. SWIFT PODS SUPPORT IS COMING ▸ there are no Swift static libraries ▸ CocoaPods needs to support frameworks ▸ You can use existing Pods in your Swift apps just fine
70. @MRACKWITZ