clerq 0.2.0 → 0.3.0

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/content.md.tt

@@ -1,3 +1,4 @@
 # <%=config[:project]%>
+{{id: 0}}
 
 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

@@ -12,7 +12,7 @@ class MarkupNode < SimpleDelegator
     hsh = {}.merge(super)
     hsh.delete(:parent)
     hsh.delete(:order_index)
-    hsh.delete(:file_name)
+    hsh.delete(:filename)
     return '' if hsh.empty?
 
     hsh.map{|k, v| "#{k}: #{v}"}

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

@@ -12,7 +12,7 @@ class MarkupNode < SimpleDelegator
 
     hsh = {id: id}.merge(super)
     hsh.delete(:order_index)
-    hsh.delete(:file_name)
+    hsh.delete(:filename)
     hsh.delete(:parent)
     [].tap{|ary|
       ary << "Attribute | Value"
@@ -37,11 +37,11 @@ class MarkupNode < SimpleDelegator
   end
 
   def url(id)
-    id = 'p' + id if id[0] == '0'
-    id.downcase
-      .gsub(/[^A-Za-z0-9]{1,}/, '-')
-      .gsub(/^-/, '')
-      .gsub(/-$/, '')
+    r = id.start_with?(/[[:digit:]]/) ? "p#{id}" : id
+    r.downcase
+     .gsub(/[^A-Za-z0-9]{1,}/, '-')
+     .gsub(/^-/, '')
+     .gsub(/-$/, '')
   end
 
   class Macro

data/lib/clerq.rb

@@ -1,10 +1,9 @@
 require_relative 'clerq/version'
 require_relative 'clerq/entities'
-require_relative 'clerq/interactors'
+require_relative 'clerq/services'
 require_relative 'clerq/repositories'
 require_relative 'clerq/properties'
 require_relative 'clerq/settings'
-require_relative 'clerq/render_erb'
 require_relative 'clerq/cli'
 include Clerq::Repositories
 
@@ -76,6 +75,12 @@ module Clerq
       @node_repository = repository
     end
 
+    def assemble(on_parse: nil, on_error: nil)
+      node_repository.assemble(
+        on_parse: on_parse,
+        on_error: on_error)
+    end
+
   end
 
 end

data/lib/clerq/cli.rb

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 require 'thor'
-require_relative 'interactors'
-include Clerq::Interactors
+require_relative 'services'
+include Clerq::Services
 
 module Clerq
 
@@ -23,7 +23,7 @@ module Clerq
     no_commands {
       # @param [String]
       # @returns [String] usual name for ruby file
-      def thor_file_name(str);
+      def thor_filename(str);
         str.split(/[\W+_]/).map(&:downcase).join('_') + '.thor'
       end
 
@@ -44,6 +44,13 @@ module Clerq
       def stop!(msg)
         raise Thor::Error, msg
       end
+
+      def query_assembly(query)
+        # TODO pretty errors ...OK, ... 1 error found, ... 2 errors found
+        on_parse = lambda {|src| puts "Reading '#{src}'... "}
+        on_error = lambda {|err| puts "\terror: #{err} "}
+        QueryAssembly.(query: query, on_parse: on_parse, on_error: on_error)
+      end
     }
 
     desc "new PROJECT", "Create a new Clerq project"
@@ -55,7 +62,7 @@ module Clerq
       tts = [
         {tt: 'new/README.md.tt', target: 'README.md'},
         {tt: 'new/clerq.yml.tt', target: Clerq::Settings::STORAGE},
-        {tt: 'new/clerq.thor.tt', target: thor_file_name(project)},
+        {tt: 'new/clerq.thor.tt', target: thor_filename(project)},
         {tt: 'new/content.md.tt', target: File.join(settings.src, "#{project}.md")}
       ]
 
@@ -68,6 +75,7 @@ module Clerq
           template(tt[:tt], File.join(Dir.pwd, tt[:target]), config)
         end
         directory('tt', File.join(Dir.pwd, 'tt'))
+        directory('lib', File.join(Dir.pwd, 'lib'))
         say "Project created!"
       end
     end
@@ -87,68 +95,46 @@ module Clerq
       stop_unless_clerq!
       document = options[:output] || Clerq.document + '.md'
       template = options[:tt] || Clerq.template
-      query = options[:query] || ''
       build = File.join(Clerq.bin, document)
-      content = RenderAssembly.(template: template, query: query)
-      File.write(build, content)
+
+      node = LoadAssembly.()
+      node = QueryNode.(assembly: node, query: options[:query]) if options[:query]
+      text = RenderNode.(node: node, template: template)
+      File.write(build, text)
       say "'#{build}' created!"
-    rescue RenderAssembly::Failure => e
+    rescue StandardError => e
       stop!(e.message)
     end
 
     desc "check", "Check the project for errors"
     def check
       stop_unless_clerq!
-      errors = CheckAssembly.()
-      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 CheckAssembly::Failure => e
-      stop!(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 = '')
-      stop_unless_clerq!
-      # smells! smells! smells!
-      # TODO interactor must return file name
-      # TODO must not check if file exists - it task of repository
-      file = File.join(Clerq.src, "#{id}.md")
-      stop!("File already exists #{fn}") if File.exist?(file)
-      template = options[:template] || ''
-      CreateNode.(id: id, title: title, template: template)
-      say "'#{file}' created"
-    rescue CreateNode::Failure => e
-      stop!(e.message)
+      puts "Checking assembly for writing errors..."
+      CheckAssembly.(LoadAssembly.())
     end
 
     desc "toc [OPTIONS]", "Print the project TOC"
     method_option :query, aliases: "-q", type: :string, desc: "Query"
     def toc
       stop_unless_clerq!
-      node = QueryAssembly.(options[:query] || '')
+      node = LoadAssembly.()
+      node = QueryNode.(assembly: node, query: options[:query]) if options[:query]
       puts "% #{node.title}"
       puts "% #{node[:query]}" if node[:query]
       node.to_a.drop(1).each{|n|
         puts  "#{'  ' * (n.nesting_level - 1)}[#{n.id}] #{n.title}"
       }
-    rescue QueryAssembly::Failure => e
+    rescue StandardError => e
+      stop!(e.message)
+    end
+
+    desc "node ID [TITLE]", "Create a new node"
+    method_option :template, aliases: "-t", type: :string, desc: "template"
+    def node(id, title = '')
+      stop_unless_clerq!
+      fn = CreateNode.(id: id, title: title, template: options[:template] || '')
+      say "'#{fn}' created"
+    rescue StandardError => e
       stop!(e.message)
     end
 

data/lib/clerq/entities/node.rb

@@ -44,6 +44,8 @@ module Clerq
         raise ArgumentError, "Invalid argument :title" unless title.is_a? String
         raise ArgumentError, "Invalid argument :body" unless body.is_a? String
         raise ArgumentError, "Invalid argument :meta" unless meta.is_a? Hash
+        id = meta.delete(:id) if id.empty? && meta[:id]
+        meta.delete(:id) unless id.empty?
         @parent = nil
         @items = []
         @id = id
@@ -68,16 +70,20 @@ module Clerq
         @items.find{|r| r.id.eql? id}
       end
 
+      # @return [Array<String>] of ids from meta[:order_index]
+      def order_index
+        return [] unless @meta[:order_index]
+        @meta[:order_index].strip.gsub(/[\s]{2,}/, ' ').split(/\s/)
+      end
+
       # @return [Array<Node>] list of child nodes; when the node
       #   metadate has :order_index arrtibute, the list will be
       #   ordered according the attribute value
       def items
-        return @items if @items.empty?
-        return @items if @meta[:order_index].nil?
-        source = Array.new(@items)
-        order = @meta[:order_index]
+        return @items if @items.empty? || order_index.empty?
         [].tap do |ordered|
-          order.split(/ /).each do |o|
+          source = Array.new(@items)
+          order_index.each do |o|
             e = source.delete(item(o))
             ordered << e if e
           end

data/lib/clerq/repositories.rb

@@ -1,4 +1,3 @@
-require_relative 'repositories/node_reader'
 require_relative 'repositories/file_repository'
 require_relative 'repositories/node_repository'
 require_relative 'repositories/text_repository'

data/lib/clerq/repositories/file_repository.rb

@@ -50,6 +50,7 @@ module Clerq
           raise StandardError, errmsg
         end
         File.write(join, content)
+        join
       end
 
     end

data/lib/clerq/repositories/node_repository.rb

@@ -2,8 +2,9 @@
 
 require_relative '../entities'
 require_relative 'file_repository'
-require_relative 'node_reader'
+require_relative '../services/read_node'
 include Clerq::Entities
+include Clerq::Services
 
 module Clerq
   module Repositories
@@ -21,9 +22,9 @@ module Clerq
 
       # asseble repository nodes hierarchy
       # @return [Node]
-      def assemble
+      def assemble(on_parse: nil, on_error: nil)
         @node = Node.new(id: 'join', title: Clerq.title)
-        loadn = load
+        loadn = load(on_parse: on_parse, on_error: on_error)
         loadn.each{|n| @node << n}
         subo!
         eqid!
@@ -36,12 +37,12 @@ module Clerq
 
       protected
 
-      def load
+      def load(on_parse: nil, on_error: nil)
         inside do
           [].tap do |ary|
             glob.each do |file|
-              # TODO: what to do with errors?
-              tmp = NodeReader.(file)
+              on_parse.call(file) if on_parse
+              tmp = ReadNode.(file, on_error)
               tmp.each{|node| ary << node }
             end
           end