pivo_flow 0.2.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pivo_flow.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Nowak
+
+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,48 @@
+# PivoFlow
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pivo_flow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pivo_flow
+
+## Usage
+
+All the required information is gathered on demand, but it's a good idea to prepare:
+
+* project's Pivotal Tracker ID
+* your Pivotal Tracker API token
+
+Get list of current stories
+
+    pf stories
+
+Start story with given ID
+
+    pf start STORY_ID
+
+Finish current story [or given story ID]
+
+    pf finish [STORY_ID]
+
+Clear current story without notifying Pivotal
+
+    pf clear
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/pf

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'pivo_flow'
+
+exit PivoFlow::Cli.new(*ARGV)
+

data/bin/pf-prepare-commit-msg

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+story_path = 'tmp/.pivotal_story_id'
+if File.exists?(story_path)
+  story_id = File.read(story_path).strip
+  if story_id =~ /(\d{7,})/
+    puts IO.read(ARGV[0])
+    commit_msg = IO.read(ARGV[0])
+    unless commit_msg.include?($1)
+      File.open(ARGV[0], 'w') do |file|
+        file.print commit_msg
+        file.print "[##{$1}]"
+      end
+    end
+  end
+end

data/lib/pivo_flow/base.rb

@@ -0,0 +1,87 @@
+module PivoFlow
+  class Base
+    GIT_DIR = '.git'
+    KEYS_TO_CHECK = ["test-pivotal.project-id", "test-pivotal.api-token"]
+
+    def initialize(*args)
+      @options = {}
+      @current_dir = Dir.pwd
+      return "no GIT (#{GIT_DIR}) directory found" unless File.directory?(File.join(@current_dir, GIT_DIR))
+
+      # paths
+      @git_dir = File.join(@current_dir, GIT_DIR)
+      @git_hook_path = File.join(@git_dir, 'hooks', 'prepare-commit-msg')
+      @pf_git_hook_name = 'pf-prepare-commit-msg'
+      @pf_git_hook_path = File.join(@git_dir, 'hooks', @pf_git_hook_name)
+
+      @options[:repository] = Grit::Repo.new(@git_dir)
+      install_git_hook if git_hook_needed?
+      git_config_ok? ? parse_git_config : add_git_config
+      run
+    end
+
+    def git_hook_needed?
+      !File.executable?(@git_hook_path) || !File.read(@git_hook_path).match(/\.\/#{@pf_git_hook_name}/)
+    end
+
+    def install_git_hook
+      puts "Installing prepare-commit-msg hook..."
+      hook_path = File.join(File.dirname(__FILE__), '..', '..', 'bin', @pf_git_hook_name)
+      FileUtils.cp(hook_path, @pf_git_hook_path, preserve: true)
+      puts "File copied..."
+      unless File.read(@git_hook_path).match(/\.\/#{@pf_git_hook_name}/)
+        File.open(@git_hook_path, "a") { |f| f.puts("./#{@pf_git_hook_name}") }
+        puts "Reference to pf-prepare-commit-msg added to prepare-commit-msg..."
+      end
+      unless File.executable?(@git_hook_path)
+        FileUtils.chmod 0755, @git_hook_path unless
+        puts "Chmod on #{@git_hook_path} set to 755"
+      end
+
+      puts "Success!\n"
+    end
+
+    def run
+      raise "you should define run!"
+    end
+
+    def user_name
+      @options[:user_name] ||= @options[:repository].config['pivotal.full-name'] || @options[:repository].config['user.name']
+    end
+
+    private
+
+    def git_config_ok?
+      !KEYS_TO_CHECK.any? { |key| @options[:repository].config[key].nil? }
+    end
+
+    def add_git_config
+      ask_question_and_update_config "Pivotal: what is your project's ID?", "test-pivotal.project-id"
+      ask_question_and_update_config "Pivotal: what is your pivotal tracker api-token?", "test-pivotal.api-token"
+      parse_git_config
+    end
+
+    def parse_git_config
+      KEYS_TO_CHECK.each do |key|
+        new_key = key.split(".").last
+        @options[new_key] = @options[:repository].config[key]
+      end
+    end
+
+    def ask_question_and_update_config question, variable
+      @options[:repository].config[variable] ||= ask_question(question)
+    end
+
+    def ask_question question, first_answer = nil
+      h = HighLine.new
+      h.ask("#{question}\t") do |q|
+        q.responses[:ask_on_error] = :question
+        q.responses[:not_valid] = "It can't be empty, sorry"
+        q.validate = ->(id) { !id.empty? }
+        q.first_answer = first_answer
+      end
+    end
+
+  end
+
+end

data/lib/pivo_flow/cli.rb

@@ -0,0 +1,55 @@
+module PivoFlow
+  class Cli
+
+    def initialize *args
+      if args.length.zero?
+        puts "You forgot method name"
+        exit 1
+      end
+      parse_argv(*args)
+    end
+
+    def stories
+      PivoFlow::Pivotal.new.show_stories
+    end
+
+    def start story_id
+      PivoFlow::Pivotal.new.pick_up_story(story_id)
+    end
+
+    def finish story_id=nil
+      file_story_path = File.join(Dir.pwd, "/tmp/.pivotal_story_id")
+      if File.exists? file_story_path
+        story_id = File.open(file_story_path).read.strip
+      end
+      PivoFlow::Pivotal.new.finish_story(story_id)
+    end
+
+    def clear
+      file_story_path = File.join(Dir.pwd, "/tmp/.pivotal_story_id")
+      if File.exists? file_story_path
+        FileUtils.remove_file(file_story_path)
+      end
+      puts "Current pivotal story id cleared."
+    end
+
+    private
+
+    def valid_method? method_name
+      self.methods.include? method_name.to_sym
+    end
+
+    def parse_argv(*args)
+      command = args.first.split.first
+      args = args.slice(1..-1)
+
+      unless valid_method?(command)
+        puts "Ups, no such method..."
+        exit 1
+      end
+      send(command, *args)
+      exit 0
+    end
+
+  end
+end

data/lib/pivo_flow/pivotal.rb

@@ -0,0 +1,129 @@
+# -*- encoding : utf-8 -*-
+module PivoFlow
+  class Pivotal < Base
+
+    def run
+      @story_id_file_name = ".pivotal_story_id"
+      @story_id_tmp_path = File.join(@current_dir, "/tmp")
+      @story_id_file_path = File.join(@story_id_tmp_path, @story_id_file_name)
+
+      return 1 unless @options["api-token"] && @options["project-id"]
+      PivotalTracker::Client.token = @options["api-token"]
+      PivotalTracker::Client.use_ssl = true
+      @options[:project] ||= PivotalTracker::Project.find(@options["project-id"])
+    end
+
+    def user_stories
+      project_stories.select{ |story| story.owned_by == user_name }
+    end
+
+    def project_stories
+      @options[:stories] ||= fetch_stories
+    end
+
+    def unasigned_stories
+      project_stories.select{ |story| story.owned_by == nil }
+    end
+
+    def current_story force = false
+      if (@options[:current_story] && !force)
+        @options[:current_story]
+      else
+        @options[:current_story] = user_stories.count.zero? ? nil : user_stories.first
+      end
+    end
+
+    def list_stories_to_output stories
+      if current_story
+        puts "You've got some started stories, it may be a good idea to finish them in the first place"
+        puts "[##{current_story.id}] #{current_story.name} - #{current_story.description}"
+      end
+
+      HighLine.new.choose do |menu|
+        menu.header = "--- STORIES FROM PIVOTAL TRACKER ---\nWhich one would you like to start?   "
+        menu.prompt = "story no.? "
+        menu.select_by = :index
+        stories.each do |story|
+          vars = {
+            story_id: story.id,
+            requested_by: story.requested_by,
+            name: story.name,
+            story_type: story_type_icon(story),
+            estimate: estimate_points(story)
+          }
+          story_text = "[#%{story_id}] %{story_type} [%{estimate} pts.] (requested by: %{requested_by}) %{name}" % vars
+          story_text += "\n   Description: #{story.description}" unless story.description
+          menu.choice(story_text) { |answer| pick_up_story(answer.match(/\[#(?<id>\d+)\]/)[:id])}
+        end
+      end
+    end
+
+    def story_type_icon story
+      case story.story_type
+        when "feature" then "☆"
+        when "bug" then "☠"
+        when "chore" then "✙"
+        else "☺"
+      end
+    end
+
+    def estimate_points story
+      unless story.estimate.nil?
+        story.estimate < 0 ? "?" : story.estimate
+      else
+        "no"
+      end
+    end
+
+    def pick_up_story story_id
+      save_story_id_to_file(story_id) if start_story(story_id)
+    end
+
+    def update_story story_id, state
+      story = @options[:project].stories.find(story_id)
+      if story.nil?
+        puts "Story not found, sorry."
+      end
+      if story.update(owned_by: user_name, current_state: state).errors.count.zero?
+        puts "Story updated in Pivotal Tracker"
+        true
+      else
+        error_message = "ERROR"
+        error_message += ": #{story.errors.first}"
+        puts error_message
+      end
+    end
+
+    def start_story story_id
+      update_story(story_id, :started)
+    end
+
+    def finish_story story_id
+      remove_story_id_file if story_id.nil? or update_story(story_id, :finished)
+    end
+
+    def remove_story_id_file
+      FileUtils.remove_file(@story_id_file_path)
+    end
+
+    def save_story_id_to_file story_id
+      FileUtils.mkdir_p(@story_id_tmp_path)
+      File.open(@story_id_file_path, 'w') { |f| f.write(story_id) }
+    end
+
+    def show_stories
+      stories = user_stories + unasigned_stories
+      if stories.count.zero?
+        puts "hmm... there is no story assigned to you! I'll better check for unasigned stories!"
+        stories = unasigned_stories
+      end
+      list_stories_to_output stories.first(10)
+    end
+
+    def fetch_stories(count = 100, state = "unstarted,unscheduled")
+      conditions = { current_state: state, limit: count }
+      @options[:stories] = @options[:project].stories.all(conditions)
+    end
+
+  end
+end

data/lib/pivo_flow/version.rb

@@ -0,0 +1,3 @@
+module PivoFlow
+  VERSION = "0.2.0"
+end

data/lib/pivo_flow.rb

@@ -0,0 +1,10 @@
+require 'grit'
+require 'optparse'
+require 'highline'
+require 'fileutils'
+require 'pivotal-tracker'
+
+require 'pivo_flow/version'
+require 'pivo_flow/base'
+require 'pivo_flow/cli'
+require 'pivo_flow/pivotal'

data/pivo_flow.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/pivo_flow/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adam Nowak"]
+  gem.email         = ["lubieniebieski@gmail.com"]
+  gem.description   = %q{Automated querying for pivotal stories, adding story id to commit message, etc.}
+  gem.summary       = %q{Simple pivotal tracker integration for day to day work with git}
+  gem.homepage      = "https://github.com/lubieniebieski/pivo_flow"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "pivo_flow"
+  gem.require_paths = ["lib"]
+  gem.version       = PivoFlow::VERSION
+
+  gem.add_runtime_dependency "pivotal-tracker"
+  gem.add_runtime_dependency "grit"
+  gem.add_runtime_dependency "highline"
+  gem.add_development_dependency "rspec"
+
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: pivo_flow
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Nowak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automated querying for pivotal stories, adding story id to commit message,
+  etc.
+email:
+- lubieniebieski@gmail.com
+executables:
+- pf
+- pf-prepare-commit-msg
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/pf
+- bin/pf-prepare-commit-msg
+- lib/pivo_flow.rb
+- lib/pivo_flow/base.rb
+- lib/pivo_flow/cli.rb
+- lib/pivo_flow/pivotal.rb
+- lib/pivo_flow/version.rb
+- pivo_flow.gemspec
+homepage: https://github.com/lubieniebieski/pivo_flow
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple pivotal tracker integration for day to day work with git
+test_files: []