RubyGems - saga - Versions diffs - 0.8.0 → 0.8.1 - Mend

saga 0.8.0 → 0.8.1

Files changed (12) hide show

data/.kick +7 -0
data/VERSION +1 -1
data/design/requirements.html +83 -0
data/design/requirements.txt +16 -0
data/lib/saga/planning.rb +7 -11
data/saga.gemspec +15 -21
data/templates/default/document.erb +1 -1
data/test/cases/document.txt +2 -0
data/test/fixtures/document.erb +1 -1
data/test/saga_formatter_spec.rb +7 -1
data/test/saga_planning_spec.rb +15 -13
metadata +7 -7

data/.kick CHANGED Viewed

@@ -15,4 +15,11 @@ process do |files|
       "test/saga_tokenizer_spec.rb"
     end
   end)
+  files.take_and_map do |file|
+    case file
+    when 'design/requirements.txt'
+      log `./bin/saga design/requirements.txt > design/requirements.html`
+      files.delete(file)
+    end
+  end
 end

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.8.0
1	+ 0.8.1

data/design/requirements.html ADDED Viewed

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+<head>
+<title>Requirements Saga &middot; Fingertips</title>
+<link rel="stylesheet" type="text/css" media="all" href="http://resources.fngtps.com/2006/doc.css" />
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<style type="text/css">
+  td.id { text-align: right !important; }
+  td.id a { color: #000; }
+  table.review { border-bottom: 1px solid #ccc; margin-top: -1em;}
+  table.review td { padding: .25em 0; vertical-align: top; text-align: left; min-width: 1em; }
+  table.review th { padding: .25em 0; vertical-align: top; text-align: right; }
+  table.review td.story { width: 100%; border-top: 1px solid #ccc; }
+  table.review td.meta { padding-left: 1em; border-top: 1px solid #ccc; text-align: right !important; white-space: nowrap; }
+  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>
+<body id="doc" class="requirements">
+<p id="logo"><img src="http://resources.fngtps.com/2006/print-logo.png" alt="Fingertips design &amp; development" /> </p>
+<h1>Requirements <br />Saga</h1>
+<p class="author">Manfred Stienstra, <a href="mailto:manfred@fngtps.com">manfred@fngtps.com</a></p>
+<h2>User stories</h2>
+<table class="review">
+<tr>
+  <th></th>
+  <th title="id">#</th>
+  <th title="Estimate">e</th>
+  <th title="Iteration">i</th>
+  <th title="Status">s</th>
+</tr>
+<tr class="done" id="story1">
+  <td class="story">As a writer I would like to write stories so developers can implement them.</td>
+  <td class="meta id">1</td>
+  <td class="meta estimate"></td>
+  <td class="meta iteration"></td>
+  <td class="meta status">done</td>
+</tr>
+<tr class="todo" id="story2">
+  <td class="story">As a writer I would like to add priorities to my stories so that I can show their importance.</td>
+  <td class="meta id">2</td>
+  <td class="meta estimate"></td>
+  <td class="meta iteration"></td>
+  <td class="meta status">todo</td>
+</tr>
+<tr class="todo" id="story3">
+  <td class="story">As a writer I would like to order my stories so that I can easily find the story I need.</td>
+  <td class="meta id">3</td>
+  <td class="meta estimate"></td>
+  <td class="meta iteration"></td>
+  <td class="meta status">todo</td>
+</tr>
+<tr class="todo">
+  <td class="notes" colspan="5">Improve the HTML template to allow ordering by ID, estimate, iteration, status, and priority.</td>
+</tr>
+<tr class="todo" id="story4">
+  <td class="story">As a writer I would like to ignore certain themes during autofill and planning so that I can specify non-functional stories.</td>
+  <td class="meta id">4</td>
+  <td class="meta estimate"></td>
+  <td class="meta iteration"></td>
+  <td class="meta status">todo</td>
+</tr>
+<tr class="todo">
+  <td class="notes" colspan="5">saga -n 'Non-functional' -n 'Optional' autofill design/requirements.txt</td>
+</tr>
+</table>
+<h2>Roles</h2>
+<dl>
+<dt>Writer</dt>
+<dd>Someone who is responsible for writing down requirements in the form of stories</dd>
+</dl>
+</body>
+</html>

data/design/requirements.txt ADDED Viewed

@@ -0,0 +1,16 @@
+Requirements Saga
+- Manfred Stienstra, manfred@fngtps.com
+USER STORIES
+As a writer I would like to write stories so developers can implement them. - #1 done
+As a writer I would like to add priorities to my stories so that I can show their importance. - #2 todo
+As a writer I would like to order my stories so that I can easily find the story I need. - #3 todo
+  Improve the HTML template to allow ordering by ID, estimate, iteration, status, and priority.
+As a writer I would like to ignore certain themes during autofill and planning so that I can specify non-functional stories. - #4 todo
+  saga -n 'Non-functional' -n 'Optional' autofill design/requirements.txt
+ROLES
+Writer: Someone who is responsible for writing down requirements in the form of stories

data/lib/saga/planning.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module Saga
     end
     def iterations
-      @document.stories.values.flatten.inject({}) do |properties, story|
+      @document.stories_as_flat_list.inject({}) do |properties, story|
         if story[:estimate]
           iteration = story[:iteration] || -1
           properties[iteration] ||= BLANK_ITERATION.dup
@@ -29,22 +29,18 @@ module Saga
     def unestimated
       unestimated = 0
-      @document.stories.values.each do |stories|
-        stories.each do |story|
-          unestimated += 1 unless story[:estimate]
-        end
+      @document.stories_as_flat_list.each do |story|
+        unestimated += 1 unless story[:estimate]
       end
       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
+      @document.stories_as_flat_list.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
       statusses

data/saga.gemspec CHANGED Viewed

@@ -4,15 +4,15 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
-  s.name = %q{saga}
-  s.version = "0.7.1"
+  s.name = "saga"
+  s.version = "0.8.1"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Manfred Stienstra}]
-  s.date = %q{2011-07-04}
-  s.description = %q{Saga is a tool to convert stories syntax to a nicely formatted document.}
-  s.email = %q{manfred@fngtps.com}
-  s.executables = [%q{saga}]
+  s.authors = ["Manfred Stienstra"]
+  s.date = "2012-06-18"
+  s.description = "Saga is a tool to convert stories syntax to a nicely formatted document."
+  s.email = "manfred@fngtps.com"
+  s.executables = ["saga"]
   s.extra_rdoc_files = [
     "LICENSE",
     "README.rdoc"
@@ -24,6 +24,8 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "bin/saga",
+    "design/requirements.html",
+    "design/requirements.txt",
     "lib/saga.rb",
     "lib/saga/document.rb",
     "lib/saga/formatter.rb",
@@ -39,6 +41,8 @@ Gem::Specification.new do |s|
     "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",
@@ -51,20 +55,10 @@ Gem::Specification.new do |s|
     "test/saga_tokenizer_spec.rb",
     "test/spec_helper.rb"
   ]
-  s.homepage = %q{http://fingertips.github.com}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  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_spec.rb",
-    "test/saga_tokenizer_spec.rb",
-    "test/spec_helper.rb"
-  ]
+  s.homepage = "http://fingertips.github.com"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.18"
+  s.summary = "Saga is a tool to convert stories syntax to a nicely formatted document."
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/templates/default/document.erb CHANGED Viewed

@@ -31,7 +31,7 @@
 <% end %>
 <% introduction.each do |paragraph| %>
-<p><%= paragraph %></p>
+<p><%== paragraph %></p>
 <% end %>
 <% unless stories.empty? %>

data/test/cases/document.txt CHANGED Viewed

@@ -2,6 +2,8 @@ Requirements Case
 - Manfred Stienstra, manfred@fngtps.com
+Saga is a tool for writing and publishing <requirements> in the form of user stories.
 USER STORIES
 As a writer I would like to write stories so that developers can implement them. - #1 todo

data/test/fixtures/document.erb CHANGED Viewed

@@ -30,7 +30,7 @@
 <% end %>
 <% introduction.each do |paragraph| %>
-<p><%= paragraph %></p>
+<p><%== paragraph %></p>
 <% end %>
 <% unless stories.empty? %>

data/test/saga_formatter_spec.rb CHANGED Viewed

@@ -9,7 +9,7 @@ describe "Formatter" do
       {: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.'
+      'A web service for interfacing with the service.', 'Exposes a public API to the application.', 'Uses <20> levels of redirection.'
     ]
     @document.stories = [
       ['General', [
@@ -29,6 +29,12 @@ describe "Formatter" do
     html.should.include('receive a certificate')
   end
+  it "include the escaped introduction in the HTML output" do
+    html = Saga::Formatter.format(@document)
+    html.should.include('<p>Uses &lt;20&gt; levels of redirection.</p>')
+    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')

data/test/saga_planning_spec.rb CHANGED Viewed

@@ -14,30 +14,30 @@ end
 describe "A Planning for unestimated stories" do
   before do
     @document = Saga::Document.new
-    @document.stories[''] = [{}, {}, {}]
+    @document.stories[''] = [{}, {}, {:stories => [{}, {}]}]
     @planning = Saga::Planning.new(@document)
   end
   it "shows a planning" do
-    @planning.to_s.should == "Unestimated   : 3 stories"
+    @planning.to_s.should == "Unestimated   : 5 stories"
   end
 end
-describe "A Planning for estimated and unestimatesd stories" do
+describe "A Planning for estimated and unestimated stories" do
   before do
     @document = Saga::Document.new
     @document.stories[''] = [{}, {}, {}]
-    @document.stories['Member'] = [{:estimate => [12, :hours]}]
+    @document.stories['Member'] = [{}, {:estimate => [6, :hours], :stories => [{:estimate => [6, :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)\n"+
+      "Unplanned     : 12 (2 stories)\n"+
+      "------------------------------\n"+
+      "Total         : 12 (2 stories)\n"+
       "\n"+
-      "Unestimated   : 3 stories"
+      "Unestimated   : 5 stories"
   end
 end
@@ -59,19 +59,21 @@ 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[''] = [{:estimate => [12, :hours], :iteration => 1}, {:estimate => [8, :hours], :stories => [{}, {}]}]
+    @document.stories['Developer'] = [{:estimate => [1, :weeks], :iteration => 2,:stories => [{:estimate => [2, :hours], :iteration => 2}, {:estimate => [1, :hours]}]}, {: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"+
+      "Unplanned     : 9 (2 stories)\n"+
       "Iteration 1   : 17 (2 stories)\n"+
-      "Iteration 2   : 41 (2 stories)\n"+
+      "Iteration 2   : 43 (3 stories)\n"+
       "Iteration 3   : 2 (1 story)\n"+
       "------------------------------\n"+
-      "Total         : 68 (6 stories)"
+      "Total         : 71 (8 stories)\n"+
+      "\n"+
+      "Unestimated   : 2 stories"
   end
 end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: saga
 version: !ruby/object:Gem::Version
-  hash: 63
+  hash: 61
   prerelease:
   segments:
   - 0
   - 8
-  - 0
-  version: 0.8.0
+  - 1
+  version: 0.8.1
 platform: ruby
 authors:
 - Manfred Stienstra
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-12 00:00:00 +02:00
-default_executable: saga
+date: 2012-06-18 00:00:00 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
@@ -78,6 +77,8 @@ files:
 - Rakefile
 - VERSION
 - bin/saga
+- design/requirements.html
+- design/requirements.txt
 - lib/saga.rb
 - lib/saga/document.rb
 - lib/saga/formatter.rb
@@ -106,7 +107,6 @@ files:
 - test/saga_spec.rb
 - test/saga_tokenizer_spec.rb
 - test/spec_helper.rb
-has_rdoc: true
 homepage: http://fingertips.github.com
 licenses: []
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubyforge_project:
-rubygems_version: 1.6.2
+rubygems_version: 1.8.18
 signing_key:
 specification_version: 3
 summary: Saga is a tool to convert stories syntax to a nicely formatted document.