story_branch 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27b478138908ff36d93a8c9c641136de6b789f1d
-  data.tar.gz: b7435c40b8257bb544f1379436a7559115100f2c
+  metadata.gz: 9c0e160a81842521457a2ef968e48f3960b2681d
+  data.tar.gz: a1a816524e43ce91699ca78b0f772c6e89a2795a
 SHA512:
-  metadata.gz: aa08dfe184feb00523a32995ea457952ef7881d34473d2aaf3423c4dbf2aedfa83050786090d1f84b2651bcf64061c2809ea0ef01eed3f052d53947f629af4e3
-  data.tar.gz: acec4e4033a5b0a6deff313be9b34253e89c379b614a0374c4e0b9a91d424e6377fb03644ecaf9867c14b964721a13d7314ab736509308bd6f44745bd8f6409f
+  metadata.gz: 8328b3529fb52fd129fe8a936b1c07e940c094c6aa3d03d297ff1a9da0b0471e5d228f180ee1accfa2f0a8ff1c858136179cf111f9384e0b655bb6f1c917745d
+  data.tar.gz: 99e3f567048af4d348d0b510d09f3aca8e1147cb9afd00708614d4f079b5295517ff9c47a62dc594cbb0735edf345a76105087dd69db671660ee5cf9800d1bc6

data/README.md

@@ -2,32 +2,37 @@
 
 # Story Branch
 
-A small collection of tools for working with git branches for
-Pivotal Tracker stories. Story branch, start, finish
+A small collection of tools for working with git branches and Pivotal
+Tracker stories. `git story`, `git finish`, `git start` and `git
+unstart`.
 
 ### Commentary
 
-`git story`: Create a git branch with automatic reference to a
+`git story`: Creates a git branch with automatic reference to a
 Pivotal Tracker Story. It will get started stories from your active
 project.  You can enter text and press TAB to search for a story
 name, or TAB to show the full list. It will then suggest an editable
 branch name. When the branch is created the `story_id` will
-be appended to it. Enter a blank to exit.
+be appended to it.
+
+e.g. `my-story-name-1234567`
+
+`git finish`: Creates a git commit message for the staged changes.
+
+e.g: `[Finishes #1234567] My Story Title`
+
+You must stage all changes (or stash them) first. Note the commit will not
+be pushed.  Note: You'll be able to bail out before.
 
 `git start`: Start a story in Pivotal Tracker from the terminal.
 It'll get all unstarted stories in your current project.  You can
 enter text and press TAB to search for a story name, or TAB to show
-the full list. Enter blank to exit.
+the full list.
 
-`git unstart`: Unstart a started story in Pivotal Tracker from the terminal.
+`git unstart`: Unstart a story in Pivotal Tracker from the terminal.
 It'll get all started stories in your current project.  You can
 enter text and press TAB to search for a story name, or TAB to show
-the full list. Enter blank to exit.
-
-`git finish`: Create commit/message for the staged changes, e.g:
-"[Finishes #1234567] My Story Title" - optionally Finishes the story
-via pivotal tracker's api. You must stage all changes (or stash
-them) first.
+the full list.
 
 ### Installing
 
@@ -35,47 +40,34 @@ Install the gem:
 
     gem install story_branch
 
-**Settings:** You must have a `PIVOTAL_API_KEY` environment variable set
+#### Settings
+
+You must have a `PIVOTAL_API_KEY` environment variable set
 to your Pivotal api key, plus either a `.story_branch` file or
 `PIVOTAL_PROJECT_ID` environment variable set. Note, values in
 `.story_branch` will override environment variable settings.
 
-**.story_branch file**
+#### .story_branch file
 
 A YAML file with either/both of:
 
     api: YOUR.PIVOTAL.API.KEY.STRING
     project: YOUR.PROJECT.ID.NUMBER
 
-Can be saved to `~/` or `./`
+Can be saved to `~/` or `./` (ie. your project folder)
 
 ### Usage
 
 You run story_branch from the git/project root folder.
 
-`start`, `unstart` and `story`, are run interactively and will display a
-list of stories to work with.
+`git story`, `git start` and `git unstart` are run interactively and
+will display a list of stories to work with.
 
-`finish` will scan the current branch name for a story id (as its
+`git finish` will scan the current branch name for a story id (as its
 suffix) and if a valid, active story is found on pivotal tracker it
 will create a commit with a message to trigger pivotal's git
 integraton features.
 
-All text entry supports Readline keyboard shortcuts / bindings, (word fwd/back, undo etc.)
-
-### Command names
-
-It's possible to the commands in a few ways, we have deprecated the
-old commmand names, and now encourage only the use of the `git`
-style usage.
-
-      git style  | deprecated
-     ------------+---------------+--------------
-      git story  | story_branch  | story-branch
-      git start  | story_start   | story-start
-      git unstart| story_unstart | story-unstart
-      git finish | story_finish  | story-finish
-
 ## Contributing
 
 All pull requests are welcome and will be reviewed.

data/lib/story_branch.rb

@@ -3,33 +3,43 @@
 # Authors: Jason Milkins <jason@opsmanager.com>
 #          Rui Baltazar <rui.p.baltazar@gmail.com>
 #          Dominic Wong <dominic.wong.617@gmail.com>
+#          Ranhiru Cooray <ranhiru@gmail.com>
 #          Gabe Hollombe <gabe@neo.com>
 #
-# Version: 0.2.6
+# Version: 0.2.7
 #
 # ## Description
-#
-# A small collection of tools for working with git branches for
-# Pivotal Tracker stories. Story branch, start, finish
+# A small collection of tools for working with git branches and Pivotal
+# Tracker stories. `git story`, `git finish`, `git start` and `git
+# unstart`.
 #
 # ### Commentary
 #
-# `git story`: Create a git branch with automatic reference to a
+# `git story`: Creates a git branch with automatic reference to a
 # Pivotal Tracker Story. It will get started stories from your active
 # project.  You can enter text and press TAB to search for a story
 # name, or TAB to show the full list. It will then suggest an editable
 # branch name. When the branch is created the `story_id` will
 # be appended to it.
 #
+# e.g. `my-story-name-1234567`
+#
+# `git finish`: Creates a git commit message for the staged changes.
+#
+# e.g: `[Finishes #1234567] My Story Title`
+#
+# You must stage all changes (or stash them) first. Note the commit will not
+# be pushed.  Note: You'll be able to bail out before.
+#
 # `git start`: Start a story in Pivotal Tracker from the terminal.
 # It'll get all unstarted stories in your current project.  You can
 # enter text and press TAB to search for a story name, or TAB to show
 # the full list.
-
-# `git finish`: Create commit/message for the staged changes, e.g:
-# "[Finishes #1234567] My Story Title" - optionally Finishes the story
-# via pivotal tracker's api. You must stage all changes (or stash
-# them) first.
+#
+# `git unstart`: Unstart a story in Pivotal Tracker from the terminal.
+# It'll get all started stories in your current project.  You can
+# enter text and press TAB to search for a story name, or TAB to show
+# the full list.
 #
 # ### Installing
 #
@@ -37,44 +47,34 @@
 #
 #     gem install story_branch
 #
-# **Settings:** You must have a `PIVOTAL_API_KEY` environment variable set
+# #### Settings
+#
+# You must have a `PIVOTAL_API_KEY` environment variable set
 # to your Pivotal api key, plus either a `.story_branch` file or
 # `PIVOTAL_PROJECT_ID` environment variable set. Note, values in
 # `.story_branch` will override environment variable settings.
 #
-# **.story_branch file**
+# #### .story_branch file
 #
 # A YAML file with either/both of:
 #
 #     api: YOUR.PIVOTAL.API.KEY.STRING
 #     project: YOUR.PROJECT.ID.NUMBER
 #
-# Can be saved to `~/` or `./`
+# Can be saved to `~/` or `./` (ie. your project folder)
 #
 # ### Usage
 #
 # You run story_branch from the git/project root folder.
 #
-# `start`, `branch`, are run interactively and will display a
-# list of stories to work with.
+# `git story`, `git start` and `git unstart` are run interactively and
+# will display a list of stories to work with.
 #
-# `finish` will scan the current branch name for a story id (as its
+# `git finish` will scan the current branch name for a story id (as its
 # suffix) and if a valid, active story is found on pivotal tracker it
 # will create a commit with a message to trigger pivotal's git
 # integraton features.
 #
-# ### Command names
-#
-# It's possible to the commands in a few ways, we have deprecated the
-# old commmand names, and now encourage only the use of the `git`
-# style usage.
-#
-#       git style  | deprecated
-#      ------------+--------------+--------------
-#       git story  | story_branch | story-branch
-#       git start  | story_start  | story-start
-#       git finish | story_finish | story-finish
-#
 # ## Contributing
 #
 # All pull requests are welcome and will be reviewed.
@@ -91,40 +91,44 @@ require 'levenshtein'
 trap('INT') {exit}
 
 module StoryBranch
+
   class Main
+
     ERRORS = {
-      'Stories in the started state must be estimated.' =>
+      "Stories in the started state must be estimated." =>
       "Error: Pivotal won't allow you to start an unestimated story"
     }
 
-    PIVOTAL_CONFIG_FILES = ['.story_branch', "#{ENV['HOME']}/.story_branch"]
-    PIVOTAL_API_CONFIG_FILES = ['.pivotal_api_key', "#{ENV['HOME']}/.pivotal_api_key"]
+    PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
 
     attr_accessor :p
 
     def initialize
-      @pivotal_info     = YAML.load_file config_file(PIVOTAL_CONFIG_FILES) if config_file(PIVOTAL_CONFIG_FILES)
-      @pivotal_api_info = YAML.load_file config_file(PIVOTAL_API_CONFIG_FILES) if config_file(PIVOTAL_API_CONFIG_FILES)
-      @p                = PivotalUtils.new
-      @p.api_key        = api_config_value
-      @p.project_id     = config_value 'project', 'PIVOTAL_PROJECT_ID'
+      if config_file
+        @pivotal_info = YAML.load_file config_file
+      end
+      @p            = PivotalUtils.new
+      @p.api_key    = config_value "api", 'PIVOTAL_API_KEY'
+      @p.project_id = config_value "project", 'PIVOTAL_PROJECT_ID'
       exit unless @p.valid?
     end
 
     def create_story_branch
       begin
-        puts 'Connecting with Pivotal Tracker'
+        puts "Connecting with Pivotal Tracker"
         @p.get_project
-        puts 'Getting stories...'
+        puts "Getting stories..."
         stories = @p.display_stories :started, false
         if stories.length < 1
-          puts 'No stories started, exiting'
+          puts "No stories started, exiting"
           exit
         end
-        story   = @p.select_story stories
-        @p.create_feature_branch story if story
+        story = @p.select_story stories
+        if story
+          @p.create_feature_branch story
+        end
       rescue RestClient::Unauthorized
-        $stderr.puts 'Pivotal API key or Project ID invalid'
+        $stderr.puts "Pivotal API key or Project ID invalid"
         return nil
       end
     end
@@ -169,48 +173,43 @@ module StoryBranch
 
         unless @p.is_current_branch_a_story?
           puts "Your current branch: '#{GitUtils.current_branch}' is not linked to a Pivotal Tracker story."
-          return
+          return nil
         end
 
         if GitUtils.has_status? :untracked or GitUtils.has_status? :modified
-          puts 'There are unstaged changes'
-          puts 'Use git add to stage changes before running git finish'
-          puts 'Use git stash if you want to hide changes for this commit'
-          return
+          puts "There are unstaged changes"
+          puts "Use git add to stage changes before running git finish"
+          puts "Use git stash if you want to hide changes for this commit"
+          return nil
         end
 
         unless GitUtils.has_status? :added or GitUtils.has_status? :staged
-          puts 'There are no staged changes.'
-          puts 'Nothing to do'
-          return
+          puts "There are no staged changes."
+          puts "Nothing to do"
+          return nil
         end
 
-        puts 'Use standard finishing commit message: [y/N]?'
+        puts "Use standard finishing commit message: [y/N]?"
         commit_message = "[Finishes ##{GitUtils.current_branch_story_parts[:id]}] #{StringUtils.undashed GitUtils.current_branch_story_parts[:title]}"
         puts commit_message
 
-        if gets.chomp!.downcase == 'y'
+        if gets.chomp!.downcase == "y"
           GitUtils.commit commit_message
         else
           puts "Aborted"
         end
       rescue RestClient::Unauthorized
-        $stderr.puts 'Pivotal API key or Project ID invalid'
+        $stderr.puts "Pivotal API key or Project ID invalid"
         return nil
       end
     end
 
-    def config_file file_set
-      file_set.select{|conf| File.exists? conf}.first
-    end
-
-    def api_config_value
-      return @pivotal_api_info['api'] if @pivotal_api_info && @pivotal_api_info['api']
-      config_value 'api', 'PIVOTAL_API_KEY'
+    def config_file
+      PIVOTAL_CONFIG_FILES.select{|conf| File.exists? conf}.first
     end
 
     def config_value key, env
-      value = @pivotal_info[key] if @pivotal_info && @pivotal_info[key]
+      value = @pivotal_info[key] if @pivotal_info and @pivotal_info[key]
       value ||= env_required env
       value
     end
@@ -222,52 +221,62 @@ module StoryBranch
       end
       ENV[var_name]
     end
+
   end
 
   class StringUtils
+
     def self.dashed s
       s.tr(' _,./:;+&', '-')
     end
 
     def self.simple_sanitize s
-      strip_newlines s.tr '\'"%!@#$(){}[]*\\?', ''
+      strip_newlines (s.tr '\'"%!@#$(){}[]*\\?', '')
     end
 
     def self.normalised_branch_name s
-      StringUtils.simple_sanitize StringUtils.dashed(s).downcase.squeeze('-')
+      simple_sanitize((dashed s).downcase).squeeze("-")
     end
 
     def self.strip_newlines s
-      s.tr "\n", '-'
+      s.tr "\n", "-"
     end
 
     def self.undashed s
-      s.underscore.humanize
+      s.gsub(/-/, " ").capitalize
     end
+
   end
 
   class GitUtils
+
     def self.g
-      Git.open '.'
+      Git.open "."
     end
 
     def self.is_existing_branch? name
       branch_names.each do |n|
-        return true if Levenshtein.distance(n, name) < 3
+        if Levenshtein.distance(n, name) < 3
+          return true
+        end
         existing_branch_name = n.match(/(.*)(-[1-9][0-9]+$)/)
         if existing_branch_name
           levenshtein_distance = Levenshtein.distance existing_branch_name[1], name
-          return true if levenshtein_distance < 3
+          if levenshtein_distance < 3
+            return true
+          end
         end
       end
-      false
+      return false
     end
 
     def self.is_existing_story? id
       branch_names.each do |n|
         branch_id = n.match(/-[1-9][0-9]+$/)
         if branch_id
-          return true if branch_id.to_s == "-#{id}"
+          if branch_id.to_s == "-#{id}"
+            return true
+          end
         end
       end
       false
@@ -286,8 +295,12 @@ module StoryBranch
     end
 
     def self.current_branch_story_parts
-      matches = current_branch.match(/(.*)-(\d+$)/)
-      { title: matches[1], id: matches[2] } if matches.length == 3
+      matches = current_story
+      if matches.length == 3
+        { title: matches[1], id: matches[2] }
+      else
+        nil
+      end
     end
 
     def self.create_branch name
@@ -296,7 +309,11 @@ module StoryBranch
     end
 
     def self.status_collect status, regex
-      status.select { |s| s.match(regex) }.map { |e| e.match(regex)[1] }
+      status.select{|e|
+        e.match(regex)
+      }.map{|e|
+        e.match(regex)[1]
+      }
     end
 
     def self.status
@@ -322,9 +339,11 @@ module StoryBranch
     def self.commit message
       g.commit(message)
     end
+
   end
 
   class PivotalUtils
+
     attr_accessor :api_key, :project_id, :project
 
     def valid?
@@ -337,10 +356,11 @@ module StoryBranch
     end
 
     def is_current_branch_a_story?
-      GitUtils.current_story && GitUtils.current_story.length == 3 &&
+      GitUtils.current_story and
+        GitUtils.current_story.length == 3 and
         filtered_stories_list(:started, true)
         .map(&:id)
-        .include?(GitUtils.current_story[2].to_i)
+        .include? GitUtils.current_story[2].to_i
     end
 
     def story_from_current_branch
@@ -356,9 +376,9 @@ module StoryBranch
       stories = project.stories.all({current_state: state})
       if estimated
         stories.select{|s|
-          s.story_type == 'bug' ||
-          s.story_type == 'chore' ||
-          (s.story_type == 'feature' && s.estimate && s.estimate >= 0)}
+          s.story_type == "bug" or
+          s.story_type == "chore" or
+          (s.story_type == "feature" and s.estimate and s.estimate >= 0)}
       else
         stories
       end
@@ -400,17 +420,16 @@ module StoryBranch
       dashed_story_name = StringUtils.normalised_branch_name story.name
       feature_branch_name = nil
       puts "You are checked out at: #{GitUtils.current_branch}"
-      while feature_branch_name == nil || feature_branch_name == ""
-        puts 'Provide a new branch name... (TAB for suggested name)' if [nil, ''].include? feature_branch_name
-        feature_branch_name = readline('Name of feature branch: ', [dashed_story_name])
+      while feature_branch_name == nil or feature_branch_name == ""
+        puts "Provide a new branch name... (TAB for suggested name)" if [nil, ""].include? feature_branch_name
+        feature_branch_name = readline("Name of feature branch: ", [dashed_story_name])
       end
       feature_branch_name.chomp!
-
-      return unless validate_branch_name feature_branch_name, story.id
-
-      feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
-      puts "Creating: #{feature_branch_name_with_story_id} with #{GitUtils.current_branch} as parent"
-      GitUtils.create_branch feature_branch_name_with_story_id
+      if validate_branch_name feature_branch_name, story.id
+        feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
+        puts "Creating: #{feature_branch_name_with_story_id} with #{GitUtils.current_branch} as parent"
+        GitUtils.create_branch feature_branch_name_with_story_id
+      end
     end
 
     # Branch name validation
@@ -420,7 +439,7 @@ module StoryBranch
         return false
       end
       if GitUtils.is_existing_branch? name
-        puts "Error: The name: #{name}, is very similar to an existing branch. To avoid confusion use a more unique name."
+        puts "Error: This name is very similar to an existing branch. Avoid confusion and use a more unique name."
         return false
       end
       unless valid_branch_name? name
@@ -441,10 +460,10 @@ module StoryBranch
       # Store the state of the terminal
       RbReadline.clear_history
       if completions.length > 0
-        completions.each { |i| Readline::HISTORY.push i}
-        RbReadline.rl_completer_word_break_characters = ''
-        Readline.completion_proc = proc { |s| completions.grep(/#{Regexp.escape(s)}/) }
-        Readline.completion_append_character = ''
+        completions.each {|i| Readline::HISTORY.push i}
+        RbReadline.rl_completer_word_break_characters = ""
+        Readline.completion_proc = proc {|s| completions.grep(/#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = ""
       end
       Readline.readline(prompt, false)
     end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Jason Milkins
 - Rui Baltazar
 - Dominic Wong
+- Ranhiru Cooray
 - Gabe Hollombe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pivotal-tracker
@@ -90,47 +91,22 @@ email:
 - jasonm23@gmail.com
 - rui.p.baltazar@gmail.com
 - dominic.wong.617@gmail.com
+- ranhiru@gmail.com
 - gabe@neo.com
 executables:
-- story_start
-- story-start
-- git-start
-- git-story-start
-- story_unstart
-- story-unstart
-- git-unstart
-- git-story-unstart
-- story_branch
-- story-branch
 - git-story
-- git-story-branch
-- git-pivotal-story
-- story_finish
-- story-finish
 - git-finish
-- git-story-finish
+- git-start
+- git-unstart
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENCE
 - README.md
 - bin/git-finish
-- bin/git-pivotal-story
 - bin/git-start
 - bin/git-story
-- bin/git-story-branch
-- bin/git-story-finish
-- bin/git-story-start
-- bin/git-story-unstart
 - bin/git-unstart
-- bin/story-branch
-- bin/story-finish
-- bin/story-start
-- bin/story-unstart
-- bin/story_branch
-- bin/story_finish
-- bin/story_start
-- bin/story_unstart
 - lib/story_branch.rb
 homepage: https://github.com/jasonm23/story_branch
 licenses:

data/bin/git-pivotal-story

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.create_story_branch

data/bin/git-story-branch

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.create_story_branch

data/bin/git-story-finish

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_finish

data/bin/git-story-start

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_start

data/bin/git-story-unstart

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_unstart

data/bin/story-branch

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.create_story_branch

data/bin/story-finish

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_finish

data/bin/story-start

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_start

data/bin/story-unstart

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_unstart

data/bin/story_branch

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.create_story_branch

data/bin/story_finish

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_finish

data/bin/story_start

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_start

data/bin/story_unstart

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-require 'story_branch'
-sb = StoryBranch::Main.new()
-sb.story_unstart