cocoapods-ppbuild 0.0.1

data/lib/cocoapods-ppbuild/Prebuild.rb

@@ -0,0 +1,236 @@
+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)
+
+                # transform names to targets
+                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.empty?
+                        raise "There's no target named (#{pod_name}) in Pod.xcodeproj.\n #{self.pod_targets.map(&:name)}" if t.nil?
+                    end
+                    tars
+                end.flatten
+
+                # add the dendencies
+                dependency_targets = targets.map {|t| t.recursive_dependent_targets }.flatten.uniq || []
+                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|
+                if !target.should_build?
+                    UI.puts "Prebuilding #{target.label}"
+                    next
+                end
+
+                output_path = sandbox.framework_folder_path_for_target_name(target.name)
+                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)
+                            target.resource_paths.values.flatten
+                        end
+                    end
+                    raise "Wrong type: #{resources}" unless resources.kind_of? Array
+
+                    path_objects = resources.flat_map do |path|
+                        real_path = framework_path + File.basename(path)
+                        # 静态库资源目录处理
+                        if use_static_framework
+                            real_bundle_path = sandbox.real_bundle_path_for_pod(path)
+                            if File.exists?(real_bundle_path)
+                                FileUtils.cp_r(real_bundle_path, framework_path, :remove_destination => true)
+                            end
+                        end
+                        object = Prebuild::Passer::ResourcePath.new
+                        if File.exists?(real_path)
+                            object.real_file_path = real_path
+                        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
+
+        # patch the post install hook
+        old_method2 = instance_method(:run_plugins_post_install_hooks)
+        define_method(:run_plugins_post_install_hooks) do 
+            old_method2.bind(self).()
+            if Pod::is_prebuild_stage
+                self.prebuild_frameworks!
+            end
+        end
+
+
+    end
+end

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

@@ -0,0 +1,216 @@
+module Pod
+  class Command
+    #
+    class Ppbuild < Command
+      self.summary = '通过将二进制对应源码放置在临时目录中，让二进制出现断点时可以跳到对应的源码，方便调试。'
+
+      self.description = <<-DESC
+          通过将二进制对应源码放置在临时目录中，让二进制出现断点时可以跳到对应的源码，方便调试。
+          在不删除二进制的情况下为某个组件添加源码调试能力，多个组件名称用空格分隔
+      DESC
+
+      self.arguments = [
+          CLAide::Argument.new('NAME', false)
+      ]
+      def self.options
+        [
+            ['--all-clean', '删除所有已经下载的源码'],
+            ['--clean', '删除所有指定下载的源码'],
+            ['--list', '展示所有一级下载的源码以及其大小'],
+            ['--source', '源码路径，本地路径,会去自动链接本地源码']
+        ]
+      end
+
+      def initialize(argv)
+        @codeSource =  argv.option('source') || nil
+        @names = argv.arguments! unless argv.arguments.empty?
+        @list = argv.flag?('list', false )
+        @all_clean = argv.flag?('all-clean', false )
+        @clean = argv.flag?('clean', false )
+        @config = Pod::Config.instance
+        @analyzer = nil
+        @podfile_dependency_cache = Pod::Installer::Analyzer::PodfileDependencyCache.from_podfile(@config.podfile)
+        super
+      end
+
+
+      def run
+        podfile_lock = File.join(Pathname.pwd,"Podfile.lock")
+        raise "podfile.lock,不存在，请先pod install/update" unless File.exist?(podfile_lock)
+        @lockfile ||= Lockfile.from_file(Pathname.new(podfile_lock) )
+
+        if @list
+          list
+        elsif @clean
+          clean
+        elsif @all_clean
+          all_clean
+        elsif @names
+          add
+        end
+
+        if @list && @clean && @names
+          raise "请选择您要执行的命令。"
+        end
+      end
+
+      #==========================begin add ==============
+
+      def add
+        if @names == nil
+          raise "请输入要调试组件名，多个组件名称用空格分隔"
+        end
+        @names.each do  |name|
+          lib_file = get_lib_path(name)
+          unless File.exist?(lib_file)
+            raise "找不到 #{lib_file}"
+          end
+          UI.puts "#{lib_file}"
+
+          target_path =  @codeSource || download_source(name)
+
+          link(lib_file,target_path,name)
+        end
+      end
+
+      #下载源码到本地
+      def download_source(name)
+        target_path =  File.join(source_root, name)
+        UI.puts target_path
+        FileUtils.rm_rf(target_path)
+        find_dependency = find_dependency(name)
+        spec = fetch_external_source(find_dependency, @config.podfile,@config.lockfile, @config.sandbox,true )
+
+        download_request = Pod::Downloader::Request.new(:name => name, :spec => spec)
+        Downloader.download(download_request, Pathname.new(target_path), :can_cache => true)
+
+        target_path
+      end
+
+      #找出依赖
+      def find_dependency (name)
+        find_dependency = nil
+
+          @config.podfile.dependencies.each do |dependency|
+            if dependency.root_name.downcase == name.downcase
+              find_dependency = dependency
+              break
+            end
+          end
+          if find_dependency.external_source.nil?
+            
+          end
+          find_dependency
+      end
+
+      # 获取external_source 下的仓库
+      # @return spec
+      def fetch_external_source(dependency ,podfile , lockfile, sandbox,use_lockfile_options)
+        checkout_options = lockfile.checkout_options_for_pod_named(dependency.root_name)
+        source = if use_lockfile_options && lockfile && checkout_options
+                   ExternalSources.from_params(checkout_options, dependency, podfile.defined_in_file, podfile.installation_options.clean?)
+                 else
+                   ExternalSources.from_dependency(dependency, podfile.defined_in_file, podfile.installation_options.clean?)
+                 end
+        source.fetch(sandbox)
+      end
+
+
+      #==========================link begin ==============
+
+      #链接，.a文件位置， 源码目录
+      def link(lib_file,target_path,basename)
+        check(lib_file,dir,basename)
+      end
+
+      def check(lib_file,dir,basename)
+        file = `dwarfdump "#{lib_file}" | grep -E "DW_AT_decl_file.*#{basename}.*\\.m|\\.c" | head -1 | cut -d \\" -f2`
+        if File.exist?(file)
+          raise "#{file} 不存在 请检测代码源是否正确~"
+        end
+        UI.puts "link successfully!"
+        UI.puts "view linked source at path: #{dir}"
+      end
+
+      def get_lib_path(name)
+        dir = Pathname.new(File.join(Pathname.pwd,"Pods",name))
+        dir = get_framework_path(dir, name)
+        if !Dir.exist?(dir)
+          raise "找不到组件：#{name}, 请输入正确名称！！ 者将组件名在git上提issues"
+        end
+        lib_path = File.join(dir, name)
+        lib_path
+      end
+
+      def get_framework_path(basepath, name)
+        dir = Pathname.new(File.join(basepath, "#{name}.framework"))
+        if !Dir.exist?(dir)
+          dir = dir.children.first
+          if Dir.exist?(dir)
+            return get_framework_path(dir, name)
+          end
+        end
+        return dir
+      end
+
+
+      #源码地址
+      # def get_gitlib_iOS_path(name)
+      #   "git@gitlab.xxx.com:iOS/#{name}.git"
+      # end
+      #要转换的地址，Github-iOS默认都是静态库
+      # def git_gitlib_iOS_path
+      #   'git@gitlab.xxx.com:Github-iOS/'
+      # end
+
+
+      #要转换的地址，Github-iOS默认都是静态库
+      # def http_gitlib_GitHub_iOS_path
+      #   'https://gitlab.xxx.com/Github-iOS/'
+      # end
+
+      #要转换的地址，iOS默认都是静态库
+      # def http_gitlib_iOS_path
+      #   'https://gitlab.xxx.com/iOS/'
+      # end
+
+      #==========================list begin ==============
+
+      def list
+        Dir.entries(source_root).each do |sub|
+          UI.puts "- #{sub}" unless sub.include?('.')
+        end
+        UI.puts "加载完成"
+      end
+
+
+      #==========================clean begin ==============
+      def all_clean
+        FileUtils.rm_rf(source_root) if File.directory?(source_root)
+        UI.puts "清理完成 #{source_root}"
+      end
+
+      def clean
+        raise "请输入要删除的组件库" if @names.nil?
+        @names.each do  |name|
+          full_path = File.join(source_root,name)
+          if File.directory?(full_path)
+            FileUtils.rm_rf(full_path)
+          else
+            UI.puts "找不到 #{full_path}".yellow
+          end
+        end
+        UI.puts "清理完成 #{@names.to_s}"
+      end
+
+      private
+
+      def source_root
+        dir = File.join(@config.cache_root,"Source")
+        FileUtils.mkdir_p(dir) unless File.exist? dir
+        UI.puts "缓存目录 #{dir}"
+        dir
+      end
+    end
+  end
+end

data/lib/cocoapods-ppbuild/command.rb

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

data/lib/cocoapods-ppbuild/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsPpbuild
+  VERSION = "0.0.1"
+end

data/lib/cocoapods-ppbuild/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 ':ppbuild => 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-ppbuild/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-ppbuild/helper/passer.rb

@@ -0,0 +1,41 @@
+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
+
+
+            # 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 = []
+
+        end
+    end
+end