gitmine 0.1.1 → 0.1.2

data/README.rdoc

@@ -7,13 +7,17 @@ Gitmine displays the last 10 commits of your repo and their associated redmine t
 
 == Setup
 Put the config file '.gitmine.yml' at the root of your project. Here is a sample file:
-<pre>
-host:     'https://redmine.yourcompany.com
-api_key:  'your_api_key'
-</pre>
+
+    host:     'https://redmine.yourcompany.com
+    # Api key is required for private projects only.
+    api_key:  'your_api_key'
 
 Then run gitmine at the root of your project.
 
+== Note on Issues
+
+* Issues are managed by redmine on http://redmine-gitmine.heroku.com/projects/gitmine
+* Thanks for reporting issues on http://redmine-gitmine.heroku.com/projects/gitmine/issues/new
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/gitmine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gitmine}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philippe Creux"]
-  s.date = %q{2010-07-26}
+  s.date = %q{2010-07-27}
   s.default_executable = %q{gitmine}
   s.description = %q{Git log with status of associated redmine tickets}
   s.email = %q{pcreux@gmail.com}
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
      "gitmine.gemspec",
      "lib/gitmine.rb",
      "spec/commit_msg_to_issue_id_spec.rb",
+     "spec/commit_spec.rb",
      "spec/config.yml",
      "spec/gitmine_spec.rb",
      "spec/issue_spec.rb",
@@ -44,6 +45,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Git log with status of associated redmine tickets}
   s.test_files = [
     "spec/commit_msg_to_issue_id_spec.rb",
+     "spec/commit_spec.rb",
      "spec/gitmine_spec.rb",
      "spec/issue_spec.rb",
      "spec/spec_helper.rb"

data/lib/gitmine.rb

@@ -5,25 +5,63 @@ require 'yaml'
 require 'HTTParty'
 
 class Gitmine
+  # CLI interface
   def self.run
     gm = Gitmine.new
     gm.commits.each do |commit|
-      issue = Issue.get_for_commit(commit.message)
-      status = issue ? issue.status : 'N/A'
+      status = commit.issue ? commit.issue.status : 'N/A'
       puts "#{commit.id[0..6]} #{status.ljust(12)} #{commit.committer.name.ljust(15)} #{commit.message[0..50].gsub("\n", '')}"
     end
   end
 
   def initialize
     @repo = Grit::Repo.new(ENV['PWD'])
+    @branch = File.read('./.git/HEAD').match(/^ref: refs\/heads\/(.+)/)[1]
   end
 
   def commits
-    @repo.commits
+    @repo.commits(@branch).map do |c|
+      Commit.new(c)
+    end
+  end
+end
+
+
+class Commit 
+  attr_reader :grit_commit
+
+  # Initialize a new Commit objects that delegates methods to the Grit::Commit object passed in
+  def initialize(grit_commit)
+    @grit_commit = grit_commit
+  end
+
+  # Issue associated with this commit
+  # Return nil if teir is no associated issue
+  def issue
+    @issue ||= Issue.get_for_commit(message)
+  end
+
+  # Delegate #id to Grit::Commit
+  def id
+    @grit_commit.id
   end
+
+  protected
+  # Delegate methods to Grit::Commit
+  def method_missing(m, *args, &block)  
+    return @grit_commit.send(m, args, block) if @grit_commit.respond_to? m
+    super
+  end  
 end
 
 module CommitMsgToIssueId
+  # Extract the issue_id from a commit message.
+  # Examples:
+  #   CommitMsgToIssueId.parse("Message for Issue #123.")
+  #     => 123
+  #   CommitMsgToIssueId.parse("#123.")
+  #     => nil
+  #
   def self.parse(msg)
     match = msg.match(/Issue #(\d+)/)
     match ? match[1] : nil
@@ -31,23 +69,29 @@ module CommitMsgToIssueId
 end
 
 class Issue
-  attr_accessor :id, :subject, :status
+  CONFIG_FILE = './.gitmine.yml'
+
+  attr_reader :id, :subject, :status
 
+  # Parse the commit_message and get the associated issue if any.
   def self.get_for_commit(commit_message)
     issue_id = CommitMsgToIssueId.parse(commit_message)
     issue_id ? Issue.get(issue_id) : nil
   end
 
+  # Get the issue from redmine
   def self.get(issue_id)
     Issue.new.tap { |issue|
       issue.build_via_issue_id(issue_id)
     }
   end
 
+  # Config from .gitmine.yml
   def config
     @config ||= YAML.load_file(CONFIG_FILE)
   end
 
+  # Get attributes from redmine and set them all
   def build_via_issue_id(issue_id)
     @id = issue_id
     data = get(issue_id).parsed_response['issue']
@@ -57,16 +101,13 @@ class Issue
 
   protected
 
+  # Url to redmine/issues
   def url(id)
     "#{config['host']}/issues/#{id}.xml?key=#{config['api_key']}"
   end
 
+  # http_get the issue using HTTParty
   def get(issue_id)
     HTTParty.get(url(issue_id))
   end
-
-  CONFIG_FILE = './.gitmine.yml'
-
-  def issues_for_commit(commit_id)
-  end
 end

data/spec/commit_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Commit do
+  let(:grit_commit) { Grit::Commit.create(nil, {:message => "Commit message"}) }
+  let(:commit) { Commit.new(grit_commit) }
+  let(:issue)  { Issue.new }
+
+  describe "#new" do
+    it "should take a grit_commit object and store it" do
+      commit.grit_commit.should == grit_commit
+    end
+  end
+
+  it "should delegate methods to the grit_commit object" do
+    commit.message.should == grit_commit.message
+  end
+
+  it "should delegate #id to the grit_commit object" do
+    commit.id.should == grit_commit.id
+  end
+
+  it "should respond_to :issue" do
+    commit.should respond_to :issue
+  end
+
+  it "should return issue via #Issue.get_for_commit" do
+    Issue.should_receive(:get_for_commit).with("Commit message") { issue }
+    commit.issue.should == issue
+  end
+
+  it "should memoize issue" do
+    Issue.should_receive(:get_for_commit).with("Commit message") { issue }.once
+    commit.issue.should == issue
+    commit.issue.should == issue
+  end
+end

data/spec/gitmine_spec.rb

@@ -1,6 +1,10 @@
 require 'spec_helper'
 
 describe Gitmine do
+  before do
+    File.stub!(:read) { "ref: refs/heads/wip" }
+  end
+
   let(:gitmine) { Gitmine.new }
 
   let(:commit_1) do
@@ -11,25 +15,33 @@ describe Gitmine do
     )
   end
 
+  let(:repo) do
+    mock(Grit::Repo, :commits => [commit_1])
+  end
+
   before do
-    Grit::Repo.stub!(:new) { 
-      mock(Grit::Repo, :commits => [commit_1])
-    }
+    Grit::Repo.stub!(:new) { repo }
   end
      
   describe "#commits" do
-    it "should return the last 10 commit messages" do
-      gitmine.commits.should == [commit_1]
+    it "should return Gitmine commits" do
+      gitmine.commits.first.should be_a Commit
+    end
+    it "should return commits for the current branch" do
+      repo.should_receive(:commits).with('wip')
+      gitmine.commits
     end
   end
 
   describe "#initialize" do
-    context "when not a git repo" do
-      it "should raise an exception"
+    let(:grit_repo) { mock(:checkout => true)}
+    before do
+      Grit::Repo.stub!(:new) { grit_repo }
     end
 
-    context "when git repo" do
-      it "should not raise any exception"
+    it "should check out to the current branch" do
+      Grit::Repo.should_receive(:new).with(ENV['PWD']) { grit_repo }
+      Gitmine.new
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 #ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
 
+require "rubygems"
 require "bundler"
 Bundler.load
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Philippe Creux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-26 00:00:00 -07:00
+date: 2010-07-27 00:00:00 -07:00
 default_executable: gitmine
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -78,6 +78,7 @@ files:
 - gitmine.gemspec
 - lib/gitmine.rb
 - spec/commit_msg_to_issue_id_spec.rb
+- spec/commit_spec.rb
 - spec/config.yml
 - spec/gitmine_spec.rb
 - spec/issue_spec.rb
@@ -114,6 +115,7 @@ specification_version: 3
 summary: Git log with status of associated redmine tickets
 test_files: 
 - spec/commit_msg_to_issue_id_spec.rb
+- spec/commit_spec.rb
 - spec/gitmine_spec.rb
 - spec/issue_spec.rb
 - spec/spec_helper.rb