git_helper 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8f1759701099c875fd08dd2b4fe00f55732c7d005a3437a5adea5019bbcf78b
-  data.tar.gz: e659e2c1bc529059854e9d35daa3d8afea6f9e13877d6cd1681b621a299995f0
+  metadata.gz: 929b169f934f99ecd468e7fb78080b0ea0059192f912ee8492ee35c0dfae7bfa
+  data.tar.gz: 9a5302fc0a26595b048cbc03e2d2e6e2d4ad4b207219e2c06b1cc732fb7be5b0
 SHA512:
-  metadata.gz: 01f01fcf9cb8e962a07488e76ae04f2ac0b0e612c089b7479da39f26598adccd8c005fa85d38bd430a5642fc8d1760e4738d3ef76759c77eb7cbce1926ff34d3
-  data.tar.gz: 9e7b63ec6d2ed7b62ca689c1cfd33eeb5830becdfef13fffe06f068a9181834393e5f4ff3f1885df2f63b12a1a90f4f22024d4d72a3d88ea4c0c7191a8fa90a8
+  metadata.gz: f6dd7318464df844707836bef67b9cb9addc580785edb8a57cf694f9e5a3af69f7efe18888aa0936cfdd3bfbc4a3848c90e142603501a2d3251d9618c26ed19c
+  data.tar.gz: ca79af7651e083f543a1a5bb89f54cec6506958dd653556afa235a3b0bad82a673fa70a3df7f9460033c1f76c5bcd76eb4081127c68f7e237a714e383d028a53

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (1.0.0)
+    git_helper (2.0.0)
       gitlab (~> 4.16)
       gli (~> 2.13)
       highline (~> 2.0)
@@ -61,18 +61,23 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (4.0.6)
-    rake (12.3.3)
+    rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (2.99.0)
-      rspec-core (~> 2.99.0)
-      rspec-expectations (~> 2.99.0)
-      rspec-mocks (~> 2.99.0)
-    rspec-core (2.99.2)
-    rspec-expectations (2.99.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.99.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     sawyer (0.8.2)
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
@@ -88,10 +93,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1)
   git_helper!
-  guard (~> 2.6)
   guard-rspec (~> 4.3)
-  rake (~> 12.3.3)
-  rspec (~> 2.99)
+  rake (~> 13.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -71,7 +71,7 @@ If you're going to make using git workflows easier, might as well provide lots o
 
 This can be used when switching the owners of a GitHub repo. When you switch a username, GitHub only makes some changes for you. With this command, you no longer have to manually walk through local repo and switch the remotes from each one into a remote with the new username.
 
-This command will go through every directory in a directory, see if it is a git directory, and then will check to see if the old username is included in the remote URL of that git directory. If it is, then the command will change the remote URL to instead point to the new username's remote URL. To run the command, run:
+This command will go through every directory in a directory, and see if it is a git directory. It will then ask the user if they wish to process the git directory in question. The command does not yet know if there's any changes to be made. If the user says 'yes', then it will check to see if the old username is included in the remote URL of that git directory. If it is, then the command will change the remote URL to instead point to the new username's remote URL. To run the command, run:
 
 ```bash
 git-helper change-remote OLD-OWNER NEW-OWNER
@@ -93,37 +93,49 @@ git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/CORRECT-DEFAULT-BR
 
 ### `clean-branches`
 
-This command will bring you to the repository's default branch, `git pull`, `git fetch -p`, and will clean up your local branches on your machine by seeing which ones are existing on the remote, and updating yours accordingly. To run:
+This command will bring you to the repository's default branch, `git pull`, `git fetch -p`, and will clean up your local branches on your machine by seeing which ones are existing on the remote, and updating yours accordingly. To clean your local branches, run:
 
 ```bash
 git-helper clean-branches
 ```
 
-### `empty-commit`
+### `code-request`
 
-For some reason, I'm always forgetting the commands to create an empty commit. So with this command, it becomes easy. The commit message of this commit will be `'Empty commit'`. To run the command, run:
+This command can be used to handily make new GitHub/GitLab pull/merge requests and to merge those requests from the command line. The command uses either the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) or [`Gitlab` client](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Usage](#usage).
+
+After setup is complete, you can call the file, and send in a flag indicating whether to create a code request, `-c`, or to merge a code request, `-m`.
 
 ```bash
-git-helper empty-commit
+git-helper code-request -c
+# OR
+git-helper code-request -m
 ```
 
-### `merge-request`
+If you're trying to create a code request, the command will provide an autogenerated code request title based on your branch name. It will separate the branch name by `'_'` if underscores are in the branch, or `'-'` if dashes are present. Then it will join the list of words together by spaces. If there's a pattern in the form of `jira-123` or `jira_123` in the first part of the branch name, then it'll add `JIRA-123` to the first part of the code request. You can respond 'yes' or 'no'. If you respond 'no', you can provide your own code request title.
+
+The command will also ask you if the default branch of the repository is the proper base branch to use. You can say 'yes' or 'no'. If you respond 'no', then you can give the command your chosen base base.
+
+Lastly, for GitHub, it'll ask the user to apply any code request templates found at any `*/pull_request_template.md` file or any file in `.github/PULL_REQUEST_TEMPLATE/*.md`. Applying any template is optional, and a user can make an empty pull request if they desire. For GitLab, it'll ask the user to apply any merge request templates found at any `*/merge_request_template.md` file or any file in `.gitlab/merge_request_templates/*.md`. Applying any template is optional, and from the command's standpoint, a user can make an empty merge request if they desire. If a GitLab project automatically adds a template, then it may create a merge request with a default template anyway.
+
+If you're requesting to merge a code request, the command will ask you the number ID of the code request you wish to merge. For GitHub, the command will also ask you what type of merge to do: regular merging, squashing, or rebasing. The commit message to use during the merge/squash/rebase will be the title of the pull request. For GitLab, the command will also ask you what type of merge to do: regular merging or squashing. The commit message to use during the merge/squash will be the title of the merge request.
 
-This command can be used to handily make new GitLab merge requests and to accept merge requests from the command line. The command uses the Ruby wrapper [`Gitlab`](https://github.com/NARKOZ/gitlab) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Usage](#usage).
+If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+
+### `empty-commit`
 
-After setup is complete, you can call the file, and send in a flag indicating whether to create a pull request, `-c`, or to merge a pull request, `-m`.
+For some reason, I'm always forgetting the commands to create an empty commit. So with this command, it becomes easy. The commit message of this commit will be `'Empty commit'`. To run the command, run:
 
 ```bash
-git-helper merge-request -c
-# OR
-git-helper merge-request -m
+git-helper empty-commit
 ```
 
-If you're trying to create a merge request, the command will provide an autogenerated merge request title based on your branch name (separated by `_`). You can respond 'yes' or 'no'. If you respond 'no', you can provide your own merge request title. The command will also ask you if the default branch of the repository is the proper base branch to use. You can say 'yes' or 'no'. If you respond 'no', then you can give the command your chosen base base. Lastly, it'll ask the user to apply any merge request templates found at any `*/merge_request_template.md` file or any file in `.gitlab/merge_request_templates/*.md`. Applying any template is optional, and from the command's standpoint, a user can make an empty merge request if they desire. If a GitLab project automatically adds a template, then it may create a merge request with a default template anyway.
+### `forget-local-commits`
 
-If you're requesting to merge a merge request, the command will ask you the number ID of the merge request you wish to accept. The command will also ask you what type of merge to do: regular merging or squashing. The commit message to use during the merge/squash will be the title of the pull request.
+This command is handy if you locally have a bunch of commits you wish to completely get rid of. This command basically does a hard reset to `origin/HEAD`. Once you forget them, they're completely gone, so run carefully. To test it out, run:
 
-If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
+```bash
+git-helper forget-local-commits
+```
 
 ### `new-branch`
 
@@ -137,24 +149,6 @@ git-helper new-branch NEW_BRANCH_NAME
 
 The command either accepts a branch name right away or it will ask you for the name of your new branch. Make sure your input does not contain any spaces or special characters.
 
-### `pull-request`
-
-This command can be used to handily make new GitHub pull requests and to merge pull requests from the command line. The command uses the [`Octokit::Client`](https://octokit.github.io/octokit.rb/Octokit/Client.html) to do this, so make sure you have a `.git_config.yml` file set up in the home directory of your computer. For instructions on how to do that, see [Usage](#usage).
-
-After setup is complete, you can call the file, and send in a flag indicating whether to create a pull request, `-c`, or to merge a pull request, `-m`.
-
-```bash
-git-helper pull-request -c
-# OR
-git-helper pull-request -m
-```
-
-If you're trying to create a pull request, the command will provide an autogenerated pull request title based on your branch name (separated by `_`). You can respond 'yes' or 'no'. If you respond 'no', you can provide your own pull request title. The command will also ask you if the default branch of the repository is the proper base branch to use. You can say 'yes' or 'no'. If you respond 'no', then you can give the command your chosen base base. Lastly, it'll ask the user to apply any pull request templates found at any `*/pull_request_template.md` file or any file in `.github/PULL_REQUEST_TEMPLATE/*.md`. Applying any template is optional, and a user can make an empty pull request if they desire.
-
-If you're requesting to merge a pull request, the command will ask you the number ID of the pull request you wish to merge. The command will also ask you what type of merge to do: regular merging, squashing, or rebasing. The commit message to use during the merge/squash/rebase will be the title of the pull request.
-
-If you're getting stuck, you can run the command with a `--help` flag instead, to get some more information.
-
 ## Contributing
 
 To submit a feature request, bug ticket, etc, please submit an official [GitHub Issue](https://github.com/emmasax4/git_helper/issues/new).
@@ -162,3 +156,16 @@ To submit a feature request, bug ticket, etc, please submit an official [GitHub
 To report any security vulnerabilities, please view this project's [Security Policy](https://github.com/emmasax4/git_helper/security/policy).
 
 This repository does have a standard [Code of Conduct](https://github.com/emmasax4/git_helper/blob/main/.github/code_of_conduct.md).
+
+## Releasing
+
+To make a new release of this gem:
+
+1. Merge the pull request via the big green button
+2. Run `git tag vX.X.X` and `git push --tag`
+3. Make a new release [here](https://github.com/emmasax4/git_helper/releases/new)
+4. Run `gem build *.gemspec`
+5. Run `gem push *.gem` to push the new gem to RubyGems
+6. Run `rm *.gem` to clean up your local repository
+
+To set up your local machine to push to RubyGems via the API, see the [RubyGems documentation](https://guides.rubygems.org/publishing/#publishing-to-rubygemsorg).

data/bin/git-helper

@@ -24,7 +24,7 @@ command 'change-remote' do |c|
   c.action do |global_options, options, args|
     require_relative '../lib/git_helper/change_remote.rb'
     raise ArgumentError, 'You must specify an old owner and a new owner' unless args.count == 2
-    GitHelper::ChangeRemote.new.execute(args[0], args[1])
+    GitHelper::ChangeRemote.new(args[0], args[1]).execute
   end
 end
 
@@ -52,22 +52,11 @@ command 'empty-commit' do |c|
   end
 end
 
-desc 'Create a GitLab merge request from the current branch.'
-command 'merge-request' do |c|
-  c.switch [:c, :create], desc: 'Create a new pull request'
-  c.switch [:m, :merge], desc: 'Merge an existing pull request'
-
+desc "Reset your local git commits to origin/HEAD."
+command 'forget-local-commits' do |c|
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/merge_request.rb'
-    raise ArgumentError, "You must specify an action (either '-m'/'--merge' or '-c'/'--create')" unless options[:create] || options[:merge]
-
-    options = global_options.merge(options)
-
-    if options[:create]
-      GitHelper::GitLabMergeRequest.new.create
-    elsif options[:merge]
-      GitHelper::GitLabMergeRequest.new.merge
-    end
+    require_relative '../lib/git_helper/forget_local_commits.rb'
+    GitHelper::ForgetLocalCommits.new.execute
   end
 end
 
@@ -80,21 +69,21 @@ command 'new-branch' do |c|
   end
 end
 
-desc 'Create a GitHub pull request from the current branch.'
-command 'pull-request' do |c|
-  c.switch [:c, :create], desc: 'Create a new pull request'
-  c.switch [:m, :merge], desc: 'Merge an existing pull request'
+desc 'Create or merge a GitHub or GitLab pull/merge request from the current branch. The command will figure out whether your code project belongs to GitHub or GitLab'
+command 'code-request' do |c|
+  c.switch [:c, :create], desc: 'Create a new pull/merge request'
+  c.switch [:m, :merge], desc: 'Merge an existing pull/merge request'
 
   c.action do |global_options, options, args|
-    require_relative '../lib/git_helper/pull_request.rb'
+    require_relative '../lib/git_helper/code_request.rb'
     raise ArgumentError, "You must specify an action (either '-m'/'--merge' or '-c'/'--create')" unless options[:create] || options[:merge]
 
     options = global_options.merge(options)
 
     if options[:create]
-      GitHelper::GitHubPullRequest.new.create
+      GitHelper::CodeRequest.new.create
     elsif options[:merge]
-      GitHelper::GitHubPullRequest.new.merge
+      GitHelper::CodeRequest.new.merge
     end
   end
 end

data/lib/git_helper/change_remote.rb

@@ -1,55 +1,71 @@
+require_relative './highline_cli.rb'
+require_relative './local_code.rb'
+
 module GitHelper
   class ChangeRemote
-    def execute(old_owner, new_owner)
-      current_dir = Dir.pwd
-      nested_dirs = Dir.entries(current_dir).select do |entry|
-        entry_dir = File.join(current_dir, entry)
+    attr_accessor :old_owner, :new_owner
+
+    def initialize(old_owner, new_owner)
+      @old_owner = old_owner
+      @new_owner = new_owner
+    end
+
+    def execute
+      original_dir = Dir.pwd
+      nested_dirs = Dir.entries(original_dir).select do |entry|
+        entry_dir = File.join(original_dir, entry)
         File.directory?(entry_dir) && !(entry == '.' || entry == '..')
       end
 
-      nested_dirs.each do |dir|
-        Dir.chdir dir
-        if File.exist?('.git')
-          puts "Found git directory: #{dir}."
-          remotes = `git remote -v`.split("\n")
-          remotes.each do |remote|
-            if resp.include?(old_owner)
-              puts "  Git directory's remote is pointing to: '#{old_owner}'."
-              swap_ssh(old_owner, new_owner, remote) if remote.scan(/(git@)/).any?
-              swap_https(old_owner, new_owner, remote) if remote.scan(/(https:\/\/)/).any?
-            else
-              puts "  No need to update remote."
-            end
-          end
-        end
-        Dir.chdir current_dir
+      nested_dirs.each do |nested_dir|
+        process_dir(nested_dir, original_dir)
       end
     end
 
-    private def swap_https(old_owner, new_owner, remote)
-      repo = remote.scan(/https:\/\/[\S]+\/([\S]*).git/).first.first
-      remote_name = remote.scan(/([a-zA-z]+)/).first.first
-      source_name = scan(/https:\/\/([a-zA-z.]+)\//).first.first
-      puts "  Changing the remote URL #{remote_name} to be 'https://#{source_name}/#{new_owner}/#{repo}.git'."
-      begin
-        `git remote set-url #{remote_name} https://#{source_name}:#{new_owner}/#{repo}.git`
-        puts "  Done."
-      rescue Exception => e
-        puts "  Could not complete: #{e.message}"
+    private def process_dir(current_dir, original_dir)
+      Dir.chdir(current_dir)
+
+      if File.exist?('.git')
+        process_git_repository if cli.process_directory_remotes?(current_dir)
       end
+
+      Dir.chdir(original_dir)
     end
 
-    private def swap_ssh(old_owner, new_owner, remote)
-      repo = remote.scan(/\/([\S]*).git/).first.first
-      remote_name = remote.scan(/([a-zA-z]+)/).first.first
-      source_name = remote.scan(/git@([a-zA-z.]+):/).first.first
-      puts "  Changing the remote URL #{remote_name} to be 'git@#{source_name}:#{new_owner}/#{repo}.git'."
-      begin
-        `git remote set-url #{remote_name} git@#{source_name}:#{new_owner}/#{repo}.git`
-        puts "  Done."
-      rescue Exception => e
-        puts "  Could not complete: #{e.message}"
+    private def process_git_repository
+      local_code.remotes.each do |remote|
+        if remote.include?(old_owner)
+          process_remote(remote)
+        else
+          puts "  Found remote is not pointing to #{old_owner}."
+        end
       end
+      puts "\n"
+    end
+
+    private def process_remote(remote)
+      remote_name = local_code.remote_name(remote)
+
+      if local_code.ssh_remote?(remote)
+        repo = local_code.remote_project(remote)
+        source_name = local_code.remote_source(remote)
+        remote_url = "git@#{source_name}:#{new_owner}/#{repo}.git"
+      elsif local_code.https_remote?(remote)
+        repo = local_code.remote_project(remote)
+        source_name = local_code.remote_source(remote)
+        remote_url = "https://#{source_name}/#{new_owner}/#{repo}.git"
+      end
+
+      puts "  Changing the remote URL #{remote_name} to be '#{remote_url}'."
+      local_code.change_remote(remote_name, remote_url)
+    end
+
+    private def local_code
+      @local_code ||= GitHelper::LocalCode.new
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
     end
   end
 end

data/lib/git_helper/checkout_default.rb

@@ -1,7 +1,9 @@
+require_relative './local_code.rb'
+
 module GitHelper
   class CheckoutDefault
     def execute
-      system("git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed \"s@^refs/remotes/origin/@@\")")
+      GitHelper::LocalCode.new.checkout_default
     end
   end
 end

data/lib/git_helper/clean_branches.rb

@@ -1,10 +1,9 @@
+require_relative './local_code.rb'
+
 module GitHelper
   class CleanBranches
     def execute
-      system("git checkout $(git symbolic-ref refs/remotes/origin/HEAD | sed \"s@^refs/remotes/origin/@@\")")
-      system("git pull")
-      system("git fetch -p")
-      system("git branch -vv | grep \"origin/.*: gone]\" | awk '{print \$1}' | grep -v \"*\" | xargs git branch -D")
+      GitHelper::LocalCode.new.clean_branches
     end
   end
 end

data/lib/git_helper/code_request.rb

@@ -0,0 +1,100 @@
+require_relative './merge_request.rb'
+require_relative './pull_request.rb'
+require_relative './local_code.rb'
+require_relative './highline_cli.rb'
+
+module GitHelper
+  class CodeRequest
+    def create
+      process_project.create({
+        base_branch: base_branch,
+        new_title: new_code_request_title
+      })
+    end
+
+    def merge
+      process_project.merge
+    end
+
+    private def process_project
+      if local_code.github_repo? # GitHub remotes are found
+        # If GitLab remotes are also found, ask for clarification, else proceed with GitHub
+        local_code.gitlab_project? ? ask_for_clarification : github_pull_request
+      elsif local_code.gitlab_project? # Only GitLab remotes are found
+        gitlab_merge_request
+      else # Neither GitHub nor GitLab remotes are found
+        puts 'Could not locate GitHub or GitLab remote URLs.'
+        exit
+      end
+    end
+
+    private def ask_for_clarification
+      resp = cli.conflicting_remote_clarification
+      if resp.include?('hub')
+        github_pull_request
+      elsif resp.include?('lab')
+        gitlab_merge_request
+      else
+        puts 'The answer we received was not parseable.'
+        exit
+      end
+    end
+
+    private def github_pull_request
+      @github_pull_request ||= GitHelper::GitHubPullRequest.new(options)
+    end
+
+    private def gitlab_merge_request
+      @gitlab_merge_request ||= GitHelper::GitLabMergeRequest.new(options)
+    end
+
+    private def options
+      {
+        local_project: local_project,
+        local_branch: local_branch,
+        local_code: local_code,
+        cli: cli
+      }
+    end
+
+    private def local_project
+      @local_project ||= local_code.project_name
+    end
+
+    private def default_branch
+      @default_branch ||= local_code.default_branch
+    end
+
+    private def base_branch
+      @base_branch ||= if cli.base_branch_default?(default_branch)
+                         default_branch
+                       else
+                         cli.base_branch
+                       end
+    end
+
+    private def local_branch
+      @local_branch ||= local_code.branch
+    end
+
+    private def autogenerated_title
+      @autogenerated_title ||= local_code.generate_title(local_branch)
+    end
+
+    private def new_code_request_title
+      @new_code_request_title ||= if cli.accept_autogenerated_title?(autogenerated_title)
+                                    autogenerated_title
+                                  else
+                                    cli.title
+                                  end
+    end
+
+    private def cli
+      @cli ||= GitHelper::HighlineCli.new
+    end
+
+    private def local_code
+      @local_code ||= GitHelper::LocalCode.new
+    end
+  end
+end