Class: GitPivotalTrackerIntegration::Command::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/git-pivotal-tracker-integration/command/base.rb

Overview

This class is abstract.

Subclass and override #run to implement command functionality

An abstract base class for all commands

Direct Known Subclasses

Deliver, Finish, Newbug, Newfeature, Release, Report, Start

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Base

Common initialization functionality for all command classes. This enforces that:

  • the command is being run within a valid Git repository

  • the user has specified their Pivotal Tracker API token

  • all communication with Pivotal Tracker will be protected with SSL

  • the user has configured the project id for this repository



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 29

def initialize
  self.start_logging
  self.check_version

  git_global_push_default = (Util::Shell.exec "git config --global push.default", false).chomp
  if git_global_push_default != "simple"
    puts "git config --global push.default simple"
    puts Util::Shell.exec "git config --global push.default simple"
  end

  @repository_root  = Util::Git.repository_root
  @configuration    = Command::Configuration.new

  @configuration.check_for_config_file
  @configuration.check_for_config_contents

  @client           = TrackerApi::Client.new(:token => @configuration.api_token, :logger => Logger.new('faraday.log'))
  @platform         = @configuration.platform_name

  current_project_id  = @configuration.project_id.to_i
  @project            = @client.project current_project_id
  my_projects         = @client.projects

  unless my_projects && my_projects.map(&:id).include?(current_project_id)
    project_manager_name  = @configuration.pconfig["project"]["project-manager"]
    project_manager_email = @configuration.pconfig["project"]["project-manager-email"]
    project_name          = @configuration.pconfig["project"]["project-name"]
    abort "This project requires access to the Pivotal Tracker project [#{project_name} - #{current_project_id}]. Please speak with project manager [#{project_manager_name} - #{project_manager_email}] and ask him to add you to the project in Pivotal Tracker."
  end
end

Instance Method Details

#check_version ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 68

def check_version
  gem_latest_version    = (Util::Shell.exec "gem list v2gpti --remote")[/\(.*?\)/].delete "()"
  gem_installed_version = Gem.loaded_specs["v2gpti"].version.version
  if (gem_installed_version == gem_latest_version)
      $LOG.info("v2gpti verison #{gem_installed_version} is up to date.")
  else
      $LOG.fatal("Out of date")
      if OS.windows?
        abort "\n\nYou are using v2gpti version #{gem_installed_version}, but the current version is #{gem_latest_version}.\nPlease update your gem with the following command.\n\n    gem update v2gpti\n\n"
      else
  abort "\n\nYou are using v2gpti version #{gem_installed_version}, but the current version is #{gem_latest_version}.\nPlease update your gem with the following command.\n\n    sudo gem update v2gpti\n\n"
end
  end
rescue StandardError => se
  puts ""
end

#create_backlog_bug_story(args) ⇒ Object 



154
155
156
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 154

def create_backlog_bug_story(args)
  create_story_with_type_state("bug", "unstarted", args)
end

#create_backlog_feature_story(args) ⇒ Object 



162
163
164
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 162

def create_backlog_feature_story(args)
  create_story_with_type_state("feature", "unstarted", args)
end

#create_icebox_bug_story(args) ⇒ Object 



150
151
152
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 150

def create_icebox_bug_story(args)
  create_story_with_type_state("bug", "unscheduled", args)
end

#create_icebox_feature_story(args) ⇒ Object 



158
159
160
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 158

def create_icebox_feature_story(args)
 create_story_with_type_state("feature", "unscheduled", args)
end

#create_story(args) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 117

def create_story(args)
  story_types = {"f" => "feature", "b" => "bug", "c" => "chore"}
  new_story_type = nil
  new_story_title = nil
  new_story_estimate = -1
  args.each do |arg|
    new_story_type = story_types[arg[-1]] if arg.include? '-n'
    new_story_title = arg if arg[0] != "-"
  end

  while new_story_type.nil?
    nst = ask("Please enter f for feature, b for bug, or c for chore")
    new_story_type = story_types[nst]
  end

  while (new_story_title.nil? || new_story_title.empty?)
    new_story_title = ask("Please enter the title for this #{new_story_type}.")
  end

  attrs = {:story_type => new_story_type, :current_state => 'unstarted', :name => new_story_title}

  if @project.bugs_and_chores_are_estimatable
    attrs[:estimate] = estimate_story
  else
    if (new_story_type == "feature" && (new_story_estimate < 0 || new_story_estimate > 3))
      attrs[:estimate] = estimate_story
    end
  end

  @project.create_story(attrs)

end

#estimated_seconds(story) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 99

def estimated_seconds(story)
  estimate = story.estimate
  seconds = 0
  case estimate
    when 0
      estimate = 15 * 60
    when 1
      estimate = 1.25 * 60 * 60
    when 2
      estimate = 3 * 60 * 60
    when 3
      estimate = 8 * 60 * 60
    else
      estimate = -1 * 60 * 60
  end
  estimate
end

#logger_filename ⇒ Object 



64
65
66
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 64

def logger_filename
  return "#{Dir.home}/.v2gpti_local.log"
end

#run ⇒ Object

This method is abstract.

Override this method to implement command functionality

The main entry point to the command’s execution

Raises:

  • (NotImplementedError) 


87
88
89
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 87

def run
  raise NotImplementedError
end

#seconds_spent(time_spent) ⇒ Object 



92
93
94
95
96
97
98
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 92

def seconds_spent(time_spent)
  seconds = 0
  time_spent.scan(/(\d+)(\w)/).each do |amount, measure|
    seconds += amount.to_i * TIMER_TOKENS[measure]
  end
  seconds
end

#start_logging ⇒ Object 



60
61
62
 
# File 'lib/git-pivotal-tracker-integration/command/base.rb', line 60

def start_logging
  $LOG = Logger.new("#{logger_filename}", 'weekly')
end