cocoapods-precompile 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f5662367c1b4c3744285ba48862a33a411a9493
+  data.tar.gz: ea7906382f28b789e658fa3d7305fc0c8196e553
+SHA512:
+  metadata.gz: b854a293a523da0bf8c58758ffbbd81b7bdcfcc3c3430d891ec6fbee272dfa4d5d1f6b5cef370e0d8781c343a01f51adc60ceb68ed8a321a429907ff74878efd
+  data.tar.gz: e8d667141d30e59794471b5615330419f9f224ea0a6230831a14c9b152a6b83d15ab8d653f6ff02a3584e8cfe3011aec00a20099bfdb9cdc41d5db57765f2f83

data/.gitignore

@@ -0,0 +1,32 @@
+.DS_Store
+pkg
+.idea/
+
+test/Pods
+
+## Various settings
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+xcuserdata/
+
+## Other
+*.moved-aside
+*.xccheckout
+*.xcscmblueprint
+
+### Xcode Patch ###
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcworkspace/contents.xcworkspacedata
+/*.gcno
+test/Binary.xcworkspace/contents.xcworkspacedata
+test/Binary.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
+test/Podfile
+test/Podfile.lock

data/.travis.yml

@@ -0,0 +1,23 @@
+osx_image: xcode9.3
+language: objective-c
+cache:
+- cocoapods
+- bundler
+before_install:
+- gem install cocoapods
+script:
+- rake install
+- cd test
+- sh test.sh
+- cd ..
+
+# auto deploy on tagging
+# automatically set by `travis setup rubygems`
+deploy:
+  provider: rubygems
+  api_key:
+    secure: HglQwElI8cEeKc5oXzoVbBBprgb8k7RUr0YOH1N1fhpNW7HJpJtSLzUBPC5T+Sv5RPSicaxY/oXeYE6x4E7Oadf7Gy2tmM9iwwJQh6YgZ/foh9G9obHZtTerhB4wY2cjguBXDmLqiMRiJzNTZRvoUnESBKakPbK/ODY0mHT+LDdMwZk2QsMjD3fRc5M7JRR29jr56jzVuUdy0lR4TRoc2+yIRqp2vFNtcbKdzKuYgzcdE9xzPh0FQzgiImA5uGDruyAgoNeOlGxDPZdnm7fw/epLmq8fUIZanReI30QnJeIErFwMCVeN1zVqQiWRgv8qGi8Z0ZKOzvcu7oKuaeXo5xSkTfkAc9I0LbcRd3UHCluAr9JHuERNwkn1qx5W0DdngTKrPM65ZABQxk4KUHt+5yd6Dv7lR9GrGD3teNZDga/X8u0tQIkoPIl76ZjXRh0bmCDQM/zWaTKkh7eX/YXQKgrjrEecZMeZfsLds789MK2QO17QlbHTVno+HBr0Rah6nHI0/vl1xqHthHCb/Y9SBXmLQ7+ySNXmj7YxPjpD6m8kEEUDTQQdgjS7vMInqJiSekGBImu2VQA/qZP1+WEBha5nX2ADfvsAWfUdsdQfuTbv07RnIG+3quzSl5U1UPVR9f7EsqpTtxflLJCqVdaz2ndQBO6NXAnRhA90cfAFd9s=
+  gem: cocoapods-binary
+  on:
+    tags: true
+    repo: leavez/cocoapods-binary

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-binary.gemspec
+gemspec
+
+group :development do
+  gem 'cocoapods'
+
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 leavez <gaojiji@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+
+<p align="center"><img src="/test/logo.png" width="622"></p>
+
+[![Build Status](https://travis-ci.org/leavez/cocoapods-binary.svg?branch=master)](https://travis-ci.org/leavez/cocoapods-binary)
+
+A CocoaPods plugin to integrate pods in form of prebuilt frameworks, not source code, by adding **just one flag** in podfile. Speed up compiling dramatically.
+
+## Why
+
+You may wonder why CocoaPods doesn't have a function to integrate libs in form of binaries, if there are dozens or hundreds of pods in your podfile and compile them for a great many times meaninglessly. Too many source code of libs slow down your compile and the response of IDE (e.g. code completion), and then reduce work efficiency, leaving us time to think about the meaning of life.
+
+This plugin implements this simple wish. Replace the source code in pod target with prebuilt frameworks.
+
+Why don't use Carthage? While Carthage also integrates libs in form of frameworks, there several reasons to use CocoaPods with this plugin:
+
+- Pod is a good simple form to organize files, manage dependencies. (private or local pods)
+- Fast switch between source code and binary, or partial source code, partial binaries.
+- Some libs don't support Carthage.
+
+## How it works
+
+It will compile the source code of pods during the pod install process, and make CocoaPods use them. Which pod should be compiled is controlled by the flag in Podfile.
+
+#### Under the hood
+
+( You could leave this paragraph for further reading, and try it now. )
+
+The plugin will do a separated completed 'Pod install' in the standard pre-install hook. But we filter the pods by the flag in Podfile here. Then build frameworks with this generated project by using xcodebuild. Store the frameworks in `Pods/_Prebuild` and save the manifest.lock file for the next pod install.
+
+Then in the flowing normal install process, we hook the integration functions to modify pod specification to using our frameworks.
+
+## Installation
+
+    $ gem install cocoapods-binary
+
+## Usage
+
+``` ruby
+plugin 'cocoapods-binary'
+
+use_frameworks!
+# all_binary!
+
+target "HP" do
+    pod "ExpectoPatronum", :binary => true
+end
+```
+
+- Add `plugin 'cocoapods-binary'` in the head of Podfile 
+- Add `:binary => true` as a option of one specific pod, or add `all_binary!` before all targets, which makes all pods binaries.
+- pod install, and that's all
+
+**Note**: cocoapods-binary require `use_frameworks!`. If your worry about the boot time and other problems introduced by dynamic framework, static framework is a good choice. Another [plugin](https://github.com/leavez/cocoapods-static-swift-framework) made by me to make all pods static frameworks is recommended.
+
+#### Options
+
+If you want to disable binary for a specific pod when using `all_binary!`, place a `:binary => false` to it.
+
+If your `Pods` folder is excluded from git, you may add `keep_source_code_for_prebuilt_frameworks!` in the head of Podfile to speed up pod install, as it won't download all the sources every time prebuilt pods have changes.
+
+If bitcode is needed, add a `enable_bitcode_for_prebuilt_frameworks!` before all targets in Podfile
+
+
+#### Known Issues
+
+- doesn't support watchos now
+- dSYM files is missing for dynamic frameworks using this plugin. Walkaround: Don't use this plugin for a release build. Add a if condition with ENV around `plugin 'cocoapods-binary'`
+
+## License
+
+MIT
+
+Appreciate a 🌟 if you like it. 
+
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+desc 'Runs all the specs'
+task :specs do
+  sh "bundle exec bacon #{specs('**')}"
+end
+
+task :default => :specs
+

data/cocoapods-precompile.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-binary/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-precompile'
+  spec.version       = CocoapodsPrecompile::VERSION
+  spec.authors       = ['iiiCeBlink']
+  spec.email         = ['zakariyyasv@gmail.com']
+  spec.description   = %q{integrate pods in form of prebuilt frameworks conveniently, reducing compile time}
+  spec.summary       = %q{A CocoaPods plugin to integrate pods in form of prebuilt frameworks, not source code, by adding just one flag in podfile. Speed up compiling dramatically.}
+  spec.homepage      = 'https://github.com/iiiCeBlink/cocoapods-binary'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/).reject{|f| f.start_with? "test/"}
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "cocoapods", ">= 1.4.0", "< 2.0"
+  spec.add_dependency "fourflusher", "~> 2.0"
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cocoapods-binary/Integration.rb

@@ -0,0 +1,266 @@
+require_relative 'helper/podfile_options'
+require_relative 'helper/feature_switches'
+require_relative 'helper/prebuild_sandbox'
+require_relative 'helper/passer'
+require_relative 'helper/names'
+
+
+
+# NOTE:
+# This file will only be loaded on normal pod install step
+# so there's no need to check is_prebuild_stage
+
+
+
+# Provide a special "download" process for prebuilded pods.
+#
+# As the frameworks is already exsited in local folder. We
+# just create a symlink to the original target folder.
+#
+module Pod
+    class Installer
+        class PodSourceInstaller
+
+            def install_for_prebuild!(standard_sanbox)
+                return if standard_sanbox.local? self.name
+
+                # make a symlink to target folder
+                prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sanbox)
+                # if spec used in multiple platforms, it may return multiple paths
+                target_names = prebuild_sandbox.existed_target_names_for_pod_name(self.name)
+                
+                def walk(path, &action)
+                    path.children.each do |child|
+                        result = action.call(child, &action)
+                        if child.directory?
+                            walk(child, &action) if result
+                        end
+                    end
+                end
+                def make_link(source, target)
+                    source = Pathname.new(source)
+                    target = Pathname.new(target)
+                    target.parent.mkpath unless target.parent.exist?
+                    relative_source = source.relative_path_from(target.parent)
+                    FileUtils.ln_sf(relative_source, target)
+                end
+                def mirror_with_symlink(source, basefolder, target_folder)
+                    target = target_folder + source.relative_path_from(basefolder)
+                    make_link(source, target)
+                end
+                
+                target_names.each do |name|
+
+                    # symbol link copy all substructure
+                    real_file_folder = prebuild_sandbox.framework_folder_path_for_target_name(name)
+                    
+                    # If have only one platform, just place int the root folder of this pod.
+                    # If have multiple paths, we use a sperated folder to store different
+                    # platform frameworks. e.g. AFNetworking/AFNetworking-iOS/AFNetworking.framework
+                    
+                    target_folder = standard_sanbox.pod_dir(self.name)
+                    if target_names.count > 1 
+                        target_folder += real_file_folder.basename
+                    end
+                    target_folder.rmtree if target_folder.exist?
+                    target_folder.mkpath
+
+
+                    walk(real_file_folder) do |child|
+                        source = child
+                        # only make symlink to file and `.framework` folder
+                        if child.directory? and child.extname == ".framework"
+                            mirror_with_symlink(source, real_file_folder, target_folder)
+                            next false  # return false means don't go deeper
+                        elsif child.file?
+                            mirror_with_symlink(source, real_file_folder, target_folder)
+                            next true
+                        else
+                            next true
+                        end
+                    end
+
+
+                    # symbol link copy resource for static framework
+                    hash = Prebuild::Passer.resources_to_copy_for_static_framework || {}
+                    
+                    path_objects = hash[name]
+                    if path_objects != nil
+                        path_objects.each do |object|
+                            make_link(object.real_file_path, object.target_file_path)
+                        end
+                    end
+                end # of for each 
+
+            end # of method
+
+        end
+    end
+end
+
+
+# Let cocoapods use the prebuild framework files in install process.
+#
+# the code only effect the second pod install process.
+#
+module Pod
+    class Installer
+
+
+        # Remove the old target files if prebuild frameworks changed
+        def remove_target_files_if_needed
+
+            changes = Pod::Prebuild::Passer.prebuild_pods_changes
+            updated_names = []
+            if changes == nil
+                updated_names = PrebuildSandbox.from_standard_sandbox(self.sandbox).exsited_framework_pod_names
+            else
+                added = changes.added
+                changed = changes.changed 
+                deleted = changes.deleted 
+                updated_names = added + changed + deleted
+            end
+
+            updated_names.each do |name|
+                root_name = Specification.root_name(name)
+                next if self.sandbox.local?(root_name)
+
+                # delete the cached files
+                target_path = self.sandbox.pod_dir(root_name)
+                target_path.rmtree if target_path.exist?
+
+                support_path = sandbox.target_support_files_dir(root_name)
+                support_path.rmtree if support_path.exist?
+            end
+
+        end
+
+
+        # Modify specification to use only the prebuild framework after analyzing
+        old_method2 = instance_method(:resolve_dependencies)
+        define_method(:resolve_dependencies) do
+
+            # Remove the old target files, else it will not notice file changes
+            self.remove_target_files_if_needed
+
+            # call original
+            old_method2.bind(self).()
+            # ...
+            # ...
+            # ...
+            # after finishing the very complex orginal function
+
+
+            # check
+            self.validate_every_pod_only_have_one_form
+
+            
+            # prepare
+            cache = []
+
+            def add_vendered_framework(spec, platform, added_framework_file_path)
+                if spec.attributes_hash[platform] == nil
+                    spec.attributes_hash[platform] = {}
+                end
+                vendored_frameworks = spec.attributes_hash[platform]["vendored_frameworks"] || []
+                vendored_frameworks = [vendored_frameworks] if vendored_frameworks.kind_of?(String)
+                vendored_frameworks += [added_framework_file_path]
+                spec.attributes_hash[platform]["vendored_frameworks"] = vendored_frameworks
+            end
+            def empty_source_files(spec)
+                spec.attributes_hash["source_files"] = []
+                ["ios", "watchos", "tvos", "osx"].each do |plat|
+                    if spec.attributes_hash[plat] != nil
+                        spec.attributes_hash[plat]["source_files"] = []
+                    end
+                end
+            end
+
+            specs = self.analysis_result.specifications
+            prebuilt_specs = (specs.select do |spec|
+                self.prebuild_pod_names.include? spec.root.name
+            end)
+
+            prebuilt_specs.each do |spec|
+
+                # Use the prebuild framworks as vendered frameworks
+                # get_corresponding_targets
+                targets = Pod.fast_get_targets_for_pod_name(spec.root.name, self.pod_targets, cache)
+                targets.each do |target|
+                    # the framework_file_path rule is decided when `install_for_prebuild`,
+                    # as to compitable with older version and be less wordy.
+                    framework_file_path = target.framework_name
+                    framework_file_path = target.name + "/" + framework_file_path if targets.count > 1
+                    add_vendered_framework(spec, target.platform.name.to_s, framework_file_path)
+                end
+                # Clean the source files
+                # we just add the prebuilt framework to specific platform and set no source files 
+                # for all platform, so it doesn't support the sence that 'a pod perbuild for one
+                # platform and not for another platform.'
+                empty_source_files(spec)
+
+                # to avoid the warning of missing license
+                spec.attributes_hash["license"] = {} 
+            end
+
+        end
+
+
+        # Override the download step to skip download and prepare file in target folder
+        old_method = instance_method(:install_source_of_pod)
+        define_method(:install_source_of_pod) do |pod_name|
+
+            # copy from original
+            pod_installer = create_pod_installer(pod_name)
+            # \copy from original
+
+            if self.prebuild_pod_names.include? pod_name
+                pod_installer.install_for_prebuild!(self.sandbox)
+            else
+                pod_installer.install!
+            end
+
+            # copy from original
+            @installed_specs.concat(pod_installer.specs_by_platform.values.flatten.uniq)
+            # \copy from original
+        end
+
+
+    end
+end
+
+# A fix in embeded frameworks script.
+#
+# The framework file in pod target folder is a symblink. The EmbedFrameworksScript use `readlink`
+# to read the read path. As the symlink is a relative symlink, readlink cannot handle it well. So 
+# we override the `readlink` to a fixed version.
+#
+module Pod
+    module Generator
+        class EmbedFrameworksScript
+
+            old_method = instance_method(:script)
+            define_method(:script) do
+
+                script = old_method.bind(self).()
+                patch = <<-SH.strip_heredoc
+                    #!/bin/sh
+                
+                    # ---- this is added by cocoapods-binary ---
+                    # Readlink cannot handle relative symlink well, so we override it to a new one
+                    # If the path isn't an absolute path, we add a realtive prefix.
+                    readlink () {
+                        path=`/usr/bin/readlink $1`;
+                        if [ $(echo "$path" | cut -c 1-1) = '/' ]; then
+                            echo $path;
+                        else
+                            echo "`dirname $1`/$path";
+                        fi
+                    }
+                    # --- 
+                SH
+                patch + script
+            end
+        end
+    end
+end