cocoapods-binary-matchup 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22d50ce597d1eddea065b2472fea259fe5a063a304638f56781a6eb740a3368b
-  data.tar.gz: dae5536d6035f67546136f12ffe1fc52d602bdffc8dd5eeba120fec2313c4cd7
+  metadata.gz: ef4ec458a15107993da7504bba8fe4efb967cc17b5a6c1071c398baf00909a94
+  data.tar.gz: 560eed7893ffa1943dead01c79a0895554ed69aa3b28335a79cb107fd2ffc555
 SHA512:
-  metadata.gz: 2ef8031c70e49c8f815594f8e4222a425b823b74cfd76c7d2f850398c7d8b52a174f102094eac7cb126976030d53ab233c9361bb55e04761f948d3a5f1a777a9
-  data.tar.gz: 8cf8d948c812075b068479e25737a0d43999831f2dea87a018d6d62fe8c1049d96bb27076f88173ed91d4bd4ae1939669d768402ee9e8ce8e5c215c14014d909
+  metadata.gz: 3bcbce4a8e58f5dd65096887e7a192a97eb906c1f53e57700ccfe54636db507440d13310f3f6f7f52e0ab78d4541238b1c3a0ee65c0d185e544b173d7252c45d
+  data.tar.gz: '09f215849f244b80f884d7093488a72d50b4988af5d96844466507db75f8da6041f02c32649accf8528c1ccda92390db43eb6c418bfbbdb68c550694adfdc56e'

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: rubygems_36250bc5acbeefaa1a7985a22146376d17725f0583417826
+  gem: cocoapods-binary-matchup
+  on:
+    tags: true
+    repo: omiapp/cocoapods-binary-matchup

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-binary-matchup.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,74 @@
+# cocoapods-binary
+
+[![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-binary-matchup.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-binary-matchup/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-binary-matchup'
+  spec.version       = CocoapodsBinary::VERSION
+  spec.authors       = ['leavez']
+  spec.email         = ['gaojiji@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/omiapp/cocoapod_binary_matchup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/).reject{|f| f.start_with?("test/") || f.start_with?('demo/')}
+  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.5.0", "< 2.0"
+  spec.add_dependency "fourflusher", "~> 2.0"
+  spec.add_dependency "xcpretty", "~> 0.3.0"
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cocoapods-binary-matchup/Integration.rb

@@ -0,0 +1,293 @@
+require_relative 'helper/podfile_options'
+require_relative 'helper/feature_switches'
+require_relative 'helper/prebuild_sandbox'
+require_relative 'helper/passer'
+require_relative 'helper/target_checker'
+
+
+# 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.
+#
+require_relative 'Integration_cache'
+
+module Pod
+    class Installer
+        class PodSourceInstaller
+
+            def install_for_prebuild!(standard_sanbox)
+                return if standard_sanbox.local? self.name
+                UI.puts "install_for_prebuild! start: #{self.name}"
+                
+                # 获取pod版本信息
+                pod_version = Pod::PrebuildCache::Cache.get_pod_version(standard_sanbox, self.name)
+                target_folder = standard_sanbox.pod_dir(self.name)
+                target_folder.rmtree if target_folder.exist?
+                
+                # 1. 首先尝试从缓存恢复
+                if Pod::PrebuildCache::Cache.copy_from_cache_if_exists(self.name, pod_version, target_folder.to_s)
+                    UI.puts "📦 Successfully restored #{self.name} (#{pod_version}) from cache"
+                    return
+                end
+                
+                # 2. 如果缓存不存在，从预构建目录拷贝
+                prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sanbox)
+                real_file_folder = prebuild_sandbox.framework_folder_path_for_pod_name(self.name)
+                
+                if real_file_folder.exist?
+                    # 拷贝到pods目录
+                    FileUtils.cp_r(real_file_folder, target_folder, :remove_destination => true)
+                    UI.puts "📦 Copied prebuilt files for #{self.name}: #{real_file_folder} -> #{target_folder}"
+                    
+                    # 3. 同时保存到缓存（如果缓存不存在）
+                    Pod::PrebuildCache::Cache.save_to_cache(self.name, pod_version, target_folder.to_s)
+                else
+                    UI.puts "⚠️  Warning: Prebuilt files not found for #{self.name} at #{real_file_folder}"
+                    # 如果预构建文件不存在，创建空目录避免错误
+                    target_folder.mkpath
+                end
+            end
+
+        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_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)
+                # 只有当不是预构建的pod时才删除，避免删除刚拷贝的预构建文件
+                next if self.prebuild_pod_names.include?(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).()
+
+            # check the pods
+            # Although we have did it in prebuild stage, it's not sufficient.
+            # Same pod may appear in another target in form of source code.
+            Prebuild.check_one_pod_should_have_only_one_target(self.prebuild_pod_targets)
+            UI.puts "🔍 prebuild_pod_names (cached): #{self.prebuild_pod_names}"
+            
+            # FIXED: 在主安装阶段强制重新计算 prebuild_pod_names
+            # 避免使用过期的缓存（可能在 aggregate_targets 初始化前被缓存为空）
+            fresh_prebuild_pod_names = self.refresh_prebuild_pod_names!
+            UI.puts "🔍 prebuild_pod_names (fresh): #{fresh_prebuild_pod_names}"
+
+            #
+            specs = self.analysis_result.specifications
+            prebuilt_specs = (specs.select do |spec|
+                self.prebuild_pod_names.include? spec.root.name
+            end)
+            
+            # make sturcture to fast get target by name
+            name_to_target_hash = self.pod_targets.reduce({}) do |sum, target|
+                sum[target.name] = target
+                sum
+            end
+
+            prebuilt_specs.each do |spec|
+                # `spec` may be a subspec, so we use the root's name 
+                root_name = spec.root.name
+                
+                target = name_to_target_hash[root_name]
+                next if Prebuild::Passer.target_names_to_skip_integration_framework.include? target.pod_name
+
+                # use the prebuilt framework
+                original_vendored_frameworks = spec.attributes_hash["vendored_frameworks"] || []
+                if original_vendored_frameworks.kind_of?(String)
+                    original_vendored_frameworks = [original_vendored_frameworks]
+                end
+                framework_name = target.framework_name
+                if framework_name.kind_of?(Array)
+                    original_vendored_frameworks += framework_name
+                else
+                    # 始终使用Build目录下的路径，因为我们的install_for_prebuild!会复制framework到Build目录
+                    original_vendored_frameworks += [framework_name]
+                end
+                spec.attributes_hash["vendored_frameworks"] = original_vendored_frameworks
+                
+                # 对于静态库类型的pod，需要保留头文件，不能完全清空source_files
+                # 检查是否有vendored_libraries（静态库）
+                vendored_libraries = spec.attributes_hash["vendored_libraries"] || []
+                if vendored_libraries.kind_of?(String)
+                    vendored_libraries = [vendored_libraries]
+                end
+                
+                # 不管是静态库还是动态框架，都需要智能处理source_files
+                # 保留头文件和重要文件，清空.m/.swift等源码文件
+                current_source_files = spec.attributes_hash["source_files"] || []
+                if current_source_files.kind_of?(String)
+                    current_source_files = [current_source_files]
+                end
+                
+                if current_source_files.empty?
+                    # 如果原来就没有source_files，不做处理
+                    spec.attributes_hash["source_files"] = []
+                else
+                    # 智能处理source_files：保留头文件相关模式，清空源码文件模式
+                    header_files = current_source_files.select { |file_pattern| 
+                        pattern = file_pattern.to_s
+                        # 检查是否是头文件相关的模式，使用更精确的正则表达式
+                        pattern.match?(/\*+\.h$/) ||                    # 匹配 "*.h", "**/*.h" 等
+                        pattern.match?(/\*+\.hpp$/) ||                  # 匹配 "*.hpp", "**/*.hpp" 等  
+                        pattern.match?(/\*+\.hh$/) ||                   # 匹配 "*.hh", "**/*.hh" 等
+                        pattern.match?(/\*+\.modulemap$/) ||            # 匹配 "*.modulemap"
+                        pattern.match?(/\/\*\.h$/) ||                   # 匹配 "Sources/*.h" 等
+                        pattern.match?(/\/\*\.hpp$/) ||                 # 匹配 "Sources/*.hpp" 等
+                        pattern.match?(/\/\*\.hh$/) ||                  # 匹配 "Sources/*.hh" 等
+                        pattern.match?(/\/\*\.modulemap$/) ||           # 匹配 "Sources/*.modulemap"
+                        pattern.end_with?('.h', '.hpp', '.hh', '.modulemap') || # 直接的头文件路径
+                        pattern.match?(/\*\*?\/\*$/)                    # 通用通配符保留，如 "Sources/*", "**/*"
+                    }
+                    
+                    # 如果没有找到明确的头文件模式，保留原有的source_files
+                    # 这样可以避免意外删除重要的头文件
+                    if header_files.empty?
+                        spec.attributes_hash["source_files"] = current_source_files
+                    else
+                        UI.puts "📋 #{spec.root.name} header_files: #{header_files}"
+                        spec.attributes_hash["source_files"] = header_files
+                    end
+                end
+
+                # to remove the resurce bundle target. 
+                # When specify the "resource_bundles" in podspec, xcode will generate a bundle 
+                # target after pod install. But the bundle have already built when the prebuit
+                # phase and saved in the framework folder. We will treat it as a normal resource
+                # file.
+                # https://github.com/leavez/cocoapods-binary/issues/29
+                if spec.attributes_hash["resource_bundles"]
+                    bundle_names = spec.attributes_hash["resource_bundles"].keys
+                    spec.attributes_hash["resource_bundles"] = nil 
+                    current_resources = spec.attributes_hash["resources"] || []
+
+                    if current_resources.kind_of?(String)
+                        current_resources = [current_resources]
+                    end
+
+                    current_resources += bundle_names.map{|n| n+".bundle"}
+                    spec.attributes_hash["resources"] = current_resources
+                end
+
+                # 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
+            UI.puts "🔍 Installing pod: #{pod_name}"
+            UI.puts "🔍 prebuild_pod_names: #{self.prebuild_pod_names}"
+            UI.puts "🔍 is_prebuild_pod: #{self.prebuild_pod_names.include?(pod_name)}"
+            
+            if self.prebuild_pod_names.include? pod_name
+                UI.puts "📦 Installing prebuild pod: #{pod_name}"
+                pod_installer.install_for_prebuild!(self.sandbox)
+            else
+                UI.puts "📥 Installing source pod: #{pod_name}"
+                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.
+                    old_read_link=`which readlink`
+                    readlink () {
+                        path=`$old_read_link $1`;
+                        if [ $(echo "$path" | cut -c 1-1) = '/' ]; then
+                            echo $path;
+                        else
+                            echo "`dirname $1`/$path";
+                        fi
+                    }
+                    # --- 
+                SH
+
+                # patch the rsync for copy dSYM symlink
+                script = script.gsub "rsync --delete", "rsync --copy-links --delete"
+                
+                patch + script
+            end
+        end
+    end
+end