marko 0.1.0 → 0.4.0

data/lib/marko/renderers.rb

@@ -0,0 +1,17 @@
+require_relative 'renderers/renderer'
+require_relative 'renderers/url'
+require_relative 'renderers/link'
+require_relative 'renderers/title'
+require_relative 'renderers/metadata'
+require_relative 'renderers/nested_list'
+require_relative 'renderers/nested_tree'
+require_relative 'renderers/content'
+require_relative 'renderers/topic'
+require_relative 'renderers/artifact'
+
+module Marko
+
+  # Renderers
+  module Renderers
+  end
+end

data/lib/marko/scanner.rb

@@ -0,0 +1,39 @@
+require_relative 'model'
+
+module Marko
+
+  # Source scanner
+  class Scanner
+    # @param text [String]
+    # @return [Array<Model::Markup>]
+    def scan(filename)
+      @source = filename
+      content = File.read(filename) 
+      scan_topics(content)
+        .select{ it.content.start_with?(?#) }
+    end
+
+    protected
+
+    def scan_topics(text)
+      quote, buffer, lineno = false, [], 0
+      origin = proc{
+        Model::Markup.new(@source,
+          lineno - buffer.size + 1, buffer.join)
+      }
+
+      [].tap{|ary|
+        text.each_line do |line|
+          if line =~ /^#/ && !quote && buffer.any?
+            ary << origin.()
+            buffer.clear
+          end
+          lineno += 1
+          buffer << line
+          quote = !quote if line.start_with?('```')
+        end
+        ary << origin.() if buffer.any?
+      }
+    end
+  end
+end

data/lib/marko/tasks/assemble.rb

@@ -0,0 +1,52 @@
+require_relative '../model'
+require_relative '../errors'
+
+module Marko
+  module Tasks
+
+    # Assemble tree
+    class Assemble
+      def initialize(config)
+        @config = config
+        @metadata = { id: '0' }
+          .merge(config.to_h.slice(:order_index, :author))
+      end
+
+      # @param topics [Array<Model::Topic>]
+      # @return [Model::Topic]
+      def call(topics)
+        @artifact = Model::Topic.new(
+          @config.title, '', **@metadata)
+        
+        topics.each{ @artifact.add(it) }
+        @artifact.each{ maybe_move(it) }
+        inject_ids
+        @artifact
+      end
+
+      protected
+
+      def maybe_move(node)
+        return unless node[:parent]
+
+        parent = @artifact.find{ it.id == node[:parent] }
+        return unless parent 
+
+        parent.add(node)
+        @artifact.delete(node)
+      end
+      
+      def inject_ids
+        counter = {}
+        no_id = @artifact.select {|node| node.id.empty?}
+        no_id.each do 
+          index = counter[it.parent] || 1
+          counter[it.parent] = index + 1
+          id = index.to_s.rjust(2, '0')
+          id = '.' + id unless it.parent == @artifact
+          it.id = id
+        end
+      end
+    end
+  end
+end

data/lib/marko/tasks/compile.rb

@@ -0,0 +1,19 @@
+require_relative '../model'
+require_relative '../errors'
+require_relative '../renderers'
+
+module Marko
+  module Tasks
+
+    # Compile tree into markup
+    class Compile
+      
+      # @param topic [Model::Topic]
+      # @return [String]
+      def call(topic)
+        Renderers::Artifact.new.render(topic)
+      end
+      
+    end
+  end
+end

data/lib/marko/tasks/load.rb

@@ -0,0 +1,13 @@
+module Marko
+  module Tasks
+
+    # Load source files
+    class Load
+      # @param pattern [String]
+      # @return [Array<String>]
+      def call(pattern)
+        Dir.glob(pattern)
+      end 
+    end
+  end
+end

data/lib/marko/tasks/parse.rb

@@ -0,0 +1,27 @@
+require_relative '../model'
+require_relative '../errors'
+require_relative '../parser'
+
+module Marko
+  module Tasks
+
+    # Parse source files
+    class Parse
+      # @param payload [Array< Array<Model::Markup> >]
+      # @return [Array<Model::Topic>]
+      def call(payload)
+        parser = Parser::Source.new
+
+        topics = payload
+          .map{ parser.parse(it) }
+          .flatten
+
+        errors = topics.reject{ it.is_a?(Model::Topic) }
+        fail Marko::StageError.new('Load stage failed', errors) \
+          if errors.any?
+          
+        topics
+      end 
+    end
+  end
+end

data/lib/marko/tasks/scan.rb

@@ -0,0 +1,18 @@
+require_relative '../model'
+require_relative '../errors'
+require_relative '../scanner'
+
+module Marko
+  module Tasks
+
+    # Scan source files
+    class Scan
+      # @param payload [Array<String>] filenames
+      # @return [Array<Array<Model::Markup>>] each scanned source must be parsed separately
+      def call(payload)
+        scanner = Scanner.new
+        payload.map{ scanner.scan(it) }
+      end 
+    end
+  end
+end

data/lib/marko/tasks/validate.rb

@@ -0,0 +1,32 @@
+require_relative '../model'
+require_relative '../errors'
+require_relative '../validators'
+
+module Marko
+  module Tasks
+
+    # Validate tree
+    class Validate
+      
+      # @param topic [Model::Topic]
+      def call(topic)
+        validators = 
+          [ Validators::NonUniqueId,
+            Validators::LostParent,
+            Validators::LostIndex,
+            Validators::LostLinks          
+          ].map(&:new)
+
+        errors = validators
+          .inject([]){|errors, validator| errors << validator.call(topic) }
+          .flatten
+        
+        fail Marko::StageError.new('Check stage failed', errors) \
+          if errors.any?  
+        
+        topic
+      end
+      
+    end
+  end
+end

data/lib/marko/tasks.rb

@@ -0,0 +1,13 @@
+require_relative 'tasks/load'
+require_relative 'tasks/scan'
+require_relative 'tasks/parse'
+require_relative 'tasks/assemble'
+require_relative 'tasks/validate'
+require_relative 'tasks/compile'
+
+module Marko
+
+  # Tasks
+  module Tasks
+  end
+end

data/lib/marko/validators/lost_index.rb

@@ -0,0 +1,21 @@
+require_relative '../errors'
+
+module Marko
+  module Validators
+    
+    # Lost parent validator 
+    class LostIndex
+      # @param tree [Enumerable]
+      def call(tree)
+        faulty = tree.drop(1)
+          .select{ it.lost_order_index.any? }
+
+        faulty.map do |e|
+          message = "lost order_index #{e.lost_order_index.join(', ')} in #{e.markup}"  
+          Marko::ValidatorError.new(message)
+        end
+      end
+    end
+    
+  end
+end

data/lib/marko/validators/lost_links.rb

@@ -0,0 +1,25 @@
+require_relative '../errors'
+
+module Marko
+  module Validators
+    
+    # Lost links validator 
+    class LostLinks
+      
+      # @param tree [Enumerable]
+      def call(tree)
+        lost_links = tree.inject([]) do |memo, topic|
+          lost = topic.links.reject{ topic.find_by_id(it) }
+          memo << [topic, lost] if lost.any?
+          memo
+        end
+
+        lost_links.map do |e, lost|
+          message = "lost link #{lost.join(', ')} in #{e.markup}"  
+          Marko::ValidatorError.new(message)
+        end
+      end
+    end
+    
+  end
+end

data/lib/marko/validators/lost_parent.rb

@@ -0,0 +1,21 @@
+require_relative '../errors'
+
+module Marko
+  module Validators
+    
+    # Lost parent validator 
+    class LostParent
+      # @param tree [Enumerable]
+      def call(tree)
+        faulty = tree
+          .select{ it[:parent] && it&.parent&.id != it[:parent] }
+        
+        faulty.map do
+          message = "lost parent [#{it[:parent]}] in #{it.markup}"
+          Marko::ValidatorError.new(message)
+        end
+      end
+    end
+    
+  end
+end

data/lib/marko/validators/non_unique_id.rb

@@ -0,0 +1,23 @@
+require_relative '../errors'
+
+module Marko
+  module Validators
+    
+    # Non unique id validator 
+    class NonUniqueId
+      # @param tree [Enumerable]
+      def call(tree)
+        topics = tree
+          .group_by(&:id)
+          .select{|_, items| items.size > 1 }
+
+        topics.map do |id, items|
+          sources = items.map{"  #{it.markup}"}.join(?\n)
+          message = "the same id [#{id}] found in\n#{sources}"
+          Marko::ValidatorError.new(message)          
+        end
+      end 
+    end
+    
+  end
+end

data/lib/marko/validators.rb

@@ -0,0 +1,11 @@
+require_relative 'validators/non_unique_id'
+require_relative 'validators/lost_parent'
+require_relative 'validators/lost_index'
+require_relative 'validators/lost_links'
+
+module Marko
+
+  # Validators namespace
+  module Validators
+  end
+end

data/lib/marko/version.rb

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

data/lib/marko.rb

@@ -1,37 +1,13 @@
-# 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"
-
+require_relative 'marko/errors'
+require_relative 'marko/model'
+require_relative 'marko/renderers'
+require_relative 'marko/parser'
+require_relative 'marko/validators'
+require_relative 'marko/tasks'
+require_relative 'marko/config'
+require_relative 'marko/chain'
+require_relative 'marko/cli'
+
+# Marko marckup generator namespace
 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

metadata

@@ -1,19 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: marko
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
-- Nikolay Voynov
-autorequire:
+- nvoynov
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 1980-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.
+description: Marko assembles separated markup sources into one artifact tree.
 email:
 - nvoynov@gmail.com
 executables:
@@ -21,62 +17,61 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
+- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- Dockerfile
+- LICENSE.txt
 - 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/basic.rb
 - lib/marko.rb
-- lib/marko/artifact.rb
-- lib/marko/assembler.rb
+- lib/marko/chain.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/errors.rb
+- lib/marko/model.rb
+- lib/marko/model/markup.rb
+- lib/marko/model/topic.rb
+- lib/marko/model/tree_node.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/parser/metadata.rb
+- lib/marko/parser/source.rb
+- lib/marko/parser/topic.rb
+- lib/marko/renderers.rb
+- lib/marko/renderers/artifact.rb
+- lib/marko/renderers/content.rb
+- lib/marko/renderers/link.rb
+- lib/marko/renderers/metadata.rb
+- lib/marko/renderers/nested_list.rb
+- lib/marko/renderers/nested_tree.rb
+- lib/marko/renderers/renderer.rb
+- lib/marko/renderers/title.rb
+- lib/marko/renderers/topic.rb
+- lib/marko/renderers/url.rb
+- lib/marko/scanner.rb
+- lib/marko/tasks.rb
+- lib/marko/tasks/assemble.rb
+- lib/marko/tasks/compile.rb
+- lib/marko/tasks/load.rb
+- lib/marko/tasks/parse.rb
+- lib/marko/tasks/scan.rb
+- lib/marko/tasks/validate.rb
+- lib/marko/validators.rb
+- lib/marko/validators/lost_index.rb
+- lib/marko/validators/lost_links.rb
+- lib/marko/validators/lost_parent.rb
+- lib/marko/validators/non_unique_id.rb
 - lib/marko/version.rb
-- marko.gemspec
 homepage: https://github.com/nvoynov/marko
-licenses: []
+licenses:
+- MIT
 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
@@ -84,16 +79,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Marko is a markup compiler that builds a tree from separated markup sources
-  and compiles it into a deliverable artifact.
+summary: Marko is a markdown separate sources compiler.
 test_files: []

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in marko.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,22 +0,0 @@
-PATH
-  remote: .
-  specs:
-    marko (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.16.3)
-    rake (13.0.6)
-
-PLATFORMS
-  x64-mingw32
-  x86_64-linux
-
-DEPENDENCIES
-  marko!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.4.1

data/lib/assets/demo/README.md

@@ -1,13 +0,0 @@
-% Marko Demo Project
-
-# Overview
-
-This project is an example of developing bulky technical artifacts with Marko Markup Compiler. It also serves as a sandbox for testing and features development.
-
-# Usage
-
-Run `$ marko` to see command-line interface
-
-Run `$ rake marko:publish` to publish the aritfact
-
-Run `$ rake -T` to see other custom interface

data/lib/assets/demo/src/fr/assemble.md

@@ -1,27 +0,0 @@
-# Assemble artifact
-{{id: .assemble, parent: fr}}
-
-The system shall provide the function to assemble artifact.
-
-__Input__
-
-* NO
-
-__Output__
-
-Parameter Type     0..* Description
---------- -------- ---- --------------
-tree      TreeNode 1    assembled tree
-
-__Flow__
-
-@@todo provide id for required functions and change steps with appropriate links
-
-1. get list of project sources
-2. parse sources buffering nodes and errors
-3. fail "parsing errors" if errors.any?
-4. assemble artifact from buffer of nodes
-5. generate and inject auto ids
-6. validate artifact buffering errors
-7. fail "tree errors" if errors.any?
-8. return artifact

data/lib/assets/demo/src/fr/compile.md

@@ -1,25 +0,0 @@
-# Compile artifact
-{{id: .compile, parent: fr}}
-
-The system shall provide the function to create deliverable artifact.
-
-__Input__
-
-Parameter Type     0..* Description
---------- -------- ---- --------------
-tree      TreeNode 1    assembled tree
-template  String   1    ERB template
-filename  String   1    filename
-
-__Output__
-
-The output of the function must be well-formed deliverable with `filename` built on `template` parameter.
-
-__Flow__
-
-@@todo provide id for required functions and change steps with appropriate links
-
-1. `tree` = [[fr.assemble]] unless `tree`
-2. load template body from `template`
-3. backup `filename` to `<filename>~`
-4. render `template` for each node of `tree` into `filename`