git_breeze 0.1.0

data/spec/git_breeze/branch_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'git_breeze/branch'
+
+describe GitBreeze::Branch do
+  subject(:branch) { described_class }
+
+  def stub_branch(ref, exit_status = 0)
+    allow_message_expectations_on_nil
+    allow(branch).to receive(:`) { ref }
+    allow($?).to receive(:exitstatus) { exit_status }
+  end
+
+  describe '.current' do
+    it 'shells out to git, looking for the current HEAD' do
+      stub_branch('refs/heads/herpty_derp_de')
+      expect(branch).to receive('`').with('git symbolic-ref HEAD')
+      branch.current
+    end
+
+    it 'ensures in a Git repository when looking for HEAD exits with non-zero status' do
+      stub_branch('', 128)
+
+      expect(GitBreeze::Repository).to receive(:ensure_exists)
+      branch.current
+    end
+  end
+
+  describe '.story_number' do
+    context 'Current branch has a story number' do
+      it 'finds the story that starts with a hash' do
+        stub_branch('refs/heads/a_very_descriptive_name_#8675309')
+        expect(branch.story_number).to eq('8675309')
+      end
+
+      it 'finds the story without a leading hash' do
+        stub_branch('refs/heads/a_very_descriptive_name_1235309')
+        expect(branch.story_number).to eq('1235309')
+      end
+
+      it 'finds the story following a forward hash' do
+        stub_branch('refs/heads/alindeman/8675309_got_her_number')
+        expect(branch.story_number).to eq('8675309')
+      end
+
+      it 'finds the story in a branch with hyphens' do
+        stub_branch('refs/heads/stevenharman/got-her-number-8675309')
+        expect(branch.story_number).to eq('8675309')
+      end
+
+      it 'finds the story in a branch with a version number' do
+        stub_branch('refs/heads/stevenharman/v2.0-got-her-number-8675309')
+        expect(branch.story_number).to eq('8675309')
+      end
+    end
+
+    context 'The current branch has a number that is not a story' do
+      it 'finds no story' do
+        stub_branch('refs/heads/a_very_descriptive_name_with_some_a_version_number_v2.0')
+        expect(branch.story_number).to_not be
+      end
+    end
+
+    context 'The current branch does not have a story number' do
+      it 'finds no story' do
+        stub_branch('refs/heads/a_very_descriptive_name-without_a_#number')
+        expect(branch.story_number).to_not be
+      end
+    end
+
+    context 'Not on a branch (HEAD does not exist)' do
+      it 'finds no story' do
+        stub_branch('')
+        expect(branch.story_number).to_not be
+      end
+    end
+  end
+end

data/spec/git_breeze/commit_message_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'git_breeze/commit_message'
+require 'active_support/core_ext/string/strip'
+
+describe GitBreeze::CommitMessage do
+  include CommitMessageHelper
+
+  subject(:commit_message) { described_class.new(file) }
+  let(:file) { 'COMMIT_EDITMSG' }
+
+  it 'requires path to the temporary commit message file' do
+    expect { GitBreeze::CommitMessage.new }.to raise_error ArgumentError
+  end
+
+  def stub_commit_message(story_text)
+    allow(File).to receive(:read).with(file) { example_commit_message(story_text) }
+  end
+
+#  describe '#keyword' do
+#    %w[fix Fixed FIXES Complete completed completes FINISH finished Finishes Deliver delivered DELIVERS].each do |keyword|
+#      it "detects the #{keyword} keyword" do
+#        stub_commit_message("Did the darn thing. [#{keyword}]")
+#        expect(commit_message.keyword).to eq(keyword)
+#      end
+#    end
+#
+#    it 'does not find the keyword when it does not exist' do
+#      stub_commit_message('Did the darn thing. [Something]')
+#      expect(commit_message.keyword).to_not be
+#    end
+#  end
+
+  describe '#mentions_story?' do
+      context 'commit message contains the special Breeze story syntax' do
+      it 'allows just the number' do
+        stub_commit_message('[#8675309]')
+        expect(commit_message).to be_mentions_story('8675309')
+      end
+
+      it 'allows multiple numbers' do
+        stub_commit_message('[#99 #777 #8675309 #111222]')
+        expect(commit_message).to be_mentions_story('99')
+        expect(commit_message).to be_mentions_story('777')
+        expect(commit_message).to be_mentions_story('8675309')
+        expect(commit_message).to be_mentions_story('111222')
+      end
+
+      it 'allows state change before number' do
+        stub_commit_message('[Fixes #8675309]')
+        expect(commit_message).to be_mentions_story('8675309')
+      end
+
+      it 'allows state change after the number' do
+        stub_commit_message('[#8675309 Delivered]')
+        expect(commit_message).to be_mentions_story('8675309')
+      end
+
+      it 'allows surrounding text' do
+        stub_commit_message('derp de #herp [Fixes #8675309] de herp-ity derp')
+        expect(commit_message).to be_mentions_story('8675309')
+      end
+    end
+
+    context 'commit message doesn not contain the special Breeze story syntax' do
+#      it 'requires brackets' do
+#        stub_commit_message('#8675309')
+#        expect(commit_message).to_not be_mentions_story('8675309')
+#      end
+
+      it 'requires a pound sign' do
+        stub_commit_message('[8675309]')
+        expect(commit_message).to_not be_mentions_story('8675309')
+      end
+
+      it 'does not allow the bare number' do
+        stub_commit_message('8675309')
+        expect(commit_message).to_not be_mentions_story('8675309')
+      end
+
+#      it 'does not allow multiple state changes' do
+#        stub_commit_message('[Fixes Deploys #8675309]')
+#        expect(commit_message).to_not be_mentions_story('8675309')
+#      end
+
+#      it 'does not allow comments' do
+#        stub_commit_message('#[#8675309]')
+#        expect(commit_message).to_not be_mentions_story('8675309')
+#      end
+    end
+  end
+
+  describe '#append' do
+    let(:fake_file) { GitBreeze::FakeFile.new }
+    before do
+      allow(File).to receive(:open).and_yield(fake_file)
+    end
+    def stub_original_commit_message(message)
+      allow(File).to receive(:read) { message }
+    end
+
+    it 'handles no existing message' do
+      commit_message_text = <<-COMMIT_MESSAGE.strip_heredoc
+
+
+        #8675309
+        # some other comments
+      COMMIT_MESSAGE
+
+      stub_original_commit_message("\n\n# some other comments\n")
+      commit_message.append('[#8675309]')
+
+      expect(fake_file.content).to eq(commit_message_text)
+    end
+
+    it 'preserves existing messages' do
+      commit_message_text = <<-COMMIT_MESSAGE.strip_heredoc
+        A first line
+
+        With more here
+
+        #8675309
+        # other comments
+      COMMIT_MESSAGE
+
+      stub_original_commit_message("A first line\n\nWith more here\n# other comments\n")
+      commit_message.append('[#8675309]')
+
+      expect(fake_file.content).to eq(commit_message_text)
+    end
+
+    it 'preserves line breaks in comments' do
+      commit_message_text = <<-COMMIT_MESSAGE.strip_heredoc
+
+
+        #8675309
+        # comment #1
+        # comment B
+        # comment III
+      COMMIT_MESSAGE
+
+      stub_original_commit_message("# comment #1\n# comment B\n# comment III")
+      commit_message.append('[#8675309]')
+
+      expect(fake_file.content).to eq(commit_message_text)
+    end
+  end
+end

data/spec/git_breeze/hook_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'git_breeze/hook'
+require 'active_support/core_ext/string/strip'
+
+describe GitBreeze::Hook do
+  subject(:hook) { described_class }
+  let(:root) { '/path/to/git/repo/toplevel' }
+  let(:hook_path) { File.join(root, '.git', 'hooks', 'prepare-commit-msg') }
+
+  describe '.init' do
+    before do
+      allow(GitBreeze::Repository).to receive(:root) { root }
+      allow(hook).to receive(:init_at)
+    end
+
+    it 'initializes to the root of the Git repository' do
+      hook.init
+      expect(hook).to have_received(:init_at).with(root)
+    end
+  end
+
+  describe '.init_at' do
+    let(:fake_file) { GitBreeze::FakeFile.new }
+    before do
+      allow(File).to receive(:open).and_yield(fake_file)
+    end
+
+    it 'writes the hook into the hooks directory' do
+      hook.init_at(root)
+      expect(File).to have_received(:open).with(hook_path, 'w')
+    end
+
+    it 'makes the hook executable' do
+      hook.init_at(root)
+      expect(fake_file.mode).to eq(0755)
+    end
+
+    it 'writes the hook code in the hook file' do
+      hook_code = <<-HOOK_CODE.strip_heredoc
+        #!/usr/bin/env bash
+
+        git-breeze prepare-commit-msg "$@"
+
+      HOOK_CODE
+
+      hook.init_at(root)
+      expect(fake_file.content).to eq(hook_code)
+    end
+  end
+
+end

data/spec/git_breeze/prepare_commit_message_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+require 'git_breeze/prepare_commit_message'
+
+describe GitBreeze::PrepareCommitMessage do
+  subject(:prepare_commit_message) { GitBreeze::PrepareCommitMessage }
+
+  describe '.run' do
+    let(:hook) { double('PrepareCommitMessage') }
+    before do
+      allow(prepare_commit_message).to receive(:new) { hook }
+    end
+
+    it 'runs the hook' do
+      expect(hook).to receive(:run)
+      prepare_commit_message.run('FILE1', 'hook_source', 'sha1234')
+    end
+  end
+
+  describe '.new' do
+
+    it 'requires the name of the commit message file' do
+      expect { prepare_commit_message.new }.to raise_error(ArgumentError)
+    end
+
+    it 'remembers the name of the commit message file' do
+      expect(prepare_commit_message.new('FILE1').file).to eq('FILE1')
+    end
+
+    it 'optionally accepts a message source' do
+      expect(hook = prepare_commit_message.new('FILE1', 'merge').source).to eq('merge')
+    end
+
+    it 'optionally accepts the SHA-1 of a commit' do
+      expect(hook = prepare_commit_message.new('FILE1', 'commit', 'abc1234').commit_sha).to eq('abc1234')
+    end
+  end
+
+  describe '#run' do
+    let(:hook) { GitBreeze::PrepareCommitMessage.new('FILE1') }
+    let(:commit_message) { double('CommitMessage', :append => nil) }
+
+    before do
+      allow(GitBreeze::Branch).to receive(:story_number) { story }
+      allow(GitBreeze::CommitMessage).to receive(:new) { commit_message }
+    end
+
+    context 'with an existing commit (via `-c`, `-C`, or `--amend` options)' do
+      let(:hook) { described_class.new('FILE2', 'commit', '60a086f3') }
+
+      it 'exits with status code 0' do
+        expect { hook.run }.to succeed
+      end
+    end
+
+    context 'branch name without a Breeze story number' do
+      let(:story) { nil }
+
+      it 'exits without updating the commit message' do
+        expect { hook.run }.to succeed
+        expect(commit_message).to_not have_received(:append)
+      end
+    end
+
+    context 'branch name with a Breeze story number' do
+      let(:story) { '8675309' }
+      before do
+        allow(commit_message).to receive(:mentions_story?) { false }
+        allow(commit_message).to receive(:keyword) { nil }
+      end
+
+      it 'appends the number to the commit message' do
+        hook.run
+        expect(commit_message).to have_received(:append).with('#8675309')
+      end
+
+      context 'keyword mentioned in the commit message' do
+        before do
+          allow(commit_message).to receive(:keyword) { 'Delivers' }
+        end
+
+        it 'appends the keyword and the story number' do
+          hook.run
+          expect(commit_message).to have_received(:append).with('Delivers #8675309')
+        end
+      end
+
+      context 'number already mentioned in the commit message' do
+        before do
+          allow(commit_message).to receive(:mentions_story?).with('8675309') { true }
+        end
+
+        it 'exits without updating the commit message' do
+          expect { hook.run }.to succeed
+          expect(commit_message).to_not have_received(:append)
+        end
+      end
+    end
+
+  end
+end

data/spec/git_breeze/repository_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'git_breeze/repository'
+
+describe GitBreeze::Repository do
+  subject(:repository) { described_class }
+  let(:git_command) { 'git rev-parse --show-toplevel' }
+  before do
+    allow_message_expectations_on_nil
+    allow(repository).to receive(:`).with(git_command) { "/path/to/git/repo/root\n" }
+  end
+
+  describe '.root' do
+
+    it 'gets the path to the top-level directory of the local Repository' do
+      allow($?).to receive(:exitstatus) { 0 }
+      expect(repository.root).to eq('/path/to/git/repo/root')
+    end
+
+    it 'aborts when not in a git repository' do
+      allow($?).to receive(:exitstatus) { 128 }
+      expect { repository.root }.to_not succeed
+    end
+  end
+
+  describe '.ensure_exists' do
+    it 'aborts when not in a git repository' do
+      allow($?).to receive(:exitstatus) { 128 }
+      expect { repository.root }.to_not succeed
+    end
+  end
+
+end

data/spec/git_breeze/runner_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'git_breeze/runner'
+
+describe GitBreeze::Runner do
+  subject(:runner) { described_class }
+  let(:args) { ['a_file', 'the_source', 'sha1234'] }
+
+  describe '.execute' do
+    include OutputHelper
+
+    before do
+      allow(runner).to receive(:prepare_commit_msg) { true }
+    end
+
+    it 'runs the hook, passing the args' do
+      expect(runner).to receive(:prepare_commit_msg).with(*args) { true }
+      runner.execute('prepare-commit-msg', *args)
+    end
+
+    it 'does not run hooks we do not know about' do
+      errors = capture_stderr do
+        expect { runner.execute('non-existent-hook', *args) }.to_not succeed
+      end
+      expect(errors.chomp).to eq("[git_tracker] command: 'non-existent-hook' does not exist.")
+    end
+  end
+
+  describe '.prepare_commit_msg' do
+    it 'runs the hook, passing the args' do
+      expect(GitBreeze::PrepareCommitMessage).to receive(:run).with(*args) { true }
+      runner.prepare_commit_msg(*args)
+    end
+  end
+
+  describe '.init' do
+    it 'tells the hook to initialize itself' do
+      expect(GitBreeze::Hook).to receive(:init)
+      runner.init
+    end
+  end
+
+  it '.help reports that it was run' do
+      expect(runner).to receive(:puts).with(/git-breeze #{GitBreeze::VERSION} is installed\./)
+    runner.execute('help')
+  end
+
+end

data/spec/git_breeze/standalone_spec.rb

@@ -0,0 +1,88 @@
+require 'git_breeze/standalone'
+
+describe GitBreeze::Standalone do
+
+  describe '#save' do
+    before do
+      File.delete 'git-breeze' if File.exists? 'git-breeze'
+    end
+
+    after do
+      File.delete 'git-breeze' if File.exists? 'git-breeze'
+    end
+
+    it 'saves to the named file' do
+      described_class.save('git-breeze')
+      expect(File.size('./git-breeze')).to be > 100
+    end
+
+    it 'marks the binary as executable' do
+      described_class.save('git-breeze')
+      expect(File).to be_executable('./git-breeze')
+    end
+
+  end
+
+  describe '#build' do
+    subject(:standalone_script) { described_class.build(io).string }
+    let(:io) { StringIO.new }
+
+    it 'declares a shebang' do
+      expect(standalone_script).to match(/#!.+/)
+    end
+
+    it 'includes generated code notice' do
+      expect(standalone_script).to include('This file is generated')
+    end
+
+    it 'inlines the code' do
+      expect(standalone_script).to include('Hook')
+      expect(standalone_script).to include('Repository')
+      expect(standalone_script).to include('PrepareCommitMessage')
+      expect(standalone_script).to include('Runner')
+      expect(standalone_script).to include('Branch')
+      expect(standalone_script).to include('CommitMessage')
+      expect(standalone_script).to include('VERSION')
+    end
+
+    it 'inlines the message HEREDOC' do
+      expect(standalone_script).to include('#{preamble.strip}')
+    end
+
+    it 'inlines the shebang for the hook' do
+      expect(standalone_script).to include('#!/usr/bin/env bash')
+    end
+
+    it 'does not inline the standalone code' do
+      expect(standalone_script).to_not include('module Standalone')
+    end
+
+    it 'includes the call to execute the hook' do
+      expect(standalone_script).to include('GitBreeze::Runner.execute(*ARGV)')
+    end
+
+    it 'excludes requiring git_breeze code' do
+      expect(standalone_script).to_not match(/^require\s+["']git_breeze/)
+    end
+
+  end
+
+  describe '#ruby_executable' do
+    subject(:standalone) { described_class }
+    before do
+      allow(RbConfig::CONFIG).to receive(:[]).with('bindir') { '/some/other/bin' }
+      allow(RbConfig::CONFIG).to receive(:[]).with('ruby_install_name') { 'ruby' }
+    end
+
+    it 'uses user-level ruby binary when it is executable' do
+      allow(File).to receive(:executable?).with('/usr/bin/ruby') { true }
+      expect(standalone.ruby_executable).to eq('/usr/bin/ruby')
+    end
+
+    it 'uses rbconfig ruby when user-level ruby binary not executable' do
+      allow(File).to receive(:executable?).with('/usr/bin/ruby') { false }
+      expect(standalone.ruby_executable).to eq('/some/other/bin/ruby')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+if (RUBY_VERSION >= '1.9') && ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
+  CodeClimate::TestReporter.start
+end
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|f| require f }
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end

data/spec/support/commit_message_helper.rb

@@ -0,0 +1,20 @@
+module CommitMessageHelper
+
+  def example_commit_message(pattern_to_match)
+    return <<-EXAMPLE
+Got Jenny's number, gonna' make her mine!
+
+#{pattern_to_match}
+# Please enter the commit message for your changes. Lines starting
+# with '#' will be ignored, and an empty message aborts the commit.
+# On branch get_jennys_number_#8675309
+# Changes to be committed:
+#   (use "git reset HEAD <file>..." to unstage)
+#
+# new file:   fake_file.rb
+#
+
+EXAMPLE
+  end
+end
+

data/spec/support/fake_file.rb

@@ -0,0 +1,13 @@
+module GitTracker
+  class FakeFile
+    attr_reader :content, :mode
+
+    def write(content)
+      @content = content
+    end
+
+    def chmod(mode_int)
+      @mode = mode_int
+    end
+  end
+end

data/spec/support/matchers/exit_code_matchers.rb

@@ -0,0 +1,37 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :succeed do
+  actual = nil
+
+  match do |block|
+    begin
+      block.call
+    rescue SystemExit => e
+      actual = e.status
+    end
+    actual and actual == successful_exit_code
+  end
+
+  failure_message do |block|
+    "expected block to call exit(#{successful_exit_code}) but exit" +
+      (actual.nil? ? ' not called' : "(#{actual}) was called")
+  end
+
+  failure_message_when_negated do |block|
+    "expected block not to call exit(#{successful_exit_code})"
+  end
+
+  description do
+    "expect block to call exit(#{successful_exit_code})"
+  end
+
+  def successful_exit_code
+    0
+  end
+
+  def supports_block_expectations?
+    true
+  end
+
+end
+

data/spec/support/output_helper.rb

@@ -0,0 +1,12 @@
+require 'stringio'
+
+module OutputHelper
+  def capture_stderr
+    old_out, new_out = $stderr, StringIO.new
+    $stderr = new_out
+    yield
+  ensure
+    $stderr = old_out
+    return new_out.string
+  end
+end