cocoapods-xlbuild 1.0.0

data/lib/cocoapods-xlbuild/Prebuild.rb

@@ -0,0 +1,239 @@
+require_relative 'rome/build_framework'
+require_relative 'helper/passer'
+require_relative 'helper/target_checker'
+
+
+# patch prebuild ability
+module Pod
+    class Installer
+
+        
+        private
+
+        def local_manifest 
+            if not @local_manifest_inited
+                @local_manifest_inited = true
+                raise "This method should be call before generate project" unless self.analysis_result == nil
+                @local_manifest = self.sandbox.manifest
+            end
+            @local_manifest
+        end
+
+        # @return [Analyzer::SpecsState]
+        def prebuild_pods_changes
+            return nil if local_manifest.nil?
+            if @prebuild_pods_changes.nil?
+                changes = local_manifest.detect_changes_with_podfile(podfile)
+                @prebuild_pods_changes = Analyzer::SpecsState.new(changes)
+                # save the chagnes info for later stage
+                Pod::Prebuild::Passer.prebuild_pods_changes = @prebuild_pods_changes 
+            end
+            @prebuild_pods_changes
+        end
+
+        
+        public 
+
+        # check if need to prebuild
+        def have_exact_prebuild_cache?
+            # check if need build frameworks
+            return false if local_manifest == nil
+            
+            changes = prebuild_pods_changes
+            added = changes.added
+            changed = changes.changed 
+            unchanged = changes.unchanged
+            deleted = changes.deleted 
+            
+            exsited_framework_pod_names = sandbox.exsited_framework_pod_names
+            missing = unchanged.select do |pod_name|
+                not exsited_framework_pod_names.include?(pod_name)
+            end
+
+            needed = (added + changed + deleted + missing)
+            return needed.empty?
+        end
+        
+        
+        # The install method when have completed cache
+        def install_when_cache_hit!
+            # just print log
+            self.sandbox.exsited_framework_target_names.each do |name|
+                UI.puts "Using #{name}"
+            end
+        end
+
+        # Build the needed framework files
+        def prebuild_frameworks! 
+            # build options
+            sandbox_path = sandbox.root
+            existed_framework_folder = sandbox.generate_framework_path
+            bitcode_enabled = Pod::Podfile::DSL.bitcode_enabled
+            use_static_framework = Pod::Podfile::DSL.static_binary
+            targets = []
+            
+            if local_manifest != nil
+                changes = prebuild_pods_changes
+                added = changes.added
+                changed = changes.changed 
+                unchanged = changes.unchanged
+                deleted = changes.deleted 
+    
+                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
+                root_names_to_update = (added + changed + missing).uniq
+                # 生成预编译target
+                cache = []
+                targets = root_names_to_update.map do |pod_name|
+                    tars = Pod.fast_get_targets_for_pod_name(pod_name, self.pod_targets, cache)
+                    if tars.nil?
+                        tars = []
+                    end
+                    tars
+                end.flatten
+
+                # 添加依赖
+                dependency_targets = targets.map {|t| t.recursive_dependent_targets }.flatten.uniq || []
+                dependency_targets = dependency_targets.select do |tar|
+                    sandbox.existed_target_version_for_pod_name(tar.pod_name) != tar.version
+                end
+                targets = (targets + dependency_targets).uniq
+            else
+                targets = self.pod_targets
+            end
+
+            targets = targets.reject {|pod_target| sandbox.local?(pod_target.pod_name) }
+
+            
+            # build!
+            Pod::UI.puts "Prebuild frameworks (total #{targets.count})"
+            Pod::Prebuild.remove_build_dir(sandbox_path)
+            targets.each do |target|
+                #linpeng edit  + target.version
+                output_path = sandbox.framework_folder_path_for_target_name(target.name)
+                output_path.rmtree if output_path.exist?
+                if !target.should_build?
+                    UI.puts "Prebuilding #{target.label}"
+                    next
+                end
+                output_path.mkpath unless output_path.exist?
+                Pod::Prebuild.build(sandbox_path, target, output_path, bitcode_enabled,  Podfile::DSL.custom_build_options,  Podfile::DSL.custom_build_options_simulator)
+
+                # save the resource paths for later installing，动态库需要将frameworkwork中资源链接到pod上
+                if target.static_framework? and !target.resource_paths.empty?
+                    framework_path = output_path + target.framework_name
+                    standard_sandbox_path = sandbox.standard_sanbox_path
+
+                    resources = begin
+                        if Pod::VERSION.start_with? "1.5"
+                            target.resource_paths
+                        else
+                            # resource_paths is Hash{String=>Array<String>} on 1.6 and above
+                            # (use AFNetworking to generate a demo data)
+                            # https://github.com/leavez/cocoapods-binary/issues/50
+                            target.resource_paths.values.flatten
+                        end
+                    end
+                    raise "Wrong type: #{resources}" unless resources.kind_of? Array
+                    path_objects = resources.map do |path|
+                        object = Prebuild::Passer::ResourcePath.new
+                        object.real_file_path = framework_path + File.basename(path)
+                        # 静态库资源目录处理
+                        if use_static_framework
+                            object.real_file_path = path.gsub('${PODS_ROOT}', existed_framework_folder.to_s) if path.start_with? '${PODS_ROOT}'
+                            object.real_file_path = path.gsub("${PODS_CONFIGURATION_BUILD_DIR}", existed_framework_folder.to_s) if path.start_with? "${PODS_CONFIGURATION_BUILD_DIR}"
+                            real_bundle_path = path.gsub('${PODS_ROOT}', sandbox_path.to_s) if path.start_with? '${PODS_ROOT}'
+                            real_bundle_path = path.gsub('${PODS_CONFIGURATION_BUILD_DIR}', sandbox_path.to_s) if path.start_with? '${PODS_CONFIGURATION_BUILD_DIR}'
+                            real_origin_path = Pathname.new(real_bundle_path)
+                            real_file_path_obj = Pathname.new(object.real_file_path)
+                            if real_origin_path.exist?
+                                real_file_path_obj.parent.mkpath unless real_file_path_obj.parent.exist?
+                                FileUtils.cp_r(real_origin_path, real_file_path_obj, :remove_destination => true)
+                            end
+                        end
+                        object.target_file_path = path.gsub('${PODS_ROOT}', standard_sandbox_path.to_s) if path.start_with? '${PODS_ROOT}'
+                        object.target_file_path = path.gsub("${PODS_CONFIGURATION_BUILD_DIR}", standard_sandbox_path.to_s) if path.start_with? "${PODS_CONFIGURATION_BUILD_DIR}"
+                        object
+                    end
+                    Prebuild::Passer.resources_to_copy_for_static_framework[target.name] = path_objects
+                end
+            end
+            Pod::Prebuild.remove_build_dir(sandbox_path)
+
+            # copy vendored libraries and frameworks
+            targets.each do |target|
+                root_path = self.sandbox.pod_dir(target.name)
+                target_folder = sandbox.framework_folder_path_for_target_name(target.name)
+                
+                # If target shouldn't build, we copy all the original files
+                # This is for target with only .a and .h files
+                if not target.should_build? 
+                    Prebuild::Passer.target_names_to_skip_integration_framework << target.name
+                    FileUtils.cp_r(root_path, target_folder, :remove_destination => true)
+                    next
+                end
+
+                target.spec_consumers.each do |consumer|
+                    file_accessor = Sandbox::FileAccessor.new(root_path, consumer)
+                    lib_paths = file_accessor.vendored_frameworks || []
+                    lib_paths += file_accessor.vendored_libraries
+                    # @TODO dSYM files
+                    lib_paths.each do |lib_path|
+                        relative = lib_path.relative_path_from(root_path)
+                        destination = target_folder + relative
+                        destination.dirname.mkpath unless destination.dirname.exist?
+                        FileUtils.cp_r(lib_path, destination, :remove_destination => true)
+                    end
+                end
+            end
+
+            # save the pod_name for prebuild framwork in sandbox 
+            targets.each do |target|
+                sandbox.save_pod_name_for_target target
+            end
+            
+            # Remove useless files
+            # remove useless pods
+            all_needed_names = self.pod_targets.map(&:name).uniq
+            useless_target_names = sandbox.exsited_framework_target_names.reject do |name| 
+                all_needed_names.include? name
+            end
+            useless_target_names.each do |name|
+                path = sandbox.framework_folder_path_for_target_name(name)
+                path.rmtree if path.exist?
+            end
+
+            if Podfile::DSL.dont_remove_source_code 
+                 # just remove the tmp files
+                path = sandbox.root + 'Manifest.lock.tmp'
+                path.rmtree if path.exist?
+            else 
+               # only keep manifest.lock and framework folder in _Prebuild
+                to_remain_files = ["Manifest.lock", File.basename(existed_framework_folder)]
+                to_delete_files = sandbox_path.children.select do |file|
+                    filename = File.basename(file)
+                    not to_remain_files.include?(filename)
+                end
+                to_delete_files.each do |path|
+                    path.rmtree if path.exist?
+                end
+            end
+        end
+
+        # hook run_plugins_post_install_hooks 方法
+        install_hooks_method = instance_method(:run_plugins_post_install_hooks)
+        define_method(:run_plugins_post_install_hooks) do
+            puts "[HY].run_plugins_post_install_hooks 触发 state:#{Pod::is_prebuild_stage}"
+            install_hooks_method.bind(self).()
+            if Pod::is_prebuild_stage
+                #开始编译
+                self.prebuild_frameworks!
+            end
+        end
+    end
+end

data/lib/cocoapods-xlbuild/Reference/reference_source_code.rb

@@ -0,0 +1,55 @@
+
+require 'xcodeproj'
+require_relative '../helper/passer'
+require_relative '../helper/prebuild_sandbox'
+
+module Pod
+    class Installer
+    	class PostInstallHooksContext
+	    	# 将源码引入主工程，方便源码调试
+	    	def refrence_source_code
+	    		sandbox_path = Pathname.new(sandbox.root)
+	    		pre_sandbox = Pod::PrebuildSandbox.from_standard_sandbox(sandbox)
+
+	    		exsited_framework_pod_names = pre_sandbox.exsited_framework_pod_names || []
+	    		proj_path = sandbox_path + get_project_name("Pods")
+
+					proj_path_new = Pathname.new(sandbox.project_path)
+
+					puts "[HY].沙盒路径：#{sandbox_path}"
+	    		project = Xcodeproj::Project.open(proj_path)
+    			exsited_framework_pod_names.each do |target_name|
+	    			real_reference("_Prebuild/#{target_name}", project, target_name)
+	    		end
+	    		project.save;
+	    	end
+
+	    	private
+	    	def get_project_name(tageter_name)
+	    		return "#{tageter_name}.xcodeproj"
+	    	end
+
+	    	def real_reference(file_path, project, target_name)
+				group = project.main_group.find_subpath(File.join("SourceCode", target_name), true)
+				group.set_source_tree('SOURCE_ROOT')
+				group.set_path(file_path)
+			    add_files_to_group(group)
+	    	end
+
+	    	#添加文件链接
+			def add_files_to_group(group)
+			  Dir.foreach(group.real_path) do |entry|
+			    filePath = File.join(group.real_path, entry)
+			    # 过滤目录和.DS_Store文件
+			    if entry != ".DS_Store" && !filePath.to_s.end_with?(".meta") &&entry != "." &&entry != ".." then
+			    	# 向group中增加文件引用
+					group.new_reference(filePath)
+				end
+			  end
+			end
+	    end
+	end
+end
+
+
+

data/lib/cocoapods-xlbuild/command/xlbuild.rb

@@ -0,0 +1,44 @@
+module Pod
+  class Command
+    # This is an example of a cocoapods plugin adding a top-level subcommand
+    # to the 'pod' command.
+    #
+    # You can also create subcommands of existing or new commands. Say you
+    # wanted to add a subcommand to `list` to show newly deprecated pods,
+    # (e.g. `pod list deprecated`), there are a few things that would need
+    # to change.
+    #
+    # - move this file to `lib/pod/command/list/deprecated.rb` and update
+    #   the class to exist in the the Pod::Command::List namespace
+    # - change this class to extend from `List` instead of `Command`. This
+    #   tells the plugin system that it is a subcommand of `list`.
+    # - edit `lib/cocoapods_plugins.rb` to require this file
+    #
+    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
+    #       in the `plugins.json` file, once your plugin is released.
+    #
+    class XLbuild < Command
+      self.summary = 'Short description of cocoapods-xlbuild.'
+
+      self.description = <<-DESC
+        Longer description of cocoapods-xlbuild.
+      DESC
+
+      # self.arguments = 'NAME'
+
+      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 for the cocoapods-xlbuild plugin in #{__FILE__}"
+      end
+    end
+  end
+end

data/lib/cocoapods-xlbuild/command.rb

@@ -0,0 +1 @@
+require 'cocoapods-xlbuild/command/xlbuild'

data/lib/cocoapods-xlbuild/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsXLbuild
+  VERSION = "1.0.0"
+end

data/lib/cocoapods-xlbuild/helper/feature_switches.rb

@@ -0,0 +1,97 @@
+require_relative '../tool/tool'
+require_relative 'prebuild_sandbox'
+
+module Pod
+
+    # a flag that indicate stages
+    class_attr_accessor :is_prebuild_stage
+
+
+    # a switch for the `pod` DSL to make it only valid for ':xlbuild => true'
+    class Podfile
+        module DSL
+            
+            @@enable_prebuild_patch = false
+
+            # when enable, `pod` function will skip all pods without 'prebuild => true'
+            def self.enable_prebuild_patch(value)
+                @@enable_prebuild_patch = value
+            end
+
+            # --- patch ---
+            old_method = instance_method(:pod)
+
+            define_method(:pod) do |name, *args|
+                if !@@enable_prebuild_patch
+                    old_method.bind(self).(name, *args)
+                    return
+                end
+
+                # patched content
+                should_prebuild = Pod::Podfile::DSL.prebuild_all
+                local = false
+                
+                options = args.last
+                if options.is_a?(Hash) and options[Pod::Prebuild.keyword] != nil
+                    should_prebuild = options[Pod::Prebuild.keyword]
+                    local = (options[:path] != nil)
+                end
+                
+                if should_prebuild and (not local)
+                    old_method.bind(self).(name, *args)
+                end
+            end
+         end
+    end
+    
+    
+    # a force disable option for integral 
+    class Installer
+        def self.force_disable_integration(value)
+            @@force_disable_integration = value
+        end
+        
+        old_method = instance_method(:integrate_user_project)
+        define_method(:integrate_user_project) do 
+            if @@force_disable_integration
+                return
+            end
+            old_method.bind(self).()
+        end
+    end
+
+    # a option to disable install complete message
+    class Installer
+        def self.disable_install_complete_message(value)
+            @@disable_install_complete_message = value
+        end
+        
+        old_method = instance_method(:print_post_install_message)
+        define_method(:print_post_install_message) do 
+            if @@disable_install_complete_message
+                return
+            end
+            old_method.bind(self).()
+        end
+    end
+
+    # option to disable write lockfiles
+    class Config
+
+        @@force_disable_write_lockfile = false
+        def self.force_disable_write_lockfile(value)
+            @@force_disable_write_lockfile = value
+        end
+        
+        old_method = instance_method(:lockfile_path)
+        define_method(:lockfile_path) do 
+            if @@force_disable_write_lockfile
+                # As config is a singleton, sandbox_root refer to the standard sandbox.
+                return PrebuildSandbox.from_standard_sanbox_path(sandbox_root).root + 'Manifest.lock.tmp'
+            else
+                return old_method.bind(self).()
+            end
+        end
+    end
+    
+end

data/lib/cocoapods-xlbuild/helper/names.rb

@@ -0,0 +1,78 @@
+# ABOUT NAMES
+#
+# There are many kinds of name in cocoapods. Two main names are widely used in this plugin.
+# - root_spec.name (spec.root_name, targe.pod_name):
+#   aka "pod_name"
+#   the name we use in podfile. the concept.
+# 
+# - target.name:
+#   aka "target_name"
+#   the name of the final target in xcode project. the final real thing.
+#
+# One pod may have multiple targets in xcode project, due to one pod can be used in mutiple 
+# platform simultaneously. So one `root_spec.name` may have multiple coresponding `target.name`s.
+# Therefore, map a spec to/from targets is a little complecated. It's one to many.
+#
+
+# Tool to transform Pod_name to target efficiently
+module Pod
+    def self.fast_get_targets_for_pod_name(pod_name, targets, cache)
+        pod_name_to_targets_hash = nil
+        if cache.empty?
+            pod_name_to_targets_hash = targets.reduce({}) do |sum, target|
+                array = sum[target.pod_name] || []
+                array << target
+                sum[target.pod_name] = array
+                sum
+            end
+            cache << pod_name_to_targets_hash
+        else
+            pod_name_to_targets_hash = cache.first
+        end
+        
+        pod_name_to_targets_hash[pod_name] || []
+    end
+end
+
+
+
+
+
+
+# Target:
+   
+#     def pod_name
+#       root_spec.name
+#     end
+
+#     def name
+# 	    pod_name + #{scope_suffix}
+#     end	
+
+#     def product_module_name
+#       root_spec.module_name
+#     end
+  
+#     def framework_name
+#       "#{product_module_name}.framework"
+#     end
+
+#    def product_name
+#       if requires_frameworks?
+#         framework_name
+#       else
+#         static_library_name
+#       end
+#     end
+
+#     def product_basename
+#       if requires_frameworks?
+#         product_module_name
+#       else
+#         label
+#       end
+#     end
+
+#     def framework_name
+#       "#{product_module_name}.framework"
+#     end

data/lib/cocoapods-xlbuild/helper/passer.rb

@@ -0,0 +1,45 @@
+require_relative '../tool/tool'
+
+module Pod    
+    class Prebuild
+
+        # Pass the data between the 2 steps
+        #
+        # At step 2, the normal pod install, it needs some info of the
+        # prebuilt step. So we store it here.
+        #
+        class Passer
+
+            # indicate the add/remove/update of prebuit pods
+            # @return [Analyzer::SpecsState] 
+            #
+            class_attr_accessor :prebuild_pods_changes
+            class_attr_accessor :prebuild_pod_targets_changes
+
+            # represent the path of resurces to copy
+            class ResourcePath
+                attr_accessor :real_file_path
+                attr_accessor :target_file_path
+            end
+            # Save the resoures for static framework, and used when installing the prebuild framework
+            # static framework needs copy the resurces mannully
+            #
+            # @return [Hash<String, [Passer::ResourcePath]>]
+            class_attr_accessor :resources_to_copy_for_static_framework
+            self.resources_to_copy_for_static_framework = {}
+
+            # Some pod won't be build in prebuild stage even if it have `binary=>true`.
+            # The targets of this pods have `oshould_build? == true`.
+            # We should skip integration (patch spec) for this pods
+            #
+            # @return [Array<String>]
+            class_attr_accessor :target_names_to_skip_integration_framework
+            self.target_names_to_skip_integration_framework = []
+
+            # 编译过的framework pod 名称
+            class_attr_accessor :static_build_pod_names
+            self.static_build_pod_names = []
+
+        end
+    end
+end