cocoapods-tag 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fc5297e51950ca49c7e6862bcd9ccaa7707c88b1568df30ed32cc165cb05d48
+  data.tar.gz: adf8df13f96690d4d98eeb08d801d7570f255eabc8d16ad395ccfb71d7815fd5
+SHA512:
+  metadata.gz: 9cd6328f564dcfe676bd940258a0a1d8701ecc1eff4451fa856c6808cb64d475d2659db869424ee316ecdcb589533ee37b045dfb1ea1b3a2b779c5cadb715713
+  data.tar.gz: 1e83a70c3ea110853d6fa97ef376cd121848567ec681b08949de3c0f2bde6e6b14fd660abbd4313de613523d72f6848baeb08b8a884d746841aba3b9584c59b2

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022 Jensen <zys2@meitu.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+## 简介
+
+`cocoapods-tag`是一个可以方便地帮助Pod库打tag的`CocoaPods`插件，插件采用问答的方式提示用户输入相应内容，简单、方便、快捷。
+
+## 安装
+
+```shell
+$ gem install cocoapods-tag
+```
+
+## 使用
+
+* 查看帮助
+
+```shell
+$ pod tag --help
+```
+
+* 创建tag并push到远端，并询问是否上传podspec到spec repo
+
+```shell
+$ pod tag
+# 或
+$ pod tag create
+```
+
+* 上传podspec到spec repo
+
+```shell
+$ pod tag spec-push REPO NAME.podspec
+```
+
+## 演示gif
+
+<img src='./cocoapods-tag.gif' width='100%' />
+

data/lib/cocoapods-tag/command/tag/create.rb

@@ -0,0 +1,320 @@
+require 'cocoapods-tag/helper/asker'
+
+module Pod
+  class Command
+    class Tag < Command
+      class Create < Tag
+        include Pod
+
+        GITHUB_DOMAIN = "github.com".freeze
+        GIT_REPO = ".git".freeze
+        PODSPEC_EXT = %w[podspec podspec.json].freeze
+
+        self.summary = '创建 tag 并 push 到远端仓库，同时可以上传 podspec 到 spec repo'
+
+        self.description = <<-DESC
+        #{self.summary}
+        DESC
+
+        def initialize(argv)
+          super
+        end
+
+        def run
+          require 'cocoapods-tag/native/validator'
+
+          # 欢迎提示
+          asker.welcome_message
+          # 检查本地 git 仓库
+          check_git_repo?
+          # 加载 podspec
+          load_podspec
+          # 提示用户输入 version
+          ask_version
+          # 提示用户输入前缀
+          ask_prefix
+          # 提示用户输入后缀
+          ask_suffix
+          # 提示用户输入 commit msg 和 tag msg
+          ask_commit_tag_msg
+          # 询问用户推送到哪个远端仓库
+          ask_remote
+          # 提示用户确认
+          ask_sure
+          # 修改 podspec
+          modify_podspec
+          # 推送 tag 到远端
+          git_tag_push
+          # 询问用户是否推送 podspec 到 spec 仓库
+          ask_push_podspec_to_repo
+          # 结束提示
+          asker.done_message if @error.nil?
+        end
+
+        private
+
+        # 加载 podspec
+        def load_podspec
+          unless check_podspec_exist?
+            raise Informative, "`#{Dir.pwd}`不存在podspec"
+          end
+          @spec = Specification.from_file(@podspecs.first)
+          raise Informative, "加载`#{@podspecs.first}`失败！" if @spec.nil?
+          @spec_hash = @spec.to_hash
+          source = @spec_hash['source']
+          # 目前只处理 git 这种形式
+          unless source['git']
+            raise Informative, "目前只能处理`git`这种形式"
+          end
+          # git字段为空
+          if source['git'] && source['git'].strip == ''
+            raise Informative, "source中git字段不能为空"
+          end
+          # 判断 source 中是否包含 github.com
+          if source['git'] && source['git'].include?(GITHUB_DOMAIN)
+            message = "\n`#{@podspecs.first}`的source中包含`#{GITHUB_DOMAIN}`，请确认是否正确？"
+            answer = asker.ask(message, true, nil, { '1' => '正确✅', '2' => '错误❌' })
+            if answer == '2'
+              exit("\n程序终止\n")
+            end
+          end
+          # 修改前校验一次 podspec
+          lint_podspec("\n修改前校验`#{@podspecs.first}`：\n")
+        end
+
+        # 检查 git repo
+        def check_git_repo?
+          print "检查git仓库：\n".yellow
+
+          git_repo = File.join(Dir.pwd, GIT_REPO)
+          raise Informative, "`#{Dir.pwd}`不存在git仓库，请先使用`git init`初始化git仓库" unless File.exist?(git_repo)
+
+          remotes = `git remote`.split("\n")
+          raise Informative, "本地git仓库没有与远端仓库关联，请先使用`git remote add`关联远端仓库" if remotes.empty?
+
+          local_commit = `git rev-parse HEAD`.chomp
+          remote_commit = `git ls-remote --head`.split("\t")[0]
+          raise Informative, "本地git仓库没有与远端同步，请先执行`git pull`或`git fetch + git rebase`拉取最新代码" unless local_commit == remote_commit
+        end
+
+        # 提示用户输入版本号
+        def ask_version
+          question = "\n请输入版本号（用于修改`podspec`中的`version`）："
+          pre_answer = @spec_hash['version']
+          regx = {
+            "tip" => "版本号中间必须有'.'且每一位只支持数字，如：0.1、1.1.2等",
+            "pattern" => /^(\d+\.)+\d+$/
+          }
+          @version = asker.ask(question, true, pre_answer, nil, regx)
+        end
+
+        # 提示用户输入前缀
+        def ask_prefix
+          question = "\n请输入tag前缀："
+          @prefix = asker.ask(question)
+          print "无前缀\n" if @prefix.size == 0
+        end
+
+        # 提示用户输入后缀
+        def ask_suffix
+          question = "\n请输入tag后缀："
+          @suffix = asker.ask(question)
+          print "无后缀\n" if @suffix.size == 0
+        end
+
+        # 提示用户输入 commit msg 和 tag msg
+        def ask_commit_tag_msg
+          @commit_msg = asker.ask("\n请输入commit信息：", true)
+          @tag_msg = asker.ask("\n请输入tag信息：", true)
+        end
+
+        # 询问用户推送到哪个远端仓库
+        def ask_remote
+          remotes = `git remote`.split("\n")
+          @remote = remotes[0] unless remotes.empty?
+          if remotes.size > 1
+            count = 0
+            selections = {}
+            remotes.map do |remote|
+              count += 1
+              selections["#{count}"] = remote
+            end
+            key = asker.ask("\n请选择推送到的远端仓库：", true, nil, selections)
+            @remote = remotes["#{key}".to_i]
+          end
+        end
+
+        # 提示用户确认信息
+        def ask_sure
+          @tag = "#{@prefix}#{@version}#{@suffix}"
+          question = <<-Q
+
+请确认以下信息：
+——————————————————————————————————————
+|tag: #{@tag}
+|version: #{@version}
+|commit_msg: #{@commit_msg}
+|tag_msg: #{@tag_msg}
+|current_branch: #{current_branch}
+|remote: #{@remote}
+——————————————————————————————————————
+          Q
+          selections = {'1'=> '确认', '2'=> '取消'}
+          answer = asker.ask(question, true, nil, selections)
+          if answer == 2
+            exit("\n程序终止\n")
+          end
+        end
+
+        # 修改podspec
+        def modify_podspec
+          if @podspecs.nil? || @podspecs.empty?
+            return
+          end
+          podspec = @podspecs.first
+          file = File.join(Dir.pwd, "#{podspec}")
+          # 匹配文件名后缀
+          if podspec =~ /.podspec$/
+            modify_podspec_ruby(file)
+          elsif podspec =~ /.podspec.json$/
+            modify_podspec_json(file)
+          end
+          # 修改完再次校验 podspec
+          lint_podspec("\n修改后校验`#{@podspecs.first}`：\n")
+        end
+
+        # 修改 *.podspec
+        def modify_podspec_ruby(file)
+          org_source = @spec_hash['source']
+          des_source = "{ :git => '#{org_source['git']}', :tag => '#{@tag}' }"
+          File.open(file, 'r') do |f|
+            lines = []
+            f.each_line do |line|
+              if line =~ /(^\s*.+\.version\s*=\s*).*/
+                line = line.sub(/(^\s*.+\.version\s*=\s*).*/, "#{$1}'#{@version}'")
+              end
+              if line =~ /(^\s*.+\.source\s*=\s*).*/
+                line = line.sub(/(^\s*.+\.source\s*=\s*).*/, "#{$1}#{des_source}")
+              end
+              lines << line
+            end
+            File.open(file, 'w') do |f|
+              f.write(lines.join(""))
+            end
+          end
+        end
+
+        # 修改 *.podspec.json
+        def modify_podspec_json(file)
+          @spec_hash['version'] = @version
+          @spec_hash['source'] = {
+            'git'=> @spec_hash['source']['git'],
+            'tag'=> "#{@tag}"
+          }
+          File.open(file, 'w') do |f|
+            f.write(@spec_hash)
+          end
+        end
+
+        # 校验 podspec
+        def lint_podspec(tip = "\n校验`#{@podspecs.first}`：\n")
+          print "#{tip}".yellow
+          argvs = [
+            @podspecs.first,
+            '--quick',
+            '--allow-warnings'
+          ]
+          lint = Pod::Command::Spec::Lint.new(CLAide::ARGV.new(argvs))
+          lint.validate!
+          lint.run
+        end
+
+        # 推送 tag 到远端
+        def git_tag_push
+          print "\n推送commit到远端git仓库`#{@remote}/#{current_branch}`：\n".yellow
+          begin
+            `git add #{@podspecs.first}`
+            `git commit -m #{@commit_msg}`
+            `git push #{@remote} #{current_branch}`
+          rescue Pod::StandardError => e
+            @error = e
+            print "推送commit到远端git仓库`#{@remote}/#{current_branch}`失败:#{e}".red
+          end
+
+          print "\n创建tag:#{@tag}并推送至远端：\n".yellow
+          begin
+            `git tag -a #{@tag} -m #{@tag_msg}`
+            `git push #{@remote} --tags`
+          rescue Pod::StandardError => e
+            @error = e
+            print "创建tag:#{@tag}并推送至远端失败:#{e}".red
+          end
+        end
+
+        # 询问用户是否推送 podspec 到 spec 仓库
+        def ask_push_podspec_to_repo
+          answer = asker.ask("\n是否推送podspec到spec仓库？", true, nil, {'1'=> 'YES', '2' => 'NO'})
+          if answer == '1'
+            @spec_repo = asker.ask("\n请输入本地spec仓库名称（可以通过`pod repo list`查看）：", true)
+            repos = `pod repo list`.split("\n").reject { |repo| repo == '' || repo =~ /^-/ }
+            unless repos.include?(@spec_repo)
+              print "本地不存在`#{@spec_repo}`仓库，请先`pod repo add`添加该仓库\n"
+              return
+            end
+            unless @spec_repo == ''
+              push_podspec_to_repo
+            end
+          else
+            print "跳过推送podspec到spec仓库\n"
+          end
+        end
+
+        # 推送 podspec 到 spec repo
+        def push_podspec_to_repo
+          print "\n推送`#{@podspecs.first}`到`#{@spec_repo}`仓库".yellow
+          argvs = [
+            @spec_repo,
+            @podspecs.first,
+            '--allow-warnings'
+          ]
+          begin
+            push = Pod::Command::Repo::Push.new(CLAide::ARGV.new(argvs))
+            push.validate!
+            push.run
+          rescue Pod::StandardError => e
+            @error = e
+            print "推送`#{@podspecs.first}`到`#{@spec_repo}`仓库失败！#{e}".red
+          end
+        end
+
+        def exit(status = -1, msg)
+          print "#{msg}".red
+          Process.exit(status)
+        end
+
+        def asker
+          @asker ||= begin
+                       Helper::Asker.new()
+                     end
+        end
+
+        # 获取当前分支
+        def current_branch
+          @current_branch ||= begin
+                                `git branch`.split(' ')[1]
+                              end
+        end
+
+        # 检查当前目录是否有podspec
+        def check_podspec_exist?
+          @podspecs = Dir.glob("*.{#{PODSPEC_EXT.join(',')}}")
+          if @podspecs.empty?
+            return false
+          end
+          true
+        end
+
+      end
+    end
+  end
+end

data/lib/cocoapods-tag/command/tag/spec_push.rb

@@ -0,0 +1,53 @@
+
+module Pod
+  class Command
+    class Tag < Command
+      class SpecPush < Tag
+
+        self.summary = '上传 podspec 到 spec 仓库，自动跳过 xcodebuild 编译校验'
+
+        self.description = <<-DESC
+        #{self.summary}
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('REPO', true ),
+          CLAide::Argument.new('NAME.podspec', true )
+        ]
+
+        def initialize(argv)
+          @repo = argv.shift_argument
+          @podspec = argv.shift_argument
+          super
+        end
+
+        def run
+          require 'cocoapods-tag/native/validator'
+
+          unless @repo
+            raise Informative, "请输入spec repo"
+          end
+          unless @podspec
+            raise Informative, "请输入要上传的podspec"
+          end
+          UI.title "推送`#{@podspec}`到`#{@repo}`仓库".yellow do
+            argvs = [
+              @repo,
+              @podspec,
+              '--allow-warnings'
+            ]
+            begin
+              push = Pod::Command::Repo::Push.new(CLAide::ARGV.new(argvs))
+              push.validate!
+              push.run
+            rescue Pod::StandardError => e
+              @error = e
+              print "推送`#{@podspec}`到`#{@repo}`仓库失败！#{e}".red
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/cocoapods-tag/command/tag.rb

@@ -0,0 +1,22 @@
+require 'cocoapods-tag/command/tag/create'
+require 'cocoapods-tag/command/tag/spec_push'
+
+module Pod
+  class Command
+    class Tag < Command
+
+      self.abstract_command = true
+      self.default_subcommand = 'create'
+
+      self.summary = '🚀 方便地帮助 pod 库打 tag'
+      self.description = <<-DESC
+        #{self.summary}
+      DESC
+
+      def initialize(argv)
+        super
+      end
+
+    end
+  end
+end

data/lib/cocoapods-tag/command.rb

@@ -0,0 +1 @@
+require 'cocoapods-tag/command/tag'

data/lib/cocoapods-tag/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsTag
+  VERSION = "0.0.1"
+end

data/lib/cocoapods-tag/helper/asker.rb

@@ -0,0 +1,65 @@
+require 'cocoapods-tag/gem_version.rb'
+
+class Helper
+  class Asker
+
+    def ask(question, required = false, pre_answer = nil, selections = nil, regx = nil )
+      question_msg = "#{question}\n"
+      question_msg += "旧值:#{pre_answer}\n" if pre_answer
+      keys = []
+      if selections && selections.is_a?(Hash)
+        keys = selections.keys
+        selections.each do |k, v|
+          question_msg += "#{k}:#{v}\n"
+        end
+      end
+      print question_msg.yellow
+      answer = ''
+      loop do
+        show_prompt
+        answer = STDIN.gets.chomp.strip
+        # 判断是否为空
+        if required && answer == ''
+          print "该项为必填项\n"
+          next
+        end
+        # 判断是否符合正则
+        if regx && regx.is_a?(Hash)
+          tip = regx['tip']
+          pattern = regx['pattern']
+          unless answer =~ pattern
+            print "#{tip}\n"
+            next
+          end
+        end
+        # 有固定选项 && 输入的值不在选项中
+        if selections && !keys.include?(answer)
+          print "请输入#{keys}中的一个值:\n"
+          next
+        end
+        break
+      end
+      answer
+    end
+
+    def welcome_message
+      message = <<-MSG
+👏🏻欢迎使用 `cocoapods-tag` 插件👏🏻
+👏🏻version: #{CocoapodsTag::VERSION}👏🏻
+
+      MSG
+      print message.green
+    end
+
+    def done_message
+      print "\n🌺 恭喜你完成任务 🌺\n".green
+    end
+
+    private
+
+    def show_prompt
+      print '> '.green
+    end
+
+  end
+end

data/lib/cocoapods-tag/native/validator.rb

@@ -0,0 +1,9 @@
+
+module Pod
+  class Validator
+    # 跳过 xcodebuild 校验
+    def perform_extensive_analysis(spec)
+      true
+    end
+  end
+end

data/lib/cocoapods-tag.rb

@@ -0,0 +1 @@
+require 'cocoapods-tag/gem_version'

data/lib/cocoapods_plugin.rb

@@ -0,0 +1 @@
+require 'cocoapods-tag/command'

data/spec/command/tag_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Tag do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ tag }).should.be.instance_of Command::Tag
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-tag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jensen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocoapods
+  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: 方便地帮助pod库打tag的CocoaPods插件
+email:
+- zys2@meitu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/cocoapods-tag.rb
+- lib/cocoapods-tag/command.rb
+- lib/cocoapods-tag/command/tag.rb
+- lib/cocoapods-tag/command/tag/create.rb
+- lib/cocoapods-tag/command/tag/spec_push.rb
+- lib/cocoapods-tag/gem_version.rb
+- lib/cocoapods-tag/helper/asker.rb
+- lib/cocoapods-tag/native/validator.rb
+- lib/cocoapods_plugin.rb
+- spec/command/tag_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Zhangyanshen/cocoapods-tag.git
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: 方便地帮助pod库打tag的CocoaPods插件，可以校验podspec的合法性
+test_files:
+- spec/command/tag_spec.rb
+- spec/spec_helper.rb