git_helper 3.6.2 → 3.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64c4ad9b8acf74b29b341f534243721f4bf168d1d15c524e052a201b867e9c6d
-  data.tar.gz: '01228b5f41daa653e47e11a33f5cde747edfc795759ab5b7c0b474d655538431'
+  metadata.gz: 7e0efd69de26cab869fc579da3011c6958b2491913cca1e0ec061f33a6890e91
+  data.tar.gz: e942b0e9b503de7d33090ce6be10b197df033fffe80b401a837c4ce62195b186
 SHA512:
-  metadata.gz: 90f31e2053f842aaa9a536de4a79c9e2e066fd08c8703367520b2728e39a3b9aa88374230fbc2211993c709077cc573272e2e79dc996d5009dbdd864986c0541
-  data.tar.gz: e683017056105ba89126467da7cea039ee7c0d88350f8971ed0e130d85fcc0e2ea383600e7e88c01806d68540e2183bb5e30f6a8130d9fbabdce4bcbba545ab8
+  metadata.gz: 30472648379bc818e9b54f15b25948e7f5cc64e0a0cb349724a8ae9f1df8e0642d1daac1df3ff4669334d162370d3a7f78c57df16574fb89c9cc2b5d48963a1c
+  data.tar.gz: 69d48ba584a596249b41b91f0cb6828af7fca255a13c123d84bc24071ed2de5cfda8cac0777050002f68e63f8e4608322924f1baae288693bd5f12cb030f4930

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_helper (3.6.1.pre.test)
+    git_helper (3.6.3)
       gli (~> 2.13)
       highline_wrapper (~> 1.1)
 
@@ -10,9 +10,9 @@ GEM
   specs:
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
     diff-lcs (1.5.0)
-    faker (3.0.0)
+    faker (3.1.1)
       i18n (>= 1.8.11, < 2)
     ffi (1.15.5)
     formatador (1.1.0)
@@ -31,13 +31,13 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    highline (2.0.3)
+    highline (2.1.0)
     highline_wrapper (1.3.1)
       highline (~> 2.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    listen (3.7.1)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
@@ -47,46 +47,46 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
+    rspec-core (3.12.1)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
+    rspec-mocks (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.40.0)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     shellany (0.0.1)
     thor (1.2.1)
-    unicode-display_width (2.3.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   arm64-darwin-21
@@ -102,4 +102,4 @@ DEPENDENCIES
   rubocop (~> 1.10)
 
 BUNDLED WITH
-   2.3.26
+   2.4.6

data/README.md

@@ -6,32 +6,37 @@
 gem install git_helper
 ```
 
-Some of the commands in this gem can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To provide access tokens for this, create a `~/.git_helper/config.yml` file. The contents should look like this:
-
-```
-:github_user:  GITHUB-USERNAME
-:github_token: GITHUB-TOKEN
-:gitlab_user:  GITLAB-USERNAME
-:gitlab_token: GITLAB-TOKEN
-```
-
-To create or see what access tokens you have, look [here for GitHub personal access tokens](https://github.com/settings/tokens) and [here for GitLab access tokens](https://gitlab.com/profile/personal_access_tokens). You could either have one set of tokens for each computer you use, or just have one set of tokens for all computers that you rotate periodically.
-
 Once the gem is installed, run this to view the help screen:
+
 ```bash
 git-helper --help
 ```
 
-To see what version of git_helper you're running, run:
+To see what version of Git Helper you're running, run:
+
 ```bash
 git-helper --version
 ```
 
-To help you create the `~/.git_helper/config.yml` file and set up the plugins (see below), run this command and allow the command to walk you through the prompts:
+Some of the commands in this gem can be used without any additional configuration. However, others utilize special GitHub or GitLab configuration. To set up access with GitHub/GitLab, run:
+
 ```bash
 git-helper setup
 ```
 
+This will give you the option to set up credentials at GitHub and/or GitLab, as well as give you the choice to set up Git Helper as a plugin or not (see below).
+
+The final result will be a `~/.git_helper/config.yml` file with the contents in this form:
+
+```
+:github_user:  GITHUB-USERNAME
+:github_token: GITHUB-TOKEN
+:gitlab_user:  GITLAB-USERNAME
+:gitlab_token: GITLAB-TOKEN
+```
+
+To create or see what access tokens you have, look [here for GitHub personal access tokens](https://github.com/settings/tokens) and [here for GitLab access tokens](https://gitlab.com/profile/personal_access_tokens). You could either have one set of tokens for each computer you use, or just have one set of tokens for all computers that you rotate periodically.
+
 ## Plugin Usage
 
 As an additional option, you can set each of the following commands to be a git plugin, meaning you can call them in a way that feels even more git-native:
@@ -42,21 +47,12 @@ git-helper clean-branches             git clean-branches
 git-helper code-request               git code-request
 ```
 
-To do this, download the `plugins.zip` file in the root of this directory. Unzip and place the contents in the appropriate location:
+Running the `setup` command will give you the option to set this up:
 
 ```bash
-mkdir ~/.git_helper
-unzip path/to/downloaded/plugins.zip -d ~/.git_helper
-```
-
-Now, the plugins will live in `~/.git_helper/plugins/*`. Add the following line to your `~/.bash_profile`:
-
-```bash
-export PATH=/path/to/computer/home/.git_helper/plugins:$PATH
+git-helper setup
 ```
 
-And then run `source ~/.bash_profile`.
-
 ## Alias Usage
 
 To make the commands even shorter, I recommend setting aliases. You can either set aliases through git itself, like this (only possible if you also use the plugin option):
@@ -67,7 +63,7 @@ git config --global alias.nb new-branch
 
 And then running `git nb` maps to `git new-branch`, which through the plugin, maps to `git-helper new-branch`.
 
-Or you can set the alias through your `~/.bashrc` (which is my preferred method because it can make the command even shorter, and doesn't require the plugin usage). To do this, add lines like this to the `~/.bashrc` file and run `source ~/.bashrc`:
+Or you can set the alias through your `~/.zshrc` (which is my preferred method because it can make the command even shorter, and doesn't require the plugin usage). To do this, add lines like this to the `~/.zshrc` file and run `source ~/.zshrc`:
 
 ```bash
 alias gnb="git new-branch"

data/lib/git_helper/git_config_reader.rb

@@ -19,7 +19,7 @@ module GitHelper
     end
 
     def git_config_file_path
-      "#{Dir.pwd.scan(%r{\A/\w*/\w*/}).first}.git_helper/config.yml"
+      "#{Dir.home}/.git_helper/config.yml"
     end
 
     private def config_file

data/lib/git_helper/setup.rb

@@ -32,14 +32,15 @@ module GitHelper
       return unless answer
 
       create_or_update_plugin_files
-      puts "\nNow add this line to your ~/.bash_profile:\n  " \
-           'export PATH=/path/to/computer/home/.git_helper/plugins:$PATH'
+      puts "\nNow add this line to your ~/.zshrc:\n  " \
+           'export PATH="$HOME/.git_helper/plugins:$PATH"'
       puts "\nDone!"
     end
 
     private def create_or_update_config_file
       contents = generate_file_contents
       puts "Creating or updating your #{config_file} file..."
+      FileUtils.mkdir_p("#{Dir.home}/.git_helper")
       File.open(config_file, 'w') { |file| file.puts contents }
       puts "\nDone!\n\n"
     end
@@ -82,7 +83,7 @@ module GitHelper
 
     # rubocop:disable Metrics/MethodLength
     private def create_or_update_plugin_files
-      plugins_dir = "#{Dir.pwd.scan(%r{\A/\w*/\w*/}).first}.git_helper/plugins"
+      plugins_dir = "#{Dir.home}/.git_helper/plugins"
       plugins_url = 'https://api.github.com/repos/emmahsax/git_helper/contents/plugins'
       header = 'Accept: application/vnd.github.v3.raw'
       token = git_config_reader.github_token

data/lib/git_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitHelper
-  VERSION = '3.6.2'
+  VERSION = '3.6.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 3.6.2
+  version: 3.6.3
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: A set of GitHub and GitLab workflow scripts