saga 0.11.1 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c513dd09debeec529175004b691ad44ca271fd57
-  data.tar.gz: b779878e3b8e252fc9b36db4e42f07dfee2beaed
+SHA256:
+  metadata.gz: 79f90ac99939d798864d05b8925eea44ca51ff11d38f33e74a07c7baa3a69c0c
+  data.tar.gz: 7e1f6ad4ac27d39b0f2b74a83c291ea8cb93f99099f95d1acf6f38d2d41dffb4
 SHA512:
-  metadata.gz: 071e3b875cb5597313c93ea2c7b64b2311931bfbdac261c2997c36bedd1fb1381c3ad479bf58efa8d63265e8fb46882220f7b7c898db2692877dd2d7dd785a40
-  data.tar.gz: 6e27fddc6dfb04c4089b153681b343e3cbf138d48b7d6e32a46a15d2d1b672546ade76b1b94f5ab0bc9d56f6a3d39670d952a01e787e8bd4770a05282f1cc09c
+  metadata.gz: bda299077b1d0117ff16e927ad167fd6dc104e4e74a65870a173de96fa42b4b284b49ac6496174f24aebc4b20ec3254f4f5a41ea372a56a0b6c92449bd4b1e63
+  data.tar.gz: fc8e568db9e467b5fe47f250f11c4d78cdcffbd444947f33245632ec1a2cad4d3825565e4faaf4c373caf693b9b2e9e2402d935704d273576fde52e9a1683f3c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Fingertips, Manfred Stienstra <manfred@fngtps.com>
+Copyright (c) Fingertips, Manfred Stienstra <manfred@fngtps.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -7,7 +7,6 @@ and definitions. The document is usually a succinct and complete description of
 a piece of software. Anyone reading the document should get a fairly good idea
 of the application without further information.
 
-
 === The introduction
 
 The first line of the document is the title. You can start the line with
@@ -25,7 +24,6 @@ The final part of the introduction is a concise description of the project.
 
   Saga is a tool to convert the requirements format used at Fingertips to HTML.
 
-
 === The stories
 
 The stories section starts with the USER STORIES header.
@@ -51,7 +49,6 @@ little text label at the end describes the status of the story.
 A TextMate bundle for the stories format is available from:
 https://github.com/Fingertips/stories.tmbundle
 
-
 === Definitions
 
 The document ends with a list of definitions. Here we define words used
@@ -60,14 +57,13 @@ or if they might be misunderstood by someone. Like with the stories sections
 are optional.
 
   ROLES
-  
+
   Writer: Someone who was appointed the task of writing the stories.
   Developer: A person developing the application.
-  
+
   DEFINITIONS
-  
-  Project: The software project the developers are working on.
 
+  Project: The software project the developers are working on.
 
 === Template
 
@@ -82,7 +78,6 @@ requirements with the <tt>--template</tt> option:
 
   $ saga convert --template design/requirements_template requirements.txt > requirements.html
 
-
 === Usage
 
   Usage: saga [command]

data/lib/saga.rb

@@ -1,8 +1,3 @@
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
 module Saga
   autoload :Document,  'saga/document'
   autoload :Formatter, 'saga/formatter'
@@ -10,10 +5,10 @@ module Saga
   autoload :Planning,  'saga/planning'
   autoload :Runner,    'saga/runner'
   autoload :Tokenizer, 'saga/tokenizer'
-  
+
   def self.run(argv)
     runner = ::Saga::Runner.new(argv)
     runner.run
     runner
   end
-end
+end

data/lib/saga/document.rb

@@ -1,24 +1,22 @@
-require 'active_support/ordered_hash'
-
 module Saga
   class Document
     attr_accessor :title, :introduction, :authors, :stories, :definitions
-    
+
     def initialize
       @title        = ''
       @introduction = []
       @authors      = []
-      @stories      = ActiveSupport::OrderedHash.new
-      @definitions  = ActiveSupport::OrderedHash.new
+      @stories      = {}
+      @definitions  = {}
     end
-    
+
     def copy_story(story)
       copied = {}
-      [:id, :iteration, :status, :estimate, :description].each do |attribute|
+      %i[id iteration status estimate description].each do |attribute|
         copied[attribute] = story[attribute] if story[attribute]
       end; copied
     end
-    
+
     def flatten_stories(stories)
       stories_as_flat_list = []
       stories.flatten.each do |story|
@@ -30,26 +28,28 @@ module Saga
         end
       end; stories_as_flat_list
     end
-    
+
     def stories_as_flat_list
       flatten_stories(stories.values)
     end
-    
+
     def _binding
       binding
     end
-    
+
     def used_ids
-      @stories.values.inject([]) do |ids, stories|
+      @stories.values.each_with_object([]) do |stories, ids|
         stories.each do |story|
           ids << story[:id]
+          next unless story[:stories]
+
           story[:stories].each do |nested|
             ids << nested[:id]
-          end if story[:stories]
-        end; ids
+          end
+        end
       end.compact
     end
-    
+
     def unused_ids(limit)
       position = 1
       used_ids = used_ids()
@@ -59,29 +59,27 @@ module Saga
         position
       end
     end
-    
+
     def length
       stories_as_flat_list.length
     end
-    
+
     def empty?
       length == 0
     end
-    
+
     def _autofill_ids(stories, unused_ids)
       stories.each do |story|
         story[:id] ||= unused_ids.shift
-        if story[:stories]
-          _autofill_ids(story[:stories], unused_ids)
-        end
+        _autofill_ids(story[:stories], unused_ids) if story[:stories]
       end
     end
-    
+
     def autofill_ids
       unused_ids = unused_ids(length - used_ids.length)
-      stories.each do |section, data|
+      stories.each do |_section, data|
         _autofill_ids(data, unused_ids)
       end
     end
   end
-end
+end

data/lib/saga/formatter.rb

@@ -1,42 +1,70 @@
-require 'erubis'
+require 'erb'
 
 module Saga
   class Formatter
-    TEMPLATE_PATH = File.expand_path('../../../templates', __FILE__)
-    
-    def initialize(document, options={})
+    TEMPLATE_PATH = File.expand_path('../../templates', __dir__)
+
+    attr_reader :document
+    attr_reader :template_path
+
+    def initialize(document, template_path: nil)
       @document = document
-      @options  = options
-      @options[:template] ||= File.join(self.class.template_path, 'default')
+      @template_path ||= template_path || File.join(self.class.template_path, 'default')
+    end
+
+    def template
+      @template ||= build_template
     end
-    
+
     def format
-      helpers_file = File.join(@options[:template], 'helpers.rb')
+      @document.extend(ERB::Util) unless @document.is_a?(ERB::Util)
+
       if File.exist?(helpers_file)
-        load helpers_file
-        @document.extend(Helpers)
-      end
-      
-      template_file = File.join(@options[:template], 'document.erb')
-      if File.exist?(template_file)
-        template = Erubis::Eruby.new(File.read(template_file))
-        template.result(@document._binding)
-      else
-        raise ArgumentError, "The template at path `#{template_file}' could not be found."
+        @document.instance_eval(File.read(helpers_file))
       end
+
+      template.result(@document._binding)
     end
-    
-    def self.format(document, options={})
-      formatter = new(document, options)
+
+    def self.format(document, **kwargs)
+      formatter = new(document, **kwargs)
       formatter.format
     end
-    
+
     def self.template_path
       TEMPLATE_PATH
     end
 
     def self.saga_format(document)
-      format(document, :template => File.join(template_path, 'saga'))
+      format(document, template_path: File.join(template_path, 'saga'))
+    end
+
+    private
+
+    if RUBY_VERSION < '2.6.0'
+      def build_erb
+        ERB.new(File.read(template_file), nil, '-')
+      end
+    else
+      def build_erb
+        ERB.new(File.read(template_file), trim_mode: '-')
+      end
+    end
+
+    def build_template
+      if File.exist?(template_file)
+        build_erb
+      else
+        raise ArgumentError, "The template at path `#{template_file}' could not be found."
+      end
+    end
+
+    def helpers_file
+      File.join(template_path, 'helpers.rb')
+    end
+
+    def template_file
+      File.join(template_path, 'document.erb')
     end
   end
 end

data/lib/saga/parser.rb

@@ -1,41 +1,41 @@
 module Saga
   class Parser
     attr_accessor :document
-    
+
     def initialize
       @tokenizer = ::Saga::Tokenizer.new(self)
       @document  = ::Saga::Document.new
       self.current_section = :title
       @current_header = ''
     end
-    
+
     def current_section=(section)
       @current_section = section
       @tokenizer.current_section = section
     end
-    
+
     def parse(input)
       @tokenizer.process(input)
       @document
     end
-    
+
     def handle_author(author)
       @document.authors << author
     end
-    
+
     def handle_story(story)
       self.current_section = :stories
       @document.stories[@current_header] ||= []
       @document.stories[@current_header] << story
     end
-    
+
     def handle_nested_story(story)
       self.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
@@ -44,33 +44,34 @@ module Saga
         story[:notes] = notes
       end
     end
-    
+
     def handle_definition(definition)
       self.current_section = :definitions
       @document.definitions[@current_header] ||= []
       @document.definitions[@current_header] << definition
     end
-    
+
     def handle_string(string)
       return if string.strip == ''
+
       if string.strip == 'USER STORIES'
         self.current_section = :stories
         return @current_section
       end
-      
-      if :title == @current_section
+
+      if @current_section == :title
         @document.title = string.gsub(/^requirements/i, '').strip
         self.current_section = :introduction
-      elsif :introduction == @current_section
+      elsif @current_section == :introduction
         @document.introduction << string
       else
         @current_header = string.strip
       end
     end
-    
+
     def self.parse(input)
       parser = new
       parser.parse(input)
     end
   end
-end
+end

data/lib/saga/planning.rb

@@ -1,32 +1,35 @@
 module Saga
   class Planning
-    BLANK_ITERATION = {:story_count => 0, :estimate_total_in_hours => 0}
-    
+    BLANK_ITERATION = { story_count: 0, estimate_total_in_hours: 0 }.freeze
+
     def initialize(document)
+      unless document
+        raise ArgumentError, 'Please supply a document for planning.'
+      end
+
       @document = document
     end
-    
+
     def iterations
-      @document.stories_as_flat_list.inject({}) do |properties, story|
-        if story[:estimate]
-          iteration = story[:iteration] || -1
-          properties[iteration] ||= BLANK_ITERATION.dup
-          properties[iteration][:story_count] += 1
-          properties[iteration][:estimate_total_in_hours] += self.class.estimate_to_hours(story[:estimate])
-        end
-        properties
+      @document.stories_as_flat_list.each_with_object({}) do |story, properties|
+        next unless story[:estimate]
+
+        iteration = story[:iteration] || -1
+        properties[iteration] ||= BLANK_ITERATION.dup
+        properties[iteration][:story_count] += 1
+        properties[iteration][:estimate_total_in_hours] += self.class.estimate_to_hours(story[:estimate])
       end
     end
-    
+
     def total
       total = BLANK_ITERATION.dup
-      iterations.each do |iteration, properties|
+      iterations.each do |_iteration, properties|
         total[:story_count] += properties[:story_count]
         total[:estimate_total_in_hours] += properties[:estimate_total_in_hours]
       end
       total
     end
-    
+
     def unestimated
       unestimated = 0
       @document.stories_as_flat_list.each do |story|
@@ -34,7 +37,7 @@ module Saga
       end
       unestimated
     end
-    
+
     def range_estimated
       range_estimated = 0
       @document.stories_as_flat_list.each do |story|
@@ -44,31 +47,31 @@ module Saga
       end
       range_estimated
     end
-    
+
     def statusses
       statusses = {}
       @document.stories_as_flat_list.each do |story|
-        if story[:estimate] and story[:status]
+        if story[:estimate] && story[:status]
           statusses[story[:status]] ||= 0
           statusses[story[:status]] += self.class.estimate_to_hours(story[:estimate])
         end
       end
       statusses
     end
-    
+
     def to_s
       if @document.empty?
-        "There are no stories yet."
+        'There are no stories yet.'
       else
         parts = iterations.keys.sort.map do |iteration|
           self.class.format_properties(iteration, iterations[iteration])
         end
         unless parts.empty?
           formatted_totals = self.class.format_properties(false, total)
-          parts << '-'*formatted_totals.length
+          parts << '-' * formatted_totals.length
           parts << formatted_totals
         end
-        if unestimated > 0 or !statusses.empty?
+        if (unestimated > 0) || !statusses.empty?
           parts << ''
           parts << self.class.format_unestimated(unestimated) if unestimated > 0
           parts << self.class.format_range_estimated(range_estimated) if range_estimated > 0
@@ -78,9 +81,9 @@ module Saga
         parts.join("\n")
       end
     end
-    
+
     FIRST_COLUMN_WIDTH = 14
-    
+
     def self.estimate_to_hours(estimate)
       case estimate[1]
       when :days
@@ -93,29 +96,29 @@ module Saga
         estimate[0]
       end
     end
-    
+
     def self.format_properties(iteration, properties)
-      if iteration
-        label = (iteration == -1) ? "Unplanned" : "Iteration #{iteration}"
-      else
-        label = 'Total'
-      end
+      label = if iteration
+                iteration == -1 ? 'Unplanned' : "Iteration #{iteration}"
+              else
+                'Total'
+              end
       story_column = format_stories_count(properties[:story_count])
       "#{label.ljust(FIRST_COLUMN_WIDTH)}: #{properties[:estimate_total_in_hours]} (#{story_column})"
     end
-    
+
     def self.format_unestimated(unestimated)
       "Unestimated   : #{format_stories_count(unestimated)}"
     end
-    
+
     def self.format_range_estimated(range_estimated)
       "Range-estimate: #{format_stories_count(range_estimated)}"
     end
-    
+
     def self.format_stories_count(count)
       count > 1 ? "#{count} stories" : 'one story'
     end
-    
+
     def self.format_statusses(statusses)
       parts = []
       statusses.each do |status, hours|
@@ -124,4 +127,4 @@ module Saga
       parts.join("\n")
     end
   end
-end
+end

data/lib/saga/runner.rb

@@ -1,56 +1,70 @@
 require 'optparse'
- 
+require 'ostruct'
+
 module Saga
   class Runner
     def initialize(argv)
       @argv = argv
-      @options = {}
     end
-    
+
+    def options
+      unless defined?(@options)
+        @options = OpenStruct.new(run: true)
+        parser.parse!(@argv)
+      end
+      @options
+    end
+
     def parser
-      @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 "    autofill <filename> - adds an id to stories without one"
-        opts.separator "    planning <filename> - shows the planning of stories in iterations"
-        opts.separator "    template <dir>      - creates a template directory"
-        opts.separator ""
-        opts.separator "Options:"
-        opts.on("-t", "--template DIR", "Use an external template for conversion to HTML") do |template_path|
-          @options[:template] = File.expand_path(template_path)
+      @parser ||= OptionParser.new do |parser|
+        parser.banner =  'Usage: saga [command]'
+        parser.separator ''
+        parser.separator 'Commands:'
+        parser.separator '    new                 - prints a blank stub'
+        parser.separator '    convert <filename>  - convert the stories to HTML'
+        parser.separator '    inspect <filename>  - print the internals of the document'
+        parser.separator '    autofill <filename> - adds an id to stories without one'
+        parser.separator '    planning <filename> - shows the planning of stories in iterations'
+        parser.separator '    template <dir>      - creates a template directory'
+        parser.separator ''
+        parser.separator 'Options:'
+        parser.on('-t', '--template DIR', 'Use an external template for conversion to HTML') do |template_path|
+          @options.template_path = File.expand_path(template_path)
         end
-        opts.on("-h", "--help",     "Show help") do
-          puts opts
-          exit
+        parser.on('-h', '--help', 'Show help') do
+          puts parser
+          @options.run = false
         end
       end
     end
-    
+
     def new_file
       document = Saga::Document.new
       document.title = 'Title'
-      document.authors << self.class.author
+      document.authors << author
       document.stories[''] = [{
-        :description => 'As a writer I would like to write stories so developers can implement them.',
-        :id => 1,
-        :status => 'todo'
+        description: 'As a writer I would like to write stories so developers can implement them.',
+        id: 1,
+        status: 'todo'
       }]
       document.definitions[''] = [{
-        :title => 'Writer',
-        :definition => 'Someone who is responsible for writing down requirements in the form of stories'
+        title: 'Writer',
+        definition: 'Someone who is responsible for writing down requirements in the form of stories'
       }]
-      
+
       Saga::Formatter.saga_format(document)
     end
-    
-    def convert(filename, options)
-      Saga::Formatter.format(Saga::Parser.parse(File.read(filename)), options)
+
+    def convert_options
+      {
+        template_path: options.template_path
+      }.compact
+    end
+
+    def convert(filename)
+      Saga::Formatter.format(Saga::Parser.parse(File.read(filename)), **convert_options)
     end
-    
+
     def write_parsed_document(filename)
       document = Saga::Parser.parse(File.read(filename))
       puts document.title
@@ -60,17 +74,17 @@ module Saga
       puts
       document.definitions.each { |header, definitions| puts header; definitions.each { |definition| p definition } }
     end
-    
+
     def autofill(filename)
       document = Saga::Parser.parse(File.read(filename))
       document.autofill_ids
       Saga::Formatter.saga_format(document)
     end
-    
+
     def planning(filename)
       Saga::Planning.new(Saga::Parser.parse(File.read(filename))).to_s
     end
-    
+
     def copy_template(destination)
       if File.exist?(destination)
         puts "The directory `#{destination}' already exists!"
@@ -81,13 +95,13 @@ module Saga
         FileUtils.cp(File.join(Saga::Formatter.template_path, 'default/document.erb'), destination)
       end
     end
-    
-    def run_command(command, options)
+
+    def run_command(command)
       case command
       when 'new'
         puts new_file
       when 'convert'
-        puts convert(File.expand_path(@argv[0]), options)
+        puts convert(File.expand_path(@argv[0]))
       when 'inspect'
         write_parsed_document(File.expand_path(@argv[0]))
       when 'autofill'
@@ -97,22 +111,22 @@ module Saga
       when 'template'
         copy_template(File.expand_path(@argv[0]))
       else
-        puts convert(File.expand_path(command), options)
+        puts convert(File.expand_path(command))
       end
     end
-    
+
     def run
-      parser.parse!(@argv)
+      return unless options.run
+
       if command = @argv.shift
-        run_command(command, @options)
+        run_command(command)
       else
         puts parser.to_s
       end
     end
-    
-    def self.author
-      name = `osascript -e "long user name of (system info)" &1> /dev/null`.strip
-      {:name => name}
+
+    def author
+      { name: `osascript -e "long user name of (system info)" &1> /dev/null`.strip }
     end
   end
 end

data/lib/saga/tokenizer.rb

@@ -1,27 +1,27 @@
 module Saga
   class Tokenizer
     attr_accessor :current_section
-    
-    RE_STORY = /\./
-    RE_DEFINITION = /\A[[:alpha:]]([[:alpha:]]|[\s-])+:/
-    
+
+    RE_STORY = /\./.freeze
+    RE_DEFINITION = /\A[[:alpha:]]([[:alpha:]]|[\s-])+:/.freeze
+
     def initialize(parser)
       @parser = parser
-      @part = :current_section
+      @current_section = nil
     end
-    
+
     def expect_stories?
-      %w(story stories).include?(@current_section.to_s)
+      %w[story stories].include?(current_section.to_s)
     end
-    
-    def process_line(input, index=0)
-      if input[0,2] == '  '
+
+    def process_line(input, index = 0)
+      if input[0, 2] == '  '
         @parser.handle_notes(input.strip)
-      elsif input[0,3] == '|  '
+      elsif input[0, 3] == '|  '
         @parser.handle_notes(input[1..-1].strip)
-      elsif input[0,1] == '|'
+      elsif input[0, 1] == '|'
         @parser.handle_nested_story(self.class.tokenize_story(input[1..-1]))
-      elsif input[0,1] == '-'
+      elsif input[0, 1] == '-'
         @parser.handle_author(self.class.tokenize_author(input))
       elsif input =~ RE_DEFINITION
         @parser.handle_definition(self.class.tokenize_definition(input))
@@ -30,17 +30,17 @@ module Saga
       else
         @parser.handle_string(input)
       end
-    rescue Exception => exception
+    rescue StandardError
       $stderr.write "On line #{index}: #{input.inspect}:"
       raise
     end
-    
+
     def process(input)
       input.split("\n").each_with_index do |line, index|
         process_line(line, index)
       end
     end
-    
+
     def self.interval(input)
       case input.strip
       when 'd'
@@ -51,18 +51,18 @@ module Saga
         :hours
       end
     end
-    
-    RE_STORY_NUMBER = /\#(\d+)/
-    RE_STORY_ITERATION = /i(\d+)/
-    RE_STORY_ESTIMATE_PART = /(\d+)(d|w|h|)/
-    
+
+    RE_STORY_NUMBER = /\#(\d+)/.freeze
+    RE_STORY_ITERATION = /i(\d+)/.freeze
+    RE_STORY_ESTIMATE_PART = /(\d+)(d|w|h|)/.freeze
+
     def self.tokenize_story_attributes(input)
       return {} if input.nil?
-      
+
       attributes = {}
       rest       = []
       parts      = input.split(/\s/)
-      
+
       parts.each do |part|
         if part.strip == ''
           next
@@ -71,7 +71,7 @@ module Saga
         elsif match = RE_STORY_ITERATION.match(part)
           attributes[:iteration] = match[1].to_i
         elsif match = /#{RE_STORY_ESTIMATE_PART}-#{RE_STORY_ESTIMATE_PART}/.match(part)
-          estimate = "#{match[1,2].join}-#{match[3,2].join}"
+          estimate = "#{match[1, 2].join}-#{match[3, 2].join}"
           attributes[:estimate] = [estimate, :range]
         elsif match = RE_STORY_ESTIMATE_PART.match(part)
           attributes[:estimate] = [match[1].to_i, interval(match[2])]
@@ -79,31 +79,30 @@ module Saga
           rest << part
         end
       end
-      
+
       attributes[:status] = rest.join(' ') unless rest.empty?
       attributes
     end
-    
+
     def self.tokenize_story(input)
-      lines = input.split('\n')
       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 }
+        { description: input.strip }
       end
     end
-    
+
     def self.tokenize_definition(input)
       if match = /^([^:]+)\s*:\s*(.+)\s*$/.match(input)
-        {:title => match[1], :definition => match[2]}
+        { title: match[1], definition: match[2] }
       else
         {}
       end
     end
-    
+
     def self.tokenize_author(input)
       author = {}
       parts = input[1..-1].split(',')
@@ -114,4 +113,4 @@ module Saga
       author
     end
   end
-end
+end

data/lib/saga/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Saga
+  VERSION = '0.12.0'.freeze
+end

metadata

@@ -1,59 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: saga
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: erubis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: bacon
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: mocha-on-bacon
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,20 +38,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Saga is a tool to convert stories syntax to a nicely formatted document.
-email: manfred@fngtps.com
-executables:
-- saga
+description: |2
+    Saga reads its own story format and formats to other output formats using
+    templates.
+email:
+- manfred@fngtps.com
+executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
 files:
 - LICENSE
 - README.rdoc
-- Rakefile
-- VERSION
-- bin/saga
 - lib/saga.rb
 - lib/saga/document.rb
 - lib/saga/formatter.rb
@@ -87,13 +56,10 @@ files:
 - lib/saga/planning.rb
 - lib/saga/runner.rb
 - lib/saga/tokenizer.rb
-- templates/default/document.erb
-- templates/default/helpers.rb
-- templates/requirements.txt.erb
-- templates/saga/document.erb
-- templates/saga/helpers.rb
-homepage: 
-licenses: []
+- lib/saga/version.rb
+homepage: https://github.com/Fingertips/saga
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -110,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Saga is a tool to convert stories syntax to a nicely formatted document.

data/Rakefile

@@ -1,18 +0,0 @@
-require 'rake'
-require 'rdoc/task'
-
-desc "Run all specs by default"
-task :default => [:spec]
-
-desc "Run all specs"
-task :spec do
-  sh 'bacon test/*_spec.rb'
-end
-
-namespace :documentation do
-  Rake::RDocTask.new(:generate) do |rd|
-    rd.main = "README.rdoc"
-    rd.rdoc_files.include("README.rdoc", "LICENSE", "bin/**/*.rb", "lib/**/*.rb", "templates/**/*.rb")
-    rd.options << "--all" << "--charset" << "utf-8"
-  end
-end

data/VERSION

@@ -1 +0,0 @@
-0.10.0

data/bin/saga

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.expand_path('../../lib', __FILE__))
-require 'saga'
-Saga.run(ARGV)

data/templates/default/document.erb

@@ -1,97 +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; }
-  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 /><%= title %></h1>
-
-<% authors.each do |author| %>
-<p class="author"><%= format_author(author) %></p>
-<% end %>
-
-<% introduction.each do |paragraph| %>
-<p><%== paragraph %></p>
-<% end %>
-
-<% unless stories.empty? %>
-<h2>User stories</h2>
-<% stories.each do |header, stories| %>
-<% 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"><%= format_estimate(*story[:estimate]) if 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 %>
-<% 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 %>
-<% end %>
-
-<% definitions.each do |header, definitions| %>
-<% unless header.strip == '' %>
-<h2><%= format_header(header) %></h2>
-<% end %>
-<dl>
-<% definitions.each do |definition| %>
-<dt><%= definition[:title] %></dt>
-<dd><%= definition[:definition] %></dd>
-<% end %>
-</dl>
-<% end %>
-</body>
-</html>

data/templates/default/helpers.rb

@@ -1,32 +0,0 @@
-module Helpers
-  def format_author(author)
-    parts = []
-    parts << author[:name] if author[:name]
-    parts << "<a href=\"mailto:#{author[:email]}\">#{author[:email]}</a>" if author[:email]
-    if author[:website] and author[:company]
-      parts << "<a href=\"#{author[:website]}\">#{author[:company]}</a>"
-    elsif author[:company]
-      parts << author[:company]
-    end
-    parts.join(', ')
-  end
-  
-  def format_header(header)
-    "#{header[0,1].upcase}#{header[1..-1].downcase}"
-  end
-  
-  def pluralize(cardinality, singular, plural)
-    [cardinality, cardinality == 1 ? singular : plural].join(' ')
-  end
-  
-  def format_estimate(cardinality, interval)
-    case interval
-    when :days
-      pluralize(cardinality, 'day', 'days')
-    when :weeks
-      pluralize(cardinality, 'week', 'days')
-    else
-      cardinality.to_s
-    end
-  end
-end

data/templates/requirements.txt.erb

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

@@ -1,34 +0,0 @@
-Requirements <%= title %>
-<% unless authors.empty? %>
-
-<% authors.each do |author| -%>
-- <%= format_author(author) -%>
-
-<% end -%>
-<% end -%>
-
-<% introduction.each do |paragraph| %>
-<%= paragraph %>
-
-<% end %>
-USER STORIES
-<% stories.each do |header, stories| -%>
-<% if header.strip == '' %>
-
-<% else %>
-<%= "\n#{header}\n\n"  -%>
-<% end %>
-<% stories.each do |story| -%>
-<%= format_story(story) -%>
-<% end -%>
-<% end -%>
-<% definitions.each do |header, definitions| -%>
-<% if header.strip == '' %>
-
-<% else %>
-<%= "\n#{header}\n\n"  -%>
-<% end %>
-<% definitions.each do |definition| -%>
-<%= format_definition(definition) %>
-<% end %>
-<% end %>

data/templates/saga/helpers.rb

@@ -1,40 +0,0 @@
-module Helpers
-  def format_author(author)
-    [:name, :email, :company, :website].map do |key|
-      author[key]
-    end.compact.join(', ')
-  end
-  
-  def format_estimate(cardinality, interval)
-    case interval
-    when :days
-      "#{cardinality}d"
-    when :weeks
-      "#{cardinality}w"
-    else
-      cardinality.to_s
-    end
-  end
-  
-  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]
-    
-    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)
-    [definition[:title], definition[:definition]].join(': ')
-  end
-end