gitmine 0.1.2 → 0.1.3

data/README.rdoc

@@ -3,14 +3,16 @@
 Gitmine displays the last 10 commits of your repo and their associated redmine ticket status.
 
 == Install
+
   gem install gitmine
 
 == Setup
+
 Put the config file '.gitmine.yml' at the root of your project. Here is a sample file:
 
-    host:     'https://redmine.yourcompany.com
-    # Api key is required for private projects only.
-    api_key:  'your_api_key'
+  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.
 
@@ -19,6 +21,11 @@ Then run gitmine at the root of your project.
 * 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
 
+== Contributors
+
+* Philippe Creux  http://github.com/pcreux
+* Greg Bell       http://github.com/gregbell
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/gitmine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gitmine}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philippe Creux"]
-  s.date = %q{2010-07-27}
+  s.date = %q{2010-08-11}
   s.default_executable = %q{gitmine}
   s.description = %q{Git log with status of associated redmine tickets}
   s.email = %q{pcreux@gmail.com}

data/lib/gitmine.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 
 require 'grit'
 require 'yaml'
-require 'HTTParty'
+require 'httparty'
 
 class Gitmine
   # CLI interface
@@ -24,90 +24,89 @@ class Gitmine
       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
+  class Commit 
+    attr_reader :grit_commit
 
-  # Issue associated with this commit
-  # Return nil if teir is no associated issue
-  def issue
-    @issue ||= Issue.get_for_commit(message)
-  end
+    # Initialize a new Commit objects that delegates methods to the Grit::Commit object passed in
+    def initialize(grit_commit)
+      @grit_commit = grit_commit
+    end
 
-  # Delegate #id to Grit::Commit
-  def id
-    @grit_commit.id
-  end
+    # Issue associated with this commit
+    # Return nil if their is no associated issue
+    def issue
+      @issue ||= Issue.get_for_commit(message)
+    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
+    # Delegate #id to Grit::Commit
+    def id
+      @grit_commit.id
+    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
+    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
-end
 
-class Issue
-  CONFIG_FILE = './.gitmine.yml'
+  class Issue
+    CONFIG_FILE = './.gitmine.yml'
+
+    attr_reader :id, :subject, :status
+
+    # Extract the issue_id from a commit message.
+    # Examples:
+    #   CommitMsgToIssueId.parse("Message for Issue #123.")
+    #     => 123
+    #   CommitMsgToIssueId.parse("#123.")
+    #     => nil
+    #
+    def self.parse_for_issue_id(msg)
+      match = msg.match(/Issue #(\d+)/)
+      match ? match[1] : nil
+    end
 
-  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 = parse_for_issue_id(commit_message)
+      issue_id ? Issue.get(issue_id) : nil
+    end
 
-  # 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
 
-  # 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
 
-  # 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']
+      @subject = data['subject']
+      @status = data['status']['name']
+    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']
-    @subject = data['subject']
-    @status = data['status']['name']
-  end
+    protected
 
-  protected
+    # Url to redmine/issues
+    def url(id)
+      "#{config['host']}/issues/#{id}.xml?key=#{config['api_key']}"
+    end
 
-  # Url to redmine/issues
-  def url(id)
-    "#{config['host']}/issues/#{id}.xml?key=#{config['api_key']}"
+    # http_get the issue using HTTParty
+    def get(issue_id)
+      HTTParty.get(url(issue_id))
+    end
   end
 
-  # http_get the issue using HTTParty
-  def get(issue_id)
-    HTTParty.get(url(issue_id))
-  end
 end

data/spec/commit_msg_to_issue_id_spec.rb

@@ -8,7 +8,7 @@ describe "CommitMsgToIssueId" do
       ['Add method #yey Commit message Issue #123.', '123']
     ].each do |msg, id|
       it "should return #{id} for '#{msg}'" do
-        CommitMsgToIssueId.parse(msg).should == id
+        Gitmine::Issue.parse_for_issue_id(msg).should == id
       end
     end
   end

data/spec/commit_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Commit do
+describe Gitmine::Commit do
   let(:grit_commit) { Grit::Commit.create(nil, {:message => "Commit message"}) }
-  let(:commit) { Commit.new(grit_commit) }
-  let(:issue)  { Issue.new }
+  let(:commit) { Gitmine::Commit.new(grit_commit) }
+  let(:issue)  { Gitmine::Issue.new }
 
   describe "#new" do
     it "should take a grit_commit object and store it" do
@@ -24,12 +24,12 @@ describe Commit do
   end
 
   it "should return issue via #Issue.get_for_commit" do
-    Issue.should_receive(:get_for_commit).with("Commit message") { issue }
+    Gitmine::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
+    Gitmine::Issue.should_receive(:get_for_commit).with("Commit message") { issue }.once
     commit.issue.should == issue
     commit.issue.should == issue
   end

data/spec/gitmine_spec.rb

@@ -25,7 +25,7 @@ describe Gitmine do
      
   describe "#commits" do
     it "should return Gitmine commits" do
-      gitmine.commits.first.should be_a Commit
+      gitmine.commits.first.should be_a Gitmine::Commit
     end
     it "should return commits for the current branch" do
       repo.should_receive(:commits).with('wip')

data/spec/issue_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-describe Issue do
-  let(:issue) { Issue.new }
+describe Gitmine::Issue do
+  let(:issue) { Gitmine::Issue.new }
   [:id, :subject, :status].each do |a|
     it "should have an #{a}" do
       issue.should respond_to a
@@ -25,17 +25,17 @@ describe Issue do
   describe "#get_for_commit" do
     it "should parse the commit message to find a commit_id and call #get" do
       commit_msg = 'A commit msg Issue #123'
-      CommitMsgToIssueId.should_receive(:parse).with(commit_msg)
-      Issue.get_for_commit(commit_msg)
+      Gitmine::Issue.should_receive(:parse_for_issue_id).with(commit_msg)
+      Gitmine::Issue.get_for_commit(commit_msg)
     end
   end
 
   describe "#get (class method)" do
     it "should build_via_issue_id" do
-      issue = Issue.new
-      Issue.should_receive(:new) { issue }
+      issue = Gitmine::Issue.new
+      Gitmine::Issue.should_receive(:new) { issue }
       issue.should_receive(:build_via_issue_id)
-      Issue.get(123)
+      Gitmine::Issue.get(123)
     end
   end
 

data/spec/spec_helper.rb

@@ -15,4 +15,4 @@ Rspec.configure do |config|
   config.mock_with :rspec
 end
 
-Issue::CONFIG_FILE = File.join(File.dirname(__FILE__), 'config.yml')
+Gitmine::Issue::CONFIG_FILE = File.join(File.dirname(__FILE__), 'config.yml')

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Philippe Creux
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-27 00:00:00 -07:00
+date: 2010-08-11 00:00:00 -07:00
 default_executable: gitmine
 dependencies: 
 - !ruby/object:Gem::Dependency