cocoapods-tag 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e08286edd1ef94599d7c41fee1be27a19b816f4ef414e2ff4f13458d140b883
-  data.tar.gz: 4513e86cf577e8965fc18db0bc123a302ca58f8a4a80bdd3e459547eac0e99f3
+  metadata.gz: 8bcf6776d9aecce496fc5ee724891375b4244907a9cec5dc0cc68e0bec72e9b1
+  data.tar.gz: 47e3f0020ec0f2ebd1be45ae35fdf49f94d7f185a9f46b0186abd0681fe0fd2f
 SHA512:
-  metadata.gz: acbeb468411de55cc4cf718caa298dbad09836d425986859f642ca50a8c17329fa47f8c09aa9b36dde2aa8161d82a95676236b8caf8701f730e67b86e2115547
-  data.tar.gz: b1ee42a404c0bad37eff6ee43ddb528d79001055a68d36cde70c619093837c40d1e59a55d7ff27d6c6d133665e7b0ee2e58aaca8b93691bd24e1f165f98e406b
+  metadata.gz: 0dec037cdb109bb8396ff9871f3ca00b89c83da4f1574f1e2df71d65eecec348523205d93a206819bd7c39882fd4a991e8b65903b95892e9599bf2db6d39dec9
+  data.tar.gz: 3e8190ebe75421b767616c7590646f8679fce382cf87bd3546d703643d6144a400df0fe6878e5a83a09c36b43717affb12a3cdaec6a2fa19b1559d1eb61436a4

data/README.md

@@ -41,6 +41,26 @@ $ gem install cocoapods-tag
   $ pod tag 0.1.7 "修改podspec版本号为0.1.7" "版本0.1.7" --spec-repo=xxx --quick
   ```
 
+* 指定tag推送到的远端仓库（可以通过`git remote -v`查看）
+
+  ```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
@@ -49,5 +69,16 @@ $ gem install cocoapods-tag
 
 > 如有疑问，请使用`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/
+```
 
+大概解释一下就是：以`数字0-9`开头，中间可以包含`数字0-9`、`字母a-z A-Z`，特殊字符只能包含`.`和`-`，版本号前后可以有`0个或多个空格`
 
+> 1. `cocoapods-tag`已经对版本号做了正则校验，不符合上面正则的版本号是无法通过的，这里写出来主要是为了提醒大家注意版本号的规范
+> 2. 不建议版本号前后加空格

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

@@ -11,11 +11,11 @@ module Pod
         self.description = <<-DESC
 #{self.summary}
 
-`TAG`: tag号【必填】\n
+`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
 
-eg:\n
+e.g.\n
 1.使用默认tag信息\n
 pod tag 0.1.7 "修改podspec版本号为0.1.7"\n
 2.使用自定义tag信息\n
@@ -23,33 +23,61 @@ 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" --spec-repo=xxx --quick
+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('TAG', true ),
+          CLAide::Argument.new('VERSION', true ),
           CLAide::Argument.new('COMMIT_MSG', true),
           CLAide::Argument.new('TAG_MSG', false)
         ]
 
         def self.options
           [
-            ['--spec-repo=SPECREPO', 'podspec 推送到的 spec repo ，可以通过`pod repo list`查看'],
-            ['--quick', '跳过一些耗时校验，如：远端仓库是否已经有该 tag ']
+            ['--quick', '跳过一些耗时校验，如：远端仓库是否已经有该tag'],
+            ['--skip-push-commit', '跳过推送commit到对应分支'],
+            ['--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)
-          @tag = argv.shift_argument
+          @version = argv.shift_argument
           @commit_msg = argv.shift_argument
           @tag_msg = argv.shift_argument
-          @spec_repo = argv.option('spec-repo', nil)
           @quick = argv.flag?('quick', false)
+          @skip_push_commit = argv.flag?('skip-push-commit', 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
-          tag = Pod::Tag.new(@tag, @commit_msg, @tag_msg, @spec_repo, @quick)
+          # 传入了工作目录
+          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, @skip_push_commit)
           tag.create
         end
 

data/lib/cocoapods-tag/gem_version.rb

@@ -1,3 +1,3 @@
 module CocoapodsTag
-  VERSION = "0.0.2"
+  VERSION = "0.0.5"
 end

data/lib/cocoapods-tag/tag.rb

@@ -8,12 +8,15 @@ module Pod
     GIT_REPO = ".git".freeze
     PODSPEC_EXT = %w[podspec podspec.json].freeze
 
-    def initialize(tag, commit_msg, tag_msg, spec_repo = nil, quick = false)
+    def initialize(version, tag, commit_msg, tag_msg, spec_repo = nil, quick = false, remote_name = nil, skip_push_commit = false )
+      @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
+      @skip_push_commit = skip_push_commit
     end
 
     public
@@ -23,16 +26,20 @@ module Pod
 
       # 欢迎语
       welcome_message
+      # 正则校验版本号
+      check_version
       # 检查本地是否有 spec_repo
       check_spec_repo if @spec_repo
       # 检查 git repo
       check_git_repo
       # 加载 podspec
       load_podspec
-      # 校验 podspec
-      lint_podspec
+      # 修改前校验 podspec
+      lint_podspec("\n修改前校验`#{podspec}`\n")
       # 修改 podspec
       modify_podspec
+      # 修改后校验 podspec
+      lint_podspec("\n修改后校验`#{podspec}`\n")
       # 推送 commit 到远端
       git_commit_push
       # 推送 tag 到远端
@@ -58,6 +65,19 @@ module Pod
       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
@@ -69,7 +89,7 @@ module Pod
 
     # 检查 git repo
     def check_git_repo
-      # print "检查本地git仓库：\n".yellow
+      print "检查本地git仓库\n".yellow
 
       # 本地是否有 .git 目录
       git_repo = File.join(Dir.pwd, GIT_REPO)
@@ -78,28 +98,44 @@ module Pod
       # 是否与远端仓库关联
       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
+      # 是否处于 detached 状态
+      raise Informative, "当前处于detached状态，请先切到分支再进行操作" if current_branch == "HEAD"
+
+      # # 是否有未提交的改动
+      # raise Informative, "本地有未提交的改动，请先提交或暂存" unless `git status --porcelain`.split("\n").empty?
 
-        # 检查本地是否已经有该 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
+      raise Informative, "本地仓库已经存在tag:#{@tag}" if `git tag`.split("\n").include?(@tag)
 
+      unless @quick
         # 判断远端是否已经有该 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?
+        raise Informative, "远端仓库已经有tag:#{@tag}" unless tags.empty?
+
+        # 校验本地 git 是否与远端仓库同步
+        print "\n检查本地git仓库是否与远端仓库同步\n".yellow
+        `git fetch #{remote}`
+        remote_br = `git rev-parse --abbrev-ref #{current_branch}@{u}`
+        unless remote_br == ''
+          remote_commit_count = `git rev-list --right-only --count #{current_branch}...#{remote_br}`.chomp.to_i
+          local_commit_count = `git rev-list --left-only --count #{current_branch}...#{remote_br}`.chomp.to_i
+          # 本地落后远端
+          unless remote_commit_count == 0
+            msg = <<-MSG
+本地git仓库落后于远端仓库`#{remote_commit_count}`个提交
+请先执行`git pull`或`git fetch #{remote} + git rebase #{remote_br}`拉取最新代码
+            MSG
+            raise Informative, msg
+          end
+
+          # 本地有未 push 的 commit
+          unless local_commit_count == 0
+            msg = "本地git仓库有`#{local_commit_count}`个commit未提交，请先执行`git push`提交"
+            raise Informative, msg
+          end
+        end
       end
 
     end
@@ -142,18 +178,18 @@ module Pod
     def modify_podspec_ruby(file)
       org_source = @spec_hash['source']
       des_source = "{ :git => '#{org_source['git']}', :tag => '#{@tag}' }"
-      File.open(file, 'r') do |f|
+      File.open(file, 'r:utf-8') do |f|
         lines = []
         f.each_line do |line|
           if line =~ /(^\s*.+\.version\s*=\s*).*/
-            line = line.sub(/(^\s*.+\.version\s*=\s*).*/, "#{$1}'#{@tag}'")
+            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|
+        File.open(file, 'w:utf-8') do |f|
           f.write(lines.join(""))
         end
       end
@@ -161,12 +197,12 @@ module Pod
 
     # 修改 *.podspec.json
     def modify_podspec_json(file)
-      @spec_hash['version'] = @tag
+      @spec_hash['version'] = @version
       @spec_hash['source'] = {
         'git'=> @spec_hash['source']['git'],
         'tag'=> "#{@tag}"
       }
-      File.open(file, 'w') do |f|
+      File.open(file, 'w:utf-8') do |f|
         f.write(@spec_hash)
       end
     end
@@ -177,7 +213,7 @@ module Pod
       begin
         `git add #{podspec}`
         `git commit -m "#{@commit_msg}"`
-        `git push #{remote} #{current_branch}`
+        `git push #{remote} #{current_branch}` unless @skip_push_commit
       rescue Pod::StandardError => e
         @error = e
         print "推送commit到远端git仓库`#{remote}/#{current_branch}`失败:#{e}".red
@@ -230,7 +266,7 @@ module Pod
     # 获取当前分支
     def current_branch
       @current_branch ||= begin
-                            `git branch`.split(' ')[1]
+                            `git rev-parse --abbrev-ref HEAD`.chomp
                           end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-tag
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Jensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods