pivotal_doc 1.3.0 → 1.4.0

data/spec/lib/ext/date_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Date do
+  before(:each) do
+    @date= Date.parse('1-1-2010')
+  end
+  
+  it "have a standard format" do
+    @date.standard_format.should eql('01-01-2010')
+  end
+  
+  it "have a fancy format" do
+    @date.fancy_format.should eql('Jan 01, 2010')
+  end
+end

data/spec/lib/generator_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe PivotalDoc::Generator do
   before(:each) do
@@ -13,29 +13,62 @@ describe PivotalDoc::Generator do
   
   describe "Configuring" do
     before(:each) do
-      PivotalDoc::Generator.stub!(:collect_releases!)
-      PivotalDoc::Generator.releases= []
+      PivotalDoc::Generator.stub!(:collect_releases!).and_return([])
     end
-
     it "should create a config object from the settings" do
       settings= {}
-      @config.stub!(:authenticate!)
       PivotalDoc::Configuration.should_receive(:new).with(settings).and_return(@config)
+      @config.stub!(:authenticate!)
       PivotalDoc::Generator.generate(:html, settings)
-      PivotalDoc::Generator.config.should eql(@config)
     end
 
     it "should authenticate against pivotal before generating the release docs" do
       @config.should_receive(:authenticate!)
       PivotalDoc::Generator.generate(:html)
+    end    
+  end
+  
+  describe "releases" do
+    before(:each) do
+      @release= mocks_helper(:release)
+      PivotalDoc::Release.stub!(:new).and_return(@release)
+    end
+    
+    it "should create a release for each project" do
+      PT::Iteration.stub!(:current).and_return(mocks_helper(:iteration))
+      @config.projects.each do |name, settings| 
+        PT::Project.should_receive(:find).with(settings['id'].to_i).and_return(@release.project) 
+      end
+      releases= PivotalDoc::Generator.collect_releases!(@config)
+      releases.size.should eql(@config.projects.size)
+    end
+    
+    describe "current" do
+      it "create a current iteration for the release if current is set for the project" do
+        PT::Project.stub!(:find).and_return(@release.project)      
+        iteration= mocks_helper(:iteration)
+        PT::Iteration.should_receive(:current).exactly(:once).and_return(iteration)
+        PivotalDoc::Generator.collect_releases!(@config)
+      end
+      
+      it "create a sprint for the current iteration instead of a release" do
+        PT::Project.stub!(:find).and_return(@release.project)      
+        iteration= mocks_helper(:iteration)
+        PT::Iteration.stub!(:current).and_return(iteration)
+        releases= PivotalDoc::Generator.collect_releases!(@config)        
+        releases.last.should be_an_instance_of(PivotalDoc::Sprint)
+      end
     end
   end
 
   describe "generation" do
     before(:each) do
       @config.stub!(:authenticate!).and_return(true)
-      @release= mocks_helper(:release)
+      @release = mocks_helper(:release)
+      PT::Iteration.stub!(:current).and_return(mocks_helper(:iteration))
+      @sprint =  PivotalDoc::Sprint.new(@release.project)
       PT::Project.stub!(:find).and_return(@release.project)
+      PivotalDoc::Sprint.stub!(:new).and_return(@sprint)
       PivotalDoc::Release.stub!(:new).and_return(@release)
     end
 
@@ -45,7 +78,14 @@ describe PivotalDoc::Generator do
         @html_gen= PivotalDoc::Generators::HTML.new({})
         @html_gen.stub!(:render_doc)
       end
+      it "use the generators format if there is one" do
+        sprint_generator= mock('PivotalDoc::Generators::Sprint')
+        @sprint.generator(:html).should_receive(:new).exactly(:once).with(@sprint, @config.settings).and_return(sprint_generator)
+        sprint_generator.should_receive(:render_doc)
+        PivotalDoc::Generator.generate(:html)        
+      end
       it "should render the release with the specified format and custom settings" do
+        @sprint.generator(:html).stub!(:new).and_return(@html_gen)
         PivotalDoc::Generators::HTML.should_receive(:new).with(@release, @config.settings).and_return(@html_gen)
         PivotalDoc::Generator.generate(:html)
       end

data/spec/lib/generators/base_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe PivotalDoc::Generators::Base do
   before(:each) do

data/spec/lib/generators/csv_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe PivotalDoc::Generators::CSV do
+  before(:each) do
+    @release= mocks_helper(:release)
+    @csv= PivotalDoc::Generators::CSV.new(@release)
+  end
+  
+  after(:each) do
+    File.delete(@csv.output_file) if File.exists?(@csv.output_file)
+  end
+  
+  describe "Generating CSV" do
+    it "should open the output file and write the csv with columns" do
+      @csv.render_doc
+      output= File.read(@csv.output_file)
+      output.should =~ /#{PivotalDoc::Generators::CSV::COLUMNS.join(',')}/
+      @release.features.each{|f| output =~ @csv.fields(f) }
+    end
+
+    it "should read the file contents" do
+      @csv.template.should be_an_instance_of(String)
+    end
+
+    it "should know its template name" do
+      @csv.template_name.should =~ /\.csv$/
+    end 
+    
+    it "include each field" do
+      fields= @csv.fields(@release.features.first)
+      fields.should be_an_instance_of(Array)
+      fields.should have(PivotalDoc::Generators::CSV::COLUMNS.size).items
+    end   
+  end
+end

data/spec/lib/generators/html_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require 'spec_helper'
 
 describe PivotalDoc::Generators::HTML do
   before(:each) do

data/spec/lib/generators/sprint_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe PivotalDoc::Generators::Sprint do
+  before(:each) do
+    @release= mocks_helper(:release)
+    @sprint= PivotalDoc::Generators::Sprint.new(@release)
+    @engine= Haml::Engine.new('')
+  end
+  
+  after(:each) do
+    File.delete(@sprint.output_file) if File.exists?(@sprint.output_file)
+  end
+  
+  it "should open the output file and write the compiled haml (html)" do
+    Haml::Engine.stub!(:new).and_return(@engine)
+    @engine.stub!(:render).and_return('compiled haml')
+    @sprint.render_doc
+    File.read(@sprint.output_file).should eql('compiled haml')
+  end
+  
+  it "should read the file contents" do
+    @sprint.template.should be_an_instance_of(String)
+  end
+  
+  it "should use the template_name if specified" do
+    options= {'template_name'=>'fancy.sprint.html'}
+    html= PivotalDoc::Generators::HTML.new(@release, options)
+    html.template_name.should eql(options['template_name'])
+  end
+  
+  it "should know its template name" do
+    @sprint.template_name.should =~ /\.haml$/
+  end
+  
+  it "should render the release doc" do
+    Haml::Engine.should_receive(:new).with(@sprint.template).and_return(@engine)
+    @engine.should_receive(:render)
+    @sprint.render_doc
+  end
+end

data/spec/lib/release_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require 'spec_helper'
 
 describe PivotalDoc::Release do
   before(:each) do

data/spec/lib/sprint_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe PivotalDoc::Sprint do
+  before(:each) do
+    @project= PT::Project.new
+    @iteration= PT::Iteration.new
+    PT::Iteration.stub!(:current).and_return([@iteration])
+    @sprint= PivotalDoc::Sprint.new(@project)
+  end
+
+  it "not have a release name" do
+    @sprint.name.should be_nil
+  end
+
+  it "know the html generator" do
+    @sprint.generator(:html).should eql(PivotalDoc::Generators::Sprint)
+  end
+
+  it "only know the html generator" do
+    @sprint.generator(:unknown).should be_nil
+  end
+
+  describe "stories" do
+    before(:each) do
+      @stories= PTApiHelpers::mock_stories
+      @sprint.iteration.stub!(:stories).and_return(@stories)
+    end
+
+    it "should get the stories only" do
+      @sprint.iteration.should_receive(:stories).and_return(@stories)
+      @sprint.stories.each{|s| s.story_type.downcase.should eql('feature') }
+    end
+
+    it "should get the bugs only" do
+      @sprint.iteration.should_receive(:stories).and_return(@stories)
+      @sprint.bugs.each{|b| b.story_type.downcase.should eql('bug') }
+    end
+
+    it "should get the chores only" do
+      @sprint.iteration.should_receive(:stories).and_return(@stories)
+      @sprint.chores.each{|c| c.story_type.downcase.should eql('chore') }
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :test)
+
 require File.join(File.dirname(__FILE__), '../lib/pivotal_doc.rb')
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.include MocksHelper
 end
-  

data/templates/sprint.haml

@@ -0,0 +1,48 @@
+!!! Strict 
+%html 
+  %head 
+    %meta{'http-equiv' => 'Content-Type', :content => 'text/html;charset=utf-8'} 
+    %title= sprint.iteration.start.fancy_format
+    %style{:type => "text/css", :media => "screen"}
+      :plain
+        p,div,h1,h2,h3,h4,h5,h6,span,a {font-family: Arial}
+        div#sprint_doc {padding-left: .5em;}
+        h2, h3 {padding: .5em 0;}
+        h3 {text-decoration: underline;}
+        div#sprint_doc {
+          width: 80%;
+          margin-left: auto;
+          margin-right: auto;
+          text-align: left;
+        }
+        div#chores, div#bugs, div#stories{ padding-left: 0.6em }
+        div.item {padding-left: .4em}
+        div.item_info {padding-left: .4em}
+  %body
+    #sprint_doc
+      #sprint_info
+        %h2= "This sprint begins on #{sprint.iteration.start.fancy_format} and ends on #{sprint.iteration.finish.fancy_format}."
+      #stories
+        %h3 Proposed Stories
+        - sprint.stories.each do |story|
+          .item
+            %h4= "Story ##{story.id} - #{story.name}"
+            .item_info
+              %p= "Requestor: #{story.requested_by}" 
+              %p= "Description: #{story.description}"
+      #bugs
+        %h3 Bug Fixes
+        - sprint.bugs.each do |bug|
+          .item
+            %h4= "Bug ##{bug.id} - #{bug.name}"
+            .item_info
+              %p= "Requestor: #{bug.requested_by}" 
+              %p= "Description: #{bug.description}" 
+      #chores    
+        %h3 Miscellaneous Chores
+        - sprint.chores.each do |chore|
+          .item
+            %h4= "Chore ##{chore.id} - #{chore.name}"
+            .item_info
+              %p= "Requestor: #{chore.requested_by}" 
+              %p= "Description: #{chore.description}" 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pivotal_doc
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Tim Linquist
@@ -15,28 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 -07:00
+date: 2011-02-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: pivotal-tracker
-  prerelease: false
+  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 3
         segments: 
         - 0
-        - 2
-        - 1
-        version: 0.2.1
-  type: :runtime
+        version: "0"
+  name: fastercsv
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: haml
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -46,12 +43,55 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  name: rake
   version_requirements: *id002
+  prerelease: false
 - !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: jeweler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
   name: rspec
+  version_requirements: *id004
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: pivotal-tracker
+  version_requirements: *id005
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,8 +100,83 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  name: haml
+  version_requirements: *id006
+  prerelease: false
+- !ruby/object:Gem::Dependency 
   type: :development
-  version_requirements: *id003
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  name: factory_girl
+  version_requirements: *id007
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: ruby-debug
+  version_requirements: *id008
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  name: pivotal-tracker
+  version_requirements: *id009
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: haml
+  version_requirements: *id010
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  version_requirements: *id011
+  prerelease: false
 description: "\n        Automated release notes for apps hosted on pivotaltracker.com.  \n        Allows release notes to be generated for any project on pivotaltracker.com by retrieving the latest iteration for the specified project and displaying the completed features, bugs, and chores.\n      "
 email: tim.linquist@gmail.com
 executables: []
@@ -72,6 +187,9 @@ extra_rdoc_files:
 - README
 files: 
 - .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
 - README
 - Rakefile
 - VERSION
@@ -92,39 +210,47 @@ files:
 - assets/css/ui-lightness/jquery-ui-1.8.5.custom.css
 - assets/js/jquery-1.4.2.min.js
 - assets/js/jquery-ui-1.8.5.custom.min.js
-- ext/date.rb
 - lib/pivotal_doc.rb
 - lib/pivotal_doc/configuration.rb
 - lib/pivotal_doc/exceptions.rb
+- lib/pivotal_doc/ext/date.rb
 - lib/pivotal_doc/generator.rb
 - lib/pivotal_doc/generators/base.rb
+- lib/pivotal_doc/generators/csv.rb
 - lib/pivotal_doc/generators/html.rb
-- lib/pivotal_doc/generators/text.rb
+- lib/pivotal_doc/generators/sprint.rb
 - lib/pivotal_doc/release.rb
+- lib/pivotal_doc/sprint.rb
+- lib/pivotal_doc/work.rb
 - pivotal_doc.gemspec
 - spec/fixtures/configs.yml
 - spec/fixtures/iterations.yml
 - spec/fixtures/projects.yml
 - spec/fixtures/stories.yml
 - spec/lib/configuration_spec.rb
+- spec/lib/ext/date_spec.rb
 - spec/lib/generator_spec.rb
 - spec/lib/generators/base_spec.rb
+- spec/lib/generators/csv_spec.rb
 - spec/lib/generators/html_spec.rb
-- spec/lib/generators/text_spec.rb
+- spec/lib/generators/sprint_spec.rb
 - spec/lib/release_spec.rb
+- spec/lib/sprint_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 - spec/support/mocks_helper.rb
 - spec/support/pt_api_helpers.rb
 - templates/fancy.haml
-- templates/html_gen.haml
-- templates/text_gen.txt
+- templates/output.csv
+- templates/output.haml
+- templates/sprint.haml
 has_rdoc: true
 homepage: http://github.com/timo3377/pivotal_doc
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -148,17 +274,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: A release documentation generator for pivotaltracker.com
 test_files: 
 - spec/lib/configuration_spec.rb
+- spec/lib/ext/date_spec.rb
 - spec/lib/generator_spec.rb
 - spec/lib/generators/base_spec.rb
+- spec/lib/generators/csv_spec.rb
 - spec/lib/generators/html_spec.rb
-- spec/lib/generators/text_spec.rb
+- spec/lib/generators/sprint_spec.rb
 - spec/lib/release_spec.rb
+- spec/lib/sprint_spec.rb
 - spec/spec_helper.rb
 - spec/support/mocks_helper.rb
 - spec/support/pt_api_helpers.rb

data/lib/pivotal_doc/generators/text.rb

@@ -1,12 +0,0 @@
-module PivotalDoc
-  module Generators
-    class Text < Base
-      def template_name; 'text_gen.txt' end
-      def output_ext; '.txt' end
-      def output; '' end
-      def render_doc
-        super(output)
-      end
-    end
-  end
-end

data/spec/lib/generators/text_spec.rb

@@ -1,25 +0,0 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
-
-describe PivotalDoc::Generators::Text do
-  before(:each) do
-    @text= PivotalDoc::Generators::Text.new(mocks_helper(:release))
-  end
-  
-  after(:each) do
-    File.delete(@text.output_file) if File.exists?(@text.output_file)
-  end
-  
-  it "should render the text and write to the output file" do
-    @text.should_receive(:output).and_return('my_text')
-    @text.render_doc
-    File.read(@text.output_file).should eql('my_text')
-  end
-  
-  it "should read the file contents" do
-    @text.template.should be_an_instance_of(String)
-  end
-  
-  it "should know its tempalte name" do
-    @text.template_name.should =~ /\.txt$/
-  end
-end