sitepress-core 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2839172c3482bfcd76b700b47a31469caa3e76119f4671c77933f1ca26266e3
-  data.tar.gz: da657c2dc3adf936890e9e51d404367e9de5d1cafa0c322e77b21284e605b5d8
+  metadata.gz: 0f5128994ea5970446da051ce17c700fd2a0ad99c1bd2716bc8628b244ca7e21
+  data.tar.gz: ce9393f3fa9218eda6fbc41523e2be852f91f069cb41a2fd50e8964e945a1555
 SHA512:
-  metadata.gz: da9b20b6beddb74ea92903d2283938e6ba3ef442a875a724330e4225240e7865fcff208ef2251432814fd54b8ed12aa1eea43a994733b348950fddff8197929b
-  data.tar.gz: 2da0235e25b98a8353ce7d254ccab76b3ef6148c09ba35a6ebfb4431c05187bb15ef20739903416f56940f1e53a17197160b80487fb75c8ade79377ceb05ce6e
+  metadata.gz: edc9fb30418337a90b81d0de0dd7a08c306222d3ac45598393a21586ba3cd6a9527f3d52820ae6844886adbea6b5a16b441a22cc2bb62e5a2d870617616436d1
+  data.tar.gz: 27b342cae371ec2a524c2a999c3f99abbf34ead1168d6650150fea5bfe450ea55f3d8b4bdd35f6d295f6560a8edf1a08e7bf38b9449fd18c1a4c05ebd097cb40

data/lib/sitepress/asset.rb

@@ -1,5 +1,6 @@
 require "mime/types"
 require "forwardable"
+require "fileutils"
 
 module Sitepress
   # Represents a file on a web server that may be parsed to extract
@@ -19,7 +20,7 @@ module Sitepress
     attr_reader :path
 
     extend Forwardable
-    def_delegators :parser, :data, :body
+    def_delegators :renderer, :render
     def_delegators :path, :handler, :node_name, :format, :exists?
 
     def initialize(path:, mime_type: nil, parser: DEFAULT_PARSER)
@@ -30,6 +31,14 @@ module Sitepress
       @parser_klass = parser
     end
 
+    def data
+      @data ||= exists? ? parse_error { parser.data } : {}
+    end
+
+    def body
+      @body ||= exists? ? parse_error { parser.body } : nil
+    end
+
     # Treat resources with the same request path as equal.
     def ==(asset)
       path == asset.path
@@ -39,8 +48,9 @@ module Sitepress
       @mime_type ||= inferred_mime_type || DEFAULT_MIME_TYPE
     end
 
-    # Used by the Rails controller to short circuit additional processing if the
-    # asset is not renderable (e.g. is it erb or haml?)
+    # 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
@@ -51,7 +61,33 @@ module Sitepress
       @parser_klass = parser_klass
     end
 
+    def updated_at
+      File.mtime path
+    end
+
+    def created_at
+      File.ctime path
+    end
+
+    def destroy
+      FIleUtils.rm path
+    end
+
+    def save
+      File.write path, render
+    end
+
+    def renderer
+      @parser_klass::Renderer.new(data: data, body: body)
+    end
+
     private
+      def parse_error(&parse)
+        parse.call
+      rescue StandardError => e
+        raise ParseError.new("Error parsing asset at #{path.to_s}: #{e}")
+      end
+
       def parser
         @parser ||= @parser_klass.new File.read path
       end

data/lib/sitepress/data.rb

@@ -0,0 +1,47 @@
+module Sitepress
+  class Data
+    def initialize(data)
+      @data = data
+    end
+
+    def fetch(key, *args, &block)
+      wrap_value { @data.fetch(key.to_s, *args, &block) }
+    end
+
+    def [](key)
+      wrap_value { @data[key.to_s] }
+    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("!")
+        wrap_value do
+          case modifier
+          when ""
+            @data[key]
+          when "!"
+            @data.fetch(key)
+          end
+        end
+      end
+    end
+
+    def dig(*args, **kwargs, &block)
+      wrap_value { @data.dig(*args, **kwargs, &block) }
+    end
+
+    private
+      def wrap_value(&block)
+        case value = block.call
+        when Hash
+          self.class.new value
+        when Array
+          value.map { |v| wrap_value { v } }
+        else
+          value
+        end
+      end
+  end
+end

data/lib/sitepress/parsers/frontmatter.rb

@@ -1,12 +1,46 @@
 require "yaml"
+require "date"
 
 module Sitepress
   module Parsers
     # Parses metadata from the header of the page.
-
-    # TODO: Redo this to use File readline and pos to
-    # perform faster
     class Frontmatter < Base
+      class Renderer
+        attr_reader :body, :data
+
+        def initialize(body:, data:)
+          @body = body
+          @data = data
+        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
+        end
+
+        def render
+          [
+            dump_yaml(data),
+            Frontmatter::DELIMITER,
+            $/,
+            $/,
+            body
+          ].join
+        end
+      end
+
+      # Default classes that we'll allow YAML to parse. Ideally this doesn't
+      # get too huge and we let users control it by setting
+      # `Sitepress::Parsers::Frontmatter.permitted_classes = [Whatever, SuperDanger]`
+      PERMITTED_CLASSES = [
+        Date,
+        Time
+      ]
+
       DELIMITER = "---".freeze
       NEWLINE = /\r\n?|\n/.freeze
       PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m
@@ -16,7 +50,24 @@ module Sitepress
       end
 
       def data
-        @data ? YAML.load(@data) : {}
+        @data ? load_yaml(@data) : {}
+      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
+      end
+
+      class << self
+        attr_writer :permitted_classes
+
+        def permitted_classes
+          @permitted_classes ||= PERMITTED_CLASSES
+        end
       end
     end
   end

data/lib/sitepress/path.rb

@@ -49,7 +49,7 @@ module Sitepress
     end
 
     def exists?
-      File.exists? path
+      File.exist? path
     end
 
     def expand_path

data/lib/sitepress/resource.rb

@@ -5,6 +5,9 @@ module Sitepress
   # resources that point to the same asset. Resources are immutable
   # and may be altered by the resource proxy.
   class Resource
+    extend Forwardable
+    def_delegators :asset, :renderable?
+
     attr_writer :body, :data
     attr_reader :node, :asset
 
@@ -62,12 +65,6 @@ module Sitepress
       @lineage ||= node.parents.reject(&:root?).reverse.map(&:name)
     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?
-      asset.renderable?
-    end
 
     private
     # Filters parent/child/sibling resources by a type. The default behavior is to only return

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "3.2.0".freeze
+  VERSION = "3.2.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/sitepress/asset.rb
 - lib/sitepress/asset_node_mapper.rb
 - lib/sitepress/asset_paths.rb
+- lib/sitepress/data.rb
 - lib/sitepress/extensions/layouts.rb
 - lib/sitepress/extensions/proc_manipulator.rb
 - lib/sitepress/formats.rb
@@ -114,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: An embeddable file-backed content management system.