sitepress-core 4.1.1 → 5.0.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e15a99e5f701876c5de27b3d6af643814010867088c9bfc58807a099e11a44a8
-  data.tar.gz: c1ad99de08178a0cd884a6e499712e16fee09501436e674d83e74c34ef533f03
+  metadata.gz: ef3344c3cfd0d28305f9f3684d9193008812425f5a0651889e180f7bd1e71738
+  data.tar.gz: a61c4ee48c2dc69971d0fef76763bea2bafb215a37c9a1f32e720417149f9316
 SHA512:
-  metadata.gz: bd9755ddebfc9f65894a680f73fb4494abb27bc7a7f73b94c66733f2119a15ab7a69b70c22b19b6654af72235a71cc888b1f40b274d4ed8ccb5e53180a221f0b
-  data.tar.gz: e70dd46ef793fa6734c6fe8859a1f95cd4e12392c416a55994a56f4bed6b07a59b1d2b916fb359c77b3c5e2563278ccfce8b4991fc1c04bb8c6a12fecfb39150
+  metadata.gz: 8fece92fa30224dc287d4689441f6db3f9a196ea6d517399b509dcd3cb8bad9232778fd281a3105cb6219966699499e40b3ec4a8fa254125041576bcaee64205
+  data.tar.gz: 0c7f1972a0982c708281c29c21ad066ed5f8b7cbef2beced7219439472ac698a439dee672ab41e3c22f77f4f89992dbd81985932fb1594550b90c225d3270a9b

data/lib/sitepress/data.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Sitepress
   module Data
     def self.manage(value)
@@ -70,22 +72,23 @@ module Sitepress
       end
 
       def method_missing(name, *args, **kwargs, &block)
-        if respond_to? name
-          self.send name, *args, **kwargs, &block
-        else
-          key, modifier, _ = name.to_s.partition(/[!?]/)
-
-          case modifier
-          when ""
-            self[key]
-          when "!"
-            self.fetch(key, *args, &block)
-          when "?"
-            !!self[key]
-          end
+        key, modifier, _ = name.to_s.partition(/[!?]/)
+
+        case modifier
+        when ""
+          self[key]
+        when "!"
+          self.fetch(key, *args, &block)
+        when "?"
+          !!self[key]
         end
       end
 
+      def respond_to_missing?(name, include_private = false)
+        key, _, _ = name.to_s.partition(/[!?]/)
+        @hash.key?(key) || @hash.key?(key.to_sym) || super
+      end
+
       def dig(*args, **kwargs, &block)
         Data.manage @hash.dig(*args, **kwargs, &block)
       end

data/lib/sitepress/directory.rb

@@ -0,0 +1,54 @@
+require "mime/types"
+
+module Sitepress
+  # Maps a directory of files into a tree of nodes that form the navigational
+  # structure of a website. You can subclass this to handle different file
+  # types or directory structures.
+  class Directory
+    attr_reader :asset_paths
+
+    def initialize(path)
+      @asset_paths = AssetPaths.new(path: path)
+    end
+
+    # Mounts the source files from the path into the given node.
+    def mount(node)
+      asset_paths.each do |path|
+        if path.directory?
+          process_directory path, node
+        else
+          process_asset path, node
+        end
+      end
+    end
+
+    protected
+
+    def process_directory(path, node)
+      node_name = File.basename path
+      self.class.new(path).mount(node.child(node_name))
+    end
+
+    def process_asset(path, node)
+      asset = source_for(path)
+      node.child(asset.node_name).resources.add_asset(asset, format: asset.format)
+    end
+
+    def source_for(path)
+      mime = MIME::Types.type_for(path.to_s).first&.content_type
+
+      case mime
+      when *Image.mime_types
+        Image.new(path: path)
+      when *Page.mime_types, nil
+        # nil handles template files like .erb that have no MIME type
+        Page.new(path: path)
+      else
+        Static.new(path: path)
+      end
+    end
+  end
+
+  # Backwards compatibility
+  AssetNodeMapper = Directory
+end

data/lib/sitepress/image.rb

@@ -0,0 +1,84 @@
+require "mime/types"
+require "fastimage"
+
+module Sitepress
+  # A source for image files. Extracts dimensions via fastimage.
+  #
+  # Example:
+  #   image = Image.new(path: "photos/sunset.jpg")
+  #   image.width   # => 1920
+  #   image.height  # => 1080
+  #   image.data["width"]  # => 1920
+  #
+  class Image
+    MIME_TYPES = %w[image/png image/jpeg image/gif image/webp].freeze
+
+    def self.mime_types
+      MIME_TYPES
+    end
+
+    attr_reader :path
+
+    def initialize(path:)
+      @path = Pathname.new(path)
+    end
+
+    def filename
+      path.basename.to_s
+    end
+
+    def node_name
+      path.basename(".*").to_s.split(".").first
+    end
+
+    def format
+      path.extname.delete(".").to_sym
+    end
+
+    def mime_type
+      MIME::Types.type_for(path.to_s).first
+    end
+
+    def size
+      exists? ? File.size(path) : nil
+    end
+
+    def width
+      dimensions[0]
+    end
+
+    def height
+      dimensions[1]
+    end
+
+    def data
+      @data ||= Data.manage({
+        "width" => width,
+        "height" => height
+      }.compact)
+    end
+
+    def body
+      File.binread(path)
+    end
+
+    def exists?
+      path.exist?
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} path=#{path.to_s.inspect}>"
+    end
+
+    private
+
+    def dimensions
+      @dimensions ||= begin
+        return [nil, nil] unless exists?
+        FastImage.size(path.to_s) || [nil, nil]
+      rescue
+        [nil, nil]
+      end
+    end
+  end
+end

data/lib/sitepress/node.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Sitepress
   # Resource nodes give resources their parent/sibling/child relationships. The relationship are determined
   # by the `request_path` given to an asset when its added to a node. Given the `request_path` `/foo/bar/biz/buz.html`,
@@ -96,6 +98,10 @@ module Sitepress
       "<#{self.class}: name=#{name.inspect}, formats=#{formats.inspect}, children=#{children.map(&:name).inspect}, resource_request_paths=#{resources.map(&:request_path)}>"
     end
 
+    def <<(mountable)
+      mountable.mount(self)
+    end
+
     def dig(*args)
       head, *tail = args
       if (head.nil? or head.empty? or head == default_name) and tail.empty?

data/lib/sitepress/{asset.rb → page.rb}

@@ -3,16 +3,35 @@ require "forwardable"
 require "fileutils"
 
 module Sitepress
-  # Represents a file on a web server that may be parsed to extract
+  # Represents a page on a website - a file that may be parsed to extract
   # metadata or be renderable via a template. Multiple resources
-  # may point to the same asset. Properties of an asset should be mutable.
+  # may point to the same page. Properties of a page should be mutable.
   # The Resource object is immutable and may be modified by the Resources proxy.
-  class Asset
+  class Page
     # If we can't resolve a mime type for the resource, we'll fall
     # back to this binary octet-stream type so the client can download
     # the resource and figure out what to do with it.
     DEFAULT_MIME_TYPE = MIME::Types["application/octet-stream"].first
 
+    # MIME types that Page can handle - text-based content that may have frontmatter
+    MIME_TYPES = %w[
+      text/html
+      text/plain
+      text/markdown
+      text/x-web-markdown
+      text/css
+      text/javascript
+      application/json
+      application/xml
+      text/xml
+      image/svg+xml
+      text/x-haml
+    ].freeze
+
+    def self.mime_types
+      MIME_TYPES
+    end
+
     # Parsers can be swapped out to deal with different types of resources, like Notion
     # documents, JSON, exif data on images, etc.
     DEFAULT_PARSER = Parsers::Frontmatter
@@ -44,9 +63,19 @@ module Sitepress
       @body ||= exists? ? parse_error { parser.body } : nil
     end
 
+    # Returns the line number where the body starts in the original file.
+    # Used to adjust error line numbers when frontmatter is present.
+    def body_line_offset
+      exists? ? parser.body_line_offset : 1
+    end
+
     # Treat resources with the same request path as equal.
-    def ==(asset)
-      path == asset.path
+    def ==(other)
+      path == other.path
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} path=#{path.to_s.inspect}>"
     end
 
     def mime_type
@@ -60,9 +89,11 @@ module Sitepress
       !!handler
     end
 
-    # Mmm.... that's the smell of cache busting, which means the hiearchy of this is wrong.
+    # When changing the parser, clear all cached parsed data.
     def parser=(parser_klass)
       @parser = nil
+      @data = nil
+      @body = nil
       @parser_klass = parser_klass
     end
 
@@ -86,11 +117,17 @@ module Sitepress
       @parser_klass::Renderer.new(data: data, body: body)
     end
 
+    # Renders the page in a view context. This is part of the Renderable protocol
+    # that allows any object to be used as a resource source.
+    def render_in(view_context)
+      view_context.render inline: body, type: handler
+    end
+
     private
       def parse_error(&parse)
         parse.call
       rescue StandardError => e
-        raise ParseError.new("Error parsing asset at #{path.to_s}: #{e}")
+        raise ParseError, "Error parsing #{path.expand_path}: #{e.class} - #{e.message}"
       end
 
       def parser
@@ -104,4 +141,7 @@ module Sitepress
         MIME::Types.type_for(format_extension).first if format_extension
       end
   end
+
+  # Backwards compatibility
+  Asset = Page
 end

data/lib/sitepress/parsers/base.rb

@@ -10,6 +10,12 @@ module Sitepress
         @body = source
         @data = {}
       end
+
+      # Returns the line number where the body starts in the original file.
+      # Subclasses should override this if they strip content from the beginning.
+      def body_line_offset
+        1
+      end
     end
   end
 end

data/lib/sitepress/parsers/frontmatter.rb

@@ -14,12 +14,7 @@ module Sitepress
         end
 
         def dump_yaml(data)
-          if YAML.respond_to? :safe_dump
-            YAML.safe_dump data, permitted_classes: Frontmatter.permitted_classes
-          else
-            # Live dangerously, lol
-            YAML.dump data
-          end
+          YAML.safe_dump data, permitted_classes: Frontmatter.permitted_classes
         end
 
         def render
@@ -46,7 +41,13 @@ module Sitepress
       PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m
 
       def initialize(content)
-        _, @data, @body = content.match(PATTERN).captures
+        @frontmatter_block, @data, @body = content.match(PATTERN).captures
+      end
+
+      # Returns the line number where the body starts in the original file.
+      def body_line_offset
+        return 1 unless @frontmatter_block
+        @frontmatter_block.count("\n") + 1
       end
 
       def data
@@ -54,12 +55,7 @@ module Sitepress
       end
 
       def load_yaml(data)
-        if YAML.respond_to? :safe_load
-          YAML.safe_load data, permitted_classes: self.class.permitted_classes
-        else
-          # Live dangerously, lol
-          YAML.load data
-        end
+        YAML.safe_load data, permitted_classes: self.class.permitted_classes
       end
 
       class << self

data/lib/sitepress/parsers/notion.rb

@@ -1,4 +1,5 @@
 require "yaml"
+require "strscan"
 
 module Sitepress
   module Parsers
@@ -19,10 +20,17 @@ module Sitepress
           @raw_data.append scanner.captures
         end
         scanner.scan(/\n/)
+        # Track where body starts for line number offset
+        @header_content = content[0, scanner.pos]
         # Parse body
         @body = scanner.rest
       end
 
+      # Returns the line number where the body starts in the original file.
+      def body_line_offset
+        @header_content.count("\n") + 1
+      end
+
       def data
         Hash[@raw_data.prepend([TITLE_KEY, @title])]
       end

data/lib/sitepress/path.rb

@@ -23,14 +23,6 @@ module Sitepress
         action_view_template_handlers_extensions || HANDLER_EXTENSIONS
       end
 
-      # I tried to hook this into Rails engines in the `config.after_initialize` block,
-      # but the way template handlers register their extensions is across the board.
-      #
-      # config.after_initialize do
-      #   Sitepress::Path.handler_extensions = ActionView::Template::Handlers.method(:extensions)
-      # ends
-      #
-      # I couldn't get that working, instead I do this check to find the handlers.
       def action_view_template_handlers_extensions
         ActionView::Template::Handlers.extensions if defined?(ActionView::Template::Handlers)
       end

data/lib/sitepress/resource.rb

@@ -4,23 +4,44 @@ module Sitepress
   # Represents the request path of an asset. There may be multiple
   # resources that point to the same asset. Resources are immutable
   # and may be altered by the resource proxy.
+  #
+  # The source can be any object that implements the Renderable protocol:
+  # - #data - returns a Hash of metadata
+  # - #render_in(view_context) - renders the content
   class Resource
     extend Forwardable
-    def_delegators :asset, :body, :data, :renderable?
+    def_delegators :source, :body
 
-    attr_reader :node, :asset
+    attr_reader :node, :source
+    alias :asset :source  # Backwards compatibility
+
+    # Check if the source implements the data protocol.
+    def has_data?
+      source.respond_to?(:data)
+    end
+
+    # Check if the source implements the render_in protocol.
+    def renderable?
+      source.respond_to?(:render_in)
+    end
+
+    # Returns metadata from the source, or an empty hash if not available.
+    def data
+      has_data? ? source.data : {}
+    end
 
     attr_accessor :format, :mime_type, :handler
 
     # Default scope for querying parent/child/sibling resources.
     DEFAULT_FILTER_SCOPE = :same
 
-    def initialize(asset:, node:, format: nil, mime_type: nil, handler: nil)
-      @asset = asset
+    def initialize(asset: nil, source: nil, node:, format: nil, mime_type: nil, handler: nil)
+      @source = source || asset
+      raise ArgumentError, "Either asset: or source: must be provided" unless @source
       @node = node
-      @format = format || asset.format
-      @mime_type = mime_type || asset.mime_type
-      @handler = handler || asset.handler
+      @format = format || @source.format
+      @mime_type = mime_type || @source.mime_type
+      @handler = handler || source_handler
     end
 
     def request_path
@@ -71,7 +92,7 @@ module Sitepress
     # Clones should be initialized with a nil node. Initializing with a node would mean that multiple resources
     # are pointing to the same node, which shouldn't be possible.
     def clone
-      self.class.new(asset: @asset, node: nil, format: @format, mime_type: @mime_type, handler: @handler)
+      self.class.new(source: @source, node: nil, format: @format, mime_type: @mime_type, handler: @handler)
     end
 
     # Removes the resource from the node's resources list.
@@ -80,7 +101,7 @@ module Sitepress
     end
 
     def inspect
-      "<#{self.class}:#{object_id} request_path=#{request_path.inspect} asset_path=#{asset.path.to_s.inspect}>"
+      "#<#{self.class}:0x#{object_id.to_s(16)} request_path=#{request_path.inspect} source=#{source.inspect}>"
     end
 
     def parent(**args)
@@ -109,7 +130,7 @@ module Sitepress
     end
 
     def render_in(view_context)
-      view_context.render inline: body, type: handler
+      renderable? ? source.render_in(view_context) : nil
     end
 
     private
@@ -135,6 +156,10 @@ module Sitepress
       end
     end
 
+    def source_handler
+      @source.handler if @source.respond_to?(:handler)
+    end
+
     # Deals with situations, particularly in the root node and other "index" nodes, for the `request_path`
     def request_filename
       if node.root? and node.default_format == format

data/lib/sitepress/resource_indexer.rb

@@ -1,3 +1,6 @@
+require "forwardable"
+require "set"
+
 module Sitepress
   # Flattens a tree of Sitepress::Node and Sitepress:Resource classes into a collection of
   # resources that can be quickly globbed, queried, or accessed.
@@ -17,8 +20,8 @@ module Sitepress
     end
 
     def glob(pattern)
-      paths = Dir.glob root_path.join(pattern)
-      resources.select { |r| paths.include? r.asset.path.to_s }
+      paths = Dir.glob(root_path.join(pattern)).to_set
+      resources.select { |r| paths.include?(r.asset.path.to_s) }
     end
 
     def get(request_path)

data/lib/sitepress/resources_pipeline.rb

@@ -1,5 +1,3 @@
-require "forwardable"
-
 module Sitepress
   # Processes a collection of resources
   class ResourcesPipeline < Array

data/lib/sitepress/site.rb

@@ -19,18 +19,18 @@ module Sitepress
       self.root_path = root_path
     end
 
-    # A tree representation of the resourecs wthin the site. The root is a node that's
+    # A tree representation of the resources within the site. The root is a node that's
     # processed by the `resources_pipeline`.
     def root
       @root ||= Node.new.tap do |root|
-        asset_node_mapper(root).map
+        root << asset_node_mapper
         resources_pipeline.process root
       end
     end
 
     # Maps a path of directories and files into the root node.
-    def asset_node_mapper(root_node)
-      AssetNodeMapper.new(path: pages_path, node: root_node)
+    def asset_node_mapper
+      Directory.new(pages_path)
     end
 
     # Returns a list of all the resources within #root.

data/lib/sitepress/static.rb

@@ -0,0 +1,47 @@
+require "mime/types"
+
+module Sitepress
+  # A source for static files that are served as-is without processing.
+  # Used as a fallback for files that don't match Image or Page MIME types.
+  #
+  # Example:
+  #   static = Static.new(path: "fonts/roboto.woff2")
+  #   static.mime_type  # => #<MIME::Type font/woff2>
+  #   static.body       # => binary content
+  #
+  class Static
+    attr_reader :path
+
+    def initialize(path:)
+      @path = Pathname.new(path)
+    end
+
+    def node_name
+      path.basename(".*").to_s.split(".").first
+    end
+
+    def format
+      path.extname.delete(".").to_sym
+    end
+
+    def mime_type
+      MIME::Types.type_for(path.to_s).first
+    end
+
+    def body
+      File.binread(path)
+    end
+
+    def data
+      @data ||= Data.manage({})
+    end
+
+    def exists?
+      path.exist?
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{object_id.to_s(16)} path=#{path.to_s.inspect}>"
+    end
+  end
+end

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "4.1.1".freeze
+  VERSION = "5.0.0.beta".freeze
 end

data/lib/sitepress-core.rb

@@ -4,17 +4,23 @@ module Sitepress
   # Errors raised by Sitepress
   Error = Class.new(StandardError)
 
+  # Raised when an asset fails to parse (e.g., invalid YAML frontmatter)
+  ParseError = Class.new(Error)
+
   # Raised by Resources if a path is added that's not a valid path.
   InvalidRequestPathError = Class.new(RuntimeError)
 
   # Raised by Resources if a path is already in its index
   ExistingRequestPathError = Class.new(InvalidRequestPathError)
 
-  autoload :Asset,                "sitepress/asset"
-  autoload :AssetNodeMapper,      "sitepress/asset_node_mapper"
+  autoload :Asset,                "sitepress/page"       # Backwards compatibility
+  autoload :AssetNodeMapper,      "sitepress/directory"  # Backwards compatibility
   autoload :AssetPaths,           "sitepress/asset_paths"
+  autoload :Directory,            "sitepress/directory"
   autoload :Data,                 "sitepress/data"
+  autoload :Image,                "sitepress/image"
   autoload :Node,                 "sitepress/node"
+  autoload :Page,                 "sitepress/page"
   autoload :Path,                 "sitepress/path"
   autoload :Parsers,              "sitepress/parsers"
   autoload :Resource,             "sitepress/resource"
@@ -22,4 +28,5 @@ module Sitepress
   autoload :ResourceIndexer,      "sitepress/resource_indexer"
   autoload :ResourcesPipeline,    "sitepress/resources_pipeline"
   autoload :Site,                 "sitepress/site"
+  autoload :Static,               "sitepress/static"
 end

data/sitepress-core.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
 
   spec.add_runtime_dependency "mime-types", ">= 2.99"
+  spec.add_runtime_dependency "fastimage", "~> 2.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 5.0.0.beta
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2025-11-17 00:00:00.000000000 Z
+date: 2026-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: fastimage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 email:
 - bradgessler@gmail.com
 executables: []
@@ -72,13 +86,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/sitepress-core.rb
-- lib/sitepress/asset.rb
-- lib/sitepress/asset_node_mapper.rb
 - lib/sitepress/asset_paths.rb
 - lib/sitepress/data.rb
+- lib/sitepress/directory.rb
 - lib/sitepress/extensions/layouts.rb
 - lib/sitepress/extensions/proc_manipulator.rb
+- lib/sitepress/image.rb
 - lib/sitepress/node.rb
+- lib/sitepress/page.rb
 - lib/sitepress/parsers.rb
 - lib/sitepress/parsers/base.rb
 - lib/sitepress/parsers/frontmatter.rb
@@ -89,6 +104,7 @@ files:
 - lib/sitepress/resources.rb
 - lib/sitepress/resources_pipeline.rb
 - lib/sitepress/site.rb
+- lib/sitepress/static.rb
 - lib/sitepress/version.rb
 - sitepress-core.gemspec
 homepage: https://sitepress.cc/

data/lib/sitepress/asset_node_mapper.rb

@@ -1,45 +0,0 @@
-module Sitepress
-  # Maps a tree of Directory and Asset objects in a a tree of nodes that
-  # format the navigational structure of a website. You can override this
-  # this in a site to deal with different file systems. For example, Notion
-  # has a completely different file structure for its content than Rails, so
-  # we could extend this class to properly map those differences into a tree
-  # of nodes.
-  class AssetNodeMapper
-    attr_reader :node, :asset_paths
-
-    def initialize(path:, node:)
-      @asset_paths = AssetPaths.new(path: path)
-      @node = node
-    end
-
-    # Mounts the source files from the path to the given node.
-    def map
-      asset_paths.each do |path|
-        if path.directory?
-          process_directory path
-        else
-          process_asset path
-        end
-      end
-    end
-
-    protected
-
-    def process_directory(path)
-      node_name = File.basename path
-      node_mapper path: path, node: node.child(node_name)
-    end
-
-    def process_asset(path)
-      asset = Asset.new(path: path)
-      node.child(asset.node_name).resources.add_asset(asset, format: asset.format)
-    end
-
-    private
-
-    def node_mapper(*args, **kwargs)
-      self.class.new(*args, **kwargs).map
-    end
-  end
-end