saga 0.13.2 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4094964e1d44aed093bd97b5b9996553ae8588c5da221193a36800fcbca0e5d9
-  data.tar.gz: 043da35cf45444bf5518cd1ace35484e0acb8aba25c603cc024d7d1282b07d68
+  metadata.gz: beaae8ecc51e2ef96e5343ffc064ab3290f490f722e44c68fa3a766986161371
+  data.tar.gz: 9ccabb4c4e6ea3563d893bfe04054aebfd954fd26e825415bb56735003d64f08
 SHA512:
-  metadata.gz: 795bdf665843a8b3f947b1d8adf9ae02720f8f2974916f3406122d7873d98572954b80d7feb54cd0cc7328917ddd90bbeeae87113de4a7944a497c8a1f5c6b9b
-  data.tar.gz: 304432814c5a89f48ff6fde9e9e4f89e573ea35ff8cb1fed8f64f8f64cc8afe95acb5ff99bdad4f68f4eea407ab5b72f82ecae0478bbac561e8fa258ef6fd1cb
+  metadata.gz: add20ee8c3436a11c6141ec3e9e9ed82c9a16f4965894bb044633b5846cc8df4fe047f6b81fe12aad6ef167a65426b1a8f98c643e0a23a8110adb5bbbcf6bd9a
+  data.tar.gz: 0772c7c89c5cd0ae6f1f6b1bc1aad3e3a48e44163fed93d6104c5e1ecb5e3d42ea052674bcec8c5ecf87e034217aad2e72f5a4afc301d1f38ef0ae66cd7cf23a

data/lib/saga/runner.rb

@@ -26,6 +26,7 @@ module Saga
         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 '    verify <dir>        - checks internal consistency of the document'
         parser.separator ''
         parser.separator 'Options:'
         parser.on('-t', '--template DIR', 'Use an external template for conversion to HTML') do |template_path|
@@ -96,20 +97,26 @@ module Saga
       end
     end
 
+    def verify(filename)
+      Saga::Verifier.new(Saga::Parser.parse(File.read(filename))).run
+    end
+
     def run_command(command)
       case command
       when 'new'
         puts new_file
       when 'convert'
-        puts convert(File.expand_path(@argv[0]))
+        puts convert(file_path)
       when 'inspect'
-        write_parsed_document(File.expand_path(@argv[0]))
+        write_parsed_document(file_path)
       when 'autofill'
-        puts autofill(File.expand_path(@argv[0]))
+        puts autofill(file_path)
       when 'planning'
-        puts planning(File.expand_path(@argv[0]))
+        puts planning(file_path)
       when 'template'
-        copy_template(File.expand_path(@argv[0]))
+        copy_template(file_path)
+      when 'verify'
+        verify(file_path)
       else
         puts convert(File.expand_path(command))
       end
@@ -128,5 +135,9 @@ module Saga
     def author
       { name: `osascript -e "long user name of (system info)" &1> /dev/null`.strip }
     end
+
+    def file_path
+      File.expand_path(@argv[0])
+    end
   end
 end

data/lib/saga/verifier.rb

@@ -0,0 +1,70 @@
+module Saga
+  class Verifier
+    attr_reader :document
+
+    def initialize(document)
+      @document = document
+    end
+
+    def structure
+      @structure ||= build_structure
+    end
+
+    def run
+      return if structure.empty?
+
+      reported = []
+      structure.each do |title, details|
+        if details[:duplicates].any?
+          warning = "has multiple stories with the same id: " \
+                    "#{format_sentence(details[:duplicates])}"
+          if title.strip != ""
+            puts "* Section #{format_title(title)} #{warning}"
+          else
+            puts "* Document #{warning}"
+          end
+        end
+
+        structure.each do |other_title, other_details|
+          next if title == other_title
+
+          reused = details[:ids] & other_details[:ids]
+          if reused.any?
+            pair = [title, other_title].sort
+            unless reported.include?(pair)
+              puts(
+                "* Sections #{format_title(title)} and #{format_title(other_title)} " \
+                "share story ids: #{format_sentence(reused)}"
+              )
+              reported << pair
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def build_structure
+      document.stories.each.with_object({}) do |(title, stories), structure|
+        structure[title] ||= {}
+        ids = stories.map { |story| story[:id] }
+        structure[title][:ids] = ids
+        structure[title][:duplicates] = ids.uniq.select { |id| ids.count(id) > 1 }
+      end
+    end
+
+    def format_title(title)
+      %("#{title}")
+    end
+
+    def format_sentence(items)
+      case items.size
+      when 0, 1, 2
+        items.join(" and ")
+      else
+        format_sentence(items[..-2].join(", "), items[-1])
+      end
+    end
+  end
+end

data/lib/saga/version.rb

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

data/lib/saga.rb

@@ -5,6 +5,7 @@ module Saga
   autoload :Planning,  'saga/planning'
   autoload :Runner,    'saga/runner'
   autoload :Tokenizer, 'saga/tokenizer'
+  autoload :Verifier,  'saga/verifier'
 
   def self.run(argv)
     runner = ::Saga::Runner.new(argv)

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: saga
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 0.14.0
 platform: ruby
 authors:
 - Manfred Stienstra
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,6 +57,7 @@ files:
 - lib/saga/planning.rb
 - lib/saga/runner.rb
 - lib/saga/tokenizer.rb
+- lib/saga/verifier.rb
 - lib/saga/version.rb
 - templates/default/document.erb
 - templates/default/helpers.rb
@@ -68,7 +68,6 @@ homepage: https://github.com/Fingertips/saga
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Saga is a tool to convert stories syntax to a nicely formatted document.
 test_files: []