saga 0.8.1 → 0.9.0

data/Rakefile

@@ -15,19 +15,4 @@ namespace :documentation do
     rd.rdoc_files.include("README.rdoc", "LICENSE", "bin/**/*.rb", "lib/**/*.rb", "templates/**/*.rb")
     rd.options << "--all" << "--charset" << "utf-8"
   end
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "saga"
-    s.summary = s.description = "Saga is a tool to convert stories syntax to a nicely formatted document."
-    s.homepage = "http://fingertips.github.com"
-    s.email = "manfred@fngtps.com"
-    s.authors = ["Manfred Stienstra"]
-    s.add_dependency('erubis', '>= 2.6')
-    s.add_dependency('activesupport', '>= 2.3')
-    s.add_development_dependency('mocha-on-bacon')
-  end
-rescue LoadError
-end
+end

data/lib/saga/document.rb

@@ -20,6 +20,10 @@ module Saga
       end; stories_as_flat_list
     end
     
+    def _binding
+      binding
+    end
+    
     def used_ids
       @stories.values.inject([]) do |ids, stories|
         stories.each do |story|

data/lib/saga/formatter.rb

@@ -20,7 +20,7 @@ module Saga
       template_file = File.join(@options[:template], 'document.erb')
       if File.exist?(template_file)
         template = Erubis::Eruby.new(File.read(template_file))
-        template.result(@document.send(:binding))
+        template.result(@document._binding)
       else
         raise ArgumentError, "The template at path `#{template_file}' could not be found."
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saga
 version: !ruby/object:Gem::Version 
-  hash: 61
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 8
-  - 1
-  version: 0.8.1
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-18 00:00:00 Z
+date: 2012-07-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: erubis
@@ -48,7 +48,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mocha-on-bacon
+  name: bacon
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -61,8 +61,22 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha-on-bacon
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Saga is a tool to convert stories syntax to a nicely formatted document.
-email: manfred@fngtps.com
+email: manfred@fngtpspec.com
 executables: 
 - saga
 extensions: []
@@ -71,43 +85,24 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .kick
 - LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
-- bin/saga
-- design/requirements.html
-- design/requirements.txt
-- lib/saga.rb
+- templates/default/document.erb
+- templates/default/helpers.rb
+- templates/requirements.txt.erb
+- templates/saga/document.erb
+- templates/saga/helpers.rb
 - 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
-- templates/default/document.erb
-- templates/default/helpers.rb
-- templates/requirements.txt.erb
-- templates/saga/document.erb
-- 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
-- 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
-homepage: http://fingertips.github.com
+- lib/saga.rb
+- bin/saga
+homepage: 
 licenses: []
 
 post_install_message: 

data/.kick

@@ -1,25 +0,0 @@
-recipe :ignore
-ignore(/(^tmp|\.DS_Store)$/)
-
-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}
-      "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/design/requirements.html

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

@@ -1,16 +0,0 @@
-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/saga.gemspec

@@ -1,81 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  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 = ["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"
-  ]
-  s.files = [
-    ".kick",
-    "LICENSE",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "bin/saga",
-    "design/requirements.html",
-    "design/requirements.txt",
-    "lib/saga.rb",
-    "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",
-    "templates/default/document.erb",
-    "templates/default/helpers.rb",
-    "templates/requirements.txt.erb",
-    "templates/saga/document.erb",
-    "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",
-    "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
-
-    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"])
-    else
-      s.add_dependency(%q<erubis>, [">= 2.6"])
-      s.add_dependency(%q<activesupport>, [">= 2.3"])
-      s.add_dependency(%q<mocha-on-bacon>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<erubis>, [">= 2.6"])
-    s.add_dependency(%q<activesupport>, [">= 2.3"])
-    s.add_dependency(%q<mocha-on-bacon>, [">= 0"])
-  end
-end
-

data/test/cases/author.txt

@@ -1,8 +0,0 @@
-- Thijs van der Vossen
-=> {:name => 'Thijs van der Vossen'}
-- Thijs van der Vossen, thijs@fngtps.com
-=> {:name => 'Thijs van der Vossen', :email => 'thijs@fngtps.com'}
-- Thijs van der Vossen, thijs@fngtps.com, Fingertips
-=> {:name => 'Thijs van der Vossen', :email => 'thijs@fngtps.com', :company => 'Fingertips'}
-- Thijs van der Vossen, thijs@fngtps.com, Fingertips, http://www.fngtps.com
-=> {:name => 'Thijs van der Vossen', :email => 'thijs@fngtps.com', :company => 'Fingertips', :website => 'http://www.fngtps.com'}

data/test/cases/definition.txt

@@ -1,10 +0,0 @@
-
-=> {}
-User: A user
-=> {:title => 'User', :definition => 'A user'}
-Administrator: Any user with full administrative access.
-=> {:title => 'Administrator', :definition => 'Any user with full administrative access.'}
-Non-functional: Stories related to non-functional requirements.
-=> {:title => 'Non-functional', :definition => 'Stories related to non-functional requirements.'}
-Service: The part of the web service used by clients to provide search and retrieval as well as account, device, and user management.
-=> {:title => 'Service', :definition => 'The part of the web service used by clients to provide search and retrieval as well as account, device, and user management.'}

data/test/cases/document.txt

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

@@ -1,4 +0,0 @@
-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/cases/story.txt

@@ -1,6 +0,0 @@
-As a developer I would like to have created database indexes so that the queries run as fast as possible.
-=> {:description => 'As a developer I would like to have created database indexes so that the queries run as fast as possible.'}
-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
-=> {:description => '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.', :id => 4, :status => 'todo' }
-As a subscriber I would like to be able to buy additional pre-paid recording slots even though I also have a subscription so that I don’t have to upgrade my subscription level when I temporarily need to make a lot more recordings than usual. - #16 todo
-=> {:description => 'As a subscriber I would like to be able to buy additional pre-paid recording slots even though I also have a subscription so that I don’t have to upgrade my subscription level when I temporarily need to make a lot more recordings than usual.', :id => 16, :status => 'todo'}

data/test/cases/story_attributes.txt

@@ -1,22 +0,0 @@
-
-=> {}
-
-=> {}
-#4
-=> {:id => 4}
-#12 todo
-=> {:id => 12, :status => 'todo'}
- #3  partially  done
-=> {:id => 3, :status => 'partially done'}
-12
-=> {:estimate => [12, :hours]}
-1d
-=> {:estimate => [1, :days]}
-#1 1w partially done
-=> {:id => 1, :estimate => [1, :weeks], :status => 'partially done'}
-i12
-=> {:iteration => 12}
-#1 i1
-=> {:id => 1, :iteration => 1}
-#3 1 i2
-=> {:id => 3, :iteration => 2, :estimate => [1, :hours]}

data/test/fixtures/document.erb

@@ -1,80 +0,0 @@
-<?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 <%= title %> &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; }
-</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 /><%= title %></h1>
-
-<% authors.each do |author| %>
-<p class="author"><%= author %></p>
-<% end %>
-
-<% introduction.each do |paragraph| %>
-<p><%== paragraph %></p>
-<% end %>
-
-<% unless stories.empty? %>
-<h2>User stories</h2>
-<% stories.each do |header, stories| %>
-<% unless header.strip == '' %>
-<h3><%= header %></h3>
-<% end %>
-<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>
-<% stories.each do |story| %>
-<tr class="<%= story[:status] %>" id="story<%= story[:id] %>">
-  <td class="story"><%= story[:description] %></td>
-  <td class="meta id"><%= story[:id] %></td>
-  <td class="meta estimate"><%= story[:estimate] %></td>
-  <td class="meta iteration"><%= story[:iteration] %></td>
-  <td class="meta status"><%= story[:status] %></td>
-</tr>
-<% if story[:notes] %>
-<tr class="<%= story[:status] %>">
-  <td class="notes" colspan="5"><%= story[:notes] %></td>
-</tr>
-<% end %>
-<% end %>
-</table>
-<% end %>
-<% end %>
-
-<% definitions.each do |header, definitions| %>
-<% unless header.strip == '' %>
-<h2><%= header %></h2>
-<% end %>
-<dl>
-<% definitions.each do |definition| %>
-<dt><%= definition[:title] %></dt>
-<dd><%= definition[:definition] %></dd>
-<% end %>
-</dl>
-<% end %>
-</body>
-</html>

data/test/saga_document_spec.rb

@@ -1,112 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-describe "A Document" do
-  it "responds to accessors" do
-    document = Saga::Document.new
-    [:title, :introduction, :authors, :stories, :definitions].each do |method|
-      document.should.respond_to(method)
-    end
-  end
-  
-  it "stores stories in the order it receives them" do
-    document = Saga::Document.new
-    sections = %w(First Second Third Fourth Fifth)
-    sections.each do |section|
-      document.stories[section] = {}
-    end
-    document.stories.keys.should == sections
-  end
-  
-  it "stores definitions in the order it receives them" do
-    document = Saga::Document.new
-    sections = %w(First Second Third Fourth Fifth)
-    sections.each do |section|
-      document.definitions[section] = {}
-    end
-    document.definitions.keys.should == sections
-  end
-  
-  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 == []
-    
-    document.stories[''] = []
-    document.stories[''] << { :id => 2 }
-    document.used_ids.should == [2]
-    
-    document.stories['Non-functional'] = []
-    document.stories['Non-functional'] << { :id => 12 }
-    document.used_ids.should == [2, 12]
-    
-    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
-    document = Saga::Document.new
-    document.unused_ids(0).should == []
-    document.unused_ids(3).should == [1,2,3]
-    document.unused_ids(4).should == [1,2,3,4]
-    
-    document.stories[''] = []
-    document.stories[''] << { :id => 2 }
-    document.stories[''] << { :id => 4 }
-    document.stories[''] << { :id => 5 }
-    document.stories[''] << { :id => 6 }
-    document.stories[''] << { :id => 100 }
-    
-    document.unused_ids(0).should == []
-    document.unused_ids(1).should == [1]
-    document.unused_ids(2).should == [1,3]
-    document.unused_ids(3).should == [1,3,7]
-    document.unused_ids(4).should == [1,3,7,8]
-  end
-  
-  it "autofills ids" do
-    document = Saga::Document.new
-    document.autofill_ids
-    
-    document.stories[''] = []
-    document.stories[''] << { :description => 'First 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' }
-    
-    document.stories['Developer'] = []
-    document.stories['Developer'] << { :description => 'Fourth story' }
-    document.stories['Developer'] << { :id => 3, :description => 'Fifth story' }
-    
-    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 == [6, 3]
-  end
-end

data/test/saga_formatter_spec.rb

@@ -1,57 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-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.', 'Uses <20> levels of redirection.'
-    ]
-    @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.', :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
-  
-  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 "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')
-    saga.should.include('receive a certificate')
-  end
-
-  describe "with an external template" do
-    it "raises when the document.erb file doesn't exist" do
-      lambda {
-        Saga::Formatter.format(@document, :template => '/does/not/exist')
-      }.should.raise(ArgumentError, "The template at path `/does/not/exist/document.erb' could not be found.")
-    end
-
-    it "omits the helpers.rb file when it doesn't exist" do
-      formatter = Saga::Formatter.new(@document, :template => File.expand_path('../fixtures', __FILE__))
-      formatter.expects(:load).never
-      formatter.format.should.not.be.empty
-    end
-  end
-end

data/test/saga_parser_spec.rb

@@ -1,169 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-module ParserHelper
-  def parser
-    @parser ||= Saga::Parser.new
-  end
-  
-  def parse(input)
-    Saga::Parser.parse(input)
-  end
-  
-  def parse_title
-    parser.parse("Requirements API\n\n")
-  end
-  
-  def parse_introduction
-    parser.parse("This document describes our API.\n\n")
-  end
-  
-  def parse_story_marker
-    parser.parse('USER STORIES')
-  end
-  
-  def parse_header
-    parser.parse('Storage')
-  end
-  
-  def parse_story
-    parser.parse('As a recorder I would like to add a recording so that it becomes available. - #1 todo')
-  end
-  
-  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
-end
-
-describe "Parser" do
-  it "should initialize and parse" 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
-  extend ParserHelper
-  before { @parser = nil }
-  
-  it "interprets the first line of the document as a title" do
-    document = parse('Requirements API')
-    document.title.should == 'API'
-    
-    document = parse('Record and Search')
-    document.title.should == 'Record and Search'
-  end
-  
-  it "interprets authors" do
-    document = parse('- Manfred Stienstra')
-    document.authors.map { |author| author[:name] }.should == ['Manfred Stienstra']
-  end
-  
-  it "interprets the introduction" do
-    parse_title
-    parse_introduction
-    parser.document.introduction.should == ['This document describes our API.']
-  end
-  
-  it "interprets stories without a header as being a gobal story" do
-    parse_title
-    parse_introduction
-    parse_story_marker
-    parse_story
-    
-    parser.document.stories.keys.should == ['']
-    parser.document.stories[''].length.should == 1
-    parser.document.stories[''].first[:id].should == 1
-  end
-  
-  it "interprets stories with a header as being part of that section" do
-    parse_title
-    parse_introduction
-    parse_story_marker
-    parse_header
-    parse_story
-    
-    parser.document.stories.keys.should == ['Storage']
-    parser.document.stories['Storage'].length.should == 1
-    parser.document.stories['Storage'].first[:id].should == 1
-  end
-  
-  it "interprets a comment after a story as being part of the story" do
-    parse_story_marker
-    parse_story
-    parse_story_notes
-    
-    parser.document.stories.keys.should == ['']
-    parser.document.stories[''].length.should == 1
-    parser.document.stories[''].first[:id].should == 1
-    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
-    parse_story_marker
-    parse_definition
-    
-    parser.document.definitions.keys.should == ['']
-    parser.document.definitions[''].length.should == 1
-    parser.document.definitions[''].first[:title].should == 'Other'
-  end
-  
-  it "interprets definitions with a header as being part of that section" do
-    parse_title
-    parse_introduction
-    parse_story_marker
-    parse_header
-    parse_definition
-    
-    parser.document.definitions.keys.should == ['Storage']
-    parser.document.definitions['Storage'].length.should == 1
-    parser.document.definitions['Storage'].first[:title].should == 'Other'
-  end
-  
-  it "properly parses hard cases" do
-    parse_story_marker
-    parser.parse('As a member I would like the app to keep the information it got from Twitter up-to-date so that changes I make on Twitter get propagated to my listing.')
-    
-    story = parser.document.stories[''].first
-    story[:description].should == 'As a member I would like the app to keep the information it got from Twitter up-to-date so that changes I make on Twitter get propagated to my listing.'
-  end
-end

data/test/saga_planning_spec.rb

@@ -1,79 +0,0 @@
-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 Planning for unestimated stories" do
-  before do
-    @document = Saga::Document.new
-    @document.stories[''] = [{}, {}, {:stories => [{}, {}]}]
-    @planning = Saga::Planning.new(@document)
-  end
-  
-  it "shows a planning" do
-    @planning.to_s.should == "Unestimated   : 5 stories"
-  end
-end
-
-describe "A Planning for estimated and unestimated stories" do
-  before do
-    @document = Saga::Document.new
-    @document.stories[''] = [{}, {}, {}]
-    @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 (2 stories)\n"+
-      "------------------------------\n"+
-      "Total         : 12 (2 stories)\n"+
-      "\n"+
-      "Unestimated   : 5 stories"
-  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], :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     : 9 (2 stories)\n"+
-      "Iteration 1   : 17 (2 stories)\n"+
-      "Iteration 2   : 43 (3 stories)\n"+
-      "Iteration 3   : 2 (1 story)\n"+
-      "------------------------------\n"+
-      "Total         : 71 (8 stories)\n"+
-      "\n"+
-      "Unestimated   : 2 stories"
-  end
-end

data/test/saga_runner_spec.rb

@@ -1,137 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-require 'singleton'
-
-module OutputHelper
-  class Collector
-    attr_reader :written
-    def initialize
-      @written = []
-    end
-    
-    def write(string)
-      @written << string
-    end
-  end
-  
-  def collect_stdout(&block)
-    collector = Collector.new
-    stdout = $stdout
-    $stdout = collector
-    begin
-      block.call
-    ensure
-      $stdout = stdout
-    end
-    collector.written.join
-  end
-end
-
-describe "A Runner" do
-  extend OutputHelper
-  
-  it "shows a help text when invoked without a command and options" do
-    runner = Saga::Runner.new([])
-    collect_stdout do
-      runner.run
-    end.should == runner.parser.to_s
-  end
-  
-  it "shows a help test when the -h option is used" do
-    runner = Saga::Runner.new(%w(-h))
-    runner.stubs(:exit)
-    collect_stdout do
-      runner.run
-    end.should == runner.parser.to_s*2 # Because we stub exit it runs twice ):
-  end
-  
-  it "generates a requirements stub to can get started" do
-    Saga::Runner.stubs(:author).returns({:name => "Manfred Stienstra"})
-    runner = Saga::Runner.new(%w(new))
-    output = collect_stdout do
-      runner.run
-    end
-    output.should.include('Requirements Title')
-    output.should.include('- Manfred Stienstra')
-  end
-  
-  it "knows information about the user currently logged in to the system" do
-    author = Saga::Runner.author
-    author[:name].should.not.be.nil
-  end
-  
-  it "converts the provided filename" do
-    runner = Saga::Runner.new(%w(requirements.txt))
-    runner.expects(:convert).with(File.expand_path('requirements.txt'), {}).returns('output')
-    collect_stdout do
-      runner.run
-    end.should == "output\n"
-  end
-  
-  it "converts the provided filename when the convert command is given" do
-    runner = Saga::Runner.new(%w(convert requirements.txt))
-    runner.expects(:convert).with(File.expand_path('requirements.txt'), {}).returns('output')
-    collect_stdout do
-      runner.run
-    end.should == "output\n"
-  end
-  
-  it "converts the provided filename with an external template" do
-    Saga::Parser.stubs(:parse)
-    File.stubs(:read)
-    Saga::Formatter.expects(:format).with do |_, options|
-      options[:template].should == File.expand_path('path/to/a/template')
-    end
-    runner = Saga::Runner.new(%W(convert --template path/to/a/template requirements.txt))
-    collect_stdout { runner.run }
-  end
-  
-  it "inspects the parsed document" do
-    runner = Saga::Runner.new(%w(inspect requirements.txt))
-    runner.expects(:write_parsed_document).with(File.expand_path('requirements.txt'))
-    runner.run
-  end
-  
-  it "autofills the parsed document" do
-    runner = Saga::Runner.new(%w(autofill requirements.txt))
-    runner.expects(:autofill).with(File.expand_path('requirements.txt')).returns('output')
-    collect_stdout 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
-  
-  it "copies the default template to the specified path" do
-    begin
-      destination = "/tmp/saga-template-dir"
-      Saga::Runner.new(%W(template #{destination})).run
-      File.read(File.join(destination, 'helpers.rb')).should ==
-        File.read(File.join(Saga::Formatter.template_path, 'default/helpers.rb'))
-      File.read(File.join(destination, 'document.erb')).should ==
-        File.read(File.join(Saga::Formatter.template_path, 'default/document.erb'))
-    ensure
-      FileUtils.rm_rf(destination)
-    end
-  end
-  
-  it "complains when tryin to create a template at an existing path" do
-    begin
-      destination = "/tmp/saga-template-dir"
-      FileUtils.mkdir_p(destination)
-      runner = Saga::Runner.new(%W(template #{destination}))
-      collect_stdout do
-        runner.run
-      end.should == "The directory `#{destination}' already exists!\n"
-      File.should.not.exist File.join(destination, 'helpers.rb')
-      File.should.not.exist File.join(destination, 'document.erb')
-    ensure
-      FileUtils.rm_rf(destination)
-    end
-  end
-end

data/test/saga_spec.rb

@@ -1,35 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
-
-describe "Saga" 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 = ActiveSupport::OrderedHash.new
-    [
-      ['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.' }
-      ]]
-    ].each do |key, stories|
-      @document.stories[key] = stories
-    end
-  end
-  
-  it "round-trips through the parser and formatter" do
-    document = @document
-    2.times do
-      saga     = Saga::Formatter.saga_format(document)
-      document = Saga::Parser.parse(saga)
-    end
-    
-    document.title.should == @document.title
-    document.authors.should == @document.authors
-    document.stories.should == @document.stories
-  end
-end

data/test/saga_tokenizer_spec.rb

@@ -1,141 +0,0 @@
-require File.expand_path('../spec_helper', __FILE__)
- 
-module CasesHelper
-  def _parse_expected(line)
-    eval(line[3..-1])
-  end
-  
-  def each_case(path)
-    filename = File.expand_path("../cases/#{path}.txt", __FILE__)
-    input = ''
-    File.readlines(filename).each do |line|
-      if line.start_with?('=>')
-        yield input, _parse_expected(line)
-        input = ''
-      else
-        input << "#{line}\n"
-      end
-    end
-  end
-end
-
-describe "Tokenizer" do
-  extend CasesHelper
-  
-  it "tokenizes story attributes input" do
-    each_case('story_attributes') do |input, expected|
-      Saga::Tokenizer.tokenize_story_attributes(input).should == expected
-    end
-  end
-  
-  it "tokenizes story input" do
-    each_case('story') do |input, expected|
-      Saga::Tokenizer.tokenize_story(input).should == expected
-    end
-  end
-  
-  it "tokenizes hard stories" do
-    Saga::Tokenizer.tokenize_story('As a member I would like the app to keep the information it got from Twitter up-to-date so that changes I make on Twitter get propagated to my listing.').should == {
-      :description => 'As a member I would like the app to keep the information it got from Twitter up-to-date so that changes I make on Twitter get propagated to my listing.'
-    }
-  end
-  
-  it "tokenizes definition input" do
-    each_case('definition') do |input, expected|
-      Saga::Tokenizer.tokenize_definition(input).should == expected
-    end
-  end
-  
-  it "tokenizes author input" do
-    each_case('author') do |input, expected|
-      Saga::Tokenizer.tokenize_author(input).should == expected
-    end
-  end
-end
-
-describe "A Tokenizer" do
-  before do
-    @parser    = stub('Parser')
-    @tokenizer = Saga::Tokenizer.new(@parser)
-  end
-  
-  it "sends a 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)
-    
-    @parser.expects(:handle_story).with(story)
-    @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)
-    
-    @parser.expects(:handle_author).with(author)
-    @tokenizer.process_line(line)
-  end
-  
-  it "sends a tokenized definition to the parser" do
-    line = 'Author: Someone who writes'
-    definition = Saga::Tokenizer.tokenize_definition(line)
-    
-    @parser.expects(:handle_definition).with(definition)
-    @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)
-    
-    @parser.expects(:handle_definition).with(definition)
-    @tokenizer.process_line(line)
-  end
-  
-  it "forwards plain strings to the parser" do
-    [
-      'Requirements User Application',
-      'USER STORIES',
-      ''
-    ].each do |line|
-      @parser.expects(:handle_string).with(line)
-      @tokenizer.process_line(line)
-    end
-  end
-  
-  it "processes lines from the input" do
-    input = File.read(File.expand_path("../cases/story.txt", __FILE__))
-    count = input.split("\n").length
-    @tokenizer.expects(:process_line).times(count)
-    @tokenizer.process(input)
-  end
-end

data/test/spec_helper.rb

@@ -1,11 +0,0 @@
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
-require 'bacon'
-require 'mocha-on-bacon'
-
-Bacon.extend Bacon::TapOutput
-$:.unshift(File.expand_path('../../lib', __FILE__))
-require 'saga'