git_helper 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0278ec1bcdeffdfc4ff94dcb4853f0d0d9a37c99799d90ab04cb0b59af49d7aa'
-  data.tar.gz: ac395aad1492142aba911277e492eb49dd97345e40f81910eed0692618f973a7
+  metadata.gz: b9c80aa14abd85f6ebcff1a7c6592e71e4222273c8239c14c45ef905c4a3e549
+  data.tar.gz: 973f3831d8587d46d5e37c7738b50b5f8bab12bab9b2ec3d8ef34379b61917ea
 SHA512:
-  metadata.gz: 73cedc8f831a0fea6543fe78fa877eeeba394a43c2f5bd038b65d30a71f6830964c40c23dc3aeb0c4056130d1ffe9ceb14c021eb181f2bd3007eaa9c2533e891
-  data.tar.gz: 14d32de16eaf5cd1579464afbaf6c1068514f1cbbaf7c94eeddc3d1fd44b224a94cb93f29f60ec4918d292a7fdde1c326068c0e093848a51dc36f4305599c458
+  metadata.gz: 4515350964ec6a6e998a912d5b53cc49c8f90bd6d9cf9acfa5a3d499ffbad71638068266716971924efd76d6692a7aa1a1523cbcefc5c20eaeaf8e99805689aa
+  data.tar.gz: bfee7c84bc7d5a9a54172779bccbdbb56e0ad22f3776f8dc2d00228149ffcdf5de4dc5f3b5182aa92c6add8eec30cb0a70b7f8184fb5e1a8c8a2da2bf621007b

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    git_helper (3.3.0)
+      gitlab (~> 4.16)
+      gli (~> 2.13)
+      highline (~> 2.0)
+      octokit (~> 4.18)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    diff-lcs (1.4.4)
+    faker (2.15.1)
+      i18n (>= 1.6, < 2)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    ffi (1.14.2)
+    formatador (0.2.5)
+    gitlab (4.17.0)
+      httparty (~> 0.18)
+      terminal-table (~> 1.5, >= 1.5.1)
+    gli (2.19.2)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    highline (2.0.3)
+    httparty (0.18.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.8)
+      concurrent-ruby (~> 1.0)
+    listen (3.4.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.20.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.4)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (1.1.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bundler (~> 2.2)
+  faker (~> 2.15)
+  git_helper!
+  guard-rspec (~> 4.3)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.2.9

data/README.md

@@ -27,6 +27,11 @@ To see what version of git_helper you're running, run:
 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:
+```bash
+git-helper setup
+```
+
 ## 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:
@@ -46,7 +51,7 @@ 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
 ```
 

data/bin/git-helper

@@ -17,6 +17,13 @@ DOCUMENTATION
     see Git Helper's GitHub repo: https://github.com/emmahsax/git_helper
 """
 
+desc 'Sets up Git Helper configs at ~/.git_helper/*'
+command 'setup' do |c|
+  c.action do ||
+    GitHelper::Setup.new.execute
+  end
+end
+
 arg :old_owner
 arg :new_owner
 desc "Update a repository's remote URLs from an old GitHub owner to a new owner."

data/lib/git_helper/git_config_reader.rb

@@ -8,12 +8,12 @@ module GitHelper
       config_file[:github_token]
     end
 
-    private def config_file
-      YAML.load_file(git_config_file_path)
+    def git_config_file_path
+      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
     end
 
-    private def git_config_file_path
-      Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first << git_config_file
+    private def config_file
+      YAML.load_file(git_config_file_path)
     end
 
     private def git_config_file

data/lib/git_helper/setup.rb

@@ -0,0 +1,87 @@
+module GitHelper
+  class Setup
+    def execute
+      if config_file_exists?
+        answer = highline.ask_yes_no("It looks like the #{config_file} file already exists. Do you wish to replace it? (y/n)")
+        puts
+      else
+        answer = true
+      end
+
+      create_or_update_config_file if answer
+
+      answer = highline.ask_yes_no("Do you wish to set up the Git Helper plugins? (y/n)")
+
+      if 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 "\nDone!"
+      end
+    end
+
+    private def create_or_update_config_file
+      contents = generate_file_contents
+      puts "\nCreating or updating your #{config_file} file..."
+      File.open(config_file, 'w') { |file| file.puts contents }
+      puts "\nDone!\n\n"
+    end
+
+    private def config_file_exists?
+      File.exists?(config_file)
+    end
+
+    private def generate_file_contents
+      file_contents = ''
+
+      if highline.ask_yes_no("Do you wish to set up GitHub credentials? (y/n)")
+        file_contents << ":github_user:  #{ask_question('GitHub username?')}\n"
+        file_contents << ":github_token: " \
+          "#{ask_question('GitHub personal access token? (Navigate to https://github.com/settings/tokens ' \
+          'to create a new personal access token)')}\n"
+      end
+
+      if highline.ask_yes_no("\nDo you wish to set up GitLab credentials? (y/n)")
+        file_contents << ":gitlab_user:  #{ask_question('GitLab username?')}\n"
+        file_contents << ":gitlab_token: " \
+          "#{ask_question('GitLab personal access token? (Navigate to https://gitlab.com/-/profile/personal_access_tokens ' \
+          'to create a new personal access token)')}\n"
+      end
+
+      file_contents.strip
+    end
+
+    private def ask_question(prompt)
+      answer = highline.ask("\n#{prompt}")
+
+      if answer.empty?
+        puts "\nThis question is required."
+        ask_question(prompt)
+      else
+        answer
+      end
+    end
+
+    private def highline
+      @highline ||= GitHelper::HighlineCli.new
+    end
+
+    private def config_file
+      GitHelper::GitConfigReader.new.git_config_file_path
+    end
+
+    private def create_or_update_plugin_files
+      plugins_dir = "#{Dir.pwd.scan(/\A\/[\w]*\/[\w]*\//).first}/.git_helper/plugins"
+      plugins_url = 'https://api.github.com/repos/emmahsax/git_helper/contents/plugins'
+      header = 'Accept: application/vnd.github.v3.raw'
+
+      Dir.mkdir(plugins_dir) unless File.exists?(plugins_dir)
+
+      all_plugins = JSON.parse(`curl -s -H "#{header}" -L "#{plugins_url}"`)
+
+      all_plugins.each do |plugin|
+        plugin_content = `curl -s -H "#{header}" -L "#{plugins_url}/#{plugin['name']}"`
+        File.open("#{plugins_dir}/#{plugin['name']}", 'w') { |file| file.puts plugin_content }
+      end
+    end
+  end
+end

data/lib/git_helper/version.rb

@@ -1,3 +1,3 @@
 module GitHelper
-  VERSION = '3.2.2'
+  VERSION = '3.3.0'
 end

data/spec/git_helper/code_request_spec.rb

@@ -133,6 +133,7 @@ describe GitHelper::CodeRequest do
       end
     end
 
+    # Unfortunately this test sometimes fails... just rerun the tests if it does
     context 'when response is neither' do
       it 'should raise an error' do
         allow(highline_cli).to receive(:ask).and_return(Faker::Lorem.word)

data/spec/git_helper/setup_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+require 'git_helper'
+
+describe GitHelper::Setup do
+  let(:response) { double(:response, readline: true, to_s: Faker::Lorem.sentence) }
+  let(:highline_cli) { double(:highline_cli, ask: response, ask_yes_no: true) }
+
+  before do
+    allow(GitHelper::HighlineCli).to receive(:new).and_return(highline_cli)
+    allow(subject).to receive(:puts)
+  end
+
+  after do
+    GitHelper::Setup.instance_variable_set("@highline", nil)
+  end
+
+  describe '#execute' do
+    it 'should ask a question if the config file exists' do
+      allow(File).to receive(:exists?).and_return(true)
+      expect(highline_cli).to receive(:ask_yes_no).and_return(true)
+      allow(subject).to receive(:create_or_update_config_file).and_return(true)
+      allow(subject).to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+
+    it 'should call to create or update the config file' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(highline_cli).to receive(:ask_yes_no).and_return(true)
+      expect(subject).to receive(:create_or_update_config_file).and_return(true)
+      allow(subject).to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+
+    it 'should skip if the user opts not to continue' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(highline_cli).to receive(:ask_yes_no).and_return(false)
+      expect(subject).not_to receive(:create_or_update_config_file)
+      expect(subject).not_to receive(:create_or_update_plugin_files)
+      subject.execute
+    end
+  end
+
+  describe '#create_or_update_config_file' do
+    it 'should generate the file based on the answers to the questions' do
+      expect(subject).to receive(:generate_file_contents)
+      allow(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file)
+    end
+
+    it 'should open the file for writing' do
+      allow(subject).to receive(:generate_file_contents)
+      expect(File).to receive(:open).and_return(nil)
+      subject.send(:create_or_update_config_file)
+    end
+  end
+
+  describe '#config_file_exists?' do
+    it 'should return true if the file exists' do
+      allow(File).to receive(:exists?).and_return(true)
+      expect(subject.send(:config_file_exists?)).to eq(true)
+    end
+
+    it 'should return false if the file does not exist' do
+      allow(File).to receive(:exists?).and_return(false)
+      expect(subject.send(:config_file_exists?)).to eq(false)
+    end
+  end
+
+  describe '#ask_question' do
+    it 'should use highline to ask a question' do
+      expect(highline_cli).to receive(:ask).and_return(Faker::Lorem.word)
+      subject.send(:ask_question, Faker::Lorem.sentence)
+    end
+
+    it 'should recurse if the highline client gets an empty string' do
+      allow(highline_cli).to receive(:ask).and_return('', Faker::Lorem.word)
+      expect(subject).to receive(:ask_question).at_least(:twice).and_call_original
+      subject.send(:ask_question, Faker::Lorem.sentence)
+    end
+
+    it 'should return the answer if it is given' do
+      answer = Faker::Lorem.sentence
+      allow(highline_cli).to receive(:ask).and_return(answer)
+      expect(subject.send(:ask_question, Faker::Lorem.sentence)).to be(answer)
+    end
+  end
+
+  describe '#generate_file_contents' do
+    it 'should ask two yes/no questions' do
+      expect(highline_cli).to receive(:ask_yes_no).exactly(2).times.and_return(false)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should ask two additional questions for each time the user says yes' do
+      allow(highline_cli).to receive(:ask_yes_no).exactly(2).times.and_return(true, false)
+      expect(subject).to receive(:ask_question).exactly(2).times.and_return(Faker::Lorem.word)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should ask four additional questions for each time the user says yes' do
+      allow(highline_cli).to receive(:ask_yes_no).exactly(2).times.and_return(true)
+      expect(subject).to receive(:ask_question).exactly(4).times.and_return(Faker::Lorem.word)
+      subject.send(:generate_file_contents)
+    end
+
+    it 'should return a string no matter what' do
+      allow(highline_cli).to receive(:ask_yes_no).exactly(2).times.and_return(true)
+      allow(subject).to receive(:ask_question).exactly(4).times.and_return(Faker::Lorem.word)
+      expect(subject.send(:generate_file_contents)).to be_a(String)
+    end
+  end
+
+  describe '#create_or_update_plugin_files' do
+    let(:plugins) do
+      [
+        {
+          'name': 'plugin-file-one'
+        },
+        {
+          'name': 'plugin-file-two'
+        }
+      ]
+    end
+
+    let(:plugins_json) do
+      "[
+        {
+          \"name\": \"plugin-file-one\"
+        },
+        {
+          \"name\": \"plugin-file-two\"
+        }
+      ]"
+    end
+
+    it 'should create the directory if it does not exist' do
+      allow(File).to receive(:exists?).and_return(false)
+      allow(File).to receive(:open).and_return(nil)
+      expect(Dir).to receive(:mkdir)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should not create the directory if it already exists' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      expect(Dir).not_to receive(:mkdir)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should curl the GitHub API' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      allow(subject).to receive(:`).and_return(plugins_json)
+      expect(JSON).to receive(:parse).with(plugins_json).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+
+    it 'should go through the loop for each plugin' do
+      allow(File).to receive(:exists?).and_return(true)
+      allow(File).to receive(:open).and_return(nil)
+      expect(subject).to receive(:`).exactly(3).times
+      allow(JSON).to receive(:parse).and_return(plugins)
+      subject.send(:create_or_update_plugin_files)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_helper
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Emma Sax
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gitlab
@@ -145,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -165,6 +166,7 @@ files:
 - lib/git_helper/new_branch.rb
 - lib/git_helper/octokit_client.rb
 - lib/git_helper/pull_request.rb
+- lib/git_helper/setup.rb
 - lib/git_helper/version.rb
 - plugins.zip
 - spec/git_helper/change_remote_spec.rb
@@ -181,6 +183,7 @@ files:
 - spec/git_helper/new_branch_spec.rb
 - spec/git_helper/octokit_client_spec.rb
 - spec/git_helper/pull_request_spec.rb
+- spec/git_helper/setup_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/emmahsax/git_helper
 licenses:
@@ -221,3 +224,4 @@ test_files:
 - spec/git_helper/new_branch_spec.rb
 - spec/git_helper/octokit_client_spec.rb
 - spec/git_helper/pull_request_spec.rb
+- spec/git_helper/setup_spec.rb