clerq 0.1.0

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

@@ -0,0 +1,64 @@
+<%
+# Template for drafts
+require 'delegate'
+class MarkupNode < SimpleDelegator
+  def title
+    '#' * nesting_level + ' ' + super
+  end
+
+  def meta
+    return '' if nesting_level == 0
+    return '' if super[:skip_meta]
+
+    hsh = {id: id}.merge(super)
+    hsh.delete(:order_index)
+    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
+
+  # @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}
+  end
+
+  def url(id)
+    id.downcase
+      .gsub(/[^A-Za-z0-9]{1,}/, '-')
+      .gsub(/^-/, '')
+      .gsub(/-$/, '')
+  end
+
+end
+-%>
+% <%= @object.title %>
+% generated by Clerq on <%= Time.now.strftime('%B %e, %Y at %H:%M') %>
+
+<% 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 %>

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

@@ -0,0 +1,93 @@
+<%
+require 'delegate'
+# Template for generate documents by Pandoc
+class MarkupNode < SimpleDelegator
+  def title
+    [].tap do |ary|
+      ary << '#' * (nesting_level + 1)
+      ary << '[' + id + ']' unless __getobj__.meta[:skip_meta]
+      ary << super
+    end.join(' ')
+  end
+
+  def meta
+    return '' if nesting_level == 0
+    return '' if super[:skip_meta]
+
+    hsh = {}.merge(super)
+    hsh.delete(:order_index)
+    hsh.delete(:file_name)
+    hsh.delete(:parent)
+    return '' if hsh.empty?
+
+    [].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(node.title)})"
+  end
+
+  def url(id)
+    id.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') %>
+
+<% 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 %>

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

@@ -0,0 +1,88 @@
+<%
+require 'delegate'
+# Template for generate documents by Pandoc
+class MarkupNode < SimpleDelegator
+  def title
+    "#{'#' * nesting_level} #{super} {##{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(:file_name)
+    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)
+    id = 'p' + id if id[0] == '0'
+    id.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') %> using 'pandoc.md.erb' 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 %>

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

@@ -0,0 +1,23 @@
+<%
+# template for saving created nodes
+require 'delegate'
+class MarkupNode < SimpleDelegator
+  def title
+    '#' * (nesting_level + 1) + ' [' + id + '] ' + super
+  end
+
+  def meta
+    return '' if super.empty?
+    [].tap{|ary|
+      ary << '{{'
+      hsh.each{|k,v| ary << "#{k}: #{v}"}
+      ary << '}}'
+    }.join("\n")
+  end
+end
+-%>
+<% 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 %>

data/lib/clerq.rb

@@ -0,0 +1,41 @@
+require_relative 'clerq/version'
+require_relative 'clerq/entities'
+require_relative 'clerq/gateways'
+require_relative 'clerq/interactors'
+require_relative 'clerq/repositories'
+require_relative 'clerq/properties'
+require_relative 'clerq/settings'
+require_relative 'clerq/templater'
+require_relative 'clerq/cli'
+
+module Clerq
+  class Error < StandardError; end
+
+  class << self
+
+    def root
+      File.dirname __dir__
+    end
+
+    def gateway
+      @gateway ||= Clerq::Gateways::InFiles.new
+    end
+
+    def gateway=(gateway)
+      errmsg =  "Invalid argument! Clark::Gateway required"
+      raise ArgumentError, errmsg unless gateway.is_a? Clerq::Gateways::Gateway
+      @gateway = gateway
+    end
+
+    def settings
+      @settings ||= Settings.new
+    end
+
+    def reset
+      @gateway = nil
+      @settings = nil
+    end
+
+  end
+
+end

data/lib/clerq/cli.rb

@@ -0,0 +1,129 @@
+# encoding: UTF-8
+
+require 'thor'
+require_relative 'interactors'
+include Clerq::Interactors
+
+module Clerq
+
+  class Cli < Thor
+    include Thor::Actions
+    namespace :clerq
+
+    def self.source_root
+      File.join Clerq.root, "lib/assets"
+    end
+
+    desc "--version, -v", "Print the version"
+    def version
+      puts "Clerq v#{Clerq::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc "new PROJECT", "Create a new Clerq project"
+    def new(project)
+      say "Creating project '#{project}'..."
+
+      if Dir.exist?(project)
+        error "Directory '#{project}' already exists!"
+        return
+      end
+
+      settings = Clerq.settings
+      tts = [
+        {tt: 'new/README.md.tt', target: 'README.md'},
+        {tt: 'new/clerq.yml.tt', target: 'clerq.yml'},
+        {tt: 'new/clerq.thor.tt', target: "#{project}.thor"},
+        {tt: 'new/content.md.tt', target: File.join(settings.src, "#{project}.md")}
+      ]
+
+      Dir.mkdir(project)
+      Dir.chdir(project) do
+        settings.folders.each{|f| Dir.mkdir(f)}
+        tts.each do |tt|
+          template(tt[:tt], File.join(Dir.pwd, tt[:target]), {project: project})
+        end
+        directory('tt', File.join(Dir.pwd, 'tt'))
+        say "Project created!"
+      end
+    end
+
+    desc "promo", "Copy content of promo project"
+    def promo
+      say "Copying promo content ..."
+      directory('promo', Dir.pwd)
+    end
+
+    desc "build [OPTIONS]", "Build the clerq project"
+    method_option :query, aliases: "-q", type: :string, desc: "query"
+    method_option :tt, aliases: "-t", type: :string, desc: "template"
+    method_option :output, aliases: "-o", type: :string, desc: "output file"
+    def build
+      settings = Clerq.settings
+      document = options[:output] || settings.document + '.md'
+      template = options[:tt] || settings.template
+      query = options[:query] || ''
+      build = File.join(settings.bin, document)
+      content = CompileNodes.(template: template, query: query)
+      File.write(build, content)
+      say "'#{build}' created!"
+    rescue CompileNodes::Failure => e
+      error e.message
+    end
+
+    desc "check", "Check the project for errors"
+    def check
+      errors = CheckNodes.()
+      if errors.empty?
+        say "No errors found"
+        return
+      end
+
+      CHECK_MESSAGES.each do |key, msg|
+        if errors.key?(key)
+          say "The following #{msg[0]}:"
+          errors[key].each{|k,v| say "\t#{k}\t#{msg[1]} #{v.join(', ')}"}
+        end
+      end
+    rescue CheckNodes::Failure => e
+      error e.message
+    end
+
+    CHECK_MESSAGES = {
+      nonuniq_ids: ['node identifiers are non-uniqe', 'in'],
+      unknown_parents: ['meta[:parent] not found', 'in'],
+      unknown_references: ['links are unknown', 'in'],
+      unknown_order_index: ['node meta[:order_index] unknown', ':']
+    }.freeze
+
+    desc "node ID [TITLE]", "Create a new node"
+    method_option :template, aliases: "-t", type: :string, desc: "template"
+    def node(id, title = '')
+      settings = Clerq.settings
+      file = File.join(settings.src, "#{id}.md")
+      if File.exist?(file)
+        error "File already exists #{fn}"
+        return
+      end
+      template = options[:template] || ''
+      CreateNode.(id: id, title: title, template: template)
+      say "'#{file}' created"
+    rescue CreateNode::Failure => e
+      error e.message
+    end
+
+    desc "toc [OPTIONS]", "Print the project TOC"
+    method_option :query, aliases: "-q", type: :string, desc: "Query"
+    def toc
+      query = options[:query]
+      node = query ? QueryNodes.(query: query) : JoinNodes.()
+      puts "% #{node.title}"
+      node.to_a.drop(1).each{|n|
+        puts  "#{'  ' * (n.nesting_level - 1)}[#{n.id}] #{n.title}"
+      }
+    rescue QueryNodes::Failure, JoinNodes::Failure => e
+      error e.message
+    end
+
+  end
+end

data/lib/clerq/entities.rb

@@ -0,0 +1,2 @@
+require_relative 'entities/node'
+require_relative 'entities/template'