saga 0.7.1 → 0.8.0

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.8.0

data/lib/saga/document.rb

@@ -12,10 +12,22 @@ module Saga
       @definitions  = ActiveSupport::OrderedHash.new
     end
     
+    def stories_as_flat_list
+      stories_as_flat_list = []
+      stories.values.flatten.each do |story|
+        stories_as_flat_list << story
+        stories_as_flat_list.concat(story[:stories]) if story[:stories]
+      end; stories_as_flat_list
+    end
+    
     def used_ids
       @stories.values.inject([]) do |ids, stories|
-        ids.concat stories.map { |story| story[:id] }
-        ids
+        stories.each do |story|
+          ids << story[:id]
+          story[:stories].each do |nested|
+            ids << nested[:id]
+          end if story[:stories]
+        end; ids
       end.compact
     end
     
@@ -30,7 +42,7 @@ module Saga
     end
     
     def length
-      stories.inject(0) { |total, (_, stories)| total + stories.length }
+      stories_as_flat_list.length
     end
     
     def empty?
@@ -39,10 +51,8 @@ module Saga
     
     def autofill_ids
       unused_ids = unused_ids(length - used_ids.length)
-      stories.each do |_, stories|
-        stories.each do |story|
-          story[:id] ||= unused_ids.shift
-        end
+      stories_as_flat_list.each do |story|
+        story[:id] ||= unused_ids.shift
       end
     end
   end

data/lib/saga/parser.rb

@@ -24,6 +24,22 @@ module Saga
       @document.stories[@current_header] << story
     end
     
+    def handle_nested_story(story)
+      @current_section = :story
+      parent = @document.stories[@current_header][-1]
+      parent[:stories] ||= []
+      parent[:stories] << story
+    end
+    
+    def handle_notes(notes)
+      story = @document.stories[@current_header][-1]
+      if @current_section == :story
+        story[:stories][-1][:notes] = notes
+      else
+        story[:notes] = notes
+      end
+    end
+    
     def handle_definition(definition)
       @current_section = :definitions
       @document.definitions[@current_header] ||= []
@@ -39,8 +55,6 @@ module Saga
         @current_section = :introduction
       elsif :introduction == @current_section
         @document.introduction << string
-      elsif :stories == @current_section and string[0,2] == '  '
-        @document.stories[@current_header][-1][:notes] = string.strip
       else
         @current_header = string.strip
       end

data/lib/saga/planning.rb

@@ -37,6 +37,19 @@ module Saga
       unestimated
     end
     
+    def statusses
+      statusses = {}
+      @document.stories.values.each do |stories|
+        stories.each do |story|
+          if story[:estimate] and story[:status]
+            statusses[story[:status]] ||= 0
+            statusses[story[:status]] += self.class.estimate_to_hours(story[:estimate])
+          end
+        end
+      end
+      statusses
+    end
+    
     def to_s
       if @document.empty?
         "There are no stories yet."
@@ -49,11 +62,18 @@ module Saga
           parts << '-'*formatted_totals.length
           parts << formatted_totals
         end
-        parts << self.class.format_unestimated(unestimated) if unestimated > 0
+        if unestimated > 0 or !statusses.empty?
+          parts << ''
+          parts << self.class.format_unestimated(unestimated) if unestimated > 0
+          parts << self.class.format_statusses(statusses) unless statusses.empty?
+        end
+        parts.shift if parts[0] == ''
         parts.join("\n")
       end
     end
     
+    FIRST_COLUMN_WIDTH = 14
+    
     def self.estimate_to_hours(estimate)
       case estimate[1]
       when :days
@@ -72,11 +92,19 @@ module Saga
         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})"
+      "#{label.ljust(FIRST_COLUMN_WIDTH)}: #{properties[:estimate_total_in_hours]} (#{story_column})"
     end
     
     def self.format_unestimated(unestimated)
       "Unestimated   : #{unestimated > 1 ? "#{unestimated} stories" : 'one story' }"
     end
+    
+    def self.format_statusses(statusses)
+      parts = []
+      statusses.each do |status, hours|
+        parts << "#{status.capitalize.ljust(FIRST_COLUMN_WIDTH)}: #{hours}"
+      end
+      parts.join("\n")
+    end
   end
 end

data/lib/saga/tokenizer.rb

@@ -7,6 +7,12 @@ module Saga
     def process_line(input)
       if input[0,2].downcase == 'as'
         @parser.handle_story(self.class.tokenize_story(input))
+      elsif input[0,2] == '  '
+        @parser.handle_notes(input.strip)
+      elsif input[0,3] == '|  '
+        @parser.handle_notes(input[1..-1].strip)
+      elsif input[0,1] == '|'
+        @parser.handle_nested_story(self.class.tokenize_story(input[1..-1]))
       elsif input[0,1] == '-'
         @parser.handle_author(self.class.tokenize_author(input))
       elsif input =~ /^\w(\w|[\s-])+:/
@@ -59,6 +65,7 @@ module Saga
     end
     
     def self.tokenize_story(input)
+      lines = input.split('\n')
       parts = input.split(' - ')
       if parts.length > 1
         story = tokenize_story_attributes(parts[-1])

data/templates/default/document.erb

@@ -16,6 +16,7 @@
   table.review td.notes { color: #666; padding: 0 0 .25em 0; font-style: italic; }
   table.review .dropped { color: #666; text-decoration: line-through; }
   table.review .done { color: #666; background-color: #f0f8ff; }
+  table.review tr.nested td.story { padding-left: 1em; }
 </style>
 <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.2.6/jquery.min.js"></script>
 </head>
@@ -60,6 +61,22 @@
   <td class="notes" colspan="5"><%= story[:notes] %></td>
 </tr>
 <% end %>
+<% if story[:stories] %>
+<% story[:stories].each do |nested| %>
+<tr class="nested <%= nested[:status] %>" id="story<%= nested[:id] %>">
+  <td class="story"><%= nested[:description] %></td>
+  <td class="meta id"><%= nested[:id] %></td>
+  <td class="meta estimate"><%= format_estimate(*nested[:estimate]) if nested[:estimate] %></td>
+  <td class="meta iteration"><%= nested[:iteration] %></td>
+  <td class="meta status"><%= nested[:status] %></td>
+</tr>
+<% if nested[:notes] %>
+<tr class="nested <%= nested[:status] %>">
+  <td class="notes" colspan="5"><%= nested[:notes] %></td>
+</tr>
+<% end %>
+<% end %>
+<% end %>
 <% end %>
 </table>
 <% end %>

data/templates/saga/document.erb

@@ -19,7 +19,7 @@ USER STORIES
 <%= "\n#{header}\n\n"  -%>
 <% end %>
 <% stories.each do |story| -%>
-<%= format_story(story) %>
+<%= format_story(story) -%>
 <% end -%>
 <% end -%>
 <% definitions.each do |header, definitions| -%>

data/templates/saga/helpers.rb

@@ -16,16 +16,22 @@ module Helpers
     end
   end
   
-  def format_story(story)
+  def format_story(story, kind=:regular)
     story_attributes = []
     story_attributes << "##{story[:id]}" if story[:id]
     story_attributes << story[:status] if story[:status]
     story_attributes << format_estimate(*story[:estimate]) if story[:estimate]
     story_attributes << "i#{story[:iteration]}" if story[:iteration]
     
-    parts = [[story[:description], story_attributes.join(' ')].join(' - ')]
-    parts << "  #{story[:notes]}" if story[:notes]
-    parts.join("\n")
+    prefix = (kind == :nested) ? '| ' : ''
+    formatted  = "#{prefix}#{story[:description]}"
+    formatted << " - #{story_attributes.join(' ')}" unless story_attributes.empty?
+    formatted << "\n"
+    formatted << "#{prefix}  #{story[:notes]}\n" if story[:notes]
+    story[:stories].each do |nested|
+      formatted << format_story(nested, :nested)
+    end if story[:stories]
+    formatted
   end
   
   def format_definition(definition)

data/test/cases/document.txt

@@ -0,0 +1,13 @@
+Requirements Case
+
+- Manfred Stienstra, manfred@fngtps.com
+
+USER STORIES
+
+As a writer I would like to write stories so that developers can implement them. - #1 todo
+  Stories are written in Saga format.
+| As a writer I would like to add nested stories so that I can write requirements on two zoom levels. - todo
+|   Nested stories are basicaly substories of regular stories.
+| As a writer I would like to add header so that I can group stories by theme. - todo
+
+Writer: Someone who is responsible for writing down requirements in the form of stories

data/test/cases/nested_stories.txt

@@ -0,0 +1,4 @@
+As an editor I would like to manage content so that I can keep the site up to date.
+| As an editor I would like to add a page so that I can create new pages.
+| As an editor I would like to remove a page so that I can remove unwanted pages.
+=> {:description => 'As an editor I would like to manage content so that I can keep the site up to date.', :stories => [{:description => 'As an editor I would like to add a page so that I can create new pages.'}, {:description => 'As an editor I would like to remove a page so that I can remove unwanted pages.'}]}

data/test/saga_document_spec.rb

@@ -59,6 +59,11 @@ describe "A Document" do
     
     document.stories['Non-functional'] << { :id => 3 }
     document.used_ids.should == [2, 12, 3]
+    
+    document.stories[''][0][:stories] = [
+      {}, {:id => 14}, {}, {:id => 5}
+    ]
+    document.used_ids.should == [2, 14, 5, 12, 3]
   end
   
   it "returns a list of unused IDs" do
@@ -87,7 +92,9 @@ describe "A Document" do
     
     document.stories[''] = []
     document.stories[''] << { :description => 'First story'}
-    document.stories[''] << { :description => 'Second story'}
+    document.stories[''] << { :description => 'Second story', :stories => [
+      { :description => 'First nested story' }, { :id => 15, :description => 'Second nested story'}
+    ] }
     
     document.stories['Non-functional'] = []
     document.stories['Non-functional'] << { :id => 1, :description => 'Third story' }
@@ -98,7 +105,8 @@ describe "A Document" do
     
     document.autofill_ids
     document.stories[''].map { |story| story[:id] }.should == [2, 4]
+    document.stories[''][1][:stories].map { |story| story[:id] }.should == [5, 15]
     document.stories['Non-functional'].map { |story| story[:id] }.should == [1]
-    document.stories['Developer'].map { |story| story[:id] }.should == [5, 3]
+    document.stories['Developer'].map { |story| story[:id] }.should == [6, 3]
   end
 end

data/test/saga_formatter_spec.rb

@@ -13,7 +13,12 @@ describe "Formatter" do
     ]
     @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', :notes => 'Use a self-signed CA certificate to create the certificates.' }
+        {:description => 'As a consumer I would like to use TLS (SSL) so that my connection with the API is secure', :id => 4, :status => 'todo', :notes => 'Use a self-signed CA certificate to create the certificates.', :stories => [
+            { :description => 'As a consumer I would like to receive a certificate from the provider.', :id => 12, :status => 'done', :notes => 'The certificate for the CA.' },
+            { :description => 'As a consumer I would like to receive a hosts file from the provider.', :id => 13, :status => 'done' }
+          ]
+        },
+        { :description => 'As a consumer I would like to get a list of users', :id => 5, :status => 'todo' }
       ]]
     ]
   end
@@ -21,11 +26,13 @@ describe "Formatter" do
   it "formats a saga document to HTML" do
     html = Saga::Formatter.format(@document)
     html.should.include('<h1>Requirements <br />Requirements API</h1>')
+    html.should.include('receive a certificate')
   end
   
   it "formats a saga document to saga" do
     saga = Saga::Formatter.saga_format(@document)
     saga.should.include('Requirements Requirements API')
+    saga.should.include('receive a certificate')
   end
 
   describe "with an external template" do

data/test/saga_parser_spec.rb

@@ -29,10 +29,18 @@ module ParserHelper
     parser.parse('As a recorder I would like to add a recording so that it becomes available. - #1 todo')
   end
   
-  def parse_story_comment
+  def parse_story_notes
     parser.parse('  “Your recording was created successfully.”')
   end
   
+  def parse_nested_story
+    parser.parse('| As a recorder I would like to add a recording so that it becomes available. - todo')
+  end
+  
+  def parse_nested_story_notes
+    parser.parse('|   “Your recording was created successfully.”')
+  end
+  
   def parse_definition
     parser.parse('Other: Stories that don’t fit anywhere else.')
   end
@@ -43,6 +51,12 @@ describe "Parser" do
     document = Saga::Parser.parse('')
     document.should.be.kind_of?(Saga::Document)
   end
+  
+  it "should initialize and parse a reference document" do
+    document = Saga::Parser.parse(File.read(File.expand_path('../cases/document.txt', __FILE__)))
+    document.should.be.kind_of?(Saga::Document)
+    document.length.should == 3
+  end
 end
 
 describe "A Parser, concerning the handling of input" do
@@ -94,7 +108,7 @@ describe "A Parser, concerning the handling of input" do
   it "interprets a comment after a story as being part of the story" do
     parse_story_marker
     parse_story
-    parse_story_comment
+    parse_story_notes
     
     parser.document.stories.keys.should == ['']
     parser.document.stories[''].length.should == 1
@@ -102,6 +116,26 @@ describe "A Parser, concerning the handling of input" do
     parser.document.stories[''].first[:notes].should == '“Your recording was created successfully.”'
   end
   
+  it "interprets nested story as part of the parent story" do
+    parse_story_marker
+    parse_story
+    parse_story_notes
+    parse_nested_story
+    parse_nested_story_notes
+    parse_nested_story
+    parse_nested_story_notes
+    
+    parser.document.stories.keys.should == ['']
+    parser.document.stories[''].length.should == 1
+    first_story = parser.document.stories[''][0]
+    first_story[:id].should == 1
+    first_story[:notes].should == '“Your recording was created successfully.”'
+    
+    first_story[:stories].length.should == 2
+    first_story[:stories][0][:notes].should == '“Your recording was created successfully.”'
+    first_story[:stories][1][:notes].should == '“Your recording was created successfully.”'
+  end
+  
   it "interprets definitions without a header as being a gobal definition" do
     parse_title
     parse_introduction

data/test/saga_planning_spec.rb

@@ -36,6 +36,7 @@ describe "A Planning for estimated and unestimatesd stories" do
       "Unplanned     : 12 (1 story)\n"+
       "----------------------------\n"+
       "Total         : 12 (1 story)\n"+
+      "\n"+
       "Unestimated   : 3 stories"
   end
 end

data/test/saga_tokenizer_spec.rb

@@ -7,13 +7,13 @@ module CasesHelper
   
   def each_case(path)
     filename = File.expand_path("../cases/#{path}.txt", __FILE__)
-    input = nil
+    input = ''
     File.readlines(filename).each do |line|
-      if input.nil?
-        input = line.strip
-      else
+      if line.start_with?('=>')
         yield input, _parse_expected(line)
-        input = nil
+        input = ''
+      else
+        input << "#{line}\n"
       end
     end
   end
@@ -67,6 +67,36 @@ describe "A Tokenizer" do
     @tokenizer.process_line(line)
   end
   
+  it "sends a tokenized note to the parser" do
+    line = '  Optionally support SSL'
+    notes = line.strip
+    
+    @parser.expects(:handle_notes).with(notes)
+    @tokenizer.process_line(line)
+  end
+  
+  it "doesn't mistake a story note with a semicolon as a definition" do
+    line = '  It would be nice if we could use http://www.braintreepaymentsolutions.com/'
+    @parser.expects(:handle_notes).with(line.strip)
+    @tokenizer.process_line(line)
+  end
+  
+  it "sends a nested tokenized story to the parser" do
+    line = '| As a recorder I would like to use TLS (SSL) so that my connection with the storage API is secure and I can be sure of the API’s identity. - #4 todo'
+    story = Saga::Tokenizer.tokenize_story(line[1..-1])
+    
+    @parser.expects(:handle_nested_story).with(story)
+    @tokenizer.process_line(line)
+  end
+  
+  it "sends a nested tokenized note to the parser" do
+    line = '|   Optionally support SSL'
+    notes = line[4..-1]
+    
+    @parser.expects(:handle_notes).with(notes)
+    @tokenizer.process_line(line)
+  end
+  
   it "sends a tokenized author to the parser" do
     line = '- Manfred Stienstra, manfred@fngtps.com'
     author = Saga::Tokenizer.tokenize_author(line)
@@ -83,12 +113,6 @@ describe "A Tokenizer" do
     @tokenizer.process_line(line)
   end
   
-  it "doesn't mistake a story note with a semicolon as a definition" do
-    line = '  It would be nice if we could use http://www.braintreepaymentsolutions.com/'
-    @parser.expects(:handle_string).with(line)
-    @tokenizer.process_line(line)
-  end
-  
   it "send a tokenize defintion to the parser (slighly more complex)" do
     line = 'Search and retrieval: Stories related to selecting and retrieving recordings.'
     definition = Saga::Tokenizer.tokenize_definition(line)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saga
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-04 00:00:00 Z
+date: 2011-10-12 00:00:00 +02:00
+default_executable: saga
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: erubis
@@ -92,6 +93,8 @@ files:
 - templates/saga/helpers.rb
 - test/cases/author.txt
 - test/cases/definition.txt
+- test/cases/document.txt
+- test/cases/nested_stories.txt
 - test/cases/story.txt
 - test/cases/story_attributes.txt
 - test/fixtures/document.erb
@@ -103,6 +106,7 @@ files:
 - test/saga_spec.rb
 - test/saga_tokenizer_spec.rb
 - test/spec_helper.rb
+has_rdoc: true
 homepage: http://fingertips.github.com
 licenses: []
 
@@ -132,16 +136,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Saga is a tool to convert stories syntax to a nicely formatted document.
-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_spec.rb
-- test/saga_tokenizer_spec.rb
-- test/spec_helper.rb
+test_files: []
+