gitjira 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d277b83f7b4c7e19dd4c37981ed4bf2dd17ba9b4
-  data.tar.gz: 6eaa7a36b90a0326dfb782c3142d8dc6d6366d48
+  metadata.gz: 4352b0c24da71ed1886cce9a72e0a81a54b401e9
+  data.tar.gz: 100b0d5bdeb9bb956bc7d2b99d68048d27a2a00a
 SHA512:
-  metadata.gz: 0dbc4c743ff1cc5823340739f9af45bbfc971441adc232c64124d8bba8fc7323c25663dd08ac129770c6dc52a02d3d5d49c5faf563fd60a2da5305706c00896b
-  data.tar.gz: 1699a939ba23a9826ea6c97a4d3706dc38abf756984b6e0f4fa0993232e23ceb4733921c86eba54a6d02b8753417eebbc922d5bf5086cad0a24b545ca9953cd2
+  metadata.gz: a76e3a6d48d2625d7606279300a1e3728f72f71ffd30ec03ee34e6f1c8de6530dd1c3c7e57c6cede18d2de20892859fa9b95913a9bc72bdf5cb18b4c8ce01b11
+  data.tar.gz: 892addae5df559e8fabf8a7ac10ea48757356262c3692f2682a47e88431b5b336175155e58cccad7aa6299be1075ac1db72314c463fbd6bf62b8cc0731d7b0e2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitjira (0.0.2)
+    gitjira (0.1.0)
       highline
       rest-client (~> 1.6)
 

data/README.md

@@ -1,42 +1,68 @@
 # gitjira
 
-Git JIRA is an extension that combines feature or all other type of branches
+Git JIRA is an extension that combines feature, or all other type of branches,
 with JIRA issues. It shows the current status and the summary of the issue.
 
 In order to be able to combine branches the branch name must include the following
 string _PROJECTKEY-###_
 
-Examples if the project key is _PROJ_ and the issue number _123_
+Examples if the project key is _PROJ_ and the issue number is _123_
 
-    features/PROJ-123_some_description
-    someprefix/PROJ-123_some_description
     PROJ-123
     PROJ-123_description
+    features/PROJ-123_some_description
+    someprefix/PROJ-123-some_description
 
 ## Installation
 
 Install via rubygems.org:
 
     $ gem install gitjira
-    or with rvm
+    or with global via rvm
     $ rvm @global do gem install gitjira
 
 ## Setup:
 
-    $ git jira init
+    $ git-jira init
     JIRA host (e.g. https://jira.example.org): http://www.example.org/jira
     Your JIRA username                       : johnny
     Your JIRA password                       : ************
     Related JIRA project key (e.g. PROJ)     : PROJ
 
+If you want update the configuration file, e.g. changing the host, you can
+update directly the .git/config file or via the following command:
+
+    $ git-jira init -f # or --force
 
-## Example Scenario - Feature Branches:
 
-    $ git jira list
+## Example Scenario #1 - List branch information that have related JIRA issues:
+
+    $ git-jira list
     Open           0% done  PROJ-123  - Implement some new feature
     Resolved     100% done  PROJ-20   - And yet another feature
     Resolved      42% done  PROJ-16   - Add /features page
 
+## Exampel Scenario #2 - Get information about the current branch
+
+    $ git-jira describe
+    => Add /features page <=
+
+    Issue Key...........: PROJ-123
+    Type................: New Feature
+    Status..............: Resolved
+    Progress............: 42.0 %
+    Estimated Work......: 1d
+    Remaining Work......: 4h 35m
+    Resolution..........: Fixed
+    Priority............: Major
+    Assignee............: Me
+    Reporter............: Me
+    Created At..........: 2013-05-26 13:09:17 +0200
+    Updated At..........: 2013-06-20 23:21:18 +0200
+    Fix Version.........: v1.2.0 (2013-06-30),
+
+    Add a page that list all features.
+
 ## Tips & Tricks
 
 Use aliases to be even more efficient, e.g. add 'alias jl = jira list' to your global ~/.gitconfig
@@ -50,6 +76,8 @@ Use aliases to be even more efficient, e.g. add 'alias jl = jira list' to your g
 
 ## Contributing
 
+Please contribute and help to make this tool even better.
+
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)

data/bin/git-jira

@@ -22,6 +22,7 @@ opt_parser = OptionParser.new do |opt|
   opt.separator  "Commands"
   opt.separator  "     init:          setup the current repository to be able to connect to a JIRA project"
   opt.separator  "     list:          returns a list of branches with related issue information"
+  opt.separator  "     describe:      verbose issue information related to the current branch"
   opt.separator  ""
 
   opt.on("-h", "--help", "help") do
@@ -54,6 +55,8 @@ when "list"
   rescue => e
     STDERR.puts "[ERROR] Not able to fetch feature branch information from JIRA, through exception: #{e}"
   end
+when "describe"
+   Gitjira::InformationFetching.describe
 else
   STDOUT.puts opt_parser
 end

data/lib/gitjira/information_fetching.rb

@@ -1,8 +1,6 @@
 class Gitjira::InformationFetching
 
   def self.branches
-    jira_url = "#{Gitjira::InformationFetching.host}rest/api/2/issue/"
-    credentials = Gitjira::InformationFetching.credentials
     project_key = Gitjira::InformationFetching.project_key
     branches = `git branch -a`.split("\n")
     issues = Array.new
@@ -16,10 +14,6 @@ class Gitjira::InformationFetching
       end
 
       if fetch
-        response = RestClient::Resource.new("#{jira_url}#{branch}", {
-          :headers => { "Authorization" => "Basic #{credentials}" }
-        }).get
-        json = JSON.parse(response)
         if json['fields']['progress']['percent']
           puts sprintf "%-12s %3.0f%s\t%-14s - %s",
             json['fields']['status']['name'],
@@ -38,16 +32,102 @@ class Gitjira::InformationFetching
     return nil
   end
 
-  def self.project_key
-     `git config --local --get gitjira.projectkey`.chomp
+  def self.describe
+    issue = self.extract_issue
+    if issue
+      issue_info = self.fetch_issue_json(issue)
+      if issue_info
+        fields = issue_info['fields']
+
+        puts "=> #{fields['summary']} <="
+        puts ""
+        puts "Issue Key...........: #{issue_info['key']}"
+        puts "Type................: #{fields['issuetype']['name']}"
+        puts "Status..............: #{fields['status'] ? fields['status']['name'] : 'None'}"
+        if fields['progress'] and fields['progress']['percent']
+          puts "Progress............: #{fields['progress']['percent'].round(2)} %"
+        end
+        if fields['timetracking'] and fields['timetracking']['originalEstimate'] and fields['timetracking']['remainingEstimate']
+          puts "Estimated Work......: #{fields['timetracking']['originalEstimate']}"
+          puts "Remaining Work......: #{fields['timetracking']['remainingEstimate']}"
+        end
+        puts "Resolution..........: #{fields['resolution'] ? fields['resolution']['name'] : 'None'}"
+        puts "Priority............: #{fields['priority']['name']}"
+        puts "Assignee............: #{self.extract_person(fields['assignee'])}"
+        puts "Reporter............: #{self.extract_person(fields['reporter'])}"
+        puts "Created At..........: #{self.date_formatter(fields['created'])}"
+        puts "Updated At..........: #{self.date_formatter(fields['updated'])}"
+        puts "Fix Version.........: #{self.extract_versions(fields['fixVersions'])}"
+
+        if fields['description']
+          puts ""
+          puts "#{fields['description']}"
+        end
+      else
+        puts "[Error] Not able to extract issue information of '#{issue}'"
+      end
+    else
+      puts "[Warning] You are currently in no branch that is related to an issue."
+    end
   end
 
-  def self.credentials
-     `git config --local --get gitjira.credentials`.chomp
+  def self.date_formatter(date)
+    DateTime.parse(date).strftime("%Y-%m-%d %H:%M:%S %z")
+  end
+
+  def self.extract_person(person_object)
+    me_email = `git config --get user.email`.chomp
+    if me_email and person_object and me_email.eql?(person_object['emailAddress'])
+      "Me"
+    else
+      "#{person_object['displayName']} <#{person_object['emailAddress']}>"
+    end
+  end
+
+  def self.extract_versions(version_array)
+    if version_array and version_array.kind_of?(Array)
+      versions = ""
+      version_array.each do |version|
+        versions = "#{version['name']} (#{version['releaseDate']}), #{versions}"
+      end
+      versions
+    else
+      ""
+    end
+  end
+
+  def self.extract_issue(branch_name = nil)
+    branch_name = Gitjira::InformationFetching.current_branch if branch_name.nil?
+    project_key = Gitjira::InformationFetching.project_key
+    branch_name[/#{project_key}-\d+/]
+  end
+
+  def self.current_branch
+    `git branch --no-color | sed -e '/^[^*]/d' -e 's/* \(.*\)/\1/'`
+  end
+
+  def self.project_key
+    `git config --local --get gitjira.projectkey`.chomp
   end
 
   def self.host
-     `git config --local --get gitjira.host`.chomp
+    `git config --local --get gitjira.host`.chomp
+  end
+
+  private
+  def self.fetch_issue_json(issue_name)
+    jira_url = "#{Gitjira::InformationFetching.host}rest/api/2/issue/"
+    credentials = Gitjira::InformationFetching.credentials
+
+    response = RestClient::Resource.new("#{jira_url}#{issue_name}", {
+      :headers => { "Authorization" => "Basic #{credentials}" }
+    }).get
+    json = JSON.parse(response)
+    json
+  end
+
+  def self.credentials
+    `git config --local --get gitjira.credentials`.chomp
   end
 
 end

data/lib/gitjira/version.rb

@@ -1,3 +1,3 @@
 module Gitjira
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitjira
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Alex Oberhauser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client