clerq 0.1.0 → 0.3.3

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

@@ -3,7 +3,9 @@ require 'delegate'
 # Template for generate documents by Pandoc
 class MarkupNode < SimpleDelegator
   def title
-    "#{'#' * nesting_level} #{super} {##{url(id)}}"
+    s = super
+    s = ".#{id.split(/\./).last}" if s.empty?
+    "#{'#' * nesting_level} #{s} {##{url(id)}}"
   end
 
   def meta
@@ -12,7 +14,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 +39,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
@@ -79,7 +81,8 @@ class MarkupNode < SimpleDelegator
 end
 -%>
 % <%= @object.title %>
-% generated by Clerq on <%= Time.now.strftime('%B %e, %Y at %H:%M') %> using 'pandoc.md.erb' template
+% 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) -%>

data/lib/clerq.rb

@@ -1,39 +1,84 @@
 require_relative 'clerq/version'
 require_relative 'clerq/entities'
-require_relative 'clerq/gateways'
-require_relative 'clerq/interactors'
+require_relative 'clerq/services'
 require_relative 'clerq/repositories'
 require_relative 'clerq/properties'
 require_relative 'clerq/settings'
-require_relative 'clerq/templater'
 require_relative 'clerq/cli'
+include Clerq::Repositories
 
 module Clerq
   class Error < StandardError; end
 
   class << self
+    # TODO try forwardable there for bin, tt, title, output, etc.
 
     def root
       File.dirname __dir__
     end
 
-    def gateway
-      @gateway ||= Clerq::Gateways::InFiles.new
+    def settings
+      @settings ||= Settings.new
     end
 
-    def gateway=(gateway)
-      errmsg =  "Invalid argument! Clark::Gateway required"
-      raise ArgumentError, errmsg unless gateway.is_a? Clerq::Gateways::Gateway
-      @gateway = gateway
+    def title
+      settings.title
     end
 
-    def settings
-      @settings ||= Settings.new
+    def document
+      settings.document
+    end
+
+    def template
+      settings.template
+    end
+
+    def bin
+      settings.bin
+    end
+
+    def src
+      settings.src
+    end
+
+    def tt
+      settings.tt
     end
 
     def reset
-      @gateway = nil
       @settings = nil
+      @node_repository = nil
+      @text_repository = nil
+    end
+
+    def text_repository
+      @text_repository ||= TextRepository.new(path: File.join(Dir.pwd, tt))
+    end
+
+    def text_repository=(repository)
+      unless repository.is_a? TextRepository
+        err = "Invalid argument. Clerq::Repositories::TextRepository required"
+        raise ArgumentError, err
+      end
+      @text_repository = repository
+    end
+
+    def node_repository
+      @node_repository ||= NodeRepository.new(path: File.join(Dir.pwd, src))
+    end
+
+    def node_repository=(repository)
+      unless repository.is_a? NodeRepository
+        err = "Invalid argument. Clerq::Repositories::NodeRepository required"
+        raise ArgumentError, err
+      end
+      @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

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
 
@@ -14,36 +14,72 @@ module Clerq
       File.join Clerq.root, "lib/assets"
     end
 
+    def self.exit_on_failure?
+      false
+    end
+
     desc "--version, -v", "Print the version"
     def version
       puts "Clerq v#{Clerq::VERSION}"
     end
     map %w[--version -v] => :version
 
+    no_commands {
+      # @param [String]
+      # @returns [String] usual name for ruby file
+      def thor_filename(str);
+        str.split(/[\W+_]/).map(&:downcase).join('_') + '.thor'
+      end
+
+      # @param [String]
+      # @returns [String] usual name for ruby class
+      def ruby_class_name(str);
+        str.split(/[\W+_]/).map(&:capitalize).join
+      end
+
+      def clerq_project?
+        File.exist?(Clerq::Settings::STORAGE) || Dir.exist?(Clerq.settings.src)
+      end
+
+      def stop_unless_clerq!
+        stop! "Clerq project required!" unless clerq_project?
+      end
+
+      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"
     def new(project)
+      stop! "'#{project}' folder already exists!" if Dir.exist?(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/clerq.yml.tt', target: Clerq::Settings::STORAGE},
+        {tt: 'new/clerq.thor.tt', target: thor_filename(project)},
         {tt: 'new/content.md.tt', target: File.join(settings.src, "#{project}.md")}
       ]
 
+      config = {project: project, klass: ruby_class_name(project)}
+
       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})
+          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
@@ -52,6 +88,7 @@ module Clerq
     def promo
       say "Copying promo content ..."
       directory('promo', Dir.pwd)
+      say "Copied!"
     end
 
     desc "build [OPTIONS]", "Build the clerq project"
@@ -59,70 +96,50 @@ module Clerq
     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)
+      stop_unless_clerq!
+      document = options[:output] || Clerq.document + '.md'
+      template = options[:tt] || Clerq.template
+      build = File.join(Clerq.bin, document)
+
+      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 CompileNodes::Failure => e
-      error e.message
+    rescue StandardError => e
+      stop!(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
+      stop_unless_clerq!
+      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
-      query = options[:query]
-      node = query ? QueryNodes.(query: query) : JoinNodes.()
+      stop_unless_clerq!
+      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 QueryNodes::Failure, JoinNodes::Failure => e
-      error e.message
+    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
 
   end

data/lib/clerq/entities.rb

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

data/lib/clerq/entities/node.rb

@@ -3,133 +3,153 @@ require "forwardable"
 
 module Clerq
   module Entities
-  end
-end
 
-class Clerq::Entities::Node
-  extend Forwardable
-  include Enumerable
-
-  attr_reader :parent
-  attr_reader :title
-  attr_reader :body
-  attr_reader :meta
-  attr_writer :id
-
-  def_delegators :@meta, :[], :[]=
-  def_delegator :@items, :delete, :delete_item
-  def_delegator :@items, :last, :last_item
-  protected :delete_item
-
-  def initialize(id: '', title: '', body: '', meta: {})
-    raise ArgumentError, "Invalid argument :id" unless id.is_a? String
-    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
-    @parent = nil
-    @items = []
-    @id = id
-    @title = title
-    @body = body
-    @meta = meta
-  end
+    # The basic block of hierarchy and the single Clerq entity
+    #
+    # Usage
+    #   n = Node.new(title: 'Part I')
+    #   n << Node.new(title: 'Item 1')
+    #   n << Node.new(title: 'Item 2')
+    #   n.each{|i| puts i.tile} # and all power of Enumerable
+    class Clerq::Entities::Node
+      extend Forwardable
+      include Enumerable
+
+      # @!attribute [r] parent
+      #   @return [Node] the parent of the node
+      attr_reader :parent
+      # @!attribute [r] title
+      #   @return [String] the title of the node
+      attr_reader :title
+
+      # @!attribute [r] body
+      #   @return [String] the body of the node
+      attr_reader :body
+
+      # @!attribute [r] meta
+      #   @return [Hash<Symbol, String>] the metadata of the node
+      attr_reader :meta
+
+      # @!attribute [w] id
+      #   @return [Hash<Symbol, String>] the metadata of the node
+      attr_writer :id
+
+      def_delegators :@meta, :[], :[]=
+      def_delegator :@items, :delete, :delete_item
+      def_delegator :@items, :last, :last_item
+      protected :delete_item
+
+      def initialize(id: '', title: '', body: '', meta: {})
+        raise ArgumentError, "Invalid argument :id" unless id.is_a? String
+        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
+        @title = title
+        @body = body
+        @meta = meta
+      end
 
-  def <<(node)
-    raise ArgumentError, "Invalid argument :node" unless node.is_a? Node
-    node.parent = self
-    @items << node
-    node
-  end
+      def <<(node)
+        raise ArgumentError, "Invalid argument :node" unless node.is_a? Node
+        node.parent = self
+        @items << node
+        node
+      end
 
-  # Find descendant node by id (for sort_order purpose)
-  # @param [String] node id
-  # @return [Node] when id found or nil if did not
-  def item(id)
-    return @items.find{|r| r.id.end_with? id[1..-1]} if id.start_with? '.'
-    @items.find{|r| r.id.eql? id}
-  end
+      # @param id [String] the id of child node; when it starts with '.',
+      #   the method will find nodes that id ends with the param
+      # @return [Node, nil] child node by provided id; when id not found
+      #   it will return ni
+      def item(id)
+        return @items.find{|r| r.id.end_with? id[1..-1]} if id.start_with? '.'
+        @items.find{|r| r.id.eql? id}
+      end
 
-  # @return [Array<Node>] array of items ordered by order_index meta
-  def items
-    return @items if @items.empty?
-    return @items if @meta[:order_index].nil?
-    source = Array.new(@items)
-    order = @meta[:order_index]
-    [].tap do |ordered|
-      order.split(/ /).each do |o|
-        e = source.delete(item(o))
-        ordered << e if e
+      # @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
-      ordered.concat(source)
-    end
-  end
 
-  # TODO: place valid Yard pointer to Enumerable#each
-  def each(&block)
-    return to_enum(__callee__) unless block_given?
-    yield(self)
-    items.each{|n| n.each(&block) }
-  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? || order_index.empty?
+        [].tap do |ordered|
+          source = Array.new(@items)
+          order_index.each do |o|
+            e = source.delete(item(o))
+            ordered << e if e
+          end
+          ordered.concat(source)
+        end
+      end
 
-  # TODO: it needs for writing, maybe shold be moved to decorator?
-  def root
-    n = self
-    n = n.parent while n.parent
-    n
-  end
+      # see Enumerable#each
+      def each(&block)
+        return to_enum(__callee__) unless block_given?
+        yield(self)
+        items.each{|n| n.each(&block) }
+      end
 
-  # TODO: it needs for writing, maybe shold be moved to decorator?
-  def nesting_level
-    @parent.nil? ? 0 : @parent.nesting_level + 1
-  end
+      # @return [Node] the root node in the node hierarchy
+      def root
+        n = self
+        n = n.parent while n.parent
+        n
+      end
 
-  # TODO: it needs for checking links and writing, maybe
-  #   shold be moved to decorator for checking also?
-  # @return [Array<String>] links to other nodes inside @body
-  def links
-    return [] if @body.empty?
-    @body.scan(/\[\[([\w\.]*)\]\]/).flatten.uniq
-  end
+      # @return [Integer] the node level in the node hierarchy
+      def nesting_level
+        @parent.nil? ? 0 : @parent.nesting_level + 1
+      end
 
-  def id
-    @id.start_with?('.') && @parent ? @parent.id + @id : @id
-  end
+      # @return [Array<String>] macro links in the node #body
+      def links
+        return [] if @body.empty?
+        @body.scan(/\[\[([\w\.]*)\]\]/).flatten.uniq
+      end
 
-  # Find the first node in the node hierarchy by its id. It allows
-  #   finding a node by matching the end of id by providing '*' prefix,
-  # @param [String] id Node id
-  # @return [Node] or nil when node not found
-  def node(id)
-    return find{|n| n.id.end_with? id[1..-1]} if id.start_with? '*'
-    find{|n| n.id.eql? id}
-  end
+      # When the node id starts with '.', the method will
+      #   prefix the node id with parent id
+      # @return [String] the id of the node
+      def id
+        @id.start_with?('.') && @parent ? @parent.id + @id : @id
+      end
 
-  # TODO: extract to NodeFinder class and do think about helpful prefixes
-  #   '.'    for first descendant
-  #   '.*'   for first descendant by #end_with?
-  #   '..'   for first node at the level of node parent
-  #   '..'   for first node at the level of node parent by #end_with?
-  # def find_node(id)
-  # end
-
-  # TODO: Node#belong_to?(node[String|Node])
-  #   that returns true if node belongs to hierarhy of self included
-  # @param [String|Node] node id or node
-  # @return [Boolean] true if node belongs to hierarchy of id or other node
-  # def belong?(node)
-  # end
-
-  # TODO: add tests
-  def orphan!
-    return unless @parent
-    @parent.delete_item(self)
-    @parent = nil
-  end
+      # Find the first node in the node hierarchy by its id.
+      #   Add '*' prefix to find id by ends_with?
+      # @param [String] id Node id
+      # @return [Node] or nil when node not found
+      def node(id)
+        if id.start_with? '*'
+          ai = id[1..-1]
+          return find {|n| n.id.end_with? ai}
+        end
+        find{|n| n.id.eql? id}
+      end
 
-  protected
-    def parent=(node)
-      raise ArgumentError, "Invalid parameter :node" unless node.is_a? Node
-      @parent = node
-    end
+      # Break of the node from parent hierarhy
+      # @return self
+      def orphan!
+        return unless @parent
+        @parent.delete_item(self)
+        @parent = nil
+        self
+      end
 
+      protected
+      def parent=(node)
+        raise ArgumentError, "Invalid parameter :node" unless node.is_a? Node
+        @parent = node
+      end
+
+    end
+  end
 end