historian 0.0.1

data/spec/historian/git_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+describe Historian::Git do
+  include GitHelpers
+
+  before do
+    create_test_repo
+  end
+
+  subject { @git }
+
+  describe "#bundle_history_file" do
+    before do
+      @history = history_for_repo :courageous_camel_history
+      @git = Historian::Git.new(repo_directory, @history)
+    end
+
+    subject { @git }
+
+    it "amends the previous commit to include changes to the history file" do
+      modified?(@history_file).should be_true
+      lambda { subject.bundle_history_file }.should_not change(self, :commits_count)
+      modified?(@history_file).should be_false
+    end
+  end
+
+  describe "#install_hook" do
+    before do
+      @git = Historian::Git.new(repo_directory, nil)
+      @hook = "foo-bar"
+      @hook_sym = :foo_bar
+      @hook_wrapper = File.join(repo_directory, ".git", "hooks", @hook)
+      @hook_script = File.join(repo_directory, ".git", "hooks", @hook + ".d", "historian")
+    end
+
+    shared_examples_for "creating the hook sub-script" do
+      it "creates the hook script" do
+        File.exists?(@hook_script).should be_true
+      end
+
+      it "makes the hook script executable" do
+        File.stat(@hook_script).should be_executable
+      end
+
+      describe "contents" do
+        before do
+          @contents = File.readlines @hook_script
+        end
+
+        it "should be a bash script" do
+          @contents.first.start_with?("#!/bin/bash").should be_true
+        end
+
+        it "should invoke the hook exactly once" do
+          @contents.grep("historian #{@hook_sym} $@\n").should have(1).match
+        end
+      end
+    end
+
+    shared_examples_for "creating the hook wrapper" do
+      it "creates a directory for hooks scripts" do
+        File.directory?(File.dirname @hook_script).should be_true
+      end
+
+      it "creates a wrapper script" do
+        File.exists?(@hook_wrapper).should be_true
+      end
+
+      it "makes the hook script executable" do
+        File.stat(@hook_wrapper).should be_executable
+      end
+
+      describe "contents" do
+        before do
+          @contents = File.readlines @hook_wrapper
+        end
+
+        it "should be a bash script" do
+          @contents.first.start_with?("#!/bin/bash").should be_true
+        end
+
+        it "should invoke all the scripts in the hook script directory" do
+          invoke = /for S in .*#{@hook}.d/
+          @contents.grep(invoke).should have(1).match
+        end
+      end
+    end
+
+    context "with no existing hook" do
+      before do
+        @result = @git.install_hook(@hook_sym)
+      end
+
+      it "returns :created" do
+        @result.should eq(:created)
+      end
+
+      it_behaves_like "creating the hook wrapper"
+      it_behaves_like "creating the hook sub-script"
+    end
+
+    context "when the hook is already installed" do
+      before do
+        @result = @git.install_hook(@hook_sym)
+      end
+
+      it "rewrites the hook file" do
+        File.should_receive(:open).with(@hook_script, /w/)
+        @git.install_hook @hook_sym
+      end
+
+      it "returns :exists" do
+        @git.install_hook(@hook_sym).should eq(:exists)
+      end
+    end
+
+    context "when another hook is already installed" do
+      before do
+        @original_contents = "the original script!"
+        File.open(@hook_wrapper, "w") { |f| f.write @original_contents }
+        @result = @git.install_hook(@hook_sym)
+      end
+
+      it "returns :adapted" do
+        @result.should eq(:adapted)
+      end
+
+      it "copies the original hook file into the hook's script directory" do
+        new_location = File.join File.dirname(@hook_script), "original"
+        File.read(new_location).should eq(@original_contents)
+      end
+
+      it_behaves_like "creating the hook wrapper"
+      it_behaves_like "creating the hook sub-script"
+    end
+  end
+
+  describe "#tag_release" do
+    shared_examples_for "a tagged release" do
+      it "creates a new tag for the latest version" do
+        tag = "v" + @history.current_version
+        tags.should_not include(tag)
+        subject.tag_release
+        tags.should include(tag)
+      end
+
+      it "annotates the tag with a short message including the version" do
+        subject.tag_release
+        commit_message_for_tag("v12.0.0").should match(/tagged v12.0.0 "Courageous Camel"/)
+      end
+
+      it "annotates the tag with the changelog" do
+        subject.tag_release
+        commit_message_for_tag("v12.0.0").should include(fixture :courageous_camel_release_log)
+      end
+    end
+
+    describe "with a dirty history file" do
+      before do
+        @history = history_for_repo :courageous_camel_history
+        @history.update_history :minor => "some little thing"
+        @git = Historian::Git.new(repo_directory, @history)
+      end
+
+      subject { @git }
+
+      it "releases the history file if the changelog isn't empty" do
+        @history.should_receive :release
+        subject.tag_release
+      end
+
+      it "commits the history file if it has unstaged changes" do
+        subject.should_receive(:commit_history_changes).twice
+        subject.tag_release
+      end
+
+      it_behaves_like "a tagged release"
+    end
+
+    describe "with a clean history file" do
+      before do
+        @history = history_for_repo :courageous_camel_history
+        run_git "add", @history.path
+        run_git "commit", "-m", "clean the history"
+        @git = Historian::Git.new(repo_directory, @history)
+      end
+
+      subject { @git }
+
+      it "does not commit the history file" do
+        subject.should_not_receive :commit_history_changes
+        subject.tag_release
+      end
+
+      it_behaves_like "a tagged release"
+
+    end
+  end
+end

data/spec/historian/history_file_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+describe Historian::HistoryFile do
+  def history(fixture_name)
+    StringIO.new(fixture fixture_name).tap do |io|
+      io.extend Historian::HistoryFile
+    end
+  end
+
+  before do
+    @io = StringIO.new ""
+    @io.extend Historian::HistoryFile
+  end
+
+  subject { @io }
+
+  describe "#release" do
+    it "should invoke update_history" do
+      subject.should_receive(:update_history).with(:release => true)
+      subject.release
+    end
+  end
+
+  context "with no history" do
+    before do
+      @io = StringIO.new(fixture :empty)
+      @io.extend Historian::HistoryFile
+    end
+    subject {@io}
+
+    context "when not adding history" do
+      it { should have_current_version "0.0.0" }
+      it { should have_next_version    "0.0.1" }
+    end
+
+    context "when adding a patch to history" do
+      before do
+        @io.update_history :patch => "bugfix #1"
+      end
+
+      it { should have_current_version "0.0.0" }
+      it { should have_next_version    "0.0.1" }
+
+      it { should have_history_like   :patch_on_nothing }
+      it { should have_changelog_like :patch_on_nothing }
+    end
+
+    context "when triggering a release" do
+      before do
+        Time.stub_chain :now, :strftime => "2010/12/12"
+        @io.update_history :release => "Addled Adder"
+      end
+
+      it { should have_current_version "0.0.1" }
+      it { should have_next_version    "0.0.2" }
+      it { should have_history_like   :release_on_nothing }
+    end
+  end
+
+  context "with unreleased history" do
+    before do
+      @io = StringIO.new(fixture :patch_on_nothing)
+      @io.extend Historian::HistoryFile
+    end
+    subject {@io}
+
+    context "when adding a patch to history" do
+      before do
+        @io.update_history :patch => "bugfix #2"
+      end
+
+      it { should have_current_version "0.0.0" }
+      it { should have_next_version    "0.0.1" }
+
+      it { should have_history_like   :second_patch_on_nothing }
+      it { should have_changelog_like :second_patch_on_nothing }
+    end
+  end
+
+  context "with unreleased and a 0.0.2 release" do
+    before do
+      @io = StringIO.new(fixture :after_0_0_2)
+      @io.extend Historian::HistoryFile
+    end
+    subject {@io}
+
+    it { should have_current_version "0.0.2" }
+    it { should have_next_version    "0.0.3" }
+
+
+    context "when adding a patch to history" do
+      before do
+        @io.update_history :patch => "bugfix #2"
+      end
+
+      it { should have_next_version    "0.0.3" }
+      it { should have_history_like   :after_0_0_2_history }
+      it { should have_changelog_like :after_0_0_2_changelog }
+    end
+  end
+
+  describe do
+    before do
+      @io = StringIO.new(fixture :normal)
+      @io.extend Historian::HistoryFile
+    end
+    subject {@io}
+
+    context "after minor changes and bugfixes" do
+      before do
+        @io.update_history :patch => "bugfix #2",
+                        :minor => "minor #1"
+      end
+
+      it { should have_current_version "11.22.33" }
+      it { should have_next_version    "11.23.0" }
+
+      it { should have_history_like   :normal_history_after_minor   }
+      it { should have_changelog_like :normal_changelog_after_minor }
+    end
+
+    context "after major changes, minor changes and bugfixes" do
+      before do
+        @io.update_history :patch => "bugfix #2",
+                        :minor => "minor #1",
+                        :major => "major #1"
+      end
+
+      it { should have_current_version "11.22.33" }
+      it { should have_next_version    "12.0.0" }
+
+      it { should have_history_like   :normal_history_after_major   }
+      it { should have_changelog_like :normal_changelog_after_major }
+    end
+  end
+
+  context "when releasing a major change" do
+    before do
+      Time.stub_chain :now, :strftime => "2010/12/12"
+      @io = StringIO.new(fixture :normal)
+      @io.extend Historian::HistoryFile
+    end
+    subject { @io }
+
+    context "with release name 'Courageous Camel'" do
+      before do
+        @io.update_history :major => "major #1",
+                        :release => "Courageous Camel"
+      end
+      it { should have_current_version "12.0.0" }
+      it { should have_next_version    "12.0.1" }
+      it { should have_history_like     :courageous_camel_history   }
+      it { should have_changelog_like   :empty                      }
+      it { should have_release_log_like :courageous_camel_release_log }
+      it "returns the release name with #release_name" do
+        subject.current_release_name.should eq("Courageous Camel")
+      end
+    end
+
+    context "with no release name" do
+      before do
+        @io.update_history :major => "major #1",
+                        :release => true
+      end
+
+      it { should have_release_log_like :anonymous_release_log }
+    end
+  end
+
+  context "when parsing a history file with a release and no unreleased changelog" do
+    before do
+      @io = StringIO.new(fixture :courageous_camel_history)
+      @io.extend Historian::HistoryFile
+    end
+    subject { @io }
+
+    it { should have_current_version "12.0.0" }
+    it "returns the release name with #release_name" do
+      subject.current_release_name.should eq("Courageous Camel")
+    end
+    it "returns the changelog for the release" do
+      subject.release_log.strip.should eql(fixture :courageous_camel_release_log)
+    end
+  end
+
+  context "when parsing a history with all significance categories" do
+    before do
+      @io = StringIO.new(fixture :all_types_history)
+      @io.extend Historian::HistoryFile
+      @io.parse
+    end
+    subject { @io.changes }
+
+    it "has major changes" do
+      subject[:major].should_not be_empty
+    end
+
+    it "has minor changes" do
+      subject[:minor].should_not be_empty
+    end
+
+    it "has patch changes" do
+      subject[:patch].should_not be_empty
+    end
+  end
+
+  # TODO: I've realized too late that the strict format
+  #       I'm parsing against isn't very practical. I'll need
+  #       to rework my parsing code to be more versatile.
+  context "oddly formated history files" do
+    it "raises an error when finding history without significance" do
+      lambda { history(:missing_significance).parse }.should raise_error(Historian::ParseError)
+    end
+    it "raises an error when finding an unknown significance" do
+      lambda { history(:invalid_significance).parse }.should raise_error(Historian::ParseError)
+    end
+    it "raises an error when finding arbitrary text" do
+      lambda { history(:arbitrary_text).parse }.should raise_error(Historian::ParseError)
+    end
+  end
+
+
+
+
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--diff
+--color
+--format progress

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+
+require File.expand_path("../../lib/historian", __FILE__)
+
+begin
+  require 'rubygems'
+  require 'spackle'
+  Spackle.init :with => :rspec_formatter
+rescue LoadError
+  puts "spackle gem not found -- continuing"
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end