raindeer 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d79ce92ce79c7e46122adb4e9ba39968d9bf220cca424deba580f3a74ac26c6
-  data.tar.gz: 6970876678afd4bf8395135d52a9c1ff20858170282e3c97c540f1458338d4ea
+  metadata.gz: 10abc837f7a79dd6e8807ab756f5d393324ef1643dc7eacfc53fdd09246e5d97
+  data.tar.gz: 15eb9638281737ad60f8ce07dd9164f8584ec5ac8a66b0d5f304c734f13155f0
 SHA512:
-  metadata.gz: 947dd01220faa492c9abf83e78aae9ec07d5e6c5794724aa24dda43be39e8fe82822734c068612f1176246c64b3e5f34e205d5b2fbb7d5517be598d3e927b1f2
-  data.tar.gz: bb4fff4358eae10a7b3ee1085ad9bd35bd7ac795c639dcb48b8e7c7deea3055e592a1f196931fc98ad64161631b5107bd1ca75fe29086d415891e7cfc23d84d3
+  metadata.gz: 27d14ec70fdd565fa5d62833f05672762bce3e050a482b6748d99b524892b473b42cda5658b3aa22dc459fcd3230614e724928d01de5e1d138031ee0a6f4151e
+  data.tar.gz: 07761ecc57e9660c719793226e63f6be7ba4d795e660647d8d9540b16b53a857f5e33e27e8d3aa435b2775d2a4222b8df17220008036f77cd64637fb8239d8b4

data/lib/matrix/cursor.rb

@@ -4,8 +4,8 @@ module Rain
   class Cursor
     attr_accessor :index, :first_update, :last_update
 
-    def initialize
-      @index = -1
+    def initialize(index: -1)
+      @index = index
       @first_update = now
       @last_update = now
     end

data/lib/matrix/effects/color_effect.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'effect'
+
+module Rain
+  class ColorEffect < Effect
+    def render(output:, next_output:, **)
+      color = next_output ? @config.cell_color : @config.lead_color
+
+      return Paint[output, '#006ab0'] if @config.leet_keys.invert.key?(output)
+      output ? Paint[output, color] : Paint[' ']
+    end
+  end
+end

data/lib/matrix/effects/effect.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rain
+  class Effect
+    attr_accessor :last_output
+
+    def initialize(config:)
+      @config = config
+      @last_output = {}
+    end
+
+    def save(output:, x:, y:)
+      @last_output[x] ||= {}
+      @last_output[x][y] = output
+    end
+  end
+end

data/lib/matrix/effects/leet_effect.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'effect'
+
+module Rain
+  class LeetEffect < Effect
+    def initialize(config:)
+      super(config:)
+
+      @leet_numbers = @config.leet_keys.transform_keys(&:to_s)
+      @leet_letters = @leet_numbers.invert
+    end
+
+    def render(output:, next_output:, x:, y:)
+      output = filter(output:, next_output:, x:, y:)
+      save(output:, x:, y:)
+    end
+
+    private
+
+    def filter(output:, next_output:, x:, y:)
+      return unless output
+
+      character = output.downcase
+      last_character = @last_output.dig(x, y)
+
+      return @leet_numbers[character] if @leet_letters.key?(last_character) && rand < 0.99
+      return @leet_numbers[character] if @leet_numbers.key?(character) && rand < 0.005
+        
+      output
+    end
+  end
+end

data/lib/matrix/matrix.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
 require 'low_event'
+require 'low_type'
 require 'observers'
 require 'paint'
 
-require_relative '../support/config_loader'
+require_relative 'effects/color_effect'
+require_relative 'effects/leet_effect'
 require_relative 'stream'
+require_relative '../support/config_loader'
 
 module Rain
   class Matrix
+    include LowType
     include Observers
 
-    def initialize(event_pool:, config: ConfigLoader.load('./config/matrix.yaml'))
+    def initialize(event_pool:, config: ConfigLoader.load('matrix.yaml'))
       @event_pool = event_pool
       @config = config
+      @effects = [LeetEffect.new(config:), ColorEffect.new(config:)]
 
       @screen_size = nil
 
@@ -64,6 +69,8 @@ module Rain
       stream
     end
 
+    # Where streams become the final output on the matrix.
+    # @columns - A column contains a particular stream
     def render_streams(show_output: true) # rubocop:disable Metrics/AbcSize
       @streams.each_value(&:render)
 
@@ -72,17 +79,18 @@ module Rain
       output = ''.dup
 
       (0...@screen_size[:row_count]).each do |row_index|
-        cell_outputs = []
-        cell_colors = []
+        row_outputs = []
 
         # Rendering streams can happen before redrawing streams, so @columns may not be populated yet.
         (0...column_count).each do |column_index|
-          cell_colors << (@columns[column_index].nil? ? nil : @columns[column_index].colors[row_index])
-          cell_outputs << (@columns[column_index].nil? ? nil : @columns[column_index].outputs[row_index])
+          row_outputs << (@columns[column_index].nil? ? nil : @columns[column_index].outputs[row_index])
         end
 
-        output << "\n" + cell_outputs.zip(cell_colors).map do |cell, color| # rubocop:disable Style/StringConcatenation
-          cell ? Paint[cell, color] : Paint[' ']
+        output << "\n" + row_outputs.map.with_index do |output, col_index| # rubocop:disable Style/StringConcatenation
+          @effects.reduce(output) do |out, effect|
+            next_output = @columns[col_index].nil? ? nil : @columns[col_index].outputs[row_index + 1]
+            effect.render(output: out, next_output:, x: row_index, y: col_index)
+          end
         end.join(' ')
       end
 

data/lib/matrix/stream.rb

@@ -8,7 +8,7 @@ require_relative 'cursor'
 module Rain
   class Stream
     include Observers
-    attr_reader :index, :inputs, :outputs, :delays, :colors, :head_cursor, :tail_cursor
+    attr_reader :index, :inputs, :outputs, :delays, :head_cursor, :tail_cursor
 
     ARROW = ['│', '▼'].freeze
 
@@ -19,13 +19,11 @@ module Rain
 
       @inputs = []
       @delays = []
-      @colors = []
       @outputs = []
 
       @event_cursor = 0
       @head_cursor = Cursor.new
-      @tail_cursor = Cursor.new
-      @tail_cursor.index = 0
+      @tail_cursor = Cursor.new(index: 0)
 
       @show_cursor = Cursor.new
       @hide_cursor = Cursor.new
@@ -75,10 +73,7 @@ module Rain
     # │  s  │  75 │     │        Then sets a "250" delay for the Hide Cursor.
     # │  t  │  75 │     │
     # └─────┴─────┴─────┘
-    #
-    # TODO: Refactor "@colors" into an Effect that happens dynamically on render rather than stored as a column of data.
-    #       This will reduce the "Metrics/AbcSize" complexity.
-    def render(duration: nil) # rubocop:disable Metrics/AbcSize
+    def render(duration: nil)
       @show_cursor.increment(delays:, inputs:, duration:) do |index|
         prev_index = index.zero? ? @inputs.count - 1 : index - 1
         next_index = index + 1 >= @inputs.count ? 0 : index + 1
@@ -86,8 +81,6 @@ module Rain
         if @inputs[index]
           @outputs[index] = @inputs[index]
           @delays[index] = @config.fade_delay
-          @colors[prev_index] = @config.cell_color if @colors[prev_index]
-          @colors[index] = @outputs[next_index] ? @config.cell_color : @config.lead_color
           @inputs[index] = nil
         end
       end
@@ -130,7 +123,7 @@ module Rain
     # │o│   1. The minimum delay
     # │u│   2. The time elapsed between events divided by the number of cells
     # │t│
-    # │e│ ◀── A cursor moves to the next cell after a delay and colors the leading cell white.
+    # │e│ ◀── A cursor moves to the next cell after a delay.
     # └─┘
     def redraw_event(current_event:, past_event:)
       variable_delay = variable_delay(current_event:, past_event:)
@@ -171,7 +164,6 @@ module Rain
       @inputs = @inputs.fill(nil, old_index...cell_count)[0...cell_count]
       @outputs = @outputs.fill(nil, old_index...cell_count)[0...cell_count]
       @delays = @delays.fill(@config.min_delay, old_index...cell_count)[0...cell_count]
-      @colors = @colors.fill(@config.cell_color, old_index...cell_count)[0...cell_count]
     end
 
     def randomize_start_index

data/lib/raindeer/boot.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'low_event'
+require 'low_node'
+require 'low_type'
+require 'observers'
+require 'providers'
+
+require_relative '../router/router'
+require_relative '../support/config_loader'
+
+module Rain
+  env = {
+    host: ENV.fetch('RAIN_HOST', nil),
+    port: ENV.fetch('RAIN_PORT', nil),
+    web_root: ENV.fetch('RAIN_WEB_ROOT', nil),
+    debug_mode: ConfigLoader.parse_boolean(ENV.fetch('RAIN_DEBUG', true)),
+    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)
+
+  Providers.define('rain.router') do
+    require_relative '../router/router'
+    Router.new
+  end
+
+  Providers.define('rain.matrix') do
+    require_relative '../matrix/matrix'
+    Matrix.new(event_pool: Providers['low.event.pool'])
+  end
+
+  Providers.define('low.loop') do
+    require 'low_loop'
+    LowLoop.new(config:, router: Providers['rain.router'], renderer: Providers['rain.matrix'])
+  end
+end
+
+module Raindeer
+  class << self
+    def router(&block)
+      Providers['rain.router'].instance_eval(&block)
+    end
+  end
+end
+
+require 'lowload'
+LowLoad.dirload(File.expand_path('../system', __dir__))

data/lib/support/config_loader.rb

@@ -6,8 +6,9 @@ require 'yaml'
 module Rain
   class ConfigLoader
     class << self
-      def load(filepath, overrides = {})
-        config_file = YAML.safe_load_file(filepath, permitted_classes: [Symbol], symbolize_names: true)
+      def load(file_path, overrides = {})
+        file_path = File.expand_path("../../../config/#{file_path}", __FILE__) unless File.exist?(file_path)
+        config_file = YAML.safe_load_file(file_path, permitted_classes: [Symbol], symbolize_names: true)
 
         # Environment variables override config file.
         config_data = config_file.merge(overrides) do |_key, old_value, new_value|

data/lib/system/dashboard_node.rbx

@@ -1,11 +1,23 @@
 # frozen_string_literal: true
 
-class DashboardNode < LowNode
-  observe '/system'
+module System
+  class DashboardNode < LowNode
+    observe '/system'
 
-  def render(event:) # rubocop:disable Lint/UnusedMethodArgument
-    <{ LayoutNode: }>
-      <h1>{"Dashboard"}</h1>
-    <{ :LayoutNode }>
+    def initialize(event:)
+      @node_count = LowNode.count
+      @event_count = LowEvent.count
+    end
+
+    def render(event:) # rubocop:disable Lint/UnusedMethodArgument
+      <{ LayoutNode: }>
+        <h1>{"Dashboard"}</h1>
+
+        <div class="grid">
+          <{ StatFormatter title='Nodes' stat=@node_count }>
+          <{ StatFormatter title='Events' stat=@event_count }>
+        </div>
+      <{ :LayoutNode }>
+    end
   end
 end

data/lib/system/events_node.rbx

@@ -1,34 +1,37 @@
 # frozen_string_literal: true
 
-class EventsNode < LowNode
-  observe '/system/events'
+module System
+  class EventsNode < LowNode
+    observe '/system/events'
 
-  def initialize(event:)
-    @events = 'TODO: Populate via LowEvent inherited hook.'
-  end
-
-  def render(event:)
-    <{ LayoutNode: }>
-      <h1>{"Events"}</h1>
+    def initialize(event:)
+      # TODO: Include types that can be observed keys too like Status and Status[404].
+      @event_types = LowEvent.events
+    end
 
-      {@events}
+    def render(event:)
+      <{ LayoutNode: }>
+        <h1>{"Events"}</h1>
 
-      <table>
-        <thead>
-          <tr>
-            <th scope="col">HTTP Verbs</th>
-            <th scope="col">Route</th>
-            <th scope="col">Observers</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <td>1</td>
-            <td>2</td>
-            <td>3</td>
-          </tr>
-        </tbody>
-      </table>
-    <{ :LayoutNode }>
+        <table>
+          <thead>
+            <tr>
+              <th scope="col">Event</th>
+              <th scope="col">Observers</th>
+            </tr>
+          </thead>
+          <tbody>
+            <{ for: observer_key in: @event_types }>
+              <tr>
+                <td>{observer_key}</td>
+                <td>
+                  <{ ObserversFormatter observer_key=observer_key }>
+                </td>
+              </tr>
+            <{ :for }>
+          </tbody>
+        </table>
+      <{ :LayoutNode }>
+    end
   end
 end

data/lib/system/formatters/label_formatter.rbx

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class LabelFormatter < LowNode
+  def render(event:, labels:)
+    <ul class="labels">
+      <{ for: label in: labels }>
+        <li class={label}>{label}</li>
+      <{ :for }>
+    </ul>
+  end
+end

data/lib/system/formatters/observers_formatter.rbx

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ObserversFormatter < LowNode
+  def initialize(event:, observer_key:)
+    # TODO: What's the best way to do this? An "if:" at the template layer? A decorator at the node layer?
+    if observer_key.to_s == 'Rain::RouteEvent'
+      routes_count = Providers['rain.router'].routes.count
+      @observers = ["#{routes_count} routes"]
+    else
+      @observers = Observers[observer_key].map { it.object }
+    end
+  end
+    
+  def render(event:, observer_key:)
+    <ul>
+      <{ for: observer in: @observers }>
+        <li>{ observer }</li>
+      <{ :for }>
+    </ul>
+  end
+end

data/lib/system/formatters/stat_formatter.rbx

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class StatFormatter < LowNode
+  def render(event:, title:, stat:)
+    <article class="stat">
+      <div class="number">{stat}</div>
+      <footer>{title}</footer>
+    </article>
+  end
+end

data/lib/system/layouts/layout_node.rbx

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module System
+  class LayoutNode < LowNode
+    def render(event:)
+      <html>
+        <head>
+          <link rel="stylesheet" href="/system/pico.min.css">
+          <link rel="stylesheet" href="/system/system.css">
+        </head>
+        <body>
+          <header>
+            <div class="container">
+              <a id="favicon" href="/system"><img src="/system/favicon.svg"/></a>
+              <nav id="navbar">
+                <ul>
+                  <li><a href="/system">{"Dashboard"}</a>
+                  <li><a href="/system/events">{"Events"}</a>
+                  <li><a href="/system/routes">{"Routes"}</a>
+                </ul>
+              </nav>
+            </div>
+          </header>
+
+          <main class="container">
+            <{ :slot }>
+          </main>
+
+          <footer>
+            <div class="container">
+              <ul>
+                <li><a href="https://raindeer.dev">{"Website"}</a></li>
+                <li><a href="https://raindeer.dev/docs">{"Docs"}</a></li>
+                <li><a href="https://github.com/raindeer-rb/raindeer">{"Source code"}</a></li>
+              </ul>
+            </div>
+          </footer>
+        </body>
+      </html>
+    end
+  end
+end

data/lib/system/routes_node.rbx

@@ -1,34 +1,36 @@
 # frozen_string_literal: true
 
-class RoutesNode < LowNode
-  observe '/system/routes'
+module System
+  class RoutesNode < LowNode
+    observe '/system/routes'
 
-  def initialize(event:)
-    @routes = Providers['rain.router'].routes
-  end
-
-  def render(event:)
-    <{ LayoutNode: }>
-      <h1>{"Routes"}</h1>
+    def initialize(event:)
+      @routes = Providers['rain.router'].routes
+    end
 
-      {@routes}
+    def render(event:)
+      <{ LayoutNode: }>
+        <h1>{"Routes"}</h1>
 
-      <table>
-        <thead>
-          <tr>
-            <th scope="col">HTTP Verbs</th>
-            <th scope="col">Route</th>
-            <th scope="col">Observers</th>
-          </tr>
-        </thead>
-        <tbody>
-          <tr>
-            <td>1</td>
-            <td>2</td>
-            <td>3</td>
-          </tr>
-        </tbody>
-      </table>
-    <{ :LayoutNode }>
+        <table>
+          <thead>
+            <tr>
+              <th scope="col">HTTP Verbs</th>
+              <th scope="col">Route</th>
+              <th scope="col">Observers</th>
+            </tr>
+          </thead>
+          <tbody>
+            <{ for: path, route in: @routes }>
+              <tr>
+                <td><{ LabelFormatter labels=route.verbs }></td>
+                <td>{route.path}</td>
+                <td><{ ObserversFormatter observer_key=route.path }></td>
+              </tr>
+            <{ :for }>
+          </tbody>
+        </table>
+      <{ :LayoutNode }>
+    end
   end
 end

data/lib/system/status_404_node.rbx

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class Status404Node < LowNode
+  observe Status[404]
+
+  def render
+    <div class="status status-404">
+      <em>404</em>
+    </div>
+  end
+end

data/lib/system/status_node.rbx

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class StatusNode < LowNode
+  observe Status
+
+  def initialize(event: StatusEvent)
+    @status_code = event.status.status_code
+  end
+
+  def render
+    <div class="status status-{@status_code}">
+      <em>{@status_code}</em>
+    </div>
+  end
+end

data/lib/system/system.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative '../raindeer'
-
 Raindeer.router do
   get '/system' do
     get '/events'

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - maedi
@@ -55,30 +55,30 @@ dependencies:
   name: lowload
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: low_loop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: low_node
   requirement: !ruby/object:Gem::Requirement
@@ -184,11 +184,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/boot.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/raindeer.rb
+- lib/raindeer/boot.rb
 - lib/router/route.rb
 - lib/router/route_event.rb
 - lib/router/router.rb
@@ -196,10 +198,14 @@ files:
 - lib/router/trie_node.rb
 - lib/support/config_loader.rb
 - lib/system/dashboard_node.rbx
-- lib/system/error_404_node.rbx
 - lib/system/events_node.rbx
-- lib/system/layout_node.rbx
+- lib/system/formatters/label_formatter.rbx
+- lib/system/formatters/observers_formatter.rbx
+- lib/system/formatters/stat_formatter.rbx
+- lib/system/layouts/layout_node.rbx
 - lib/system/routes_node.rbx
+- lib/system/status_404_node.rbx
+- lib/system/status_node.rbx
 - lib/system/system.rb
 - lib/version.rb
 homepage: https://codeberg.org/raindeer/raindeer

data/lib/boot.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require 'low_event'
-require 'low_node'
-require 'low_type'
-require 'providers'
-
-require_relative 'support/config_loader'
-
-env = {
-  host: ENV.fetch('RAIN_HOST', nil),
-  port: ENV.fetch('RAIN_PORT', nil),
-  web_root: ENV.fetch('RAIN_WEB_ROOT', nil),
-  matrix_mode: Rain::ConfigLoader.parse_boolean(ENV.fetch('RAIN_MATRIX', nil)),
-  mirror_mode: Rain::ConfigLoader.parse_boolean(ENV.fetch('RAIN_MIRROR', nil))
-}
-
-config = Rain::ConfigLoader.load('./config/config.yaml', env)
-
-Providers.define('rain.router') do
-  require_relative 'router/router'
-  Rain::Router.new
-end
-
-Providers.define('rain.matrix') do
-  require_relative 'matrix/matrix'
-  Rain::Matrix.new(event_pool: Providers['low.event.pool'])
-end
-
-Providers.define('low.loop') do
-  require 'low_loop'
-  LowLoop.new(config:, router: Providers['rain.router'], renderer: Providers['rain.matrix'])
-end
-
-require 'lowload'
-LowLoad.dirload(File.expand_path('system', __dir__))

data/lib/raindeer.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'low_event'
-require 'low_node'
-require 'low_type'
-require 'observers'
-require 'providers'
-
-require_relative 'router/router'
-
-module Raindeer
-  class << self
-    def router(&block)
-      Providers['rain.router'].instance_eval(&block)
-    end
-  end
-end

data/lib/system/error_404_node.rbx

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class Error404Node < LowNode
-  observe Low::Types::Status[404]
-
-  def render(event:) # rubocop:disable Lint/UnusedMethodArgument
-    <div class="page-not-found">
-      <em>404</em>
-    </div>
-  end
-end

data/lib/system/layout_node.rbx

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-class LayoutNode < LowNode
-  def render(event:)
-    <html>
-      <head>
-        <link rel="stylesheet" href="/assets/pico.min.css">
-        <link rel="stylesheet" href="/assets/system.css">
-      </head>
-      <body>
-        <header>
-          <div class="container">
-            <a id="favicon" href="/system"><img src="/assets/favicon.svg"/></a>
-            <nav id="navbar">
-              <ul>
-                <li><a href="/system">{"Dashboard"}</a>
-                <li><a href="/system/events">{"Events"}</a>
-                <li><a href="/system/routes">{"Routes"}</a>
-              </ul>
-            </nav>
-          </div>
-        </header>
-
-        <main class="container">
-          <{ :slot }>
-        </main>
-
-        <footer>
-          <div class="container">
-            <ul>
-              <li><a href="https://raindeer.dev">{"Website"}</a></li>
-              <li><a href="https://raindeer.dev/docs">{"Docs"}</a></li>
-              <li><a href="https://github.com/raindeer-rb/raindeer">{"Source code"}</a></li>
-            </ul>
-          </div>
-        </footer>
-      </body>
-    </html>
-  end
-end