gradesfirst 0.2.1 → 0.3.0

data/.gitignore

@@ -1,3 +1,4 @@
 *.gem
 *.swp
 .rvmrc
+*.swo

data/Gemfile

@@ -2,8 +2,7 @@ source "https://rubygems.org"
 
 gem 'rake'
 gem 'minitest', '~> 4.7.0'
-gem 'thor', '~> 0.14.6'
+gem 'thor', '~> 0.18.1'
 gem 'webmock', '~> 1.16.0'
-gem 'mocha'
 gem 'pry'
 gem 'pry-debugger'

data/Gemfile.lock

@@ -12,11 +12,8 @@ GEM
       debugger-ruby_core_source (~> 1.2.4)
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.4)
-    metaclass (0.0.1)
     method_source (0.8.2)
     minitest (4.7.5)
-    mocha (0.14.0)
-      metaclass (~> 0.0.1)
     pry (0.9.12.4)
       coderay (~> 1.0)
       method_source (~> 0.8)
@@ -27,7 +24,7 @@ GEM
     rake (10.0.2)
     safe_yaml (0.9.7)
     slop (3.4.7)
-    thor (0.14.6)
+    thor (0.18.1)
     webmock (1.16.0)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -37,9 +34,8 @@ PLATFORMS
 
 DEPENDENCIES
   minitest (~> 4.7.0)
-  mocha
   pry
   pry-debugger
   rake
-  thor (~> 0.14.6)
+  thor (~> 0.18.1)
   webmock (~> 1.16.0)

data/gradesfirst.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = "gradesfirst"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
   s.summary = "GradesFirst command line utility for developers."
   s.description = "This utility will help manage the various tasks developers need to do on their workstation such as database updates."
   s.license = "MIT"
@@ -22,6 +22,6 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_dependency('thor', '~> 0.14.6')
+  s.add_dependency('thor', '~> 0.18.1')
   s.add_development_dependency('minitest', '~> 4.7.0')
 end

data/lib/gradesfirst.rb

@@ -1,2 +1,3 @@
 module GradesFirst
+  TAB = '  '
 end

data/lib/gradesfirst/cli.rb

@@ -1,53 +1,31 @@
 require 'thor'
 
+require 'gradesfirst/cli_helper'
 require 'gradesfirst/command'
 require 'gradesfirst/branch_command'
 require 'gradesfirst/commit_message_command'
-require 'gradesfirst/task_command'
+require 'gradesfirst/task_cli'
 
 require 'pivotal_tracker'
 
 module GradesFirst
   class CLI < Thor
+    include GradesFirst::CliHelper
 
     desc 'branch', GradesFirst::BranchCommand.description
     def branch
       set_pivotal_tracker_api_token
-      execute(GradesFirst::BranchCommand.new)
+      execute(GradesFirst::BranchCommand)
     end
 
     desc 'commit-message', GradesFirst::CommitMessageCommand.description
     def commit_message
       set_pivotal_tracker_api_token
-      execute(GradesFirst::CommitMessageCommand.new)
+      execute(GradesFirst::CommitMessageCommand)
     end
 
-    desc 'task', GradesFirst::TaskCommand.description
-    def task
-      set_pivotal_tracker_api_token
-      execute(GradesFirst::TaskCommand.new)
-    end
-
-    private
-
-    def execute(command)
-      command.execute
-      say command.response
-    end
-
-    def set_pivotal_tracker_api_token
-      file_name = "#{Dir.home}/.pivotal_tracker_api_key"
-      if File.exists?(file_name)
-        api_token = File.read(file_name)
-      else
-        api_token = ask('Enter your PivotalTracker API token:')
-        File.open(file_name, 'w') do |file|
-          file.write(api_token)
-        end
-      end
-
-      PivotalTracker.api_token = api_token
-    end
+    desc 'task COMMAND', 'Manage tasks related to a PivotalTracker story.'
+    subcommand 'task', GradesFirst::TaskCLI
 
     Signal.trap('SIGINT') do
       print "\n"

data/lib/gradesfirst/cli_helper.rb

@@ -0,0 +1,33 @@
+module GradesFirst
+
+  # Helper methods used across multiple Thor CLI commands and subcommands.
+  module CliHelper
+    private
+
+    # Executes a command that conforms to the GradesFirst Command pattern
+    # interface.
+    def execute(klass, *args)
+      command = klass.new
+      command.execute(*args)
+      say command.response
+    end
+
+    # Set the PivotalTracker api token to authenticate the current user.
+    # If the user is access PivotalTracker for the first time then they will
+    # be prompted to enter their api token and it will be saved for later use.
+    def set_pivotal_tracker_api_token
+      file_name = "#{Dir.home}/.pivotal_tracker_api_key"
+      if File.exists?(file_name)
+        api_token = File.read(file_name)
+      else
+        api_token = ask('Enter your PivotalTracker API token:')
+        File.open(file_name, 'w') do |file|
+          file.write(api_token)
+        end
+      end
+
+      PivotalTracker.api_token = api_token
+    end
+
+  end
+end

data/lib/gradesfirst/command.rb

@@ -1,3 +1,5 @@
+require 'gradesfirst'
+
 module GradesFirst
 
   # Base class for all command objects.
@@ -10,6 +12,11 @@ module GradesFirst
       `git rev-parse --abbrev-ref HEAD`
     end
 
+    # Retrieves the current story
+    def current_story
+      PivotalTracker.stories[story_id].get
+    end
+
     # Extracts a PivotalTracker story id from a branch if one is present.
     def story_id(branch = current_branch)
       if branch =~ /[0-9]+$/

data/lib/gradesfirst/commit_message_command.rb

@@ -15,7 +15,7 @@ module GradesFirst
 
     # Performs the gf commit-message Thor command.
     def execute
-      @story = PivotalTracker.stories[story_id].get
+      @story = current_story
     end
 
     # Output response of the gf commit-message Thor command in the standard

data/lib/gradesfirst/task_add_command.rb

@@ -0,0 +1,51 @@
+require 'gradesfirst/task_command'
+
+module GradesFirst
+
+  # Implementation of a Thor command for adding tasks to PivotalTracker stories.
+  class TaskAddCommand < GradesFirst::TaskCommand
+    # Description of the "gf task add" Thor command that will be used in
+    # the commandline help.
+    def self.description
+      'Add a task to a PivotalTracker story.'
+    end
+
+    # Performs the gf task add Thor command.
+    def execute(description)
+      @story = current_story
+      if @story
+        @success = task_add(@story, description)
+      end
+    end
+
+    # Generates the command line output response.  The output of the task add
+    # command is a completion status message which may be followed by the new
+    # list of tasks if the task was added successfully.
+    def response
+      task_action_response(@story, @success)
+    end
+
+    private
+
+    def story_error_message
+      'Tasks cannot be created for this branch.'
+    end
+
+    def task_add(story, description)
+      PivotalTracker.
+        projects[story['project_id']].
+        stories[story['id']].
+        tasks.
+        post(description: description)
+    end
+
+    def task_error_message
+      'Creation of the task failed.'
+    end
+
+    def task_success_message
+      'Task was successfully added.'
+    end
+  end
+
+end

data/lib/gradesfirst/task_cli.rb

@@ -0,0 +1,48 @@
+require 'gradesfirst/cli_helper'
+require 'gradesfirst/task_add_command'
+require 'gradesfirst/task_delete_command'
+require 'gradesfirst/task_list_command'
+require 'gradesfirst/task_move_command'
+require 'gradesfirst/task_toggle_command'
+
+module GradesFirst
+  class TaskCLI < Thor
+    include GradesFirst::CliHelper
+
+    namespace :task
+    # Waiting on fix for subcommands with default command.
+    # https://github.com/erikhuda/thor/pull/374
+    #default_command :list
+
+    desc 'add DESCRIPTION', GradesFirst::TaskAddCommand.description
+    def add(description)
+      set_pivotal_tracker_api_token
+      execute(GradesFirst::TaskAddCommand, description)
+    end
+
+    desc 'delete POSITION', GradesFirst::TaskDeleteCommand.description
+    def delete(position)
+      set_pivotal_tracker_api_token
+      execute(GradesFirst::TaskDeleteCommand, position)
+    end
+
+    desc 'list', GradesFirst::TaskListCommand.description
+    def list
+      set_pivotal_tracker_api_token
+      execute(GradesFirst::TaskListCommand)
+    end
+
+    desc 'move FROM TO', GradesFirst::TaskMoveCommand.description
+    def move(from, to)
+      set_pivotal_tracker_api_token
+      execute(GradesFirst::TaskMoveCommand, from , to)
+    end
+
+    desc 'toggle POSITION', GradesFirst::TaskToggleCommand.description
+    def toggle(position)
+      set_pivotal_tracker_api_token
+      execute(GradesFirst::TaskToggleCommand, position)
+    end
+
+  end
+end

data/lib/gradesfirst/task_command.rb

@@ -1,47 +1,55 @@
 require 'gradesfirst/command'
 
 module GradesFirst
-
-  # Implementation of a Thor command for managing tasks related to a story.
   class TaskCommand < GradesFirst::Command
+    private
 
-    # Description of the gf branch Thor command that will be used in the
-    # command line help.
-    def self.description
-      'List the tasks related to a PivotalTracker story.'
+    def get_task_id_by_position(story, position)
+      task = get_task_by_position(story, position)
+      task['id'] if task
     end
 
-    # Performs the gf tasks Thor command.
-    def execute
-      @story = PivotalTracker.stories[story_id].get
-      if @story
-        project_id = @story['project_id']
-        @tasks = PivotalTracker.projects[project_id].stories[story_id].tasks.get
-      end
+    def get_task_by_position(story, position)
+      get_tasks(story).find { |t| t['position'] == position.to_i }
     end
 
-    # Generates the comand line output response.  The output of the task command
-    # is a list of the tasks associated with the PivotalTracker story associated
-    # with the current branch.
-    def response
-      if @tasks.nil?
-        error_message
-      else
-        task_list = @tasks.map do |t|
-          "  [#{t["complete"] ? 'X' : ' '}] #{t["description"]}"
-        end
-        story_line + task_list.join("\n") + "\n"
-      end
+    def get_tasks(story)
+      PivotalTracker.
+        projects[story['project_id']].
+        stories[story['id']].
+        tasks.
+        get
     end
 
-    private
+    def position(task)
+      task['position'].to_s.rjust(2)
+    end
+
+    def story_line(story)
+      "#{TAB}#{story['name']} (#{story['url']})\n\n"
+    end
 
-    def error_message
-      'Tasks cannot be retrieved for this branch.'
+    # Generates the commandline output response for actions taken on tasks like
+    # add and delete.
+    def task_action_response(story, success)
+      if story.nil?
+        story_error_message
+      elsif !success
+        task_error_message
+      else
+        tasks = get_tasks(story)
+        [
+          TAB + task_success_message,
+          task_list_response(story, tasks)
+        ].join("\n\n")
+      end
     end
 
-    def story_line
-      "  #{@story['name']} (#{@story['url']})\n\n"
+    def task_list_response(story, tasks)
+      task_list = tasks.map do |t|
+        "#{TAB}#{position(t)}. [#{t["complete"] ? 'X' : ' '}] #{t["description"]}"
+      end
+      story_line(story) + task_list.join("\n") + "\n"
     end
   end
 end

data/lib/gradesfirst/task_delete_command.rb

@@ -0,0 +1,64 @@
+require 'gradesfirst/task_command'
+
+module GradesFirst
+
+  # Implementation of a Thor command for deleting tasks from PivotalTracker
+  # stories.
+  class TaskDeleteCommand < GradesFirst::TaskCommand
+    # Description of the "gf task delete" Thor command that will be used in
+    # the commandline help.
+    def self.description
+      'Delete a task from a PivotalTracker story.'
+    end
+
+    # Performs the gf task delete POSITION Thor command.
+    def execute(position)
+      @story = current_story
+      if @story
+        task_id = get_task_id_by_position(@story, position)
+        if task_id
+          @success = task_delete(@story, task_id)
+        else
+          @task_position_invalid = true
+        end
+      end
+    end
+
+    # Generates the command line output response.  The output of the task delete
+    # command is a completion status message which may be followed by the new
+    # list of tasks if the task was deleted successfully.
+    def response
+      if @task_position_invalid
+        position_invalid_message
+      else
+        task_action_response(@story, @success)
+      end
+    end
+
+    private
+
+    def position_invalid_message
+      'Task position given does not exist.'
+    end
+
+    def story_error_message
+      'Tasks cannot be deleted for this branch.'
+    end
+
+    def task_delete(story, task_id)
+      PivotalTracker.
+        projects[story['project_id']].
+        stories[story['id']].
+        tasks[task_id].
+        delete
+    end
+
+    def task_error_message
+      'Deletion of the task failed.'
+    end
+
+    def task_success_message
+      'Task was successfully deleted.'
+    end
+  end
+end