git_reflow 0.9.2 → 0.9.6

data/lib/git_reflow/workflow.rb

@@ -132,7 +132,7 @@ module GitReflow
         @workflows
       end
 
-      # Creates a singleton method on the inlcuded class
+      # Creates a singleton method on the included class
       #
       # This method will take any number of keyword parameters. If @defaults keyword is provided, and the given
       # key(s) in the defaults are not provided as keyword parameters, then it will use the value given in the
@@ -157,7 +157,7 @@ module GitReflow
         self.commands[name] = params
         self.command_docs[name] = params
 
-        self.define_singleton_method(name) do |**args|
+        self.define_singleton_method(name) do |args = {}|
           args_with_defaults = {}
           args.each do |name, value|
             if "#{value}".length <= 0 && !defaults[name].nil?
@@ -230,7 +230,7 @@ module GitReflow
         end
       end
 
-      # Creates a singleton method on the inlcuded class
+      # Creates a singleton method on the included class
       #
       # This method updates the help text associated with the provided command.
       #

data/spec/fixtures/authentication_failure.json

@@ -0,0 +1,3 @@
+{
+  "error" : "GET https://api.github.com/authorizations: 401 Bad credentials"
+}

data/spec/fixtures/users/user.json

@@ -0,0 +1,32 @@
+{
+  "login": "reenhanced",
+  "id": 1,
+  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+  "gravatar_id": "somehexcode",
+  "url": "https://api.github.com/users/reenhanced",
+  "name": "monalisa octocat",
+  "company": "GitHub",
+  "blog": "https://github.com/blog",
+  "location": "San Francisco",
+  "email": "octocat@github.com",
+  "hireable": false,
+  "bio": "There once was...",
+  "public_repos": 2,
+  "public_gists": 1,
+  "followers": 20,
+  "following": 0,
+  "html_url": "https://github.com/reenhanced",
+  "created_at": "2008-01-14T04:33:35Z",
+  "type": "User",
+  "total_private_repos": 100,
+  "owned_private_repos": 100,
+  "private_gists": 81,
+  "disk_usage": 10000,
+  "collaborators": 8,
+  "plan": {
+    "name": "Medium",
+    "space": 400,
+    "collaborators": 10,
+    "private_repos": 20
+  }
+}

data/spec/lib/git_reflow/git_helpers_spec.rb

@@ -1,15 +1,15 @@
-require 'spec_helper'
+require "spec_helper"
+
+module Gitacular
+  include GitReflow::GitHelpers
+  extend self
+end
 
 describe GitReflow::GitHelpers do
-  let(:origin_url) { 'git@github.com:reenhanced.spectacular/this-is-the.shit.git' }
+  let(:origin_url) { "git@github.com:reenhanced.spectacular/this-is-the.shit.git" }
 
   before do
-    stub_with_fallback(GitReflow::Config, :get).with('remote.origin.url').and_return(origin_url)
-
-    module Gitacular
-      include GitReflow::GitHelpers
-      extend self
-    end
+    stub_with_fallback(GitReflow::Config, :get).with("remote.origin.url").and_return(origin_url)
 
     stub_run_for Gitacular
   end
@@ -18,83 +18,86 @@ describe GitReflow::GitHelpers do
     subject { Gitacular.default_editor }
 
     context "when the environment has EDITOR set" do
-      before  { allow(ENV).to receive(:[]).with('EDITOR').and_return('emacs') }
-      specify { expect( subject ).to eql('emacs') }
+      before  { allow(ENV).to receive(:[]).with("EDITOR").and_return("emacs") }
+      specify { expect(subject).to eql("emacs") }
     end
 
     context "when the environment has no EDITOR set" do
-      before  { allow(ENV).to receive(:[]).with('EDITOR').and_return(nil) }
-      specify { expect( subject ).to eql('vi') }
+      before  { allow(ENV).to receive(:[]).with("EDITOR").and_return(nil) }
+      specify { expect(subject).to eql("vi") }
     end
   end
 
   describe ".git_root_dir" do
     subject { Gitacular.git_root_dir }
-    it      { expect{ subject }.to have_run_command_silently "git rev-parse --show-toplevel" }
+    it      { expect { subject }.to have_run_command_silently "git rev-parse --show-toplevel" }
   end
 
-  describe '.git_editor_command' do
+  describe ".git_editor_command" do
     subject { Gitacular.git_editor_command }
-    before { ENV['EDITOR'] = 'vim' }
+    before { ENV["EDITOR"] = "vim" }
 
-    it 'defaults to GitReflow config' do
-      allow(GitReflow::Config).to receive(:get).with('core.editor').and_return 'nano'
+    it "defaults to GitReflow config" do
+      allow(GitReflow::Config).to receive(:get).with("core.editor").and_return "nano"
 
-      expect(subject).to eq 'nano'
+      expect(subject).to eq "nano"
     end
 
-    it 'falls back to the environment variable $EDITOR' do
-      allow(GitReflow::Config).to receive(:get).with('core.editor').and_return ''
+    it "falls back to the environment variable $EDITOR" do
+      allow(GitReflow::Config).to receive(:get).with("core.editor").and_return ""
 
-      expect(subject).to eq 'vim'
+      expect(subject).to eq "vim"
     end
   end
 
   describe ".remote_user" do
     subject { Gitacular.remote_user }
 
-    it { is_expected.to eq('reenhanced.spectacular') }
+    it { is_expected.to eq("reenhanced.spectacular") }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { '' }
-      it { is_expected.to eq('') }
+      let(:origin_url) { "" }
+      it { is_expected.to eq("") }
     end
 
     context "remote origin uses HTTP" do
-      let(:origin_url) { 'https://github.com/reenhanced.spectacular/this-is-the.shit.git' }
-      it               { is_expected.to eq('reenhanced.spectacular') }
+      let(:origin_url) { "https://github.com/reenhanced.spectacular/this-is-the.shit.git" }
+      it               { is_expected.to eq("reenhanced.spectacular") }
     end
   end
 
   describe ".remote_repo_name" do
     subject { Gitacular.remote_repo_name }
 
-    it { is_expected.to eq('this-is-the.shit') }
+    it { is_expected.to eq("this-is-the.shit") }
 
     context "remote origin url isn't set" do
-      let(:origin_url) { '' }
-      it { is_expected.to eq('') }
+      let(:origin_url) { "" }
+      it { is_expected.to eq("") }
     end
 
     context "remote origin uses HTTP" do
-      let(:origin_url) { 'https://github.com/reenhanced.spectacular/this-is-the.shit.git' }
-      it               { is_expected.to eq('this-is-the.shit') }
+      let(:origin_url) { "https://github.com/reenhanced.spectacular/this-is-the.shit.git" }
+      it               { is_expected.to eq("this-is-the.shit") }
     end
   end
 
-  describe '.default_base_branch' do
+  describe ".default_base_branch" do
     subject { Gitacular.default_base_branch }
-    it      { is_expected.to eq('master') }
+    it      { is_expected.to eq("master") }
 
-    context 'when configured' do
-      before { allow(GitReflow::Config).to receive(:get).with('reflow.base-branch').and_return('tuba') }
-      it { is_expected.to eq('tuba') }
+    context "when configured" do
+      before { allow(GitReflow::Config).to receive(:get).with("reflow.base-branch").and_return("tuba") }
+      it { is_expected.to eq("tuba") }
     end
   end
 
   describe ".current_branch" do
     subject { Gitacular.current_branch }
-    it      { expect{ subject }.to have_run_command_silently "git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'" }
+    it {
+      expect { subject }
+        .to have_run_command_silently "git branch --no-color | grep '^\* ' | grep -v 'no branch' | sed 's/^* //g'"
+    }
   end
 
   describe ".pull_request_template" do
@@ -119,36 +122,29 @@ describe GitReflow::GitHelpers do
 
       it { is_expected.to be_nil }
     end
-  end
-
-  describe ".pull_request_template" do
-    subject { Gitacular.pull_request_template }
-
-    context "template file exists" do
-      let(:root_dir) { "/some_repo" }
-      let(:template_content) { "Template content" }
 
+    context "custom template file configured" do
       before do
-        allow(Gitacular).to receive(:git_root_dir).and_return(root_dir)
-        allow(File).to receive(:exist?).with("#{root_dir}/.github/PULL_REQUEST_TEMPLATE.md").and_return(true)
-        allow(File).to receive(:read).with("#{root_dir}/.github/PULL_REQUEST_TEMPLATE.md").and_return(template_content)
+        allow(GitReflow::Config).to receive(:get).with("templates.pull-request").and_return "pr_template_file.md"
       end
 
-      it { is_expected.to eq template_content }
+      context "template file exists" do
+        let(:template_content) { "Template content" }
 
-      context "when template has mustache tags" do
-        let(:template_content) { "This is the coolest {{current_branch}}" }
-        before { allow(GitReflow).to receive(:current_branch).and_return("tomato") }
-        it { is_expected.to eq "This is the coolest tomato" }
+        before do
+          allow(File).to receive(:exist?).with("pr_template_file.md").and_return(true)
+          allow(File).to receive(:read).with("pr_template_file.md").and_return(template_content)
+        end
+        it { is_expected.to eq template_content }
       end
-    end
 
-    context "template file does not exist" do
-      before do
-        allow(File).to receive(:exist?).and_return(false)
-      end
+      context "template file does not exist" do
+        before do
+          allow(File).to receive(:exist?).and_return(false)
+        end
 
-      it { is_expected.to be_nil }
+        it { is_expected.to be_nil }
+      end
     end
   end
 
@@ -181,27 +177,51 @@ describe GitReflow::GitHelpers do
 
       it { is_expected.to be_nil }
     end
+
+    context "custom template file configured" do
+      before do
+        allow(GitReflow::Config).to receive(:get).with("templates.merge-commit").and_return "merge_template_file.md"
+      end
+
+      context "template file exists" do
+        let(:template_content) { "Template content" }
+
+        before do
+          allow(File).to receive(:exist?).with("merge_template_file.md").and_return(true)
+          allow(File).to receive(:read).with("merge_template_file.md").and_return(template_content)
+        end
+        it { is_expected.to eq template_content }
+      end
+
+      context "template file does not exist" do
+        before do
+          allow(File).to receive(:exist?).and_return(false)
+        end
+
+        it { is_expected.to be_nil }
+      end
+    end
   end
 
   describe ".get_first_commit_message" do
     subject { Gitacular.get_first_commit_message }
-    it      { expect{ subject }.to have_run_command_silently 'git log --pretty=format:"%s" --no-merges -n 1' }
+    it      { expect { subject }.to have_run_command_silently 'git log --pretty=format:"%s" --no-merges -n 1' }
   end
 
   describe ".push_current_branch" do
     subject { Gitacular.push_current_branch }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('bingo') }
-    it      { expect{ subject }.to have_run_command "git push origin bingo" }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("bingo") }
+    it      { expect { subject }.to have_run_command "git push origin bingo" }
   end
 
   describe ".fetch_destination(destination_branch)" do
-    subject { Gitacular.fetch_destination('new-feature') }
-    it      { expect{ subject }.to have_run_command "git fetch origin new-feature" }
+    subject { Gitacular.fetch_destination("new-feature") }
+    it      { expect { subject }.to have_run_command "git fetch origin new-feature" }
   end
 
   describe ".update_destination(destination_branch)" do
-    let(:current_branch)     { 'bananas' }
-    let(:destination_branch) { 'monkey-business' }
+    let(:current_branch)     { "bananas" }
+    let(:destination_branch) { "monkey-business" }
 
     before  { allow(Gitacular).to receive(:current_branch).and_return(current_branch) }
     subject { Gitacular.update_destination(destination_branch) }
@@ -217,7 +237,7 @@ describe GitReflow::GitHelpers do
 
   describe ".update_current_branch" do
     subject { Gitacular.update_current_branch }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('new-feature') }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("new-feature") }
 
     it "updates the remote changes and pushes any local changes" do
       expect { subject }.to have_run_commands_in_order [
@@ -228,9 +248,9 @@ describe GitReflow::GitHelpers do
   end
 
   describe ".update_feature_branch" do
-    options = {base: "base", remote: "remote"}
+    options = { base: "base", remote: "remote" }
     subject { Gitacular.update_feature_branch(options) }
-    before  { allow(Gitacular).to receive(:current_branch).and_return('feature') }
+    before  { allow(Gitacular).to receive(:current_branch).and_return("feature") }
 
     it "calls the correct methods" do
       expect { subject }.to have_run_commands_in_order [
@@ -246,14 +266,14 @@ describe GitReflow::GitHelpers do
   describe ".append_to_merge_commit_message(message)" do
     let(:original_commit_message) { "Oooooo, SQUASH IT" }
     let(:message)                 { "do do the voodoo that you do" }
-    let(:root_dir)                { '/home/gitreflow' }
+    let(:root_dir)                { "/home/gitreflow" }
     let(:merge_message_path)      { "#{root_dir}/.git/SQUASH_MSG" }
     let(:tmp_merge_message_path)  { "#{root_dir}/.git/tmp_merge_msg" }
     before                        { allow(Gitacular).to receive(:git_root_dir).and_return(root_dir) }
     subject                       { Gitacular.append_to_merge_commit_message(message) }
 
     it "appends the message to git's SQUASH_MSG temp file" do
-      tmp_file = double('file')
+      tmp_file = double("file")
       allow(File).to receive(:open).with(tmp_merge_message_path, "w").and_yield(tmp_file)
       allow(File).to receive(:exists?).with(merge_message_path).and_return(true)
       allow(File).to receive(:foreach).with(merge_message_path).and_yield(original_commit_message)
@@ -269,7 +289,7 @@ describe GitReflow::GitHelpers do
       let(:merge_message_path) { "#{root_dir}/.git/MERGE_MSG" }
       subject { Gitacular.append_to_merge_commit_message(message, merge_method: "merge") }
       it "appends the message to git's MERGE_MSG temp file if using a direct merge" do
-        tmp_file = double('file')
+        tmp_file = double("file")
         allow(File).to receive(:open).with(tmp_merge_message_path, "w").and_yield(tmp_file)
         allow(File).to receive(:exists?).with(merge_message_path).and_return(true)
         allow(File).to receive(:foreach).with(merge_message_path).and_yield(original_commit_message)

data/spec/lib/git_reflow/git_server/git_hub/pull_request_spec.rb

@@ -100,7 +100,7 @@ describe GitReflow::GitServer::GitHub::PullRequest do
     context "Testing Nil Comments" do
       before do
         stub_request(:get, "https://api.github.com/repos/reenhanced/repo/pulls/2/comments?access_token=a1b2c3d4e5f6g7h8i9j0").
-         with(:headers => {'Accept'=>'application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1', 'Accept-Charset'=>'utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'token a1b2c3d4e5f6g7h8i9j0', 'User-Agent'=>'Github API Ruby Gem 0.18.2'}).
+         with(:headers => {'Accept'=>'application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1', 'Accept-Charset'=>'utf-8', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Authorization'=>'token a1b2c3d4e5f6g7h8i9j0', 'User-Agent'=>'Github API Ruby Gem 0.19.0'}).
          to_return(:status => 200, :body => "", :headers => {})
 
         FakeGitHub.new(

data/spec/lib/git_reflow/git_server/git_hub_spec.rb

@@ -78,7 +78,7 @@ describe GitReflow::GitServer::GitHub do
     subject                     { github.authenticate }
 
     before  do
-      allow(GitReflow::GitServer::GitHub).to receive(:user).and_return('reenhanced')
+      allow(GitReflow::GitServer::GitHub).to receive(:user).and_return(user)
       allow(github_api).to receive(:oauth).and_return(github_authorizations)
       allow(github_api).to receive_message_chain(:oauth, :all).and_return([])
       allow(github).to receive(:run).with('hostname', loud: false).and_return(hostname)
@@ -151,12 +151,86 @@ describe GitReflow::GitServer::GitHub do
           body: { error: "GET https://api.github.com/authorizations: 401 Bad credentials" }
         }}
 
+        before do
+          allow(GitReflow::Config).to receive(:get).and_call_original
+          allow(GitReflow::Config).to receive(:get).with('github.oauth-token').and_return(oauth_token_hash[:token])
+          allow(Github::Client).to receive(:new).and_return(github_api)
+          allow(github_authorizations).to receive(:authenticated?).and_return(true)
+          allow(github_api.oauth).to receive(:create).with({ scopes: ['repo'], note: "git-reflow (#{hostname})" }).and_return(oauth_token_hash)
+
+          stub_request(:get, %r{/user}).
+            to_return(
+              body: Fixture.new('authentication_failure.json').to_s,
+              status: 401,
+              headers: {'content-type' => 'application/json; charset=utf-8', status: 'Unauthorized'},
+            )
+        end
+
+        it "notifies the user of successful setup" do
+          expect { subject }.to have_said "Your GitHub account was successfully setup!", :success
+        end
+
+        it "creates a new GitHub oauth token" do
+          expect(github_api.oauth).to receive(:create).and_return(oauth_token_hash)
+          subject
+        end
+
+        it "creates git config keys for github connections" do
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all github.site \"#{github_site}\"", blocking: false
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all github.endpoint \"#{github_api_endpoint}\"", blocking: false
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all github.oauth-token \"#{oauth_token_hash[:token]}\"", blocking: false
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all reflow.git-server \"GitHub\"", blocking: false
+        end
+
+      end
+    end
+
+    context 'already authenticated' do
+      let(:oauth_token) { "abc123" }
+
+      before do
+        allow(GitReflow::Config).to receive(:get).and_call_original
+        allow(GitReflow::Config).to receive(:get).with('github.oauth-token').and_return(oauth_token)
+      end
+
+      context "and authentication token is still valid" do
+        before do
+          stub_request(:get, %r{/user}).
+            to_return(
+              body: Fixture.new('users/user.json').to_s,
+              status: 200,
+              headers: { content_type: "application/json; charset=utf-8" }
+            )
+
+          allow(Github::Client).to receive(:new).and_return(github_api)
+          allow(github_api).to receive(:oauth).and_return(github_authorizations)
+          allow(github_authorizations).to receive(:authenticated?).and_return(true)
+          allow(github_api.oauth).to receive(:create).with({ scopes: ['repo'], note: "git-reflow (#{hostname})" }).and_return(oauth_token_hash)
+        end
+
+        it "resolves all missing git-reflow configurations" do
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all github.site \"#{github_site}\"", blocking: false
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all github.endpoint \"#{github_api_endpoint}\"", blocking: false
+          expect{ subject }.to have_run_command_silently "git config -f #{GitReflow::Config::CONFIG_FILE_PATH} --replace-all reflow.git-server \"GitHub\"", blocking: false
+          expect { subject }.to have_said "Your GitHub account was already setup with: "
+          expect { subject }.to have_said "\tUser Name: #{user}"
+          expect { subject }.to have_said "\tEndpoint: #{github_api_endpoint}"
+        end
+      end
+
+      context "and authentication token is expired" do
+        let(:unauthorized_error_response) {{
+          response_headers: {'content-type' => 'application/json; charset=utf-8', status: 'Unauthorized'},
+          method: 'GET',
+          status: '401',
+          body: { error: "GET https://api.github.com/authorizations: 401 Bad credentials" }
+        }}
+
         before do
           allow(Github::Client).to receive(:new).and_raise Github::Error::Unauthorized.new(unauthorized_error_response)
         end
 
-        it "notifies user of invalid login details" do
-          expect { subject }.to have_said "Github Authentication Error: #{Github::Error::Unauthorized.new(unauthorized_error_response).inspect}", :error
+        it "requests a new oauth token" do
         end
       end
     end

data/spec/lib/git_reflow/git_server/pull_request_spec.rb

@@ -491,14 +491,42 @@ describe GitReflow::GitServer::PullRequest do
         allow(GitReflow::Config).to receive(:get).with('reflow.always-cleanup').and_return('false')
       end
 
-      context "and user chooses to cleanup" do
-        before { expect(pr).to receive(:ask).with('Would you like to push this branch to your remote repo and cleanup your feature branch? ').and_return('yes') }
+      context "and always cleanup local config is set" do
+      end
+
+      context "and always cleanup remote config is set" do
+      end
+
+      context "and user chooses to cleanup local only" do
+        before do
+          expect(pr).to receive(:ask).with('Would you like to cleanup your local feature branch? ').and_return('yes')
+          allow(pr).to receive(:ask).with('Would you like to cleanup your remote feature branch? ').and_return('no')
+        end
+        it { should be_truthy }
+      end
+
+      context "and user chooses to cleanup remote only" do
+        before do
+          expect(pr).to receive(:ask).with('Would you like to cleanup your local feature branch? ').and_return('no')
+          expect(pr).to receive(:ask).with('Would you like to cleanup your remote feature branch? ').and_return('yes')
+        end
         it     { should be_truthy }
       end
 
-      context "and user chooses not to cleanup" do
-        before { expect(pr).to receive(:ask).with('Would you like to push this branch to your remote repo and cleanup your feature branch? ').and_return('no') }
-        it     { should be_falsy }
+      context "and user chooses to cleanup local and remote" do
+        before do
+          allow(pr).to receive(:ask).with('Would you like to cleanup your local feature branch? ').and_return('yes')
+          allow(pr).to receive(:ask).with('Would you like to cleanup your remote feature branch? ').and_return('yes')
+        end
+        it { should be_truthy }
+      end
+
+      context "and user chooses to cleanup neither local nor remote" do
+        before do
+          expect(pr).to receive(:ask).with('Would you like to cleanup your local feature branch? ').and_return('no')
+          allow(pr).to receive(:ask).with('Would you like to cleanup your remote feature branch? ').and_return('no')
+        end
+        it     { should be_falsey }
       end
     end
   end

data/spec/lib/git_reflow_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe GitReflow do
-
   describe ".logger" do
     # Ignore memoization for tests
     before { GitReflow.instance_variable_set("@logger", nil) }

data/spec/spec_helper.rb

@@ -1,8 +1,8 @@
 require 'rubygems'
 require 'rspec'
+require 'ruby_jard'
 require 'multi_json'
 require 'webmock/rspec'
-require 'pry'
 
 $LOAD_PATH << 'lib'
 require 'git_reflow'