cocoapods-yaml 1.0.0

data/lib/core/check/podspec.rb

@@ -0,0 +1,195 @@
+require_relative 'project'
+require_relative 'util'
+require_relative '../my_constants'
+
+module Xcodeproj
+  class PodspecChecker
+
+    # @return [XCodeProject]
+    attr_accessor :project
+
+    # @param project::[XCodeProject]
+    def initialize(project)
+      @project = project
+    end
+
+    # 检查podspec文件
+    def check_podspec
+
+      yaml_dep = Pod::YamlDependencies.new
+      if yaml_dep.disable_check_podspec
+        return
+      end
+
+      CocoaPods::Yaml.log.step("podspec文件检查中...")
+      start = (Time.now.to_f * 1000).to_i
+      module_count = 0
+
+      project.module_items.each do |module_name, module_item|
+        unless module_item.is_development_module
+          next
+        end
+        unless module_item.podspec_path
+          next
+        end
+        module_count += 1
+
+        module_item.init_absolute_import_info
+
+        # 代码里需要的模块
+        need_modules = get_code_need_modules(module_item)
+
+        # podspec直接依赖
+        podspec_modules = get_podspec_modules(module_item)
+
+        loss = loss_modules(need_modules, podspec_modules)
+        unused = unused_modules(need_modules, podspec_modules, module_item)
+
+        if loss.size >0
+          CocoaPods::Yaml.log.warn("组件#{module_item.module_name}可能缺少以下依赖(#{loss.size}个), 请检查:")
+          loss.sort.each do |name|
+            CocoaPods::Yaml.log.info("  s.dependency '#{name}'")
+          end
+        end
+
+        if unused.size >0
+          CocoaPods::Yaml.log.warn("组件#{module_item.module_name}可能未使用以下依赖(#{unused.size}个), 请检查:")
+          unused.sort.each { |name| CocoaPods::Yaml.log.info("  #{name}") }
+        end
+
+      end
+
+      duration = ((Time.now.to_f * 1000).to_i - start)*0.001
+      CocoaPods::Yaml.log.detail("podspec检查完毕! 共检查#{module_count}个组件 耗时:#{duration.round(2)}秒")
+    end
+
+    private
+
+    # podspec.json中平台级配置使用的键，s.ios.dependency等会序列化到这些键下
+    PLATFORM_KEYS = %w[ios osx tvos watchos visionos].freeze
+
+    # 获取缺失的模块
+    # @param need_modules::[String]
+    # @param podspec_modules::[Hash{String => [String]}]
+    def loss_modules(need_modules, podspec_modules)
+      # 一次性展开所有podspec声明的framework/组件名
+      declared_modules = podspec_modules.values.flatten.uniq
+
+      need_modules.select do |name|
+        !declared_modules.include?(name) && module_is_installed(name)
+      end
+    end
+
+    # 获取多余的模块
+    # @param need_modules::[String]
+    # @param podspec_modules::[Hash{String => [String]}]
+    def unused_modules(need_modules, podspec_modules, module_item)
+      res = []
+      podspec_modules.each do |dep_name, array|
+        contain = false
+        array.each do |vendor|
+          if need_modules.include?(vendor)
+            contain = true
+          end
+        end
+
+        if not contain and module_item.module_name != dep_name
+          res << dep_name
+        end
+      end
+      res
+    end
+
+    # @note 获取代码里需要的模块
+    def get_code_need_modules(module_item)
+      import_items = module_item.absolute_import_items
+      result_dic = {}
+      import_items.each do |import_item|
+        # 过滤系统库
+        if system_modules.include?(import_item.belong_module)
+          next
+        end
+
+        # 过滤当前库
+        if module_item.module_name == import_item.belong_module
+          next
+        end
+
+        result_dic[import_item.belong_module] = import_item
+      end
+      result_dic.keys
+    end
+
+    # 获取podspec文件里写的模块 直接依赖
+    # @return [Hash{String => [String]}]
+    def get_podspec_modules(module_item)
+
+      podspec_content =  Util.get_podspec_content(module_item.podspec_path)
+
+      # 递归收集当前层、所有嵌套subspec、以及平台级(ios/osx等)声明的依赖
+      podspec_dependencies = []
+      collect_podspec_dependencies(podspec_content, podspec_dependencies)
+
+      # 转成map
+      result = {}
+      podspec_dependencies.each do |podspec_dependency|
+        podspec_dependency = podspec_dependency.split("/")[0] #如果podspec里写的依赖是带/的，取/前第一个, 例如：s.dependency 'UMCShare/Social/ReducedQQ'
+        dependency_item = project.module_items[podspec_dependency]
+        if dependency_item
+          result[podspec_dependency] =  dependency_item.frameworks
+        else #如果/都处理了，还是取不到，那就整个默认值，自身
+          frameworks = [podspec_dependency]
+          if podspec_dependency.include?("/") #处理依赖 s.dependency 'UMCShare/Social/ReducedQQ'
+            frameworks << podspec_dependency.split("/")[0]
+          end
+          result[podspec_dependency] = frameworks
+        end
+      end
+
+      result
+    end
+
+    # 递归收集podspec(含嵌套subspec、平台级配置)中声明的全部依赖名
+    # @param spec_content::[Hash] podspec.json解析出的当前层内容
+    # @param dependencies::[Array<String>] 累加结果
+    def collect_podspec_dependencies(spec_content, dependencies)
+      return unless spec_content.is_a?(Hash)
+
+      if spec_content["dependencies"].is_a?(Hash)
+        dependencies.concat(spec_content["dependencies"].keys)
+      end
+
+      # s.ios.dependency 'X' 等平台级依赖会序列化到 ios/osx/... 键下
+      PLATFORM_KEYS.each do |platform_key|
+        platform_content = spec_content[platform_key]
+        collect_podspec_dependencies(platform_content, dependencies) if platform_content.is_a?(Hash)
+      end
+
+      # 嵌套subspec递归收集
+      subspecs = spec_content["subspecs"]
+      if subspecs.is_a?(Array)
+        subspecs.each do |subspec|
+          collect_podspec_dependencies(subspec, dependencies)
+        end
+      end
+    end
+
+    # 判断某个库是否被安装
+    def module_is_installed(module_name)
+      all = project.lock_content["DEPENDENCIES"]
+      unless all
+        return false
+      end
+      # 使用非破坏式map生成归一化数组，禁止collect!改写lock原始数据
+      normalized = all.map do |dep|
+        dep.split(" (")[0].split("/")[0]
+      end
+      normalized.include?(module_name)
+    end
+    # 系统级的依赖库
+    # @return [String]
+    def system_modules
+      MyConstants::LIBLIBARYS + MyConstants::FRAMEWORKS
+    end
+  end
+end

data/lib/core/check/project.rb

@@ -0,0 +1,405 @@
+require 'pathname'
+require 'colored2'
+require 'cocoapods/downloader/request'
+require_relative 'xcodeproj'
+require_relative 'util'
+require_relative 'item'
+
+module Xcodeproj
+
+  class XCodeProject
+
+    # 参与import/podspec分析的源码后缀
+    CODE_FILE_EXTENSIONS = %w[.h .m .mm .pch .c .cc .cpp .hpp].freeze
+    HEADER_FILE_EXTENSIONS = %w[.h .hpp].freeze
+
+    # 壳工程xcodeproj对象
+    # @return Xcodeproj::Project
+    attr_accessor :shell_project
+
+    # Pods工程xcodeproj对象
+    # @return Xcodeproj::Project
+    attr_accessor :pod_project
+
+    # @return [Hash{String => ModuleItem}]
+    attr_accessor :module_items
+
+    # @return [Hash]
+    attr_accessor :lock_content
+
+    # @return [Hash]
+    attr_accessor :version_map
+
+    def initialize
+      @shell_project = nil
+      @pod_project = nil
+      @module_items = {}
+      @version_map = {}
+      @lock_content = {}
+      init_shell_project
+      init_pod_project
+      init_lockfile
+      init_version_map
+      expand_module
+      init_vendor_frameworks
+    end
+
+    def init_shell_project
+      # 统一走XcodeprojManager的壳工程查找逻辑，避免多份实现选取结果不一致
+      @shell_project = XCProject::XcodeprojManager.share_manager.get_shell_project
+    end
+
+    def init_pod_project
+      xcodeproj_path = "#{Dir.pwd}/Pods/Pods.xcodeproj"
+      unless File.exist?(xcodeproj_path)
+        return nil
+      end
+
+      @pod_project = Xcodeproj::Project.open(xcodeproj_path)
+    end
+
+    def init_lockfile
+      lockfile_path = MyConstants::PODFILE_LOCK
+
+      unless File.exist?(lockfile_path)
+        return
+      end
+
+      @lock_content = YAML.load_file(lockfile_path)
+    end
+    def init_version_map
+      lock_content = @lock_content
+
+      remote_dependencies = lock_content["PODS"]
+      unless remote_dependencies
+        return
+      end
+
+      remote_dependencies.each do |dependency|
+        if dependency.class == Hash
+          dependency = dependency.keys.first
+        end
+        # 外部源条目形如 "Xxx (from `path`)"，没有版本号；
+        # 不跳过会把 "from `path`" 当版本存入，污染get_podspec_path的缓存路径推断
+        next if dependency.include?("(from")
+
+        temp = dependency.split("(")
+        # 无括号段(理论上不出现)时temp[1]为nil，直接跳过避免NoMethodError
+        version = temp[1]
+        next if version.nil?
+
+        name = temp[0].split("/")[0] # UMCShare/Social/ReducedWeChat
+        name = name.gsub(" ", "").gsub(")", "")
+        version = version.gsub("= ", "").gsub(")", "")
+        next if version.empty?
+
+        @version_map[name] = version
+      end
+    end
+
+    # 展开模块
+    def expand_module
+      self.expand_with_module(pod_project.main_group, nil)
+    end
+
+    # 展开模块
+    def expand_with_module(group, module_name)
+
+      if group.class != Xcodeproj::Project::Object::PBXGroup
+        return
+      end
+
+      if not module_name and group.hierarchy_path
+        group_hierarchy_path_array = group.hierarchy_path.split("/")
+        module_name = group_hierarchy_path_array.size >= 3 ? group_hierarchy_path_array[2] : nil
+      end
+
+      # 创建 source_file_item
+      source_file_item = @module_items[module_name]
+      if module_name and not source_file_item
+        source_file_item = ModuleItem.new(module_name)
+        source_file_item.podspec_path = get_podspec_path(module_name)
+        @module_items[module_name] = source_file_item
+      end
+
+      # 更新module_path
+      if source_file_item and not source_file_item.module_path and group.hierarchy_path
+        group_hierarchy_path_array = group.hierarchy_path.split("/")
+        if group_hierarchy_path_array.size == 3
+          source_file_item.module_path = group.real_path
+        end
+        if group_hierarchy_path_array.include?("Development Pods")
+          source_file_item.is_development_module = true
+        end
+      end
+
+      # 文件引用
+      file_reference_class = Xcodeproj::Project::Object::PBXFileReference
+      # PBXFileSystemSynchronizedRootGroup在xcodeproj 1.25(Xcode16)才引入，旧版本取nil走普通分组逻辑
+      synchronized_group_class =
+        if Xcodeproj::Project::Object.const_defined?(:PBXFileSystemSynchronizedRootGroup)
+          Xcodeproj::Project::Object.const_get(:PBXFileSystemSynchronizedRootGroup)
+        end
+
+      not_child_names = ["Podfile","Frameworks", "Products","Targets Support Files","Support Files"]
+      source_file_extension = CODE_FILE_EXTENSIONS
+      header_file_extension = HEADER_FILE_EXTENSIONS
+
+      group.children.each {|child|
+
+        module_name = source_file_item ? source_file_item.module_name : nil
+
+        # Xcode16+的文件系统同步分组不是PBXGroup子类(PBXFileSystemSynchronizedRootGroup
+        # 直接继承AbstractObject)，既没有name也没有real_path，走普通递归会在方法入口被整体跳过，
+        # 导致该组件不进module_items，podspec检查和import检查会静默失效。
+        # 该判断必须在child.name过滤之前(同步分组不响应name方法)。这里改为按磁盘目录扫描展开。
+        if synchronized_group_class && child.is_a?(synchronized_group_class)
+          expand_synchronized_group(group, child, module_name)
+          next
+        end
+
+        if not_child_names.include?(child.name)
+          # puts "不检查：#{child.name} #{child.real_path}"
+          next
+        end
+
+        if child.class != file_reference_class
+          # puts "不是文件引用：#{child.class}  #{child.real_path}"
+          self.expand_with_module(child, module_name)
+          next
+        end
+
+        hierarchy_path_array = child.hierarchy_path.split("/")
+        if hierarchy_path_array.size < 3
+          self.expand_with_module(child, module_name)
+          next
+        end
+
+        if source_file_item
+          extend_name = child.real_path.basename.extname
+          basename = child.real_path.basename
+          if basename.to_s == "#{module_name}.podspec" or basename.to_s == "#{module_name}.podspec.json"
+            source_file_item.podspec_path = child.real_path
+          elsif source_file_extension.include?(extend_name)
+            source_file_item.source_files[child.real_path.basename.to_s] = child.real_path
+            if header_file_extension.include?(extend_name)
+              source_file_item.header_files[child.real_path.basename.to_s] = child.real_path
+            end
+          else
+            # puts child.real_path
+          end
+        end
+
+        # 递归展开
+        self.expand_with_module(child, module_name)
+      }
+
+    end
+
+    # 展开Xcode16+文件系统同步分组(PBXFileSystemSynchronizedRootGroup)
+    # 同步分组不在工程文件里列举成员，磁盘上有什么文件Xcode就编译什么，
+    # 因此这里直接扫描磁盘目录收集源码与podspec，语义与普通分组遍历保持一致。
+    # 注意: 同步分组没有hierarchy_path/real_path/name，层级信息需从父分组拼接
+    # @param parent_group [PBXGroup] 承载该同步分组的普通分组(用于解析相对路径)
+    # @param sync_group [PBXFileSystemSynchronizedRootGroup]
+    # @param module_name [String, nil] 父分组已解析出的组件名
+    def expand_synchronized_group(parent_group, sync_group, module_name)
+      # 与普通分组一致，按层级路径解析组件名
+      hierarchy_path = build_synchronized_hierarchy_path(parent_group, sync_group)
+      if hierarchy_path
+        hierarchy_path_array = hierarchy_path.split("/")
+        module_name = hierarchy_path_array[2] if hierarchy_path_array.size >= 3
+      end
+
+      source_file_item = @module_items[module_name]
+      if module_name && source_file_item.nil?
+        source_file_item = ModuleItem.new(module_name)
+        source_file_item.podspec_path = get_podspec_path(module_name)
+        @module_items[module_name] = source_file_item
+      end
+      return unless source_file_item
+
+      disk_path = synchronized_disk_path(parent_group, sync_group)
+      return unless disk_path && File.directory?(disk_path)
+
+      # 与普通分组逻辑一致: 层级深度为3的分组对应组件根目录
+      if source_file_item.module_path.nil? && hierarchy_path && hierarchy_path.split("/").size == 3
+        source_file_item.module_path = Pathname.new(disk_path)
+      end
+      if hierarchy_path&.split("/")&.include?("Development Pods")
+        source_file_item.is_development_module = true
+      end
+
+      scan_disk_module_files(source_file_item, disk_path, module_name)
+    end
+
+    # 拼接同步分组的层级路径(其自身不响应hierarchy_path)
+    # @return [String, nil] 形如 "/Development Pods/BSLogin"
+    def build_synchronized_hierarchy_path(parent_group, sync_group)
+      parent_path = parent_group.respond_to?(:hierarchy_path) ? parent_group.hierarchy_path : nil
+      return nil if parent_path.nil?
+
+      "#{parent_path}/#{sync_group.display_name}"
+    end
+
+    # 递归收集磁盘目录下的源码文件和podspec(对应Xcode16+同步文件夹分组)
+    # @param module_item [ModuleItem]
+    # @param disk_path [String, Pathname] 同步分组在磁盘上的根目录
+    # @param module_name [String]
+    def scan_disk_module_files(module_item, disk_path, module_name)
+      Dir.glob(File.join(disk_path.to_s, '**', '*')).each do |path|
+        next unless File.file?(path)
+
+        basename = File.basename(path)
+        extend_name = File.extname(path)
+        pathname = Pathname.new(path)
+        if basename == "#{module_name}.podspec" || basename == "#{module_name}.podspec.json"
+          module_item.podspec_path = pathname
+        elsif CODE_FILE_EXTENSIONS.include?(extend_name)
+          module_item.source_files[basename] = pathname
+          if HEADER_FILE_EXTENSIONS.include?(extend_name)
+            module_item.header_files[basename] = pathname
+          end
+        end
+      end
+    end
+
+    # 计算同步分组在磁盘上的绝对路径
+    # @param parent_group [PBXGroup] 承载该同步分组的普通分组(有real_path)
+    # @param sync_group [PBXFileSystemSynchronizedRootGroup] 只有相对path，没有real_path
+    def synchronized_disk_path(parent_group, sync_group)
+      relative = sync_group.path
+      return nil if relative.nil? || relative.empty?
+
+      path = Pathname.new(relative)
+      return path if path.absolute?
+
+      case sync_group.source_tree
+      when 'SOURCE_ROOT'
+        # 相对Pods工程源根目录，不需要父分组回退
+        base = pod_project.root_object.main_group.real_path
+        return path unless base
+
+        base.join(relative)
+      else # '<group>'(默认): 相对所在父分组
+        base = parent_group.real_path
+        candidate = base ? base.join(relative) : path
+        # 部分工程父分组未配置显式path，real_path只解析到工程根目录，
+        # 此时按分组名再补一层做回退(Development Pods等分组名通常与磁盘目录同名)
+        if base && !candidate.directory? && parent_group.respond_to?(:display_name)
+          fallback = base.join(parent_group.display_name.to_s, relative)
+          candidate = fallback if fallback.directory?
+        end
+        candidate
+      end
+    end
+
+    # 读取某个模块的podspec路径
+    def get_podspec_path(module_name)
+      check_options = lock_content["CHECKOUT OPTIONS"]
+      if check_options and check_options[module_name]
+        check_option = check_options[module_name]
+        request = Pod::Downloader::Request.new(released:false, name:module_name, params:check_option)
+        slug_opts = {}
+        cache_path = request.slug(**slug_opts)
+        return "~/Library/Caches/CocoaPods/Pods/Specs/#{cache_path}.podspec.json"
+      end
+
+      # :path: localPods/XX
+      local_spec = lock_content["EXTERNAL SOURCES"]
+      if local_spec and local_spec[module_name]
+        path = local_spec[module_name][:path]
+        podspec_path = "#{path}/#{module_name}.podspec"
+        podspec_json_path = "#{path}/#{module_name}.podspec.json"
+        if File.exist?(podspec_path)
+          return Pathname(podspec_path).expand_path
+        elsif File.exist?(podspec_json_path)
+          return Pathname(podspec_json_path).expand_path
+        else
+          return nil
+        end
+      end
+
+      # 4.0.1-24ee2.podspec.json
+      version_spec = @lock_content["SPEC CHECKSUMS"]
+      md5_to5 = ""
+      if version_spec and version_spec[module_name]
+        md5 =  version_spec[module_name]
+        md5_to5 = md5.slice(0,5)
+      end
+      version = @version_map[module_name]
+      if version
+        podspec_json_name = "#{version}-#{md5_to5}.podspec.json"
+        path = "~/Library/Caches/CocoaPods/Pods/Specs/Release/#{module_name}/#{podspec_json_name}"
+        return Pathname(path).expand_path
+      end
+
+      nil
+    end
+
+
+    # 初始化模块的vendor_frameworks
+    def init_vendor_frameworks
+      @module_items.each_value do |module_item|
+        module_item.frameworks << module_item.module_name
+
+        unless module_item.podspec_path
+          CocoaPods::Yaml.log.warn("读取#{module_item.module_name}的podspec路径为空，请发送Podfile.lock文件联系开发者修复")
+          next
+        end
+
+        podspec_content = Util.get_podspec_content(module_item.podspec_path)
+
+        unless podspec_content
+          next
+        end
+
+        update_dep_frameworks(module_item.frameworks, podspec_content)
+
+        subspec_content = podspec_content["subspecs"]
+        if subspec_content and subspec_content.class == Array
+          subspec_content.each { |json_content|
+            update_dep_frameworks(module_item.frameworks, json_content)
+          }
+        end
+      end
+
+    end
+
+    def update_dep_frameworks(item_frameworks, json_content)
+      vendor_frameworks = json_content["vendored_frameworks"]
+      unless vendor_frameworks
+        ios = json_content["ios"]
+        if ios and ios.class == Hash
+          vendor_frameworks = ios["vendored_frameworks"]
+        end
+      end
+
+      if vendor_frameworks
+        if vendor_frameworks.class == Array
+          vendor_frameworks.each do |vendor_framework|
+            frameworks = deal_frameworks(vendor_framework)
+            if frameworks != "*"
+              item_frameworks << frameworks
+            end
+          end
+        elsif vendor_frameworks.class == String
+          frameworks = deal_frameworks(vendor_frameworks)
+          if frameworks != "*"
+            item_frameworks << frameworks
+          end
+        end
+      end
+    end
+
+    def deal_frameworks(frameworks)
+      # "frameworks/WCDB/WCDB.framework",
+      # "openssl.xcframework"
+      temp_array = frameworks.split("/")
+      result = temp_array.last
+      result = result.gsub(".xcframework","")
+      result.gsub(".framework", "")
+    end
+
+  end
+end