sitepress-core 5.0.0.beta1 → 5.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ca9aab55ae45bf39216231a491ffa4f432682c2b5549e0905d9561436e57b5a
-  data.tar.gz: 42fb6f8c6b22a8e18895689a3a5d792e1c8daabd899be7530ad86d4a84c926dd
+  metadata.gz: f8f487224acfb9abed8c58d92458335235c1a3643dd7ff379181ff314c150cc6
+  data.tar.gz: 8105632137100f27f86f542a9215b634a72eae4ae824da2472015af14d3cbee2
 SHA512:
-  metadata.gz: 846b3c0ae6ef4b30405cd1aece7eafcd5650ce7df355bbeb65675e25ddfa55d85baf7b7b4462a64eb3f13c9fbc4e8ef2cf661d1e52294d8f05a4aa637f2c9448
-  data.tar.gz: 26ff50a30859fa7160793d36e6353d207fe980b6ae8c898a5657527508ebc5bc9774b8bd8a012b7252cbe4082eeaa347afb21c0830abb4d2447f294d305780e0
+  metadata.gz: 6f7385c3f09cb8af5af3fcffeca64c73eebe82d513a23e015d05161b1b06b28d00f2687a06f2c94c7295b560e3f75bcf7cebcf0de25ae42ba45af0a4af881c7a
+  data.tar.gz: 641f2e5b2da44d0f3c86ea390dd4a089c4a27739a7a16cfd34d93932e1c934b9b5fdbe06d66652a6d3681e217c665b8799b38f712760e201154f67e5533c5258

data/lib/sitepress/data.rb

@@ -46,7 +46,7 @@ module Sitepress
       def_delegators :@hash, :keys, :values, :key?
 
       def initialize(hash)
-        @hash = hash
+        @hash = hash || {}
       end
 
       def fetch(key, *args, &block)

data/lib/sitepress/directory.rb

@@ -30,8 +30,10 @@ module Sitepress
     end
 
     def process_asset(path, node)
-      asset = source_for(path)
-      node.child(asset.node_name).resources.add_asset(asset, format: asset.format)
+      source = source_for(path)
+      # Parse the path to get node_name and format for tree building
+      parsed_path = Path.new(path.to_s)
+      node.child(parsed_path.node_name).resources.add_asset(source, format: parsed_path.format)
     end
 
     def source_for(path)

data/lib/sitepress/image.rb

@@ -1,4 +1,3 @@
-require "mime/types"
 require "fastimage"
 
 module Sitepress
@@ -10,35 +9,17 @@ module Sitepress
   #   image.height  # => 1080
   #   image.data["width"]  # => 1920
   #
-  class Image
+  class Image < Static
     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
@@ -58,18 +39,6 @@ module Sitepress
       }.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

data/lib/sitepress/page.rb

@@ -1,17 +1,11 @@
-require "mime/types"
-require "forwardable"
 require "fileutils"
+require "forwardable"
 
 module Sitepress
-  # 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 page. Properties of a page should be mutable.
-  # The Resource object is immutable and may be modified by the Resources proxy.
-  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
+  # A source for text-based files that may have frontmatter.
+  # Handles parsing of YAML frontmatter and provides access to data and body.
+  class Page < Static
+    extend Forwardable
 
     # MIME types that Page can handle - text-based content that may have frontmatter
     MIME_TYPES = %w[
@@ -36,18 +30,12 @@ module Sitepress
     # documents, JSON, exif data on images, etc.
     DEFAULT_PARSER = Parsers::Frontmatter
 
-    attr_reader :path
     attr_writer :body
 
-    extend Forwardable
-    def_delegators :renderer, :render
-    def_delegators :path, :handler, :node_name, :format, :exists?
-
-    def initialize(path:, mime_type: nil, parser: DEFAULT_PARSER)
-      # The MIME::Types gem returns an array when types are looked up.
-      # This grabs the first one, which is likely the intent on these lookups.
-      @mime_type = Array(mime_type).first
-      @path = Path.new path
+    def_delegator :renderer, :render, :serialize
+
+    def initialize(path:, parser: DEFAULT_PARSER)
+      super(path: path)
       @parser_klass = parser
     end
 
@@ -69,26 +57,11 @@ module Sitepress
       exists? ? parser.body_line_offset : 1
     end
 
-    # Treat resources with the same request path as equal.
+    # Treat sources with the same path as equal.
     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
-      @mime_type ||= inferred_mime_type || DEFAULT_MIME_TYPE
-    end
-
-    # Certain files, like binary file types, aren't something that we should try to
-    # parse. When this returns true in some cases, a reference to the file will be
-    # passed and skip all the overhead of trying to parse and render.
-    def renderable?
-      !!handler
-    end
-
     # When changing the parser, clear all cached parsed data.
     def parser=(parser_klass)
       @parser = nil
@@ -110,42 +83,23 @@ module Sitepress
     end
 
     def save
-      File.write path, render
+      File.write path, serialize
     end
 
     def renderer
       @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)
-      template = ActionView::Template.new(
-        body,
-        path.to_s,
-        ActionView::Template.handler_for_extension(handler),
-        locals: []
-      )
-      template.render(view_context, {})
-    end
-
     private
       def parse_error(&parse)
         parse.call
       rescue StandardError => e
-        raise ParseError, "Error parsing #{path.expand_path}: #{e.class} - #{e.message}"
+        raise ParseError, "Error parsing #{File.expand_path(path)}: #{e.class} - #{e.message}"
       end
 
       def parser
         @parser ||= @parser_klass.new File.read path
       end
-
-      # Returns the mime type of the file extension. If a type can't
-      # be resolved then we'll just grab the first type.
-      def inferred_mime_type
-        format_extension = path.format&.to_s
-        MIME::Types.type_for(format_extension).first if format_extension
-      end
   end
 
   # Backwards compatibility

data/lib/sitepress/resource.rb

@@ -1,18 +1,23 @@
 require "forwardable"
+require "mime/types"
 
 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.
+  # Represents the web-facing view of a source file. A Resource wraps a source
+  # and adds web-serving concerns: request path, handler, format, and rendering.
   #
-  # The source can be any object that implements the Renderable protocol:
-  # - #data - returns a Hash of metadata
-  # - #render_in(view_context) - renders the content
+  # Source = file on disk (Pathname)
+  # Resource = web representation (Path parsing, rendering)
   class Resource
     extend Forwardable
     def_delegators :source, :body
 
-    attr_reader :node, :source
+    # 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
+
+    attr_reader :node, :source, :source_path
+
     alias :asset :source  # Backwards compatibility
 
     # Check if the source implements the data protocol.
@@ -20,14 +25,14 @@ module Sitepress
       source.respond_to?(:data)
     end
 
-    # Check if the source implements the render_in protocol.
-    def renderable?
-      source.respond_to?(:render_in)
+    # Delegate to source.
+    def data
+      has_data? ? source.data : Data.manage({})
     end
 
-    # Returns metadata from the source, or an empty hash if not available.
-    def data
-      has_data? ? source.data : {}
+    # Delegate to source.
+    def fetch_data(key, *args, &block)
+      source.fetch_data(key, *args, &block)
     end
 
     attr_accessor :format, :mime_type, :handler
@@ -39,9 +44,27 @@ module Sitepress
       @source = source || asset
       raise ArgumentError, "Either asset: or source: must be provided" unless @source
       @node = node
-      @format = format || @source.format
-      @mime_type = mime_type || @source.mime_type
-      @handler = handler || source_handler
+      # Parse the source path to extract handler, format, node_name (if source has path)
+      if @source.respond_to?(:path)
+        @source_path = Path.new(@source.path.to_s)
+        @format = format || @source_path.format
+        @handler = handler || @source_path.handler
+      else
+        @source_path = nil
+        @format = format
+        @handler = handler
+      end
+      @mime_type = mime_type || inferred_mime_type || DEFAULT_MIME_TYPE
+    end
+
+    # The node name is derived from the source path
+    def node_name
+      @source_path&.node_name
+    end
+
+    # Whether this resource can be rendered (has a template handler)
+    def renderable?
+      !!handler
     end
 
     def request_path
@@ -129,8 +152,16 @@ module Sitepress
       node.parents.reject(&:root?).reverse.map(&:name)
     end
 
+    # Renders the resource in a view context using the appropriate template handler.
     def render_in(view_context)
-      renderable? ? source.render_in(view_context) : nil
+      return nil unless renderable?
+      template = ActionView::Template.new(
+        body,
+        source.path.to_s,
+        ActionView::Template.handler_for_extension(handler),
+        locals: []
+      )
+      template.render(view_context, {})
     end
 
     private
@@ -156,8 +187,10 @@ module Sitepress
       end
     end
 
-    def source_handler
-      @source.handler if @source.respond_to?(:handler)
+    # Returns the mime type inferred from the format extension
+    def inferred_mime_type
+      format_extension = format&.to_s
+      MIME::Types.type_for(format_extension).first if format_extension
     end
 
     # Deals with situations, particularly in the root node and other "index" nodes, for the `request_path`

data/lib/sitepress/static.rb

@@ -1,13 +1,13 @@
 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.
+  # Base class for source files. A source represents a file on disk
+  # without any web-serving concerns (handlers, formats, etc.).
   #
   # Example:
-  #   static = Static.new(path: "fonts/roboto.woff2")
-  #   static.mime_type  # => #<MIME::Type font/woff2>
-  #   static.body       # => binary content
+  #   source = Static.new(path: "fonts/roboto.woff2")
+  #   source.mime_type  # => #<MIME::Type font/woff2>
+  #   source.body       # => binary content
   #
   class Static
     attr_reader :path
@@ -16,12 +16,8 @@ module Sitepress
       @path = Pathname.new(path)
     end
 
-    def node_name
-      path.basename(".*").to_s.split(".").first
-    end
-
-    def format
-      path.extname.delete(".").to_sym
+    def exists?
+      path.exist?
     end
 
     def mime_type
@@ -36,8 +32,10 @@ module Sitepress
       @data ||= Data.manage({})
     end
 
-    def exists?
-      path.exist?
+    def fetch_data(key, *args, &block)
+      data.fetch(key, *args, &block)
+    rescue KeyError
+      raise KeyError, "key not found: #{key.inspect} in #{path}"
     end
 
     def inspect

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "5.0.0.beta1".freeze
+  VERSION = "5.0.0.beta3".freeze
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 5.0.0.beta1
+  version: 5.0.0.beta3
 platform: ruby
 authors:
 - Brad Gessler
 bindir: exe
 cert_chain: []
-date: 2026-02-20 00:00:00.000000000 Z
+date: 2026-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler