pivo_flow 0.3.0 → 0.3.3

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+notifications:
+  email:
+    recipients:
+      - lubieniebieski@gmail.com

data/README.md

@@ -1,18 +1,12 @@
 # PivoFlow
 
-TODO: Write a gem description
+[![Build Status](https://secure.travis-ci.org/hybridgroup/taskmapper.png?branch=master)](http://travis-ci.org/hybridgroup/taskmapper)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'pivo_flow'
+PivoFlow let's you choose the story from Pivotal Tracker you are currently working on. Intended for all the people, who doesn't like feature-branch approach or are "merdżuj - nie pier*ol"-theory enthusiasts.
 
-And then execute:
-
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Install it yourself as:
 
     $ gem install pivo_flow
 
@@ -39,10 +33,42 @@ Clear current story without notifying Pivotal
 
     pf clear
 
+Display current gem version
+
+    pf version
+
 ## Git-hooks
 
 This gem installs a `pepare-commit-msg` hook by adding a reference to `pf-prepare-commit-msg` file. In short: you shouldn't be worried about your own `prepare-commit-msg` hook, the one added by `pivo_flow` will be added in the last line of original hook file.
 
+## Roadmap
+
+### Incoming releases
+
+* story statistics
+* colorized output
+
+### 0.3 Current release
+
+* single-story view
+* flow:
+  * select story
+  * read the story description
+  * accept or back to story selection
+* **TODO** `pf info` displaying info about current task, it's comments and all the available data
+* **TODO** `pf help`
+
+### 0.2
+
+* git hoook
+* formatted output
+* bugfixes
+
+### before 0.2
+
+* gem basic structure
+* git config read/write
+
 ## Contributing
 
 1. Fork it
@@ -50,3 +76,7 @@ This gem installs a `pepare-commit-msg` hook by adding a reference to `pf-prepar
 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
+
+## Thanks
+
+This gem is inspired by https://github.com/blindsey/git_pivotal_tracker. Thanks to it's author for the inspiration and idea. If you would like to use Pivotal with feature-branch-based flow, `git_pivotal_tracker` is the way you should proably go.

data/Rakefile

@@ -1,2 +1,5 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/pf

@@ -4,5 +4,5 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'pivo_flow'
 
-exit PivoFlow::Cli.new(*ARGV)
+exit PivoFlow::Cli.new(*ARGV).go!
 

data/lib/pivo_flow/base.rb

@@ -1,13 +1,24 @@
 module PivoFlow
+
+  # This class is responsible for setting up the project environment
+  #
+  # * saving Pivotal Tracker API token and project ID in git repository config
+  # * installing git hook
+
   class Base
+
+    # Git repository directory
     GIT_DIR = '.git'
+    # Keys used by gem in git config, with corresponding questions which are
+    # used during project setup
     KEYS_AND_QUESTIONS = {
       "pivo-flow.project-id"  => "Pivotal: what is your project's ID?",
       "pivo-flow.api-token"   => "Pivotal: what is your pivotal tracker api-token?"
     }
 
-    def initialize(*args)
-      @options = {}
+    # Basic initialize method
+    def initialize(options={})
+      @options = options
       @current_dir = Dir.pwd
 
       # exit if no git repo found
@@ -29,10 +40,16 @@ module PivoFlow
       run
     end
 
+    # Check if git hook is already installed
     def git_hook_needed?
       !File.executable?(@git_hook_path) || !File.read(@git_hook_path).match(/#{@pf_git_hook_name} \$1/)
     end
 
+    # Install git hook
+    # Copy hook to <tt>.git/hooks</tt> directory and add a reference to this
+    # executable file within <tt>prepare-commit-msg</tt> hook (it may be
+    # helpful if user has his custom hooks)
+
     def install_git_hook
       puts "Installing prepare-commit-msg hook..."
       hook_path = File.join(File.dirname(__FILE__), '..', '..', 'bin', @pf_git_hook_name)
@@ -50,22 +67,30 @@ module PivoFlow
       puts "Success!\n"
     end
 
+    # This method is fired after initialization and should be overwritten by
+    # subclasses
     def run
     end
 
+    # Get full user name from git config, i.e. Adam Newman
     def user_name
       @options[:user_name] ||= @options[:repository].config['pivotal.full-name'] || @options[:repository].config['user.name']
     end
 
+    # Setup project by entering Pivotal <tt>api-token</tt> and Pivotal Tracker <tt>project_id</tt>
     def reconfig
       KEYS_AND_QUESTIONS.each do |key, question|
         ask_question_and_force_update_config(question, key)
       end
-      puts "[SUCCESS] Pivotal Tracker configuration has been updated."
+      config_update_success
     end
 
     private
 
+    def config_update_success
+      puts "[SUCCESS] Pivotal Tracker configuration has been updated."
+    end
+
     def git_config_ok?
       !KEYS_AND_QUESTIONS.keys.any? { |key| @options[:repository].config[key].nil? }
     end
@@ -92,6 +117,13 @@ module PivoFlow
       @options[:repository].config[variable] = ask_question(question)
     end
 
+    def update_config_from_options
+      KEYS_AND_QUESTIONS.keys.each do |key|
+        @options[:repository].config[key] = @options[key.gsub(/-/, "_")]
+      end
+      config_update_success
+    end
+
     def ask_question question, first_answer = nil
       h = HighLine.new
       h.ask("#{question}\t") do |q|

data/lib/pivo_flow/cli.rb

@@ -2,37 +2,42 @@ module PivoFlow
   class Cli
 
     def initialize *args
-      if args.length.zero?
-        puts "You forgot method name"
-        exit 1
-      end
+      @file_story_path = File.join(Dir.pwd, "/tmp/.pivotal_story_id")
+      @args = args
+    end
+
+    def go!
       Signal.trap(2) {
         puts "\nkkthxbye!"
-        exit(0)
+        return 0
       }
-      parse_argv(*args)
+      return parse_argv(@args)
     end
 
+    private
+
     def stories
-      PivoFlow::Pivotal.new.show_stories
+      pivotal_object.show_stories
     end
 
-    def start story_id
-      PivoFlow::Pivotal.new.pick_up_story(story_id)
+    def start story_id=nil
+      unless story_id
+        puts "Ok, but which story?"
+        return 1
+      end
+      pivotal_object.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
+      if File.exists? @file_story_path
+        story_id = File.open(@file_story_path).read.strip
       end
-      PivoFlow::Pivotal.new.finish_story(story_id)
+      pivotal_object.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)
+      if File.exists? @file_story_path
+        FileUtils.remove_file(@file_story_path)
       end
       puts "Current pivotal story id cleared."
     end
@@ -45,22 +50,75 @@ module PivoFlow
       puts PivoFlow::VERSION
     end
 
-    private
+    def pivotal_object
+      @pivotal_object ||= PivoFlow::Pivotal.new(@options)
+    end
+
+    def no_method_error
+      puts "You forgot a method name"
+    end
 
-    def valid_method? method_name
-      self.methods.include? method_name.to_sym
+    def invalid_method_error
+      puts "Ups, no such method..."
     end
 
-    def parse_argv(*args)
-      command = args.first.split.first
-      args = args.slice(1..-1)
+    def parse_argv(args)
+      @options = {}
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner =   "Usage: pf <COMMAND> [OPTIONS]\n"
+        opts.separator  "Commands"
+        opts.separator  "     clear:             clears STORY_ID from temp file"
+        opts.separator  "     finish [STORY_ID]: finish story on Pivotal"
+        opts.separator  "     reconfig:          clears API_TOKEN and PROJECT_ID from git config"
+        opts.separator  "     start <STORY_ID>:  start a story of given ID"
+        opts.separator  "     stories:           list stories for current project"
+        opts.separator  ""
+        opts.separator  "Options"
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          return 1
+        end
+
+        opts.on_tail("-v", "--version", "Show version") do
+          puts PivoFlow::VERSION
+          return 1
+        end
+
+        opts.on("-t <API_TOKEN>", "--token <API_TOKEN>", "Sets Pivotal Tracker API TOKEN") do |api_token|
+          @options[:api_token] = api_token
+        end
+
+        opts.on("-p <PROJECT_ID>", "--project <PROJECT_ID>", Numeric, "Sets Pivotal Tracker PROJECT_ID") do |project_id|
+          @options[:project_id] = project_id
+        end
 
-      unless valid_method?(command)
-        puts "Ups, no such method..."
-        exit 1
       end
-      send(command, *args)
-      exit 0
+
+      opt_parser.parse!(args)
+
+      case args[0]
+      when "clear"
+        clear
+      when "reconfig"
+        reconfig
+      when "start"
+        start args[1]
+      when "stories"
+        stories
+      when "finish"
+        finish args[1]
+      when nil
+        no_method_error
+        puts opt_parser.summarize
+        return 1
+      else
+        invalid_method_error
+        return 1
+      end
+      return 0
+
     end
 
   end

data/lib/pivo_flow/pivotal.rb

@@ -68,7 +68,6 @@ module PivoFlow
       end
     end
 
-
     def find_story story_id
       story = project_stories.find { |p| p.id == story_id }
       story.nil? ? @options[:project].stories.find(story_id) : story

data/lib/pivo_flow/version.rb

@@ -1,3 +1,3 @@
 module PivoFlow
-  VERSION = "0.3.0"
+  VERSION = "0.3.3"
 end

data/pivo_flow.gemspec

@@ -19,5 +19,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "grit"
   gem.add_runtime_dependency "highline"
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "rake"
 
 end

data/spec/pivo_flow/cli_spec.rb

@@ -0,0 +1,73 @@
+require_relative './../../lib/pivo_flow/cli'
+
+describe PivoFlow::Cli do
+
+  before(:each) do
+    # we don't need cli output all over the specs
+    PivoFlow::Cli.any_instance.stub(:puts)
+  end
+
+  describe "with no args provided" do
+
+    let(:command) { PivoFlow::Cli.new.go! }
+
+    before(:each) do
+      PivoFlow::Cli.any_instance.should_receive(:no_method_error).and_return(true)
+    end
+
+    it "calls no_method_error message " do
+      command
+    end
+
+    it "returns 1" do
+      expect(command).to eq 1
+    end
+
+  end
+
+  describe "on invalid command" do
+
+    let(:command) { PivoFlow::Cli.new("invalid_method_name").go! }
+
+    before(:each) do
+      PivoFlow::Cli.any_instance.should_receive(:invalid_method_error)
+    end
+
+    it "calls invalid_method_error message" do
+      command
+    end
+
+    it "returns 1" do
+      expect(command).to eq 1
+    end
+
+  end
+
+  describe "with valid command" do
+    cmd = "stories"
+    let(:command) { PivoFlow::Cli.new(cmd).go! }
+
+    before do
+      PivoFlow::Cli.any_instance.should_receive(cmd.to_sym)
+    end
+
+    it "runs this command if it is public" do
+      command
+    end
+
+    it "returns 0" do
+      expect(command).to eq 0
+    end
+
+  end
+
+  it "should allow to execute given commands" do
+    methods = [:stories, :start, :finish, :clear, :reconfig]
+
+    methods.each do |method|
+      PivoFlow::Cli.any_instance.stub(method)
+      PivoFlow::Cli.new(method.to_s).go!.should eq 0
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'simplecov'
+SimpleCov.start
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'pivo_flow'
+require 'rspec'
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pivo_flow
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pivotal-tracker
@@ -75,6 +75,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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:
@@ -86,6 +118,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -98,6 +132,7 @@ files:
 - lib/pivo_flow/pivotal.rb
 - lib/pivo_flow/version.rb
 - pivo_flow.gemspec
+- spec/pivo_flow/cli_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/lubieniebieski/pivo_flow
 licenses: []
@@ -124,4 +159,6 @@ signing_key:
 specification_version: 3
 summary: Simple pivotal tracker integration for day to day work with git
 test_files:
+- spec/pivo_flow/cli_spec.rb
 - spec/spec_helper.rb
+has_rdoc: