git-routines 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58d64892849a8a45ed2ad5e96c9f8afff84ac8f5
+  data.tar.gz: 1928d6fff597db051bf12b60d7a67a5cf0e3fc92
+SHA512:
+  metadata.gz: 990f4c4ff2f8b481feef73c4c7e8aaba24be4be873f8997fc8043fa8c00ad255b60fb2594e583a768f592184c8dc378ec33a8cad56bb5b69067da330e082aa50
+  data.tar.gz: 81017e49ae000ce43e31a22274f4f35aa0471aaab97ec9edb560180a54bf2ab14a9557764e0133cf0d00abd8d6ccfa5082b30518daf95aa6f4b0376d361afd01

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+
+## 0.3.0
+
+* Gave it a (new) name
+
+
+## 0.2.1
+
+* #2: A Chore story in PivotalTracker needs to be set to “accepted” rather than “finished”
+
+
+## 0.2.0
+
+* Set PivotalTracker story to finished when done
+
+
+## 0.1.0
+
+* Basic workflow
+* Plugin infrastructure
+* GitHub pull requests
+* PivotalTracker story integration

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nico Hagenburger
+
+MIT License
+
+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,51 @@
+# Git-Routines
+
+`git start`—a Git workflow helper that:
+
+* Shows all your PivotalTracker stories
+* Creates feature/bug/chore branches (e.g. feature/4711-create-profile) for a chosen story
+  **Bonus:** you can also create a new story in the command line
+* Asks to estimate the story if needed
+* Sets the story started
+* _Optional:_ Outputs a summary of the story to the command line (incl. description, tasks, and link to story)
+
+`git finish`—to call after you finished the story:
+
+* Sets the story finished
+* _Optional:_ Rebases the current branch to your *master* branch
+* Pushes the branch
+* _Optional:_ Opens a GitHub pull request (incl. link to the corresponding PivotalTracker story)
+* Checks out *master*
+
+The first questions will only be asked once:
+![git-routines-demo](https://cloud.githubusercontent.com/assets/103399/5758653/6e2229c4-9cc7-11e4-9b49-c05e87817499.png)
+![git-routines-pull-request](https://cloud.githubusercontent.com/assets/103399/5758752/5f7af6de-9cc8-11e4-8e04-f968ee6acf94.png)
+
+## Setup
+
+```
+gem install git-routines
+```
+
+Other configuration happens on the fly. All information will be requested when needed.
+
+
+## Work in Progress
+
+This is brand new but at [Homify](https://www.homify.co.uk) we’re using it for our workflows. It is mostly done, feedback is welcome, and [GitHub issues integration](https://github.com/hagenburger/git-routines/issues/1) as alternative to PivotalTracker is in the planning. Other tools should be easy to integrate. Have a look into the source or ping me [on Twitter](https://twitter.com/hagenburger). If you have a better name for this, let me know ;)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'add some awesome feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+## Copyright
+
+Copyright 2015 [Nico Hagenburger](http://www.hagenburger.net).
+See [MIT-LICENSE.txt](MIT-LICENSE.txt) for details.
+Get in touch with [@hagenburger](http://twitter.com/hagenburger) on Twitter or [open an issue](https://github.com/hagenburger/git-routines/issues/new).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/git-finish

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'git-routines'
+
+GitRoutines.finish

data/bin/git-start

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'git-routines'
+
+GitRoutines.start

data/git-start.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-routines/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'git-routines'
+  spec.version       = Git::Routines::VERSION
+  spec.authors       = ['Nico Hagenburger']
+  spec.email         = ['nico@hagenburger.net']
+  spec.summary       = %q{Connects Git with project management software}
+  spec.description   = %q{Connects Git with project management software}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hooks'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/git-routines.rb

@@ -0,0 +1,139 @@
+require 'git-routines/version'
+require 'hooks'
+require 'fileutils'
+
+PLUGINS = {
+  'show-summary' => 'Show story summary after starting',
+  'pivotal' => 'PivotalTracker integration',
+  'rebase' => 'Rebase to default branch before finishing',
+  'pull-request' => 'Open pull request after finishing',
+}
+
+class GitRoutines
+  include Hooks
+  include Hooks::InstanceHooks
+
+  define_hook :setup
+  define_hook :before_start
+  define_hook :after_start
+  define_hook :before_finish
+  define_hook :after_finish
+
+  class << self
+    attr_accessor :default_branch
+    attr_accessor :title
+    attr_accessor :summary
+
+    def start
+      run_hook :setup
+      run_hook :before_start
+      git :checkout, "-b #{branch}"
+      run_hook :after_start
+    end
+
+    def finish
+      @branch = current_branch
+      run_hook :setup
+      run_hook :before_finish
+      git :checkout, default_branch
+      run_hook :after_finish
+    end
+
+    def branch
+      @branch ||= ask_for('Branch name')
+      @branch.strip.downcase.gsub(/[^\w\d\/]+/, '-')
+    end
+
+    def default_branch
+      @default_branch ||= config(
+        'git-start.default-branch',
+        'Default branch name',
+        :local,
+        'master'
+      )
+    end
+
+    def ask_for(question, default = nil)
+      print "#{question}#{" [#{default}]" unless default.nil?}: "
+      value = STDIN.readline.strip
+      value == '' ? default : value
+    end
+
+    def select_multiple_of(question, *option_lists)
+      select_of("#{question} (comma separated)", *option_lists)
+    end
+
+    def select_one_of(question, *option_lists)
+      select_of(question, *option_lists).first
+    end
+
+    def git(command, *options)
+      `git #{command} #{options.map{ |o| o.is_a?(Symbol) ? "--#{o}" : o}.join(' ')}`
+    end
+
+    def config(key, question = nil, scope = nil, default = nil)
+      value = git(:config, key).strip
+      if value == '' and !question.nil?
+        value = ask_for(question, default)
+        git :config, scope, key, value
+      end
+      value
+    end
+
+    def requires_gem(name)
+      require name
+    rescue LoadError
+      abort "\nPlease install the `#{name}` Gem first:\n\ngem install #{name}\n\n"
+    end
+
+    def include_plugin(plugin)
+      @included_plugins ||= []
+      return if @included_plugins.include?(plugin)
+      @included_plugins << plugin
+      file = File.expand_path("../git-routines/plugins/#{plugin}.rb", __FILE__)
+      instance_eval File.read(file)
+    end
+
+    def current_branch
+      `git rev-parse --abbrev-ref HEAD`.strip
+    end
+
+    private
+
+    def select_of(question, *option_lists)
+      list_options *option_lists
+      choice = ask_for(question)
+      abort 'Command aborted.' if choice.nil?
+      choice.split(',').map do |item|
+        item =~ /^\d+$/ ? item.to_i - 1 : item.to_sym
+      end
+    end
+
+    def list_options(*option_lists)
+      option_lists.each do |list|
+        next unless list.any?
+        puts "\n"
+        list.each_with_index do |a, b|
+          key, value = list.is_a?(Hash) ? [a[0], a[1]] : [b + 1, a]
+          puts "[#{key}]".to_s.rjust(@column_size) + " #{value}"
+        end
+      end
+      puts "\n"
+    end
+  end
+
+  setup do
+    @column_size = 5
+    plugins = config('git-routines.plugins').strip.split(',')
+    if plugins.empty?
+      question = 'Choose plugins (comma separated)'
+      select_multiple_of(question, PLUGINS.values).each do |index|
+        plugins << PLUGINS.keys[index]
+      end
+      git :config, :local, 'git-routines.plugins', plugins.join(',')
+    end
+    plugins.each do |plugin|
+      include_plugin plugin
+    end
+  end
+end

data/lib/git-routines/plugins/github.rb

@@ -0,0 +1,8 @@
+requires_gem 'octokit'
+
+setup do
+  remote_url = config('remote.origin.url')
+  @github_repo = remote_url.match(/(?<=:).+(?=\.git)/).to_s
+  @github_token = config('github.token', 'Your GitHub API token')
+  @github = Octokit::Client.new(access_token: @github_token)
+end

data/lib/git-routines/plugins/pivotal.rb

@@ -0,0 +1,121 @@
+requires_gem 'tracker_api'
+
+# TrackerApi does not support saving yet
+class ::TrackerApi::Client
+  def put(path, options = {})
+    request(:put, parse_query_and_convenience_headers(path, options))
+  end
+end
+
+setup do
+  @story_types = { f: :feature, b: :bug, c: :chore }
+  @tracker_token = config('pivotal.token', 'Your PivotalTracker API token', :global)
+  @user_initials = config('pivotal.user', 'Your PivotalTracker user initials', :global).upcase
+  @project_id = config('pivotal.project', 'PivotalTracker project ID (last part of URL)', :local)
+  @tracker = TrackerApi::Client.new(token: @tracker_token)
+  @project = @tracker.project(@project_id)
+  @user_id = user_id_of(@user_initials)
+end
+
+before_start do
+  select_story
+  @branch = "#{@story.story_type.downcase}/#{@story.id}-#{@story.name}"
+  @title = @story.name
+  @summary = generate_summary
+end
+
+after_start do
+  update_story @story.id, current_state: :started
+end
+
+before_finish do
+  @story_id = branch.match(/(?<=feature\/|chore\/|bug\/)(\d+)(?=-)/).to_s.to_i
+  @story = @project.story(@story_id)
+  @title = @story.name
+  @summary = generate_summary
+end
+
+after_finish do
+  new_state = @story.story_type == 'chore' ? 'accepted' : 'finished'
+  update_story @story.id, current_state: new_state
+end
+
+
+def generate_summary
+  <<-MARKDOWN.gsub(/^    /, '').gsub(/\n+/, "\n\n")
+    # #{@story.name}
+    #{@story.description}
+    #{@story.tasks.map{ |t| "  * #{t.description}" }.join("\n") rescue ''}
+    <#{@story.url}>
+  MARKDOWN
+end
+
+def stories
+  @stories ||= @project.stories(filter: filter, limit: 999)
+end
+
+def filter
+  "current_state:unscheduled,unstarted,rejected mywork:#{@user_initials}"
+end
+
+def select_story
+  existing_stories = stories.map do |s|
+    s.story_type.upcase.ljust(9) + s.name
+  end
+  new_story_types = @story_types.inject({}) do |h, (key, type)|
+    h.update(key => type.to_s.upcase.ljust(9) + "Create new #{type} story")
+  end
+  choice = select_one_of('Select story', existing_stories, new_story_types)
+
+  if @story_types.has_key?(choice)
+    @story = create_story(@story_types[choice])
+  else
+    if choice >= 0 and choice < stories.length
+      @story = stories[choice]
+    else
+      abort "No valid story selected."
+    end
+  end
+  estimate if needs_estimation?
+end
+
+def needs_estimation?
+  @story.estimate.nil? &&
+  @story.story_type == 'feature' || @project.bugs_and_chores_are_estimatable
+end
+
+def estimate
+  scale = @project.point_scale.gsub(',', ', ')
+  estimate = ask_for("This story needs an estimate first [#{scale}]")
+  update_story @story.id, estimate: estimate
+end
+
+def update_story(id, attributes)
+  @tracker.put "/projects/#{@project_id}/stories/#{id}", params: attributes
+end
+
+def user_id_of(initials)
+  membership = @project.memberships.detect{ |m| m.person.initials == initials }
+  if membership.nil?
+    abort "User with initials #{initials} not found for this project."
+  end
+  membership.person.id
+end
+
+def create_story(type)
+  params = {
+    name: ask_for('Story title'),
+    description: ask_for('Story description'),
+    requested_by_id: requester_id,
+    owner_ids: [@user_id],
+    story_type: type
+  }
+  data = @tracker.post("/projects/#{@project_id}/stories", params: params).body
+  TrackerApi::Resources::Story.new({ client: @client }.merge(data))
+end
+
+def requester_id
+  question = 'Story requester initials'
+  initials = config('pivotal.requester', question, :local, @user_initials).upcase
+  user_id_of(initials)
+end

data/lib/git-routines/plugins/pull-request.rb

@@ -0,0 +1,5 @@
+include_plugin 'github'
+
+after_finish do
+  @github.create_pull_request @github_repo, 'master', branch, title, summary
+end

data/lib/git-routines/plugins/rebase.rb

@@ -0,0 +1,7 @@
+before_finish do
+  git :checkout, default_branch
+  git :pull
+  git :checkout, branch
+  git :rebase, default_branch
+  git :push, 'origin', branch, :force
+end

data/lib/git-routines/plugins/show-summary.rb

@@ -0,0 +1,6 @@
+after_start do
+  unless summary.nil?
+    text = summary.strip.gsub(/^#+ *(.+)/){ $1.upcase }.gsub(/<(http.+)>/, '\\1')
+    puts "\n#{'-' * @column_size}\n\n#{text}\n\n#{'-' * @column_size}\n\n"
+  end
+end

data/lib/git-routines/version.rb

@@ -0,0 +1,5 @@
+module Git
+  module Routines
+    VERSION = "0.3.0"
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: git-routines
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Nico Hagenburger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Connects Git with project management software
+email:
+- nico@hagenburger.net
+executables:
+- git-finish
+- git-start
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/git-finish
+- bin/git-start
+- git-start.gemspec
+- lib/git-routines.rb
+- lib/git-routines/plugins/github.rb
+- lib/git-routines/plugins/pivotal.rb
+- lib/git-routines/plugins/pull-request.rb
+- lib/git-routines/plugins/rebase.rb
+- lib/git-routines/plugins/show-summary.rb
+- lib/git-routines/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Connects Git with project management software
+test_files: []