historian 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+rdoc
+tmp
+pkg/*
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--drb
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in historian/.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    historian (0.0.1)
+      project_scout (>= 0.0.2)
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    diff-lcs (1.1.2)
+    project_scout (0.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    thor (0.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  bundler
+  historian!
+  project_scout (>= 0.0.2)
+  rspec (~> 2.3.0)
+  thor

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rick Lee-Morlang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Rick Lee-Morlang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,149 @@
+= Historian
+
+Historian automatically maintains your project's History.txt file
+based on your git changelogs, and can automatically perform
+releases for you.
+
+== Historian is Opinionated Software
+
+Historian makes a number of assumptions. You might not like them.
+It works well for how I like to work, but patches are welcome.
+
+* it (pretty much) works only with Git
+* it updates history in +History.txt+ in your project root dir
+* it writes your +History.txt+ file in Markdown format
+* it considers three levels of "significance": major changes, minor changes, and bugfixes
+* it generates version numbers when a release is triggered
+* version numbers are in x.y.z format (major.minor.patch)
+* the significance of changes controls how version numbers are incremented
+
+== Usage
+
+Install Historian's git commit hooks in your current git repository.
+
+  historian install
+
+Make some changes, and run +git commit+. In your commit message,
+prefix any lines you'd like to make part of your history with
+one of the following tags, according to the significance of the
+change message:
+
+M:: A major change
+m:: A minor change
+b:: A bugfix
+
+For example, suppose your commit message would normally have
+been:
+
+  Rewrote network protocol, breaking compatibility with old clients.
+
+With Historian, this becomes:
+
+  M:Rewrote network protocol, breaking compatibility with old clients.
+
+The "M:" will be stripped out of the commit message, so it won't
+show up that way in your commit history. However, Historian will
+use the content on the line where the M: appears to update the
+history file. If you had no +History.txt+ file before now, one
+will be created with the following content:
+
+  ## In Git
+
+  ### Major Changes
+  * Rewrote network protocol, breaking compatibility with old clients.
+
+Historian will bundle the change to +History.txt+ as part of your
+commit.
+
+== Adding history without it showing in your commit log
+
+You can also insert history entries that don't show up in your
+commit logs, if you prefer. Example syntax of a commit message.
+
+  Replaced ASCII protocol with XML syntax.
+
+  M#:Rewrote network protocol, breaking compatibility with old clients.
+
+Note the "#" before the colon. This tells Historian to suppress the
+content of that line in the commit message, so your commit log will
+only show:
+
+  Replaced ASCII protocol with XML syntax.
+
+
+== Triggering releases
+
+You can also tell Historian that this commit marks a new release.
+Any line that begins with a bang-colon "!:" will trigger a release.
+The rest of the line can be empty, or it can optionally contain
+a "friendly name" for the release. Examples:
+
+  !:Flux Capacitor PRO
+
+Or, in Debian/Ubuntu style:
+
+  !:Addled Adder
+
+When a release is triggered, Historian will check the recent History
+for major, minor, and bugfix entries to determine if this is a
+major, minor or bugfix release. Historian refers to this as
+"significance."
+
+Historian will also determine the most recent release number from
+the History.txt file, or will default to "0.0.0".
+
+Historian will calculate a new version number by incrementing the
+appropriate major, minor, or patch triplet based on the significance
+of the release.
+
+Historian will update the +History.txt+ file with a header for
+the recent history that contains the version number, date, and
+(if specified) the release name.
+
+Finally, Historian will create an annotated tag in git with the
+version number of the release. The tag contents will contain
+the changelog.
+
+== Multiple history entries
+
+Historian allows multiple entries, if you like. Example commit
+message:
+
+  Numerous minor bugfixes
+
+  b: * eliminated crash when ip address not specified
+  b: * logs now include hostnames
+  b: * new connections append to logfiles instead of clobbering them
+
+Note that any non-alphanumeric content after the colon is ignored,
+so the history entries will not include the " * ".
+
+== Manual Invocation
+
+You can use Historian in a limited way from the commandline. These
+forms update +History.txt+ only, and do not interact with Git.
+
+The following will add two new history entries.
+
+  history update major="rewrote network protocol" \
+                 bugfix="fixed null reference crash"
+
+This will increment the version number.
+
+  history release
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Rick Lee-Morlang. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/bin/historian

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+historian_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(historian_dir) unless $LOAD_PATH.include?(historian_dir)
+
+require 'historian'
+
+begin
+  Historian::CLI.start
+#rescue => err
+  #STDERR.puts err.message
+  #exit 1
+end

data/historian.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "historian/version"
+
+Gem::Specification.new do |s|
+  s.name        = "historian"
+  s.version     = Historian::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Richard Lee-Morlang"]
+  s.email       = ["rick@lee-morlang.com"]
+  s.homepage    = "https://github.com/rleemorlang/historian"
+  s.summary     = %q{Automatically extract information from git commit messages and update your project's history file.}
+  s.description = %q{Historian uses git commit hooks to inject itself into Git's commit workflow. Historian checks your commit messages for certain markup tokens. If found, it updates your project's history file, and amends your commit with it, while also stripping out the markup.}
+
+  #s.rubyforge_project = "historian"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "thor"
+  s.add_dependency "project_scout", ">= 0.0.2"
+
+  s.add_development_dependency "rspec", "~> 2.3.0"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "autotest"
+end

data/lib/historian.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+
+module Historian
+  class ParseError < StandardError; end
+end
+
+require "historian/history_file"
+require "historian/git"
+require "historian/commit_message"
+require "historian/cli"
+require "historian/version"

data/lib/historian/cli.rb

@@ -0,0 +1,84 @@
+require 'thor'
+require 'project_scout'
+#require 'thor/actions'
+
+class Historian::CLI < Thor
+  attr_accessor :git, :history, :repo_directory
+
+  default_task :help
+
+  def initialize(*)
+    super
+    @repo_directory = ProjectScout.scan Dir.pwd, :for => [ :git_repository ]
+
+    history_file = File.join(repo_directory, "History.txt")
+    unless File.exists? history_file
+      File.open history_file, "w"
+    end
+    @history = File.open history_file, File::RDWR
+    history.sync = true
+    history.extend Historian::HistoryFile
+    self.git = Historian::Git.new(repo_directory, history)
+  end
+
+  desc "commit_msg FILE", "Git commit-msg hook for Historian. Not intended for manual use."
+  def commit_msg(message_file)
+    return nil if File.exists? amend_flag_file
+
+    history_updated = false
+    release = nil
+    new_message = []
+    File.open(message_file).each_line do |line|
+      line = Historian::CommitMessage.parse_line line
+      new_message << line.to_s unless line.suppressed?
+      case line.significance
+      when :minor, :major, :patch
+        history.update_history line.significance => line.to_message_s
+        history_updated = true
+      when :release
+        release = line.to_message_s
+      end
+    end
+
+    if release
+      history_updated = true
+      history.update_history :release => release
+      File.open release_flag_file, "w"
+    end
+
+    if history_updated
+      File.open amend_flag_file, "w"
+      File.open(message_file,"w") { |f| f.puts new_message }
+    end
+  end
+
+  desc "install", "install Historian Git hooks into current repository."
+  def install
+    git.install_hook :commit_msg
+    git.install_hook :post_commit
+  end
+
+  desc "post_commit", "Git post-commit hook for Historian. Not intended for manual use."
+  def post_commit
+    if File.exists? amend_flag_file
+      File.unlink amend_flag_file
+      git.bundle_history_file
+    end
+
+    if File.exists? release_flag_file
+      File.unlink release_flag_file
+      git.tag_release
+    end
+  end
+
+protected
+
+  def amend_flag_file
+    File.join(repo_directory, ".git", "historian-amend")
+  end
+
+  def release_flag_file
+    File.join(repo_directory, ".git", "historian-release")
+  end
+end
+

data/lib/historian/commit_message.rb

@@ -0,0 +1,40 @@
+require 'ostruct'
+
+class Historian::CommitMessage
+  attr_reader :line, :token, :suppressed
+
+  def initialize(line)
+    if line =~ /^([!bmM])(#?):(.*[0-9a-zA-Z].*)$/
+      @token = $1
+      @suppressed = true if $2 == "#"
+      @line = $3
+    else
+      @line = line
+    end
+  end
+
+  def significance
+    case token
+    when "b"; :patch
+    when "m"; :minor
+    when "M"; :major
+    when "!"; :release
+    end
+  end
+
+  def suppressed?
+    @suppressed == true
+  end
+
+  def to_s
+    line
+  end
+
+  def to_message_s
+    line.gsub /^\W*/, '' if significance
+  end
+
+  def self.parse_line(line)
+    new line
+  end
+end

data/lib/historian/configuration.rb

@@ -0,0 +1,10 @@
+require 'active_dotfile'
+
+module Historian
+  class Configuration
+    include ActiveDotfile::Configurable
+    load_dotfiles_on_initialize
+
+    attr_accessor_with_default :map => {}
+  end
+end