gitjira 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4352b0c24da71ed1886cce9a72e0a81a54b401e9
-  data.tar.gz: 100b0d5bdeb9bb956bc7d2b99d68048d27a2a00a
+  metadata.gz: 6ffc0c5f2516a815a6e25fdac1e79f0c446462da
+  data.tar.gz: e27d242f0d6d3eb15e7f5dd5a99ceaa2ffb0f5cd
 SHA512:
-  metadata.gz: a76e3a6d48d2625d7606279300a1e3728f72f71ffd30ec03ee34e6f1c8de6530dd1c3c7e57c6cede18d2de20892859fa9b95913a9bc72bdf5cb18b4c8ce01b11
-  data.tar.gz: 892addae5df559e8fabf8a7ac10ea48757356262c3692f2682a47e88431b5b336175155e58cccad7aa6299be1075ac1db72314c463fbd6bf62b8cc0731d7b0e2
+  metadata.gz: e81801375ce8eafa87ef69b5817923c621f5e330c00c5976a52fdd62a3b8e4a7f32588f70c706f946e19824c6d55a66682c938c35ccc9d478c564785ca7f141f
+  data.tar.gz: c6034d33f7803901c3dead1400262d9acd8f49608f4263848226db34afa4eab799e25e850784573d2dc2e951f2028538c6327e3fca8cbf510ce2974037c01b1b

data/.gitignore

@@ -16,3 +16,4 @@ tmp
 .yardoc
 _yardoc
 doc/
+_site

data/Gemfile.lock

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

data/README.md

@@ -1,10 +1,11 @@
 # gitjira
 
-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.
+Git JIRA is an extension that combines branches with JIRA issues. It allows the
+extraction of issue information directly from the console, without changing to
+the JIRA website and interrupting the work process.
 
-In order to be able to combine branches the branch name must include the following
-string _PROJECTKEY-###_
+In order to be able to enrich a branch with issue informaiton the name must
+include the following string _PROJECTKEY-###_ aka. the issue name.
 
 Examples if the project key is _PROJ_ and the issue number is _123_
 
@@ -18,7 +19,7 @@ Examples if the project key is _PROJ_ and the issue number is _123_
 Install via rubygems.org:
 
     $ gem install gitjira
-    or with global via rvm
+    or globally via rvm
     $ rvm @global do gem install gitjira
 
 ## Setup:
@@ -61,19 +62,33 @@ update directly the .git/config file or via the following command:
     Updated At..........: 2013-06-20 23:21:18 +0200
     Fix Version.........: v1.2.0 (2013-06-30),
 
-    Add a page that list all features.
+    Add a page that lists all features.
 
 ## Tips & Tricks
 
-Use aliases to be even more efficient, e.g. add 'alias jl = jira list' to your global ~/.gitconfig
+Use aliases to be even more efficient:
+
+    $ cat ~/.gitconfig
+    ...
+    [alias]
+        jl = jira list
+        jd = jira describe
+    ...
 
     $ git jl # same as git jira list
+    $ git jd # same as git jira describe
 
 ## Usage
 
     # See what commands are available.
     $ git-jira --help # or git jira -h
 
+## Resources
+
+* [RubyGems.org](https://rubygems.org/gems/gitjira) - The gem lives here...
+* [GitHub](https://github.com/Sigimera/gitjira) - The code lives here...
+* [Documentation](http://sigimera.github.io/gitjira/) - The documentation lives here...
+
 ## Contributing
 
 Please contribute and help to make this tool even better.

data/lib/gitjira/information_fetching.rb

@@ -1,7 +1,7 @@
 class Gitjira::InformationFetching
 
   def self.branches
-    project_key = Gitjira::InformationFetching.project_key
+    project_key = self.project_key
     branches = `git branch -a`.split("\n")
     issues = Array.new
     issues_printed = Array.new
@@ -14,6 +14,7 @@ class Gitjira::InformationFetching
       end
 
       if fetch
+        json = self.fetch_issue_json(branch)
         if json['fields']['progress']['percent']
           puts sprintf "%-12s %3.0f%s\t%-14s - %s",
             json['fields']['status']['name'],
@@ -97,8 +98,8 @@ class Gitjira::InformationFetching
   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 = self.current_branch if branch_name.nil?
+    project_key = self.project_key
     branch_name[/#{project_key}-\d+/]
   end
 
@@ -116,8 +117,8 @@ class Gitjira::InformationFetching
 
   private
   def self.fetch_issue_json(issue_name)
-    jira_url = "#{Gitjira::InformationFetching.host}rest/api/2/issue/"
-    credentials = Gitjira::InformationFetching.credentials
+    jira_url = "#{self.host}rest/api/2/issue/"
+    credentials = self.credentials
 
     response = RestClient::Resource.new("#{jira_url}#{issue_name}", {
       :headers => { "Authorization" => "Basic #{credentials}" }

data/lib/gitjira/version.rb

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

data/tools/readme2ghpage.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/env ruby
+
+# checkout the readme from the master branch
+`git checkout gh-pages; git checkout master README.md`
+
+path = `pwd`.gsub(/\n/, "")
+readme_path = File.join(path, "README.md")
+index_path = File.join(path, "index.md")
+
+# write the index readme file
+File.open readme_path, "r" do |readme|
+  File.open index_path, "w" do |index|
+
+    # write the jekyll front matter
+    index.puts "---"
+    index.puts "layout: main"
+    index.puts "---"
+
+    readme.readlines.each do |line|
+
+      # convert backticks to liquid
+      %w(bash ruby).each do |lang|
+        line.gsub!("```#{lang}", "{% highlight #{lang} %}")
+      end
+      line.gsub!("```", "{% endhighlight %}")
+
+      # convert headers so they are linkable
+      if line =~ /^#+/
+        leader = line[0, line.index(/\s/)]
+        text = line[line.index(/\s./)..-1].strip
+        line = "#{leader} #{text} {##{text.downcase.gsub(/\s/, "-")}}"
+      end
+
+      index.puts line
+    end
+  end
+end
+
+# remove the readme
+`git reset HEAD README.md; rm README.md`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitjira
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alex Oberhauser
@@ -87,6 +87,7 @@ files:
 - lib/gitjira/information_fetching.rb
 - lib/gitjira/setup.rb
 - lib/gitjira/version.rb
+- tools/readme2ghpage.rb
 homepage: https://github.com/Sigimera/gitjira
 licenses:
 - MIT