story_branch 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f515e7349d6e9e3c97deb9036626e0b609a4961
-  data.tar.gz: 7cf773b74675fd4060b5c7f664b0dd4dcad6d87d
+  metadata.gz: 51fb5eb1e204d970116356bb1f2f273ac0de0804
+  data.tar.gz: 6ae1d58a21ae39e5def105f4b58d327147fd83a9
 SHA512:
-  metadata.gz: 1146269635ae3f44f03aae8da7556fb566a65648997ae107aa59531958a800589eccf0129bc2c0661d80ddd7150b6a9910808890f8a780fbb770b9b889022e00
-  data.tar.gz: e39bee90b82d67fd713e9a8155c756b9b9b548f2552c9aaef89a694a9f305ad7561a4f97daa33483c31e5332f46a9d81d95c396b80c3f24b618663fc6428c093
+  metadata.gz: 010f313b23b8b1604af7dd9fd679d60f9c67b8109fc4083c39932480be23f1ed544fcbe8ad5a3e488df9b3a68af67581e7e8c3a7edec2f82f7553d3650913fea
+  data.tar.gz: 2d227dfd93c2a3655f78a512f1ee3d7adf5d57c2c41c6fb96264bd88dc738bd94185dc5c611057d1ea52d3a997704b87d14f0f24bf249e9db418714a45ad94e0

data/README.md

@@ -2,113 +2,63 @@
 
 # Story Branch
 
-Create a git feature branch with automatic reference to a Pivotal Tracker Story
+## Description
 
-By default `story_branch` will present a list of started stories from
-your Pivotal Tracker project, you select one and then provide
-a feature branch name for that story. The branch will be created and
-the name will include the selected `story_id` as a suffix.
+A small collection of tools for working with git branches for
+Pivotal Tracker stories. Story branch, story start, story finish
 
-When picking a story, enter the selection number on the left, using the up
-arrow (or C-p) will scroll through the selection numbers.
+### Commentary
 
-Once a story is selected, a feature branch name can be entered, a
-suggestion is provided (press the up arrow (or C-p) to see it)
+**git story**: Create a git branch with automatic reference to a
+Pivotal Tracker Story, it will present a list of started stories
+from your active project.  Select a story, and it will suggest a
+feature branch name for that story, which you can edit or
+accept. The branch will be created (the story_id will automatically
+be used as a suffix in the branch name)
 
-The feature branch name input has full
-[Readline](http://tiswww.case.edu/php/chet/readline/rluserman.html#SEC5)
-capability, to make it easy and pleasant to edit.
+**git start**: Start a story in Pivotal Tracker from the terminal.
+List all unstarted stories in your current project. Entering a
+partial string will fuzzy match against the list.
 
-## Setup
+**git finish**: Create a finishing commit + message, for example:
+"[Finishes #1234567] My Story Title" - optionally Finishes the story
+via pivotal tracker's api.
+
+### Installing
 
 Install the gem:
 
     gem install story_branch
 
-Config the Pivotal API key and Project ID, either in the environment
-or using a config YAML file. (`.story_branch` in the git root, or
-`~/.story_branch`)
-
-The environment variables to set are `PIVOTAL_API_KEY` and `PIVOTAL_PROJECT_ID`
-
-The **Pivotal API** key is visble at the bottom of your Pivotal Tracker
-Profile page when you're logged in. the **Project ID** is in the URL for
-your pivotal project.
-
-If you decide to use the `.story_branch` config file, it should look
-something like:
-
-    project: 123456
-    api: REHTKHMYKEYISM328974Y32487AND_SO_ON
-
-Or just:
-
-    project: 123456
-
-Replace the values with your own. Any value not found in the config
-will attempt to be set from the environment. An error is thrown for a
-value that cannot be found anywhere.
-
-Note, that only one config file will be used at the moment, values
-**CANNOT** currently be split over `.story_branch` in the git root and
-`~/.story_branch`
+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.
 
-## Usage
+### Usage
 
-While checked out at your master branch, and located in the git root.
+Note: Run story_branch from the project root folder.
 
-    story_branch
+`start`, `story`, are run interactively and will display a
+list of stories to work with.
 
-Follow the directions on screen. When the process is finished, you'll
-be switched automatically to the newly created branch.
+`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.
 
-## Aliases
+### Command names
 
-You can also run story branch using the following aliases.
+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 story
-
-    git story-branch
-
-    story-branch
-
-
-## Roadmap
-
-Prepare a v1.0 release
-
-## Changelog
-
-* Banish constraint of master as parent branch
-* Verify API key / Project ID
-* Update config method to use YAML .story_branch files (in git root or $HOME) see above.
-* Build/Publish as Ruby gem
-* Simple sanitization
-* Begin test coverage
-* Refactor to class
-* Provide readline editing for inputs
-* Present safe version of story name (dash-cased) for editing
-* Readline history injection for story selection & branch name suggestion
-* Validate that branchname is 'legal'
-* Validate that branchname doesn't already exist (strip pivotal
-  tracker ids suffix from existing names when present)
-* Use Levenshtein Distance to determine if name is (very) similar to
-  existing branch names
-* Use Git gem
-* Use ActiveSupport gem
-* Use Levenschtein-ffi gem
-* ~~Look for pivotal project id (.pivotal-id) in repo root (we assume
-  we're in project root.) fallback to `PIVOTAL_PROJECT_ID` environment
-  var~~ **PLEASE NOTE:** Now uses `.story_branch` or `~/.story_branch`
-  as config file, containing YAML. Only one is used, the local root
-  `.story_branch` is favoured.
+      git style  | deprecated
+     ------------+--------------+--------------
+      git story  | story_branch | story-branch
+      git start  | story_start  | story-start
+      git finish | story_finish | story-finish
 
 ## Contributing
 
-If you'd like to contribute to `story_branch` please follow the steps below.
-
-* Fork, start a feature branch and check it out
-* Write tests / Pass them
-* Send a pull request
-
-**Note:** Pull requests require full test coverage to be accepted.
+All pull requests are welcome and will be reviewed.

data/bin/git-finish

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

data/bin/git-pivotal-story

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

data/bin/git-start

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

data/bin/git-story

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

data/bin/git-story-branch

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

data/bin/git-story-finish

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

data/bin/git-story-start

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

data/bin/story-branch

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

data/bin/story-finish

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

data/bin/story-start

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

data/bin/story_branch

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

data/bin/story_finish

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

data/bin/story_start

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

data/lib/story_branch.rb

@@ -1,214 +1,393 @@
-# Name: story_branch (recommend: setting a git alias as "git story")
+# Name: story branch
 #
 # Authors: Jason Milkins <jason@opsmanager.com>
 #          Rui Baltazar <rui.p.baltazar@gmail.com>
-#          Gabe Hollombe <gabe@neo.com>
 #          Dominic Wong <dominic.wong.617@gmail.com>
+#          Gabe Hollombe <gabe@neo.com>
+#
+# Version: 0.2.0
+#
+# ## Description
+#
+# A small collection of tools for working with git branches for
+# Pivotal Tracker stories. Story branch, start, finish
+#
+# ### Commentary
+#
+# **branch**: Create a git branch with automatic reference to a
+# Pivotal Tracker Story, it will present a list of started stories
+# from your active project.  Select a story, and it will suggest a
+# feature branch name for that story, which you can edit or
+# accept. The branch will be created (the story_id will automatically
+# be used as a suffix in the branch name)
 #
-# Version: 0.1.8
+# **start**: Start a story in Pivotal Tracker from the terminal.
+# List all unstarted stories in your current project. Entering a
+# partial string will fuzzy match against the list.
 #
-# Description:
+# **finish**: Create a finishing commit + message, for example:
+# "[Finishes #1234567] My Story Title" - optionally Finishes the story
+# via pivotal tracker's api.
 #
-# Create a git branch with automatic reference to a Pivotal Tracker
-# Story ID
+# ### Installing
 #
-# Commentary:
+# Install the gem:
 #
-# By default story_branch will present a list of started stories from
-# your active PivotalTracker project, you select one and then provide
-# a feature branch name for that story. The branch will be created and
-# the name will include the story_id as a suffix.
+#     gem install story_branch
 #
-# When picking a story, enter the selection number on the left (up
-# arrow / C-p will scroll through the numbers)
+# 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.
 #
-# Once a story is selected, a feature branch name must be entered, a
-# suggestion is shown if you press up arrow / C-p
+# ### Usage
 #
-# Usage:
+# Note: Run story_branch from the project root folder.
 #
-# Note: Run story_branch from the project root folder, with the
-# master branch checked out, or an error will be thrown.
+# `start`, `branch`, are run interactively and will display a
+# list of stories to work with.
 #
-# You must have a PIVOTAL_API_KEY environment variable set to your
-# Pivotal api key, and either a .pivotal-id file or PIVOTAL_PROJECT_ID
-# environment variable set, (the file will supersede the environment
-# variable)
+# `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.
+#
+# Code:
 
 require 'yaml'
 require 'pivotal-tracker'
 require 'readline'
 require 'git'
+require 'active_support/core_ext/string/inflections'
 require 'levenshtein'
 
-class StoryBranch
+module StoryBranch
+
+  class Main
 
-  # Config file = .pivotal or ~/.pivotal
-  # contains YAML
-  # project: pivotal-id
-  # api: pivotal api key
+    PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
 
-  # NOTE: Is this Windows friendly? Await freak-outs from those users... *crickets*
-  PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
+    attr_accessor :p
 
-  def initialize
-    if config_file
-      @pivotal_info = YAML.load_file config_file
+    def initialize
+      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
 
-    @api_key = config_value "api", 'PIVOTAL_API_KEY'
-    @project_id = config_value "project", 'PIVOTAL_PROJECT_ID'
-  end
+    def create_story_branch
+      begin
+        @p.get_project
+        stories = @p.display_stories :started
+        if stories.length < 1
+          puts "No stories started... exiting"
+          exit
+        end
+        puts "[0] Exit"
+        story   = @p.select_story stories
+        if story
+          @p.create_feature_branch story
+        end
+      rescue RestClient::Unauthorized
+        puts "Pivotal API key or Project ID invalid"
+        return nil
+      end
+    end
 
-  def config_file
-    PIVOTAL_CONFIG_FILES.select{|conf| File.exists? conf}.first
-  end
+    def story_start
+      begin
+        @p.get_project
+        # TODO: Use a predicate for Estimated and Backlog'ed stories
+        stories = @p.display_stories :unstarted
+        puts "[0] Exit"
+        story = @p.select_story stories
+        if story
+          story.update :current_state => "started"
+          puts "#{story.id} started"
+        end
+      rescue RestClient::Unauthorized
+        puts "Pivotal API key or Project ID invalid"
+        return nil
+      end
+    end
 
-  def config_value key, env
-    value = @pivotal_info[key] if @pivotal_info and @pivotal_info[key]
-    value ||= env_required env
-    value
-  end
+    def story_unstart
+      # TODO: unstart a started story.
+    end
+
+    def story_finish
+      begin
+        @p.get_project
+        unless @p.is_current_branch_a_story?
+          puts "Your current branch: #{GitUtils.current_branch}"
+          puts "is not linked to a started story."
+          return
+        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
+        end
+
+        unless GitUtils.has_status? :added or GitUtils.has_status? :staged
+          puts "There are no staged changes."
+          puts "Nothing to do"
+          return
+        end
 
-  def connect
-    begin
-      pivotal_story_branch @api_key, @project_id
-    rescue RestClient::Unauthorized
-      puts "Pivotal API key or Project ID invalid"
-      exit
+        puts "Use standard finishing commit message: [y/N]?"
+        commit_message = "[Finishes ##{GitUtils.current_branch_story_parts[:id]}] #{GitUtils.current_branch_story_parts[:description]}"
+        puts commit_message
+
+        if gets.chomp!.downcase == "y"
+          GitUtils.commit commit_message
+        else
+          puts "Aborted"
+        end
+      rescue RestClient::Unauthorized
+        puts "Pivotal API key or Project ID invalid"
+        return nil
+      end
     end
-  end
 
-  def valid?
-    return (not @api_key.strip.empty? and not @project_id.strip.empty?)
-  end
+    def config_file
+      PIVOTAL_CONFIG_FILES.select{|conf| File.exists? conf}.first
+    end
 
-  private
-  def env_required var_name
-    if ENV[var_name].nil?
-      puts "$#{var_name} must be set or in .story_branch file"
-      exit
+    def config_value key, env
+      value = @pivotal_info[key] if @pivotal_info and @pivotal_info[key]
+      value ||= env_required env
+      value
     end
-    ENV[var_name]
+
+    def env_required var_name
+      if ENV[var_name].nil?
+        puts "$#{var_name} must be set or in .story_branch file"
+        return nil
+      end
+      ENV[var_name]
+    end
+
   end
 
-  def readline prompt, history=[]
-    if history.length > 0
-      history.each {|i| Readline::HISTORY.push i}
+  class StringUtils
+
+    def self.dashed s
+      s.tr(' _,./:;', '-')
     end
-    begin
-      Readline.readline(prompt, false)
-    rescue Interrupt
-      exit
+
+    def self.simple_sanitize s
+      s.tr '\'"%!@#$(){}[]*\\?', ''
     end
-  end
 
-  def dashed s
-    s.tr(' _,./:;', '-')
   end
 
-  def simple_sanitize s
-    s.tr '\'"%!@#$(){}[]*\\?', ''
-  end
+  class GitUtils
 
-  # Branch name validation
-  def validate_branch_name name
-    unless valid_branch_name? name
-      puts "Error: #{name}\nis an invalid name."
-      return false
+    def self.g
+      Git.open "."
     end
-    existing_name_score = is_existing_branch?(name)
-    unless existing_name_score == -1
-      puts <<-END.strip_heredoc
-        Name Collision Error:
 
-        #{name}
+    def self.is_existing_branch? name
+      # we don't use the Git gem's is_local_branch? because we want to
+      # ignore the id suffix while still avoiding name collisions
+      branch_names.each do |n|
+        normalised_branch_name = StringUtils.simple_sanitize(StringUtils.dashed(n.match(/(^.*)(-[1-9][0-9]+$)?/)[1]))
+        levenshtein_distance = Levenshtein.distance normalised_branch_name, name
+        if levenshtein_distance < 2
+          return levenshtein_distance
+        end
+      end
+      return -1
+    end
 
-        This is too similar to the name of an existing
-        branch, a more unique name is required
-      END
+    def self.branch_names
+      g.branches.map(&:name)
     end
-  end
 
-  def valid_branch_name? name
-    # Valid names begin with a letter and are followed by alphanumeric
-    # with _ . - as allowed punctuation
-    valid = /[a-zA-Z][-._0-9a-zA-Z]*/
-    name.match valid
-  end
+    def self.current_branch
+      g.current_branch
+    end
 
-  # Git operations
+    def self.current_story
+      current_branch.match(/(.*)-(\d+$)/)
+    end
 
-  def is_existing_branch? name
-    # we don't use the Git gem's is_local_branch? because we want to
-    # ignore the id suffix while still avoiding name collisions
-    git_branch_names.each do |n|
-      normalised_branch_name = simple_sanitize(dashed(n.match(/(^.*)(-[1-9][0-9]+$)?/)[1]))
-      levenshtein_distance = Levenshtein.distance normalised_branch_name, name
-      if levenshtein_distance < 2
-        return levenshtein_distance
+    def self.current_branch_story_parts
+      matches = current_branch.match(/(.*)-(\d+$)/)
+      if matches.length == 3
+        { description: matches[1], id: matches[2] }
+      else
+        nil
       end
     end
-    return -1
-  end
 
-  def git_branch_names
-    g = Git.open "."
-    g.branches.map(&:name)
-  end
+    def self.create_branch name
+      g.branch(name).create
+      g.branch(name).checkout
+    end
 
-  def git_current_branch
-    g = Git.open "."
-    g.current_branch
-  end
+    def self.status_collect status, regex
+      status.select{|e|
+        e.match(regex)
+      }.map{|e|
+        e.match(regex)[1]
+      }
+    end
 
-  def git_create_branch name
-    g = Git.open "."
-    g.branch(name).create
-    g.branch(name).checkout
-  end
+    def self.status
+      modified_rx  = /^ M (.*)/
+      untracked_rx = /^\?\? (.*)/
+      staged_rx    = /^M  (.*)/
+      added_rx     = /^A  (.*)/
+      status = g.lib.send(:command, "status", "-s").lines
+      return nil if status.length == 0
+      {
+        modified:  status_collect(status, modified_rx),
+        untracked: status_collect(status, untracked_rx),
+        added:     status_collect(status, added_rx),
+        staged:    status_collect(status, staged_rx)
+      }
+    end
 
-  # Use Pivotal tracker API to get Stories
+    def self.has_status? state
+      return false unless status
+      status[state].length > 0
+    end
+
+    def self.commit message
+      g.commit(message)
+    end
 
-  def list_pivotal_stories api_key, project_id
-    PivotalTracker::Client.token = api_key
-    project = PivotalTracker::Project.find(project_id.to_i)
-    stories = project.stories.all({current_state: :started})
-    stories.each_with_index{|s,i| puts "[#{i+1}] ##{s.id} : #{s.name}"}
-    stories
   end
 
-  def select_story stories
-    story_selection = nil
-    while story_selection == nil or story_selection == 0 or story_selection > stories.length + 1
-      puts "invalid selection" if story_selection != nil
-      story_selection = readline("Select a story: ", Range.new(1,stories.length).to_a.map(&:to_s)).to_i
+  class PivotalUtils
+
+    attr_accessor :api_key, :project_id, :project
+
+    def valid?
+      return (not @api_key.nil? and not @project_id.nil?)
     end
-    story = stories[story_selection - 1]
-    puts "Selected : ##{story.id} : #{story.name}"
-    return story
-  end
 
-  def create_feature_branch story
-    current_branch = git_current_branch
-    dashed_story_name = simple_sanitize((dashed story.name).downcase).squeeze("-")
-    feature_branch_name = nil
-    puts "You are checked out at: #{current_branch}"
-    while feature_branch_name == nil or feature_branch_name == ""
-      puts "Provide a new branch name..." if [nil, ""].include? feature_branch_name
-      feature_branch_name = readline("Name of feature branch: ", [dashed_story_name])
-    end
-    feature_branch_name.chomp!
-    validate_branch_name feature_branch_name
-    feature_branch_name_with_story_id = "#{feature_branch_name}-#{story.id}"
-    puts "Creating: #{feature_branch_name_with_story_id} with #{current_branch} as parent"
-    git_create_branch feature_branch_name_with_story_id
-  end
+    def get_project
+      PivotalTracker::Client.token = @api_key
+      @project = PivotalTracker::Project.find @project_id.to_i
+    end
+
+    def is_current_branch_a_story?
+      GitUtils.current_story.length == 3 and
+        filtered_stories_list(:started).map(&:id).include? GitUtils.current_story[2].to_i
+    end
+
+    def story_from_current_branch
+      get_project.stories.find(GitUtils.current_story[2].to_i) if GitUtils.current_story.length == 3
+    end
+
+    # TODO: Add some other predicates as we need them...
+    # Filtering on where a story lives (Backlog, IceBox)
+    # Filtering on tags/labels
+    # Filtering on estimation (estimated?, 0 point, 1 point etc.)
+
+    def filtered_stories_list state
+      project = get_project
+      project.stories.all({current_state: state})
+    end
+
+    def display_stories state
+      filtered_stories_list(state).each_with_index {|s,i| puts one_line_story s, i}
+    end
+
+    def one_line_story s, i
+      "[#{i+1}] ##{s.id} : #{s.name}"
+    end
+
+    def select_story stories
+      story_selection = nil
+      while story_selection == nil or story_selection.to_i > stories.length + 1
+        puts "invalid selection" if story_selection != nil
+        story_texts = Range.new(1,stories.length).to_a.map(&:to_s)
+        story_selection = readline("Select a story: ", story_texts)
+      end
+      if story_selection.to_i == 0
+        return nil
+      end
+      story = stories[story_selection.to_i - 1]
+      puts "Selected : ##{story.id} : #{story.name}"
+      return story
+    end
+
+    def create_feature_branch story
+      dashed_story_name = StringUtils.simple_sanitize((StringUtils.dashed story.name).downcase).squeeze("-")
+      feature_branch_name = nil
+      puts "You are checked out at: #{GitUtils.current_branch}"
+      while feature_branch_name == nil or feature_branch_name == ""
+        puts "Provide a new branch name... (C-p or <up> 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!
+      validate_branch_name feature_branch_name
+      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
+
+    # Branch name validation
+    def validate_branch_name name
+      unless valid_branch_name? name
+        puts "Error: #{name}\nis an invalid name."
+        return false
+      end
+      existing_name_score = GitUtils.is_existing_branch?(name)
+      unless existing_name_score == -1
+        puts <<-END.strip_heredoc
+        Name Collision Error:
+
+        #{name}
+
+        This is too similar to the name of an existing
+        branch, a more unique name is required
+      END
+      end
+    end
+
+    def valid_branch_name? name
+      # Valid names begin with a letter and are followed by alphanumeric
+      # with _ . - as allowed punctuation
+      valid = /[a-zA-Z][-._0-9a-zA-Z]*/
+      name.match valid
+    end
+
+    def readline prompt, history=[]
+      if history.length > 0
+        history.each {|i| Readline::HISTORY.push i}
+      end
+      begin
+        Readline.readline(prompt, false)
+      rescue Interrupt
+      end
+    end
 
-  def pivotal_story_branch api_key, project_id
-    stories = list_pivotal_stories api_key, project_id
-    story = select_story stories
-    create_feature_branch story
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: story_branch
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Milkins
-- Gabe Hollombe
 - Rui Baltazar
 - Dominic Wong
+- Gabe Hollombe
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -59,42 +59,58 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Simple gem that fetches the available stories in your pivotaltracker
   project and allows you to create a git branch with the name based on the selected
   story
 email:
 - jasonm23@gmail.com
-- gabe@neo.com
 - rui.p.baltazar@gmail.com
 - dominic.wong.617@gmail.com
+- gabe@neo.com
 executables:
+- story_start
+- story-start
+- git-start
+- git-story-start
 - story_branch
 - story-branch
 - git-story
 - git-story-branch
 - git-pivotal-story
+- story_finish
+- story-finish
+- git-finish
+- git-story-finish
 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/story-branch
+- bin/story-finish
+- bin/story-start
 - bin/story_branch
+- bin/story_finish
+- bin/story_start
 - lib/story_branch.rb
-homepage: https://github.com/jasonm23/pivotal-story-branch
+homepage: https://github.com/jasonm23/story_branch
 licenses:
 - MIT
 metadata: {}