raindeer 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42828c094ed42e854e71771f9ead3dfe12ff79322bf8348fe35eb3c96caec94
-  data.tar.gz: 2aa21a01220ecad0e959e8edd05e535482bfe4afb3204703ae82460979d0cd89
+  metadata.gz: 41aa9563466af4e0a352cb288bf3af4dc340de96baa2417928f0807d745e7f4e
+  data.tar.gz: cf4ba9e858b140c6e3893814df02e04acc85a24320cf9e71580d2df5188aa615
 SHA512:
-  metadata.gz: 8625736bca1b2f5ef9ff7f139a4b8172989fcd302816a5f3216f8b8c4c44c08f90b33b118c85ce4f6b242711be07a5b75c46bc7b475b3bbc9cb75641b122ea0e
-  data.tar.gz: b2b025031b825409cbfe418fdf336e5b8747cab209e45d2c935ac0ad5a2028194a3063c9cb48138e0889d3506a174d22d15d76044b8a875ed9711e0ccf700818
+  metadata.gz: 90762ce5864de9c7bdd5a69f6d30f5246388745d6bf2c44c85e01b661b48431210d6bc475cfe7b2d83f21de2305053292de4fbbfafc0b8922be5294761b36e5c
+  data.tar.gz: c63d7c49fedcbf168731510c4e5d07fdeeac7dfd27c81fdd099516f44a4940a8d700513b9cbfcab56eeea0aa46849774eae036aa1f5585cf4940cdae7a3b6395

data/bin/rain

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # 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.

data/lib/cli/cli.rb

@@ -1,19 +1,24 @@
 # frozen_string_literal: true
 
 require 'trees'
-require_relative 'static/static'
+require_relative 'static'
 
 module Rain
   module CLI
     extend Trees
 
+    TEMPLATE_URL = 'https://github.com/raindeer-rb/raindeer-template'
+
     line('new :app_name') do |app_name|
-      summary { "Generates a Raindeer application with the specified name." }
-      execute { 'TODO' }
+      summary { 'Generates a Raindeer application with the specified name.' }
+      execute do
+        system("git clone #{TEMPLATE_URL} #{app_name}")
+        system("cd #{app_name}")
+      end
     end
 
     line('server') do
-      summary { "Starts a Raindeer application. Once run visit http://127.0.0.1:4133" }
+      summary { 'Starts a Raindeer application. Once run visit http://127.0.0.1:4133' }
       execute { system('bin/server') }
     end
 

data/lib/cli/static.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'ruby-progressbar'
+require 'fileutils'
+
+require 'antlers' # Adds antlers support to lowload.
+require 'lowload'
+
+require_relative '../pages/pages'
+
+module Rain
+  module CLI
+    module Static
+      extend self
+
+      FakeRequest = Data.define(:path)
+      RequestResult = Data.define(:path, :status, :html)
+
+      def build(application_path:)
+        metadata = load_user_application(app_path: File.expand_path('app', application_path))
+        build_path = File.expand_path('build', application_path)
+
+        FileUtils.rm_rf(build_path)
+        FileUtils.mkdir_p(build_path)
+        FileUtils.cp_r(File.expand_path('public', application_path), File.expand_path('public', build_path))
+
+        Low::Events::RequestEvent.define do |observers|
+          observers << Providers['rain.router']
+        end
+
+        request_results(metadata:).each do |request_result|
+          folder_path = File.join(build_path, request_result.path)
+
+          puts "#{folder_path} => #{request_result.status}"
+
+          FileUtils.mkdir_p(folder_path)
+          File.write(File.expand_path('index.html', folder_path), request_result.html)
+        end
+      end
+
+      private
+
+      def load_user_application(app_path:)
+        metadata = LowLoad.dirload(app_path)
+
+        if Dir.exist?(File.expand_path('pages', app_path))
+          Providers.define('rain.pages', eager: true) do
+            require_relative '../pages/pages'
+            Rain::Pages.new(metadata:)
+          end
+        end
+
+        metadata
+      end
+
+      def request_results(metadata:)
+        file_paths = metadata.file_types.values_at('md', 'rd', 'markdown', 'raindown').flat_map { it }.compact
+        paths = file_paths.map { |file_path| Rain::Pages.url_path(file_path:) }.compact
+        paths << '/'
+        # Skip files that became solely metadata due to underscores hiding the entire file path.
+        paths.reject! { |url_path| url_path == '' }
+
+        progress_bar = ProgressBar.create(
+          total: paths.size,
+          format: "\e[0;34m%a |%B| %p%%\e[0m"
+        )
+
+        paths.map do |path|
+          request = FakeRequest.new(path:)
+          response = Low::Events::RequestEvent.take(request:).response
+          result = RequestResult.new(path:, status: response.status, html: response.read)
+          progress_bar.increment
+          result
+        end
+      end
+    end
+  end
+end

data/lib/matrix/effects/color_effect.rb

@@ -8,6 +8,7 @@ module Rain
       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

data/lib/matrix/effects/leet_effect.rb

@@ -11,14 +11,14 @@ module Rain
       @leet_letters = @leet_numbers.invert
     end
 
-    def render(output:, next_output:, x:, y:)
-      output = filter(output:, next_output:, x:, y:)
+    def render(output:, x:, y:, **)
+      output = filter(output:, x:, y:, **)
       save(output:, x:, y:)
     end
 
     private
 
-    def filter(output:, next_output:, x:, y:)
+    def filter(output:, x:, y:, **)
       return unless output
 
       character = output.downcase
@@ -26,7 +26,7 @@ module Rain
 
       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

data/lib/matrix/stream.rb

@@ -75,8 +75,8 @@ module Rain
     # └─────┴─────┴─────┘
     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
+        index.zero? ? @inputs.count - 1 : index - 1
+        index + 1 >= @inputs.count ? 0 : index + 1
 
         if @inputs[index]
           @outputs[index] = @inputs[index]

data/lib/pages/pages.rb

@@ -11,7 +11,7 @@ module Rain
     Page = Struct.new(:metadata, :html)
 
     def initialize(metadata:)
-      @file_paths = [*metadata.file_types['md'], *metadata.file_types['markdown']]
+      @file_paths = metadata.file_types.values_at('md', 'rd', 'markdown', 'raindown').flat_map { it }.compact
       @url_paths = {}
       @tags = {}
 
@@ -20,8 +20,7 @@ module Rain
 
     def page(path:)
       path = '/home' if path == '/'
-      url_path = File.expand_path("app/pages#{path}", Dir.pwd)
-      file_path = @url_paths[url_path] || return
+      file_path = @url_paths[path] || return
 
       metadata, markdown = parse_file(file_path:)
       raindown = Raindown.render(markdown:)
@@ -29,55 +28,38 @@ module Rain
       Page.new(metadata, raindown)
     end
 
-    def list(file_paths:)
+    def list(**typed_tags)
+      file_paths = tagged(**typed_tags)
       sorted_paths = file_paths.sort_by { order(it) }
-
-      sorted_paths.map do |file_path|
-        metadata, markdown = parse_file(file_path:)
-        metadata[:content] = markdown.empty? ? '' : Raindown.render(markdown:)
-        OpenStruct.new(metadata)
-      end
+      sorted_paths.map { |file_path| present_file(file_path:) }
     end
 
     def tagged(**typed_tags)
-      results = []
+      file_paths = []
 
       typed_tags.each do |type, tag|
-        results = [*results, *@tags.dig(type, tag)]
+        file_paths = [*file_paths, *@tags.dig(type, tag)]
       end
 
-      results
+      file_paths
     end
 
     private
 
     def process_files
       @file_paths.each do |file_path|
-        url_path = url_path(file_path:)
-        @url_paths[url_path] = 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
     end
 
-    # Remove segments beginning with "_" and ending with "/" or "-".
-    # Example: app/pages/docs/_basics/_1-getting-started.md => app/pages/docs/getting-started.md
-    def url_path(file_path:)
-      url_path = file_path.split('/').map do |segment|
-        next segment.sub(/^_\d\W/, '') if segment.sub(/^_\d\W/, '') != segment
-        next nil if segment.sub(/^_/, '') != segment
-
-        segment
-      end.compact.join('/')
-
-      url_path.delete_suffix(File.extname(url_path))
-    end
-
     def tag(type:, tag:, file_path:)
       @tags[type] ||= {}
       @tags[type][tag] ||= []
@@ -86,15 +68,15 @@ module Rain
 
     def folders(file_path:)
       File.dirname(file_path)
-        .split(Regexp.union(['/', '-']))
-        .filter { it.start_with?('_') }
-        .map { it.delete_prefix('_') }
-        .filter { !number?(it) }
+          .split(Regexp.union(['/', '&', '-']))
+          .filter { it.start_with?('_') }
+          .map { it.delete_prefix('_') }
+          .filter { !number?(it) }
     end
 
     def order(file_path)
       file_path
-        .split(Regexp.union(['/', '-']))
+        .split(Regexp.union(['/', '&', '-']))
         .filter { it.start_with?('_') }
         .map { it.delete_prefix('_') }
         .filter { number?(it) }
@@ -105,12 +87,20 @@ module Rain
       !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).with_index do |line, index|
+      File.foreach(file_path) do |line|
         if line.strip == '---' && dash_lines.count < 2
           dash_lines << line
           next
@@ -126,5 +116,24 @@ module Rain
 
       [YAML.safe_load(data_lines.join, symbolize_names: true), text_lines.join.strip]
     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
+      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
+
+          segment
+        end.compact.join('/')
+
+        url_path.delete_prefix(pages_path).delete_suffix(File.extname(url_path))
+      end
+
+      def pages_path
+        File.expand_path('app/pages', Dir.pwd)
+      end
+    end
   end
 end

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

@@ -5,7 +5,8 @@ require 'interfaces/lexeme' # From antlers gem, too generic.
 module Rain
   module TOCLexeme
     include Antlers::Lexeme
-    extend self
+
+    module_function
 
     KEYWORDS = [':toc'].freeze
 

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

@@ -14,17 +14,17 @@ module Rain
     def render(current_binding: nil, parent_binding: nil, slot_node: nil)
       doc = Nokogiri::HTML(@template)
 
-      output = <<~HTML
+      <<~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|
+              #{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>"
-              }.join("\n")}
+              end.join("\n")}
             </ul>
-          </div>
-        </details>
+          </details>
+        </div>
       HTML
     end
 

data/lib/pages/raindown/raindown.rb

@@ -6,14 +6,14 @@ require_relative 'elements'
 
 module Rain
   module Raindown
-    extend self
+    module_function
 
     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
+        if %i[code code_block].include?(node.type)
           node.string_content = node.string_content.gsub('<!-- ANTLERS', '<{').gsub('ANTLERS -->', '}>')
         end
       end

data/lib/raindeer/cli.rb

@@ -5,7 +5,12 @@ require 'low_type'
 require 'observers'
 require 'providers'
 
-# Allows the CLI to load application code and metadata, but not start a server.
+# The CLI loads user application code and metadata, but doesn't start a server.
+#
+# Flow:
+#   1. bin/rain - Located in raindeer or user application, loads "raindeer/cli" which is available on $PATH.
+#   2. lib/raindeer/cli - Boots up a raindeer/user application that is suitable for use by the CLI. <-- YOU ARE HERE
+#   3. lib/cli/cli - Defines and runs the CLI that responds to the ARGs given to bin/rain.
 
 #################################################
 # FRAMEWORK INTERNAL API
@@ -24,13 +29,7 @@ end
 # FRAMEWORK EXTERNAL API
 #################################################
 
-module Raindeer
-  class << self
-    def router(&block)
-      Providers['rain.router'].instance_eval(&block)
-    end
-  end
-end
+require_relative 'raindeer'
 
 #################################################
 # CLI

data/lib/raindeer/raindeer.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'boot'
-
 module Raindeer
   class << self
     def router(&block)

data/lib/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - maedi
@@ -10,7 +10,7 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ostruct
+  name: commonmarker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: paint
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +38,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: commonmarker
+  name: ostruct
+  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: paint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +80,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -246,7 +260,7 @@ extra_rdoc_files: []
 files:
 - bin/rain
 - lib/cli/cli.rb
-- lib/cli/static/static.rb
+- lib/cli/static.rb
 - lib/matrix/cursor.rb
 - lib/matrix/effects/color_effect.rb
 - lib/matrix/effects/effect.rb

data/lib/cli/static/static.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require 'antlers'
-require 'lowload'
-
-require 'async'
-require 'async/http/internet'
-require 'fileutils'
-
-module Rain
-  module CLI
-    module Static
-      extend self
-
-      Result = Data.define(:path, :html)
-
-      def build(application_path:)
-        metadata = LowLoad.dirload(File.expand_path('app', application_path))
-
-        build_path = File.expand_path('build', application_path)
-        FileUtils.rm_rf(build_path)
-        FileUtils.mkdir_p(build_path)
-        FileUtils.cp_r(File.expand_path('public', application_path), File.expand_path('public', build_path))
-
-        request_paths(metadata:, application_path:).each do |result|
-          path = File.expand_path(result.path, build_path)
-          FileUtils.mkdir_p(path)
-          File.write(File.expand_path('index.html', path), result.html)
-        end
-      end
-
-      private
-
-      def request_paths(metadata:, application_path:)
-        tasks = metadata.url_paths.keys.compact.map do |file_path|
-          Async do
-            request_path = request_path(application_path:, file_path:)
-            request_url = endpoint + request_path
-
-            response = client.get(request_url)
-            response_html = response.read
-            response.close
-
-            Result.new(path: request_path, html: response_html)
-          end
-        end
-
-        tasks.map(&:result)
-      end
-
-      def request_path(application_path:, file_path:)
-        file_path.delete_prefix("#{application_path}/app/pages/")
-      end
-
-      def client
-        Async::HTTP::Internet.new
-      end
-
-      def endpoint
-        "http://#{config.host}:#{config.port}/"
-      end
-
-      def config
-        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_path = File.expand_path('config/config.yaml', Dir.pwd)
-        ConfigLoader.load(config_path, env)
-      end
-    end
-  end
-end