gitmine 0.1.3 → 0.1.4.pre

data/.gitignore

@@ -19,3 +19,4 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
+.gitmine.yml.mine

data/.gitmine.yml

@@ -1,2 +1,2 @@
 host:     'http://redmine-gitmine.heroku.com'
-#api_key: '' # No need for api_key since the redmine project is public.
+github:   'pcreux/gitmine'

data/Gemfile

@@ -1,5 +1,5 @@
-gem 'httparty'
-gem 'grit'
+gem 'httparty', '0.6.1'
+gem 'grit', '2.0.0'
 
 # Test env
-gem 'rspec',        '2.0.0.beta.17'
+gem 'rspec',        '2.0.0'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  specs:
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    grit (2.0.0)
+      diff-lcs (>= 1.1.2)
+      mime-types (>= 1.15)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    mime-types (1.16)
+    rspec (2.0.0.beta.17)
+      rspec-core (= 2.0.0.beta.17)
+      rspec-expectations (= 2.0.0.beta.17)
+      rspec-mocks (= 2.0.0.beta.17)
+    rspec-core (2.0.0.beta.17)
+    rspec-expectations (2.0.0.beta.17)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.17)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  grit
+  httparty
+  rspec (= 2.0.0.beta.17)

data/README.rdoc

@@ -14,7 +14,21 @@ Put the config file '.gitmine.yml' at the root of your project. Here is a sample
   # Api key is required for private projects only.
   api_key:  'your_api_key'
 
-Then run gitmine at the root of your project.
+== Usage
+
+* Display the latest 10 commits and there ticket status:
+
+  $> gitmine
+  8497d68 In Progress  Philippe Creux  Add branch command. Need refactoring.Issue #10
+  b0132d2 Closed       Philippe Creux  Gitmine now works on case sensitive FS. Issue #8
+  b77fb0c N/A          Philippe Creux  Add Greg Bell as an awesome contributor.
+  9f3e464 N/A          Greg Bell       Moved CommitMsgToIssueId module into the Gitmine::I
+
+* Create a new remote branch + a tracking branch + add a note to the associated ticket:
+
+  $> gitmine branch 10-add-branch
+
+See here: http://redmine-gitmine.heroku.com/issues/10#note-1
 
 == Note on Issues
 

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.executables         = ["gitmine"]
     gem.add_dependency "httparty"
     gem.add_dependency "grit"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", "2.0.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4.pre

data/bin/gitmine

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 require File.dirname(__FILE__) + '/../lib/gitmine'
 
-Gitmine.run
+Gitmine::CLI.run

data/gitmine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gitmine}
-  s.version = "0.1.3"
+  s.version = "0.1.4.pre"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Philippe Creux"]
-  s.date = %q{2010-08-11}
+  s.date = %q{2010-11-11}
   s.default_executable = %q{gitmine}
   s.description = %q{Git log with status of associated redmine tickets}
   s.email = %q{pcreux@gmail.com}
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      ".gitignore",
      ".gitmine.yml",
      "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -31,6 +32,10 @@ Gem::Specification.new do |s|
      "bin/gitmine",
      "gitmine.gemspec",
      "lib/gitmine.rb",
+     "lib/gitmine/cli.rb",
+     "lib/gitmine/commit.rb",
+     "lib/gitmine/gitmine.rb",
+     "lib/gitmine/issue.rb",
      "spec/commit_msg_to_issue_id_spec.rb",
      "spec/commit_spec.rb",
      "spec/config.yml",
@@ -41,33 +46,33 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/pcreux/gitmine}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   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/gitmine_spec.rb",
+     "spec/spec_helper.rb",
      "spec/issue_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/commit_msg_to_issue_id_spec.rb",
+     "spec/commit_spec.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, [">= 0"])
       s.add_runtime_dependency(%q<grit>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<rspec>, ["= 2.0.0"])
     else
       s.add_dependency(%q<httparty>, [">= 0"])
       s.add_dependency(%q<grit>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rspec>, ["= 2.0.0"])
     end
   else
     s.add_dependency(%q<httparty>, [">= 0"])
     s.add_dependency(%q<grit>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rspec>, ["= 2.0.0"])
   end
 end
 

data/lib/gitmine/cli.rb

@@ -0,0 +1,26 @@
+module Gitmine
+  class CLI
+    def self.run
+      case ARGV[0]
+      when nil
+        list
+      when "branch"
+        branch
+      else
+        puts <<-EOS
+  Usage:
+  gitmine: show the 10 latest commits and their associated issue status
+  gitmine branch [BRANCH_NAME]: create a new branch
+  EOS
+      end
+    end
+
+    def self.list
+      Gitmine.list
+    end
+
+    def self.branch
+      Gitmine.branch(ARGV[1])
+    end
+  end
+end

data/lib/gitmine/commit.rb

@@ -0,0 +1,28 @@
+module Gitmine
+  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 their 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
+end

data/lib/gitmine/gitmine.rb

@@ -0,0 +1,51 @@
+module Gitmine
+  class Gitmine
+    def self.list
+      gm = Gitmine.new
+      gm.commits.each do |commit|
+        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(@branch).map do |c|
+        Commit.new(c)
+      end
+    end
+
+
+    def self.branch(branch_name)
+      issue_id = branch_name[/^\d+/]
+      original_branch = File.read('./.git/HEAD').match(/^ref: refs\/heads\/(.+)/)[1]
+      config = Issue.config
+
+      raise "Invalid branch name. It should start with the issue number" unless issue_id
+
+      puts "Creating the remote branch #{branch_name}"
+
+      run_cmd("git push origin origin:refs/heads/#{branch_name}")
+      run_cmd("git checkout --track -b #{branch_name} origin/#{branch_name}")
+
+
+      puts "Adding a note to the Issue ##{issue_id}"
+      note = "Branch *#{branch_name}* created from #{original_branch}"
+      if config['github']
+        note << %{ - "See on Github":https://github.com/#{config['github']}/tree/#{branch_name}}
+        note << %{ - "Compare on Github":https://github.com/#{config['github']}/compare/#{original_branch}...#{branch_name}}
+      end
+
+      Issue.find(issue_id).add_note(note)
+    end
+
+    def self.run_cmd(cmd)
+      puts cmd
+      system cmd
+    end
+  end
+end

data/lib/gitmine/issue.rb

@@ -0,0 +1,68 @@
+module Gitmine
+  class Issue
+    CONFIG_FILE = './.gitmine.yml'
+
+    attr_reader :id, :subject, :status
+    
+    # Config from .gitmine.yml
+    def self.config
+      @@config ||= YAML.load_file(CONFIG_FILE)
+    end
+
+    # 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
+
+    # 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.find(issue_id) : nil
+    end
+
+    # Get the issue from redmine
+    def self.find(issue_id)
+      Issue.new.tap { |issue|
+        issue.build_via_issue_id(issue_id)
+      }
+    end
+
+    # Get attributes from redmine and set them all
+    def build_via_issue_id(issue_id)
+      @id = issue_id
+      data = http_get(issue_id).parsed_response['issue']
+      @subject = data['subject']
+      @status = data['status']['name']
+    end
+
+    # Add a note to the Issue
+    def add_note(note)
+      p self.class.put(url(self.id), 
+                     :query => {:notes => note}, 
+                     :body => "") # nginx reject requests without body
+    end
+
+    include HTTParty
+    base_uri "#{config['host']}/issues/"
+    basic_auth config['api_key'], '' # username is api_key, password is empty
+    headers 'Content-type' => 'text/xml' # by-pass rails authenticity token mechanism
+
+    protected
+
+    # Url to redmine/issues
+    def url(id)
+      "/#{id}.xml"
+    end
+
+    def http_get(issue_id)
+      self.class.get(url(issue_id))
+    end
+  end
+end

data/lib/gitmine.rb

@@ -4,109 +4,6 @@ require 'grit'
 require 'yaml'
 require 'httparty'
 
-class Gitmine
-  # CLI interface
-  def self.run
-    gm = Gitmine.new
-    gm.commits.each do |commit|
-      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(@branch).map do |c|
-      Commit.new(c)
-    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 their 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
-
-  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
-
-    # 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
-
-    # 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']
-      @subject = data['subject']
-      @status = data['status']['name']
-    end
-
-    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
-  end
-
+%w(gitmine issue commit cli).each do |filename|
+  require File.dirname(__FILE__) + "/gitmine/#{filename}.rb"
 end

data/spec/commit_spec.rb

@@ -30,7 +30,8 @@ describe Gitmine::Commit do
 
   it "should memoize issue" do
     Gitmine::Issue.should_receive(:get_for_commit).with("Commit message") { issue }.once
-    commit.issue.should == issue
-    commit.issue.should == issue
+    2.times do
+      commit.issue.should == issue
+    end
   end
 end

data/spec/gitmine_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe Gitmine do
+describe Gitmine::Gitmine do
   before do
     File.stub!(:read) { "ref: refs/heads/wip" }
   end
 
-  let(:gitmine) { Gitmine.new }
+  let(:gitmine) { Gitmine::Gitmine.new }
 
   let(:commit_1) do
     mock(
@@ -41,7 +41,7 @@ describe Gitmine do
 
     it "should check out to the current branch" do
       Grit::Repo.should_receive(:new).with(ENV['PWD']) { grit_repo }
-      Gitmine.new
+      Gitmine::Gitmine.new
     end
   end
 end

data/spec/issue_spec.rb

@@ -10,18 +10,10 @@ describe Gitmine::Issue do
 
   describe "#config" do
     it "should load the config from config.yml" do
-      issue.config.should == {"host"=>"http://localhost:3000", "api_key"=>"api_key"}
+      Gitmine::Issue.config.should == {"host"=>"http://redmine-gitmine.heroku.com", "github" => "pcreux/gitmine"}
     end
   end
 
-  describe "#url (protected)" do
-    it "should build up URL based on the config" do
-      issue.send(:url, '123').should == 'http://localhost:3000/issues/123.xml?key=api_key'
-    end
-
-  end
-
-
   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'
@@ -30,19 +22,19 @@ describe Gitmine::Issue do
     end
   end
 
-  describe "#get (class method)" do
+  describe "#find (class method)" do
     it "should build_via_issue_id" do
       issue = Gitmine::Issue.new
       Gitmine::Issue.should_receive(:new) { issue }
       issue.should_receive(:build_via_issue_id)
-      Gitmine::Issue.get(123)
+      Gitmine::Issue.find(123)
     end
   end
 
   describe "#build_via_issue_id" do
     before do
       @httparty = mock(:http_party_response, :parsed_response => {'issue' => { 'subject' => 'A subject', 'status' => {'name' => 'Completed'}}})
-      issue.stub!(:get) { @httparty }
+      issue.stub!(:http_get) { @httparty }
     end
 
     it "should get issue data and load attributes" do
@@ -58,12 +50,11 @@ describe Gitmine::Issue do
     end
   end
 
-  describe "#get (protected instance method)" do
-    it "should create a new issue via HTTParty" do
-      issue.stub!(:url) { 'the_url' }
-      HTTParty.should_receive(:get).with('the_url')
-      issue.send(:get, 123)
+  describe "#add_note" do
+    it "should PUT a note" do
+      issue.stub!(:id) { 1 }
+      issue.class.should_receive(:put).with('/1.xml', :query => {:notes => "Hello"}, :body => "")
+      issue.add_note("Hello")
     end
   end
-
 end

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: gitmine
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 961915996
+  prerelease: true
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  - pre
+  version: 0.1.4.pre
 platform: ruby
 authors: 
 - Philippe Creux
@@ -14,16 +16,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-11 00:00:00 -07:00
+date: 2010-11-11 00:00:00 -08:00
 default_executable: gitmine
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -33,9 +37,11 @@ dependencies:
   name: grit
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -45,14 +51,16 @@ dependencies:
   name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
+        - 0
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id003
 description: Git log with status of associated redmine tickets
@@ -69,6 +77,7 @@ files:
 - .gitignore
 - .gitmine.yml
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -77,6 +86,10 @@ files:
 - bin/gitmine
 - gitmine.gemspec
 - lib/gitmine.rb
+- lib/gitmine/cli.rb
+- lib/gitmine/commit.rb
+- lib/gitmine/gitmine.rb
+- lib/gitmine/issue.rb
 - spec/commit_msg_to_issue_id_spec.rb
 - spec/commit_spec.rb
 - spec/config.yml
@@ -93,29 +106,35 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 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
+- spec/issue_spec.rb
+- spec/commit_msg_to_issue_id_spec.rb
+- spec/commit_spec.rb