cocoapods-amimono 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c802deb44fc7227e5a1ca4f4fb266f7ff51d06bc
-  data.tar.gz: fb88a7712cd35bf6f3fc1b468f682e45c0b9e07e
+  metadata.gz: 7a607ef5c8f40f9e3573b195af6e60a5e0467054
+  data.tar.gz: 8da7473fed96d2e25e069b70c6228a1c6fc3ac05
 SHA512:
-  metadata.gz: 96f17037f27c9f6fac1c0d7594eb78f1aa0d03b68c9a2dc2ce88d5651581e45ffa60dda7ffdbf4a28ddf23c11cc1d0ff5c1fb7c29b077b3bab3e2491051d9b62
-  data.tar.gz: aca7d993ad1c6b6cd26cf629f6d0f49550c33543143fe2a8822d93a353cb121942554aeb633aa778e991348867d2f2f6cd888ee7a985a8ed9997aa1662241e4a
+  metadata.gz: 93182f0c82f6a5cf9ab1f587f3ca5fceeaa90f58a3b76c78939bc95d685f5d0d0e92e89dc6c281ae37588a4a573e61f8767491ede509a7f3b269c43aad0bb65f
+  data.tar.gz: 13feccb0c3b83750b6a05c63f6fa2858f1f8de236b9ededca0e305523a16e187ba7a0480e2b64ab1c9fd79ab1b8a5c000b9dc66777665956ea174f6738d7c953

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-amimono (0.0.1)
+    cocoapods-amimono (0.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,11 +1,60 @@
 # cocoapods-amimono
 
+<p align="center">
+  <img src="https://dl.dropboxusercontent.com/u/12352209/GitHub/amimono.gif" alt="amimono"/>
+</p>
+
 Move all dynamic frameworks symbols into the main executable.
 
+## Why would you want this plugin in your Podfile?
+
+Apple introduced dynamic linking on iOS 8 alongside with Swift. Shortly after, this was adopted by CocoaPods as a requirement to use Pods that contain Swift, because Xcode can't use static libraries with Swift.
+
+On iOS 9.1, a dyld crash affected the vast majority of apps that used a high number of dynamic frameworks. You can learn more about the issue on [artsy/eigen#1246](https://github.com/artsy/eigen/issues/1246). Although the issue was fixed on iOS 9.3.2, it was clear that having a high number of dynamic frameworks was not a good idea. During WWDC 2016, someone asked what would be the optimal number of dynamic frameworks on an iOS application and we got the following response:
+
+> Apple advises to use about half a dozen dynamic frameworks in an app. Hard to achieve with external & internal deps.
+> -- from [Twitter](https://twitter.com/arekholko/status/743135179514978304)
+
+This is hardly an option for some. If you think you might be in that group, then continue reading.
+
+## What is this plugin doing?
+
+This plugin is based on [dyld-image-loading-performance](https://github.com/stepanhruda/dyld-image-loading-performance). In a nutshell, it copies all symbols of your CocoaPods dependencies into your main app executable, so the dynamic linker doesn't have to load the frameworks. You can verify this yourself by enabling
+
+![log_setting_xcode.png](https://dl.dropboxusercontent.com/u/12352209/GitHub/log_setting_xcode.png)
+
+and looking at the log output you shouldn't find any `dlopen` call of your CocoaPods frameworks.
+
+## Limitations
+
+Currently this plugin has the following limitations:
+
+* You will have modify your `post_install` hook. This is necessary because the CocoaPods plugin API currently doesn't offer everything that the gem needs.
+* Only dependencies compiled from source will work. This means dependencies with bundled binaries (like vendored static frameworks) won't work. You will have to add these manually to your Xcode project.
+
 ## Installation
 
-    $ gem install cocoapods-amimono
+```bash
+gem install cocoapods-amimono
+````
 
 ## Usage
 
-    $ plugin 'cocoapods-amimono'
+Add the following to your Podfile:
+
+```ruby
+plugin 'cocoapods-amimono'
+```
+
+Add the following to your `post_install` hook:
+
+```ruby
+post_install do |installer|
+  require 'cocoapods-amimono/patcher'
+  Amimono::Patcher.patch_copy_resources_script(installer: installer)
+  ...
+```
+
+## Example project
+
+[Here](https://github.com/Ruenzuo/cocoapods-amimono-example).

data/lib/cocoapods-amimono/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsAmimono
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/cocoapods-amimono/integrator.rb

@@ -1,9 +1,33 @@
 module Amimono
   class Integrator
 
+    FILELIST_SCRIPT = <<-SCRIPT.strip_heredoc
+          #!/usr/bin/ruby
+          intermediates_directory = ENV['OBJROOT']
+          configuration = ENV['CONFIGURATION']
+          platform = ENV['EFFECTIVE_PLATFORM_NAME']
+          archs = ENV['ARCHS']
+          target_name = ENV['TARGET_NAME']
+
+          archs.split(" ").each do |architecture|
+            Dir.chdir("\#{intermediates_directory}/Pods.build") do
+              filelist = ""
+              %s.each do |dependency|
+                Dir.glob("\#{configuration}\#{platform}/\#{dependency}.build/Objects-normal/\#{architecture}/*.o") do |object_file|
+                  next if ["Pods-\#{target_name}-dummy", "Pods_\#{target_name}_vers"].any? { |dummy_object| object_file.include? dummy_object }
+                  filelist += File.absolute_path(object_file) + "\\n"
+                end
+              end
+              File.write("\#{configuration}\#{platform}-\#{architecture}.objects.filelist", filelist)
+            end
+          end
+        SCRIPT
+
+    AMIMONO_FILELIST_BUILD_PHASE = '[Amimono] Create filelist per architecture'
+
     def update_xcconfigs(aggregated_target_sandbox_path:)
       path = aggregated_target_sandbox_path
-      archs = ['armv7', 'arm64', 'i386', 'x86_64']
+      archs = ['armv7', 'armv7s', 'arm64', 'i386', 'x86_64']
       # Find all xcconfigs for the aggregated target
       Dir.entries(path).select { |entry| entry.end_with? 'xcconfig' }.each do |entry|
         full_path = path + entry
@@ -21,38 +45,34 @@ module Amimono
 
     def update_build_phases(aggregated_target:)
       user_project = aggregated_target.user_project
-      # Remove the `Embed Pods Frameworks` build phase
       application_target = user_project.targets.find { |target| target.product_type.end_with? 'application' }
-      embed_pods_frameworks_build_phase = application_target.build_phases.find { |build_phase| build_phase.display_name.eql? '[CP] Embed Pods Frameworks' }
-      embed_pods_frameworks_build_phase.remove_from_project
-      # Check if [Amimono] phase already exist
-      amimono_build_phase = application_target.build_phases.find { |build_phase| build_phase.display_name.include? '[Amimono]' }
+      # Remove the `Embed Pods Frameworks` build phase
+      remove_embed_pods_frameworks(application_target: application_target)
+      # Create or update [Amimono] build phase
+      create_or_update_amimono_phase(application_target: application_target, phase_name: AMIMONO_FILELIST_BUILD_PHASE, script: generate_filelist_script(aggregated_target: aggregated_target))
       user_project.save
-      return unless amimono_build_phase.nil?
-      # Add new shell
-      shell_build_phase = application_target.new_shell_script_build_phase '[Amimono] Create filelist per architecture'
-      application_target.build_phases.insert(1, shell_build_phase)
+    end
+
+    private
+
+    def remove_embed_pods_frameworks(application_target:)
+      embed_pods_frameworks_build_phase = application_target.build_phases.find { |build_phase| build_phase.display_name.include? 'Embed Pods Frameworks' }
+      return if embed_pods_frameworks_build_phase.nil?
+      embed_pods_frameworks_build_phase.remove_from_project
+    end
+
+    def create_or_update_amimono_phase(application_target:, phase_name:, script:)
+      amimono_filelist_build_phase = application_target.build_phases.find { |build_phase| build_phase.display_name.include? phase_name } || application_target.new_shell_script_build_phase(phase_name)
+      amimono_filelist_build_phase.shell_path = '/usr/bin/ruby'
+      amimono_filelist_build_phase.shell_script = script
+      application_target.build_phases.insert(1, amimono_filelist_build_phase)
       application_target.build_phases.uniq!
-      shell_build_phase.shell_path = '/usr/bin/ruby'
-      shell_build_phase.shell_script = <<-SCRIPT.strip_heredoc
-        #!/usr/bin/ruby
-        intermediates_directory = ENV['OBJROOT']
-        configuration = ENV['CONFIGURATION']
-        platform = ENV['EFFECTIVE_PLATFORM_NAME']
-        archs = ENV['ARCHS']
-
-        archs.split(" ").each do |architecture|
-          Dir.chdir("\#{intermediates_directory}/Pods.build") do
-            filelist = ""
-            Dir.glob("\#{configuration}\#{platform}/*.build/Objects-normal/\#{architecture}/*.o") do |object_file|
-              filelist += File.absolute_path(object_file) + "\\n"
-            end
-            File.write("\#{configuration}\#{platform}-\#{architecture}.objects.filelist", filelist)
-          end
-        end
-      SCRIPT
-      user_project.save
     end
 
+    def generate_filelist_script(aggregated_target:)
+      dependencies = aggregated_target.specs.map(&:name).reject { |dependency| dependency.include? '/'}
+      puts "[Amimono] #{dependencies.count} dependencies found"
+      FILELIST_SCRIPT % dependencies.to_s
+    end
   end
 end

data/lib/cocoapods-amimono/patcher.rb

@@ -0,0 +1,41 @@
+module Amimono
+  # This class will patch your project's copy resources script to match the one that would be
+  # generated as if the `use_frameworks!` flag wouldn't be there
+  class Patcher
+    def self.patch_copy_resources_script(installer:)!
+      aggregated_target = installer.aggregate_targets.first
+      project = installer.sandbox.project
+      path = aggregated_target.copy_resources_script_path
+      resources = resources_by_config(aggregated_target: aggregated_target, project: project)
+      generator = Pod::Generator::CopyResourcesScript.new(resources, aggregated_target.platform)
+      generator.save_as(path)
+      puts "[Amimono] Copy resources script patched"
+    end
+
+    private
+
+    # Copied over from https://github.com/CocoaPods/CocoaPods/blob/master/lib/cocoapods/installer/xcode/pods_project_generator/aggregate_target_installer.rb#L115-L131
+    # with some modifications to this particular use case
+    def self.resources_by_config(aggregated_target:, project:)
+      library_targets = aggregated_target.pod_targets.reject do |pod_target|
+        # This reject doesn't matter much anymore. We have to process all targets because
+        # every single one requires frameworks and this workaround doesn't work with Pods
+        # that contains binaries
+        !pod_target.should_build?
+      end
+      aggregated_target.user_build_configurations.keys.each_with_object({}) do |config, resources_by_config|
+        resources_by_config[config] = library_targets.flat_map do |library_target|
+          next [] unless library_target.include_in_build_config?(aggregated_target.target_definition, config)
+          resource_paths = library_target.file_accessors.flat_map do |accessor|
+            accessor.resources.flat_map { |res| res.relative_path_from(project.path.dirname) }
+          end
+          resource_bundles = library_target.file_accessors.flat_map do |accessor|
+            accessor.resource_bundles.keys.map { |name| "#{library_target.configuration_build_dir}/#{name.shellescape}.bundle" }
+          end
+          # The `bridge_support_file` has been removed from this part
+          (resource_paths + resource_bundles).uniq
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods_plugin.rb

@@ -3,6 +3,9 @@ require 'cocoapods-amimono/integrator'
 
 Pod::HooksManager.register('cocoapods-amimono', :post_install) do |installer_context|
   # Find the aggregated target
+  # This is probably wrong, all agregated targets are prefixed by 'Pods-'
+  # but this works for now because find will return the first one
+  # which is usually the app target
   pods_target = installer_context.umbrella_targets.find do |target|
     target.cocoapods_target_label.include? 'Pods'
   end
@@ -12,5 +15,7 @@ Pod::HooksManager.register('cocoapods-amimono', :post_install) do |installer_con
 
   integrator = Amimono::Integrator.new
   integrator.update_xcconfigs(aggregated_target_sandbox_path: path)
+  puts "[Amimono] xcconfigs updated with filelist"
   integrator.update_build_phases(aggregated_target: pods_target)
+  puts "[Amimono] Build phases updated"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-amimono
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Renzo Crisostomo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-31 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ files:
 - lib/cocoapods-amimono/command/amimono.rb
 - lib/cocoapods-amimono/gem_version.rb
 - lib/cocoapods-amimono/integrator.rb
+- lib/cocoapods-amimono/patcher.rb
 - lib/cocoapods_plugin.rb
 - spec/command/amimono_spec.rb
 - spec/spec_helper.rb