marko 0.1.0

data/lib/marko/tree_node.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require_relative "gadgets"
+
+module Marko
+
+  MustbeString = Sentry.new(:key, "must be String"
+  ) {|v| v.is_a? String}
+
+  MustbeTreeNode = Sentry.new(:key, "must be TreeNode"
+  ) {|v| v.is_a? TreeNode}
+
+  class TreeNode
+    extend Forwardable
+    include Enumerable
+
+    attr_reader :parent
+    attr_reader :title
+    attr_reader :meta
+    attr_reader :body
+
+    def_delegators :@meta, :[], :[]=
+    def_delegator :@items, :last
+    def_delegator :@items, :delete, :delete_item
+    def_delegator :@meta, :delete, :delete_meta
+    def_delegator :@parent, :id, :parent_id
+
+    def initialize(title = '', body = '', **meta)
+      @parent, @items = nil, []
+      @title = MustbeString.(title, :title)
+      @body = MustbeString.(body, :body)
+      @meta = meta
+      @meta[:id] = '' unless @meta[:id]
+    end
+
+    def <<(node)
+      MustbeTreeNode.(node)
+      node.parent = self
+      @items << node
+      node
+    end
+
+    # see Enumerable#each
+    def each(&block)
+      return to_enum(__callee__) unless block_given?
+      yield(self)
+      items.each{|n| n.each(&block) }
+    end
+
+    # @return [Array<String>]
+    def order_index
+      @meta
+        .fetch(:order_index, '')
+        .strip
+        .split(/\s{1,}/)
+    end
+
+    def id
+      val = @meta.fetch(:id, '')
+      return val unless @parent
+      val.start_with?('.') ? @parent.id + val : val
+    end
+
+    def find_item(ref)
+      @items.find{|n| n.id == ref || n.id.end_with?(ref)}
+    end
+
+    def find_node(ref)
+      return find_item(ref) if ref.start_with?(?.)
+      root.find{|n| n.id == ref}
+    end
+
+    # @return [Array<Node>] ordered list of child nodes
+    def items
+      return @items unless order_index.any?
+      [].tap do |ary|
+        src = Array.new(@items)
+        order_index.each do |i|
+          node = find_item(i)
+          ary << src.delete(node) if node
+        end
+        ary.concat(src)
+      end
+    end
+
+    def belongs_to?(ref)
+      owner = root.find{|n| n.id == ref}
+      self == owner&.find{|n| n == self}
+    end
+
+    # @return [Node] the root node in the node hierarchy
+    def root
+      n = self
+      n = n.parent while n.parent
+      n
+    end
+
+    def root?
+      self == root
+    end
+
+    # @return [Integer] the node level in the node hierarchy
+    def nesting_level
+      @parent.nil? ? 0 : @parent.nesting_level + 1
+    end
+
+    # @return [Array<String>] macro links in the node #body  IT IS RATHER MACRO FOR WRITER SO TI SHOULD BE PROCESSED APPROPRIATELY
+    def links
+      return [] if @body.empty?
+      @body.scan(/\[\[([\w\.]*)\]\]/).flatten.uniq
+    end
+
+    def orphan!
+      return unless @parent
+      @parent.delete_item(self)
+      @parent = nil
+    end
+
+    protected
+
+    def parent=(node)
+      @parent = MustbeTreeNode.(node)
+    end
+
+  end
+
+end

data/lib/marko/validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "tree_node"
+
+module Marko
+
+  # The strategy of tree validation
+  class Validator
+    extend Pluggable
+
+    # @param tree [TreeNode]
+    # @param block [&block] proc {|event, payload|}
+    # @return [Array<String>] errors array
+    def call(tree, &block)
+      fail "the abstract method must be overriden"
+    end
+  end
+
+end

data/lib/marko/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Marko
+  VERSION = "0.1.0"
+end

data/lib/marko.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "marko/version"
+require_relative "marko/gadgets"
+require_relative "marko/tree_node"
+require_relative "marko/storage"
+require_relative "marko/parser"
+require_relative "marko/validator"
+require_relative "marko/assembler"
+require_relative "marko/compiler"
+require_relative "marko/config"
+require_relative "marko/markup"
+require_relative "marko/services"
+require_relative "marko/loader"
+require_relative "marko/cli"
+
+module Marko
+
+  class << self
+    def root
+      File.dirname __dir__
+    end
+
+    # helper method for assemblage
+    # @see Marko::Services::Assemble
+    def assemble(&block)
+      Services::Assemble.(&block)
+    end
+
+    # helper method for compilation
+    # @see Marko::Services::Compile
+    def compile(tree: nil, template: '', filename: '', &block)
+      Services::Compile.(
+        tree: tree, template: template, filename: filename, &block)
+    end
+  end
+end

data/marko.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/marko/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "marko"
+  spec.version = Marko::VERSION
+  spec.authors = ["Nikolay Voynov"]
+  spec.email = ["nvoynov@gmail.com"]
+
+  spec.summary = "Marko is a markup compiler that builds a tree from separated markup sources and compiles it into a deliverable artifact."
+
+  spec.description = <<~EOF
+    Marko supplies a "docs-as-code" approach for compiling bulky software artifacts by providing source storage, original plain text markup, compiler templates, command-line and Gem interfaces.
+
+    Having the assembled artifact, it can be analyzed, enriched by extra data, served as a source for deriving subdued artifacts, etc.
+  EOF
+
+  spec.homepage = "https://github.com/nvoynov/marko"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: marko
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikolay Voynov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-02 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Marko supplies a "docs-as-code" approach for compiling bulky software artifacts by providing source storage, original plain text markup, compiler templates, command-line and Gem interfaces.
+
+  Having the assembled artifact, it can be analyzed, enriched by extra data, served as a source for deriving subdued artifacts, etc.
+email:
+- nvoynov@gmail.com
+executables:
+- marko
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- exe/marko
+- lib/assets/demo/README.md
+- lib/assets/demo/src/fr/assemble.md
+- lib/assets/demo/src/fr/compile.md
+- lib/assets/demo/src/fr/markup.md
+- lib/assets/demo/src/fr/storage.md
+- lib/assets/demo/src/fr/treenode.md
+- lib/assets/demo/src/index.md
+- lib/assets/demo/src/intro.md
+- lib/assets/demo/src/ui/cli.md
+- lib/assets/demo/src/ui/gem.md
+- lib/assets/demo/src/ur/uc.create.project.md
+- lib/assets/demo/src/ur/uc.general.flow.md
+- lib/assets/init/README.md
+- lib/assets/init/Rakefile
+- lib/assets/init/tt/artifact.md.tt
+- lib/marko.rb
+- lib/marko/artifact.rb
+- lib/marko/assembler.rb
+- lib/marko/cli.rb
+- lib/marko/compiler.rb
+- lib/marko/config.rb
+- lib/marko/gadgets.rb
+- lib/marko/gadgets/pluggable.rb
+- lib/marko/gadgets/sentry.rb
+- lib/marko/gadgets/service.rb
+- lib/marko/loader.rb
+- lib/marko/markup.rb
+- lib/marko/markup/compiler.rb
+- lib/marko/markup/decorator.rb
+- lib/marko/markup/macro.rb
+- lib/marko/markup/parser.rb
+- lib/marko/markup/storage.rb
+- lib/marko/markup/validator.rb
+- lib/marko/parser.rb
+- lib/marko/services.rb
+- lib/marko/services/assemble.rb
+- lib/marko/services/compile.rb
+- lib/marko/storage.rb
+- lib/marko/tree_node.rb
+- lib/marko/validator.rb
+- lib/marko/version.rb
+- marko.gemspec
+homepage: https://github.com/nvoynov/marko
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/nvoynov/marko
+  source_code_uri: https://github.com/nvoynov/marko
+  changelog_uri: https://github.com/nvoynov/marko/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: Marko is a markup compiler that builds a tree from separated markup sources
+  and compiles it into a deliverable artifact.
+test_files: []