raindeer 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e0b76037f60987d82171f076418703e068203ea1a9326964c630049a7aef633
-  data.tar.gz: 92a5be3103a09b81f287f3dafb74d75cf41761271d2c917500bf762fefb4613a
+  metadata.gz: 1911af310e0e12743cd151c8d0434b247d959385ea04329a40287538199b0407
+  data.tar.gz: 84320dbf6de9d25dd6c9c3315f51abfddeb2e21d62ddd6e99e8ff754ba252ba4
 SHA512:
-  metadata.gz: 06b5fb27769c9319b0c0dbe7ef75cbdab5f5ea6e1c9b116bcd73faffbb9c56211a9818e62aae4ebe27b3a120eb0fc689caabe55e14d751f7461a85a0aeaf9448
-  data.tar.gz: d96c8de0e0d25782b167c7fd72bd610463f353379df85024323edfaae941490bb7f751db37effb4112aa31788ba3de9f757bb38c16be937f03ed3329739f9bf5
+  metadata.gz: 7341996eb059d5dc1f7fb6075c2ffeb866efc6a68fc4a69142c321be325bdc5e15dad955a67d24b39b185dbbe2d6670466fddaf802ae8b43cb448cd0258fe33e
+  data.tar.gz: db80a6183bde1082b49cb230252f43ca9a5ff97eea0c5effda469ae0c09f17a4f2be9f16d8a9b9041388fb53eeebeda1b691dac8ed37a47459e70ef21f30c890

data/bin/rain

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Call "rain" to access the CLI loaded on your $PATH by Bundler.
+# Uncomment the line below and call "bin/rain" to load local gems from your Gemfile in development.
+# Comment this line out when running "bundle exec rake install".
+# require 'bundler/setup'
+
+require_relative '../lib/raindeer/cli'
+
+Rain::CLI.run(ARGV)

data/lib/cli/cli.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'trees'
+require_relative 'static/static'
+
+module Rain
+  module CLI
+    extend Trees
+
+    line('new :app_name') do |app_name|
+      execute { 'TODO' }
+    end
+
+    line('server') do
+      execute { system('bin/server') }
+    end
+
+    line('static') do
+      summary { 'Static site generation' }
+
+      line('build') do
+        execute { Static.build(application_path: Dir.pwd) }
+      end
+    end
+  end
+end

data/lib/cli/static/static.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'antlers'
+require 'lowload'
+
+module Rain
+  module CLI
+    module Static
+      extend self
+
+      def build(application_path:)
+        metadata = LowLoad.dirload(File.expand_path('app', application_path))
+        # TODO: Use metadata.url_paths to HTTP Request and export the response to a build folder of HTML.
+      end
+    end
+  end
+end

data/lib/pages/pages.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'kramdown'
-require 'kramdown-parser-gfm'
-require 'rouge'
+require_relative 'raindown/raindown'
 
 module Rain
   class Pages
@@ -14,13 +12,14 @@ module Rain
 
     def initialize(metadata:)
       @url_paths = metadata.url_paths
+      @raindown = Raindown.new(metadata:)
     end
 
     def process(file_path:)
-      metadata, text = parse_file(file_path:)
-      html = Kramdown::Document.new(text, input: 'GFM', syntax_highlighter: 'rouge').to_html
+      metadata, markdown = parse_file(file_path:)
+      raindown = @raindown.render(markdown:)
 
-      Result.new(metadata, html)
+      Result.new(metadata, raindown)
     end
 
     private

data/lib/pages/raindown/elements.rb

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'interfaces/lexeme' # From antlers gem, too generic.
+
+module Rain
+  module TOCLexeme
+    include Antlers::Lexeme
+    extend self
+
+    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

@@ -0,0 +1,41 @@
+# 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)
+
+      output = <<~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 { |h|
+                "<li class='#{h.name}'><a href='\##{h['id']}'>#{h.text.strip}</a></li>"
+              }.join("\n")}
+            </ul>
+          </div>
+        </details>
+      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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'commonmarker'
+require 'antlers/elements'
+require_relative 'elements'
+
+module Rain
+  class Raindown
+    def initialize(metadata: {})
+      @metadata = metadata
+    end
+
+    def render(markdown:)
+      template = markdown.gsub('<{', '<!-- ANTLERS').gsub('}>', 'ANTLERS -->')
+
+      doc = Commonmarker.parse(template)
+      doc.walk do |node|
+        if node.type == :code || node.type == :code_block
+          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

data/lib/raindeer/boot.rb

@@ -6,15 +6,14 @@ require 'low_type'
 require 'observers'
 require 'providers'
 
-require_relative '../pages/pages'
-require_relative '../router/router'
-require_relative '../support/config_loader'
+# File paths are relative to the directory where the process is run from, so the app can just require this boot file.
 
 #################################################
-# INTERNAL API
+# FRAMEWORK INTERNAL API
 #################################################
 
 module Rain
+  require_relative '../support/config_loader'
   env = {
     host: ENV.fetch('RAIN_HOST', nil),
     port: ENV.fetch('RAIN_PORT', nil),
@@ -23,8 +22,8 @@ module Rain
     matrix_mode: ConfigLoader.parse_boolean(ENV.fetch('RAIN_MATRIX', nil)),
     mirror_mode: ConfigLoader.parse_boolean(ENV.fetch('RAIN_MIRROR', nil))
   }
-
-  config = ConfigLoader.load('config.yaml', env)
+  config_path = File.expand_path('config/config.yaml', Dir.pwd)
+  config = ConfigLoader.load(config_path, env)
 
   Providers.define('rain.router') do
     require_relative '../router/router'
@@ -43,7 +42,7 @@ module Rain
 end
 
 #################################################
-# EXTERNAL API
+# FRAMEWORK EXTERNAL API
 #################################################
 
 module Raindeer
@@ -55,10 +54,10 @@ module Raindeer
 end
 
 #################################################
-# USER CODE
+# APPLICATION CODE
 #################################################
 
-require 'antlers' # LowLoad supports antlers but doesn't make it a hard dependency.
+require 'antlers' # Adds antlers support to lowload.
 require 'lowload'
 LowLoad.dirload(File.expand_path('../system', __dir__))
 
@@ -66,8 +65,10 @@ application_path = File.expand_path('app', Dir.pwd)
 return unless Dir.exist?(application_path)
 
 metadata = LowLoad.dirload(application_path)
-return unless Dir.exist?(File.expand_path('pages', application_path))
 
-Providers.define('rain.pages', eager: true) do
-  Rain::Pages.new(metadata:)
+if Dir.exist?(File.expand_path('pages', application_path))
+  Providers.define('rain.pages', eager: true) do
+    require_relative '../pages/pages'
+    Rain::Pages.new(metadata:)
+  end
 end

data/lib/raindeer/cli.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'low_node'
+require 'low_type'
+require 'observers'
+require 'providers'
+
+# Allows the CLI to load application code and metadata, but not start a server.
+
+#################################################
+# FRAMEWORK INTERNAL API
+#################################################
+
+module Rain
+  Providers.define('rain.router') do
+    require_relative '../router/router'
+    Router.new
+  end
+end
+
+#################################################
+# FRAMEWORK EXTERNAL API
+#################################################
+
+module Raindeer
+  class << self
+    def router(&block)
+      Providers['rain.router'].instance_eval(&block)
+    end
+  end
+end
+
+#################################################
+# CLI
+#################################################
+
+require_relative '../cli/cli'

data/lib/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - maedi
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kramdown
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +52,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kramdown-parser-gfm
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +66,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rouge
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -205,6 +205,20 @@ dependencies:
     - - ">="
       - !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'
 - !ruby/object:Gem::Dependency
   name: providers
   requirement: !ruby/object:Gem::Requirement
@@ -219,13 +233,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A new Ruby framework. Coming soon...
+description: "Raindeer is an event-driven framework using the dynamic features and
+  latest async improvements in Ruby + some weird ideas, \nto build a new breed of
+  web application. Each Raindeer component can be used individually in your exisiting
+  application, \nor all together as a cohesive framework. Deer to be different.\n"
 email:
 - maediprichard@gmail.com
-executables: []
+executables:
+- rain
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/rain
+- lib/cli/cli.rb
+- lib/cli/static/static.rb
 - lib/matrix/cursor.rb
 - lib/matrix/effects/color_effect.rb
 - lib/matrix/effects/effect.rb
@@ -233,7 +254,12 @@ 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/router/route.rb
 - lib/router/route_event.rb
 - lib/router/router.rb
@@ -252,11 +278,12 @@ files:
 - lib/system/status_node.rbx
 - lib/system/system_routes.rb
 - lib/version.rb
-homepage: https://codeberg.org/raindeer/raindeer
+homepage: https://github.com/raindeer-rb/raindeer
 licenses: []
 metadata:
-  homepage_uri: https://codeberg.org/raindeer/raindeer
-  source_code_uri: https://codeberg.org/raindeer/raindeer/src/branch/main
+  homepage_uri: https://github.com/raindeer-rb/raindeer
+  source_code_uri: https://github.com/raindeer-rb/raindeer/src/branch/main
+  mailing_list_uri: https://www.rubyforum.org/tag/raindeer
 rdoc_options: []
 require_paths:
 - lib
@@ -273,5 +300,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Deer to be different
+summary: An event-driven and compositional web framework that's easy to use. Deer
+  to be different.
 test_files: []