gitlab-branch-rename 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02aa63f9aa10433d20701e09795bc748f4b642ffe628c9ea5bfbc962939e85f
-  data.tar.gz: 5c5b106cd879f3a7f676b6013e6be7dfa2c8005951b75e34f6d09ba52e64462e
+  metadata.gz: 4c1e3af9e6a7bf863499c1cc50580df59ebd274a60a856c8b321515275fcf513
+  data.tar.gz: 3ab5d0012f1451416392fddd789b176009de4541296dc20ce655747361078c53
 SHA512:
-  metadata.gz: 626949e870d91827b5901ff5e62ffbe1a93e7972a00918425feba2960b61893ce6b15d0861da45db2e1ba61d7f30b821d51b97b4d908aaf2e703732d07b99a0c
-  data.tar.gz: dea4861e80089beb216cf3295d16d61ca3e5e8e5f5f380f4d28ca22514d052d1d3d2b07afbfefe7411fbcd16a8845ea3e04f348c62db5733ae300084f9e99578
+  metadata.gz: 18a3bc1ece6198c4a11c25c2b4ad6983eb84eadebb468a3d36d07aa11ab144e22ad88edcde2512eda268dbc09c77bd5c7ad93956e6e62fde58314f0c2e06fcb4
+  data.tar.gz: 218ebf0040a5790781d93b0be5489424804a84125d4767ab9cbe17f4771fcc59595923d4ff6fe4e9194d4dfc09782463fbb2a5a31375135a3a1b58a75a2369fd

data/Gemfile

@@ -2,3 +2,4 @@ source "https://rubygems.org"
 ruby "~> 2.6"
 
 gemspec
+gem "colorize", "~> 0.8.1"

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    gitlab-branch-rename (0.3.0)
+    gitlab-branch-rename (0.4.0)
       gitlab (~> 4.16)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    colorize (0.8.1)
     gitlab (4.16.1)
       httparty (~> 0.14, >= 0.14.0)
       terminal-table (~> 1.5, >= 1.5.1)
@@ -25,10 +26,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  colorize (~> 0.8.1)
   gitlab-branch-rename!
 
 RUBY VERSION
-   ruby 2.7.0p0
+   ruby 2.6.5p114
 
 BUNDLED WITH
-   2.1.4
+   1.17.3

data/Makefile

@@ -2,7 +2,7 @@ build:
 	gem build ./gitlab-branch-rename.gemspec
 
 clean:
-	rm gitlab-branch-rename-*.gem
+	-rm gitlab-branch-rename-*.gem
 
 install: build
 	gem install ./gitlab-branch-rename-*.gem

data/README.md

@@ -1,6 +1,6 @@
 # Gitlab Branch Rename
 
-This is a simple tool to rename your Gitlab project branches en-mass.
+This is a simple tool to rename your Gitlab project branches en masse.
 
 ## Motivation
 

data/gitlab-branch-rename.gemspec

@@ -1,18 +1,18 @@
 require_relative 'lib/gitlab_branch_rename/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gitlab-branch-rename"
-  spec.version       = GitlabBranchRename::VERSION
-  spec.authors       = ["AP Fritts"]
-  spec.email         = ["ap@apfritts.com"]
+  spec.name = "gitlab-branch-rename"
+  spec.version = GitlabBranchRename::VERSION
+  spec.authors = ["AP Fritts"]
+  spec.email = ["ap@apfritts.com"]
 
-  spec.summary       = "Tool to rename your Gitlab project branches en-mass"
-  spec.description   = "To support Black Lives Matter and try to create safer spaces, I wanted to rename " +
-      "all of my own default branches in Gitlab. I wasn't able to find any tools to do that, so I wrote " +
-      "this one. If you're unsure why this is important or want to better understand my personal understanding " +
-      "of why I wanted to make these changes, see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272"
-  spec.homepage      = "https://gitlab.com/apfritts/gitlab-branch-rename"
-  spec.license       = "MIT"
+  spec.summary = "Tool to rename your Gitlab project branches en masse"
+  spec.description = "To support Black Lives Matter and create safer spaces, I wanted to rename all of the default " +
+      "branches in my Gitlab account. I wasn't able to find any tools to do that, so I wrote this one. If you're " +
+      "unsure why this is important or want to better understand why I wanted to make these changes, see this " +
+      "great {Twitter thread}[https://twitter.com/mislav/status/1270388510684598272]."
+  spec.homepage = "https://gitlab.com/apfritts/gitlab-branch-rename"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0")
   end
-  spec.bindir        = "exe"
-  spec.executables   = "gitlab-branch-rename"
+  spec.bindir = "exe"
+  spec.executables = "gitlab-branch-rename"
   spec.require_paths = ["lib"]
 end

data/lib/gitlab_branch_rename/configuration.rb

@@ -5,7 +5,7 @@ module GitlabBranchRename
   class Configuration
     attr_accessor :token, :branch_to_rename, :new_branch_name,
                   :endpoint, :is_default_branch, :has_visibility, :minimum_access_level,
-                  :skip_confirm, :pretend, :logfile
+                  :skip_confirm, :pretend, :disable_color, :logfile
 
     def initialize
       # Required parameters
@@ -22,6 +22,7 @@ module GitlabBranchRename
       # Optional parameters
       self.skip_confirm = false
       self.pretend = false
+      self.disable_color = false
       self.logfile = STDOUT
     end
 
@@ -31,30 +32,33 @@ module GitlabBranchRename
         opts.banner = "Usage: gitlab-branch-rename --from <branch to rename> --to <new branch name> [options]"
         opts.separator ""
         opts.separator "Specific options:"
-        opts.on("--from OLD_BRANCH", "Branch to rename") do |from|
+        opts.on("--from OLD_BRANCH", "Branch to rename (required)") do |from|
           configuration.branch_to_rename = from
         end
-        opts.on("--to NEW_BRANCH", "New branch name") do |to|
+        opts.on("--to NEW_BRANCH", "New branch name (required)") do |to|
           configuration.new_branch_name = to
         end
-        opts.on("--endpoint ENDPOINT", "Gitlab server endpoint. default: Gitlab cloud") do |endpoint|
+        opts.on("--endpoint ENDPOINT", "Gitlab server endpoint, default: https://gitlab.com/api/v4") do |endpoint|
           configuration.endpoint = endpoint
         end
-        opts.on("--token-env-var ENV_VAR_NAME", "Environment variable to pull token out of") do |token_env_var|
+        opts.on("--token-env-var ENV_VAR_NAME", "Environment variable to use for Gitlab API token, default: GITLAB_ACCESS_TOKEN") do |token_env_var|
           configuration.token = ENV[token_env_var]
         end
-        opts.on("--only-if-default", "Rename only if it is the default branch") do
+        opts.on("--only-if-default", "Rename only if the old branch is currently the default project branch") do
           configuration.is_default_branch = true
         end
-        opts.on("--visibility VISIBILITIES", "Comma-separated list of project visibilities default: public,internal,private") do |visibility|
+        opts.on("--visibility VISIBILITIES", "Comma-separated list of project visibilities, default: public,internal,private") do |visibility|
           configuration.has_visibility = visibility.split ","
         end
         opts.on("--skip-confirm", "Skip confirmation before executing rename") do
           configuration.skip_confirm = true
         end
-        opts.on("--pretend", "Pretend to perform actions. Overrides confirm option") do
+        opts.on("--pretend", "Pretend to perform actions. Overrides --skip-confirm option") do
           configuration.pretend = true
         end
+        opts.on("--disable-color", "Disable output colors") do
+          configuration.disable_color = true
+        end
         opts.on("--logfile LOGFILE", "Logfile destination. Use - for STDOUT") do |logfile|
           if logfile == "-"
             configuration.logfile = STDOUT
@@ -72,8 +76,8 @@ module GitlabBranchRename
 
       begin
         optparse.parse!
-        raise OptionParser::MissingArgument.new('old branch name') if configuration.branch_to_rename.nil?
-        raise OptionParser::MissingArgument.new('new branch name') if configuration.new_branch_name.nil?
+        raise OptionParser::MissingArgument.new("old branch name") if configuration.branch_to_rename.nil?
+        raise OptionParser::MissingArgument.new("new branch name") if configuration.new_branch_name.nil?
       rescue OptionParser::InvalidOption, OptionParser::MissingArgument
         puts $!.to_s
         puts optparse

data/lib/gitlab_branch_rename/logger_configure.rb

@@ -1,13 +1,33 @@
+require "colorize"
+
 module GitlabBranchRename
   class LoggerConfigure
     def self.configure(configuration)
       logger = Logger.new(STDOUT)
       logger.formatter = proc do |severity, datetime, progname, msg|
         date_format = datetime.to_datetime.strftime("%Q")
-        if severity == "INFO" or severity == "WARN"
-          "#{severity}  #{date_format} #{msg}\n"
+        output = nil
+        color = :black
+        case severity
+        when "DEBUG"
+          output = "D #{date_format} #{msg}\n"
+          color = :light_black
+        when "INFO"
+          output = "I #{date_format} #{msg}\n"
+          color = :black
+        when "WARN"
+          output = "W #{date_format} #{msg}\n"
+          color = :yellow
+        when "ERROR"
+          output = "E #{date_format} #{msg}\n"
+          color = :red
         else
-          "#{severity} #{date_format} #{msg}\n"
+          output = "? #{date_format} #{msg}\n"
+        end
+        if configuration.disable_color
+          output
+        else
+          output.colorize(color)
         end
       end
       logger

data/lib/gitlab_branch_rename/main.rb

@@ -27,6 +27,9 @@ module GitlabBranchRename
     logger.info("    git checkout #{c.new_branch_name}")
     logger.info("    git remote set-head `git remote` #{c.new_branch_name}")
     logger.info("    git branch -d #{c.branch_to_rename}")
+    logger.info("")
+    logger.info("Or all as one line:")
+    logger.info("    git fetch `git remote` --prune && git checkout trunk && git remote set-head `git remote` trunk && git branch -d master")
     logger.close
   end
 end

data/lib/gitlab_branch_rename/operation.rb

@@ -62,7 +62,7 @@ module GitlabBranchRename
 
         # Confirm or pretend
         msg = "Rename #{project.path_with_namespace} branch #{@configuration.branch_to_rename} to #{@configuration.new_branch_name} " +
-            (branch_protection_parameters ? "with" : "without") + " protection"
+            (branch_protection_parameters.nil? ? "without" : "with") + " protection"
         if @configuration.pretend
           puts(msg)
           @logger.info(msg)
@@ -86,17 +86,17 @@ module GitlabBranchRename
           Gitlab.create_branch(project.id, @configuration.new_branch_name, old_branch.name)
           @logger.debug("Created new branch with name #{@configuration.new_branch_name}")
         rescue StandardError => e
-          @logger.error(e)
+          @logger.error("Error creating new branch: #{e}")
           next
         end
 
         # Protect branch
-        unless branch_protection_parameters
+        unless branch_protection_parameters.nil?
           begin
             Gitlab.protect_branch(project.id, @configuration.new_branch_name, branch_protection_parameters)
             @logger.debug("Protected branch with parameters #{branch_protection_parameters}")
           rescue StandardError => e
-            @logger.error(e)
+            @logger.error("Error protecting new branch: #{e} with #{branch_protection_parameters}")
           end
         end
 
@@ -107,16 +107,16 @@ module GitlabBranchRename
           Gitlab.edit_project(project.id, {default_branch: @configuration.new_branch_name})
           @logger.debug("Changed default branch")
         rescue StandardError => e
-          @logger.error(e)
+          @logger.error("Error changing default branch: #{e}")
         end
 
         # Unprotect protected branches
-        unless branch_protection_parameters
+        if branch_protection_parameters
           begin
             Gitlab.unprotect_branch(project.id, old_branch.name)
             @logger.debug("Unprotected old branch")
           rescue StandardError => e
-            @logger.error(e)
+            @logger.error("Error unprotecting old branch: #{e}")
           end
         end
 
@@ -125,7 +125,7 @@ module GitlabBranchRename
           Gitlab.delete_branch(project.id, old_branch.name)
           @logger.debug("Deleted old branch")
         rescue StandardError => e
-          @logger.error(e)
+          @logger.error("Error deleting old branch: #{e}")
         end
       end
     end

data/lib/gitlab_branch_rename/version.rb

@@ -1,3 +1,3 @@
 module GitlabBranchRename
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-branch-rename
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - AP Fritts
@@ -24,11 +24,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.16'
-description: 'To support Black Lives Matter and try to create safer spaces, I wanted
-  to rename all of my own default branches in Gitlab. I wasn''t able to find any tools
-  to do that, so I wrote this one. If you''re unsure why this is important or want
-  to better understand my personal understanding of why I wanted to make these changes,
-  see this Twitter thread: https://twitter.com/mislav/status/1270388510684598272'
+description: To support Black Lives Matter and create safer spaces, I wanted to rename
+  all of the default branches in my Gitlab account. I wasn't able to find any tools
+  to do that, so I wrote this one. If you're unsure why this is important or want
+  to better understand why I wanted to make these changes, see this great {Twitter
+  thread}[https://twitter.com/mislav/status/1270388510684598272].
 email:
 - ap@apfritts.com
 executables:
@@ -44,7 +44,6 @@ files:
 - LICENSE.txt
 - Makefile
 - README.md
-- bin/console
 - exe/gitlab-branch-rename
 - gitlab-branch-rename.gemspec
 - gitlab-branch-rename.gemspec.lock
@@ -78,5 +77,5 @@ requirements: []
 rubygems_version: 3.0.8
 signing_key:
 specification_version: 4
-summary: Tool to rename your Gitlab project branches en-mass
+summary: Tool to rename your Gitlab project branches en masse
 test_files: []

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "main"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)