podfileDep 1.1.4 → 2.0.0

data/lib/podfileDep/check/dep.rb

@@ -0,0 +1,183 @@
+require 'pathname'
+require 'yaml'
+require_relative '../podfilelock'
+require_relative '../constants'
+require_relative 'module'
+require_relative 'item'
+require_relative 'xcodeproj'
+
+module Dep
+  class DepChecker
+
+    # 检查缺少的或着多的依赖
+    def self.dep_check
+      puts "\n依赖库关系检查中..."
+      start = (Time.now.to_f * 1000).to_i
+
+      podfile_lock_manager = PodfileLock::PodfileLockManager
+      module_manager = ModuleModule::ModuleManager.share_instance
+      project_manager = XCProject::XcodeprojManager.share_manager
+
+      # podfile.lock的内容
+      lock_content = podfile_lock_manager.podfile_lock_content
+
+      # 获取需要检查的模块名和路径
+      modules = project_manager.get_development_module
+
+      # 获取所有已安装的依赖库
+      installed_deps = module_manager.get_installed_deps(lock_content)
+
+      # 计数
+      check_count = 0
+
+      # 遍历需要被检查的模块
+      modules.each { |module_name, module_item|
+
+        #组件的的真实依赖包括间接依赖 依据podfile.lock递归读取
+        real_dependencies = module_manager.real_dependencies(module_name, lock_content)
+
+        substart = (Time.now.to_f * 1000).to_i
+        real_frameworks = self.module_frameworks(real_dependencies)
+        puts "#{module_name}打点0：#{((Time.now.to_f * 1000).to_i - substart).to_s}毫秒\n"
+        substart = (Time.now.to_f * 1000).to_i
+
+        #podspec写的直接依赖
+        podspec_dependencies = module_manager.podspec_dependencies(module_item.podspec_path)
+
+        # 某个模块从代码文件里读取的真实需要的依赖库 #import <XX/XX.h>
+        import_item_map = {}
+        module_item.source_files.each { |source_file|
+          self.update_import_item_map(source_file, module_name, import_item_map)
+          check_count += 1
+        }
+
+        if import_item_map.size == 0 and real_dependencies.size == 0
+          next
+        end
+
+        # real_dependencies指的是根据组件podspec的写法 解析出来的依赖库
+        # import_item_map指的是根据代码文件解析出来的依赖库
+        loss = []
+        import_item_map.each_key {|key|
+          if key != module_name
+            did_loss = true
+
+            real_frameworks.each { |dep, frameworks|
+              frameworks.each {|framework|
+                if key == framework
+                  did_loss = false
+                  break
+                end
+              }
+            }
+
+            if did_loss
+              loss << "#{key}"
+            end
+
+          end
+        }
+
+        puts "#{module_name}打点1：#{((Time.now.to_f * 1000).to_i - substart).to_s}毫秒\n"
+        substart = (Time.now.to_f * 1000).to_i
+
+        unused = []
+        real_frameworks.each { |dep, frameworks|
+          use = false
+          frameworks.each{|framework|
+            if import_item_map.keys.include?(framework)
+              use = true
+              break
+            end
+          }
+          if not use and podspec_dependencies.include?(dep)
+            unused << "# s.dependency '#{dep}'"
+          end
+        }
+
+        if loss.size >0
+          puts "⚠️  [#{module_name}] 请到#{module_name}.podspec文件中添加缺少的依赖库, 如下:"
+          puts loss
+          puts "\n"
+        end
+
+        if unused.size >0
+          puts "⚠️  [#{module_name}] 请到#{module_name}.podspec文件中移除未被引用的依赖库, 如下:"
+          puts unused
+          puts "\n"
+        end
+
+        puts "#{module_name}打点2：#{((Time.now.to_f * 1000).to_i - substart).to_s}毫秒\n"
+      }
+
+      duration = ((Time.now.to_f * 1000).to_i - start)*0.001
+      puts "依赖库关系检查完毕! 共检查#{modules.size.to_s}个组件(#{check_count}个文件) 耗时:#{duration.round(2)}秒"
+    end
+
+    # 将某个库的所有依赖转化为其对应的frameworks
+    def self.module_frameworks(dependencies)
+      project_manager = XCProject::XcodeprojManager.share_manager
+      result_map = {}
+      dependencies.each do |dependency|
+        frameworks = project_manager.frameworks_with_module_name(dependency)
+        result_map[dependency] = frameworks
+      end
+      result_map
+    end
+
+    # 获取某个文件内对应类型的import <XX/XX>
+    def self.update_import_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(" ", "")
+        if not line.start_with?("#import<") and not line.start_with?("#include<")
+          next
+        end
+
+        line_split_array = line.split(">")
+        if line_split_array.size == 0
+          next
+        end
+
+        import_name = line_split_array[0]+">" # #import <XX/XX.h> 或者 #import <XX.h> 防止后边有其他的内容
+        if not import_name.include?(".h") and not import_name.include?(".H")
+          next
+        end
+        import_array = import_name.split("/")
+        if line_split_array.size == 0
+          next
+        end
+
+        pod = import_array[0].gsub("#import<", "").gsub("#include<", "")
+        pod = pod.gsub(".h>", "")
+        pod = pod.gsub(".H>", "")
+
+        # 已经包含
+        if import_item_map[pod]
+          next
+        end
+
+        # 系统级依赖库
+        if self.system_deps.include?(pod)
+          next
+        end
+
+        file_name = File.basename(file_path)
+        line_index = index+1
+
+        import_item_map[pod] = ImportItem.new(import_name, module_name, file_name, line_index, pod)
+
+      }
+    end
+
+    # 系统级的依赖库
+    def self.system_deps
+      return Constants::LIBLIBARYS + Constants::FRAMEWORKS
+    end
+
+  end
+end

data/lib/podfileDep/check/import.rb

@@ -0,0 +1,159 @@
+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

data/lib/podfileDep/check/item.rb

@@ -0,0 +1,11 @@
+
+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
+  end
+end

data/lib/podfileDep/check/module.rb

@@ -0,0 +1,178 @@
+require 'pathname'
+require 'yaml'
+require 'cocoapods'
+require 'xcodeproj'
+require_relative '../constants'
+
+module ModuleModule
+
+  class ModuleDepObject
+    def initialize(module_name)
+      @module_name = module_name
+      @dependencies = []
+      @dependencies_expanded = false
+    end
+
+    # 组件名
+    attr_reader :module_name
+
+    # 组件所引用的依赖库
+    attr_reader :dependencies
+
+    # 组件的依赖是否被全部展开
+    attr_reader :dependencies_expanded
+
+
+    # 添加一个依赖库
+    def add_dependency(dependency)
+      self.dependencies << dependency
+    end
+
+    def did_expanded
+      @dependencies_expanded = true
+    end
+
+  end
+
+  class ModuleManager
+
+    # 缓存某个的依赖库
+    # {{"module_nameA":ModuleDepObject,{"module_nameB":ModuleDepObject}
+    attr_reader :all_module_dependencies
+
+    def initialize
+      @all_module_dependencies = {}
+    end
+    # 单例方法
+    @@instance = ModuleManager.new
+
+    # 获取单例
+    def self.share_instance
+      @@instance
+    end
+
+    private_class_method :new
+
+    def real_dependencies(module_name, lock_content)
+
+      lock_dependencies = lock_content["PODS"]
+
+      module_dep = ModuleDepObject.new(module_name)
+
+      # 可能是取的缓存 所以必须赋值
+      module_dep = self.get_module_dep(lock_dependencies, module_dep)
+
+      module_dep.dependencies
+
+    end
+
+    # 根据podfile.lock里内容递归获取某个库的依赖库
+    @private
+    def get_module_dep(lock_dependencies, module_dep)
+
+      module_dep_cache = self.all_module_dependencies[module_dep.module_name]
+      if module_dep_cache&.dependencies_expanded
+        return module_dep_cache
+      end
+
+      # 找出当前组件的依赖
+      lock_dependencies.each { |item|
+
+        item_name= item
+        if item.class == Hash
+          item_name = item.keys[0]
+        end
+
+        item_name = item_name.split(" (")[0]
+        item_name = item_name.split("/")[0] #解决子仓库的问题
+
+        # 非当前组件
+        if item_name != module_dep.module_name
+          next
+        end
+
+        # 当前组件无其他依赖
+        if item.class == String
+          break
+        end
+
+        # 当前组件有其他依赖
+        # item:{"A (99999)"=>["Masonry", "MJExtension"]
+        item.each {|name, child_names|
+          child_names.each { |child_name|
+            child_name = child_name.split(" (")[0]
+            child_name = child_name.split("/")[0] #解决子仓库的问题
+
+            if item_name == child_name #解决item_name = AFNetworking child_name=AFNetworking/NSURLSession
+              next
+            end
+
+            # 当前库的依赖加进去
+            unless module_dep.dependencies.include?(child_name)
+              module_dep.dependencies << child_name
+            end
+
+            # 当前库的依赖的子依赖
+            child = ModuleDepObject.new(child_name)
+            child_dep = self.get_module_dep(lock_dependencies, child)
+
+            child_dep.did_expanded
+            self.all_module_dependencies[child_dep.module_name] = child_dep
+
+            child_dep.dependencies.each { |sun_name|
+              # 孙子依赖加进去
+              unless module_dep.dependencies.include?(sun_name)
+                module_dep.dependencies << sun_name
+              end
+            }
+          }
+        }
+      }
+
+      module_dep.did_expanded
+      self.all_module_dependencies[module_dep.module_name] = module_dep
+      module_dep
+    end
+
+    # 获取某个库的podspec的直接依赖
+    def podspec_dependencies(podspec_path)
+
+      podspec_json_path = podspec_path.to_s.end_with?(".podspec.json") ? podspec_path : nil
+
+      podspec_content = nil
+      if podspec_json_path and File.exist?(podspec_json_path)
+        json = File.read(podspec_json_path)
+        podspec_content = JSON.parse(json)
+      elsif podspec_path and File.exist?(podspec_path)
+        json = self.get_podspec_content(podspec_path)
+        podspec_content = JSON.parse(json)
+      end
+
+      podspec_content["dependencies"] ? podspec_content["dependencies"].keys : []
+
+    end
+
+    # 获取已安装的依赖库
+    def get_installed_deps(lock_dependencies)
+      lock_dependencies["SPEC CHECKSUMS"] ? lock_dependencies["SPEC CHECKSUMS"].keys : {}
+    end
+
+    # 根据podspec路径把podspec转为json
+    @private
+    def get_podspec_content(podspec_path)
+
+      spec_contents = File.open(podspec_path, 'r:utf-8', &:read)
+
+      if spec_contents.respond_to?(:encoding) && spec_contents.encoding.name != 'UTF-8'
+        spec_contents.encode!('UTF-8')
+      end
+
+      path = Pathname.new(podspec_path)
+
+      spec = ::Pod._eval_podspec(spec_contents, path)
+
+      spec.to_json
+    end
+
+  end
+end