sitepress-core 2.0.0.beta9 → 2.0.0.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a7a004d33fe5e05c2e1831ebcd902dc9c6bbcbf4650437b6e36984a1eb0e263
-  data.tar.gz: 9bd65a5f76ee6b166337887619e825c48c4580cb082448c63c8d78d1c549759b
+  metadata.gz: 86f9eb2e3903461a6661161ec2f581804b634e2405f90897b6f63bf9adb3e01e
+  data.tar.gz: 77cdcc509daf4f20fbf83545ea1e906b61d523c6f0c7ab7614277b4e049096f8
 SHA512:
-  metadata.gz: 213d67af29c1e88c03f3ad72cb81001a2a938f418ca41717288f757581a409ec6daba877bdca903bb0a650c140d71e7252c113d2b4e0d9334b2e2726122ddb54
-  data.tar.gz: 68e40ac58a005c54262b050a3bc430eb3d2b81124705ce8aca39a87a3f0d07dd0fe9ab43283ead764c8afa9a00bf611fe6a903c2beb24d91b7eced7226b3ca7a
+  metadata.gz: 15a2854e3ea0562eee7db1a64d880fbddee2d6cfd0b1b772f91e4e13ba3b35cce52f9590627494b49f3b97bde0ae5f855c2506c3af2e66abf61430803bca429a
+  data.tar.gz: e3d263d7d5ebcdad165ad39e56eadbbe333fc3855fabc38150de1cef71cb3fddd2d12cc1e93da7ffff488641a75b72ec66269fb7f8f71ab25b742a729fe85e44

data/lib/sitepress-core.rb

@@ -8,13 +8,14 @@ module Sitepress
   ExistingRequestPathError = Class.new(InvalidRequestPathError)
 
   autoload :Asset,                "sitepress/asset"
+  autoload :AssetNodeMapper,      "sitepress/asset_node_mapper"
+  autoload :AssetPaths,           "sitepress/asset_paths"
   autoload :Formats,              "sitepress/formats"
-  autoload :Frontmatter,          "sitepress/frontmatter"
   autoload :Node,                 "sitepress/node"
   autoload :Path,                 "sitepress/path"
+  autoload :Parsers,              "sitepress/parsers"
   autoload :Resource,             "sitepress/resource"
   autoload :ResourceCollection,   "sitepress/resource_collection"
   autoload :ResourcesPipeline,    "sitepress/resources_pipeline"
   autoload :Site,                 "sitepress/site"
-  autoload :SourceNodeMapper,     "sitepress/source_node_mapper"
 end

data/lib/sitepress/asset.rb

@@ -4,7 +4,7 @@ require "pathname"
 
 module Sitepress
   # Represents a file on a web server that may be parsed to extract
-  # frontmatter or be renderable via a template. Multiple resources
+  # metadata or be renderable via a template. Multiple resources
   # may point to the same asset. Properties of an asset should be mutable.
   # The Resource object is immutable and may be modified by the Resources proxy.
   class Asset
@@ -16,14 +16,15 @@ module Sitepress
     attr_reader :path
 
     extend Forwardable
-    def_delegators :frontmatter, :data, :body
+    def_delegators :parser, :data, :body
     def_delegators :path, :handler, :node_name, :format, :exists?
 
-    def initialize(path: , mime_type: nil)
+    def initialize(path:, mime_type: nil, parser: Parsers::Frontmatter)
       # 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
+      @parser_klass = parser
     end
 
     # Treat resources with the same request path as equal.
@@ -41,9 +42,15 @@ module Sitepress
       !!handler
     end
 
+    # Set the parser equal to a thing.
+    def parser=(parser_klass)
+      @parser = nil
+      @parser_klass = parser_klass
+    end
+
     private
-      def frontmatter
-        Frontmatter.new File.read path
+      def parser
+        @parser ||= @parser_klass.new File.read path
       end
 
       # Returns the mime type of the file extension. If a type can't

data/lib/sitepress/asset_node_mapper.rb

@@ -0,0 +1,45 @@
+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.add_child(node_name)
+    end
+
+    def process_asset(path)
+      asset = Asset.new(path: path)
+      node.add_child(asset.node_name).formats.add(format: asset.format, asset: asset)
+    end
+
+    private
+
+    def node_mapper(*args, **kwargs)
+      self.class.new(*args, **kwargs).map
+    end
+  end
+end

data/lib/sitepress/asset_paths.rb

@@ -0,0 +1,49 @@
+require "pathname"
+
+module Sitepress
+  # Iterates through a folder, ignores partials and files that are well known to
+  # not be part of the website files, like `.DS_Store`, etc.
+  class AssetPaths
+    include Enumerable
+
+    # Exclude swap files created by Textmate and vim from being added
+    # to the sitemap.
+    IGNORE_FILE_PATTERNS = [
+      "*~",         # Created by many editors when things crash
+      "*.swp",      # Created by vim
+      ".DS_Store",  # Created by our friends at Apple
+      "*.orig"      # Created when there's a git conflict
+    ]
+
+    # Template files that start with `_user.html.erb` are partials that we want
+    # to ignore for the site's navigation tree.
+    PARTIAL_PREFIX = "_".freeze
+
+    attr_reader :path
+
+    def initialize(path:)
+      @path = Pathname.new(path)
+    end
+
+    # Returns a list of files, paths, and node names to iterate through to build out nodes
+    def each
+      path.each_child do |path|
+        yield path unless ignore_file? path
+      end
+    end
+
+    private
+
+    def ignore_file?(path)
+      is_partial_file?(path) or matches_ignore_file_pattern?(path)
+    end
+
+    def is_partial_file?(path)
+      path.basename.to_s.start_with? PARTIAL_PREFIX
+    end
+
+    def matches_ignore_file_pattern?(path)
+      IGNORE_FILE_PATTERNS.any? { |pattern| path.basename.fnmatch? pattern }
+    end
+  end
+end

data/lib/sitepress/formats.rb

@@ -21,7 +21,7 @@ module Sitepress
     end
 
     def remove(extension)
-      @formats.delete(symbolize(extension))
+      @formats.delete symbolize(extension)
     end
 
     def get(extension)

data/lib/sitepress/frontmatter.rb

@@ -5,7 +5,7 @@ module Sitepress
 
   # TODO: Redo this to use File readline and pos to
   # perform faster
-  class Frontmatter
+  class Parsers::Frontmatter
     DELIMITER = "---".freeze
     NEWLINE = /\r\n?|\n/.freeze
     PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m

data/lib/sitepress/parsers.rb

@@ -0,0 +1,12 @@
+require "yaml"
+
+module Sitepress
+  # Parsers parse the data and the body out of an asset. The resulting
+  # data is referenced by `Resource#data`, which is `current_page.data`
+  # from page templates.
+  module Parsers
+    autoload :Base,         "sitepress/parsers/base"
+    autoload :Frontmatter,  "sitepress/parsers/frontmatter"
+    autoload :Notion,       "sitepress/parsers/notion"
+  end
+end

data/lib/sitepress/parsers/base.rb

@@ -0,0 +1,15 @@
+require "yaml"
+
+module Sitepress
+  module Parsers
+    # Parses nothing. The body is returned and the data is blank.
+    class Base
+      attr_reader :body, :data
+
+      def initialize(source)
+        @body = source
+        @data = {}
+      end
+    end
+  end
+end

data/lib/sitepress/parsers/frontmatter.rb

@@ -0,0 +1,23 @@
+require "yaml"
+
+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
+      DELIMITER = "---".freeze
+      NEWLINE = /\r\n?|\n/.freeze
+      PATTERN = /\A(#{DELIMITER}#{NEWLINE}(.+?)#{NEWLINE}#{DELIMITER}#{NEWLINE}*)?(.+)\Z/m
+
+      def initialize(content)
+        _, @data, @body = content.match(PATTERN).captures
+      end
+
+      def data
+        @data ? YAML.load(@data) : {}
+      end
+    end
+  end
+end

data/lib/sitepress/parsers/notion.rb

@@ -0,0 +1,31 @@
+require "yaml"
+
+module Sitepress
+  module Parsers
+    # Parses metadata from the header of the page.
+    class Notion < Base
+      DELIMITER = /\n\n/.freeze
+      TITLE_KEY = "Title".freeze
+      KEY_DELIMITER = ":".freeze
+
+      def initialize(content)
+        scanner = StringScanner.new(content)
+        # Parse title
+        scanner.scan(/# (.+)#{DELIMITER}/)
+        @title = scanner.captures.first
+        # Parse metadata
+        @raw_data = []
+        while scanner.scan(/(.+?)#{KEY_DELIMITER} (.+)\n/)
+          @raw_data.append scanner.captures
+        end
+        scanner.scan(/\n/)
+        # Parse body
+        @body = scanner.rest
+      end
+
+      def data
+        Hash[@raw_data.prepend([TITLE_KEY, @title])]
+      end
+    end
+  end
+end

data/lib/sitepress/resource.rb

@@ -5,19 +5,20 @@ 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, :mime_type, :handler
-
     attr_writer :body, :data
-    attr_reader :node, :asset, :format
+    attr_reader :node, :asset
+
+    attr_accessor :format, :mime_type, :handler
 
     # Default scope for querying parent/child/sibling resources.
     DEFAULT_FILTER_SCOPE = :same
 
-    def initialize(asset:, node:, format: nil)
+    def initialize(asset:, node:, format: nil, mime_type: nil, handler: nil)
       @asset = asset
       @node = node
-      @format = format
+      @format = format || asset.format
+      @mime_type = mime_type || asset.mime_type
+      @handler = handler || asset.handler
     end
 
     def request_path

data/lib/sitepress/site.rb

@@ -11,8 +11,12 @@ module Sitepress
     # Default root_path for site.
     DEFAULT_ROOT_PATH = Pathname.new(".").freeze
 
+    # Maps Rail-ish template files & structures into the site's node tree.
+    DEFAULT_NODE_MAPPER = AssetNodeMapper
+
     attr_reader :root_path
     attr_writer :resources_pipeline
+    attr_accessor :node_mapper
 
     # TODO: Get rid of these so that folks have ot call site.resources.get ...
     extend Forwardable
@@ -20,13 +24,14 @@ module Sitepress
 
     def initialize(root_path: DEFAULT_ROOT_PATH)
       self.root_path = root_path
+      self.node_mapper = DEFAULT_NODE_MAPPER
     end
 
     # A tree representation of the resourecs wthin the site. The root is a node that's
     # processed by the `resources_pipeline`.
     def root
       @root ||= Node.new.tap do |node|
-        source_node_mapper.mount node
+        node_mapper.new(path: pages_path, node: node).map
         resources_pipeline.process node
       end
     end
@@ -97,11 +102,5 @@ module Sitepress
     def resources_pipeline
       @resources_pipeline ||= ResourcesPipeline.new
     end
-
-    private
-
-    def source_node_mapper
-      @source_node_mapper ||= SourceNodeMapper.new(path: pages_path)
-    end
   end
 end

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "2.0.0.beta9".freeze
+  VERSION = "2.0.0.beta10".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta9
+  version: 2.0.0.beta10
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,17 +75,22 @@ 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/extensions/layouts.rb
 - lib/sitepress/extensions/proc_manipulator.rb
 - lib/sitepress/formats.rb
 - lib/sitepress/frontmatter.rb
 - lib/sitepress/node.rb
+- lib/sitepress/parsers.rb
+- lib/sitepress/parsers/base.rb
+- lib/sitepress/parsers/frontmatter.rb
+- lib/sitepress/parsers/notion.rb
 - lib/sitepress/path.rb
 - lib/sitepress/resource.rb
 - lib/sitepress/resource_collection.rb
 - lib/sitepress/resources_pipeline.rb
 - lib/sitepress/site.rb
-- lib/sitepress/source_node_mapper.rb
 - lib/sitepress/version.rb
 - sitepress-core.gemspec
 homepage: https://github.com/sitepress/sitepress
@@ -107,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: An embeddable file-backed content management system.

data/lib/sitepress/source_node_mapper.rb

@@ -1,60 +0,0 @@
-module Sitepress
-  # Maps a directory of assets into a set of routes that correspond with
-  # the `path` root.
-  class SourceNodeMapper
-    # Exclude swap files created by Textmate and vim from being added
-    # to the sitemap.
-    IGNORE_FILE_PATTERNS = [
-      "*~",         # Created by many editors when things crash
-      "*.swp",      # Created by vim
-      ".DS_Store",  # Created by our friends at Apple
-      "*.orig"      # Created when there's a git conflict
-    ]
-
-    # Partial rails prefix.
-    PARTIAL_PREFIX = "_".freeze
-
-    attr_reader :assets, :path
-    alias :root :path
-
-    def initialize(path:)
-      @path = path
-    end
-
-    # Mounts the source files from the path to the given node.
-    def mount(node)
-      paths.each do |path|
-        if path.directory?
-          name = File.basename path
-          SourceNodeMapper.new(path: path).mount node.add_child(name)
-        else
-          asset = Asset.new(path: path)
-          node.add_child(asset.node_name).formats.add(format: asset.format, asset: asset)
-        end
-      end
-    end
-
-    private
-    # Returns a list of files, paths, and node names to iterate through to build out nodes
-    def paths
-      Enumerator.new do |y|
-        root.each_child do |path|
-          next if ignore_file? path
-          y << path
-        end
-      end
-    end
-
-    def ignore_file?(path)
-      is_partial_file?(path) or matches_ignore_file_pattern?(path)
-    end
-
-    def is_partial_file?(path)
-      path.basename.to_s.start_with? PARTIAL_PREFIX
-    end
-
-    def matches_ignore_file_pattern?(path)
-      IGNORE_FILE_PATTERNS.any? { |pattern| path.fnmatch? pattern }
-    end
-  end
-end