git_scf 0.0.1 → 0.0.2

data/README.md

@@ -1 +1,47 @@
-TODO
+## GitScf
+Git tools to simplify the workflow at SeeClickFix
+
+### Installation
+
+    $ gem install git_scf
+
+Configure jira credentials. Either set them in your environment:
+
+    $ export JIRA_USERNAME="your-jira-username"
+    $ export JIRA_PASSWORD="your-jira-password"
+
+or in your git config:
+
+    $ git config --global gitscf.jirausername "your-jira-username"
+    $ git config --global gitscf.jirapassword "your-jira-password"
+
+### Usage
+
+    Usage: git scf (start|show|review|finish) [issue_number]
+          -v, --verbose                    Output more information
+          -h, --help                       Display this screen
+
+START - Start a feature branch based on the ticket ID.
+
+    $ git scf start SCF-100
+
+SHOW - Show jira information about tickets.
+
+    $ git scf show          # shows info on the current branch
+    $ git scf show -v       # include description and comments
+    $ git scf show SCF-500  # specify a different ticket ID
+
+REVIEW - Create a pull request in github on the current branch.
+
+    $ git scf review
+
+FINISH - Close out the current feature branch and code review.
+
+    $ git scf finish
+
+### Todo
+Contributions are appreciated!
+
+- Tests
+- Better error handling
+- Less backtick system calls

data/lib/git_scf/env_config.rb

@@ -5,6 +5,16 @@ class EnvConfig
   end
 
   def get(key)
-  	ENV[key] || repo.config["scfgit.#{key.downcase}"]
+  	ENV[key] || @repo.config["gitscf.#{git_key(key)}"]
+  end
+
+  def repo
+    @repo
+  end
+
+  private
+
+  def git_key(key)
+    key.downcase.gsub('_','')
   end
 end

data/lib/git_scf/jira.rb

@@ -2,6 +2,7 @@ class Jira
 	require 'jira'
 	
 	def initialize(config)
+		@config = config
 		options = { username: config.get('JIRA_USERNAME'),
 		            password: config.get('JIRA_PASSWORD'),
 		            use_ssl: true,
@@ -12,6 +13,10 @@ class Jira
 		@jira = JIRA::Client.new(options)
 	end
 
+	def config
+    @config
+	end
+
 	def ticket(id)
     @jira.Issue.find(id)
 	end

data/lib/git_scf/logger.rb

@@ -1,10 +1,10 @@
 class Logger
 
-  LOG_PATH = 'script/scfgit'
-  LOG_FILE = 'log'
+  LOG_PATH = '.gitscf'
 
-	def initialize
+	def initialize(ticket)
     `mkdir -p #{LOG_PATH}`
+    @filename = "#{ticket.id}"
   end
 
   def add(string)
@@ -14,6 +14,6 @@ class Logger
   private
 
   def log_file
-    "#{LOG_PATH}/#{LOG_FILE}"
+    "#{LOG_PATH}/#{@filename}"
   end
 end

data/lib/git_scf/subcommands/review.rb

@@ -10,7 +10,7 @@ class Review
     `git add .`
     `git commit -am "#{@ticket.id} #review"`
     `git push`
-    `hub pull-request "Addresses #{@ticket.id} please review." | pbcopy`
+    `hub pull-request "Addresses #{@ticket.id} #{@ticket.summary} please review." | pbcopy`
     puts "The code-review URL is in your clipboard."
   end
 end

data/lib/git_scf/ticket.rb

@@ -1,7 +1,7 @@
 class Ticket
 
-  def initialize(repo, jira)
-    @repo = repo
+  def initialize(jira)
+    @repo = jira.config.repo
     @jira = jira
   end
 
@@ -10,19 +10,19 @@ class Ticket
   end
 
   def branch_name
-    "#{id}-#{parameterize(summary)}"
+    "#{id}-#{parameterize(summary)[0..50]}"
   end
 
   def jira_ticket
     @jira && @jira.ticket(id)
   end
 
-  private
-
   def summary
     jira_ticket && jira_ticket.summary
   end
 
+  private
+
   def id_by_argument_or_branch
     ARGV.size == 2 ? ARGV.pop : id_from_branch
   end

data/lib/git_scf/version.rb

@@ -1,3 +1,3 @@
 module GitScf
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/git_scf.rb

@@ -45,13 +45,14 @@ module GitScf
     rescue
       puts "ERROR: Invalid git directory"
       puts opts
-      exit 
+      exit
     end
 
-    jira   = Jira.new(EnvConfig.new(repo))
-    ticket = Ticket.new(repo, jira)
-    logger = Logger.new
-    
+    config = EnvConfig.new(repo)
+    jira   = Jira.new(config)
+    ticket = Ticket.new(jira)
+    logger = Logger.new(ticket)
+
     case ARGV.first
     when 'start'
       Start.new(ticket, logger)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_scf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -64,17 +64,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0.b7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0.b7
 description: ! "  Provides git tools that match the SCF workflow. \n"
 email: jeff@seeclickfix.com
 executables: