raindeer 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10abc837f7a79dd6e8807ab756f5d393324ef1643dc7eacfc53fdd09246e5d97
-  data.tar.gz: 15eb9638281737ad60f8ce07dd9164f8584ec5ac8a66b0d5f304c734f13155f0
+  metadata.gz: 1911af310e0e12743cd151c8d0434b247d959385ea04329a40287538199b0407
+  data.tar.gz: 84320dbf6de9d25dd6c9c3315f51abfddeb2e21d62ddd6e99e8ff754ba252ba4
 SHA512:
-  metadata.gz: 27d14ec70fdd565fa5d62833f05672762bce3e050a482b6748d99b524892b473b42cda5658b3aa22dc459fcd3230614e724928d01de5e1d138031ee0a6f4151e
-  data.tar.gz: 07761ecc57e9660c719793226e63f6be7ba4d795e660647d8d9540b16b53a857f5e33e27e8d3aa435b2775d2a4222b8df17220008036f77cd64637fb8239d8b4
+  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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative 'raindown/raindown'
+
+module Rain
+  class Pages
+    include LowType
+
+    attr_reader :url_paths
+
+    Result = Struct.new(:metadata, :html)
+
+    def initialize(metadata:)
+      @url_paths = metadata.url_paths
+      @raindown = Raindown.new(metadata:)
+    end
+
+    def process(file_path:)
+      metadata, markdown = parse_file(file_path:)
+      raindown = @raindown.render(markdown:)
+
+      Result.new(metadata, raindown)
+    end
+
+    private
+
+    def parse_file(file_path:)
+      dash_lines = []
+      data_lines = []
+      text_lines = []
+
+      File.foreach(file_path).with_index do |line, index|
+        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
+
+        text_lines << line
+      end
+
+      [YAML.safe_load(data_lines.join, symbolize_names: true), text_lines.join.strip]
+    end
+  end
+end

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,10 +6,14 @@ require 'low_type'
 require 'observers'
 require 'providers'
 
-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.
+
+#################################################
+# FRAMEWORK INTERNAL API
+#################################################
 
 module Rain
+  require_relative '../support/config_loader'
   env = {
     host: ENV.fetch('RAIN_HOST', nil),
     port: ENV.fetch('RAIN_PORT', nil),
@@ -18,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'
@@ -37,6 +41,10 @@ module Rain
   end
 end
 
+#################################################
+# FRAMEWORK EXTERNAL API
+#################################################
+
 module Raindeer
   class << self
     def router(&block)
@@ -45,5 +53,22 @@ module Raindeer
   end
 end
 
+#################################################
+# APPLICATION CODE
+#################################################
+
+require 'antlers' # Adds antlers support to lowload.
 require 'lowload'
 LowLoad.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)
+
+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/router/router.rb

@@ -6,6 +6,7 @@ require 'providers'
 require_relative 'route'
 require_relative 'route_event'
 require_relative 'trie'
+require_relative 'wildcard_route_event'
 
 module Rain
   class Router
@@ -58,9 +59,14 @@ module Rain
       @trie.match(path: event.request.path.delete_suffix('/')).each do |route_event|
         response_event = route_event.trigger
       end
-
       return response_event if response_event
 
+      if @routes['/*']
+        route = Route.new(path: event.request.path, verbs: @routes['/*'].verbs)
+        wildcard_event = WildcardRouteEvent.trigger(key: '/*', action: :render, route:)
+        return wildcard_event if wildcard_event
+      end
+
       Low::Events::StatusEvent.trigger(status: Low::Types::Status[404], request: event.request)
     end
   end

data/lib/router/wildcard_route_event.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'low_event'
+
+module Rain
+  class WildcardRouteEvent < ::LowEvent
+    attr_reader :route, :params
+
+    def initialize(key:, route:, action: :render)
+      super(key:, action:)
+
+      @route = route
+    end
+  end
+end

data/lib/system/layouts/layout_node.rbx

@@ -5,7 +5,7 @@ module System
     def render(event:)
       <html>
         <head>
-          <link rel="stylesheet" href="/system/pico.min.css">
+          <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@picocss/pico@2/css/pico.min.css">
           <link rel="stylesheet" href="/system/system.css">
         </head>
         <body>

data/lib/version.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.5.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:
@@ -37,6 +37,48 @@ dependencies:
     - - ">="
       - !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: 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: 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: low_event
   requirement: !ruby/object:Gem::Requirement
@@ -163,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
@@ -177,25 +233,39 @@ 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
 - lib/matrix/effects/leet_effect.rb
 - 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
 - lib/router/trie.rb
 - lib/router/trie_node.rb
+- lib/router/wildcard_route_event.rb
 - lib/support/config_loader.rb
 - lib/system/dashboard_node.rbx
 - lib/system/events_node.rbx
@@ -206,13 +276,14 @@ files:
 - lib/system/routes_node.rbx
 - lib/system/status_404_node.rbx
 - lib/system/status_node.rbx
-- lib/system/system.rb
+- 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
@@ -229,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: []