raindown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0250c356fb715c70bb5620ebb20f3d9f92775398b1b002c71eec906f4cf3ad20
+  data.tar.gz: a601014e5ce54762c17db6d888067cd66239a64169ab453621036d95ca82a177
+SHA512:
+  metadata.gz: 975fbcedd3fc3a2e3c2b853173ac5f5eb882db921462fc4dba2d15cc35e7e8278ff0c44a89e986f8c967dcc73c1f80d59f1348850cddb06e92d409484d18f005
+  data.tar.gz: 2042a62352c54e59801d300cd49fa5ea7d7ffc65a8f01bd1aa0f213151606d947a7ea614239e148d36e5ccff1f0340714870dc1a383f695b7266990e58632c57

data/lib/elements.rb

@@ -0,0 +1,33 @@
+# 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
+
+    plug(:list) do
+      plug(:lexeme) do
+        require_relative 'lexemes/list_lexeme'
+        ListLexeme
+      end
+
+      plug(:node) do
+        require_relative 'nodes/list_node'
+        ListNode
+      end
+    end
+  end
+end

data/lib/lexemes/list_lexeme.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'antlers/api'
+
+module Rain
+  module ListLexeme
+    include Antlers::Lexeme
+
+    module_function
+
+    KEYWORDS = ['list:', 'folder:', 'order:', ':list'].freeze
+
+    def match?(keywords:, **)
+      KEYWORDS.include?(keywords.keys.first)
+    end
+
+    def lexeme(keywords:, **)
+      if keywords['list:']
+        *key, value = keywords['list:'].split(',').map(&:strip)
+
+        list_def = { list_def: value, folder: keywords['folder:'] }
+        list_def[:order] = keywords['order:'] if keywords['order:']
+        list_def[:key] = key.first unless key.empty?
+
+        return list_def
+      end
+
+      # TODO: Keep track of which list loop we're in to allow nested list loops.
+      { list_end: 'level_1' }
+    end
+  end
+end

data/lib/lexemes/toc_lexeme.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'antlers/api'
+
+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/nodes/list_node.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'antlers/api'
+
+module Rain
+  class ListNode < Antlers::BranchNode
+    include Antlers::Props
+    include Antlers::Variables
+
+    DEF_KEY = :list_def
+    END_KEY = :list_end
+
+    def initialize(value:, folder:, props: [], children: [])
+      super(name: :toc, props:, children:)
+
+      @value = value.delete("'").delete('"')
+      @folder = folder.delete("'").delete('"')
+    end
+
+    def render(current_binding: nil, parent_binding: nil, slot_node: nil, metadata: {})
+      output = ''
+
+      list = metadata.list(folder: @folder)
+
+      list.each do |value|
+        # TODO: Parallelize by creating new bindings and ensuring children have any args they need via RenderEvent.
+        current_binding.local_variable_set(@value, value)
+
+        @children.each do |child|
+          output += child.render(current_binding:, parent_binding:, slot_node:, metadata:) || ''
+        end
+      end
+
+      output
+    end
+
+    class << self
+      def match?(segment:)
+        segment[DEF_KEY]
+      end
+
+      def build(segment:, **)
+        new(value: segment[:list_def], folder: segment[:folder])
+      end
+    end
+  end
+end

data/lib/nodes/toc_node.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'antlers/api'
+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, metadata: {})
+      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/raindown.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'commonmarker'
+require 'antlers/api'
+require_relative 'elements'
+
+module Rain
+  module Raindown
+    module_function
+
+    def render(markdown:, metadata: {})
+      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, :var, :prop, :slot, :if, :for] + Rain::Elements[:toc, :list])
+
+      Antlers.render(ast:, current_binding: binding, metadata:)
+    end
+  end
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: raindown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- maedi
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: antlers
+  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: 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: plugs
+  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'
+description: |
+  Raindown is a templating layer for static site generation
+  and an annotation framework for Markdown files.
+email:
+- maediprichard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/elements.rb
+- lib/lexemes/list_lexeme.rb
+- lib/lexemes/toc_lexeme.rb
+- lib/nodes/list_node.rb
+- lib/nodes/toc_node.rb
+- lib/raindown.rb
+- lib/version.rb
+homepage: https://github.com/raindeer-rb/raindown
+licenses: []
+metadata:
+  homepage_uri: https://github.com/raindeer-rb/raindown
+  source_code_uri: https://github.com/raindeer-rb/raindown/src/branch/main
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Markup your markdown with a template and annotation layer
+test_files: []