saga 0.5.0 → 0.5.1

data/.kick

@@ -1,12 +1,20 @@
 recipe :ignore
 ignore(/(^tmp|\.DS_Store)$/)
 
+process do |files|
+  if files.delete('stories.txt')
+    system "./bin/saga planning stories.txt"
+  end
+end
+
 recipe :ruby
 process do |files|
   Ruby.run_tests(files.take_and_map do |file|
     case file
     when %r{^lib/(.+)\.rb$}
       "test/#{$1.gsub('/', '_')}_spec.rb"
+    when %r{^templates}
+      "test/saga_formatter_spec.rb"
     when %r{^test/(.+)_spec\.rb$}
       file
     when %r{^test/cases}

data/README.rdoc

@@ -59,6 +59,7 @@ The document ends with a list of definitions. Here we define words used througho
       convert <filename>  - convert the stories to HTML
       inspect <filename>  - print the internals of the document
       autofill <filename> - adds an id to stories without one
+      planning <filename> - shows the planning of stories in iterations
   
   Options:
       -h, --help                       Show help

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.5.1

data/lib/saga.rb

@@ -7,6 +7,7 @@ module Saga
   autoload :Document,  'saga/document'
   autoload :Formatter, 'saga/formatter'
   autoload :Parser,    'saga/parser'
+  autoload :Planning,  'saga/planning'
   autoload :Runner,    'saga/runner'
   autoload :Tokenizer, 'saga/tokenizer'
   

data/lib/saga/document.rb

@@ -33,6 +33,10 @@ module Saga
       stories.inject(0) { |total, (_, stories)| total + stories.length }
     end
     
+    def empty?
+      length == 0
+    end
+    
     def autofill_ids
       unused_ids = unused_ids(length - used_ids.length)
       stories.each do |_, stories|

data/lib/saga/planning.rb

@@ -0,0 +1,65 @@
+module Saga
+  class Planning
+    BLANK_ITERATION = {:story_count => 0, :estimate_total_in_hours => 0}
+    
+    def initialize(document)
+      @document = document
+    end
+    
+    def iterations
+      @document.stories.values.flatten.inject({}) do |properties, story|
+        if story[:estimate]
+          iteration = story[:iteration] || -1
+          properties[iteration] ||= BLANK_ITERATION.dup
+          properties[iteration][:story_count] += 1
+          properties[iteration][:estimate_total_in_hours] += self.class.estimate_to_hours(story[:estimate])
+        end
+        properties
+      end
+    end
+    
+    def total
+      total = BLANK_ITERATION.dup
+      iterations.each do |iteration, properties|
+        total[:story_count] += properties[:story_count]
+        total[:estimate_total_in_hours] += properties[:estimate_total_in_hours]
+      end
+      total
+    end
+    
+    def to_s
+      if @document.empty?
+        "There are no stories yet."
+      else
+        parts = iterations.keys.sort.map do |iteration|
+          self.class.format_properties(iteration, iterations[iteration])
+        end
+        formatted_totals = self.class.format_properties(false, total)
+        parts << '-'*formatted_totals.length
+        parts << formatted_totals
+        parts.join("\n")
+      end
+    end
+    
+    def self.estimate_to_hours(estimate)
+      case estimate[1]
+      when :days
+        estimate[0] * 8
+      when :weeks
+        estimate[0] * 40
+      else
+        estimate[0]
+      end
+    end
+    
+    def self.format_properties(iteration, properties)
+      if iteration
+        label = (iteration == -1) ? "Unplanned" : "Iteration #{iteration}"
+      else
+        label = 'Total'
+      end
+      story_column = (properties[:story_count] == 1) ? "#{properties[:story_count]} story" : "#{properties[:story_count]} stories"
+      "#{label.ljust(14)}: #{properties[:estimate_total_in_hours]} (#{story_column})"
+    end
+  end
+end

data/lib/saga/runner.rb

@@ -16,6 +16,7 @@ module Saga
         opts.separator "    convert <filename>  - convert the stories to HTML"
         opts.separator "    inspect <filename>  - print the internals of the document"
         opts.separator "    autofill <filename> - adds an id to stories without one"
+        opts.separator "    planning <filename> - shows the planning of stories in iterations"
         opts.separator ""
         opts.separator "Options:"
         opts.on("-h", "--help", "Show help") do
@@ -62,6 +63,9 @@ module Saga
       Saga::Formatter.format(document, :template => 'saga')
     end
     
+    def planning(filename)
+      Saga::Planning.new(Saga::Parser.parse(File.read(filename))).to_s
+    end
     
     def run_command(command, options)
       case command
@@ -73,6 +77,8 @@ module Saga
         write_parsed_document(File.expand_path(@argv[1]))
       when 'autofill'
         puts autofill(File.expand_path(@argv[1]))
+      when 'planning'
+        puts planning(File.expand_path(@argv[1]))
       else
         puts convert(File.expand_path(command))
       end

data/saga.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{saga}
-  s.version = "0.5.0"
+  s.version = "0.5.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Manfred Stienstra"]
-  s.date = %q{2010-04-02}
+  s.date = %q{2010-06-21}
   s.default_executable = %q{saga}
   s.description = %q{Saga is a tool to convert stories syntax to a nicely formatted document.}
   s.email = %q{manfred@fngtps.com}
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "lib/saga/document.rb",
      "lib/saga/formatter.rb",
      "lib/saga/parser.rb",
+     "lib/saga/planning.rb",
      "lib/saga/runner.rb",
      "lib/saga/tokenizer.rb",
      "saga.gemspec",
@@ -45,6 +46,7 @@ Gem::Specification.new do |s|
      "test/saga_document_spec.rb",
      "test/saga_formatter_spec.rb",
      "test/saga_parser_spec.rb",
+     "test/saga_planning_spec.rb",
      "test/saga_runner_spec.rb",
      "test/saga_tokenizer_spec.rb",
      "test/spec_helper.rb"
@@ -52,12 +54,13 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://fingertips.github.com}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Saga is a tool to convert stories syntax to a nicely formatted document.}
   s.test_files = [
     "test/saga_document_spec.rb",
      "test/saga_formatter_spec.rb",
      "test/saga_parser_spec.rb",
+     "test/saga_planning_spec.rb",
      "test/saga_runner_spec.rb",
      "test/saga_tokenizer_spec.rb",
      "test/spec_helper.rb"
@@ -67,7 +70,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<erubis>, [">= 2.6"])
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3"])
       s.add_development_dependency(%q<mocha-on-bacon>, [">= 0"])

data/templates/default/document.erb

@@ -29,6 +29,10 @@
 <p class="author"><%= format_author(author) %></p>
 <% end %>
 
+<% introduction.each do |paragraph| %>
+<p><%= paragraph %></p>
+<% end %>
+
 <% unless stories.empty? %>
 <h2>User stories</h2>
 <% stories.each do |header, stories| %>

data/templates/saga/document.erb

@@ -7,6 +7,10 @@ Requirements <%= title %>
 <% end -%>
 <% end -%>
 
+<% introduction.each do |paragraph| %>
+<%= paragraph %>
+
+<% end %>
 USER STORIES
 <% stories.each do |header, stories| -%>
 <% if header.strip == '' %>

data/test/saga_document_spec.rb

@@ -26,7 +26,26 @@ describe "A Document" do
     document.definitions.keys.should == sections
   end
   
-  it "should return a list of used IDs" do
+  it "returns the number of stories as its length" do
+    document = Saga::Document.new
+    document.length == 0
+    
+    document.stories[''] = [{}, {}]
+    document.length.should == 2
+    
+    document.stories['Non-functional'] = [{}]
+    document.length.should == 3
+  end
+  
+  it "know whether the document does or does not have stories" do
+    document = Saga::Document.new
+    document.should.be.empty
+    
+    document.stories[''] = [{},{}]
+    document.should.not.be.empty
+  end
+  
+  it "returns a list of used IDs" do
     document = Saga::Document.new
     document.used_ids.should == []
     
@@ -42,7 +61,7 @@ describe "A Document" do
     document.used_ids.should == [2, 12, 3]
   end
   
-  it "should return a list of unused IDs" do
+  it "returns a list of unused IDs" do
     document = Saga::Document.new
     document.unused_ids(0).should == []
     document.unused_ids(3).should == [1,2,3]
@@ -62,7 +81,7 @@ describe "A Document" do
     document.unused_ids(4).should == [1,3,7,8]
   end
   
-  it "should autofills ids" do
+  it "autofills ids" do
     document = Saga::Document.new
     document.autofill_ids
     

data/test/saga_formatter_spec.rb

@@ -4,6 +4,18 @@ describe "Formatter" do
   before do
     @document = Saga::Document.new
     @document.title = 'Requirements API'
+    @document.authors = [
+      {:name => 'Thijs van der Vossen', :email => 'thijs@fngtps.com', :company => 'Fingertips', :website => 'http://www.fngtps.com'},
+      {:name => 'Manfred Stienstra', :email => 'manfred@fngtps.com', :company => 'Fingertips', :website => 'http://www.fngtps.com'}
+    ]
+    @document.introduction = [
+      'A web service for interfacing with the service.', 'Exposes a public API to the application.'
+    ]
+    @document.stories = [
+      ['General', [
+        {:description => 'As a consumer I would like to use TLS (SSL) so that my connection with the API is secure', :id => 4, :status => 'todo' }
+      ]]
+    ]
   end
   
   it "formats a saga document to HTML" do

data/test/saga_planning_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe "An empty Planning" do
+  before do
+    @document = Saga::Document.new
+    @planning = Saga::Planning.new(@document)
+  end
+  
+  it "shows an empty planning message" do
+    @planning.to_s.should == 'There are no stories yet.'
+  end
+end
+
+describe "A simple Planning" do
+  before do
+    @document = Saga::Document.new
+    @document.stories[''] = [{:estimate => [12, :hours]}]
+    @planning = Saga::Planning.new(@document)
+  end
+  
+  it "shows a planning" do
+    @planning.to_s.should ==
+      "Unplanned     : 12 (1 story)\n"+
+      "----------------------------\n"+
+      "Total         : 12 (1 story)"
+  end
+end
+
+describe "A complicated Planning" do
+  before do
+    @document = Saga::Document.new
+    @document.stories[''] = [{:estimate => [12, :hours], :iteration => 1}, {:estimate => [8, :hours]}]
+    @document.stories['Developer'] = [{:estimate => [1, :weeks], :iteration => 2}, {:estimate => [1, :hours], :iteration => 2}]
+    @document.stories['Writer'] = [{:estimate => [5, :hours], :iteration => 1}, {:estimate => [2, :hours], :iteration => 3}]
+    @planning = Saga::Planning.new(@document)
+  end
+  
+  it "shows a planning" do
+    @planning.to_s.should ==
+      "Unplanned     : 8 (1 story)\n"+
+      "Iteration 1   : 17 (2 stories)\n"+
+      "Iteration 2   : 41 (2 stories)\n"+
+      "Iteration 3   : 2 (1 story)\n"+
+      "------------------------------\n"+
+      "Total         : 68 (6 stories)"
+  end
+end

data/test/saga_runner_spec.rb

@@ -88,4 +88,12 @@ describe "A Runner" do
       runner.run
     end.should == "output\n"
   end
+  
+  it "shows an overview of the time planned in the different iterations" do
+    runner = Saga::Runner.new(%w(planning requirements.txt))
+    runner.expects(:planning).with(File.expand_path('requirements.txt')).returns('output')
+    collect_stdout do
+      runner.run
+    end.should == "output\n"
+  end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saga
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -9,39 +15,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 +02:00
+date: 2010-06-21 00:00:00 +02:00
 default_executable: saga
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: erubis
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
         version: "2.6"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
         version: "2.3"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mocha-on-bacon
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id003
 description: Saga is a tool to convert stories syntax to a nicely formatted document.
 email: manfred@fngtps.com
 executables: 
@@ -63,6 +83,7 @@ files:
 - lib/saga/document.rb
 - lib/saga/formatter.rb
 - lib/saga/parser.rb
+- lib/saga/planning.rb
 - lib/saga/runner.rb
 - lib/saga/tokenizer.rb
 - saga.gemspec
@@ -78,6 +99,7 @@ files:
 - test/saga_document_spec.rb
 - test/saga_formatter_spec.rb
 - test/saga_parser_spec.rb
+- test/saga_planning_spec.rb
 - test/saga_runner_spec.rb
 - test/saga_tokenizer_spec.rb
 - test/spec_helper.rb
@@ -91,21 +113,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Saga is a tool to convert stories syntax to a nicely formatted document.
@@ -113,6 +141,7 @@ test_files:
 - test/saga_document_spec.rb
 - test/saga_formatter_spec.rb
 - test/saga_parser_spec.rb
+- test/saga_planning_spec.rb
 - test/saga_runner_spec.rb
 - test/saga_tokenizer_spec.rb
 - test/spec_helper.rb