pt 0.8.6 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93ae006e38a2336e7717d7754d1ff07e7e86162e
-  data.tar.gz: a6f6d11a0f765bb8862b486ac9b96cd3facab79f
+  metadata.gz: 1c872c7de07ff476f016e21cd526a26cde532c61
+  data.tar.gz: 2b5cd00d28ad94fcf20842d6c50b9eb02bf4ef8d
 SHA512:
-  metadata.gz: 739d0a6c02367b3808f71ea867b92cd2937cfcb47a50b429ddace71c7511886fab9aad6e52ef0363dd31b1a500c54e7aa90472d5cc9a5e4bd5b6a97273f67db2
-  data.tar.gz: f283c929e0a18a1be42cd80c9db675be318654e91b0e8a6024e23446564de17a5483b3a1fccaed2ce674d00b7e98a6ff9d249aebe0042e074d6b37ac6497c913
+  metadata.gz: dae2f14490c2b022db21fc2f5408e29365907091b0f41992aa65577f2aeac8b037f41d4487459042ec05aaedba4489c67ae184391b31f571c8abe137de328535
+  data.tar.gz: eccedbf39e375f0389423657e0bf9abab46600211ed377735e91a4b364ac2798422a5269dfc1eebdb44efa246c48f031ff6ba6cefec078d26ab6ca66bccee6a6

data/Changelog.md

@@ -1,5 +1,9 @@
 # pt changelog
 
+## v0.9.0
+- add pagination for long stories (limit: default is 20, can be changed by set :limit: on local .pt file)
+-
+
 ## v0.8.6
 - replace ruby save navigation operator
 ## v0.8.5

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pt.gemspec
 gemspec
+gem 'aruba', '~> 0.14.2'

data/README.md

@@ -15,54 +15,11 @@ The first time you run it, `pt` will ask you some data about your Pivotal Tracke
 
 ## Usage
 
-Run `pt` from the root folder of your project.
-
-```
-  pt                                                                      # show all available stories
-
-  pt todo      <owner>                                                    # show all unscheduled stories
-
-  pt (unscheduled,started,finished,delivered, accepted, rejected) <owner> # show all (unscheduled,started,finished,delivered, accepted, rejected) stories
-
-  pt create    [title] <owner> <type> -m                                  # create a new story (and include description ala git commit)
-
-  pt show      [id]                                                       # shows detailed info about a story
-
-  pt tasks     [id]                                                       # manage tasks of story
-
-  pt open      [id]                                                       # open a story in the browser
-
-  pt assign    [id] <owner>                                               # assign owner
-
-  pt comment   [id] [comment]                                             # add a comment
-
-  pt label     [id] [label]                                               # add a label
-
-  pt estimate  [id] [0-3]                                                 # estimate a story in points scale
-
-  pt (start,finish,deliver,accept)     [id]                               # mark a story as started
-
-  pt reject    [id] [reason]                                              # mark a story as rejected, explaining why
-
-  pt done      [id]  <0-3> <comment>                                      # lazy mans finish story, opens, assigns to you, estimates, finish & delivers
-
-  pt find      [query]                                                    # looks in your stories by title and presents it
-
-  pt list      [owner]                                                    # list all stories for another pt user
-
-  pt list      all                                                        # list all stories for all users
-
-  pt updates                                                              # shows number recent activity from your current project
-
-  pt recent                                                               # shows stories you've recently shown or commented on with pt
-
-  All commands can be run entirely without arguments for a wizard based UI. Otherwise [required] <optional>.
-  Anything that takes an id will also take the num (index) from the pt command.
-```
+Run `pt` from the root folder of your project will show all available command.
 
 ## Problems?
 
-[Open a new issue](https://github.com/raul/pt/issues/new). It can be helpful to include a trace of the requests and responses you're getting from Pivotal Tracker: you can get it by adding the `--debug` parameter while invoking `ptt` (remember to remove all sensible data though).
+[Open a new issue](https://github.com/raul/pt/issues/new). 
 
 ## Contribute
 - `git clone https://github.com/raul/pt.git`

data/bin/pt

@@ -7,4 +7,4 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'pt'
 
-PT::UI.new ARGV
+PT::CLI.start ARGV

data/lib/pt.rb

@@ -3,7 +3,9 @@ require "pt/version"
 require 'pt/client'
 require 'pt/data_row'
 require 'pt/data_table'
-require 'pt/ui'
+require 'pt/action'
+require 'pt/helper'
+require 'pt/cli'
 
 module PT
    # Your code goes here...

data/lib/pt/action.rb

@@ -0,0 +1,151 @@
+module PT
+  module Action
+    def show_story(story)
+      title('========================================='.red)
+      title story.name.red
+      title('========================================='.red)
+      estimation = [-1, nil].include?(story.estimate) ? "Unestimated" : "#{story.estimate} points"
+      requester = story.requested_by ? story.requested_by.initials : @local_config[:user_name]
+      message "#{story.current_state.capitalize} #{story.story_type} | #{estimation} | Req: #{requester} | Owners: #{story.owners.map(&:initials).join(',')} | ID: #{story.id}"
+
+      if story.labels.present?
+        message "Labels: " + story.labels.map(&:name).join(', ')
+      end
+      message story.description.green unless story.description.nil? || story.description.empty?
+      message "View on pivotal: #{story.url}"
+
+      if story.tasks.present?
+        title('tasks'.yellow)
+        story.tasks.each{ |t| compact_message "- #{t.complete ? "[done]" : ""} #{t.description}" }
+      end
+
+
+      story.comments.each do |n|
+        title('......................................'.blue)
+        text = ">> #{n.person.initials}: #{n.text}"
+        text << "[#{n.file_attachment_ids.size}F]" if n.file_attachment_ids
+        message text
+      end
+      save_recent_task( story.id )
+    end
+
+    def tasks_story(story)
+      story_task = get_open_story_task_from_params(story)
+      if story_task.position == -1
+        description = ask('Title for new task')
+        story.create_task(:description => description)
+        congrats("New todo task added to \"#{story.name}\"")
+      else
+        edit_story_task story_task
+      end
+    end
+
+    def open_story story
+      `open #{story.url}`
+    end
+
+    def assign_story story
+      if (owner = find_owner @params[1])
+        @client.assign_task(story, owner)
+      else
+        members = @client.get_members
+        table = PersonsTable.new(members.map(&:person))
+        owner = select("Please select a member to assign him the story", table)
+      end
+
+      congrats("story assigned to #{owner.initials}, thanks!")
+    end
+
+    def comment_story(story)
+      comment = @params[1] || ask("Write your comment")
+      if @client.comment_task(story, comment)
+        congrats("Comment sent, thanks!")
+        save_recent_task( story.id )
+      else
+        error("Ummm, something went wrong.")
+      end
+    end
+
+    def label_story(story)
+      if @params[1]
+        label = @params[1]
+      else
+        label = ask("Which label?")
+      end
+
+      @client.add_label(story, label );
+      show_story(task_by_id_or_pt_id(story.id))
+    end
+
+    def estimate_story(story)
+      estimation ||= ask("How many points you estimate for it? (#{project.point_scale})")
+      @client.estimate_story(story, estimation)
+      congrats("Task estimated, thanks!")
+    end
+
+    def start_story story
+      @client.mark_task_as(story, 'started')
+      congrats("story started, go for it!")
+    end
+
+    def finish_story story
+      if story.story_type == 'chore'
+        @client.mark_task_as(story, 'accepted')
+      else
+        @client.mark_task_as(story, 'finished')
+      end
+      congrats("Another story bites the dust, yeah!")
+    end
+
+    def deliver_story story
+      return if story.story_type == 'chore'
+      @client.mark_task_as(story, 'delivered')
+      congrats("story delivered, congrats!")
+    end
+
+    def accept_story story
+      @client.mark_task_as(story, 'accepted')
+      congrats("Accepted")
+    end
+
+    def reject_story(story)
+      comment = @params[1] || ask("Please explain why are you rejecting the story.")
+      if @client.comment_task(story, comment)
+        @client.mark_task_as(story, 'rejected')
+        congrats("story rejected, thanks!")
+      else
+        error("Ummm, something went wrong.")
+      end
+    end
+
+    def done_story(story)
+      #we need this for finding again later
+      story_id = story.id
+
+      if !@params[1] && story.estimate == -1
+        error("You need to give an estimate for this task")
+        return
+      end
+
+      if @params[1] && story.estimate == -1
+        if [0,1,2,3].include? @params[1].to_i
+          estimate_story(story, @params[1].to_i)
+        end
+        if @params[2]
+          story = task_by_id_or_pt_id story_id
+          @client.comment_task(story, @params[2])
+        end
+      else
+        @client.comment_task(story, @params[1]) if @params[1]
+      end
+
+      start_story story
+
+      finish_story story
+
+      deliver_story story
+    end
+
+  end
+end
+

data/lib/pt/cli.rb

@@ -0,0 +1,183 @@
+require 'yaml'
+require 'colored'
+require 'highline'
+require 'tempfile'
+require 'uri'
+require 'thor'
+module PT
+  class CLI < Thor
+    include PT::Action
+    include PT::Helper
+    attr_reader :project
+
+    def initialize(*args)
+      super
+      @io = HighLine.new
+      @global_config = load_global_config
+      @local_config = load_local_config
+      @client = Client.new(@global_config[:api_number], @local_config)
+      @project = @client.project
+    end
+
+    %w[unscheduled started finished delivered accepted rejected].each do |state|
+      desc "#{state} <owner>", "show all #{state} stories"
+      define_method(state.to_sym) do  |owner = nil|
+        filter =  "state:#{state}"
+        filter << " owner:#{owner}" if owner
+        story = select_story_from_paginated_table do |page|
+          @client.get_stories(filter: filter, page: page)
+        end
+        show_story(story)
+      end
+    end
+
+    %w[show tasks open assign comments label estimate start finish deliver accept reject done].each do |action|
+      desc "#{action} [id]", "#{action} story"
+      define_method(action.to_sym) do |story_id = nil|
+        if story_id
+          story = task_by_id_or_pt_id(story_id.to_i)
+          unless story
+            message("No matches found for '#{story_id}', please use a valid pivotal story Id")
+            return
+          end
+        else
+          method_name = "get_stories_to_#{action}"
+          story = select_story_from_paginated_table do |page|
+            if @client.respond_to?(method_name.to_sym)
+              @client.send("get_stories_to_#{action}", page: page)
+            else
+              @client.get_stories(page: page)
+            end
+          end
+        end
+        title("#{action} '#{story.name}'")
+        send("#{action}_story", story)
+      end
+    end
+
+    desc 'mywork', 'list all your stories'
+    def mywork
+      story = select_story_from_paginated_table do |page|
+        @client.get_stories(filter: "owner:#{@local_config[:user_name]} -state:accepted", page: page)
+      end
+      show_story(story)
+    end
+
+    desc "list [owner]", "list all stories from owner"
+    def list(owner = nil)
+      if owner
+        if owner == "all"
+          stories = @client.get_work
+          TasksTable.new(stories).print @global_config
+        else
+          stories = @client.get_my_work(owner)
+          TasksTable.new(stories).print @global_config
+        end
+      else
+        members = @client.get_members
+        table = MembersTable.new(members)
+        user = select("Please select a member to see his tasks.", table).name
+        title("Work for #{user} in #{project_to_s}")
+        stories = @client.get_my_work(user)
+        TasksTable.new(stories).print @global_config
+      end
+    end
+
+    desc "recent", "show stories you've recently shown or commented on with pt"
+    def recent
+      title("Your recent stories from #{project_to_s}")
+      stories = @project.stories( ids: @local_config[:recent_tasks].join(',') )
+      MultiUserTasksTable.new(stories).print @global_config
+    end
+
+    desc 'create [title] --owner <owner> --type <type> -m', "create a new story (and include description ala git commit)"
+    long_desc <<-LONGDESC
+      create story with title [title]
+
+      --owner, -o  set owner
+
+      --type , -t  set story type
+
+      -m           enable add description using vim
+
+      omit all parameters will start interactive mode
+    LONGDESC
+    option :type, aliases: :t
+    option :owner, aliases: :o
+    option :m, type: :boolean
+    def create(title =nil)
+      owner = options[:owner]
+      type = options[:type]
+      requester_id = @local_config[:user_id]
+      if title
+        name = title
+        owner = owner || @local_config[:user_name]
+        type = task_type_or_nil(owner) || task_type_or_nil(type) || 'feature'
+      else
+        title("Let's create a new task:")
+        name = ask("Name for the new task:")
+      end
+
+      owner = @client.find_member(owner).person.id if owner.kind_of?(String)
+
+      unless owner
+        if ask('Do you want to assign it now? (y/n)').downcase == 'y'
+          members = @client.get_members
+          table = PersonsTable.new(members.map(&:person))
+          owner = select("Please select a member to assign him the task.", table).id
+        else
+          owner = nil
+        end
+        requester = @local_config[:user_name]
+        type = ask('Type? (c)hore, (b)ug, anything else for feature)')
+      end
+
+      type = case type
+             when 'c', 'chore'
+               'chore'
+             when 'b', 'bug'
+               'bug'
+             else
+               'feature'
+             end
+
+      owner_ids = [owner]
+      # did you do a -m so you can add a description?
+      if options[:m]
+        editor = ENV.fetch('EDITOR') { 'vi' }
+        temp_path = "/tmp/editor-#{ Process.pid }.txt"
+        system "#{ editor } #{ temp_path }"
+
+        description = File.read(temp_path)
+      end
+
+      story = @client.create_story(
+        name: name,
+        owner_ids: owner_ids,
+        requested_by_id: requester_id,
+        story_type: type,
+        description: description
+      )
+      congrats("#{type} for #{owner} open #{story.url}")
+      show_story(story)
+    end
+
+    desc "find [query] " ,"looks in your stories by title and presents it"
+    def find(query)
+      story = select_story_from_paginated_table do |page|
+        @client.get_stories(filter: query, page: page)
+      end
+      show_story(story)
+    end
+
+    desc "updates","shows number recent activity from your current project"
+    def updates
+      activities = @client.get_activities
+      tasks = @client.get_my_work
+      title("Recent Activity on #{project_to_s}")
+      activities.each do |activity|
+        show_activity(activity, tasks)
+      end
+    end
+  end
+end

data/lib/pt/client.rb

@@ -7,6 +7,7 @@ module PT
 
     STORY_FIELDS=':default,requested_by,owners,tasks,comments(:default,person,file_attachments)'
 
+    attr_reader :config, :project
 
     def self.get_api_token(email, password)
       PivotalAPI::Me.retrieve(email, password)
@@ -14,9 +15,10 @@ module PT
       raise PT::InputError.new("Bad email/password combination.")
     end
 
-    def initialize(token)
+    def initialize(token, local_config=nil)
       @client = TrackerApi::Client.new(token: token)
-      @project = nil
+      @config = local_config
+      @project = @client.project(local_config[:project_id]) if local_config
     end
 
     def get_project(project_id)
@@ -28,7 +30,7 @@ module PT
       @client.projects
     end
 
-    def get_membership(project, email)
+    def get_membership(email)
       PivotalTracker::Membership.all(project).select{ |m| m.email == email }.first
     end
 
@@ -40,117 +42,125 @@ module PT
       PivotalTracker::Iteration.current(project)
     end
 
-    def get_activities(project, limit)
+    def get_activities
       project.activity
     end
 
-    def get_work(project)
+    def get_work
       project.stories(filter: 'state:unscheduled,unstarted,started', fields: STORY_FIELDS )
     end
 
-    def get_my_work(project, user_name)
-      project.stories(filter: "owner:#{user_name} -state:accepted", limit: 50, fields: STORY_FIELDS)
+    def get_my_work
+      project.stories(filter: "owner:#{config[:user_name]} -state:accepted", limit: 50, fields: STORY_FIELDS)
     end
 
-    def search_for_story(project, query)
-      project.stories(filter: query.to_s ,fields: STORY_FIELDS)
+    def search_for_story(query, params={})
+      params[:filter] =  "#{query}"
+      get_stories(params)
     end
 
-    def get_task_by_id(project, id)
+    def get_task_by_id(id)
       project.story(id, fields: STORY_FIELDS)
     end
     alias :get_story :get_task_by_id
 
-    def get_my_open_tasks(project, user_name)
-      project.stories filter: "owner:#{user_name}", fields: STORY_FIELDS
+    def get_my_open_tasks(params={})
+      params[:filter] =  "owner:#{config[:user_name]}"
+      get_stories(params)
     end
 
-    def get_my_tasks_to_estimate(project, user_name)
-      project.stories( filter: "owner:#{user_name} type:feature estimate:-1", fields: STORY_FIELDS)
+    def get_stories_to_estimate(params={})
+      params[:filter] =  "owner:#{config[:user_name]} type:feature estimate:-1"
+      get_stories(params)
     end
 
-    def get_my_tasks_to_start(project, user_name)
-      tasks = project.stories filter: "owner:#{user_name} state:unscheduled,rejected,unstarted", limit: 50, fields: STORY_FIELDS
-      tasks.reject{ |t| (t.story_type == 'feature') && (t.estimate == -1) }
+    def get_stories_to_start(params={})
+      params[:filter] =  "owner:#{config[:user_name]} type:feature,bug state:unscheduled,rejected,unstarted"
+      tasks = get_stories(params)
+      tasks.reject{ |t| (t.story_type == 'feature') && (!t.estimate) }
     end
 
-    def get_my_tasks_to_finish(project, user_name)
-      project.stories filter: "owner:#{user_name} -state:finished,delivered,accepted,rejected", limit: 50, fields: STORY_FIELDS
+    def get_stories_to_finish(params={})
+      params[:filter] =  "owner:#{config[:user_name]} -state:unscheduled,rejected"
+      get_stories(params)
     end
 
-    def get_my_tasks_to_deliver(project, user_name)
-      project.stories filter: "owner:#{user_name} -state:delivered,accepted,rejected", limit: 50, fields: STORY_FIELDS
+    def get_stories_to_deliver(params={})
+      params[:filter] =  "owner:#{config[:user_name]} -state:delivered,accepted,rejected"
+      get_stories(params)
     end
 
-    def get_my_tasks_to_accept(project, user_name)
-      project.stories filter: "owner:#{user_name} -state:accepted", limit: 50, fields: STORY_FIELDS
+    def get_stories_to_accept(params={})
+      params[:filter] =  "owner:#{config[:user_name]} -state:accepted"
+      get_stories(params)
     end
 
-    def get_my_tasks_to_reject(project, user_name)
-      project.stories filter: "owner:#{user_name} -state:rejected", limit: 50, fields: STORY_FIELDS
+    def get_stories_to_reject(params={})
+      params[:filter] =  "owner:#{config[:user_name]} -state:rejected"
+      get_stories(params)
     end
 
-    def get_tasks_to_assign(project)
-      project.stories filter: "-state:accepted", limit: 50
+    def get_stories_to_assign(params={})
+      params[:filter] =  "-state:accepted"
+      get_stories(params)
     end
 
-    def get_all_stories(project, user_name)
-      project.stories limit: 20, fields: STORY_FIELDS
+    def get_stories(params={})
+      limit = config[:limit] || 20
+      page = params[:page] || 0
+      offset = page*limit
+      filter = params[:filter] || '-state=accepted'
+      project.stories limit: limit, fields: STORY_FIELDS, auto_paginate: false, offset: offset, filter: filter
     end
 
 
-    def get_member(project, query)
+    def get_member(query)
       member = project.memberships.select{ |m| m.person.name.downcase.start_with?(query.downcase) || m.person.initials.downcase == query.downcase }
       member.empty? ? nil : member.first
     end
 
-    def find_member(project, query)
-      memberships = project.memberships.detect do |m|
+    def find_member(query)
+      project.memberships.detect do |m|
         m.person.name.downcase.start_with?(query.downcase) || m.person.initials.downcase == query.downcase
       end
     end
 
-    def get_members(project)
+    def get_members
       project.memberships fields: ':default,person'
     end
 
 
-    def mark_task_as(project, task, state)
-      task = get_story(project, task.id)
+    def mark_task_as(task, state)
+      task = get_story(task.id)
       task.current_state = state
       task.save
     end
 
-    def estimate_task(project, task, points)
-      task = get_story(project, task.id)
+    def estimate_story(task, points)
+      task = get_story(task.id)
       task.estimate = points
       task.save
     end
 
-    def assign_task(project, task, owner)
-      task = get_story(project, task.id)
+    def assign_task(task, owner)
+      task = get_story(task.id)
       task.add_owner(owner)
     end
 
-    def add_label(project, task, label)
-      task = get_story(project, task.id)
+    def add_label(task, label)
+      task = get_story(task.id)
       task.add_label(label)
       task.save
     end
 
-    def comment_task(project, task, comment)
-      task = get_story(project, task.id)
+    def comment_task(task, comment)
+      task = get_story(task.id)
       task.create_comment(text: comment)
     end
 
-    def create_task(project, name, owner_ids, task_type)
-      project.create_story(:name => name, :story_type => task_type, owner_ids: owner_ids)
+    def create_story(args)
+      project.create_story(args)
     end
 
-    def create_task_with_description(project, name, owner, task_type, description)
-      project.create_story(:name => name, :story_type => task_type, :description => description)
-    end
-
-
   end
 end