herodotus 0.0.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2

data/CHANGES

@@ -0,0 +1,10 @@
+v0.0.1 [2011-07-28]:
+
+2011-07-23  Harold Giménez <hgimenez@thoughtbot.com>
+Including "Changelog:" in the commit message will mark
+that commit as available for the changelog, and will use all text
+below the keyword.
+
+2011-07-27  Harold Giménez <hgimenez@thoughtbot.com>
+Add the ability for specifying which revision to write a changelog
+since. Usually, this will be a tag name.

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+Herodotus
+---------
+
+Herodotus, an ancient greek historian and story teller will
+help you keep a changelog updated.
+
+Oftentimes you don't think about the changelog when you make changes to your
+project. Then, when it's time to cut a release, you've really lost momentum
+of how those changes affect your users. You thought about these things days or
+weeks ago, when you committed them to the repo.
+
+Herodotus can help by going over your git history since a particular release
+and extracting your notes. Obviously, not every commit will contain useful or
+changelog worthy information, so we'll use the commit message format to
+communicate what should go in the changelog. Here are the rules:
+
+* Tag every release, so that it is easy to tell Herodotus how far back to start
+  looking for changes.
+* To start writing notes for use in the changelog, use the following format on 
+  your git commit message:
+
+
+```
+Real commit message subject
+
+Some more info on the commit
+
+Changelog:
+Anything below this line will go on the changelog. Tell your users how to
+upgrade the app, what has been depracated, what will break, etc.
+```
+
+It doesn't need to be exact either. Herodotus will simply extract these 
+comments, format them by adding the author and date, and either append them to 
+your CHANGES file, or print them out to standard out. Once it's there you can 
+tweak it at will before pushing. But the important pieces have been thought out 
+at the time when you wrote the software changes - and was written right on the 
+commit message, and so maintaining the changelog could be easier.
+
+## Installation
+
+Add herodotus to your Gemfile and run bundle.
+
+If you're not using bundler, install via `gem install herodotus`
+
+Then add `require 'herodotus/tasks'` to your `Rakefile`. This will provide the rake tasks with which you interface with herodotus.
+
+## Usage
+
+Herodotus provides a couple of rake tasks: 
+
+```
+rake -T
+rake herodotus:append[since_ref]  # Appends changes to your changelog
+rake herodotus:print[since_ref]   # Prints out the change log from git
+```
+
+You can optionally pass the reference (usually a tag) from which herodotus will start to look for changelog messages in your commits.
+Note that some shells require you to wrap the rake task in double quotes when passing arguments. For example: `rake "herodotus:print[v1]"`

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'bundler/setup'
+require 'herodotus/tasks'
+Bundler::GemHelper.install_tasks
+include Rake::DSL
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task :default => :test

data/herodotus.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "herodotus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "herodotus"
+  s.version     = Herodotus::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Harold Giménez"]
+  s.email       = ["harold.gimenez@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{The father of your project's history}
+  s.description = %q{Reads your git tags and commit messages to keep the changelog updated}
+
+  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 'grit'
+
+  s.add_development_dependency 'redgreen'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'ruby-debug19'
+  s.add_development_dependency 'mocha'
+end

data/lib/herodotus.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'grit'
+
+require 'herodotus/git'
+require 'herodotus/collector'
+require 'herodotus/reporter'

data/lib/herodotus/collector.rb

@@ -0,0 +1,46 @@
+module Herodotus
+  class Collector
+    attr_accessor :git, :since_ref, :changes, :changelog_filename
+    CHANGES_REGEX = /changelog.*?\n(.*)/mi.freeze
+
+    def initialize(base_dir, since_ref = nil)
+      @git                = Git.new(base_dir)
+      @since_ref          = since_ref
+      @changes            = []
+      find_changes
+    end
+
+    Change = Struct.new(:author, :time, :message) do
+      def pretty_author
+        "#{author.name} <#{author.email}>"
+      end
+
+      def log_entry
+        "#{time.to_date}  #{pretty_author}" +
+        "\n#{message}" +
+        "\n\n"
+      end
+    end
+
+    def print
+      reporter.print
+    end
+
+    def append_to_changelog
+      reporter.append_to_changelog
+    end
+
+    def find_changes
+      git.commits.each do |commit|
+        if commit.message =~ CHANGES_REGEX
+          @changes.unshift Change.new(commit.author, commit.authored_date, $1)
+        end
+      end
+    end
+    private :find_changes
+
+    def reporter
+      Herodotus::Reporter.new(self)
+    end
+  end
+end

data/lib/herodotus/git.rb

@@ -0,0 +1,31 @@
+module Herodotus
+  class Git
+    attr_accessor :repo
+    def initialize(base_dir)
+      @base_dir = base_dir
+      @repo     = Grit::Repo.new(guess_repo)
+    end
+
+    def commits(since_ref = nil)
+      if since_ref
+        output = repo.git.rev_list({'pretty' => 'raw'}, "#{since_ref}..")
+        Grit::Commit.list_from_string(repo, output)
+      else
+        Grit::Commit.find_all(@repo, since_ref)
+      end
+    end
+
+    private
+    def guess_repo
+      current_dir = File.expand_path(@base_dir)
+      until current_dir == '/' do
+        maybe_repo = File.expand_path(".git", current_dir)
+        if File.directory?(maybe_repo)
+          return maybe_repo
+        else
+          current_dir = File.expand_path('..', current_dir)
+        end
+      end
+    end
+  end
+end

data/lib/herodotus/reporter.rb

@@ -0,0 +1,25 @@
+module Herodotus
+  class Reporter
+    attr_reader :collector
+    attr_accessor :changelog_filename
+
+    def initialize(collector)
+      @collector          = collector
+      @changelog_filename = 'CHANGES'
+    end
+
+    def print
+      @collector.changes.each do |change|
+        puts change.log_entry
+      end
+    end
+
+    def append_to_changelog
+      File.open(changelog_filename, 'a') do |file|
+        @collector.changes.each do |change|
+          file.puts change.log_entry
+        end
+      end
+    end
+  end
+end

data/lib/herodotus/tasks.rb

@@ -0,0 +1,22 @@
+require 'rake'
+require 'herodotus'
+
+def default_base_dir
+  File.expand_path(File.dirname(__FILE__))
+end
+
+namespace :herodotus do
+  desc 'Prints out the change log from git'
+  task :print, :since_ref do |t, args|
+    base_dir  = ENV['BASE_DIR'] || default_base_dir
+    Herodotus::Collector.new(base_dir, args['since_ref']).
+      print
+  end
+
+  desc 'Appends changes to your changelog'
+  task :append, :since_ref do |t, args|
+    base_dir  = ENV['BASE_DIR'] || default_base_dir
+    Herodotus::Collector.new(base_dir, args['since_ref']).
+      append_to_changelog
+  end
+end

data/lib/herodotus/version.rb

@@ -0,0 +1,6 @@
+module Herodotus
+  MAJOR   = 0
+  MINOR   = 0
+  PATCH   = 1
+  VERSION = "#{MAJOR}.#{MINOR}.#{PATCH}"
+end

data/spec/collector_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Herodotus::Collector do
+  def collector
+    @collector ||= Herodotus::Collector.new('/tmp/herodotus')
+  end
+  before do
+    FileUtils.mkdir_p '/tmp/herodotus'
+    FileUtils.cd '/tmp/herodotus' do
+      `git init`
+      `touch file1`
+      `git add file1`
+      `git commit -m "this is a change"`
+      `touch file2`
+      `git add file2`
+      `git commit -m "Another\nChAnGeLOg:\nBroke everything again. Don't update to this version."`
+      `touch file3`
+      `git add file3`
+      `git commit -m "Another\nchangelog:\nNevermind, everything is fixed now."`
+    end
+  end
+
+  after { FileUtils.rm_rf '/tmp/herodotus' }
+
+  it 'starts off with a default git, changes and a since_ref of nil' do
+    collector.git.wont_be_nil
+    collector.since_ref.must_be_nil
+    collector.changes.wont_be_nil
+  end
+
+  it 'finds commits containing the changelog keyword on the message' do
+    collector.changes.length.must_equal 2
+    collector.changes.first.message.must_equal "Broke everything again. Don't update to this version."
+    collector.changes.last.message.must_equal "Nevermind, everything is fixed now."
+  end
+
+  it 'tells the reporter to print' do
+    reporter = mock('reporter')
+    collector.stubs(:reporter).returns(reporter)
+    reporter.expects(:print).once
+    collector.print
+  end
+
+  it 'tells the reporter to append to changelog' do
+    reporter = mock('reporter')
+    collector.stubs(:reporter).returns(reporter)
+    reporter.expects(:append_to_changelog).once
+    collector.append_to_changelog
+  end
+end

data/spec/git_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'ruby-debug'
+
+describe Herodotus::Git do
+
+  def git
+    @git ||= Herodotus::Git.new('/tmp/herodotus/bacon')
+  end
+
+  before do
+    FileUtils.mkdir_p '/tmp/herodotus'
+    FileUtils.cd '/tmp/herodotus' do
+      `git init`
+      `touch file`
+      `git add file`
+      `git commit -m "Added file"`
+      `git tag -a v1 -m "the MVP"`
+      `touch file2`
+      `git add file2`
+      `git commit -m "Added file2"`
+      FileUtils.mkdir_p 'bacon'
+    end
+  end
+
+  after do
+    FileUtils.rm_rf '/tmp/herodotus'
+  end
+
+  it 'locates the closest git repo' do
+    git.repo.path.must_equal '/tmp/herodotus/.git'
+  end
+
+  it 'pulls out commits from the repo' do
+    git.commits.map(&:message).must_equal ['Added file2', 'Added file']
+  end
+
+  it 'pulls out commits since a given ref' do
+    git.commits('v1').map(&:message).must_equal ['Added file2']
+  end
+end

data/spec/reporter_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Herodotus::Reporter do
+  def collector
+    @collector ||= Herodotus::Collector.new('/tmp/herodotus')
+  end
+
+  before do
+    FileUtils.mkdir_p '/tmp/herodotus'
+    FileUtils.cd '/tmp/herodotus' do
+      `git init`
+      `touch file1`
+      `git add file1`
+      `git commit -m "this is a change"`
+      `touch file2`
+      `git add file2`
+      `git commit -m "Another\nChAnGeLOg:\nBroke everything again. Don't update to this version."`
+      `touch file3`
+      `git add file3`
+      `git commit -m "Another\nchangelog:\nNevermind, everything is fixed now."`
+    end
+  end
+
+  after { FileUtils.rm_rf '/tmp/herodotus' }
+
+  it 'takes a Collector instance' do
+    reporter = Herodotus::Reporter.new(collector)
+    reporter.collector.must_equal collector
+  end
+
+  it 'has a default changelog filename of CHANGES' do
+    reporter = Herodotus::Reporter.new(collector)
+    reporter.changelog_filename.must_equal 'CHANGES'
+  end
+
+  it 'appends changelog entries to the changelog file' do
+    reporter = Herodotus::Reporter.new(collector)
+    reporter.changelog_filename = File.expand_path('tmp/test_changes')
+    reporter.append_to_changelog
+    changelog = IO.read(reporter.changelog_filename)
+    changelog.must_include "Broke everything again. Don't update to this version."
+    changelog.must_include "Nevermind, everything is fixed now."
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'ruby-debug'
+require 'mocha'
+
+require File.expand_path(File.join('lib', 'herodotus'))

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: herodotus
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Harold Gim\xC3\xA9nez"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grit
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Reads your git tags and commit messages to keep the changelog updated
+email: 
+- harold.gimenez@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- CHANGES
+- Gemfile
+- README.md
+- Rakefile
+- herodotus.gemspec
+- lib/herodotus.rb
+- lib/herodotus/collector.rb
+- lib/herodotus/git.rb
+- lib/herodotus/reporter.rb
+- lib/herodotus/tasks.rb
+- lib/herodotus/version.rb
+- spec/collector_spec.rb
+- spec/git_spec.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2072332935919534749
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -2072332935919534749
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: The father of your project's history
+test_files: 
+- spec/collector_spec.rb
+- spec/git_spec.rb
+- spec/reporter_spec.rb
+- spec/spec_helper.rb