raindeer 0.9.12 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b88965618a03ec9c66576a52476f0c327cd09b81122f4f7b21c20f43e8a697
-  data.tar.gz: 270af90b3e24ba7ebe9f88df012e001d58ea9ac138b9c6eda7cb3afe5b64c640
+  metadata.gz: 52e3ce521b166d3df697806260de0c1446e901c5fc5249fa646879346161d441
+  data.tar.gz: 1e3e444642ca2c4f380d6892d95d8eb8294156d31d6ad0a3728d61f55bf71944
 SHA512:
-  metadata.gz: 51d62694f87974e768a376a243054b1206c550300e75bea167d08cd717ec80897c5883928d8f3a82b22a5b166139ad5c83305fd8d1b9944e78347cf7759d27e1
-  data.tar.gz: a6b9e7ac7ac1d1a4b88622cd19d9006fe7b6b64be311b35254326dc8b89622ee1e9702a22cf0050afa0a0e229e5ad53addfc7b5f0baa86699af9fe531b044e93
+  metadata.gz: a43f006044f5ac5b4b40c01c64018614d03b79451fa11d613212dc08206464866d693ab7f1421327e43dcf3659e6bf4f91daec32fdb68f7c662e746c97b3fac8
+  data.tar.gz: 727e862a41348eb57840bc7954bc090c0765f97b956a9eddd4f0f3e9d632f60861c88072b131e30ba3a86ff1e05b8857532ea859fafcf4ee90563acf2c8807c6

data/lib/cli/static.rb

@@ -4,8 +4,8 @@ require 'fileutils'
 require 'protocol/http'
 require 'ruby-progressbar'
 
-require 'antlers' # Adds antlers support to lowload.
-require 'lowload'
+require 'antlers' # Adds antlers support to dirload.
+require 'dirload'
 
 require_relative '../pages/pages'
 
@@ -41,7 +41,7 @@ module Rain
       private
 
       def load_user_application(app_path:)
-        metadata = LowLoad.dirload(app_path)
+        metadata = dirload(app_path)
 
         if Dir.exist?(File.expand_path('pages', app_path))
           Providers.define('rain.pages', eager: true) do

data/lib/matrix/matrix.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'low_event'
-require 'low_type'
+require 'lowevent'
+require 'lowtype'
 require 'observers'
 require 'paint'
 

data/lib/matrix/stream.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'low_event'
+require 'lowevent'
 require 'observers'
 
 require_relative 'cursor'

data/lib/pages/pages.rb

@@ -1,137 +1,54 @@
 # frozen_string_literal: true
 
-require_relative 'raindown/raindown'
+require 'raindown'
 
 module Rain
-  class Pages
+  # Generates static site pages and those pages have file paths that match a route "{page.path}".
+  # Unlike the Raindown CLI we don't write-back and we hide directives "<{}>" in the html output.
+  # This repo's .raindown/config.yml is for its own Markdown/Raindown files, not the static site.
+  class Pages < Raindown::Pages
     include LowType
 
     attr_reader :url_paths
 
     Page = Struct.new(:metadata, :html)
+    RENDER_OPTIONS = { hide_directives: true }.freeze
 
     def initialize(metadata:)
-      @file_paths = metadata.file_types.values_at('md', 'rd', 'markdown', 'raindown').flat_map { it }.compact
       @url_paths = {}
-      @tags = {}
 
-      process_files
+      super(metadata:, root: Pages.pages_path, render_options: RENDER_OPTIONS)
     end
 
     def page(path:)
       path = '/home' if path == '/'
       file_path = @url_paths[path] || return
 
-      metadata, markdown = parse_file(file_path:)
-      raindown = Raindown.render(markdown:)
-
-      Page.new(metadata, raindown)
-    end
-
-    def list(**typed_tags)
-      file_paths = tagged(**typed_tags)
-      sorted_paths = file_paths.sort_by { order(it) }
-      sorted_paths.map { |file_path| present_file(file_path:) }
-    end
-
-    def tagged(**typed_tags)
-      file_paths = []
-
-      typed_tags.each do |type, tag|
-        file_paths = [*file_paths, *@tags.dig(type, tag)]
-      end
-
-      file_paths
+      Page.new(@metadata[file_path], Raindown.render_file(path: file_path, metadata: self, **RENDER_OPTIONS))
     end
 
     private
 
-    def process_files
-      @file_paths.each do |file_path|
-        url_path = Pages.url_path(file_path:)
-        @url_paths[url_path] = file_path unless url_path.empty?
-
-        tag(type: :folder, tag: folders(file_path:).last, file_path:)
-
-        metadata, * = parse_file(file_path:, parse_content: false)
-        metadata.each do |type, tag|
-          tag(type:, tag:, file_path:)
-        end
-      end
-    end
-
-    def tag(type:, tag:, file_path:)
-      @tags[type] ||= {}
-      @tags[type][tag] ||= []
-      @tags[type][tag] << file_path
-    end
-
-    def folders(file_path:)
-      File.dirname(file_path)
-          .split(Regexp.union(['/', '&', '-']))
-          .filter { it.start_with?('_') }
-          .map { it.delete_prefix('_') }
-          .filter { !number?(it) }
-    end
-
-    def order(file_path)
-      file_path
-        .split(Regexp.union(['/', '&', '-']))
-        .filter { it.start_with?('_') }
-        .map { it.delete_prefix('_') }
-        .filter { number?(it) }
-        .last
-    end
-
-    def number?(string)
-      !Float(string, exception: false).nil?
-    end
-
-    def present_file(file_path:)
-      metadata, markdown = parse_file(file_path:)
-      metadata[:content] = markdown.empty? ? '' : Raindown.render(markdown:)
-      metadata[:path] = Pages.url_path(file_path:)
-
-      OpenStruct.new(metadata)
-    end
-
-    def parse_file(file_path:, parse_content: true)
-      dash_lines = []
-      data_lines = []
-      text_lines = []
-
-      File.foreach(file_path) do |line|
-        line.force_encoding('UTF-8')
-
-        if line.strip == '---' && dash_lines.count < 2
-          dash_lines << line
-          next
-        elsif dash_lines.count > 0 && dash_lines.count < 2
-          data_lines << line
-          next
-        end
-
-        break unless parse_content
-
-        text_lines << line
-      end
+    # Adds the URL path to Raindown's metadata for the file, in place of its file path.
+    def implicit_metadata(file_path:)
+      url_path = Pages.url_path(file_path:)
+      @url_paths[url_path] = file_path unless url_path.empty?
 
-      metadata = YAML.safe_load(data_lines.join, symbolize_names: true) || []
-      [metadata, text_lines.join.strip]
+      super.merge(path: url_path)
     end
 
     class << self
-      # Remove segments beginning with "_" and ending with "&", "-" or "/".
-      # Example: app/pages/docs/_basics/_1-getting-started.md => app/pages/docs/getting-started.md
+      # Remove segments beginning with "_" and ending with "&", "-" or "/", from the path under app/pages.
+      # Example: app/pages/docs/_basics/_1-getting-started.md => /docs/getting-started
       def url_path(file_path:)
-        url_path = file_path.split(Regexp.union(['/', '&'])).map do |segment|
-          next segment.sub(/^_\d\W/, '') if segment.sub(/^_\d\W/, '') != segment
-          next nil if segment.sub(/^_/, '') != segment
+        url_path = file_path.delete_prefix(pages_path).split(Regexp.union(['/', '&'])).map do |segment|
+          next segment.sub(/^_\d+\W/, '') if segment.match?(/^_\d+\W/)
+          next nil if segment.start_with?('_')
 
           segment
         end.compact.join('/')
 
-        url_path.delete_prefix(pages_path).delete_suffix(File.extname(url_path))
+        url_path.delete_suffix(File.extname(url_path))
       end
 
       def pages_path

data/lib/raindeer/boot.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'low_event'
-require 'low_node'
-require 'low_type'
+require 'lowevent'
+require 'lownode'
+require 'lowtype'
 require 'observers'
 require 'plugs'
 require 'providers'
@@ -37,7 +37,7 @@ module Rain
   end
 
   Providers.define('low.loop') do
-    require 'low_loop'
+    require 'lowloop'
     LowLoop.new(config:, router: Providers['rain.router'], renderer: Providers['rain.matrix'])
   end
 end
@@ -53,14 +53,14 @@ require_relative 'raindeer'
 # APPLICATION CODE
 #################################################
 
-require 'antlers' # Adds antlers support to lowload.
-require 'lowload'
-LowLoad.dirload(File.expand_path('../system', __dir__))
+require 'antlers' # Adds antlers support to dirload.
+require 'dirload'
+dirload(File.expand_path('../system', __dir__))
 
 application_path = File.expand_path('app', Dir.pwd)
 return unless Dir.exist?(application_path)
 
-metadata = LowLoad.dirload(application_path)
+metadata = dirload(application_path)
 
 if Dir.exist?(File.expand_path('pages', application_path))
   Providers.define('rain.pages', eager: true) do

data/lib/raindeer/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'low_node'
-require 'low_type'
+require 'lownode'
+require 'lowtype'
 require 'observers'
 require 'providers'
 

data/lib/router/events/route_event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'low_event'
+require 'lowevent'
 
 module Rain
   class RouteEvent < ::LowEvent

data/lib/router/events/wildcard_event.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'low_event'
+require 'lowevent'
 
 module Rain
   class WildcardEvent < ::LowEvent

data/lib/router/router.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'low_event'
+require 'lowevent'
 
 require_relative 'events/route_event'
 require_relative 'events/wildcard_event'

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raindeer
-  VERSION = '0.9.12'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.10.1
 platform: ruby
 authors:
 - maedi
@@ -9,34 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: commonmarker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -65,20 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rouge
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -94,77 +52,77 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: low_event
+  name: dirload
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
-  name: lowload
+  name: lowevent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
-  name: low_loop
+  name: lowloop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
-  name: low_node
+  name: lownode
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
-  name: low_state
+  name: lowtype
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: low_type
+  name: antlers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -178,7 +136,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: antlers
+  name: expressions
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,7 +150,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: expressions
+  name: observers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -206,7 +164,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: observers
+  name: plugs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -220,7 +178,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: plugs
+  name: providers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -234,19 +192,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: providers
+  name: raindown
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: trees
   requirement: !ruby/object:Gem::Requirement
@@ -282,10 +240,6 @@ files:
 - lib/matrix/matrix.rb
 - lib/matrix/stream.rb
 - lib/pages/pages.rb
-- lib/pages/raindown/elements.rb
-- lib/pages/raindown/lexemes/toc_lexeme.rb
-- lib/pages/raindown/nodes/toc_node.rb
-- lib/pages/raindown/raindown.rb
 - lib/raindeer/boot.rb
 - lib/raindeer/cli.rb
 - lib/raindeer/integrations.rb

data/lib/pages/raindown/elements.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'plugs'
-
-module Rain
-  class Elements
-    include Plugs
-
-    plug(:toc) do
-      plug(:lexeme) do
-        require_relative 'lexemes/toc_lexeme'
-        TOCLexeme
-      end
-
-      plug(:node) do
-        require_relative 'nodes/toc_node'
-        TOCNode
-      end
-    end
-  end
-end

data/lib/pages/raindown/lexemes/toc_lexeme.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'interfaces/lexeme' # From antlers gem, too generic.
-
-module Rain
-  module TOCLexeme
-    include Antlers::Lexeme
-
-    module_function
-
-    KEYWORDS = [':toc'].freeze
-
-    def match?(keywords:, **)
-      keywords.keys.include?(':toc')
-    end
-
-    def lexeme(**)
-      { toc: :default }
-    end
-  end
-end

data/lib/pages/raindown/nodes/toc_node.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'antlers'
-require 'nokogiri'
-
-module Rain
-  class TOCNode < Antlers::LeafNode
-    def initialize(name:, template:)
-      super(name:)
-
-      @template = template
-    end
-
-    def render(current_binding: nil, parent_binding: nil, slot_node: nil)
-      doc = Nokogiri::HTML(@template)
-
-      <<~HTML
-        <div class="floating">
-          <details id="toc" open>
-            <summary>Table of contents</summary>
-            <ul>
-              #{doc.css('h1[id], h2[id], h3[id], h4[id], h5[id], h6[id]').map do |h|
-                "<li class='#{h.name}'><a href='\##{h['id']}'>#{h.text.strip}</a></li>"
-              end.join("\n")}
-            </ul>
-          </details>
-        </div>
-      HTML
-    end
-
-    class << self
-      def match?(segment:)
-        segment[:toc]
-      end
-
-      def build(template:, **)
-        new(name: :toc, template:)
-      end
-    end
-  end
-end

data/lib/pages/raindown/raindown.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'commonmarker'
-require 'antlers/elements'
-require_relative 'elements'
-
-module Rain
-  module Raindown
-    module_function
-
-    def render(markdown:)
-      template = markdown.gsub('<{', '<!-- ANTLERS').gsub('}>', 'ANTLERS -->')
-
-      doc = Commonmarker.parse(template.force_encoding('UTF-8'), options: { extension: { alerts: true }})
-      doc.walk do |node|
-        if %i[code code_block].include?(node.type)
-          node.string_content = node.string_content.gsub('<!-- ANTLERS', '<{').gsub('ANTLERS -->', '}>')
-        end
-      end
-
-      template = doc.to_html(options: { render: { unsafe: true } })
-      template = template.gsub('<!-- ANTLERS', '<{').gsub('ANTLERS -->', '}>')
-
-      return template unless template.include?('<{') || template.include?('{')
-
-      ast = Antlers.ast(template:, elements: Antlers::Elements[:html, :prop] + Rain::Elements[:toc])
-
-      Antlers.render(ast:, current_binding: binding)
-    end
-  end
-end