cocoapods-tag 0.0.1 → 0.0.4

checksums.yaml

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

data/README.md

@@ -1,6 +1,6 @@
 ## 简介
 
-`cocoapods-tag`是一个可以方便地帮助Pod库打tag的`CocoaPods`插件，插件采用问答的方式提示用户输入相应内容，简单、方便、快捷。
+`cocoapods-tag`是一个可以方便地帮助Pod库打tag的`CocoaPods`插件。
 
 ## 安装
 
@@ -12,25 +12,73 @@ $ gem install cocoapods-tag
 
 * 查看帮助
 
-```shell
-$ pod tag --help
-```
+  ```shell
+  $ pod tag --help
+  $ pod tag auto --help
+  ```
 
-* 创建tag并push到远端，并询问是否上传podspec到spec repo
+* 使用默认tag信息，如tag为“0.1.7”，那么tag信息为”v0.1.7“
 
-```shell
-$ pod tag
-# 或
-$ pod tag create
-```
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7"
+  ```
 
-* 上传podspec到spec repo
+* 使用自定义tag信息
 
-```shell
-$ pod tag spec-push REPO NAME.podspec
-```
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7"
+  ```
+
+* 推送`podspec`到指定的`spec repo`
+
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --spec-repo=xxx
+  ```
+
+* 跳过耗时校验
+
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --spec-repo=xxx --quick
+  ```
+
+* 指定tag推送到的远端仓库（可以通过`git remote -v`查看）
 
-## 演示gif
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --remote=origin
+  ```
+  
+* 指定工作目录（插件执行的目录）
+
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" --work-dir=xxx
+  ```
+
+* 为tag添加前后缀**（前后缀与版本号中间会自动用`-`分隔，不需要手动添加）**
+
+  以下面这行命令为例，`podspec`中的`version`为`0.1.7`，`source`字段中的`tag`为`mtxx-0.1.7-beta1`，最终推送到远端仓库的`tag`也是`mtxx-0.1.7-beta1`
+
+  ```shell
+  $ pod tag 0.1.7 "修改podspec版本号为0.1.7" --prefix="mtxx" --suffix="beta1"
+  ```
+
+* 单独推送`podspec`到指定`spec repo`
+
+  ```shell
+  $ pod tag spec-push REPO NAME.podspec
+  ```
+
+> 如有疑问，请使用`pod tag auto --help`查看帮助信息，里面有每个字段的解释
+
+## 版本号
+
+`CocoaPods`对版本号是有校验的，如果不符合规则当推送`podspec`到`spec repo`时会校验失败，具体校验正则如下：
+
+```ruby
+VERSION_PATTERN = '[0-9]+(?>\.[0-9a-zA-Z]+)*(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?'
+ANCHORED_VERSION_PATTERN = /\A\s*(#{VERSION_PATTERN})?\s*\z/
+```
 
-<img src='./cocoapods-tag.gif' width='100%' />
+大概解释一下就是：以`数字0-9`开头，中间可以包含`数字0-9`、`字母a-z A-Z`，特殊字符只能包含`.`和`-`，版本号前后可以有`0个或多个空格`
 
+> 1. `cocoapods-tag`已经对版本号做了正则校验，不符合上面正则的版本号是无法通过的，这里写出来主要是为了提醒大家注意版本号的规范
+> 2. 不建议版本号前后加空格

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

@@ -0,0 +1,85 @@
+require 'cocoapods-tag/tag'
+
+module Pod
+  class Command
+    class Tag < Command
+      class Auto < Tag
+        include Pod
+
+        self.summary = '创建 tag 并 push 到远端仓库，同时可以上传 podspec 到 spec repo'
+
+        self.description = <<-DESC
+#{self.summary}
+
+`VERSION`: podspec中的version字段，如果没有prefix和suffix，version与tag一样【必填】\n
+`COMMIT_MSG`: commit信息【必填】\n
+`TAG_MSG`: tag信息【可选，默认为"v[tag号]"，比如：tag是"0.0.1"，则tag信息是"v0.0.1"】\n
+
+e.g.\n
+1.使用默认tag信息\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7"\n
+2.使用自定义tag信息\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7"\n
+3.推送podspec到spec repo\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --spec-repo=xxx\n
+4.跳过耗时校验\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --quick\n
+5.指定工作目录\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" --work-dir=xxx\n
+6.为tag指定前后缀\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" --prefix="xxx" --suffix="xxx"\n
+7.指定tag推送到的远端仓库\n
+pod tag 0.1.7 "修改podspec版本号为0.1.7" --remote=xxx
+DESC
+
+        self.arguments = [
+          CLAide::Argument.new('VERSION', true ),
+          CLAide::Argument.new('COMMIT_MSG', true),
+          CLAide::Argument.new('TAG_MSG', false)
+        ]
+
+        def self.options
+          [
+            ['--quick', '跳过一些耗时校验，如：远端仓库是否已经有该tag'],
+            ['--remote=REMOTE', '指定tag推送到的远端仓库，可以通过`git remote -v`查看'],
+            ['--spec-repo=SPECREPO', 'podspec推送到的repo，可以通过`pod repo list`查看'],
+            ['--work-dir=WORKDIR', '执行命令的工作区'],
+            ['--prefix=PREFIX', 'tag前缀'],
+            ['--suffix=SUFFIX', 'tag后缀']
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          @version = argv.shift_argument
+          @commit_msg = argv.shift_argument
+          @tag_msg = argv.shift_argument
+          @quick = argv.flag?('quick', false)
+          @remote = argv.option('remote', false)
+          @spec_repo = argv.option('spec-repo', nil)
+          @work_dir = argv.option('work-dir', nil)
+          @prefix = argv.option('prefix', nil)
+          @suffix = argv.option('suffix', nil)
+          @tag = @version
+          unless @prefix.nil?
+            @tag = "#{@prefix}-#{@tag}"
+          end
+          unless @suffix.nil?
+            @tag = "#{@tag}-#{@suffix}"
+          end
+          super
+        end
+
+        def run
+          # 传入了工作目录
+          unless @work_dir.nil?
+            raise Informative, "不存在工作目录`#{@work_dir}`" unless File.exist?(@work_dir)
+            Dir.chdir(@work_dir)
+          end
+          tag = Pod::Tag.new(@version, @tag, @commit_msg, @tag_msg, @spec_repo, @quick, @remote)
+          tag.create
+        end
+
+      end
+    end
+  end
+end

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

@@ -10,7 +10,7 @@ module Pod
         GIT_REPO = ".git".freeze
         PODSPEC_EXT = %w[podspec podspec.json].freeze
 
-        self.summary = '创建 tag 并 push 到远端仓库，同时可以上传 podspec 到 spec repo'
+        self.summary = '【问答的方式】创建 tag 并 push 到远端仓库，同时可以上传 podspec 到 spec repo'
 
         self.description = <<-DESC
         #{self.summary}
@@ -241,13 +241,13 @@ module Pod
             print "推送commit到远端git仓库`#{@remote}/#{current_branch}`失败:#{e}".red
           end
 
-          print "\n创建tag:#{@tag}并推送至远端：\n".yellow
+          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
+            print "创建tag:`#{@tag}`并推送至远端失败:#{e}".red
           end
         end
 

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

@@ -1,4 +1,5 @@
-require 'cocoapods-tag/command/tag/create'
+require 'cocoapods-tag/command/tag/auto'
+# require 'cocoapods-tag/command/tag/create'
 require 'cocoapods-tag/command/tag/spec_push'
 
 module Pod
@@ -6,7 +7,7 @@ module Pod
     class Tag < Command
 
       self.abstract_command = true
-      self.default_subcommand = 'create'
+      self.default_subcommand = 'auto'
 
       self.summary = '🚀 方便地帮助 pod 库打 tag'
       self.description = <<-DESC

data/lib/cocoapods-tag/gem_version.rb

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

data/lib/cocoapods-tag/tag.rb

@@ -0,0 +1,295 @@
+require 'cocoapods-tag/helper/asker'
+
+module Pod
+  class Tag
+    include Pod
+
+    GITHUB_DOMAIN = "github.com".freeze
+    GIT_REPO = ".git".freeze
+    PODSPEC_EXT = %w[podspec podspec.json].freeze
+
+    def initialize(version, tag, commit_msg, tag_msg, spec_repo = nil, quick = false, remote_name = nil)
+      @version = version || raise(Informative, "缺少必填参数`version`")
+      @tag = tag || raise(Informative, "缺少必填参数`tag`")
+      @commit_msg = commit_msg || raise(Informative, "缺少必填参数`commit_msg`")
+      @tag_msg = tag_msg || "v#{@tag}"
+      @spec_repo = spec_repo
+      @quick = quick
+      @remote = remote_name
+    end
+
+    public
+
+    def create
+      require 'cocoapods-tag/native/validator'
+
+      # 欢迎语
+      welcome_message
+      # 正则校验版本号
+      check_version
+      # 检查本地是否有 spec_repo
+      check_spec_repo if @spec_repo
+      # 检查 git repo
+      check_git_repo
+      # 加载 podspec
+      load_podspec
+      # 修改前校验 podspec
+      lint_podspec("\n修改前校验`#{podspec}`\n")
+      # 修改 podspec
+      modify_podspec
+      # 修改后校验 podspec
+      lint_podspec("\n修改后校验`#{podspec}`\n")
+      # 推送 commit 到远端
+      git_commit_push
+      # 推送 tag 到远端
+      git_tag_push
+      # 推送 podspec 到 spec repo
+      push_podspec_to_repo if @spec_repo
+      # 结束语
+      done_message
+    end
+
+    private
+
+    def welcome_message
+      message = <<-MSG
+👏🏻欢迎使用 `cocoapods-tag` 插件👏🏻
+👏🏻version: #{CocoapodsTag::VERSION}👏🏻
+
+      MSG
+      print message.green
+    end
+
+    def done_message
+      print "\n🌺 恭喜你完成任务 🌺\n".green
+    end
+
+    # 正则校验版本号
+    def check_version
+      unless Pod::Vendor::Gem::Version.correct?(@version)
+        msg = <<-ERROR
+版本号`#{@version}`格式不正确
+版本号必须以数字`0-9`开头，可以包含数字`0-9`、字母`a-z A-Z`，特殊字符只能是`.`和`-`
+具体请参考CocoaPods校验版本号的正则：
+#{Pod::Vendor::Gem::Version::ANCHORED_VERSION_PATTERN}
+        ERROR
+        raise Informative, msg
+      end
+    end
+
+    # 检查本地 spec_repo
+    def check_spec_repo
+      print "检查本地spec仓库\n".yellow
+      repos = `pod repo list`.split("\n").reject { |repo| repo == '' || repo =~ /^-/ }
+      unless repos.include?(@spec_repo)
+        raise Informative, "本地不存在`#{@spec_repo}`仓库，请先使用`pod repo add`添加该仓库或使用`pod repo list`查看其他仓库"
+      end
+    end
+
+    # 检查 git repo
+    def check_git_repo
+      print "检查本地git仓库\n".yellow
+
+      # 本地是否有 .git 目录
+      git_repo = File.join(Dir.pwd, GIT_REPO)
+      raise Informative, "`#{Dir.pwd}`不存在git仓库，请先使用`git init`初始化git仓库" unless File.exist?(git_repo)
+
+      # 是否与远端仓库关联
+      raise Informative, "本地git仓库没有与远端仓库关联，请先使用`git remote add`关联远端仓库" if remote.nil?
+
+      unless @quick
+        # 校验本地 git 是否与远端仓库同步
+        print "\n检查本地git仓库是否与远端仓库同步\n".yellow
+        local_commit = `git rev-parse #{remote}/HEAD`.chomp
+        remote_commit = `git ls-remote --head #{remote} #{current_branch}`.split("\t")[0]
+        unless local_commit == remote_commit
+          msg = <<-MSG
+本地git仓库没有与远端仓库同步，请先执行以下操作：
+1.`git pull`或`git fetch + git rebase`拉取最新代码
+2.`git push`推送本地仓库commit
+          MSG
+          raise Informative, msg
+        end
+
+        # 检查本地是否已经有该 tag
+        print "\n检查本地仓库是否有tag:`#{@tag}`\n".yellow
+        raise Informative, "本地已经存在tag:#{@tag}" if `git tag`.split("\n").include?(@tag)
+
+        # 判断远端是否已经有该 tag
+        print "\n检查远端仓库是否有tag:`#{@tag}`\n".yellow
+        tags = `git ls-remote --tags #{remote}`.split("\n").select { |tag| tag.include?("refs/tags/#{@tag}") }
+        raise Informative, "远端仓库已经有该tag:#{@tag}" unless tags.empty?
+      end
+
+    end
+
+    # 加载 podspec
+    def load_podspec
+      raise Informative, "`#{Dir.pwd}`不存在podspec" if podspec.nil?
+
+      @spec = Specification.from_file(podspec)
+      raise Informative, "加载`#{podspec}`失败！" 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
+    end
+
+    # 修改podspec
+    def modify_podspec
+      return if podspec.nil?
+
+      print "\n修改`#{podspec}`\n".yellow
+      file = File.join(Dir.pwd, "#{podspec}")
+      # 匹配文件名后缀
+      if podspec =~ /.podspec$/
+        modify_podspec_ruby(file)
+      elsif podspec =~ /.podspec.json$/
+        modify_podspec_json(file)
+      end
+      print "`#{podspec}` modified done\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
+
+    # 推送 commit
+    def git_commit_push
+      print "\n推送commit到远端git仓库`#{remote}/#{current_branch}`\n".yellow
+      begin
+        `git add #{podspec}`
+        `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
+    end
+
+    # 推送 tag 到远端
+    def git_tag_push
+      print "\n创建tag:`#{@tag}`并推送至远端`#{remote}`\n".yellow
+      begin
+        `git tag -a #{@tag} -m "#{@tag_msg}"`
+        `git push #{remote} #{@tag}`
+      rescue Pod::StandardError => e
+        @error = e
+        print "创建tag:`#{@tag}`并推送至远端失败:#{e}".red
+      end
+    end
+
+    # 推送 podspec 到 spec repo
+    def push_podspec_to_repo
+      print "\n推送`#{podspec}`到`#{@spec_repo}`仓库\n".yellow
+      argvs = [
+        @spec_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}`到`#{@spec_repo}`仓库失败！#{e}".red
+      end
+    end
+
+    # 校验 podspec
+    def lint_podspec(tip = "\n校验`#{podspec}`\n")
+      print "#{tip}".yellow
+      argvs = [
+        podspec,
+        '--quick',
+        '--allow-warnings'
+      ]
+      lint = Pod::Command::Spec::Lint.new(CLAide::ARGV.new(argvs))
+      lint.validate!
+      lint.run
+    end
+
+    # 获取当前分支
+    def current_branch
+      @current_branch ||= begin
+                            `git branch`.split(' ')[1]
+                          end
+    end
+
+    # 获取当前目录下的 podspec
+    def podspec
+      @podspec ||= begin
+                     podspec = nil
+                     podspecs = Dir.glob("*.{#{PODSPEC_EXT.join(',')}}")
+                     unless podspecs.empty?
+                       podspec = podspecs.first
+                     end
+                     podspec
+                   end
+    end
+
+    def asker
+      @asker ||= begin
+                   Helper::Asker.new()
+                 end
+    end
+
+    # 获取远端仓库名
+    def remote
+      @remote ||= begin
+                    remote = nil
+                    remotes = `git remote`.split("\n")
+                    remote = remotes.first unless remotes.empty?
+                    if remotes.size > 1
+                      count = 0
+                      selections = {}
+                      remotes.map do |r|
+                        count += 1
+                        selections["#{count}"] = r
+                      end
+                      key = asker.ask("\n本地有多个关联的远端仓库，请选择：", true, nil, selections)
+                      remote = remotes["#{key}".to_i - 1]
+                    end
+                    remote
+                  end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-tag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Jensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -64,11 +64,13 @@ files:
 - lib/cocoapods-tag.rb
 - lib/cocoapods-tag/command.rb
 - lib/cocoapods-tag/command/tag.rb
+- lib/cocoapods-tag/command/tag/auto.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-tag/tag.rb
 - lib/cocoapods_plugin.rb
 - spec/command/tag_spec.rb
 - spec/spec_helper.rb