clerq 0.1.0 → 0.3.3

data/lib/assets/lib/clerq_doc.thor

@@ -0,0 +1,119 @@
+require 'clerq'
+require 'thor'
+require 'tmpdir'
+require_relative 'lib/colonize_repo'
+include Clerq::Repositories
+include Clerq::Entities
+include Clerq::Services
+
+# This thor file sample was created with purpose to show some examples
+# of using Pandoc for clerq reposiory publishing and even import souce
+# documents into a clerq repository ... `thor clerq:doc:grab`, `thor clerq:doc:publish`
+class ClerqDoc < Thor
+  include Thor::Actions
+  namespace 'clerq:doc'.to_sym
+
+  no_commands {
+    def eqid!(node)
+      counter = {}
+      node.to_a.drop(1).each do |n|
+        index = counter[n.parent] || 1
+        counter[n.parent] = index + 1
+        id = index.to_s.rjust(2, '0')
+        id = '.' + id unless n.parent == node
+        n.id = id
+      end
+    end
+  }
+
+  # Why does one need to grab the document?
+  #   it started in MS Word but the author decieded to pкoceed in Clerq
+  #   it is the source for the clerq project, SRS based on Vision?
+  #   something else?
+  # TODO provide -q/--query QUERY_STRING parameter
+  # TODO how about importing images?
+  desc 'grab FILENAME', 'Grab document and populate the clerq repository'
+  def grab(filename)
+    mdown = File.join(Dir.tmpdir, 'clerq.grab.md')
+    optns = [].tap{|o|
+      o << '--wrap=none'
+      o << '--atx-headers'
+      o << "#{filename}"
+      o << "-o #{mdown}"
+    }.join(' ')
+
+    `pandoc #{optns}`
+
+    on_error_callback = lambda {|err| puts err}
+    puts "Reading '#{mdown}'..."
+
+    # TODO handle query parameter
+    arry = ReadNode.(mdown, on_error_callback)
+    node = Node.new(id: '00', title: File.basename(mdown, '.md'))
+    arry.each{|n| node << n}
+    eqid!(node)
+
+    puts "Colonizing this repository..."
+    dir_counter = 0
+    src_counter = 0
+    on_create_dir = lambda {|dir| puts "Created '#{dir}' directory"; dir_counter += 1 }
+    on_create_src = lambda {|src| puts "Created '#{src}' file"; src_counter += 1 }
+
+    Dir.chdir(Clerq.src) { ColonizeRepo.(node, on_create_dir, on_create_src) }
+
+    msg = [].tap do |memo|
+      memo << "#{dir_counter} #{dir_counter == 1 ? 'directory' : 'directories'}" if dir_counter > 0
+      memo << "#{src_counter} #{src_counter == 1 ? 'file' : 'files'}" if src_counter > 0
+    end.join(' and ')
+
+    say "#{node.to_a.size} nodes from '#{filename}' imported to the repositroy. #{msg} created in the repository."
+  end
+
+  desc 'publish', 'Publishing final deliverables'
+  def publish
+    invoke :docx
+    invoke :html
+  end
+
+  desc 'html', 'Publish final deliverable in Html'
+  def html
+    source = File.join(Clerq.bin, Clerq.document + ".md")
+    target = File.join(Clerq.bin, Clerq.document + ".html")
+    optns = [].tap{|o|
+      o << '-s --toc --toc-depth 3'
+      o << "--resource-path #{Clerq.bin}"
+      o << "\"#{source}\""
+      o << "-o \"#{target}\""
+    }.join(" ")
+
+    `clerq build -t pandoc.md.erb`
+    `pandoc #{optns}`
+    say "\"#{target}\" created!"
+  end
+
+  desc 'docx', 'Publish final deliverable in Docx'
+  def docx
+    source = File.join(Clerq.bin, Clerq.document + ".md")
+    target = File.join(Clerq.bin, Clerq.document + ".docx")
+    sample = File.join(Clerq.bin, 'custom-reference.docx')
+
+    unless File.exist?(sample)
+      # produce a custom reference.docx
+      `pandoc -o #{sample} --print-default-data-file reference.docx`
+    end
+
+    optns = [].tap{|o|
+      o << '-s --toc --toc-depth 3'
+      o << '--from markdown+table_captions+implicit_figures'
+      o << "--reference-doc #{sample}"
+      o << "--resource-path #{Clerq.bin}"
+      o << "\"#{source}\""
+      o << "-o \"#{target}\""
+    }.join(" ")
+
+    `clerq build -t pandoc.md.erb`
+    `pandoc #{optns}`
+    say "\"#{target}\" created!"
+  end
+
+end

data/lib/assets/lib/colonize_repo.rb

@@ -0,0 +1,82 @@
+require 'clerq'
+require 'erb'
+include Clerq::Entities
+include Clerq::Services
+
+# Creates clerq repository sources in current work directory
+# Warning! Change work dierectory before calling for the serice
+# Usage
+#   node = Clerq.node_repository.assembly
+#   Dir.chdir(Clerq.src) { ColonizeRepo.(node) }
+class ColonizeRepo < Service
+  private_class_method :new
+
+  def call
+    write(@node)
+  end
+
+  # TODO callback? and calback for ReadNode.()?
+  def write(node)
+    dir = folder(node)
+    src = source(node)
+    txt = text(node)
+    unless dir.empty? || Dir.exist?(dir)
+      Dir.mkdir(dir)
+      @on_create_dir.call(dir) if @on_create_dir
+    end
+    File.write(src, txt)
+    @on_create_file.call(src) if @on_create_file
+    node.items.reject{|n| n.items.empty?}.each{|n| write(n)}
+  end
+
+  # @param node [Node] the node for colonization
+  # @param on_create_file [Block(arg)] on create new file callback
+  # @param on_create_dir [Block(arg)] on create new directory callback
+  def initialize(node, on_create_dir = nil, on_create_file = nil)
+    @node = node
+    @on_create_dir = on_create_dir
+    @on_create_file = on_create_file
+  end
+
+  def source(node)
+    fld = folder(node)
+    src = filename(node)
+    fld.empty? ? src : File.join(fld, src)
+  end
+
+  def folder(node)
+    dir = ''
+    n = node
+    while n != @node.root && n.parent != @node.root
+      dir = File.join("#{n.parent.id} #{n.parent.title}", dir)
+      n = n.parent
+    end
+    dir
+  end
+
+  def filename(node)
+    "#{node.id} #{node.title}.md"
+  end
+
+  # TODO replace to services
+  def text(node)
+    RenderErb.(erb: TEMPLATE, object: node)
+  end
+
+  TEMPLATE = <<~EOF
+    # <%= @object.title %>
+    {{id: <%= @object.id %><%= ", parent: " + @object.parent.id if @object.parent %>, order_index: <%= @object.items.map(&:id).join(' ') %>}}
+
+    <%= @object.body %>
+
+    <% for n in @object.items -%>
+    <%   next unless n.items.empty? -%>
+    ## <%= n.title %>
+    {{id: <%= n.id %>}}
+
+    <%= n.body %>
+
+    <% end %>
+  EOF
+
+end

data/lib/assets/lib/spec/colonize_repo_spec.rb

@@ -0,0 +1,85 @@
+require 'clerq'
+require 'erb'
+require 'minitest/autorun'
+require_relative 'colonize_repo'
+include Clerq::Entities
+include Clerq::Services
+
+describe ColonizeRepo do
+  class FakeWriter < ColonizeRepo
+    public_class_method :new
+    attr_reader :node
+  end
+
+  let(:node) {
+    Node.new(id: '0', title: 'Import').tap{|n|
+      n << Node.new(id: '01', title: 'User')
+      n << Node.new(id: '02', title: 'Func')
+      n.item('01') << Node.new(id: '01.01', title: 'Story 1')
+      n.item('01') << Node.new(id: '01.02', title: 'Story 2')
+    }
+  }
+
+  let(:writer) { FakeWriter.new(node) }
+
+  describe '#folder' do
+    it 'must return parent.id + parent.name' do
+      spec = writer.node.map{|n| writer.folder(n)}
+      _(spec).must_equal([
+        '', '', '01 User/', '01 User/', ''
+      ])
+    end
+  end
+
+  describe '#filename' do
+    it 'must return node.id + node.title' do
+      spec = writer.node.map{|n| writer.filename(n)}
+      _(spec).must_equal([
+        '0 Import.md', '01 User.md', '01.01 Story 1.md',
+        '01.02 Story 2.md', '02 Func.md'
+      ])
+    end
+  end
+
+  describe '#source' do
+    # title and first level shall be paced in root folder
+    it 'must return node.id + node.title' do
+      spec = writer.node.map{|n| writer.source(n)}
+      _(spec).must_equal([
+        '0 Import.md',
+        '01 User.md',
+        '01 User/01.01 Story 1.md',
+        '01 User/01.02 Story 2.md',
+        '02 Func.md'
+      ])
+    end
+  end
+
+  describe '#write(node)' do
+    let(:node) {
+      Node.new(id: '0', title: 'Import').tap{|n|
+        n << Node.new(id: '01', title: 'User')
+        n << Node.new(id: '02', title: 'Func')
+        n.item('01') << Node.new(id: '01.01', title: 'Story 1')
+        n.item('01') << Node.new(id: '01.02', title: 'Story 2')
+        n.node('01.01') << Node.new(id: '01.01.01', title: 'Story 1.1')
+        n.node('01.01') << Node.new(id: '01.01.02', title: 'Story 1.2')
+      }
+    }
+
+    it 'must build repo' do
+      files = ['0 Import.md', '01 User.md', '01 User/01.01 Story 1.md']
+      Dir.mktmpdir(['clerq']) do |dir|
+        Dir.chdir(dir) do
+          ColonizeRepo.(node)
+          files.each{|fn| _(File.exist?(fn)).must_equal true }
+          _(File.read('0 Import.md')).wont_match "parent:"
+          _(File.read('01 User.md')).must_match "parent: 0"
+          _(File.read('01 User/01.01 Story 1.md')).must_match "parent: 01"
+        end
+      end
+
+    end
+  end
+
+end

data/lib/assets/new/clerq.thor.tt

@@ -1,15 +1,42 @@
-# TODO how about to include commands automatically from 'lib' folder
-
-require 'thor'
 require 'clerq'
+require 'thor'
 
-class <%=config[:project].capitalize%> < Thor
+class <%=config[:klass]%> < Thor
   include Thor::Actions
 
   desc "stat", "Print statistic"
   def stat
-    nodes = Clerq::Interactors::JoinNodes.()
+    nodes = Clerq.assemble
     say "#{nodes.to_a.drop(1).size} nodes total"
   end
 
+  desc "mm", "Create meeting minutes"
+  def mm
+    minutes = "meeting minutes #{Time.new.strftime('%Y-%m-%d')}.md"
+    content = "% #{minutes.capitalize}\n\n" + MINUTES_TEMPLATE
+    Dir.mkdir('mm') unless Dir.exist?('mm')
+    File.write("mm/#{minutes}", content)
+    say "'mm/#{minutes}' created!"
+  end
+
+  MINUTES_TEMPLATE = <<~EOF
+    # Attendants
+
+    1.
+    2.
+    3.
+
+    # Questions
+
+    1.
+    2.
+    3.
+
+    # Resolutions
+
+    1.
+    2.
+    3.
+  EOF
+
 end

data/lib/assets/new/content.md.tt

@@ -1,41 +1,4 @@
-# Introduction
-{{skip_meta: true}}
+# <%=config[:project]%>
+{{id: 0}}
 
-{{@@skip
-
-This file was created automatically from the premise that you could want to have the high-level structure of the project (document) in a single place.
-
-For the usual descriptive parts (nodes) that do not need unique identifiers - use `skip_meta: true` attribute. To output child parts in appropriate order - use the `order_index: nx ny nz` attribute.
-
-Pay attention that this content placed under `skip` macro that means this content won't be included in the output document.}}
-
-## Purpose
-{{skip_meta: true}}
-
-The purpose of this document is to provide a detailed product description of the <%= config[:project] %>. The document describes the product from user and software requirements perspectives.
-
-All parties who are responsible for the definition and implementation of the project should read and understand this document.
-
-## Scope
-{{skip_meta: true}}
-
-## Definitions, acronyms, and abbreviations
-{{skip_meta: true}}
-
-## References
-{{skip_meta: true}}
-
-## Overview
-{{skip_meta: true}}
-
-# Users and Stakeholders
-{{skip_meta: true}}
-
-# User requirements
-{{skip_meta: true}}
-
-# Functional requirements
-{{skip_meta: true}}
-
-# Nonfunctional requirements
-{{skip_meta: true}}
+This file was created automatically by the `clerq new` command as the root node of your project. To familiarize yourself with how to start writing with the Clerq - please read the [Writing](https://github.com/nvoynov/clerq/blob/master/README.md#writing) section and then just delete the content of the paragraph.

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

@@ -1,64 +1,45 @@
 <%
-# Template for drafts
+
 require 'delegate'
+
 class MarkupNode < SimpleDelegator
   def title
-    '#' * nesting_level + ' ' + super
+    s = super
+    s = ".#{id.split(/\./).last}" if s.empty?
+    '#' * nesting_level + ' ' + s
   end
 
   def meta
     return '' if nesting_level == 0
-    return '' if super[:skip_meta]
-
-    hsh = {id: id}.merge(super)
-    hsh.delete(:order_index)
+    hsh = {}.merge(super)
     hsh.delete(:parent)
-    hsh.delete(:file_name)
-    [].tap{|ary|
-      ary << "Attribute | Value"
-      ary << "--------- | -----"
-      hsh.each{|k,v| ary << "#{k} | #{v}"}
-    }.join("\n")
-  end
-
-  def body
-    return '' if super.empty?
-    # replace links
-    txt = String.new(super)
-    links.each{|l| txt.gsub!("[[#{l}]]", link(l))}
-    txt
-  end
-
-  def link(id)
-    r = find_node(id)
-    return "[#{id}](#unknown)" unless r
-    "[#{r.title}](##{url(r.id)})"
-  end
+    hsh.delete(:order_index)
+    hsh.delete(:filename)
+    return '' if hsh.empty?
 
-  # @param [String] id Node id, when it starts with
-  #   '.' it finds for first descendant by #end_with?
-  #   '*' it finds first note by #end_with? from root
-  # @return [Node] or nil when node not found
-  def find_node(id)
-    return find{|n| n.id.end_with? id[1..-1]} if id.start_with? '.'
-    return root.find{|n| n.id.end_with? id[1..-1]} if id.start_with? '*'
-    root.find{|n| n.id.eql? id}
+    hsh.map{|k, v| "#{k}: #{v}"}
+       .unshift("{{")
+       .push("}}")
+       .join("\n")
   end
 
-  def url(id)
-    id.downcase
-      .gsub(/[^A-Za-z0-9]{1,}/, '-')
-      .gsub(/^-/, '')
-      .gsub(/-$/, '')
+  def markup
+    [].tap do |o|
+      o << title
+      o << meta unless meta.empty?
+      unless body.empty?
+        o << "\n#{body}"
+      end
+    end.join("\n")
   end
-
 end
 -%>
 % <%= @object.title %>
 % generated by Clerq on <%= Time.now.strftime('%B %e, %Y at %H:%M') %>
+% default 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") %>
+<%=  n.markup %>
 
 <% end %>