marko 0.3.0 → 0.4.0

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.3.0"
+  VERSION = '0.4.0'
 end

data/lib/marko.rb

@@ -1,45 +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
-
-    def demo
-      File.join(root, 'lib', 'assets', 'demo')
-    end
-
-    def samples
-      File.join(root, 'lib', 'assets', 'samples')
-    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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
-- Nikolay Voynov
-autorequire:
+- nvoynov
 bindir: exe
 cert_chain: []
-date: 2023-11-22 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,93 +17,61 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
+- ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
+- Dockerfile
+- LICENSE.txt
 - README.md
 - Rakefile
-- STORY.md
-- _layouts/footer.md
-- _layouts/header.md
-- _layouts/layout.html
-- _layouts/robots.txt.erb
-- _layouts/sitemap.xml.erb
-- _layouts/styles.css
-- docs/changelog.html
-- docs/css/styles.css
-- docs/index.html
-- docs/readme.html
-- docs/robots.txt
-- docs/sitemap.xml
-- docs/story.html
 - 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/custom.md.tt
-- lib/assets/init/tt/default.md.tt
-- lib/assets/samples/0_index.md
-- lib/assets/samples/1_intro.md
-- lib/assets/samples/2_stakh.md
-- lib/assets/samples/3_actors.md
-- lib/assets/samples/4_cases.md
-- lib/assets/samples/5_entities.md
-- lib/assets/samples/6_concerns.md
-- lib/assets/samples/SRS-IEEE-830-1998.md
-- lib/assets/samples/SRS-RUP.md
-- lib/assets/samples/business-case.md
-- lib/assets/samples/ears.md
-- lib/assets/samples/gen_punch_domain.rb
-- lib/assets/samples/requirements.md
-- lib/assets/samples/stakeholders.png
-- lib/assets/samples/vision.md
+- 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
-- sancho.yml
 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
@@ -115,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.19
-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,23 +0,0 @@
-PATH
-  remote: .
-  specs:
-    marko (0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    minitest (5.16.3)
-    rake (13.0.6)
-
-PLATFORMS
-  x64-mingw-ucrt
-  x64-mingw32
-  x86_64-linux
-
-DEPENDENCIES
-  marko!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-
-BUNDLED WITH
-   2.4.5

data/STORY.md

@@ -1,44 +0,0 @@
----
-title: Marko Story
-date: 2023-01-26
-...
-
-[Marko](https://github.com/nvoynov/marko) is the result of my ten-year journey with Ruby playing the Business Analyst role.
-
-## Childhood, 2012
-
-Somewhere in between 2011 and 2014 I was playing Software Engineer role in some BigKnownCo where my first and foremost working tool was Microsoft Word 2007. Requirements specifications and Architecture design documents Artifacts that I was mainly working on often consisted of one and more hundreds of pages and it was such a pain to deal with in MS Word which was the corporate standard.
-
-In simple words it just gone crazy on large documents, the program consumed all my RAM, document navigation was slow, the program simply stopped responding, which entailed restarting the process with a loss of changes; or even worse, the loss of style formatting that is invisible to the eye when you simply cannot see it that the formatting was lost somewhere on the 225th page.
-
-> So problem was clear "__The problem of__ the lack of simple reliable tools and approaches for writing software artifacts __affects__ technical writers who develop and manage the artifacts __the impact of which is__ they tend to choose.."
-
-And I come up with the idea to create something light, simple and reliable to eliminate the MS Word from my work experience once and for all. This time I was curious about using YAML for storing requirements just inside file system. And I regularly done some estimations and prioritization for requirements, so I decided that FPA, PERT, and Risk-Value prioritization will be valuable features here.
-
-It was my first serious diving into Ruby for few weeks. I succeeded in reading / writing YAML and even provided estimations algorithms. I fall in love with Ruby. But from user perspective (I was the user) it was complete failure. Writing YAML manually was just unforgivable but that time I was obsessed with the format.
-
-> YAML was chosen just because this days I dramatically reduced time for load configuration of my target service provisioning system, that stored its configuration tree in RDBMS that causes ~5 000 000 selects for reading and about the same number insert/update for writing. It just reduced to 20 000 instead of 5 000 000.
-
-## Adolescence, 2014 - 2015
-
-It took two years to return to the subject, I left that job in 2014 and got haft year off. This time I discovered Markdown and static site generators, and I decided on Markdown as my primary markup format, where each source is just a plain markdown file with some metadata excerpt.
-
-Things were going well and in a few months, I got something quite usable. Estimations algorithms were thrown out; markup sources were assembled in one artifact that was translated into HTML by Kramdown. I named it "Creq" for "console requirements" and since then I assembled all software artifacts in my own tool.
-
-## Youth, since 2015
-
-Using my tool daily on a regular basis I discovered Pandoc and then can translate my artifact into any supported format; provided more advanced artifact templates, and provided a few templates for different purposes (draft, customer deliverable, etc.), added macros for tree node body.
-
-This time I named my tool Clerq because it just was my regular tool - I started my day from `$ git checkout -b new_feature` and finished with merging the branch, assembling new requirements increment, and pushing into git for my development team.
-
-In 2018 I have read The Clean Architecture I took my first clumsy attempts to apply it for Clerq.
-
-## Marko, 2022
-
-The last time I used Clerq for two months in July 2022. I noticed that time that I use only "create a new project" and "build the artifact" commands. And I realized that there is nothing about requirements - just about artifact assembling.
-
-So I took two weeks and finished 2022 with a git commit on Dec 31, 2022 :)
-
-The Marko purpose is assembling markup artifact from separated markup sources. Its interfaces are simple and clear. It could be naturally extended through Rakefile for any specific purpose related to visiting artifacts tree nodes.
-
-This is the first time I feel for a product that there are nothing I want to take or change. Just "Right Product, Done Right, Managed Messy"

data/_layouts/footer.md

@@ -1,4 +0,0 @@
-<div id="footer">
-  ***
-  © 2022-2023 <a href="http://nvoynov.github.io/">nvoynov</a>
-</div>

data/_layouts/header.md

@@ -1,3 +0,0 @@
-<p class="navbar">
-[ = **"Marko" Markup Compiler** = [Readme](readme.html) ~  [Changelog](changelog.html) ~ [Story](story.html) ~ [Github](https://github.com/nvoynov/sancho)]{.smallcaps}
-</p>