cocoapods-xlbuild 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5748f33f7f849025871d30147a549cc44e663050f0db5f4d566e704a79b5a8af
+  data.tar.gz: 8fdda2558312a18ce1428d9012e8c137ed7740dd015108103369ab62ed3615b1
+SHA512:
+  metadata.gz: de501a7958a4dd3fd69c1d594a5635ab71b3a08e1827b308e33e290740c7860ec5efdf301c95a492e54be686e7bf4c8dc3f588c7088d1d6881bb49dc12b4b1bc
+  data.tar.gz: e649985d9a764cff3fcb0a3b305cffa4fba37b73e228d0c431ac48be3b761ff3661289d703a89460c9f2a8ee3b29aa1734a378cda68879d463d6c338a6ad7f62

data/lib/cocoapods-xlbuild/Integration.rb

@@ -0,0 +1,377 @@
+require_relative 'helper/podfile_options'
+require_relative 'helper/feature_switches'
+require_relative 'helper/prebuild_sandbox'
+require_relative 'helper/passer'
+require_relative 'helper/names'
+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.
+#
+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)
+                    return unless path.exist?
+                    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, uselink)
+                    source = Pathname.new(source)
+                    target = Pathname.new(target)
+                    target.parent.mkpath unless target.parent.exist?
+                    relative_source = source.relative_path_from(target.parent)
+                    if uselink
+                        FileUtils.ln_sf(relative_source, target)
+                    else
+                        if File.directory?(source) 
+                            FileUtils.cp_r source, target, :remove_destination => true
+                        else
+                            FileUtils.cp source, target
+                        end
+                        if not target.exist?
+                            raise "资源导入失败：#{target}"
+                        end
+                    end
+                end
+
+                def mirror_with_symlink(source, basefolder, target_folder, uselink)
+                    target = target_folder + source.relative_path_from(basefolder)
+                    make_link(source, target, uselink)
+                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?
+                            if [".framework"].include? child.extname
+                                mirror_with_symlink(source, real_file_folder, target_folder, true)
+                                next false  # return false means don't go deeper
+                            elsif [".dSYM"].include? child.extname
+                                mirror_with_symlink(source, real_file_folder, target_folder, false)
+                                next false  # return false means don't go deeper
+                            elsif [".bundle"].include? child.extname
+                                mirror_with_symlink(source, real_file_folder, target_folder, false)
+                                next false
+                            else
+                                next true
+                            end
+                        elsif child.file?
+                            mirror_with_symlink(source, real_file_folder, target_folder, false)
+                            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|
+                            if object.real_file_path != nil
+                                real_path = Pathname.new(object.target_file_path)
+                                real_path.rmtree if real_path.exist?
+                                make_link(object.real_file_path, object.target_file_path, false)
+                            end
+                        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_pod_targets_changes
+            updated_names = []
+            if changes == nil
+                updated_names = PrebuildSandbox.from_standard_sandbox(self.sandbox).exsited_framework_pod_names
+            else
+                t_changes = Pod::Prebuild::Passer.prebuild_pods_changes
+                added = t_changes.added
+                changed = t_changes.changed 
+                deleted = t_changes.deleted 
+                updated_names = (added + changed + deleted).to_a
+
+                updated_names = (changes + updated_names).uniq
+            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
+
+        def save_change_targets!
+            sandbox_path = sandbox.root
+            existed_framework_folder = sandbox.generate_framework_path
+            if local_manifest != nil
+                changes = prebuild_pods_changes
+                added = changes.added
+                changed = changes.changed 
+                unchanged = changes.unchanged
+                deleted = changes.deleted.to_a
+    
+                existed_framework_folder.mkdir unless existed_framework_folder.exist?
+                exsited_framework_pod_names = sandbox.exsited_framework_pod_names
+    
+                # additions
+                missing = unchanged.select do |pod_name|
+                    not exsited_framework_pod_names.include?(pod_name)
+                end
+
+                # 保存有改变的target列表
+                root_names_to_update = (added + changed + missing).uniq
+                updates_target_names = (root_names_to_update + deleted).uniq
+                cache = []
+                updates_targets = []
+                updates_target_names.each do |pod_name|
+                    tars = Pod.fast_get_targets_for_pod_name(pod_name, self.pod_targets, cache)
+                    if tars.nil?
+                        tars = []
+                    end
+                    updates_targets = (updates_targets + tars).uniq 
+                end
+                updates_dependency_targets = updates_targets.map {|t| 
+                    t.recursive_dependent_targets 
+                }.flatten.uniq || []
+                dependency_names = updates_dependency_targets.map { |e| e.pod_name }
+                if Pod::Prebuild::Passer.prebuild_pod_targets_changes.nil?
+                    Pod::Prebuild::Passer.prebuild_pod_targets_changes = (updates_target_names + dependency_names).uniq
+                else
+                    Pod::Prebuild::Passer.prebuild_pod_targets_changes = (Pod::Prebuild::Passer.prebuild_pod_targets_changes + updates_target_names + dependency_names).uniq
+                end
+            end
+        end
+
+        # Modify specification to use only the prebuild framework after analyzing
+        old_method2 = instance_method(:resolve_dependencies)
+        define_method(:resolve_dependencies) do
+            if Pod::is_prebuild_stage
+                # call original
+                old_method2.bind(self).()
+                self.save_change_targets!
+            else
+                # 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 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)
+                self.validate_every_pod_only_have_one_form
+
+                
+                # prepare
+                cache = []
+
+                def add_vendered_framework(spec, platform, added_framework_file_path)
+                    platform_map = spec.attributes_hash[platform]
+                    if platform_map == nil
+                        platform_map = {}
+                    end
+                    vendored_frameworks = platform_map["vendored_frameworks"] || []
+                    vendored_frameworks = [vendored_frameworks] if vendored_frameworks.kind_of?(String)
+                    vf = spec.attributes_hash["vendored_frameworks"] || []
+                    vf = [vf] if vf.kind_of?(String)
+                    vendored_frameworks += vf
+                    vendored_frameworks += [added_framework_file_path]
+                    spec.attributes_hash["vendored_frameworks"] = vendored_frameworks
+                    if spec.attributes_hash[platform] != nil
+                        spec.attributes_hash[platform].delete("vendored_frameworks")
+                    end
+                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 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.
+
+                    if spec.attributes_hash["resource_bundles"]
+                        bundle_names = spec.attributes_hash["resource_bundles"].keys
+                        spec.attributes_hash["resource_bundles"] = nil 
+                        spec.attributes_hash["resources"] ||= []
+                        spec.attributes_hash["resources"] += bundle_names.map{|n| n+".bundle"}
+                    elsif spec.attributes_hash['ios'] && spec.attributes_hash['ios']["resource_bundles"]
+                        bundle_names = spec.attributes_hash['ios']["resource_bundles"].keys
+                        spec.attributes_hash['ios']["resource_bundles"] = nil 
+                        spec.attributes_hash['ios']["resources"] ||= []
+                        spec.attributes_hash['ios']["resources"] += bundle_names.map{|n| n+".bundle"}
+                    end
+
+                    # to avoid the warning of missing license
+                    spec.attributes_hash["license"] = {}
+
+                end
+            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|
+            if Pod::is_prebuild_stage
+                tmp = old_method.bind(self).(pod_name)
+            else
+                # 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
+                return @installed_specs.concat(pod_installer.specs_by_platform.values.flatten.uniq)
+                # \copy from original
+            end
+        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).()
+                if not Pod::is_prebuild_stage
+                    patch = <<-SH.strip_heredoc
+                        #!/bin/sh
+                    
+                        # ---- this is added by cocoapods-xlbuild ---
+                        # 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"
+                    
+                    script = patch + script
+                end
+                script
+            end
+        end
+    end
+end

data/lib/cocoapods-xlbuild/Main.rb

@@ -0,0 +1,193 @@
+# encoding: UTF-8
+require_relative 'helper/podfile_options'
+require_relative 'tool/tool'
+
+module Pod
+    class Podfile
+        module DSL
+            # Enable prebuiding for all pods
+            # it has a lower priority to other xlbuild settings
+            def use_dynamic_binary!
+                DSL.prebuild_all = true
+                DSL.static_binary = false
+                DSL.dont_remove_source_code = true
+            end
+            # 设置当前swift版本
+            def use_swift_version(version)
+                DSL.swift_version = version
+            end
+
+            # 设置是否使用静态库
+            def use_static_binary!
+                DSL.prebuild_all = true
+                DSL.static_binary = true
+                DSL.dont_remove_source_code = true
+            end
+
+            # 设置是否保存源码，默认 true
+            def remove_source_code_for_prebuilt_frameworks!
+                DSL.dont_remove_source_code = false
+            end
+
+            # Enable bitcode for prebuilt frameworks
+            def enable_bitcode_for_prebuilt_frameworks!
+                DSL.bitcode_enabled = true
+            end
+
+            # Add custom xcodebuild option to the prebuilding action
+            #
+            # You may use this for your special demands. For example: the default archs in dSYMs
+            # of prebuilt frameworks is 'arm64 armv7 x86_64', and no 'i386' for 32bit simulator.
+            # It may generate a warning when building for a 32bit simulator. You may add following
+            # to your podfile
+            #
+            #  ` set_custom_xcodebuild_options_for_prebuilt_frameworks :simulator => "ARCHS=$(ARCHS_STANDARD)" `
+            #
+            # Another example to disable the generating of dSYM file:
+            #
+            #  ` set_custom_xcodebuild_options_for_prebuilt_frameworks "DEBUG_INFORMATION_FORMAT=dwarf"`
+            #
+            #
+            # @param [String or Hash] options
+            #
+            #   If is a String, it will apply for device and simulator. Use it just like in the commandline.
+            #   If is a Hash, it should be like this: { :device => "XXXXX", :simulator => "XXXXX" }
+            #
+            def set_custom_xcodebuild_options_for_prebuilt_frameworks(options)
+                if options.kind_of? Hash
+                    DSL.custom_build_options = [ options[:device] ] unless options[:device].nil?
+                    DSL.custom_build_options_simulator = [ options[:simulator] ] unless options[:simulator].nil?
+                elsif options.kind_of? String
+                    DSL.custom_build_options = [options]
+                    DSL.custom_build_options_simulator = [options]
+                else
+                    raise "Wrong type."
+                end
+            end
+
+            private
+            class_attr_accessor :prebuild_all
+            prebuild_all = false
+
+            class_attr_accessor :swift_version
+            swift_version = "5.0"   # swift版本默认5.0
+
+            class_attr_accessor :static_binary
+            static_binary = false
+
+            class_attr_accessor :bitcode_enabled
+            bitcode_enabled = false
+
+            class_attr_accessor :dont_remove_source_code
+            dont_remove_source_code = true
+
+            class_attr_accessor :custom_build_options
+            class_attr_accessor :custom_build_options_simulator
+            self.custom_build_options = []
+            self.custom_build_options_simulator = []
+        end
+    end
+end
+
+Pod::HooksManager.register('cocoapods-xlbuild', :pre_install) do |installer_context|
+    require_relative 'helper/feature_switches'
+    if Pod.is_prebuild_stage
+        next
+    end
+
+    # [Check Environment]
+    # check user_framework is on
+    podfile = installer_context.podfile
+    podfile.target_definition_list.each do |target_definition|
+        next if target_definition.prebuild_framework_pod_names.empty?
+        if not target_definition.uses_frameworks?
+            STDERR.puts "[!] cocoapods-xlbuild requires `use_frameworks!`".red
+            exit
+        end
+    end
+
+    # -- step 1: prebuild framework ---
+    # Execute a sperated pod install, to generate targets for building framework,
+    # then compile them to framework files.
+    require_relative 'helper/prebuild_sandbox'
+
+    #Prebuild里面hooke了run_plugins_post_install_hooks方法
+    require_relative 'Prebuild'
+
+    # Pod::UI.puts "火速编译中..."
+
+    # Fetch original installer (which is running this pre-install hook) options,
+    # then pass them to our installer to perform update if needed
+    # Looks like this is the most appropriate way to figure out that something should be updated
+
+    update = nil
+    repo_update = nil
+
+    include ObjectSpace
+    ObjectSpace.each_object(Pod::Installer) { |installer|
+        update = installer.update
+        repo_update = installer.repo_update
+    }
+
+    # control features
+    Pod.is_prebuild_stage = true
+    Pod::Podfile::DSL.enable_prebuild_patch true  # enable sikpping for prebuild targets
+    Pod::Installer.force_disable_integration true # don't integrate targets
+    Pod::Config.force_disable_write_lockfile true # disbale write lock file for perbuild podfile
+    Pod::Installer.disable_install_complete_message true # disable install complete message
+
+    # make another custom sandbox
+    standard_sandbox = installer_context.sandbox
+    prebuild_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(standard_sandbox)
+
+    # get the podfile for prebuild
+    prebuild_podfile = Pod::Podfile.from_ruby(podfile.defined_in_file)
+
+    # install
+    lockfile = installer_context.lockfile
+    binary_installer = Pod::Installer.new(prebuild_sandbox, prebuild_podfile, lockfile)
+
+    require_relative 'Integration'
+    # Prebuild文件里面也扩展了 Pod::Installer类，同时新增扩展了have_exact_prebuild_cache?方法
+    if binary_installer.have_exact_prebuild_cache? && !update
+        binary_installer.install_when_cache_hit!
+    else
+        binary_installer.update = update
+        binary_installer.repo_update = repo_update
+        binary_installer.install!
+    end
+
+    ##备注上面的install是同步执行的，工程hook了 pod 的方法使得其会先下载源码然后进行xcodebuild编译 编译晚
+    #之后才会往下走
+
+    # reset the environment
+    Pod.is_prebuild_stage = false
+    Pod::Installer.force_disable_integration false
+    Pod::Podfile::DSL.enable_prebuild_patch false
+    Pod::Config.force_disable_write_lockfile false
+    Pod::Installer.disable_install_complete_message false
+    Pod::UserInterface.warnings = [] # clean the warning in the prebuild step, it's duplicated.
+
+    # -- step 2: pod install ---
+    # install
+    Pod::UI.puts "🤖  Pod Install " + Time.new.inspect
+    # go on the normal install step ...
+
+end
+
+## pod 安装依赖的时候会执行install，install的时候会执行run_plugins_post_install_hooks（Prebuildhook了该方法）
+# 只要有触发install方法就会触发如下的
+Pod::HooksManager.register('cocoapods-xlbuild', :post_install) do |installer_context|
+    Pod::UI.puts "🤖  Pod Install hook " + Time.new.inspect
+    if Pod::Podfile::DSL.static_binary
+        Pod::UI.puts "🤖  replace_tagert_copy_source_sh " + Time.new.inspect
+        Pod::PrebuildSandbox.replace_tagert_copy_source_sh(installer_context)
+    end
+
+    if !Pod.is_prebuild_stage && Pod::Podfile::DSL.dont_remove_source_code
+        Pod::UI.puts "🤖  pod工程关联引用源码 " + Time.new.inspect
+        require_relative 'reference/reference_source_code'
+        installer_context.refrence_source_code
+    end
+end
+