saga 0.1.0 → 0.2.0

data/Rakefile

@@ -27,6 +27,9 @@ begin
     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

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/saga.rb

@@ -1,3 +1,8 @@
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
 module Saga
   autoload :Document,  'saga/document'
   autoload :Formatter, 'saga/formatter'

data/lib/saga/document.rb

@@ -1,3 +1,5 @@
+require 'active_support/ordered_hash'
+
 module Saga
   class Document
     attr_accessor :title, :introduction, :authors, :stories, :definitions
@@ -6,8 +8,8 @@ module Saga
       @title        = ''
       @introduction = []
       @authors      = []
-      @stories      = {}
-      @definitions  = {}
+      @stories      = ActiveSupport::OrderedHash.new
+      @definitions  = ActiveSupport::OrderedHash.new
     end
   end
 end

data/lib/saga/formatter.rb

@@ -1,27 +1,30 @@
-require 'rubygems'
 require 'erubis'
 
 module Saga
   class Formatter
     TEMPLATE_PATH = File.expand_path('../../../templates', __FILE__)
     
-    def initialize(document)
+    def initialize(document, options={})
       @document = document
+      @options  = options
+      @options[:template] ||= 'default'
     end
     
     def format
-      helpers_file = File.join(self.class.template_path, 'default/helpers.rb')
+      template_path = File.join(self.class.template_path, @options[:template])
+      
+      helpers_file = File.join(template_path, 'helpers.rb')
       load helpers_file
       @document.extend(Helpers)
       binding = @document.send(:binding)
       
-      template_file = File.join(self.class.template_path, 'default/document.erb')
+      template_file = File.join(template_path, 'document.erb')
       template = Erubis::Eruby.new(File.read(template_file))
       template.result(binding)
     end
     
-    def self.format(document)
-      formatter = new(document)
+    def self.format(document, options={})
+      formatter = new(document, options)
       formatter.format
     end
     

data/lib/saga/parser.rb

@@ -19,11 +19,13 @@ module Saga
     end
     
     def handle_story(story)
+      @current_section = :stories
       @document.stories[@current_header] ||= []
       @document.stories[@current_header] << story
     end
     
     def handle_definition(definition)
+      @current_section = :definitions
       @document.definitions[@current_header] ||= []
       @document.definitions[@current_header] << definition
     end
@@ -32,12 +34,13 @@ module Saga
       return if string.strip == ''
       return(@current_section = :body) if string.strip == 'USER STORIES'
       
-      case @current_section
-      when :title
+      if :title == @current_section
         @document.title = string.gsub(/^requirements/i, '').strip
         @current_section = :introduction
-      when :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/runner.rb

@@ -8,9 +8,15 @@ module Saga
     end
     
     def parser
-      OptionParser.new do |opts|
-        opts.banner =  "Usage: saga [command] [options] <file>"
+      @parser ||= OptionParser.new do |opts|
+        opts.banner =  "Usage: saga [command]"
         opts.separator ""
+        opts.separator "Commands:"
+        opts.separator "    new                 - prints a blank stub"
+        opts.separator "    convert <filename>  - convert the stories to HTML"
+        opts.separator "    inspect <filename>  - print the internals of the document"
+        opts.separator ""
+        opts.separator "Options:"
         opts.on("-h", "--help", "Show help") do
           puts opts
           exit
@@ -18,13 +24,37 @@ module Saga
       end
     end
     
+    def new_file
+      document = Saga::Document.new
+      document.title = '(Title)'
+      document.authors << self.class.author
+      Saga::Formatter.format(document, :template => 'saga')
+    end
+    
+    def write_parsed_document(filename)
+      document = Saga::Parser.parse(File.read(filename))
+      puts document.title
+      document.authors.each { |author| p author }
+      puts
+      document.stories.each { |header, stories| puts header; stories.each { |story| p story } }
+      puts
+      document.definitions.each { |header, definitions| puts header; definitions.each { |definition| p definition } }
+    end
+    
+    def convert(filename)
+      Saga::Formatter.format(Saga::Parser.parse(File.read(filename)))
+    end
+    
     def run_command(command, options)
       case command
-      when :run
+      when 'new'
+        puts new_file
+      when 'convert'
+        puts convert(File.expand_path(@argv[1]))
+      when 'inspect'
+        write_parsed_document(File.expand_path(@argv[1]))
       else
-        filename = File.expand_path(command)
-        document = Saga::Parser.parse(File.read(filename))
-        puts Saga::Formatter.format(document)
+        puts convert(File.expand_path(command))
       end
     end
     
@@ -37,5 +67,10 @@ module Saga
         puts parser.to_s
       end
     end
+    
+    def self.author
+      name = `osascript -e "long user name of (system info)" &1> /dev/null`.strip
+      {:name => name}
+    end
   end
 end

data/lib/saga/tokenizer.rb

@@ -9,7 +9,7 @@ module Saga
         @parser.handle_story(self.class.tokenize_story(input))
       elsif input[0,1] == '-'
         @parser.handle_author(self.class.tokenize_author(input))
-      elsif input =~ /^(\w|[\s-])+:/
+      elsif input =~ /^\w(\w|[\s-])+:/
         @parser.handle_definition(self.class.tokenize_definition(input))
       else
         @parser.handle_string(input)
@@ -44,10 +44,14 @@ module Saga
     end
     
     def self.tokenize_story(input)
-      description, attributes = input.split('-')
-      story = tokenize_story_attributes(attributes)
-      story[:description] = description.strip
-      story
+      parts = input.split('-')
+      if parts.length > 1
+        story = tokenize_story_attributes(parts[-1])
+        story[:description] = parts[0..-2].join('-').strip
+        story
+      else
+        { :description => input.strip }
+      end
     end
     
     def self.tokenize_definition(input)

data/saga.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{saga}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Manfred Stienstra"]
+  s.date = %q{2010-03-31}
+  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}
+  s.executables = ["saga"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".kick",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/saga",
+     "lib/saga.rb",
+     "lib/saga/document.rb",
+     "lib/saga/formatter.rb",
+     "lib/saga/parser.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/story.txt",
+     "test/cases/story_attributes.txt",
+     "test/saga_document_spec.rb",
+     "test/saga_formatter_spec.rb",
+     "test/saga_parser_spec.rb",
+     "test/saga_runner_spec.rb",
+     "test/saga_tokenizer_spec.rb",
+     "test/spec_helper.rb"
+  ]
+  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.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_runner_spec.rb",
+     "test/saga_tokenizer_spec.rb",
+     "test/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= 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/templates/default/document.erb

@@ -51,6 +51,11 @@
   <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 %>

data/templates/requirements.txt.erb

@@ -0,0 +1,7 @@
+Requirements <%= title %>
+
+- <%= author %>
+
+USER STORIES
+
+As a developer I would like to write stories so I know what to develop. - #1 todo

data/templates/saga/document.erb

@@ -0,0 +1,7 @@
+Requirements <%= title %>
+
+<% authors.each do |author| %>
+- <%= format_author(author) %>
+<% end %>
+
+USER STORIES

data/templates/saga/helpers.rb

@@ -0,0 +1,7 @@
+module Helpers
+  def format_author(author)
+    [:name, :email, :company, :website].map do |key|
+      author[key]
+    end.compact.join(', ')
+  end
+end

data/test/cases/story.txt

@@ -2,3 +2,5 @@ As a developer I would like to have created database indexes so that the queries
 => {: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/saga_document_spec.rb

@@ -7,4 +7,22 @@ describe "A Document" do
       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
 end

data/test/saga_formatter_spec.rb

@@ -10,4 +10,9 @@ describe "Formatter" do
     html = Saga::Formatter.format(@document)
     html.should.include('<h1>Requirements <br />Requirements API</h1>')
   end
+  
+  it "formats a saga document to saga" do
+    saga = Saga::Formatter.format(@document, :template => 'saga')
+    saga.should.include('Requirements Requirements API')
+  end
 end

data/test/saga_parser_spec.rb

@@ -29,6 +29,10 @@ 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
+    parser.parse('  “Your recording was created successfully.”')
+  end
+  
   def parse_definition
     parser.parse('Other: Stories that don’t fit anywhere else.')
   end
@@ -87,6 +91,17 @@ describe "A Parser, concerning the handling of input" do
     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_comment
+    
+    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 definitions without a header as being a gobal definition" do
     parse_title
     parse_introduction

data/test/saga_runner_spec.rb

@@ -1,16 +1,83 @@
 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
-  it "should show a help text when invoked without a command and options" do
-    @runner = Saga::Runner.new([])
-    @runner.expects(:puts).with(@runner.parser.to_s)
-    @runner.run
+  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 "should show a help test when the -h option is used" do
-    @runner = Saga::Runner.new(%w(-h))
-    @runner.expects(:puts).at_least(1)
-    @runner.stubs(:exit)
-    @runner.run
+  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
 end

data/test/saga_tokenizer_spec.rb

@@ -77,6 +77,12 @@ 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: saga
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Manfred Stienstra
@@ -11,8 +11,37 @@ cert_chain: []
 
 date: 2010-03-31 00:00:00 +02:00
 default_executable: saga
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.3"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha-on-bacon
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Saga is a tool to convert stories syntax to a nicely formatted document.
 email: manfred@fngtps.com
 executables: 
@@ -36,8 +65,12 @@ files:
 - lib/saga/parser.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/story.txt