herodotus 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,4 @@
 Gemfile.lock
 pkg/*
 tmp/*
+!.keep

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+  1.9.2

data/CHANGES

@@ -1,5 +1,16 @@
-v0.0.1 [2011-07-28]:
+v0.0.2 [2011-07-29]
+-------------------
+2011-07-29  Harold Giménez <hgimenez@thoughtbot.com>
+Introduces ability to configure Herodotus. Here's an example on how to
+configure it:
 
+    Herodotus::Configuration.run do |config|
+      config.base_path          = '/path/to/project/root'
+      config.changelog_filename = 'CHANGELOG.md'
+    end
+
+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

data/README.md

@@ -1,6 +1,8 @@
 Herodotus
 ---------
 
+[![Build Status](http://travis-ci.org/hgimenez/herodotus.png)](http://travis-ci.org/hgimenez/herodotus)
+
 Herodotus, an ancient greek historian and story teller will
 help you keep a changelog updated.
 
@@ -16,7 +18,7 @@ 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 
+* To start writing notes for use in the changelog, use the following format on
   your git commit message:
 
 
@@ -30,11 +32,11 @@ 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 
+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
@@ -47,7 +49,7 @@ Then add `require 'herodotus/tasks'` to your `Rakefile`. This will provide the r
 
 ## Usage
 
-Herodotus provides a couple of rake tasks: 
+Herodotus provides a couple of rake tasks:
 
 ```
 rake -T
@@ -57,3 +59,14 @@ 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]"`
+
+## Configuring
+
+You can configure Herodotus. Drop this somewhere sensible like an initializer or anywhere where it loads prior to running the rake tasks:
+
+```ruby
+Herodotus::Configuration.run do |config|
+  config.base_path          = '/path/to/project/root'
+  config.changelog_filename = 'CHANGELOG.md'
+end
+```

data/lib/herodotus.rb

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

data/lib/herodotus/collector.rb

@@ -3,8 +3,8 @@ module Herodotus
     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)
+    def initialize(base_path, since_ref = nil)
+      @git                = Git.new(base_path)
       @since_ref          = since_ref
       @changes            = []
       find_changes

data/lib/herodotus/configuration.rb

@@ -0,0 +1,22 @@
+module Herodotus
+  class Configuration
+    attr_accessor :base_path, :changelog_filename
+
+    def initialize
+      @changelog_filename = 'CHANGES'
+    end
+
+    class << self
+      attr_accessor :config
+    end
+    @config = Configuration.new
+
+    def self.run
+      yield config
+    end
+
+    def self.reset!
+      self.config = Configuration.new
+    end
+  end
+end

data/lib/herodotus/git.rb

@@ -1,8 +1,8 @@
 module Herodotus
   class Git
-    attr_accessor :repo
-    def initialize(base_dir)
-      @base_dir = base_dir
+    attr_accessor :repo, :base_path
+    def initialize(base_path = nil)
+      @base_path = base_path || Configuration.config.base_path
       @repo     = Grit::Repo.new(guess_repo)
     end
 
@@ -17,7 +17,7 @@ module Herodotus
 
     private
     def guess_repo
-      current_dir = File.expand_path(@base_dir)
+      current_dir = File.expand_path(@base_path)
       until current_dir == '/' do
         maybe_repo = File.expand_path(".git", current_dir)
         if File.directory?(maybe_repo)

data/lib/herodotus/reporter.rb

@@ -5,7 +5,7 @@ module Herodotus
 
     def initialize(collector)
       @collector          = collector
-      @changelog_filename = 'CHANGES'
+      @changelog_filename = Configuration.config.changelog_filename
     end
 
     def print

data/lib/herodotus/tasks.rb

@@ -1,22 +1,26 @@
 require 'rake'
 require 'herodotus'
 
-def default_base_dir
-  File.expand_path(File.dirname(__FILE__))
-end
-
 namespace :herodotus do
+  def default_base_path
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  def configured_base_path
+    Herodotus::Configuration.config.base_path
+  end
+
   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']).
+    base_path  = ENV['base_path'] || configured_base_path || default_base_path
+    Herodotus::Collector.new(base_path, 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']).
+    base_path  = ENV['base_path'] || configured_base_path || default_base_path
+    Herodotus::Collector.new(base_path, args['since_ref']).
       append_to_changelog
   end
 end

data/lib/herodotus/version.rb

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

data/spec/collector_spec.rb

@@ -4,23 +4,6 @@ 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
@@ -28,12 +11,6 @@ describe Herodotus::Collector do
     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)
@@ -47,4 +24,31 @@ describe Herodotus::Collector do
     reporter.expects(:append_to_changelog).once
     collector.append_to_changelog
   end
+
+  describe 'with some commits' do
+    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 '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
+  end
+
 end

data/spec/configuration_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+
+describe Herodotus::Configuration do
+
+  before { Herodotus::Configuration.reset! }
+
+  %w(base_path changelog_filename).each do |configurable|
+    it "allows you to configure a #{configurable}" do
+      Herodotus::Configuration.run do |config|
+        config.must_be_kind_of Herodotus::Configuration
+        config.send("#{configurable}=", 'foo')
+      end
+
+      Herodotus::Configuration.config.send(configurable).must_equal 'foo'
+    end
+
+  end
+
+  it 'has a default changelog filename of CHANGES' do
+    Herodotus::Configuration.config.changelog_filename.must_equal 'CHANGES'
+  end
+end

data/spec/git_spec.rb

@@ -1,5 +1,4 @@
 require File.expand_path('spec_helper', File.dirname(__FILE__))
-require 'ruby-debug'
 
 describe Herodotus::Git do
 
@@ -7,34 +6,44 @@ describe Herodotus::Git do
     @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'
+  it 'uses the configured base_path if none is provided' do
+    Herodotus::Configuration.run do |config|
+      config.base_path = 'foo'
     end
-  end
 
-  after do
-    FileUtils.rm_rf '/tmp/herodotus'
+    Herodotus::Git.new.base_path.must_equal 'foo'
   end
 
-  it 'locates the closest git repo' do
-    git.repo.path.must_equal '/tmp/herodotus/.git'
-  end
+  describe 'with some commits' do
+    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
 
-  it 'pulls out commits from the repo' do
-    git.commits.map(&:message).must_equal ['Added file2', 'Added file']
-  end
+    after do
+      FileUtils.rm_rf '/tmp/herodotus'
+    end
 
-  it 'pulls out commits since a given ref' do
-    git.commits('v1').map(&:message).must_equal ['Added file2']
+    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
 end

data/spec/reporter_spec.rb

@@ -28,11 +28,6 @@ describe Herodotus::Reporter do
     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')
@@ -40,5 +35,15 @@ describe Herodotus::Reporter do
     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."
+    FileUtils.rm_rf 'tmp/test_changes'
+  end
+
+  it 'uses the configured changelog_filename' do
+    Herodotus::Configuration.run do |config|
+      config.changelog_filename = 'los cambios van aqui!'
+    end
+
+    reporter = Herodotus::Reporter.new('base dir')
+    reporter.changelog_filename.must_equal 'los cambios van aqui!'
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: herodotus
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - "Harold Gim\xC3\xA9nez"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-28 00:00:00 -04:00
+date: 2011-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,6 +80,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rvmrc
+- .travis.yml
 - CHANGES
 - Gemfile
 - README.md
@@ -87,14 +88,17 @@ files:
 - herodotus.gemspec
 - lib/herodotus.rb
 - lib/herodotus/collector.rb
+- lib/herodotus/configuration.rb
 - lib/herodotus/git.rb
 - lib/herodotus/reporter.rb
 - lib/herodotus/tasks.rb
 - lib/herodotus/version.rb
 - spec/collector_spec.rb
+- spec/configuration_spec.rb
 - spec/git_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb
+- tmp/.keep
 has_rdoc: true
 homepage: ""
 licenses: []
@@ -109,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2072332935919534749
+      hash: 4363217657516253176
       segments: 
       - 0
       version: "0"
@@ -118,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2072332935919534749
+      hash: 4363217657516253176
       segments: 
       - 0
       version: "0"
@@ -131,6 +135,7 @@ specification_version: 3
 summary: The father of your project's history
 test_files: 
 - spec/collector_spec.rb
+- spec/configuration_spec.rb
 - spec/git_spec.rb
 - spec/reporter_spec.rb
 - spec/spec_helper.rb