lowload 0.5.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4308f9be211e662f356659bccaa5e8c6a072e36b7a7cf2cac34d8b8f88bf0a61
-  data.tar.gz: 065a035f71f16424c0dd2d98c2c95f60cdec86cab2863ecab8cceb3f6f9e8248
+  metadata.gz: e0a6b7db4c15bb23eea273eb0a2d63bfed6d182b03a9964eb4c8adabc947fe93
+  data.tar.gz: 4ae8e96140a5f5560204aa7aac365167dd500068e7cef9415ef4b919b8271239
 SHA512:
-  metadata.gz: 5c8adc7cee6f2486e83c5adfae2d7aedcf33a6d6ceb26cbe052b2326c2d659de8cc58ccf54f4e572143ce11ed5d079585e7fb9f8c8886f8399fd248f245bd31a
-  data.tar.gz: 579e6eddfd6e92b6d426f10214cab3571670126d0b64c9cc2f112b9af09f72cca5c383ef10821bbc1fe917c279ebbb06b99ee8ec3e683e6ad01d09906f3a9664
+  metadata.gz: 1aee43560dc727fd1093d933805dee8f6fb8f9d466a60c594cd4c6635f007f77830c143d05827efe412b48430705636d556ee8ab554d8973e73e19f04a944df4
+  data.tar.gz: 88c59f0e36586302d1457b00926afe013fbdef453815a38b56ef1cf0b15c74edd38d081e6d263403d5f062d0a9b47b44af635da504bebf63709f040f6f0d9570

data/lib/adapters/adapter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LowLoad
+  class Adapter
+    EXTENSIONS = []
+
+    def metadata(file_path:) = nil
+
+    def preload(file_path:) = nil
+
+    def evaluate(file_path:, top_level_binding: nil) = nil
+
+    def url_path(file_path:) = nil
+  end
+end

data/lib/adapters/markdown_adapter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'lowkey'
+require_relative 'adapter'
+
+module LowLoad
+  class MarkdownAdapter < Adapter
+    EXTENSIONS = ['md', 'rd', 'markdown', 'raindown']
+
+    def metadata(file_path:)
+      line_numbers = []
+      yaml_lines = []
+
+      File.foreach(file_path).with_index do |line, index|
+        if line.strip == '---'
+          line_numbers << index + 1
+          break if line_numbers.count > 1
+        elsif line_numbers.count > 0
+          yaml_lines << line
+        end
+      end
+
+      # TODO: Test that this returns an empty hash when no yaml lines found.
+      YAML.safe_load(yaml_lines.join, symbolize_names: true)
+    end
+
+    def url_path(file_path:)
+      # Remove "_number-" and segments beginning with "_".
+      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('/')
+      
+      EXTENSIONS.each do |extension|
+        url_path.delete_suffix!(".#{extension}")
+      end
+
+      url_path
+    end
+  end
+end

data/lib/adapters/rbx_adapter.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'lowkey'
+require_relative 'adapter'
+require_relative '../loader'
+
+def top_level_binding
+  binding
+end
+
+module LowLoad
+  class RBXAdapter < Adapter
+    EXTENSIONS = ['rbx']
+
+    # Map all definitions and dependencies.
+    def metadata(file_path:)
+      Lowkey.load(file_path)
+
+      { file_path: }
+    end
+
+    # Then autoload all dependencies for those files.
+    def preload(file_path:)
+      Loader.add_autoloads(file_proxy: Lowkey[file_path])
+    end
+
+    # Now we can load the file into Ruby.
+    def evaluate(file_path:)
+      # 1. "File Load" phase.
+      file_proxy = Lowkey[file_path] || Lowkey.load(file_path)
+      templates = wrap_render_methods(file_proxy:)
+
+      # 2. "Class Load" phase.
+      # Not a security risk because "eval" is equivalent to "load" or "require_relative" in this context.
+      eval(file_proxy.export, top_level_binding, file_proxy.file_path, 0) # rubocop:disable Security/Eval
+
+      # 3. "Runtime" phase (before low nodes are rendered).
+      # Templates only exist if antlers gem has been required by another gem (such as LowNode) and the template contains antlers syntax.
+      templates.each do |namespace, method_template|
+        klass = Object.const_get(namespace)
+        method, template = method_template
+        # TODO: If params contain "**props" or similar then send that, so that LowNode can replicate it.
+        params = method.params.map(&:name)
+
+        next unless supports_templates?(klass) || raise(UnsupportedTemplate, "Template for '#{namespace}' identified but not implemented")
+
+        # TODO: Make template engine configurable.
+        klass.build_template(template:, params:, engine: Antlers, namespace:)
+      end
+    end
+
+    private
+
+    def supports_templates?(klass)
+      klass.respond_to?(:render) && klass.respond_to?(:template) && klass.respond_to?(:build_template)
+    end
+
+    def wrap_render_methods(file_proxy:)
+      # GOAL: Templates could be organised by method and template rendering engine.
+      templates = {}
+
+      file_proxy.definitions.each_value do |class_proxy|
+        render_method = class_proxy.respond_to?(:instance_methods) ? class_proxy.instance_methods[:render] : nil
+
+        next unless render_method
+
+        render_method_body = render_method.body.export
+
+        if defined?(Antlers) && ['{', '<{'].any? { |needle| render_method_body.include?(needle) }
+          templates[class_proxy.namespace] = [render_method, render_method_body]
+        end
+
+        # Intended to target HTML or Antlers tags. Use HEREDOC "<<~" in a plain Ruby (".rb") file, not RBX.
+        render_method.body.wrap(prefix: '%q{', suffix: '}') if render_method_body.strip.start_with?('<')
+      end
+
+      templates
+    end
+  end
+end

data/lib/adapters/ruby_adapter.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'lowkey'
+require_relative 'adapter'
+require_relative '../loader'
+
+module LowLoad
+  class RubyAdapter < Adapter
+    EXTENSIONS = ['rb']
+
+    # Map all definitions and dependencies.
+    def metadata(file_path:)
+      Lowkey.load(file_path)
+
+      { file_path: }
+    end
+
+    # Then autoload all dependencies for those files.
+    def preload(file_path:)
+      Loader.add_autoloads(file_proxy: Lowkey[file_path])
+    end
+
+    # Now we can load the file into Ruby.
+    def evaluate(file_path:)
+      load(file_path)
+    end
+  end
+end

data/lib/lowload.rb

@@ -1,99 +1,51 @@
 # frozen_string_literal: true
 
-require 'antlers'
-require 'lowkey'
-
+require_relative 'adapters/markdown_adapter'
+require_relative 'adapters/rbx_adapter'
+require_relative 'adapters/ruby_adapter'
 require_relative 'loader'
-
-def top_level_binding
-  binding
-end
+require_relative 'metadata'
 
 module LowLoad
+  class UnsupportedFileType < StandardError; end
   class UnsupportedTemplate < StandardError; end
 
   class << self
-    # Files are mapped, autoloaded, then loaded into Ruby in 3 separate stages.
+    ADAPTERS = [MarkdownAdapter.new, RBXAdapter.new, RubyAdapter.new]
+
     def dirload(path, pwd = Dir.pwd)
       absolute_path = File.expand_path(path, pwd)
       file_paths = Dir["#{absolute_path}/**/*"].filter { !File.directory?(it) }
 
-      # Map all definitions and dependencies first.
-      file_paths.each do |file_path|
-        Lowkey.load(file_path)
+      file_path_adapters = file_paths.each_with_object({}) do |file_path, hash|
+        hash[file_path] = find_adapter(file_path:)
       end
 
-      # Then autoload all dependencies for those files.
-      file_paths.each do |file_path| # rubocop:disable Style/CombinableLoops
-        Loader.add_autoloads(file_proxy: Lowkey[file_path])
-      end
+      metadata = Metadata.new
+      metadata.process(file_path_adapters:)
+      step(:preload, file_path_adapters:)
+      step(:evaluate, file_path_adapters:)
 
-      # Now we can load the files into Ruby.
-      file_paths.each do |file_path| # rubocop:disable Style/CombinableLoops
-        lowload(file_path)
-      end
+      metadata
     end
 
-    # Dependencies must first be loaded by dirload() or required by the file.
     def lowload(file_path)
-      case File.extname(file_path).delete_prefix('.')
-      when 'rb'
-        load(file_path)
-      when 'rbx'
-        load_rbx(file_path)
-      end
-    end
-
-    private
-
-    def load_rbx(file_path)
-      # 1. "File Load" phase.
-      file_proxy = Lowkey[file_path] || Lowkey.load(file_path)
-      templates = wrap_render_methods(file_proxy:)
-
-      # 2. "Class Load" phase.
-      # Not a security risk because "eval" is equivalent to "load" or "require_relative" in this context.
-      eval(file_proxy.export, top_level_binding, file_proxy.file_path, 0) # rubocop:disable Security/Eval
+      adapter = find_adapter(file_path:)
 
-      # 3. "Runtime" phase (before LowNode instances are rendered).
-      # Templates only exist if antlers gem has been required by another gem (such as LowNode) and the template contains antlers syntax.
-      templates.each do |namespace, method_template|
-        klass = const_get(namespace)
-        method, template = method_template
-        # TODO: If params contain "**props" or similar then send that, so that LowNode can replicate it.
-        params = method.params.map(&:name)
+      raise(UnsupportedFileType, "Could not load #{file_path}") if adapter.nil?
 
-        next unless supports_templates?(klass) || raise(UnsupportedTemplate, "Template for '#{namespace}' identified but not implemented")
-
-        # TODO: Make template engine configurable.
-        klass.build_template(template:, params:, engine: Antlers, namespace:)
-      end
+      adapter.evaluate(file_path:)
     end
 
-    def supports_templates?(klass)
-      klass.respond_to?(:render) && klass.respond_to?(:template) && klass.respond_to?(:build_template)
-    end
-
-    def wrap_render_methods(file_proxy:)
-      # GOAL: Templates could be organised by method and template rendering engine.
-      templates = {}
-
-      file_proxy.definitions.each_value do |class_proxy|
-        render_method = class_proxy.respond_to?(:instance_methods) ? class_proxy.instance_methods[:render] : nil
-
-        next unless render_method
-
-        render_method_body = render_method.body.export
-
-        if defined?(Antlers) && ['{', '<{'].any? { |needle| render_method_body.include?(needle) }
-          templates[class_proxy.namespace] = [render_method, render_method_body]
-        end
-
-        # Intended to target HTML or Antlers tags. Use HEREDOC "<<~" in a plain Ruby (".rb") file, not RBX.
-        render_method.body.wrap(prefix: '%q{', suffix: '}') if render_method_body.strip.start_with?('<')
+    def step(step, file_path_adapters:)
+      file_path_adapters.each do |file_path, adapter|
+        adapter&.send(step, file_path:)
       end
+    end
 
-      templates
+    def find_adapter(file_path:)
+      extension = File.extname(file_path).delete_prefix('.')
+      ADAPTERS.find { |adapter| adapter.class::EXTENSIONS.include?(extension) }
     end
   end
 end

data/lib/metadata.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative 'adapters/markdown_adapter'
+
+module LowLoad
+  class Metadata
+    EXTENSIONS = [
+      *::LowLoad::MarkdownAdapter::EXTENSIONS,
+      *::LowLoad::RBXAdapter::EXTENSIONS,
+      *::LowLoad::RubyAdapter::EXTENSIONS,
+    ]
+
+    attr_accessor :loaded_paths, :missed_paths, :file_types, :url_paths, :tags
+
+    def initialize
+      @loaded_paths = []
+      @missed_paths = []
+
+      @file_types = EXTENSIONS.each_with_object({}) { |extension, hash| hash[extension] = [] }
+      @url_paths = {}
+      @tags = {}
+    end
+
+    def process(file_path_adapters:)
+      file_path_adapters.each do |file_path, adapter|
+        if (metadata = adapter&.metadata(file_path:))
+          append(file_path:, adapter:, metadata:)
+        else
+          @missed_paths << file_path
+        end
+      end
+    end
+
+    def append(file_path:, adapter:, metadata:)
+      @loaded_paths << file_path
+      @file_types[File.extname(file_path).delete_prefix('.')] << file_path
+      @url_paths[adapter.url_path(file_path:)] = file_path
+
+      metadata[:tags]&.each do |tag|
+        @tags[tag] ||= []
+        @tags[tag] = file_path
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LowLoad
-  VERSION = '0.5.1'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lowload
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.1
 platform: ruby
 authors:
 - maedi
@@ -31,8 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/adapters/adapter.rb
+- lib/adapters/markdown_adapter.rb
+- lib/adapters/rbx_adapter.rb
+- lib/adapters/ruby_adapter.rb
 - lib/loader.rb
 - lib/lowload.rb
+- lib/metadata.rb
 - lib/version.rb
 homepage: https://github.com/low-rb/lowload
 licenses: []
@@ -53,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.6
 specification_version: 4
 summary: An autoloader without namespace and folder structure conventions
 test_files: []