podfileDep 2.1.6 → 2.2.0

data/lib/podfileDep/yaml/yaml_dep.rb

@@ -1,97 +1,51 @@
+require_relative 'yaml_pod'
 require_relative '../version'
 require_relative '../constants'
 require_relative '../check/xcodeproj'
 
 module Pod
+  class YamlDep
 
-  class YamlRely
-    attr_accessor :module_name, :pod, :subspecs, :version, :git, :tag, :branch, :podspec, :configurations, :path, :inhibit_warnings, :source, :binary
-    def initialize(pod)
-      @pod = pod
-    end
-
-    def option
-      result = {:configurations => self.configurations, :inhibit_warnings => self.inhibit_warnings, :subspecs => self.subspecs}
-      if self.path #路径依赖
-        result[:path] = self.path
-      elsif self.podspec #podspec引用
-        result[:podspec] = self.podspec
-      elsif self.version #版本号依赖
-        result[:source] = self.source
-      elsif self.git #git仓库引用
-        result[:git] = self.git
-        if self.tag #tag引用
-          result[:tag] = self.tag
-        else #分支引用 或着未指定分支 也按分支引用
-          result[:branch] = self.branch
-        end
-      end
-      result
-    end
+    # 主工程target列表
+    # @return [String]
+    attr_accessor :targets
 
-  end
-  class YamlManager
+    # 主工程里所有yaml文件定义的依赖
+    # @return {String, {String, [Pod:YamlPod]}}
+    attr_accessor :yaml_deps
 
-    attr_accessor :local_yaml_deps
+    # 解析后生成主工程里所有yaml文件定义的依赖
+    # @return {String, [Pod:YamlPod]}
+    attr_accessor :all_deps
 
-    def initialize
-      @local_yaml_deps = []
-    end
+    # 所有的targets对应的依赖库列表
+    # @return {String, [Pod:YamlPod]}
+    attr_accessor :targets_dependencies
 
-    # 单例方法
-    @@instance = YamlManager.new
+    attr_accessor :podfile_local_yaml
+    attr_accessor :podfile_module_yaml
+    attr_accessor :podfile_third_party_yaml
 
-    # 获取单例
-    def self.share_manager
-      @@instance
+    def initialize
+      super
+      @targets = []
+      @yaml_deps = {}
+      @all_deps = {}
+      @targets_dependencies = {}
+      @podfile_local_yaml = Constants::PODFILE_LOCAL_YAML
+      @podfile_module_yaml = Constants::PODFILE_MODULE_YAML
+      @podfile_third_party_yaml = Constants::PODFILE_THIRD_PARTY_YAML
     end
 
-    private_class_method :new
-
-    def analysis_yaml(podfile, old)
-
-      # 获取targets列表
-      project_manager = XCProject::XcodeprojManager.share_manager
-
-      targets = project_manager.get_app_targets
-
-      podfile_local_yaml = Constants::PODFILE_LOCAL_YAML
-      podfile_module_yaml = Constants::PODFILE_MODULE_YAML
-      podfile_third_party_yaml = Constants::PODFILE_THIRD_PARTY_YAML
-
-      # 检查参数
-      check_param(targets)
-
-      # 生成YAML文件
-      generate_local_yaml(podfile_local_yaml)
-      generate_module_yaml(podfile_module_yaml, "# 企业内部组件")
-      generate_module_yaml(podfile_third_party_yaml, "# 第三方维护组件")
-
-      # 读取yaml依赖
-      yaml_dependencies = {}
-      read_yaml_dependencies(podfile_third_party_yaml,false ,yaml_dependencies)
-      read_yaml_dependencies(podfile_module_yaml,false ,yaml_dependencies)
-      read_yaml_dependencies(podfile_local_yaml,true ,yaml_dependencies)
-
-      # 打印依赖
-      print_dependencies(yaml_dependencies)
-
-      # 为所有target生成依赖
-      targets_dependencies = {}
-      update_target_dependencies(targets, yaml_dependencies, targets_dependencies)
-
-      # 兼容老方式
-      if old
-        return targets_dependencies
-      end
+    def install_yaml_dep(podfile)
+      analysis_yaml_dep
 
-      # 存储所有依赖
-      store_dependencies(targets_dependencies, podfile) do|name|
+      install_dependencies(targets_dependencies, podfile) do|name|
         yield(name) if block_given?
       end
     end
 
-    def store_dependencies(targets, podfile)
+    def install_dependencies(targets, podfile)
       # 存储所有的依赖
       targets.each { |name, dependencies|
         podfile.target name do
@@ -109,165 +63,113 @@ module Pod
       targets
     end
 
-    # 检查方法调用的参数
-    def check_param(targets)
-      msg = "❌ 参数需要填写target名字, 参数类型是字符串格式的数组。例如[\"test1\", \"test2\"]"
-      unless targets.class == Array
-        puts msg
-        exit!
-      end
+    # 获取非扩展target定义在yaml文件的依赖
+    # @return targets_dependencies
+    def analysis_yaml_dep
+      init_main_targets
+      generate_yaml
+      read_yaml_deps
+      analyzing_yaml_deps
+      print_yaml_deps
+      resolve_targets_deps
+    end
 
+    def resolve_targets_deps
       targets.each { |target|
-        unless target.class == String
-          puts msg
-          exit!
-        end
+        targets_dependencies[target] = all_deps.values
       }
+      targets_dependencies
     end
 
-    # 校验yaml文件写法是否正确
-    def yaml_content(yaml_name)
-      unless File.exist?(yaml_name)
-        puts "文件不存在:"+yaml_name
-        return nil
-      end
-
-      begin
-        yaml_content = YAML.load_file(yaml_name)
-      rescue Exception => e
-        puts e
-        puts yaml_name+'文件解析异常, 请检查 ⬆️'
-        exit!
-      end
+    # 读取yaml文件的依赖
+    def read_yaml_deps
+      read_yaml_deps_file(podfile_third_party_yaml)
+      read_yaml_deps_file(podfile_module_yaml)
+      read_yaml_deps_file(podfile_local_yaml)
+    end
 
-      prefix_message = "解析:"+yaml_name + "=> "
-      unless yaml_content.class == Hash
-        puts "#{prefix_message}共0个依赖(文件不是keyValue形式)"
-        return nil
-      end
+    # 解析所有的依赖
+    def analyzing_yaml_deps
+      yaml_deps.each do |yaml_name, deps|
+        if yaml_name == podfile_local_yaml
+          clean = false #记录只能清一次就够了
+          deps.each { |name, dep|
+            real_name = name.split("/")[0]
+            # 有子模块 把之前的全部清空
+            if Array(dep.subspecs).size > 0 or Array(dep.configurations).size > 0
+              unless clean
+                all_deps.delete_if{|pod_name|
+                  real_pod_name = pod_name.split("/")[0]
+                  if real_pod_name == real_name
+                    puts "✅ #{pod_name}被#{yaml_name}覆盖"
+                  end
+                  real_pod_name == real_name
+                }
+                clean = true
+              end
+            end
 
-      unless yaml_content.key?('PODS')
-        puts "#{prefix_message}共0个依赖(文件内的key[PODS]不存在)"
-        return nil
-      end
+            if all_deps.has_key?(name)
+              puts "✅ #{name}被#{yaml_name}覆盖"
+            end
 
-      unless yaml_content['PODS'].class == Array
-        puts "#{prefix_message}共0个依赖(文件配置的依赖PODS下边不是数组或数组为空)"
-        return nil
-      end
+            all_deps[name] = dep
+          }
+        else
+          @all_deps.merge!(deps)
+        end
 
-      podfile_local_yaml = Constants::PODFILE_LOCAL_YAML
-      if yaml_name != podfile_local_yaml and (not yaml_content['SOURCE'] or yaml_content['SOURCE'].class != String)
-        puts "#{yaml_name}的SOURCE字段必须是字符串且不为空"
-        exit!
       end
+      all_deps
+    end
 
-      if yaml_name != podfile_local_yaml and (not yaml_content['BINARY_SOURCE'] or yaml_content['BINARY_SOURCE'].class != String)
-        puts "#{yaml_name}的BINARY_SOURCE字段必须是字符串且不为空"
-        exit!
-      end
+    def read_yaml_deps_file(yaml_name)
 
-      yaml_content
+      yaml_content = read_yaml_content(yaml_name)
 
-    end
+      unless yaml_content
+        return
+      end
 
-    # 读取yaml依赖
-    def read_yaml_dependencies(yaml_name, can_cover, yaml_dependencies)
+      if yaml_name != podfile_local_yaml
+        if not yaml_content["SOURCE"] or yaml_content["SOURCE"].class != String
+          puts "#{yaml_name}的SOURCE字段必须是字符串且不为空"
+          exit!
+        end
+        if yaml_name != podfile_local_yaml and not yaml_content["BINARY_SOURCE"] or yaml_content["BINARY_SOURCE"].class != String
+          puts "#{yaml_name}的BINARY_SOURCE字段必须是字符串且不为空"
+          exit!
+        end
+      end
 
-      # 检查写法
-      yaml_content = yaml_content(yaml_name)
+      unless yaml_content["PODS"]
+        puts "#{yaml_name}共0个依赖(文件内的key[PODS]不存在)"
+        return
+      end
 
-      unless yaml_content
+      if yaml_content["PODS"].class != Array
+        puts "#{yaml_name}共0个依赖(文件配置的依赖PODS项不是数组或数组为空)"
         return
       end
 
       # 读取默认源码source
-      default_source_source = nil
-      if yaml_content.key?('SOURCE') and yaml_content['SOURCE'].class == String
-        default_source_source = yaml_content['SOURCE']
-      end
+      default_source_source = yaml_content['SOURCE']
 
       # 读取默认二进制source
-      default_binary_source = nil
-      if yaml_content.key?('BINARY_SOURCE') and yaml_content['BINARY_SOURCE'].class == String
-        default_binary_source = yaml_content['BINARY_SOURCE']
-      end
+      default_binary_source = yaml_content['BINARY_SOURCE']
 
       # 依赖列表
       dependencies_pods = yaml_content['PODS']
-      puts "解析:#{yaml_name} => 共#{dependencies_pods.size.to_s}个依赖"
 
       # 当前yaml文件的组件名字 用来校验本文件内是否重复
       dependencies_name = []
 
+      yaml_dependencies = {}
+
       # 遍历依赖库列表
       dependencies_pods.each { |dependency|
 
-        # 不支持提醒
-        available_keys = %w[module pod subspecs path podspec version git tag branch configurations inhibit_warnings source binary]
-        dependency.each_key { |key|
-          unless available_keys.include?(key)
-            gem_name = "podfileDep"
-            puts "❌ #{yaml_name}: 当前#{gem_name}版本(#{PodfileDep::VERSION})不支持字段#{key}"
-            puts "请检查对应字段或尝试执行如下命令升级"
-            puts "gem uninstall #{gem_name} && gem install #{gem_name}"
-            exit!
-          end
-        }
-
-        # 校验字段
-        unless dependency['pod']
-          puts "#{yaml_name}: pod 字段(组件名字)必须存在,请检查:"
-          exit!
-        end
-
-        unless dependency['path'] or dependency['podspec'] or dependency['version'] or dependency['git'] or dependency['tag'] or dependency['branch']
-          puts "#{yaml_name} - #{dependency['pod']}: path/podspec/version/git/tag/branch 字段需至少有一个存在,请检查"
-          exit!
-        end
-
-        if dependency['tag'] and dependency['branch'] and not dependency['git']
-          puts "#{yaml_name} - #{dependency['pod']}: 请为此组件配置git字段"
-          exit!
-        end
-
-        #  检查数据类型
-        if dependency['configurations'] and dependency['configurations'].class != Array
-          puts "#{yaml_name} - #{dependency['pod']} - #{dependency['configurations']}: configurations字段必须是数组，例如:['Debug','Release']"
-          exit!
-        end
-
-        if dependency['subspecs'] and dependency['subspecs'].class != Array
-          puts "#{yaml_name} - #{dependency['pod']} - #{dependency['subspecs']}: subspecs字段必须是数组，例如:['A','B','C']"
-          exit!
-        end
-
-        # 校验自身文件重复
-        if dependencies_name.include?(dependency['pod'])
-          puts "❌ 发现#{yaml_name}内重复组件:#{dependency['pod']},请检查并删除重复依赖:"
-          exit!
-        else
-          dependencies_name << dependency['pod']
-        end
-        # 校验和总的依赖的重复
-        repeats = []
-        if yaml_dependencies.key?(dependency['pod']) and not can_cover
-          repeats << dependency['pod']
-        end
-        if repeats.size > 0
-          puts "❌ 发现重复组件如下,请检查并删除重复依赖:"
-          puts repeats
-          exit!
-        end
-
-        # 警告
-        podfile_local_yaml = Constants::PODFILE_LOCAL_YAML
-        if dependency['path'] and not can_cover
-          puts "⚠️  组件#{dependency['pod']}使用path依赖方式应该写在#{podfile_local_yaml}"
-        end
-        if dependency['podspec'] and not can_cover
-          puts "⚠️  组件#{dependency['pod']}使用podspec依赖方式应该写在#{podfile_local_yaml}"
-        end
+        check_pod(dependency, yaml_name, dependencies_name)
 
         # 默认值
         source = dependency['source']
@@ -276,36 +178,16 @@ module Pod
         end
         inhibit_warnings = dependency['inhibit_warnings'] ? !!dependency['inhibit_warnings'] : false
         binary = dependency['binary'] ? !!dependency['binary'] : true
-        version = (dependency['path'] or dependency['podspec']) ? nil :dependency['version']
-
-        # 记录
-        if yaml_name == Constants::PODFILE_LOCAL_YAML
-          self.local_yaml_deps << dependency['pod']
-        end
-
-        # subspecs的覆盖前 把之前展开的全部清空
-        if can_cover and Array(dependency['subspecs']).size > 0
-          pod_prefix = dependency['pod']
-          yaml_dependencies.delete_if{|key, value|
-            key.start_with?(pod_prefix)
-          }
-          puts "✅ #{dependency['pod']}被#{yaml_name}覆盖"
-        end
 
-        # 记录覆盖
-        if yaml_dependencies.key?(dependency['pod']) and can_cover
-          puts "✅ #{dependency['pod']}被#{yaml_name}覆盖"
-        end
-
-        need_expand = !!(Array(dependency['configurations']).size > 0 or can_cover)
-        if Array(dependency['subspecs']).size > 0 and need_expand
+        # configurations和subspecs cocoapods不能同时支持，所以要展开
+        if Array(dependency['subspecs']).size > 0 and Array(dependency['configurations']).size > 0
           dependency['subspecs'].each {|subspec|
-            dep = YamlRely.new(pod = "#{dependency['pod']}/#{subspec}")
+            dep = YamlPod.new(pod = "#{dependency['pod']}/#{subspec}")
             dep.module_name = dependency['module']
             dep.subspecs = nil
             dep.path = dependency['path']
             dep.podspec = dependency['podspec']
-            dep.version = version
+            dep.version = dependency['version']
             dep.git = dependency['git']
             dep.tag = dependency['tag']
             dep.branch = dependency['branch']
@@ -317,12 +199,12 @@ module Pod
           }
 
         else
-          dep = YamlRely.new(pod = dependency['pod'])
+          dep = YamlPod.new(pod = dependency['pod'])
           dep.module_name = dependency['module']
           dep.subspecs = dependency['subspecs']
           dep.path = dependency['path']
           dep.podspec = dependency['podspec']
-          dep.version = version
+          dep.version = dependency['version']
           dep.git = dependency['git']
           dep.tag = dependency['tag']
           dep.branch = dependency['branch']
@@ -334,24 +216,124 @@ module Pod
         end
       }
 
+      yaml_deps[yaml_name] = yaml_dependencies
+
+      yaml_dependencies
     end
 
-    # 生成传进来的target的依赖库列表
-    def update_target_dependencies(targets, yaml_dependencies, targets_dependencies)
-      temp_array = []
-      yaml_dependencies.each_value { |value|
-        temp_array << value
+    def check_pod(dependency, yaml_name, dependencies_name)
+      # 不支持提醒
+      available_keys = %w[module pod subspecs path podspec version git tag branch configurations inhibit_warnings source binary]
+      dependency.each_key { |key|
+        unless available_keys.include?(key)
+          gem_name = "podfileDep"
+          puts "❌ #{yaml_name}: 当前#{gem_name}版本(#{PodfileDep::VERSION})不支持字段#{key}"
+          puts "请检查对应字段或尝试执行如下命令升级"
+          puts "gem uninstall #{gem_name} && gem install #{gem_name}"
+          exit!
+        end
       }
 
-      targets.each { |target|
-        targets_dependencies[target] = temp_array
-      }
+      # 校验字段
+      unless dependency['pod']
+        puts "#{yaml_name}: pod 字段(组件名字)必须存在,请检查:"
+        exit!
+      end
+
+      current_type = nil
+      current_type = check_only_one_dep(dependency, "path", current_type, yaml_name)
+      current_type = check_only_one_dep(dependency, "podspec", current_type, yaml_name)
+      current_type = check_only_one_dep(dependency, "version", current_type, yaml_name)
+      current_type = check_only_one_dep(dependency, "tag", current_type, yaml_name)
+      current_type = check_only_one_dep(dependency, "branch", current_type, yaml_name)
+
+      unless current_type
+        puts "#{yaml_name} - #{dependency['pod']}: path/podspec/version/git/tag/branch 字段请指定其中一个"
+        exit!
+      end
+
+      unless dependency['git']
+        if dependency['tag']
+          puts "#{yaml_name} - #{dependency['pod']}: 你指定了tag，但未配置git地址，请为此组件配置git字段"
+          exit!
+        end
+        if dependency['branch']
+          puts "#{yaml_name} - #{dependency['pod']}: 你指定了branch，但未配置git地址，请为此组件配置git字段"
+          exit!
+        end
+      end
+
+      #  检查数据类型
+      if dependency['configurations'] and dependency['configurations'].class != Array
+        puts "#{yaml_name} - #{dependency['pod']} - #{dependency['configurations']}: configurations字段必须是数组，例如:['Debug','Release']"
+        exit!
+      end
+
+      if dependency['subspecs'] and dependency['subspecs'].class != Array
+        puts "#{yaml_name} - #{dependency['pod']} - #{dependency['subspecs']}: subspecs字段必须是数组，例如:['A','B','C']"
+        exit!
+      end
+
+      # 校验自身文件重复
+      if dependencies_name.include?(dependency['pod'])
+        puts "❌ 发现#{yaml_name}内重复组件:#{dependency['pod']},请检查并删除重复依赖:"
+        exit!
+      else
+        dependencies_name << dependency['pod']
+      end
+
+      # 警告
+      if dependency['path'] and yaml_name != podfile_local_yaml
+        warn "⚠️  组件#{dependency['pod']}使用path依赖方式应该写在#{podfile_local_yaml}"
+      end
+      if dependency['podspec'] and yaml_name != podfile_local_yaml
+        warn "⚠️  组件#{dependency['pod']}使用podspec依赖方式应该写在#{podfile_local_yaml}"
+      end
+
+    end
+
+    def check_only_one_dep(dependency, key, current_type, yaml_name)
+      if dependency[key]
+        if current_type
+          puts "#{yaml_name} - #{dependency['pod']}: #{current_type}字段和#{key}只能使用其中一个，请删除不需要的一个"
+          exit!
+        else
+          return key
+        end
+      end
+      current_type
+    end
+
+    def read_yaml_content(yaml_name)
+      unless File.exist?(yaml_name)
+        puts "文件不存在:"+yaml_name
+        return nil
+      end
+
+      begin
+        yaml_content = YAML.load_file(yaml_name)
+      rescue Exception => e
+        puts e
+        puts yaml_name+'文件解析异常, 请检查 ⬆️'
+        exit!
+      end
+
+      unless yaml_content.class == Hash
+        puts "#{yaml_name} => (文件不是keyValue形式)"
+        return nil
+      end
+
+      yaml_content
     end
 
-    def print_dependencies(yaml_dependencies)
-      puts "➡️  解析依赖总数共计:#{yaml_dependencies.size}个\n\n"
+    def print_yaml_deps
+      yaml_deps.each do |yaml_name, deps|
+        puts "读取#{yaml_name} => #{deps.size}个"
+      end
+      puts "➡️  解析后依赖总数共计:#{all_deps.size}个\n"
+
       puts '⬇️  打印依赖'
-      yaml_dependencies.each_value { |dependency|
+      all_deps.each_value { |dependency|
         puts_result = "pod '#{dependency.pod}'"
 
         if dependency.path #路径引用
@@ -387,31 +369,13 @@ module Pod
       puts "⬆️  打印完毕"
     end
 
-    def local_yaml_contain(module_name)
-      local_yaml_deps.include?(module_name)
-    end
-
-    # 是否需要快速编译
-    def quick_build
-
-      podfile_local_yaml = Constants::PODFILE_LOCAL_YAML
-
-      unless File.exist?(podfile_local_yaml)
-        puts "文件不存在:"+podfile_local_yaml
-        return false
-      end
-
-      begin
-        yaml_content = YAML.load_file(podfile_local_yaml)
-      rescue Exception => e
-        puts e
-        return false
-      end
-
-      yaml_content["QUICKBUILD"] == true ? true : false
+    # 生成默认yaml文件
+    def generate_yaml
+      generate_local_yaml(podfile_local_yaml)
+      generate_module_yaml(podfile_module_yaml, "# 企业内部组件")
+      generate_module_yaml(podfile_third_party_yaml, "# 第三方维护组件")
     end
 
-    # 生成local文件
     def generate_local_yaml(podfile_local_yaml)
       if File.exist?(podfile_local_yaml)
         return
@@ -423,8 +387,8 @@ module Pod
       content = content + "# 2、PODS下边的配置是数组形式, 如果有多个就写多个(subspecs需要数组)\n"
       content = content + "# 3、本文件加入到忽略文件中\n\n"
 
-      # content = content + "# QUICKBUILD字段如果为true, 则表示会自动解析所有组件的依赖, 并删除不被使用的依赖库, 以达到开发时快速编译的目的\n"
-      # content = content + "QUICKBUILD: false\n\n"
+      content = content + "# QUICK_BUILD字段如果为true, 则表示会自动解析所有组件的依赖, 并删除不被使用的依赖库, 以达到开发时快速编译的目的\n"
+      content = content + "QUICK_BUILD: false\n\n"
 
       content = content + "PODS:\n"
 
@@ -447,7 +411,6 @@ module Pod
       }
     end
 
-    # 生成其他的yaml文件
     def generate_module_yaml(yaml_name, prefix)
       if File.exist?(yaml_name)
         return
@@ -457,16 +420,15 @@ module Pod
       content = ""
       content = content + prefix
       content = content + "\n"
-      content = content + "# 1、优先级:path > podspec > version > tag > branch)\n"
+      content = content + "# 1、优先级:path > podspec > version > tag > branch\n"
       content = content + "# 2、path字段就是直接从对应的路径读取依赖\n"
       content = content + "# 3、podspec字段就是直接从对应的路径读取podspec文件加载依赖\n"
       content = content + "# 4、当version不为空时，会取source字段的repo获取组件，如果source字段为空，那么就取文件顶部配置的默认SOURCE\n"
       content = content + "# 5、当tag字段或branch字段不为空时，会取git字段的地址获取代码\n"
       content = content + "\n"
-      content = content + "# 如果 source = null && binary = false 则source默认使用这个\n"
+      content = content + "# 如果 source = null && binary = false 则source默认使用SOURCE\n"
+      content = content + "# 如果 source = null && binary = true  则source默认使用BINARY_SOURCE\n"
       content = content + "SOURCE: 这里替换成源码的source\n"
-      content = content + "\n"
-      content = content + "# 如果 source = null && binary = true 则source默认使用这个\n"
       content = content + "BINARY_SOURCE: 这里替换成二进制的source\n"
       content = content + "\n"
       content = content + "PODS:\n"
@@ -489,5 +451,17 @@ module Pod
       }
     end
 
+    # 读取主工程target列表
+    def init_main_targets
+      project_manager = XCProject::XcodeprojManager.share_manager
+      @targets = project_manager.get_app_targets
+    end
+
+    #是否开启了编译优化开关
+    def quick_build
+      yaml_content = read_yaml_content(podfile_local_yaml)
+      !!(yaml_content["QUICK_BUILD"])
+    end
+
   end
 end