clerq 0.1.0

data/lib/clerq/entities/node.rb

@@ -0,0 +1,135 @@
+# encoding: UTF-8
+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
+
+  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
+
+  # @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
+      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
+
+  # TODO: it needs for writing, maybe shold be moved to decorator?
+  def root
+    n = self
+    n = n.parent while n.parent
+    n
+  end
+
+  # TODO: it needs for writing, maybe shold be moved to decorator?
+  def nesting_level
+    @parent.nil? ? 0 : @parent.nesting_level + 1
+  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
+
+  def id
+    @id.start_with?('.') && @parent ? @parent.id + @id : @id
+  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
+
+  # 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
+
+  protected
+    def parent=(node)
+      raise ArgumentError, "Invalid parameter :node" unless node.is_a? Node
+      @parent = node
+    end
+
+end

data/lib/clerq/entities/template.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+module Clerq
+  module Entities
+
+    class Template
+      attr_reader :id
+      attr_reader :body
+
+      def initialize(id:, body: '')
+        raise ArgumentError, "Invalid argument :id" if !(id.is_a?(String) && !id.empty?)
+        raise ArgumentError, "Invalid argument :body" unless body.is_a? String
+        @id = id
+        @body = body
+      end
+    end
+
+  end
+end

data/lib/clerq/gateways.rb

@@ -0,0 +1,3 @@
+require_relative 'gateways/gateway'
+require_relative 'gateways/in_memory'
+require_relative 'gateways/in_files'

data/lib/clerq/gateways/gateway.rb

@@ -0,0 +1,17 @@
+module Clerq
+  module Gateways
+
+    class Gateway
+      # @return [Array<Node>]
+      def nodes; end
+
+      # @return [Array<Template>]
+      def templates; end
+
+      # @param obj [Node or Template]
+      def save(obj); end
+
+    end
+
+  end
+end

data/lib/clerq/gateways/in_files.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+require "forwardable"
+require_relative '../repositories'
+require_relative 'gateway'
+
+module Clerq
+  module Gateways
+
+    class InFiles < Gateway
+      extend Forwardable
+
+      attr_reader :node_repo, :tplt_repo
+
+      def_delegator :@node_repo, :items, :nodes
+      def_delegator :@tplt_repo, :items, :templates
+
+      def initialize
+        settings = Clerq.settings
+        @node_repo = Clerq::Repositories::NodeRepository.new(settings.src)
+        @tplt_repo = Clerq::Repositories::TemplateRepository.new(settings.tt)
+        @repositories = {}
+        @repositories[Clerq::Entities::Node] = @node_repo
+        @repositories[Clerq::Entities::Template] = @tplt_repo
+      end
+
+      def save(obj)
+        repo = @repositories[obj.class]
+        raise ArgumentError, "Repository for #{obj.class} not found" unless repo
+        repo.save(obj)
+      end
+
+    end
+
+  end
+end

data/lib/clerq/gateways/in_memory.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+
+require "forwardable"
+require_relative "gateway"
+require_relative "../repositories/in_memory"
+
+module Clerq
+  module Gateways
+
+    class InMemory < Gateway
+      extend Forwardable
+
+      attr_reader :node_repo, :template_repo
+
+      def_delegator :@node_repo, :items, :nodes
+      def_delegator :@template_repo, :items, :templates
+
+      def initialize
+        @node_repo = Clerq::Repositories::InMemory.new
+        @template_repo = Clerq::Repositories::InMemory.new
+        @repositories = {}
+        @repositories[Clerq::Entities::Node] = @node_repo
+        @repositories[Clerq::Entities::Template] = @template_repo
+      end
+
+      def save(obj)
+        repo = @repositories[obj.class]
+        raise ArgumentError, "Repository for #{obj.class} not found" unless repo
+        repo.save(obj)
+      end
+
+    end
+
+  end
+end

data/lib/clerq/interactors.rb

@@ -0,0 +1,5 @@
+require_relative "interactors/join_nodes"
+require_relative "interactors/query_nodes"
+require_relative "interactors/check_nodes"
+require_relative "interactors/create_node"
+require_relative "interactors/compile_nodes"

data/lib/clerq/interactors/check_nodes.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+require_relative "interactor"
+require_relative "join_nodes"
+
+module Clerq
+  module Interactors
+
+    # TODO: maybe it needs QueryNodes instead of JoinNodes?
+    # TODO: add check for empty node content - @items.empty && @body.empty?
+    class CheckNodes < Interactor
+
+      def call
+        # TODO: query parameter for each interactor
+        @node = JoinNodes.()
+        {}.tap do |errors|
+          nonuniq = nonuniq_ids
+          errors.merge!(nonuniq_ids: nonuniq) unless nonuniq.empty?
+          parents = unknown_parents
+          errors.merge!(unknown_parents: parents) unless parents.empty?
+          references = unknown_references
+          errors.merge!(unknown_references: references) unless references.empty?
+          order = unknown_order_index
+          errors.merge!(unknown_order_index: order) unless order.empty?
+        end
+      end
+
+      protected
+
+      # @return [Hash<node id, Array<file_name>>] node ids and array of file_names
+      def nonuniq_ids
+        @node.each_with_object({}){|node, hsh|
+          hsh[node.id] ||= []
+          # TODO that way CheckNodes depends on files!?
+          hsh[node.id] << node[:file_name]
+        }.select{|k, v| v.size > 1}
+        .each{|k, v| v.uniq!}
+      end
+
+      # @return [Hash<parent, Array<node id>>] unknown meta[:parent] and
+      #   array of nodes those have this meta attribute
+      def unknown_parents
+        @node # .drop(1)?
+        .select{|node| node[:parent] && node.parent.id != node[:parent]}
+        .each_with_object({}){|node, hsh|
+          hsh[node[:parent]] ||= []
+          hsh[node[:parent]] << node.id
+        }
+      end
+
+      # @return [Hash<node_id, Array<node_id>>] node ids that noe found
+      #   in hierarchy and array of node ids those have links to corresponding
+      #   unknown node
+      def unknown_references
+        index = @node.map(&:id).drop(1)
+        @node.each_with_object({}) do |node, hsh|
+          node.links
+          .reject {|lnk| index.include?(lnk)}
+          .each do |lnk|
+            hsh[lnk] ||= []
+            hsh[lnk] << node.id
+          end
+        end
+      end
+
+      # @return [Hash<node_id, Array<node_id>>] node ids and array of
+      #   unknown links in :order_index
+      def unknown_order_index
+        @node
+        .select{|node| node[:order_index]}
+        .each_with_object({}){|node, hsh|
+          order = node[:order_index].split(/ /)
+          wrong = order.select{|o| node.item(o).nil?}
+          hsh[node.id] = wrong unless wrong.empty?
+        }
+      end
+
+    end
+
+  end
+end

data/lib/clerq/interactors/compile_nodes.rb

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+
+require_relative "interactor"
+require_relative "join_nodes"
+require_relative "query_nodes"
+
+module Clerq
+  module Interactors
+
+    class CompileNodes < Interactor
+
+      # @return [String] document body
+      def call
+        tt = gateway.templates(@template)
+        raise Failure, "Template '#{@template}' not found" unless tt
+        node = @query.empty? ? JoinNodes.() : QueryNodes.(query: @query)
+        Clerq::Templater.(tt.body, node)
+      end
+
+      protected
+
+        def initialize(template:, query: '')
+          raise ArgumentError, "Invalid argument :query" unless query.is_a? String
+          raise ArgumentError, "Invalid argument :template" if !(template.is_a?(String) && !template.empty?)
+          @query = query
+          @template = template
+        end
+    end
+
+  end
+end

data/lib/clerq/interactors/create_node.rb

@@ -0,0 +1,40 @@
+# encoding: UTF-8
+
+require_relative "interactor"
+
+module Clerq
+  module Interactors
+
+    class CreateNode < Interactor
+
+      def call
+        unless @template.empty?
+          tt = gateway.templates(@template)
+          raise Failure, "Template not found" unless tt
+# TODO not just `@body = tt.body` but build `@body` in accordance with tt.body
+          @body = tt.body
+        end
+        node = Clerq::Entities::Node.new(
+          id: @id, title: @title, body: @body, meta: @meta)
+        gateway.save(node)
+      end
+
+      protected
+
+      def initialize(id: '', title: '', body: '', meta: {}, template: '')
+        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
+        raise ArgumentError, "Invalid argument :template" unless template.is_a? String
+        @id = id
+        @title = title
+        @body = body
+        @meta = meta
+        @template = template
+      end
+
+    end
+
+  end
+end

data/lib/clerq/interactors/interactor.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+module Clerq
+  module Interactors
+
+    class Interactor
+      Failure = Class.new(StandardError)
+
+      def self.inherited(klass)
+        klass.const_set(:Failure, Class.new(klass::Failure))
+      end
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      # Should be implemented in subclasses
+      def call; end
+
+      protected
+
+        def gateway
+          Clerq.gateway
+        end
+    end
+
+  end
+end

data/lib/clerq/interactors/join_nodes.rb

@@ -0,0 +1,59 @@
+# encoding: UTF-8
+
+require_relative "interactor"
+
+module Clerq
+  module Interactors
+
+    # Combine all nodes in one root node (document)
+    class JoinNodes < Interactor
+
+      # @return [Node]
+      def call
+        @node = join(gateway.nodes)
+        subordinate!
+        equip_ident!
+        @node
+      end
+
+      protected
+
+      def join(nodes)
+        return nodes.first if nodes.size == 1
+        node = Clerq::Entities::Node.new(id: 'join', title: Clerq.settings.title)
+        node.tap{|node| nodes.each{|n| node << n}}
+      end
+
+      def subordinate!
+        @node.items
+        .select{|n| n[:parent] && n[:parent] != n.parent.id}
+        .each{|n|
+          parent = @node.node(n[:parent])
+          next unless parent
+          parent << n
+          @node.items.delete(n)
+          n.meta.delete(:parent)
+        }
+        # if @node.id == 'join' && @node.items.size == 1
+        #   @node = @node.items.first
+        #   @node.orphan!
+        # end
+      end
+
+      # equips nodes with autogenerated id
+      # @param [Node] node
+      def equip_ident!
+        counter = {}
+        @node.select{|n| n.id.empty?}.each do |n|
+          next if n == @node
+          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
+
+    end
+  end
+end