estimate 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.rvmrc

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+ - 1.9.2
+ - 1.9.3
+ - ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    happymapper (0.4.0)
+      libxml-ruby (~> 2.0)
+    libxml-ruby (2.3.2)
+    mime-types (1.18)
+    nokogiri (1.5.2)
+    pivotal-tracker (0.5.1)
+      builder
+      builder
+      happymapper (>= 0.3.2)
+      happymapper (>= 0.3.2)
+      nokogiri (>= 1.4.3)
+      nokogiri (~> 1.4)
+      rest-client (~> 1.6.0)
+      rest-client (~> 1.6.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.9.0)
+      rspec-core (~> 2.9.0)
+      rspec-expectations (~> 2.9.0)
+      rspec-mocks (~> 2.9.0)
+    rspec-core (2.9.0)
+    rspec-expectations (2.9.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pivotal-tracker
+  rspec

data/README.md

@@ -0,0 +1,21 @@
+# Estimate
+
+Do you have a manager that's been nugging you about an end date or a project estimate?
+**Estimate** can solve your problem.
+
+## Usage
+
+```ruby
+gem install estimate # install
+
+estimate <project_name> -u <username> -p <password> --ssl
+
+Usage: estimate <project_name> [options]
+    -u, --user STRING                Pivotal tracker username
+    -p, --pass STRING                Pivotal tracker password
+    -s, --ssl                        Use secure connection
+    -d, --developers INT             Number of developers (default: 2)
+    -x, --day_points INT             Points allocated to a day (default: 1)
+```
+
+[![Build Status](https://secure.travis-ci.org/despo/estimate.png)](http://travis-ci.org/despo/estimate)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_path = 'rspec'
+  t.rspec_opts = ["-cfd"]
+end
+
+task :default => :spec

data/bin/estimate

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+options = {}
+parsed_options = OptionParser.new do |opts|
+  opts.banner = "Usage: estimate <project_name> [options]"
+
+  opts.on('-u', '--user STRING', 'Pivotal tracker username') { |user| options[:username] = user }
+  opts.on('-p', '--pass STRING', 'Pivotal tracker password') { |pass| options[:password] = pass }
+  opts.on('-s', '--ssl', 'Use secure connection') { options[:ssl] = true }
+
+  opts.on('-d', '--developers INT', 'Number of developers (default: 2)') do |developers|
+    options[:developers] = developers
+  end
+
+  opts.on('-x', '--day_points INT', 'Points allocated to a day (default: 1)') do |day_options|
+    options[:day_points] = day_points
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+project = ARGV.first or warn("Which project do you want to estimate?")
+
+if !options[:username] or !options[:password]
+  warn "No authentication credentials specified"
+  exit
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'estimate'
+begin
+  Estimate::TrackingSystem.authenticate! options[:username], options[:password], options[:ssl]
+  puts Estimate::Project.new(project, options).process!
+rescue Exception => e
+  puts "Something went wrong..."
+  puts e.message
+end

data/estimate.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "estimate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "estimate"
+  s.version     = Estimate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Despo Pentara"
+  s.email       = "despo@extractmethod.com"
+  s.homepage    = "https://github.com/despo/estimate"
+  s.summary     = "Estimate projects the easy way."
+  s.description = %{Have a manager that's been nugging you for a project estimate? Waste no time! Estimate your project now.}
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.licenses = ["MIT"]
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths      = ["lib"]
+
+  s.add_dependency "pivotal-tracker", "~> 0.5.1"
+
+  s.add_development_dependency "rspec", "~> 2.8.0"
+  s.add_development_dependency "rake"
+end
+

data/lib/estimate.rb

@@ -0,0 +1,7 @@
+require 'pivotal-tracker'
+require_relative 'estimate/tracking_system'
+require_relative 'estimate/project'
+
+module Estimate
+
+end

data/lib/estimate/project.rb

@@ -0,0 +1,78 @@
+require 'pivotal-tracker'
+
+module Estimate
+  class Project
+
+    def initialize name, properties={}
+      @name = name
+      @properties = properties
+    end
+
+    def process!
+  """
+  Project: #{@name}
+  Incomplete stories: #{incomplete_stories.length}
+
+  And your project end date is.....
+            #{display_end_date}
+
+  You have #{remaining_days} days to complete this project.
+  """
+    end
+
+    private
+    WORK_WEEK_DAYS = 5
+
+    def incomplete_stories
+      @stories = @stories || project.stories.all(:story_type => story_points.keys, :current_state => incomplete_stati)
+    end
+
+    def project
+      @project = @project || PivotalTracker::Project.all.select { |x| x.name.eql? @name }.first
+    end
+
+    def story_points
+      { :feature => 5,
+        :bug => 1,
+        :chore => 1
+      }
+    end
+
+    def incomplete_stati
+      [ 'unscheduled', 'unstarted', 'started' ]
+    end
+
+    def display_end_date
+      end_date.strftime('%A, %b %d %Y')
+    end
+
+    def end_date
+      DateTime.now + remaining_weeks*7
+    end
+
+    def remaining_weeks
+      @remaining_weeks = @remaining_weeks || (points/day_points+holidays*developers)/WORK_WEEK_DAYS/developers
+    end
+
+    def points
+      incomplete_stories.inject(0) { |points, story|  points + story_points[story.story_type.to_sym] }
+    end
+
+    def day_points
+      @properties[:day_points] || 1
+    end
+
+    def holidays
+      5*developers
+    end
+
+    def developers
+      @properties[:developers] || 2
+    end
+
+    def remaining_days
+      (end_date-DateTime.now).to_i
+    end
+
+  end
+end

data/lib/estimate/tracking_system.rb

@@ -0,0 +1,9 @@
+module Estimate
+
+  class TrackingSystem
+    def self.authenticate! username, password, ssl=nil
+      PivotalTracker::Client.token(username, password)
+      PivotalTracker::Client.use_ssl = true
+    end
+  end
+end

data/lib/estimate/version.rb

@@ -0,0 +1,4 @@
+module Estimate
+  VERSION = "0.0.1"
+end
+

data/spec/estimate/project_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Estimate::Project do
+
+  context 'properties' do
+    it '#developers' do
+      project = Estimate::Project.new(:project_name, :developers => 5)
+      project.stub(:project => mock_pivotal_project)
+
+      3.times { project.should_receive(:developers).and_return(5) }
+
+      project.process!
+    end
+
+    it '#day_points' do
+      project = Estimate::Project.new(:project_name, :day_points => 2)
+      project.stub(:project => mock_pivotal_project)
+
+      project.should_receive(:day_points).and_return(2)
+
+      project.process!
+    end
+  end
+
+  it "can estimate the project's end date" do
+    number_of_stories = 10
+
+    project = Estimate::Project.new(:project_name)
+    mock_incomplete_stories(project, number_of_stories)
+
+    end_date = (DateTime.now + 7*7).strftime('%A, %b %d %Y')
+
+    project.process!.should eq process_string(:project_name, number_of_stories, end_date)
+  end
+end

data/spec/estimate/tracking_system_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Estimate::TrackingSystem do
+
+  context 'can connect to the tracking system' do
+
+    it 'can authenticate a user' do
+      PivotalTracker::Client.should_receive(:token).with(:username, :password)
+      Estimate::TrackingSystem.authenticate! :username, :password
+    end
+
+    it 'can authenticate when ssl authentication is enabled' do
+      PivotalTracker::Client.should_receive(:token).with(:username, :password)
+      PivotalTracker::Client.should_receive(:use_ssl=).with(true)
+
+      Estimate::TrackingSystem.authenticate!(:username, :password, true)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'support/mocks.rb'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'estimate'

data/spec/support/mocks.rb

@@ -0,0 +1,25 @@
+def mock_incomplete_stories project, number_of_stories
+  incomplete_stories = number_of_stories.times.map { mock_feature }
+
+  2.times { project.should_receive(:incomplete_stories).and_return(incomplete_stories) }
+end
+
+def process_string name, incomplete_stories, end_date
+  """
+  Project: #{name}
+  Incomplete stories: #{incomplete_stories}
+
+  And your project end date is.....
+            #{end_date}
+
+  You have 48 days to complete this project.
+  """
+end
+
+def mock_feature
+  mock(:story_type => 'feature')
+end
+
+def mock_pivotal_project
+  mock(:pivotal_project, :stories => mock(:all => []))
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: estimate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Despo Pentara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pivotal-tracker
+  requirement: &70293662021420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70293662021420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70293662020720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70293662020720
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70293662020000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70293662020000
+description: Have a manager that's been nugging you for a project estimate? Waste
+  no time! Estimate your project now.
+email: despo@extractmethod.com
+executables:
+- estimate
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/estimate
+- estimate.gemspec
+- lib/estimate.rb
+- lib/estimate/project.rb
+- lib/estimate/tracking_system.rb
+- lib/estimate/version.rb
+- spec/estimate/project_spec.rb
+- spec/estimate/tracking_system_spec.rb
+- spec/spec_helper.rb
+- spec/support/mocks.rb
+homepage: https://github.com/despo/estimate
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Estimate projects the easy way.
+test_files: []