clerq 0.3.3 → 0.3.4

data/lib/assets/promo/promo.thor

@@ -9,7 +9,7 @@ class Promo < Thor
   def publish
     doc = Clerq.settings.document
     tmp = '.publish.md'
-    `clerq build -t pandoc.md.erb -o #{tmp}`
+    `clerq build -o #{tmp}`
     Dir.chdir(Clerq.settings.bin) do
       `pandoc -s --toc #{tmp} -o "#{doc}.docx"`
       File.delete(tmp)

data/lib/assets/promo/src/clerq.md

@@ -1,14 +1,14 @@
-# 1 Introduction
+# Introduction
 {{skip_meta: true}}
 
-## 1.1 Purpose
+## Purpose
 {{skip_meta: true}}
 
 The purpose of this document is to provide a demo project "Clerq Promo SRS" for all perspective Clerq users to introduce the system by example and provide a sandbox for experiments for the existing users.
 
 The other purpose (rather technical) is to have repository that provides all possible combinations of markup inside (links, ids, macros, etc.) to exercise in writing documents templates.   
 
-## 1.2 Scope
+## Scope
 {{skip_meta: true}}
 
 This software system will be a command-line interface (CLI) that provides a set of tools related to requirements management tasks. The system will also provide the requirements repository structure and the format of the requirements sources.
@@ -17,7 +17,7 @@ The system does not provide any graphical user interface. Assumed that users cre
 
 Any features related to restricting access to the requirements repository or to the functions of the system are out of scope. Assumed that each project repository is under control of an SCM tool (Git, Subversion, etc.) and the SCM is in charge of user's access to the SCM artifacts.
 
-## 1.3 Definitions, acronyms, and abbreviations
+## Definitions, acronyms, and abbreviations
 {{skip_meta: true}}
 
 CLI
@@ -40,16 +40,14 @@ OS
 
 :   Operations System
 
-[//]: # (to use the extension `--from markdown+definition_lists`)
-
-## 1.4 References
+## References
 {{skip_meta: true}}
 
 1. [Markdown Guide](https://www.markdownguide.org/)
-2. [Pandoc User’s Guide](https://pandoc.org/MANUAL.html)
-3. [Git Documentation](https://git-scm.com/doc)
+2. [Pandoc User's Guide](https://pandoc.org/MANUAL.html)
+3. [Git User's Manual](https://git-scm.com/docs/user-manual.html)
 
-## 1.5 Overview
+## Overview
 {{skip_meta: true}}
 
 The remaining sections of this document provide user requirements and functional requirements of the system.
@@ -58,10 +56,10 @@ The next chapter [[us]] introduces the system from User Stories' point of view a
 
 The following chapter [[fr]] describes detailed requirements for functions and user interfaces that are based on user stories from the previous chapter. The chapter is structured around system components and is written primarily for developers and quality assurance specialists.
 
-# [us] 2 User stories
+# [us] User stories
 {{skip_meta: true; order_index: .reader .writer}}
 
-# [fr] 3 Functional requirements
+# [fr] Functional requirements
 {{skip_meta: true}}
 
 ## [cmp] Components

data/lib/assets/tt/default.md.erb

@@ -1,42 +1,9 @@
 <%
-
-require 'delegate'
-
-class MarkupNode < SimpleDelegator
-  def title
-    s = super
-    s = ".#{id.split(/\./).last}" if s.empty?
-    '#' * nesting_level + ' ' + s
-  end
-
-  def meta
-    return '' if nesting_level == 0
-    hsh = {}.merge(super)
-    hsh.delete(:parent)
-    hsh.delete(:order_index)
-    hsh.delete(:filename)
-    return '' if hsh.empty?
-
-    hsh.map{|k, v| "#{k}: #{v}"}
-       .unshift("{{")
-       .push("}}")
-       .join("\n")
-  end
-
-  def markup
-    [].tap do |o|
-      o << title
-      o << meta unless meta.empty?
-      unless body.empty?
-        o << "\n#{body}"
-      end
-    end.join("\n")
-  end
-end
+require_relative "lib/markup_node"
 -%>
 % <%= @object.title %>
-% generated by Clerq on <%= Time.now.strftime('%B %e, %Y at %H:%M') %>
-% default template
+% This file was generated by [Clerq](https://nvoynov.github.io/clerq/) <%= Time.now.strftime('on %B %e, %Y at %H:%M') %>
+% using "default.md.erb" template
 
 <% for @node in @object.to_a.drop(1) -%>
 <%   n = MarkupNode.new(@node) -%>

data/lib/clerq/services/service.rb

@@ -4,8 +4,14 @@ module Clerq
   module Services
 
     class Service
-      def self.call(*args, **opts)
-        new(*args, **opts).call
+      if RUBY_VERSION =~ /3\.[[:digit:]]+\.[[:digit:]]/
+        def self.call(*args, **opts)
+          new(*args, **opts).call
+        end
+      else
+        def self.call(*args)
+          new(*args).call
+        end
       end
 
       private_class_method :new

data/lib/clerq/version.rb

@@ -1,3 +1,3 @@
 module Clerq
-  VERSION = "0.3.3"
+  VERSION = "0.3.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerq
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Nikolay Voynov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - clerq.thor
 - docs/README.md
 - docs/_config.yml
+- docs/promo.png
 - exe/clerq
 - lib/assets/knb/SRS-IEEE-830-1998.md
 - lib/assets/knb/SRS-RUP.md
@@ -104,7 +105,11 @@ files:
 - lib/assets/knb/vision-document.md
 - lib/assets/lib/clerq_doc.thor
 - lib/assets/lib/colonize_repo.rb
+- lib/assets/lib/markup_macro.rb
+- lib/assets/lib/markup_node.rb
 - lib/assets/lib/spec/colonize_repo_spec.rb
+- lib/assets/lib/spec/markup_macro_spec.rb
+- lib/assets/lib/spec/markup_node_spec.rb
 - lib/assets/new/README.md.tt
 - lib/assets/new/clerq.thor.tt
 - lib/assets/new/clerq.yml.tt
@@ -132,7 +137,6 @@ files:
 - lib/assets/promo/src/us/us.reader.md
 - lib/assets/promo/src/us/us.writer.md
 - lib/assets/tt/default.md.erb
-- lib/assets/tt/pandoc.md.erb
 - lib/clerq.rb
 - lib/clerq/cli.rb
 - lib/clerq/entities.rb
@@ -154,6 +158,7 @@ files:
 - lib/clerq/services/service.rb
 - lib/clerq/settings.rb
 - lib/clerq/version.rb
+- promo.png
 homepage: https://github.com/nvoynov/clerq
 licenses:
 - MIT

data/lib/assets/tt/pandoc.md.erb

@@ -1,91 +0,0 @@
-<%
-require 'delegate'
-# Template for generate documents by Pandoc
-class MarkupNode < SimpleDelegator
-  def title
-    s = super
-    s = ".#{id.split(/\./).last}" if s.empty?
-    "#{'#' * nesting_level} #{s} {##{url(id)}}"
-  end
-
-  def meta
-    return '' if nesting_level == 0
-    return '' if super[:skip_meta]
-
-    hsh = {id: id}.merge(super)
-    hsh.delete(:order_index)
-    hsh.delete(:filename)
-    hsh.delete(:parent)
-    [].tap{|ary|
-      ary << "Attribute | Value"
-      ary << "--------- | -----"
-      hsh.each{|k,v| ary << "#{k} | #{v}"}
-    }.join("\n")
-  end
-
-  def body
-    # links replacement
-    txt = String.new(super)
-    links.each{|l| txt.gsub! "[[#{l}]]", link(l)}
-    # macro substitution
-    macro.each{|m| txt.gsub! m.regex, m.substitution}
-    txt
-  end
-
-  def link(ref)
-    node = root.find{|n| n.id == ref}
-    return "[#{ref}](#unknown)" unless node
-    "[#{node.title}](##{url(ref)})"
-  end
-
-  def url(id)
-    r = id.start_with?(/[[:digit:]]/) ? "p#{id}" : id
-    r.downcase
-     .gsub(/[^A-Za-z0-9]{1,}/, '-')
-     .gsub(/^-/, '')
-     .gsub(/-$/, '')
-  end
-
-  class Macro
-    attr_reader :regex
-    def initialize(regex, &substitution)
-      @regex, @substitution = regex, substitution
-    end
-
-    def substitution
-      @substitution.call()
-    end
-  end
-
-  def macro
-    [].tap do |ary|
-      ary << Macro.new(/{{@@skip[\s\S]*?}}/, &Proc.new{ '' })
-      ary << Macro.new("{{@@list}}", &Proc.new{list})
-      ary << Macro.new("{{@@tree}}", &Proc.new{tree})
-    end
-  end
-
-  def tree
-    this_level = nesting_level + 1
-    to_a.drop(1).inject([]) do |ary, n|
-      lead_spaces = '   ' * (n.nesting_level - this_level)
-      ary << "#{lead_spaces}* [#{n.title}](##{url(n.id)})"
-    end.join("\n")
-  end
-
-  def list
-    items.inject([]) do |ary, n|
-      ary << "* [#{n.title}](##{url(n.id)})"
-    end.join("\n")
-  end
-end
--%>
-% <%= @object.title %>
-% generated by Clerq on <%= Time.now.strftime('%B %e, %Y at %H:%M') %>
-% pandoc template
-
-<% for @node in @object.to_a.drop(1) -%>
-<%   n = MarkupNode.new(@node) -%>
-<%=  [n.title, n.meta, n.body].select{|t| !t.empty?}.join("\n\n") %>
-
-<% end %>