podfileDep 1.1.4 → 2.0.0

data/lib/podfileDep/yaml/yaml_dep.rb

@@ -0,0 +1,449 @@
+require_relative '../version'
+require_relative '../constants'
+require_relative '../check/xcodeproj'
+
+module Pod
+
+  class YamlRely
+    attr_reader :pod, :subspecs, :version, :git, :tag, :branch, :podspec, :configurations, :path, :inhibit_warnings, :source, :binary
+    def initialize(module_name, pod, subspecs, path, podspec, version, git, tag, branch, configurations, inhibit_warnings, source, binary)
+      @module_name = module_name
+      @pod = pod
+      @subspecs = subspecs
+      @path = path
+      @podspec = podspec
+      @version = version
+      @git = git
+      @tag = tag
+      @branch = branch
+      @configurations = configurations
+      @inhibit_warnings = inhibit_warnings
+      @source = source
+      @binary = binary
+    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
+
+  end
+  class YamlRelies
+
+    def self.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
+
+      # 检查参数
+      self.check_param(targets)
+
+      # 生成YAML文件
+      self.generate_local_yaml(podfile_local_yaml)
+      self.generate_module_yaml(podfile_module_yaml, "# 企业内部组件")
+      self.generate_module_yaml(podfile_third_party_yaml, "# 第三方维护组件")
+
+      # 读取yaml依赖
+      yaml_dependencies = {}
+      self.read_yaml_dependencies(podfile_third_party_yaml,false ,yaml_dependencies)
+      self.read_yaml_dependencies(podfile_module_yaml,false ,yaml_dependencies)
+      self.read_yaml_dependencies(podfile_local_yaml,true ,yaml_dependencies)
+
+      # 打印依赖
+      self.print_dependencies(yaml_dependencies)
+
+      # 为所有target生成依赖
+      targets_dependencies = {}
+      self.update_target_dependencies(targets, yaml_dependencies, targets_dependencies)
+
+      # 兼容老方式
+      if old
+        return targets_dependencies
+      end
+
+      # 存储所有依赖
+      self.store_dependencies(targets_dependencies, podfile)
+
+    end
+
+    def self.store_dependencies(targets, podfile)
+      # 存储所有的依赖
+      targets.each { |name, dependencies|
+        podfile.target name do
+          podfile.use_frameworks!
+          dependencies.each { |dependency|
+            if dependency.version
+              podfile.pod dependency.pod, dependency.version, dependency.option
+            else
+              podfile.pod dependency.pod, dependency.option
+            end
+          }
+        end
+      }
+      targets
+    end
+
+    # 检查方法调用的参数
+    def self.check_param(targets)
+      msg = "❌ 参数需要填写target名字, 参数类型是字符串格式的数组。例如[\"test1\", \"test2\"]"
+      unless targets.class == Array
+        puts msg
+        exit!
+      end
+
+      targets.each { |target|
+        unless target.class == String
+          puts msg
+          exit!
+        end
+      }
+    end
+
+    # 校验yaml文件写法是否正确
+    def self.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
+
+      prefix_message = "解析:"+yaml_name + "=> "
+      unless yaml_content.class == Hash
+        puts "#{prefix_message}共0个依赖(文件不是keyValue形式)"
+        return nil
+      end
+
+      unless yaml_content.key?('PODS')
+        puts "#{prefix_message}共0个依赖(文件内的key[PODS]不存在)"
+        return nil
+      end
+
+      unless yaml_content['PODS'].class == Array
+        puts "#{prefix_message}共0个依赖(文件配置的依赖PODS下边不是数组或数组为空)"
+        return nil
+      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
+
+      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
+
+      return yaml_content
+
+    end
+
+    # 读取yaml依赖
+    def self.read_yaml_dependencies(yaml_name, can_cover, yaml_dependencies)
+
+      # 检查写法
+      yaml_content = self.yaml_content(yaml_name)
+
+      unless yaml_content
+        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
+
+      # 读取默认二进制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
+
+      # 依赖列表
+      dependencies_pods = yaml_content['PODS']
+      puts "解析:#{yaml_name} => 共#{dependencies_pods.size.to_s}个依赖"
+
+      # 当前yaml文件的组件名字 用来校验本文件内是否重复
+      dependencies_name = []
+
+      # 遍历依赖库列表
+      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 = "yaml_relies"
+            puts "❌ #{yaml_name}: 当前#{gem_name}版本(#{Yaml_relies::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
+
+        # 记录覆盖
+        if yaml_dependencies.key?(dependency['pod']) and can_cover
+          puts "✅ #{dependency['pod']}被#{yaml_name}覆盖"
+        end
+
+        # 默认值
+        source = dependency['source']
+        unless source
+          source = dependency['binary'] ? default_binary_source : default_source_source
+        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']
+
+        # 生成依赖对象
+        dependency = YamlRely.new(module_name = dependency['module'],
+                                  pod = dependency['pod'],
+                                  subspecs = dependency['subspecs'],
+                                  path = dependency['path'],
+                                  podspec = dependency['podspec'],
+                                  version = version,
+                                  git = dependency['git'],
+                                  tag = dependency['tag'],
+                                  branch = dependency['branch'],
+                                  configurations = dependency['configurations'],
+                                  inhibit_warnings = inhibit_warnings,
+                                  source = source,
+                                  binary = binary)
+        yaml_dependencies[dependency.pod] = dependency
+      }
+
+    end
+
+    # 生成传进来的target的依赖库列表
+    def self.update_target_dependencies(targets, yaml_dependencies, targets_dependencies)
+      temp_array = []
+      yaml_dependencies.each_value { |value|
+        temp_array << value
+      }
+
+      targets.each { |target|
+        targets_dependencies[target] = temp_array
+      }
+    end
+
+    def self.print_dependencies(yaml_dependencies)
+      puts "➡️  解析依赖总数共计:#{yaml_dependencies.size}个\n\n"
+      puts '⬇️  打印依赖'
+      yaml_dependencies.each_value { |dependency|
+        puts_result = "pod '#{dependency.pod}'"
+
+        if dependency.path #路径引用
+          puts_result += ", :path => '#{dependency.path}'"
+        elsif dependency.podspec #podspec引用
+          puts_result += ", :podspec => '#{dependency.podspec}'"
+        elsif dependency.version #版本号引用
+          puts_result += ", '#{dependency.version.to_s}'"
+        elsif dependency.git #git仓库引用
+          puts_result += ", :git => '#{dependency.git}'"
+          if dependency.tag
+            puts_result += ", :tag => '#{dependency.tag}'"
+          elsif dependency.branch
+            puts_result += ", :branch => '#{dependency.branch}'"
+          end
+        end
+
+        if dependency.configurations
+          puts_result += ", :configurations => ['#{dependency.configurations.join("','")}']"
+        end
+        if dependency.subspecs
+          puts_result += ", :subspecs => ['#{dependency.subspecs.join("','")}']"
+        end
+        if dependency.inhibit_warnings
+          puts_result += ", :inhibit_warnings => true"
+        end
+        if dependency.version and dependency.source
+          puts_result += ", :source => '#{dependency.source}'"
+        end
+
+        puts puts_result
+      }
+      puts "⬆️  打印完毕"
+    end
+
+    # 是否需要快速编译
+    def self.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["QUICK"] == true ? true : false
+    end
+
+    # 生成local文件
+    def self.generate_local_yaml(podfile_local_yaml)
+      if File.exist?(podfile_local_yaml)
+        return
+      end
+      puts "生成#{podfile_local_yaml}文件"
+
+      content = ""
+      content = content + "# 1、本依赖配置文件优先级最高, 用来覆盖其他两个依赖的yaml文件中的组件。 尝试打开以下注释, 修改对应字段, 然后执行pod install\n"
+      content = content + "# 2、PODS下边的配置是数组形式, 如果有多个就写多个\n"
+      content = content + "# 3、本文件加入到忽略文件中\n\n"
+
+      # content = content + "# QUICK字段如果为true, 则表示会自动解析所有组件的依赖, 并删除不被使用的依赖库, 以达到开发时快速编译的目的\n"
+      # content = content + "QUICK: false\n\n"
+
+      content = content + "PODS:\n"
+
+      content = content + "\n"
+
+      content = content + "# - module: Masonry\n"
+      content = content + "#   pod: Masonry\n"
+      content = content + "#   subspecs: null\n"
+      content = content + "#   path: ~/MasonryCodePath\n"
+
+      content = content + "\n"
+
+      content = content + "# - module: MJExtension\n"
+      content = content + "#   pod: MJExtension\n"
+      content = content + "#   subspecs: null\n"
+      content = content + "#   path: ~/MJExtensionCodePath\n"
+
+      File.open(podfile_local_yaml, 'w') { |file|
+        file.write(content)
+      }
+    end
+
+    # 生成其他的yaml文件
+    def self.generate_module_yaml(yaml_name, prefix)
+      if File.exist?(yaml_name)
+        return
+      end
+      puts "生成#{yaml_name}文件"
+
+      content = ""
+      content = content + prefix
+      content = content + "\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: 这里替换成源码的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"
+      content = content + "\n"
+      content = content + "# - module: XXX\n"
+      content = content + "#   pod: XXX\n"
+      content = content + "#   subspecs: null\n"
+      content = content + "#   podspec: null\n"
+      content = content + "#   version: 1.0.0\n"
+      content = content + "#   git: null\n"
+      content = content + "#   tag: null\n"
+      content = content + "#   branch: null\n"
+      content = content + "#   configurations: null\n"
+      content = content + "#   inhibit_warnings: true\n"
+      content = content + "#   source: null\n"
+      content = content + "#   binary: true\n"
+
+      File.open(yaml_name, 'w') { |file|
+        file.write(content)
+      }
+    end
+
+  end
+end