github-renaming 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e519037df2e9bbe4bc12eba18ca1b0fc1a2faecc015a3fcb80c8db7771ea21ee
+  data.tar.gz: c174239f91191baa6d2cb4cf7a1fbceefee56dc57f1735f6da0880c6894113fb
+SHA512:
+  metadata.gz: 87b324661b20af37943818d4dbfe1d5e3225557bdc7f4ff26afbec065553f732016a90d1165d3f48135b48bb46d3eff90b754d2d69e9447cdb4de158c16015f5
+  data.tar.gz: 111818458a60aafd53acbf05dcd1657d07de296368290ebcb6d6817d9068c2866b55da9f3d7ca294e37cd48b9f56d74070f2a639ac06328c5c29921d3ee603e6

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in github-renaming.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    github-renaming (0.1.0)
+      highline (~> 2.0.3)
+      httparty (~> 0.18.1)
+      octokit (~> 4.21.0)
+      thor (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    faraday (1.5.1)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    highline (2.0.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0704)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    octokit (4.21.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    thor (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github-renaming!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2021 qiuzhifei <qiuzhifei521@gmail.com>
+
+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,21 @@
+# Renaming the default branch
+
+Renaming the default branch of our own repositories from master to main.
+
+## Installation
+```
+gem install github-renaming
+```
+
+## Usage
+```
+github-renaming default-branch <old-branch> <new-branch> -t <token> -r <user/repo>
+```
+Rename master to main
+```
+github-renaming default-branch master main -t <token> -r <user/repo>
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "github/renaming"
+
+# 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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/github-renaming

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "github/renaming"
+
+Github::Renaming.start(ARGV)

data/github-renaming.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/github/renaming/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-renaming"
+  spec.version       = Github::VERSION
+  spec.authors       = ["qiuzhifei"]
+  spec.email         = ["qiuzhifei521@gmail.com"]
+
+  spec.summary       = "Renaming the default branch on Github"
+  spec.description   = "Renaming the default branch on Github"
+  spec.homepage      = "https://github.com/QiuZhiFei/github-renaming"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "thor",       "~> 1.1.0"
+  spec.add_dependency "octokit",    "~> 4.21.0"
+  spec.add_dependency "httparty",   "~> 0.18.1"
+  spec.add_dependency "highline",   "~> 2.0.3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/github/cli.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "octokit"
+require "thor"
+require "httparty"
+require "highline"
+require_relative "constant"
+require_relative "repox"
+
+module Github
+  module CLI
+    include Logging
+    
+    def check_token(*args, options)
+      token = options[:token] || ""
+      _assert_not_nil_token(token)
+      
+      url = "https://api.github.com/users/codertocat"
+      res = HTTParty.get(url, headers: { 
+      "Authorization" => "token #{token}"})
+      data = JSON.parse(res.body)
+      return unless !data.member?("login")
+      logger.error "Github token is invalid."
+      exit 1
+    end
+    
+    def rename_default_branch(*args, options)
+      token = options[:token]
+      
+      repo_path = options[:repo] || ""
+      _assert_not_nil_repo(repo_path)
+      
+      old_branch = args[0] || "master"
+      new_branch = args[1] || "main"
+      if old_branch == new_branch
+        logger.error "Branch #{branch} is the same as #{based_on_branch}"
+        exit 1
+      end
+      
+      _rename_prompt(repo_path, token, old_branch, new_branch)
+      
+      repo = Github::RepoX.new(token, repo_path)
+      # get the sha
+      old_branch_sha = repo.branch_sha(old_branch)
+      # create new branch
+      logger.debug "Creating branch #{new_branch} based on #{old_branch}."
+      repo.create_branch(new_branch, old_branch_sha) {
+        _delete_branch_prompt(repo_path, token, new_branch)
+        logger.debug "Deleting branch #{new_branch}."
+        repo.delete_branch(new_branch)
+      }
+      # set default branch
+      logger.debug "Setting #{new_branch} as default branch."
+      repo.set_default_branch(new_branch)
+      # delete old branch
+      logger.debug "Deleting #{old_branch}."
+      repo.delete_branch(old_branch)
+
+      # local
+      if new_branch == "main"
+        global_default_branch = `git config --global init.defaultBranch`.strip
+        if global_default_branch != new_branch
+          `git config --global init.defaultBranch #{new_branch}`
+          logger.debug "Setting #{new_branch} as global default branch."
+        end
+      end
+      
+      logger.info "Finished."
+    end
+    
+    private
+    def _rename_prompt(repo_path, token, old_branch, new_branch)
+      answer = HighLine.agree("
+------------------------------------
+Action: Renaming branch
+Repo: #{repo_path}
+Token: #{token}
+Create new branch: #{new_branch}
+Delete old branch: #{old_branch}
+Rename default branch: #{old_branch} -> #{new_branch}
+------------------------------------
+Continue? (y/n) ")
+      if answer == false
+        exit 1
+      end
+    end
+
+    def _delete_branch_prompt(repo_path, token, branch)
+      answer = HighLine.agree("
+------------------------------------
+Action: Deleting branch
+Repo: #{repo_path}
+Token: #{token}
+Delete branch: #{branch}
+------------------------------------
+Continue? (y/n) ")
+      if answer == false
+        exit 1
+      end
+    end
+    
+    def _assert_not_nil_token(token)
+      return unless token.empty?
+      logger.error "You must provide a GitHub token to use this command. See 'github-renaming --help'.
+      
+Creating a personal access token
+https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token"
+      exit 1
+    end
+    
+    def _assert_not_nil_repo(repo)
+      return unless repo.empty?
+      logger.error "You must provide a GitHub repo to use this command. See 'github-renaming --help'."
+      exit 1
+    end
+  end
+end
+
+module Github
+  extend CLI
+end

data/lib/github/constant.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Logging
+  def logger
+    Logging.logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+end

data/lib/github/renaming.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "thor"
+require "logger"
+require_relative "renaming/version"
+require_relative "cli"
+require_relative "constant"
+
+module Github
+  class Renaming < Thor
+    class_option :token, type: :string, aliases: '-t', desc: "User's Github Token at github.com"
+    class_option :repo, type: :string, aliases: '-r', desc: "User's Repo at at github.com"
+    
+    desc "default-branch <old-branch> <new-branch>", "Rename default branch on GitHub"
+    map "-d" => :default_branch
+    def default_branch(*args)
+      prepare(*args)
+      Github.rename_default_branch(*args, options)
+    end
+    
+    desc "version", "Show github-renaming version number and quit (aliases: `v`)."
+    map ["v", "-v", "--version"] => :version
+    def version
+      say "github-renaming #{Github::VERSION}"
+    end
+
+    private
+    def prepare(*args)
+      Github.check_token(*args, options)
+    end
+  end
+end

data/lib/github/renaming/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Github
+  VERSION = "0.1.0"
+end

data/lib/github/repox.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "octokit"
+require_relative "constant"
+
+module Github
+  class RepoX
+    include Logging
+
+    def initialize(token, repo_path)
+      @client = Octokit::Client.new(access_token: token)
+
+      begin
+        @repo = @client.repo(repo_path)
+      rescue Octokit::Error => e
+        logger.error "Repo #{repo_path} does not exist."
+        exit 1
+      end
+    end
+    
+    # description
+    def description
+      puts <<-EOS
+--------------------------------------
+Repo description
+
+name: 
+#{@repo.full_name}
+
+default_branch:
+#{default_branch}
+
+branches:
+#{branches.map { |value| value.name }}
+--------------------------------------
+      EOS
+    end
+
+    # get name
+    def name
+      @repo.full_name
+    end
+    
+    # get default branch
+    def default_branch
+      @repo.default_branch
+    end
+    
+    # get all branches
+    def branches
+      @client.branches(@repo.full_name)
+    end
+    
+    # get branch sha
+    def branch_sha(branch)
+      begin
+        ref = @client.ref(@repo.full_name, "heads/#{branch}")
+      rescue Octokit::Error => e
+        logger.error "Branch #{branch} does not exist."
+        exit 1
+      end
+      if ref.key?(:object)
+        return ref.object.sha
+      end
+      logger.error "Branch #{branch} does not exist."
+      exit 1
+    end
+    
+    # create a new branch
+    def create_branch(branch, sha, &block)
+      begin
+        @client.create_ref(@repo.full_name, "heads/#{branch}", sha)
+      rescue Octokit::Error => e
+        if e.message.include?("422 - Reference already exists")
+          logger.debug "Branch #{branch} already exists."
+          block.call if block_given?
+        else
+          logger.error "Branch #{branch} already exists."
+          exit 1
+        end
+      end
+    end
+    
+    # delete a branch
+    def delete_branch(branch)
+      @repo.delete_ref("heads/#{branch}")
+    end
+    
+    # set default branch
+    def set_default_branch(branch)
+      @client.edit_repository(@repo.full_name, default_branch: branch)
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: github-renaming
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- qiuzhifei
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.21.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description: Renaming the default branch on Github
+email:
+- qiuzhifei521@gmail.com
+executables:
+- github-renaming
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/github-renaming
+- github-renaming.gemspec
+- lib/github/cli.rb
+- lib/github/constant.rb
+- lib/github/renaming.rb
+- lib/github/renaming/version.rb
+- lib/github/repox.rb
+homepage: https://github.com/QiuZhiFei/github-renaming
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.23
+signing_key:
+specification_version: 4
+summary: Renaming the default branch on Github
+test_files: []