podfileDep 2.3.6 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b141be5a2d0872d97b87f3afbd0549bf6d65146f66d665432a71f82ec5da405
-  data.tar.gz: bdd4ee72216e8929dad9c09c0bb79d487b3dfd3805026d44efbad9c2740e633b
+  metadata.gz: 90b91a2988e18202add645f9dfb02623d018854b09ed5b3e1c7cfe52ca463fba
+  data.tar.gz: 1a7f61c0e7d35282204b055e3580bf4d78894fc6525a3b1f5d59bfea7d4f95d4
 SHA512:
-  metadata.gz: 8a0e1e6c178434c745cb3aece459458fe770ec2da2ca8e3d4efa742706f6078d5584232a94f6d22bc7d95bb8498e3eac4e97cb738767343f5be50690f89e5997
-  data.tar.gz: 0d2cdac871d2c5ef04c13e6606bea7498a5b2d1e21662ede1ffb2abf088712d2bd2041e9eedf81a3cbab54d28976432cda1711db25dfddc88338f79ea465627c
+  metadata.gz: b6d370629f905be0397b4e76f2c2198b800a8e7868882d1436ed3a8a9aa19c57d3ed0a775ce1947e9e8f345cc6f2a018fc9d30c4264d966b87da80bca97f5bed
+  data.tar.gz: dccea04f95d9d9d06db5a22424ebf02f360a465b18f2e4a07aa05af32e3bbc2423dc34b429b360acdab81c5abdd1a878ba2578ee3b32f1c867f52dbdae9969d8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Released]
 
+### [2.4.1] - 2023-7-29
+- 依赖库关系检查特殊问题修复
+
+### [2.4.0] - 2023-7-29
+- 依赖库关系检查
+
 ### [2.3.6] - 2023-7-25
 - 彩色打印
 

data/lib/cocoapods_plugin.rb

@@ -1,11 +1,12 @@
 require 'cocoapods'
 require_relative 'podfileDep/command/quick'
 require_relative 'podfileDep/check/project'
-require_relative 'podfileDep/check/dep'
+require_relative 'podfileDep/check/podspec'
 require_relative 'podfileDep/modify/modify_code'
 require_relative 'podfileDep/reference/project'
 require_relative 'podfileDep/indirect/indirect'
 require_relative 'podfileDep/reference/unused'
+require_relative 'podfileDep/check/import'
 
 # 注册插件
 module CocoapodsPlugin
@@ -26,13 +27,16 @@ module CocoapodsPlugin
   # end
 
   Pod::HooksManager.register('podfileDep', :post_install) do |context|
-    # 检查依赖库
-    # Dep::DepChecker.dep_check
 
     project = Xcodeproj::XCodeProject.new
 
     # 检查import
-    project.check_import
+    checker1 = Xcodeproj::ImportChecker.new(project)
+    checker1.check_import
+
+    # 检查podspec
+    checker2 = Xcodeproj::PodspecChecker.new(project)
+    checker2.check_podspec
 
     # 代码文件处理
     ModifyCode::Modify.modify_fb

data/lib/podfileDep/check/import.rb

@@ -1,159 +1,76 @@
-# require 'pathname'
-# require 'yaml'
-# require_relative '../constants'
-# require_relative 'module'
-# require_relative 'item'
-# require_relative 'xcodeproj'
-#
-# module Import
-#   class ImportManager
-#
-#     # 检查import规范
-#     def self.import_check
-#       puts "\nimport规范检查中..."
-#       start = (Time.now.to_f * 1000).to_i
-#
-#       project_manager = XCProject::XcodeprojManager.share_manager
-#
-#       # 获取需要检查的模块名和路径
-#       modules = project_manager.get_development_module
-#
-#       # 获取Pods和本地依赖库的 组件名和包含的头文件列表 map类型
-#       module_headers = project_manager.get_installed_headers_module
-#
-#       # 计数
-#       check_count = 0
-#
-#       # 遍历需要被检查的模块
-#       modules.each_value { |module_item|
-#
-#         # 某个模块从代码文件里读取的双引号依赖库 #import "XX/XX.h"
-#         import_item_map = {}
-#
-#         #头文件的文件名
-#         header_file_names = []
-#
-#         module_item.source_files.each { |source_file|
-#
-#           header_file_name = File.basename(source_file)
-#           if header_file_name.end_with?(".h") or header_file_name.end_with?(".hpp")  or header_file_name.end_with?(".pch")
-#             header_file_names << header_file_name
-#           end
-#
-#           self.update_import_dot_item_map(source_file, module_item, import_item_map)
-#
-#           check_count += 1
-#         }
-#
-#         if import_item_map.size == 0 and header_file_names.size == 0
-#           next
-#         end
-#
-#         messages = []
-#         import_item_map.each {|key, value| #key是 xxx.h value是{ImportItem:}
-#
-#           # 当前仓库的文件已包含
-#           if header_file_names.include?(key)
-#             next
-#           end
-#
-#           # 是否是导入的系统lib
-#           if self.check_sys_libary(key)
-#             next
-#           end
-#
-#           search_module_name = self.get_module_name(module_headers, key)
-#
-#           unless  search_module_name
-#             next
-#           end
-#
-#           messages << "#{value.file_name} 第#{value.line_index}行 #{value.import_name} => #import <#{search_module_name}/#{value.pod}>"
-#
-#         }
-#
-#         if messages.size >0
-#           puts "⚠️  组件#{module_item.module_name}存在以下情况, 请检查:"
-#           puts messages
-#           puts "\n"
-#         end
-#
-#       }
-#
-#       duration = ((Time.now.to_f * 1000).to_i - start)*0.001
-#       puts "import规范检查完毕! 共检查#{modules.size.to_s}个组件(#{check_count}个文件) 耗时:#{duration.round(2)}秒"
-#     end
-#
-#     # 获取某个文件内对应类型的import "XXX.h"
-#     def self.update_import_dot_item_map(file_path, module_name, import_item_map)
-#       if File.directory?(file_path)
-#         return
-#       end
-#
-#       line_array = IO.readlines(file_path)
-#       line_array.each_with_index { |line, index|
-#         line = line.gsub(" ", "")
-#         unless line.start_with?("#import\"")
-#           next
-#         end
-#
-#         if line.start_with?("@implementation")
-#           break
-#         end
-#
-#         line_split_array = line.split("\"")
-#         if line_split_array.size <= 1
-#           next
-#         end
-#
-#         import_name = "#{line_split_array[0]}\"#{line_split_array[1]}\"" # import"XXX.h" 或import"XXX.AAA.h" 防止后边有其他内容
-#
-#         # 特殊处理
-#         if import_name == "#import\"NBSAppAgent.h\""
-#           next
-#         end
-#
-#         podfile = import_name
-#         podfile = podfile.gsub("#import\"", "")
-#         podfile = podfile.gsub("\"", "") # 变成 XX.h
-#
-#         # 已经包含
-#         if import_item_map[podfile]
-#           next
-#         end
-#         pre_index = index-1 < 0 ? 0 : index-1
-#         pre_line = line_array[pre_index]
-#         pre_line = pre_line.gsub(" ", "").gsub("\n", "")
-#         if pre_line.start_with?("#if") or pre_line == "#else"
-#           next
-#         end
-#
-#         file_name = File.basename(file_path)
-#         line_index = index+1
-#
-#         import_item_map[podfile] = ImportItem.new(import_name, module_name, file_name, line_index, podfile)
-#
-#       }
-#     end
-#
-#     # 根据文件名反查出属于哪个组件
-#     def self.get_module_name(module_headers, file_name)
-#       module_headers.each do |module_name,module_item|
-#         module_item.source_files.each {|source_file|
-#           if source_file.basename.to_s == file_name
-#             return module_name
-#           end
-#         }
-#       end
-#       return nil
-#     end
-#
-#     # 获取某库是否是系统级的依赖库
-#     def self.check_sys_libary(name)
-#       name = name.gsub(".h", "")
-#       libs = Constants::LIBLIBARYS
-#       return libs.include?(name)
-#     end
-#
-#   end
-# end
+require_relative 'project'
+
+module Xcodeproj
+  class ImportChecker
+
+    # @return [XCodeProject]
+    attr_accessor :project
+
+    # @param project::[XCodeProject]
+    def initialize(project)
+      @project = project
+    end
+
+    # 检查import规范
+    def check_import
+      puts "import检查中..."
+      start = (Time.now.to_f * 1000).to_i
+      module_count = 0
+      file_count = 0
+
+      project.module_items.each do |module_name, module_item|
+        unless module_item.is_development_module
+          next
+        end
+        module_count += 1
+
+        messages = []
+
+        did_check_imports = {}
+        module_item.init_import_info
+
+        module_item.import_items.each do |import_item|
+          file_count += 1
+          did_check_import = did_check_imports[import_item.import_file_name]
+          if did_check_import
+            next
+          end
+          need_module_item = project.module_items[import_item.module_name]
+          real_path = need_module_item.header_files[import_item.import_file_name]
+          did_check_imports[import_item.import_file_name] = !!(real_path)
+          unless real_path
+            # 去查找所属模块
+            expect_module_name = find_module_with_header_file(import_item.import_file_name)
+            if expect_module_name
+              messages << "#{import_item.file_path.basename} 第#{import_item.line_index}行 #{import_item.import_name} => #import <#{expect_module_name}/#{import_item.import_file_name}>"
+            end
+          end
+        end
+
+        if messages.size >0
+          puts "组件#{module_item.module_name}存在以下情况, 请检查:".yellow
+          puts messages
+          puts "\n"
+        end
+
+      end
+
+      duration = ((Time.now.to_f * 1000).to_i - start)*0.001
+      puts "import检查完毕! 共检查#{module_count}个组件(#{file_count}个import) 耗时:#{duration.round(2)}秒"
+    end
+
+    private
+    # 根据头文件名查找所属组件
+    # @return [String, nil]
+    def find_module_with_header_file(header_file_name)
+      project.module_items.each do |module_name, module_item|
+        file_path =  module_item.header_files[header_file_name]
+        if file_path
+          return module_item.module_name
+        end
+      end
+      nil
+    end
+
+  end
+end

data/lib/podfileDep/check/item.rb

@@ -1,11 +1,204 @@
 
-class ImportItem
-  attr_reader :import_name, :module_item, :file_name, :line_index, :pod
-  def initialize(import_name, module_item, file_name, line_index, pod)
-    @import_name = import_name
-    @module_item = module_item
-    @file_name = file_name
-    @line_index = line_index
-    @pod = pod
+module Xcodeproj
+  class ImportItem
+    attr_accessor :import_name
+    attr_accessor :module_name
+    attr_accessor :file_path
+    attr_accessor :import_file_name
+    attr_accessor :line_index
+    attr_accessor :belong_module
+    def initialize
+      @import_name = nil
+      @module_name = nil
+      @file_path = nil
+      @import_file_name = nil
+      @line_index = nil
+      @belong_module = nil
+    end
+
+  end
+
+  class ModuleItem
+
+    public
+    # 组名名
+    attr_accessor :module_name
+
+    # 组件路径
+    attr_accessor :module_path
+
+    # podspec路径
+    attr_accessor :podspec_path
+
+    # 组件目录的所有被引用的文件数组
+    attr_accessor :header_files
+
+    # 组件目录的所有被引用的文件数组
+    attr_accessor :source_files
+
+    # 是否是开发模块
+    attr_accessor :is_development_module
+
+    # [ImportItem]
+    attr_accessor :import_items
+
+    # [ImportItem]
+    attr_accessor :absolute_import_items
+
+    # [String]
+    attr_accessor :frameworks
+
+    def initialize(module_name)
+      @module_name = module_name
+      @module_path = nil
+      @podspec_path = nil
+      @header_files = {}
+      @source_files = {}
+      @import_items = []
+      @absolute_import_items = []
+      @is_development_module = false
+      @frameworks = []
+    end
+
+    # 生成 import <XX/YY.h>的信息
+    # 生成 include <XX/YY.h>的信息
+    def init_absolute_import_info
+      source_files.each_value do |source_file_path|
+        if File.directory?(source_file_path)
+          next
+        end
+
+        line_array = IO.readlines(source_file_path)
+        line_array.each_with_index { |line, line_index|
+          line = line.gsub(" ", "")
+
+          # 处理特殊情况
+          if line.start_with?("#import\"NBSAppAgent.h\"")
+            line = "#import<tingyunApp/NBSAppAgent.h>"
+          end
+
+          if not line.start_with?("#import<") and not line.start_with?("#include<")
+            next
+          end
+
+          if line.start_with?("@implementation")
+            break
+          end
+
+          # 前一行的内容 这里不是检测，则不需要
+          pre_line = ""
+
+          import_item = other_module_import(line, source_file_path, line_index, @module_name, pre_line)
+          if import_item
+            absolute_import_items << import_item
+          end
+        }
+      end
+
+      absolute_import_items
+    end
+
+    # 生成 import "XXX.h"的信息
+    def init_import_info
+      source_files.each_value do |source_file_path|
+        if File.directory?(source_file_path)
+          next
+        end
+
+        line_array = IO.readlines(source_file_path)
+        line_array.each_with_index { |line, line_index|
+          line = line.gsub(" ", "")
+
+          unless line.start_with?("#import")
+            next
+          end
+
+          if line.start_with?("@implementation")
+            break
+          end
+
+          # 前一行的内容
+          pre_index = line_index-1 < 0 ? 0 : line_index-1
+          pre_line = line_array[pre_index]
+
+          if line.start_with?("#import\"") #本组件
+            import_item = own_module_import(line, source_file_path, line_index, @module_name, pre_line)
+            if import_item
+              import_items << import_item
+            end
+          elsif line.start_with?("#import<") #其他组件
+
+          end
+
+        }
+      end
+
+      import_items
+    end
+
+    private
+    # 生成自己模块的import item
+    # @param line 以 import" 开头
+    def own_module_import(line, file_path, line_index, module_name, pre_line)
+      line_split_array = line.split("\"")
+      if line_split_array.size <= 1
+        return nil
+      end
+
+      import_content = "#{line_split_array[0]}\"#{line_split_array[1]}\"" # import"XXX.h" 或import"XXX.AAA.h" 防止后边有其他内容
+
+      # 特殊处理
+      if import_content == "#import\"NBSAppAgent.h\""
+        return nil
+      end
+
+      pre_line = pre_line.gsub(" ", "").gsub("\n", "")
+      if pre_line.start_with?("#if") or pre_line == "#else"
+        return nil
+      end
+
+      import_file_name = import_content
+      import_file_name = import_file_name.gsub("#import\"", "")
+      import_file_name = import_file_name.gsub("\"", "") # 变成 XX.h
+
+
+      import_item = ImportItem.new # (import_name, module_name, file_name, line_index, podfile)
+      import_item.import_name = import_content.gsub("#import\"", "#import \"")
+      import_item.module_name = module_name
+      import_item.file_path = file_path
+      import_item.import_file_name = import_file_name
+      import_item.line_index = line_index + 1
+
+      import_item
+    end
+
+
+    def other_module_import(line, file_path, line_index, module_name, pre_line)
+      line = line.gsub("\n","")
+      line_split_array = line.split("/") #import<XX/YY.h> 或 #import<XX/YY/ZZ.h>
+      if line_split_array.size <= 1
+        return nil
+      end
+
+      pre_line = pre_line.gsub(" ", "").gsub("\n", "")
+      if pre_line.start_with?("#if") or pre_line == "#else"
+        return nil
+      end
+
+      import_file_name = line_split_array[line_split_array.size-1].gsub(">", "")
+      belong_module =  line_split_array[0].gsub("#import<", "").gsub("#include<", "")
+      import_name = line.gsub("#import<", "#import <").gsub("#include<", "#include <")
+
+      import_item = ImportItem.new # (import_name, module_name, file_name, line_index, podfile)
+      import_item.import_name = import_name
+      import_item.module_name = module_name
+      import_item.file_path = file_path
+      import_item.import_file_name = import_file_name
+      import_item.line_index = line_index + 1
+      import_item.belong_module = belong_module
+
+      import_item
+
+    end
   end
 end

data/lib/podfileDep/check/podspec.rb

@@ -0,0 +1,175 @@
+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
+      puts "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
+        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)
+
+        if loss.size >0
+          puts "组件#{module_item.module_name}可能缺少以下依赖, 请检查:".yellow
+          loss.each do |name|
+            puts "  s.dependency '#{name}'"
+          end
+        end
+
+        if unused.size >0
+          puts "组件#{module_item.module_name}可能未使用以下依赖, 请检查:".yellow
+          puts unused
+        end
+
+      end
+
+      duration = ((Time.now.to_f * 1000).to_i - start)*0.001
+      puts "podspec检查完毕! 共检查#{module_count}个组件 耗时:#{duration.round(2)}秒"
+    end
+
+    private
+
+    # 获取缺失的模块
+    # @param need_modules::[String]
+    # @param podspec_modules::[Hash{String => [String]}]
+    def loss_modules(need_modules, podspec_modules)
+      # 展开
+      temp_array = []
+      podspec_modules.each do |podspec_module|
+        podspec_modules.values.each do |array|
+          temp_array = temp_array | array
+        end
+      end
+
+      res = []
+      need_modules.each do |name|
+        unless temp_array.include?(name)
+          res << name
+        end
+      end
+      res
+    end
+
+    # 获取多余的模块
+    # @param need_modules::[String]
+    # @param podspec_modules::[Hash{String => [String]}]
+    def unused_modules(need_modules, podspec_modules)
+      res = []
+      podspec_modules.each do |dep_name, array|
+        contain = false
+        array.each do |vendor|
+          if need_modules.include?(vendor)
+            contain = true
+          end
+        end
+
+        unless contain
+          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
+
+        # 过滤未被安装的依赖库
+        unless module_is_installed(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)
+
+      podspec_dependencies = podspec_content["dependencies"] ? podspec_content["dependencies"].keys : []
+
+      # 子模块
+      subspecs = podspec_content["subspecs"]
+      if subspecs and subspecs.class == Array
+        subspecs.each do |subspec|
+          subspec_deps = subspec["dependencies"] ? subspec["dependencies"].keys : []
+          podspec_dependencies = podspec_dependencies + subspec_deps
+        end
+      end
+
+      # 转成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
+
+    # 判断某个库是否被安装
+    def module_is_installed(module_name)
+      all = project.lock_content["SPEC CHECKSUMS"]
+      unless all
+        return false
+      end
+      !!all[module_name]
+    end
+    # 系统级的依赖库
+    # @return [String]
+    def system_modules
+      MyConstants::LIBLIBARYS + MyConstants::FRAMEWORKS
+    end
+  end
+end