cocoapods-ykutility 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc117e8086c2837b3d7b49a2dc44c641ffd10dcb57dae7ae11178cf59f80cf45
-  data.tar.gz: d44bf31e0a0f060750144297636ee2aca87195bab1176a4452a175f0956efa80
+  metadata.gz: c4b79fd9f7903656dadce1185190adc88e55a314292b0454f77719bf50b8790e
+  data.tar.gz: c7659edbf4c293ba187c1314a3aede0abfeb9ddcdf002ecdff0b64b1de8b132d
 SHA512:
-  metadata.gz: f878d8679e9c066e088736982a40098b0eabb9db1f0888dab221907d40379bad1fd9809a9924279d0e9551c3825da737f7b1e859e9501e38f7d8d6a302f16720
-  data.tar.gz: c29dda8b533c1fa47273262a5bb9a7769bf5383b3f11ed6820de677426c3cdbbf1d693fd5d9003fd0b993340a610354fdd00545877f38178745e87cf6d55ce59
+  metadata.gz: 82ff382f1800c1bf4b9c68140b0dca9c721df2f9394b2dfefb959d3fd3ae2c8f7981cfac22ee435aca9c24e8577c5c1ce801c35ef03978bd1911d849c51298d9
+  data.tar.gz: 65e65eca2963857a404af1a60a79f85127a3bd5dd1e7e0b2d71e39d3c29a83db9cc35ed6b667de5f513ba7f57db6ebc569c7e5e2f14c838a0853dcb94a0af4f2

data/lib/cocoapods-ykutility/command/Ykutility.rb

@@ -1,5 +1,6 @@
 require 'cocoapods'
-require 'cocoapods-ykutility/command/ykutility/create'
+require 'cocoapods-ykutility/command/create'
+require 'cocoapods-ykutility/command/push'
 
 module Pod
   class Command

data/lib/cocoapods-ykutility/{function → command/create}/yk_create_pod_action.rb

@@ -4,13 +4,13 @@ module YKPod
   require 'cocoapods'
 
   class YKCreate
-    require 'cocoapods-ykutility/function/yk_create_pod_config'
-    require 'cocoapods-ykutility/function/yk_log_tool'
+    require 'cocoapods-ykutility/command/create/yk_create_pod_config'
+    require 'cocoapods-ykutility/tools/yk_log_tool'
     require 'find'
     include YKPod::YKLogTool
 
     require 'cocoapods-ykutility/gem_version'
-    require 'cocoapods-ykutility/function/yk_exchange_tool'
+    require 'cocoapods-ykutility/command/create/yk_exchange_tool'
     include YKPod::YKExchangeTool
 
     def initialize(conf)

data/lib/cocoapods-ykutility/{function → command/create}/yk_exchange_tool.rb

@@ -2,7 +2,7 @@
 
 module YKPod
   module YKExchangeTool
-    require 'cocoapods-ykutility/function/yk_log_tool'
+    require 'cocoapods-ykutility/tools/yk_log_tool'
     include YKPod::YKLogTool
     def updateFileDirs(rootDir, keyWord, destWord)
       Dir.glob("#{rootDir}/**/**/**/**").each do |name|

data/lib/cocoapods-ykutility/command/{ykutility/create.rb → create.rb}

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-require 'cocoapods-ykutility/function/yk_create_pod_action'
+require 'cocoapods-ykutility/command/create/yk_create_pod_action'
 require 'cocoapods-ykutility/gem_version'
 
 module Pod
   class Command
     class Ykutility < Command
 
-      require 'cocoapods-ykutility/function/yk_create_pod_config'
+      require 'cocoapods-ykutility/command/create/yk_create_pod_config'
       class Create < Ykutility
 
         self.summary = 'Creates a new Pod'

data/lib/cocoapods-ykutility/command/push/yk_api_analysis.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module YKApi
+  class YkApiAnalysis
+    require 'cocoapods-ykutility/tools/yk_log_tool'
+    require 'cocoapods-ykutility/command/push/yk_api_parse'
+
+    require 'cocoapods'
+
+    include YKPod::YKLogTool
+
+    attr_accessor :spec_list, :pod_names, :version
+    def initialize(podspec_files, source_urls)
+      @spec_files = podspec_files
+      @source_urls = source_urls
+
+      @public_headers = []
+      @source_files = []
+      @swift_files = []
+      @pod_names = []
+      @version = ""
+    end
+
+    def execute
+      analysis_all_specs
+      analysis_api
+    end
+
+    def all_pod_names
+      "\"#{@pod_names.join(" ")}\""
+    end
+
+    private
+    def analysis_all_specs()
+      @spec_files.each do |one|
+        valid = Pod::Validator.new(one, @source_urls)
+        spec = valid.linter.spec
+        @version = spec.version.to_s
+        analysis_one_spec(spec)
+      end
+
+      ykMessage "all public header files:\n#{@public_headers.join("\n")}"
+      ykMessage "all source code files:\n#{@source_files.join("\n")}"
+      @swift_files = @source_files.find_all do |onePath|
+        onePath.extname == ".swift"
+      end
+      ykMessage "all swift files:\n#{@swift_files}"
+    end
+
+    def analysis_one_spec(spec)
+      path_list = Pod::Sandbox::PathList.new(spec.defined_in_file.dirname)
+      file_accessor = Pod::Sandbox::FileAccessor.new(path_list, spec.consumer(Pod::Platform.ios))
+      public_header_arr = file_accessor.public_headers
+      ykMessage("#{spec.name} --> plubic_headers:\n#{public_header_arr.join("\n")}")
+      @public_headers.concat(public_header_arr) unless public_header_arr.blank?
+      @pod_names.append(spec.name)
+
+      source_file_arr = file_accessor.source_files
+      ykMessage("#{spec.name} --> source_files:\n#{source_file_arr.join("\n")}")
+      @source_files.concat(source_file_arr) unless source_file_arr.blank?
+
+      sub_spec_arr = spec.subspecs
+      ykNotice "#{spec.name} has sub_specs: #{sub_spec_arr.join(",\t")}" unless sub_spec_arr.blank?
+      sub_spec_arr.each do |oneSub|
+        analysis_one_spec(oneSub)
+      end
+    end
+
+    def analysis_api
+      api_output_dir = File.join(Dir.pwd, "Api")
+      if File.exist?(api_output_dir)
+        FileUtils.rm_r(api_output_dir)
+      end
+
+      FileUtils.mkdir(api_output_dir)
+      analysis_success = YKApi::YkApiParser.new(@public_headers, @swift_files, api_output_dir).analysis
+      analysis_success
+    end
+
+  end
+end

data/lib/cocoapods-ykutility/command/push/yk_api_parse.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module YKApi
+  class YkApiParser
+
+    require 'cocoapods-ykutility/tools/yk_log_tool'
+    include YKPod::YKLogTool
+
+    def initialize(objc_header_file_list, swift_file_list, output_dir)
+      @objc_header_files = objc_header_file_list
+      @swift_file_list = swift_file_list
+      @output_dir = output_dir
+      @json_cache = File.join(output_dir, "json_files_tem")
+      FileUtils.rm_r(@json_cache) if File.exist?(@json_cache)
+      FileUtils.mkdir(@json_cache)
+    end
+
+    def analysis
+      json_arr_objc = parse_objc
+      json_arr_swift = parse_swift
+      create_api(json_arr_objc, json_arr_swift)
+    end
+
+    private
+    def parse_objc
+      ykNotice("#{self.class} --> #{__method__}")
+      # sourcekitten doc --objc NSBundle+YKInternational.h  -- -x objective-c -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator)  -fmodules > 123
+      cache_arr = []
+      @objc_header_files.each do |one|
+        cache_path = File.join(@json_cache, one.basename)
+        cmd = "sourcekitten doc --single-file --objc \"#{one}\"  -- -x objective-c -isysroot $(xcrun --show-sdk-path --sdk iphonesimulator)  -fmodules > \"#{cache_path}\""
+        ykMessage("cmd: #{cmd}")
+        code = system(cmd)
+        cache_arr.append("\"#{cache_path}\"")
+      end
+
+      cache_arr
+    end
+
+    def parse_swift
+        ykNotice("#{self.class} --> #{__method__}")
+        # sourcekitten doc --single-file $input_file -- -j4 $input_file >> $temp_outout
+
+        cache_arr = []
+        @swift_file_list.each do |one|
+          cache_path = File.join(@json_cache, one.basename)
+          cmd = "sourcekitten doc --single-file \"#{one}\" -- -j4 \"#{one}\" > \"#{cache_path}\""
+          ykNotice("cmd: #{cmd}")
+          code = system(cmd)
+          cache_arr.append("\"#{cache_path}\"")
+        end
+
+        cache_arr
+    end
+
+    def create_api(json_objc_arr, json_swift_arr)
+      json_all = json_objc_arr + json_swift_arr
+
+      json_all.map
+      cmd = "jazzy --min-acl public --sourcekitten-sourcefile #{json_all.join(",")}"
+      cmd << " -o \"#{@output_dir}\""
+      ykMessage("cmd: \n#{cmd}")
+      cmd_result =system(cmd)
+      cmd_result
+    end
+
+  end
+end

data/lib/cocoapods-ykutility/command/push/yk_git_manager.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'git'
+module Git
+  class Base
+    def is_clean
+      cmd = "git status --short"
+      @cmd_out_put = []
+      IO.popen(cmd) do |f|
+        line = f.gets
+        @cmd_out_put << line unless line.blank?
+      end
+
+      @cmd_out_put.blank?
+    end
+  end
+end
+
+module YKUtitlityGitModule
+  class YKGitManager
+    require 'git'
+    require 'cocoapods-ykutility/tools/yk_log_tool'
+    include YKPod::YKLogTool
+
+    def initialize(dir)
+      @dir = dir
+
+      Dir.chdir(dir) do
+        @git = Git.open(Dir.pwd)
+      end
+    end
+
+    def prepare
+      is_clean = @git.is_clean
+      if is_clean == false
+        ykNotice("work tree dirty, work finish") unless is_clean
+        return false
+      end
+      return true
+    end
+
+    def commit_for_api(commit_message)
+      begin
+        @git.add(:all => true)
+        @git.commit(commit_message)
+        @git.push('origin', @git.current_branch)
+      rescue Git::FailedError => e
+        puts(e.to_s)
+      end
+    end
+
+    def update_tag(dest_tag)
+      delete_dest_tag(dest_tag.to_s) # 删除原有tag
+      create_dest_tag(dest_tag.to_s) # 新建tag
+    end
+
+    private
+
+    def create_dest_tag(dest_tag)
+      return false unless prepare == true
+
+      puts "start create tag"
+      @git.add_tag(dest_tag, :m => "\"#{dest_tag}\" -- auto created with api document, by 'cocoapods-ykutility'")
+      @git.push('origin', dest_tag)
+    end
+
+    def delete_dest_tag(dest_tag)
+      # 此处需要防止本地有tag, 而远端不存在， 所以此处做如下操作
+      # 1. 检查本地tag
+      # 2. 删除本地tag
+      # 3. 拉取远端tag
+      # 4. 删除本地和远端tag
+
+      begin
+        exist_tag = @git.tag(dest_tag)
+      rescue Git::GitTagNameDoesNotExist => e
+      end
+
+      ykNotice("tag [#{dest_tag}] existed, we delete it on local and remote \"origin\"") unless exist_tag.blank?
+      begin
+        @git.delete_tag(dest_tag) unless exist_tag.blank?
+        @git.push('origin', dest_tag, :delete => true) unless exist_tag.blank?
+      rescue Git::FailedError => e
+      end
+    end
+  end
+end

data/lib/cocoapods-ykutility/command/push.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Pod
+  class Command
+    class Ykutility < Command
+      class Push < Ykutility
+        require 'cocoapods/command/repo/push'
+        require 'cocoapods-ykutility/tools/yk_log_tool'
+        require 'cocoapods-ykutility/command/push/yk_api_analysis'
+        require 'cocoapods-ykutility/command/push/yk_git_manager'
+
+        include YKPod::YKLogTool
+
+        include Pod::Config::Mixin
+        self.summary = 'Release a new pod version'
+
+        self.description = <<-DESC
+          组件发布新版本
+        DESC
+
+        attr_accessor :repo_push_cmd
+        attr_accessor :argv_cache
+
+        self.arguments = Pod::Command::Repo::Push.arguments
+
+        def self.options
+          Pod::Command::Repo::Push.options.concat(super)
+        end
+
+        def initialize(argv)
+          # 如果有一部分参数是本类特有的，需要在此处优先取出
+          argv_map = argv.remainder
+          argv_new = CLAide::ARGV.new(argv.remainder)
+          @repo_push_cmd = Pod::Command::Repo::Push.new(argv_new)
+
+          # 因为这部分参数是 本类 和 Pod::Command::Repo::Push 共有的， 所以本类用 argv 取参数， Pod::Command::Repo::Push使用 argv_map 取参数
+          @repo = argv.shift_argument
+          @podspec = argv.shift_argument
+          @source = source_for_repo
+          @source_urls = argv.option('sources', config.sources_manager.all.map(&:url).append(Pod::TrunkSource::TRUNK_REPO_URL).uniq.join(',')).split(',')
+          argv_extra = argv_new.remainder
+          argv_extra.append("--help") if argv_map.include?("--help")
+          super(CLAide::ARGV.new(argv_extra))
+        end
+
+        def validate! # 此处validate 是复制 Pod::Command::Repo::Push ， 因为如果直接用 self.repo_push_cmd.validate! 会导致提示显示的是 Pod::Command::Repo::Push  的使用说明
+          super
+
+          help! 'A spec-repo name or url is required.' unless @repo
+          unless @source && @source.repo.directory?
+            raise Informative,
+                  "Unable to find the `#{@repo}` repo. " \
+                  'If it has not yet been cloned, add it via `pod repo add`.'
+          end
+        end
+
+        def run
+          gitmanager = YKUtitlityGitModule::YKGitManager.new(Dir.pwd)
+          return false unless gitmanager.prepare == true
+
+          ykNotice "pod ykutility push running !"
+          self.repo_push_cmd.run # 使用Pod::Command::Repo::Push，发布pod
+
+          ykNotice "pod ykutility analysis create document running !"
+          api_analysis = YKApi::YkApiAnalysis.new(podspec_files, @source_urls)
+          aanlysis_success = api_analysis.execute
+          raise Informative, "Failed to analysis Component api: #{api_analysis.all_pod_names}" unless aanlysis_success == true
+          # 解析podspec, 识别出 公共文件， tag
+          # 根据公共文件，生成接口文档
+          # 检查tag是否存在，删除已有tag, 删除远端已有tag
+          # 添加接口文档，并提交，生成对应版本的tag,并对送到远端
+          version = api_analysis.version
+
+          gitmanager.commit_for_api("create api document for version: #{version.to_s}")
+          gitmanager.update_tag(version.to_s)
+
+        end
+
+        private
+
+        def podspec_files
+          if @podspec
+            path = Pathname(@podspec)
+            raise Informative, "Couldn't find #{@podspec}" unless path.exist?
+            [path]
+          else
+            files = Pathname.glob('*.podspec{,.json}')
+            raise Informative, "Couldn't find any podspec files in current directory" if files.empty?
+            files
+          end
+        end
+
+        def source_for_repo
+          self.config.sources_manager.source_with_name_or_url(@repo) unless @repo.nil?
+        rescue
+          nil
+        end
+
+      end
+    end
+  end
+end

data/lib/cocoapods-ykutility/gem_version.rb

@@ -1,4 +1,4 @@
 module CocoapodsYkPodUtility
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
   YK_POD_TEMPLATE_PATH = File.expand_path(File.join(__FILE__, '../../../podTemplate'))
 end

data/lib/cocoapods-ykutility/{function → tools}/yk_log_tool.rb

@@ -2,7 +2,10 @@
 
 module YKPod
   module YKLogTool
+    require 'cocoapods'
+
     def ykWarning(message)
+      verbose = Pod::Config.instance.verbose
       puts "\n[⚠️] #{message}".yellow
       return 0
     end
@@ -12,6 +15,11 @@ module YKPod
       return 0
     end
 
+    def ykMessage(message)
+      puts "\n#{message}" if Pod::Config.instance.verbose
+      return 0
+    end
+
     def ykError(message)
       puts "\n[❌] #{message}".red
       return 1

data/podTemplate/example/YKRPC_POD_NAME_Example.xcodeproj/project.pbxproj

@@ -3,7 +3,7 @@
 	archiveVersion = 1;
 	classes = {
 	};
-	objectVersion = 56;
+	objectVersion = 55;
 	objects = {
 
 /* Begin PBXBuildFile section */
@@ -104,7 +104,7 @@
 				};
 			};
 			buildConfigurationList = FDDD855D299DED6500EAB62E /* Build configuration list for PBXProject "YKRPC_POD_NAME_Example" */;
-			compatibilityVersion = "Xcode 14.0";
+			compatibilityVersion = "Xcode 13.0";
 			developmentRegion = en;
 			hasScannedForEncodings = 0;
 			knownRegions = (

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-ykutility
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - stephen.chen
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-17 00:00:00.000000000 Z
-dependencies: []
+date: 2023-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jazzy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 创建定制化标准组件.
 email:
 - stephenchen@yeahka.com
@@ -20,12 +76,16 @@ files:
 - lib/cocoapods-ykutility.rb
 - lib/cocoapods-ykutility/command.rb
 - lib/cocoapods-ykutility/command/Ykutility.rb
-- lib/cocoapods-ykutility/command/ykutility/create.rb
-- lib/cocoapods-ykutility/function/yk_create_pod_action.rb
-- lib/cocoapods-ykutility/function/yk_create_pod_config.rb
-- lib/cocoapods-ykutility/function/yk_exchange_tool.rb
-- lib/cocoapods-ykutility/function/yk_log_tool.rb
+- lib/cocoapods-ykutility/command/create.rb
+- lib/cocoapods-ykutility/command/create/yk_create_pod_action.rb
+- lib/cocoapods-ykutility/command/create/yk_create_pod_config.rb
+- lib/cocoapods-ykutility/command/create/yk_exchange_tool.rb
+- lib/cocoapods-ykutility/command/push.rb
+- lib/cocoapods-ykutility/command/push/yk_api_analysis.rb
+- lib/cocoapods-ykutility/command/push/yk_api_parse.rb
+- lib/cocoapods-ykutility/command/push/yk_git_manager.rb
 - lib/cocoapods-ykutility/gem_version.rb
+- lib/cocoapods-ykutility/tools/yk_log_tool.rb
 - lib/cocoapods_plugin.rb
 - podTemplate/example/Podfile
 - podTemplate/example/Podfile.lock
@@ -62,7 +122,7 @@ homepage: https://github.com/stephen5652/cocoapods-yk-pod-utility.git
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -77,8 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: 一款cocoapods插件，用于创建定制化标准组件.
 test_files: []