marko 0.1.0 → 0.4.0

data/lib/marko/markup/validator.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../validator"
-
-module Marko
-  module Markup
-    class Validator < Marko::Validator
-
-      def initialize
-        @inspectors = []
-        @inspectors << TheSameId.new
-        @inspectors << LostParent.new
-        @inspectors << LostIndex.new
-        @inspectors << LostLink.new
-      end
-
-      # see Marko::Validator#call
-      def call(tree)
-        [].tap{|errors|
-          @inspectors.each{|spectr| errors.concat(spectr.(tree)) }
-        }
-      end
-
-    end
-
-    class Inspector
-      def call(tree)
-        select(tree).then{ report(_1) }
-      end
-
-      def select(tree)
-        fail "the abstract method must be overriden"
-      end
-
-      def report(errs)
-        fail "the abstract method must be overriden"
-      end
-
-    end
-
-    class TheSameId < Inspector
-      def select(tree)
-        fn = proc{|n, memo| memo[n.id] ||= []; memo[n.id] << n}
-        tree
-          .each_with_object({}, &fn)
-          .select{|_, v| v.size > 1}
-      end
-
-      def report(errs)
-        # the same id [ref] found twice
-        #   src/source2.md:22 >> ## header
-        #   src/source3.md:11 >> ## header
-        errs.map{|id, nodes|
-          sources = nodes.map{|n| "  #{n[:origin]}\n"}.join
-          "the same id [#{id}] found in\n#{sources}"
-        }
-      end
-    end
-
-    class LostParent < Inspector
-      def select(tree)
-        tree.select{|n| n[:parent] && n.parent_id != n[:parent]}
-      end
-
-      def report(errs)
-        # lost parent [ref] src/source2.md:22 >> ## header
-        errs.map{|n| "lost parent [#{n[:parent]}] found in #{n[:origin]}\n"}
-      end
-    end
-
-    class LostIndex < Inspector
-      def select(tree)
-        lost = proc{|n| n.order_index.reject{|i| n.find_item(i)}}
-        tree
-          .select{|n| n.order_index.any? && lost.(n).any?}
-          .map{|n| [n[:origin], lost.(n)]} # @todo second time calculation
-      end
-
-      def report(errs)
-        # lost index [a, b] src/source2.md:22 >> ## header
-        errs.map{|orig, lost| "lost index [#{lost.join(', ')}] in #{orig}\n" }
-      end
-    end
-
-    class LostLink < Inspector
-      def select(tree)
-        lost = proc{|n| n.links.reject{|i| n.find_node(i)}}
-        tree
-          .select{|n| lost.(n).any? }
-          .map{|n| [n[:origin], lost.(n)]} # @todo second time #lost calculation
-      end
-
-       # @todo report link line number in the origin
-      def report(errs)
-        # lost links [ref] src/source2.md:22 >> ## header
-        errs.map{|orig, lost| "lost link [#{lost.join(', ')}] in #{orig}\n"}
-      end
-    end
-
-  end
-end

data/lib/marko/markup.rb

@@ -1,24 +0,0 @@
-require_relative "markup/parser"
-require_relative "markup/storage"
-require_relative "markup/validator"
-require_relative "markup/macro"
-require_relative "markup/decorator"
-require_relative "markup/compiler"
-require_relative "config"
-
-
-module Marko
-
-  ParserPlug.plug Markup::Parser
-  StoragePlug.plug Markup::Storage
-  CompilerPlug.plug Markup::Compiler
-  ValidatorPlug.plug Markup::Validator
-
-  # ParserPlug = Markup::Parser.plug
-  # StoragePlug = Markup::Storage.plug
-  # @todo let Decorator know
-  MacroProcPlug = Markup::MacroProcessor.plug
-  # ValidatorPlug = Markup::Validator.plug
-  # CompilerPlug = Markup::Compiler.plug
-
-end

data/lib/marko/services/assemble.rb

@@ -1,16 +0,0 @@
-require_relative "../gadgets"
-require_relative "../assembler"
-
-module Marko
-  module Services
-
-    # Assemblage service
-    # @todo assemble projects bu url
-    class Assemble < Service
-      def call
-        Assembler.(&@block)
-      end
-    end
-
-  end
-end

data/lib/marko/services/compile.rb

@@ -1,30 +0,0 @@
-require_relative "../gadgets"
-require_relative "../assembler"
-
-module Marko
-  module Services
-
-    # Compitation service
-    class Compile < Service
-      def initialize(tree: nil, template: '', filename: '', &block)
-        @tree = MustbeTreeNode.(tree) if tree
-        @template = MustbeString.(template)
-        @filename = MustbeString.(filename)
-        @block = block
-
-        art = Marko.artifact
-        @template = art.template if @template.empty?
-        @filename = art.filename if @filename.empty?
-      end
-
-      def call
-        storage = StoragePlug.plugged
-        compiler = CompilerPlug.plugged
-        erb = storage.content(@template)
-        @tree = Assembler.(&@block) unless @tree
-        compiler.(@tree, erb, @filename, &@block) # => filename
-      end
-    end
-
-  end
-end

data/lib/marko/services.rb

@@ -1,2 +0,0 @@
-require_relative "services/assemble"
-require_relative "services/compile"

data/lib/marko/storage.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "gadgets"
-require_relative "artifact"
-
-module Marko
-
-  # The base class that represents sources repository
-  class Storage
-    extend Pluggable
-
-    # create a new repository
-    # @param repository [String] the name for the repository
-    def punch(repository)
-      fail "the abstract method must be overriden"
-    end
-
-    # @retrun [Array<String>] array of sources inside the repository
-    def sources
-      fail "the abstract method must be overriden"
-    end
-
-    # @param source [Striing] source to retrieve content
-    # @return [String] content of :source
-    def content(source)
-      fail "the abstract method must be overriden"
-    end
-
-    # @return [Artifact] artifact settings
-    def artifact
-      fail "the abstract method must be overriden"
-    end
-
-  end
-
-end

data/lib/marko/tree_node.rb

@@ -1,128 +0,0 @@
-# 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

@@ -1,19 +0,0 @@
-# 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/marko.gemspec

@@ -1,44 +0,0 @@
-# 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