jiragit 0.5.0

data/spec/commit_message_spec.rb

@@ -0,0 +1,82 @@
+require './spec/spec_helper'
+require 'expect'
+
+describe "Commit message" do
+
+  include_context "Test Repository"
+
+  context "when making a commit" do
+
+    before do
+      @repo.make_a_command_line_commit
+      checkout_a_new_branch('new_branch', 'PA-12345')
+      @repo.create('a_file', 'The brown fox jumped over the fence')
+      @repo.add('a_file')
+    end
+
+    it "must be properly formatted" do
+      message = <<-COMMIT
+Capitalized, short (50 chars or less) summary
+
+More detailed explanatory text, if necessary.  Wrap it to about 72
+characters or so.  In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body.  The blank
+line separating the summary from the body is critical (unless you omit
+the body entirely); tools like rebase can get confused if you run the
+two together.
+      COMMIT
+
+      @repo.commit(message) do |output, input|
+        output.expect("Commit rejected", 5) do |message|
+          expect(message).to be nil
+        end
+      end
+    end
+
+    it "must contain a title" do
+      message = ""
+      @repo.commit(message) do |output, input|
+        output.expect("The title of the commit message must be present", 5) do |message|
+          expect(message).to_not be nil
+        end
+        output.expect("Edit commit message? [yes]> ")
+        input.puts("no")
+      end
+    end
+
+    it "the title must not be too long" do
+      message = "a"*51
+      @repo.commit(message) do |output, input|
+        output.expect("The title of the commit message must be no longer than 50 characters", 5) do |message|
+          expect(message).to_not be nil
+        end
+        output.expect("Edit commit message? [yes]> ")
+        input.puts("no")
+      end
+    end
+
+    it "the body must be seperated by at least one new line from the title" do
+      message = "Line 1\nLine 2"
+      @repo.commit(message) do |output, input|
+        output.expect("The commit title and body must be separated by a single blank line", 5) do |message|
+          expect(message).to_not be nil
+        end
+        output.expect("Edit commit message? [yes]> ")
+        input.puts("no")
+      end
+    end
+
+    it "the lines in the body must not be too long" do
+      message = "a"*20 + "\n\n" +"b"*73
+      @repo.commit(message) do |output, input|
+        output.expect("Lines in the body of the commit message must be no longer than 72 characters", 5) do |message|
+          expect(message).to_not be nil
+        end
+        output.expect("Edit commit message? [yes]> ")
+        input.puts("no")
+      end
+    end
+
+  end
+
+end

data/spec/commit_spec.rb

@@ -0,0 +1,81 @@
+require './spec/spec_helper'
+require 'expect'
+
+describe "Repository Commit Behaviors" do
+
+  include_context "Test Repository"
+
+  context "when making a commit" do
+
+    before do
+      @repo.make_a_command_line_commit
+      checkout_a_new_branch('new_branch', 'PA-12345')
+    end
+
+    context "via editor" do
+
+      before do
+        @commit = @repo.make_a_commit
+      end
+
+      it "adds the related jira to the body of the commit message" do
+        @repo.log_for_one_commit(@commit.sha) do |output, input|
+          output.expect("PA-12345", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+      it "contains the commit message on the first line" do
+        @repo.oneline_log_for_one_commit(@commit.sha) do |output, input|
+          output.expect("Short (50 chars or less) summary", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+      it "relates the jira and the commit" do
+        assert_relation({jira: 'PA-12345'}, {commit: @repo.current_commit})
+      end
+
+      it "relates the branch and the commit" do
+        assert_relation({branch: 'new_branch'}, {commit: @repo.current_commit})
+      end
+
+    end
+
+    context "via command line" do
+
+      before do
+        @commit = @repo.make_a_command_line_commit
+      end
+
+      it "adds the related jira to the body of the commit message" do
+        @repo.log_for_one_commit(@commit.sha) do |output, input|
+          output.expect("PA-12345", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+      it "contains the commit message on the first line" do
+        @repo.oneline_log_for_one_commit(@commit.sha) do |output, input|
+          output.expect("command line specified commit message", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+      it "relates the jira and the commit" do
+        assert_relation({jira: 'PA-12345'}, {commit: @repo.current_commit})
+      end
+
+      it "relates the branch and the commit" do
+        assert_relation({branch: 'new_branch'}, {commit: @repo.current_commit})
+      end
+
+    end
+
+  end
+
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,32 @@
+require './spec/spec_helper'
+
+module Jiragit
+
+  describe Configuration do
+
+    let!(:config) { described_class.new('.testconfig') }
+
+    cleanup = ->(x) { File.delete('.testconfig') if File.exist?('.testconfig') }
+    before &cleanup
+    after &cleanup
+
+    it "should create a config file" do
+      config[:a] = 5
+      expect(File.exists?('.testconfig')).to be true
+    end
+
+    it "should set keys" do
+      config[:a] = 5
+      expect(config[:a]).to eq(5)
+    end
+
+    it "should load keys" do
+      config[:a] = 5
+
+      new_config = described_class.new('.testconfig')
+      expect(new_config[:a]).to eq(5)
+    end
+
+  end
+
+end

data/spec/git_editor.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+#
+# This is a test double for entering a commit message via an editor
+# It always enters the same commit message
+
+def commit_message
+  File.read(ARGV[0])
+end
+
+def write_commit_message(message)
+  File.write(ARGV[0], message)
+end
+
+def prepend_to_commit_message(line)
+  write_commit_message(line+commit_message)
+end
+
+def commit_body
+  if File.exist?('.git_commit_body')
+    File.read('.git_commit_body')
+  else
+    predefined_commit_body
+  end
+end
+
+def predefined_commit_body
+<<-BODY
+Short (50 chars or less) summary of changes
+
+More detailed explanatory text, if necessary.  Wrap it to about 72
+characters or so.  In some contexts, the first line is treated as the
+subject of an email and the rest of the text as the body.  The blank
+line separating the summary from the body is critical (unless you omit
+the body entirely); tools like rebase can get confused if you run the
+two together.
+
+BODY
+end
+
+prepend_to_commit_message(commit_body)

data/spec/git_editor_spec.rb

@@ -0,0 +1,59 @@
+describe "Git Editor Double" do
+
+  context "when making a commit via an editor" do
+
+    before do
+      @commit_message_filename = '.git_commit_message'
+      @commit_body_filename = '.git_commit_body'
+      delete_commit_message
+      delete_commit_body
+      write_commit_message("#This is the git commit message prepared by git")
+    end
+
+    after do
+      delete_commit_message
+      delete_commit_body
+    end
+
+    it "should add a predefined body to the commit message" do
+      run_git_editor
+      expect(commit_message).to match(/summary of changes/)
+    end
+
+    it "should add a user defined body to the commit message" do
+      write_commit_body('this is a test body')
+      run_git_editor
+      expect(commit_message).to match(/this is a test body/)
+    end
+
+    def commit_message
+      File.read(@commit_message_filename)
+    end
+
+    def commit_body
+      File.read(@commit_body_filename)
+    end
+
+    def write_commit_message(message)
+      File.write(@commit_message_filename, message)
+    end
+
+    def delete_commit_message
+      File.delete(@commit_message_filename) if File.exist?(@commit_message_filename)
+    end
+
+    def write_commit_body(body)
+      File.write(@commit_body_filename, body)
+    end
+
+    def delete_commit_body
+      File.delete(@commit_body_filename) if File.exists?(@commit_body_filename)
+    end
+
+    def run_git_editor
+      `./spec/git_editor.rb #{@commit_message_filename}`
+    end
+
+  end
+
+end

data/spec/jira_store_spec.rb

@@ -0,0 +1,57 @@
+require './spec/spec_helper'
+
+module Jiragit
+
+  describe JiraStore do
+
+    subject {
+      File.delete('.testjirastore') if File.exists?('.testjirastore')
+      described_class.new('.testjirastore')
+    }
+
+    after do
+      File.delete('.testjirastore') if File.exists?('.testjirastore')
+    end
+
+    it "should initialize using the default location" do
+      expect(described_class.new).to be_a JiraStore
+    end
+
+    it "should initialize using a custom location" do
+      expect(subject).to be_a JiraStore
+    end
+
+    it "should relate a branch to a jira" do
+      subject.relate(jira: "PA-12345", branch: "my-feature-branch")
+      branch = subject.relations(jira: "PA-12345").first
+      expect(branch.label).to eq "my-feature-branch"
+    end
+
+    it "should automatically save changes" do
+      subject.relate(jira: "PA-12345", branch: "my-feature-branch")
+      store = described_class.new('.testjirastore')
+      branch = store.relations(jira: "PA-12345").first
+      expect(branch.label).to eq "my-feature-branch"
+    end
+
+    it "should relate multiple branches to a jira" do
+      subject.relate(jira: "PA-12345", branch: "my-feature-branch")
+      subject.relate(jira: "PA-12345", branch: "my-second-feature-branch")
+      branch = subject.relations(jira: "PA-12345")
+      expect(branch.size).to eq 2
+      expect(branch.to_a.first.label).to eq "my-feature-branch"
+      expect(branch.to_a.last.label).to eq "my-second-feature-branch"
+    end
+
+    it "should relate a branch and a commit to a jira" do
+      subject.relate(jira: "PA-12345", branch: "my-feature-branch")
+      subject.relate(jira: "PA-12345", commit: "3d0ff811d2e4e71ede49d3db7fac71f1f988627e")
+      relations = subject.relations(jira: "PA-12345")
+      expect(relations.size).to eq 2
+      expect(relations.map(&:label)).to include "my-feature-branch"
+      expect(relations.map(&:label)).to include "3d0ff811d2e4e71ede49d3db7fac71f1f988627e"
+    end
+
+  end
+
+end

data/spec/logger_spec.rb

@@ -0,0 +1,37 @@
+require './spec/spec_helper'
+
+module Jiragit
+
+  describe Logger do
+
+    subject { Logger.new("test_log") }
+
+    after do
+      File.delete('test_log') if File.exists?('test_log')
+    end
+
+    it "should initialize" do
+      expect(subject).to be_a Logger
+    end
+
+    it "should create a log file" do
+      subject.info "Test"
+      expect(File.exists?('test_log')).to be true
+    end
+
+    it "should contain log entries" do
+      subject.info "Test"
+      contents = `cat test_log`
+      expect(contents).to match(/Test/)
+    end
+
+    it "should contain hooks names" do
+      subject.hook = "post-checkout"
+      subject.info "Test"
+      contents = `cat test_log`
+      expect(contents).to match(/post-checkout/)
+    end
+
+  end
+
+end

data/spec/merge_spec.rb

@@ -0,0 +1,85 @@
+require './spec/spec_helper'
+require 'expect'
+
+describe "Repository Merge Behaviors" do
+
+  include_context "Test Repository"
+
+  context "when merging a feature branch" do
+
+    before do
+      @repo.create('a_file', 'The quick fox jumped over the fence')
+      @repo.add('a_file')
+      @repo.commit('initial commit')
+      checkout_a_new_branch('feature_branch', 'PA-12345')
+      @repo.create('a_file', 'The brown fox jumped over the fence')
+      @repo.add('a_file')
+      @repo.commit('feature commit')
+      checkout_a_new_branch('another_feature_branch', 'PA-54321')
+      @repo.create('c_file', 'The frog went for a swim')
+      @repo.add('c_file')
+      @repo.commit('another feature commit')
+      checkout_an_existing_branch('master')
+      @repo.create('b_file', 'The cow walked to the lake')
+      @repo.add('b_file')
+      @repo.commit('hotpatch commit')
+      checkout_an_existing_branch('feature_branch')
+      @repo.create('d_file', 'The crow flew for a while')
+      @repo.add('d_file')
+      @repo.commit('feature commit number two')
+    end
+
+    context "into the master branch without conflicts" do
+
+      it "should not relate the jira" do
+        checkout_an_existing_branch('master')
+        @repo.merge('feature_branch')
+        assert_no_relation({jira: 'PA-12345'}, {branch: 'master'})
+      end
+
+      it "should add the jira to the merge commit message" do
+        checkout_an_existing_branch('master')
+        @repo.merge('feature_branch')
+        @repo.log_for_one_commit('HEAD') do |output, input|
+          output.expect("PA-12345", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+    end
+
+    context "into the feature branch without conflicts" do
+
+      it "should relate the jiras" do
+        checkout_an_existing_branch('feature_branch')
+        @repo.merge('another_feature_branch')
+        assert_relation({jira: 'PA-12345'}, {branch: 'feature_branch'})
+        assert_no_relation({jira: 'PA-54321'}, {branch: 'feature_branch'})
+      end
+
+      it "should add the current branch jira to the merge commit message" do
+        checkout_an_existing_branch('feature_branch')
+        @repo.merge('another_feature_branch')
+        @repo.log_for_one_commit('HEAD') do |output, input|
+          output.expect("PA-12345", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+      it "should add the merge branch jira to the merge commit message" do
+        checkout_an_existing_branch('feature_branch')
+        @repo.merge('another_feature_branch')
+        @repo.log_for_one_commit('HEAD') do |output, input|
+          output.expect("PA-54321", 5) do |message|
+            expect(message).to_not be nil
+          end
+        end
+      end
+
+    end
+
+  end
+
+end