pivotal_doc 1.1.0

data/spec/lib/generators/html_spec.rb

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

data/spec/lib/generators/text_spec.rb

@@ -0,0 +1,25 @@
+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

data/spec/lib/release_spec.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe PivotalDoc::Release do
+  before(:each) do
+    @project= PT::Project.new
+    @latest_iteration= PT::Iteration.new
+    PT::Iteration.stub!(:done).and_return([@latest_iteration])
+    @release= PivotalDoc::Release.new(@project)
+  end
+
+  it "should get the last 'done' iteration for the project" do
+    PT::Iteration.should_receive(:done).with(@project, :offset=>'-1')
+    @release.latest_iteration
+  end
+  
+  describe "the latest iteration" do
+    before(:each) do
+      @release.stub!(:latest_iteration).and_return(@latest_iteration)
+    end
+    
+    it "should use the iteration if specified" do
+      backlog= PTApiHelpers::mock_object('iterations')
+      release= PivotalDoc::Release.new(@project, backlog)
+      release.iteration.should eql(backlog)      
+    end
+    
+    it "should default the iteration to the latest_iteration (last 'done') if one isn't specified" do
+      PT::Iteration.should_receive(:done).and_return([@latest_iteration])
+      release= PivotalDoc::Release.new(@project)
+      release.iteration.should eql(@latest_iteration)
+    end
+    
+    describe "release of (me)" do
+      before(:each) do
+        @stories= PTApiHelpers::mock_stories
+        @me= PTApiHelpers::mock_actual_release
+        @latest_iteration.stub!(:stories).and_return(@stories)
+      end
+      
+      it "should find the \"release\" if there is one" do
+        @latest_iteration.should_receive(:stories).and_return(@stories)
+        @release.me.story_type.should eql('release')
+      end
+      
+      it "should know the name of the release" do
+        @release.name.should eql(@me.name)
+      end
+    end
+
+    describe "stories" do
+      before(:each) do
+        @stories= PTApiHelpers::mock_stories
+        @latest_iteration.stub!(:stories).and_return(@stories)
+      end
+      
+      it "should get the stories only" do
+        @latest_iteration.should_receive(:stories).and_return(@stories)
+        @release.stories.each{|s| s.story_type.downcase.should eql('feature') }
+      end
+
+      it "should get the bugs only" do
+        @latest_iteration.should_receive(:stories).and_return(@stories)
+        @release.bugs.each{|b| b.story_type.downcase.should eql('bug') }
+      end
+      
+      it "should get the chores only" do
+        @latest_iteration.should_receive(:stories).and_return(@stories)
+        @release.chores.each{|c| c.story_type.downcase.should eql('chore') }        
+      end
+
+      describe "finished work" do
+        [:stories, :chores, :bugs].each do |m|
+          it "should know the #{m} delivered in this release" do
+            @release.send("#{m}_delivered").should eql(@release.send(m).size)
+          end
+        end
+        
+        it "should only get the \"delivered\" stories" do
+          @release.stories.each{|s| s.current_state.downcase.should eql('accepted')}
+        end
+
+        it "should only get the \"delivered\" bugs" do
+          @release.bugs.each{|b| b.current_state.downcase.should eql('accepted')}
+        end
+
+        it "should only get the \"accepted\" chores" do
+          @release.chores.each{|c| c.current_state.downcase.should eql('accepted')}
+        end
+      end      
+    end
+  end  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+ENV['mode']= '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|
+  config.include MocksHelper
+end
+  

data/spec/support/mocks_helper.rb

@@ -0,0 +1,31 @@
+module MocksHelper
+  def mocks_helper(mock)
+    raise "No mock exists yet for #{mock}!" unless mocks.has_key?(mock)
+    return mocks[mock]
+  end
+
+  private  
+  def release
+    release= PivotalDoc::Release.new(project, iteration)
+    release.stub!(:stories).and_return(PTApiHelpers::mock_stories)
+    release.stub!(:bugs).and_return(PTApiHelpers::mock_bugs)
+    release.stub!(:chores).and_return(PTApiHelpers::mock_chores)
+    release
+  end
+  
+  def project
+    return PTApiHelpers::mock_projects.first
+  end
+  
+  def iteration
+    return PTApiHelpers::mock_iterations.first
+  end
+  
+  def mocks
+    @@mocks= {
+      :release=>release,
+      :project=>project,
+      :iteration=>iteration
+    }
+  end  
+end

data/spec/support/pt_api_helpers.rb

@@ -0,0 +1,42 @@
+module PTApiHelpers
+  FIXTURE_PATH= File.join(File.dirname(__FILE__), '/../fixtures/')
+
+  def self.mock_object(file_name, attrs={})
+    collection= mock_collection(file_name)
+    collection.first.merge(attrs)
+  end
+  
+  def self.mock_collection(file_name)
+    fixture= File.new(File.join(FIXTURE_PATH, "#{file_name}.yml"))
+    return YAML::load(fixture)    
+  end
+  
+  def self.mock_stories
+    mock_collection('stories').collect{|s| PT::Story.new(s) }
+  end
+  
+  def self.mock_iterations
+    mock_collection('iterations').collect{|iteration| set_attributes(PT::Iteration.new, iteration) }
+  end
+  
+  def self.mock_actual_release
+    mock_stories.detect{|s| s.story_type.downcase == 'release' }    
+  end
+  
+  def self.mock_bugs
+    mock_stories.reject{|s| s.story_type.downcase != 'bug' }
+  end
+  
+  def self.mock_chores
+    mock_stories.reject{|s| s.story_type.downcase != 'chores' }
+  end
+
+  def self.mock_projects
+    mock_collection('projects').collect{|project| set_attributes(PT::Project.new, project) }
+  end
+  
+  def self.set_attributes(obj, attrs={})
+    attrs.each{|k,v| obj.send("#{k}=".to_sym, v)}    
+    obj
+  end
+end

data/templates/fancy.haml

@@ -0,0 +1,74 @@
+!!! Strict 
+%html 
+  %head 
+    %meta{'http-equiv' => 'Content-Type', :content => 'text/html;charset=utf-8'} 
+    %title= release.name
+    %script{:type => "text/javascript", :src  => "../../assets/js/jquery-1.4.2.min.js"}
+    %script{:type => "text/javascript", :src  => "../../assets/js/jquery-ui-1.8.5.custom.min.js"}
+    %link{:rel=>"stylesheet", :href=>"../../assets/css/ui-lightness/jquery-ui-1.8.5.custom.css"}
+    %style{:type => "text/css", :media => "screen"}
+      :plain
+        p,div,h1,h2,h3,h4,h5,h6,span,a {font-family: Arial}
+        div#release_doc, div#accordian {padding-left: .5em;}
+        h2, h3 {padding: .5em 0;}
+        div#release_doc {
+          width: 80%;
+          margin-left: auto;
+          margin-right: auto;
+          text-align: left;
+        }
+        div#release_info{
+          text-align: center;
+        }
+        div#accordian {padding: 0 30px}  
+        div.item {padding-left: .4em}
+        div.item_info {padding-left: .4em}
+    :javascript
+      $(function() {
+        $( "#accordian" ).accordion({ active: false, collapsible: true, autoHeight: false });
+      });
+  %body
+    #release_doc
+      #release_info
+        %h2= "Announcing the \"#{release.name}\" release for the #{release.project_name} project"
+        %p
+          = "This sprint began on #{release.iteration.start.fancy_format} and was completed on #{release.iteration.finish.fancy_format}.  It includes #{release.stories_delivered} new stories, #{release.bugs_delivered} bug fixes, and #{release.chores_delivered} miscellaneous chores."
+      #accordian
+        %h3
+          %a{:href=>'#'} Accepted Stories
+        .accodian_container
+          - release.stories.each do |story|
+            .item
+              %h4= "Story ##{story.id} - #{story.name}"
+              .item_info
+                %p= "Requestor: #{story.requested_by}" 
+                %p= "Completed By: #{story.owned_by}"
+                %p= "Description: #{story.description}"
+                %p
+                  / %a{:href=>story.url, :target=>'_blank'} More Information
+
+        %h3
+          %a{:href=>'#'} Bug Fixes
+        .accodian_container
+          - release.bugs.each do |bug|
+            .item
+              %h4= "Bug ##{bug.id} - #{bug.name}"
+              .item_info
+                %p= "Requestor: #{bug.requested_by}" 
+                %p= "Completed By: #{bug.owned_by}"
+                %p= "Description: #{bug.description}" 
+                %p
+                  / %a{:href=>bug.url, :target=>'_blank'} More Information
+          
+        %h3
+          %a{:href=>'#'} Miscellaneous Chores
+        .accodian_container
+          - release.chores.each do |chore|
+            .item
+              %h4= "Chore ##{chore.id} - #{chore.name}"
+              .item_info
+                %p= "Requestor: #{chore.requested_by}" 
+                %p= "Completed By: #{chore.owned_by}"
+                %p= "Description: #{chore.description}" 
+                %p
+                  / %a{:href=>chore.url, :target=>'_blank'} More Information

data/templates/html_gen.haml

@@ -0,0 +1,53 @@
+!!! Strict 
+%html 
+  %head 
+    %meta{'http-equiv' => 'Content-Type', :content => 'text/html;charset=utf-8'} 
+    %title= release.name
+    %style{:type => "text/css", :media => "screen"}
+      :plain
+        p,div,h1,h2,h3,h4,h5,h6,span,a {font-family: Arial}
+        div#release_doc {padding-left: .5em;}
+        h2, h3 {padding: .5em 0;}
+        h3 {text-decoration: underline;}
+        div#release_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
+    #release_doc
+      #release_info
+        %h2= "Announcing the \"#{release.name}\" release for the #{release.project_name} project"
+        %p
+          = "This sprint began on #{release.iteration.start.fancy_format} and was completed on #{release.iteration.finish.fancy_format}.  It includes #{release.stories_delivered} new stories, #{release.bugs_delivered} bug fixes, and #{release.chores_delivered} miscellaneous chores."
+      #stories
+        %h3 Accepted Stories
+        - release.stories.each do |story|
+          .item
+            %h4= "Story ##{story.id} - #{story.name}"
+            .item_info
+              %p= "Requestor: #{story.requested_by}" 
+              %p= "Completed By: #{story.owned_by}"
+              %p= "Description: #{story.description}"
+      #bugs
+        %h3 Bug Fixes
+        - release.bugs.each do |bug|
+          .item
+            %h4= "Bug ##{bug.id} - #{bug.name}"
+            .item_info
+              %p= "Requestor: #{bug.requested_by}" 
+              %p= "Completed By: #{bug.owned_by}"
+              %p= "Description: #{bug.description}" 
+      #chores    
+        %h3 Miscellaneous Chores
+        - release.chores.each do |chore|
+          .item
+            %h4= "Chore ##{chore.id} - #{chore.name}"
+            .item_info
+              %p= "Requestor: #{chore.requested_by}" 
+              %p= "Completed By: #{chore.owned_by}"
+              %p= "Description: #{chore.description}" 

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: pivotal_doc
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Tim Linquist
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pivotal-tracker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
+        version: 0.2.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+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: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- assets/css/ui-lightness/images/ui-bg_diagonals-thick_18_b81900_40x40.png
+- assets/css/ui-lightness/images/ui-bg_diagonals-thick_20_666666_40x40.png
+- assets/css/ui-lightness/images/ui-bg_flat_10_000000_40x100.png
+- assets/css/ui-lightness/images/ui-bg_glass_100_f6f6f6_1x400.png
+- assets/css/ui-lightness/images/ui-bg_glass_100_fdf5ce_1x400.png
+- assets/css/ui-lightness/images/ui-bg_glass_65_ffffff_1x400.png
+- assets/css/ui-lightness/images/ui-bg_gloss-wave_35_f6a828_500x100.png
+- assets/css/ui-lightness/images/ui-bg_highlight-soft_100_eeeeee_1x100.png
+- assets/css/ui-lightness/images/ui-bg_highlight-soft_75_ffe45c_1x100.png
+- assets/css/ui-lightness/images/ui-icons_222222_256x240.png
+- assets/css/ui-lightness/images/ui-icons_228ef1_256x240.png
+- assets/css/ui-lightness/images/ui-icons_ef8c08_256x240.png
+- assets/css/ui-lightness/images/ui-icons_ffd27a_256x240.png
+- assets/css/ui-lightness/images/ui-icons_ffffff_256x240.png
+- 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/generator.rb
+- lib/pivotal_doc/generators/base.rb
+- lib/pivotal_doc/generators/html.rb
+- lib/pivotal_doc/generators/text.rb
+- lib/pivotal_doc/release.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/generator_spec.rb
+- spec/lib/generators/base_spec.rb
+- spec/lib/generators/html_spec.rb
+- spec/lib/generators/text_spec.rb
+- spec/lib/release_spec.rb
+- 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
+has_rdoc: true
+homepage: http://github.com/timo3377/pivotal_doc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A release documentation generator for pivotaltracker.com
+test_files: 
+- spec/lib/configuration_spec.rb
+- spec/lib/generator_spec.rb
+- spec/lib/generators/base_spec.rb
+- spec/lib/generators/html_spec.rb
+- spec/lib/generators/text_spec.rb
+- spec/lib/release_spec.rb
+- spec/spec_helper.rb
+- spec/support/mocks_helper.rb
+- spec/support/pt_api_helpers.rb