story_branch 0.1.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f515e7349d6e9e3c97deb9036626e0b609a4961
+  data.tar.gz: 7cf773b74675fd4060b5c7f664b0dd4dcad6d87d
+SHA512:
+  metadata.gz: 1146269635ae3f44f03aae8da7556fb566a65648997ae107aa59531958a800589eccf0129bc2c0661d80ddd7150b6a9910808890f8a780fbb770b9b889022e00
+  data.tar.gz: e39bee90b82d67fd713e9a8155c756b9b9b548f2552c9aaef89a694a9f305ad7561a4f97daa33483c31e5332f46a9d81d95c396b80c3f24b618663fc6428c093

data/LICENCE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Jason Milkins, Gabe Hollombe, Rui Baltazar, Dominic Wong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+[![Gem Version](https://badge.fury.io/rb/story_branch.png)](http://badge.fury.io/rb/story_branch)
+
+# Story Branch
+
+Create a git feature branch with automatic reference to a Pivotal Tracker Story
+
+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.
+
+When picking a story, enter the selection number on the left, using the up
+arrow (or C-p) will scroll through the selection numbers.
+
+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)
+
+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.
+
+## Setup
+
+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`
+
+## Usage
+
+While checked out at your master branch, and located in the git root.
+
+    story_branch
+
+Follow the directions on screen. When the process is finished, you'll
+be switched automatically to the newly created branch.
+
+## Aliases
+
+You can also run story branch using the following aliases.
+
+    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.
+
+## 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.

data/bin/git-pivotal-story

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

data/bin/git-story

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

data/bin/git-story-branch

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

data/bin/story-branch

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

data/bin/story_branch

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

data/lib/story_branch.rb

@@ -0,0 +1,214 @@
+# Name: story_branch (recommend: setting a git alias as "git story")
+#
+# 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>
+#
+# Version: 0.1.8
+#
+# Description:
+#
+# Create a git branch with automatic reference to a Pivotal Tracker
+# Story ID
+#
+# Commentary:
+#
+# 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.
+#
+# When picking a story, enter the selection number on the left (up
+# arrow / C-p will scroll through the numbers)
+#
+# Once a story is selected, a feature branch name must be entered, a
+# suggestion is shown if you press up arrow / C-p
+#
+# Usage:
+#
+# Note: Run story_branch from the project root folder, with the
+# master branch checked out, or an error will be thrown.
+#
+# 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)
+#
+
+require 'yaml'
+require 'pivotal-tracker'
+require 'readline'
+require 'git'
+require 'levenshtein'
+
+class StoryBranch
+
+  # Config file = .pivotal or ~/.pivotal
+  # contains YAML
+  # project: pivotal-id
+  # api: pivotal api key
+
+  # NOTE: Is this Windows friendly? Await freak-outs from those users... *crickets*
+  PIVOTAL_CONFIG_FILES = ['.story_branch',"#{ENV['HOME']}/.story_branch"]
+
+  def initialize
+    if config_file
+      @pivotal_info = YAML.load_file config_file
+    end
+
+    @api_key = config_value "api", 'PIVOTAL_API_KEY'
+    @project_id = config_value "project", 'PIVOTAL_PROJECT_ID'
+  end
+
+  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 and @pivotal_info[key]
+    value ||= env_required env
+    value
+  end
+
+  def connect
+    begin
+      pivotal_story_branch @api_key, @project_id
+    rescue RestClient::Unauthorized
+      puts "Pivotal API key or Project ID invalid"
+      exit
+    end
+  end
+
+  def valid?
+    return (not @api_key.strip.empty? and not @project_id.strip.empty?)
+  end
+
+  private
+  def env_required var_name
+    if ENV[var_name].nil?
+      puts "$#{var_name} must be set or in .story_branch file"
+      exit
+    end
+    ENV[var_name]
+  end
+
+  def readline prompt, history=[]
+    if history.length > 0
+      history.each {|i| Readline::HISTORY.push i}
+    end
+    begin
+      Readline.readline(prompt, false)
+    rescue Interrupt
+      exit
+    end
+  end
+
+  def dashed s
+    s.tr(' _,./:;', '-')
+  end
+
+  def simple_sanitize s
+    s.tr '\'"%!@#$(){}[]*\\?', ''
+  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 = 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
+
+  # Git operations
+
+  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
+      end
+    end
+    return -1
+  end
+
+  def git_branch_names
+    g = Git.open "."
+    g.branches.map(&:name)
+  end
+
+  def git_current_branch
+    g = Git.open "."
+    g.current_branch
+  end
+
+  def git_create_branch name
+    g = Git.open "."
+    g.branch(name).create
+    g.branch(name).checkout
+  end
+
+  # Use Pivotal tracker API to get Stories
+
+  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
+    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 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

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: story_branch
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+platform: ruby
+authors:
+- Jason Milkins
+- Gabe Hollombe
+- Rui Baltazar
+- Dominic Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: levenshtein-ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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
+executables:
+- story_branch
+- story-branch
+- git-story
+- git-story-branch
+- git-pivotal-story
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE
+- README.md
+- bin/git-pivotal-story
+- bin/git-story
+- bin/git-story-branch
+- bin/story-branch
+- bin/story_branch
+- lib/story_branch.rb
+homepage: https://github.com/jasonm23/pivotal-story-branch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Story Branch - create git branches based on pivotal tracker stories
+test_files: []