sitepress-core 2.0.0.beta8 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83c9ae67ef108b15908409feb2d555c718019e667c187713969372910e688580
-  data.tar.gz: 077afc29c48638240747ba35f3be4dda71f038645d1de08411d5337698d45b6a
+  metadata.gz: 4bf0b2c774c66fac3d6b12d4a9e8ca07ad774ebb06efa966bc38b9a04c6d08e2
+  data.tar.gz: 92e2f384ddf2b34592494f9e25ad52fb386e0e2516ec9129defb12bcb5653717
 SHA512:
-  metadata.gz: 68622942e6fb27b292154b2ab5b344b6ba6a34008d151aef31d0b69989c732ad9c5eefdc69f335f31650d8c8652fdad9fe935e0c02c63910648194b0123f45dc
-  data.tar.gz: aa63c9d8b7fdb3c9dda60503192799d00cdd4ca8219047b04d632d21dc8ada33a61305ec9059ef0753a8dbbebd7e04a3aadf1a5f1e27cec71407cd2361edcbc2
+  metadata.gz: de0131d58b1c69251b3cb2d0fe253b44f75e8af2e671f5d41772bd7c07f0cc2381045883f4a474267b84db5d0e35667b437e7e6fef3274578a3557febfea6b37
+  data.tar.gz: e9a0171d0b66a8b6985022203ac82a9b2860f1f62bed26b5fdc6910caf64049e9d1e90b3c68ef6a5f4d480b002d92f814bba343bdea63f336de3f59104c46780

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,42 +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 = Pathname.new path
-    end
-
-    # List of all file extensions.
-    def extensions
-      path.basename.to_s.split(".").drop(1)
-    end
-
-    def basename
-      path.basename.to_s.split(".").first
-    end
-    alias :node_name :basename
-
-    def format_basename
-      [basename, format_extension].join(".")
-    end
-
-    # Returns the format extension.
-    def format_extension
-      extensions.first
-    end
-
-    # The base name with the format extension.
-    def format_name
-      [basename, format_extension].join(".")
-    end
-
-    # Returns a list of the rendering extensions.
-    def template_extensions
-      extensions.drop(1)
+      @path = Path.new path
+      @parser_klass = parser
     end
 
     # Treat resources with the same request path as equal.
@@ -63,19 +36,28 @@ module Sitepress
       @mime_type ||= inferred_mime_type || DEFAULT_MIME_TYPE
     end
 
-    def exists?
-      File.exist? path
+    # Used by the Rails controller to short circuit additional processing if the
+    # asset is not renderable (e.g. is it erb or haml?)
+    def renderable?
+      !!handler
     end
 
-    private
-    def frontmatter
-      Frontmatter.new File.read @path
+    # Set the parser equal to a thing.
+    def parser=(parser_klass)
+      @parser = nil
+      @parser_klass = parser_klass
     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
-      MIME::Types.type_for(format_extension).first if format_extension
-    end
+    private
+      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
 end

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

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Sitepress
   # Manages collections of resources that share the same Node. Given the files `/a.html` and `/a.gif`,
   # both of these assets would be stored in the `Node#name = "a"` under `Node#formats` with
@@ -19,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/node.rb

@@ -80,7 +80,7 @@ module Sitepress
     end
 
     def inspect
-      "<#{self.class}: name=#{name.inspect} formats=#{formats.map(&:request_path)} children=#{children.map(&:name).inspect}>"
+      "<#{self.class}: name=#{name.inspect}, formats=#{formats.extensions.inspect}, children=#{children.map(&:name).inspect}, resource_request_paths=#{formats.map(&:request_path)}>"
     end
 
     def dig(*args)

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/path.rb

@@ -1,31 +1,127 @@
+require "pathname"
+require "mime-types"
+
 module Sitepress
   class Path
-    DELIMITER = "/".freeze
+    # Default handler extensions. Handlers are anything that render or
+    # manipulate the contents of the file into a different output, like
+    # ERB or HAML.
+    HANDLER_EXTENSIONS = %i[haml erb md markdown]
+
+    # The root node name is a blank string.
+    ROOT_NODE_NAME = "".freeze
+
+    # The name of the root path
+    ROOT_PATH = "/".freeze
+
+    attr_reader :handler, :format, :path, :node_name, :dirname, :basename
+
+    # When Rails boots, it sets the handler extensions so that paths
+    # can be properly parsed.
+    class << self
+      attr_writer :handler_extensions
+
+      def handler_extensions
+        @handler_extensions ||= HANDLER_EXTENSIONS
+      end
+    end
 
-    attr_reader :node_names, :ext
+    def initialize(path, path_seperator: File::SEPARATOR, handler_extensions: self.class.handler_extensions)
+      @path = path.to_s
+      @path_seperator = Regexp.new(path_seperator)
+      @handler_extensions = handler_extensions
+      parse
+    end
+
+    def node_names
+      @node_names ||= node_name_ancestors.push(node_name)
+    end
+
+    # Necessary for operations like `File.read path` where `path` is an instance
+    # of this object.
+    def to_str
+      @path
+    end
+    alias :to_s :to_str
+
+    def ==(path)
+      to_s == path.to_s
+    end
 
-    def initialize(path, delimiter: DELIMITER)
-      @path = path
-      @delimiter = delimiter
-      parse_path
+    def exists?
+      File.exists? path
+    end
+
+    def expand_path
+      File.expand_path path
     end
 
     def format
-      format = @ext.partition(".").last
-      return nil if format.nil? or format.empty?
-      format.to_sym
+      (handler_is_format? ? handler : @format)&.to_sym
     end
 
     private
-      def strip_leading_slash(path)
-        path.to_s.gsub(/^\//, "")
+      # TODO: I don't want to look this up everytime I try to figure out the
+      # extension. I'll have to create an extension registry .
+
+      # Rails has handlers, like `:html` and `:raw` that are both
+      # handlers and formats. If we don't account for this, then the object
+      # would return a `nil` for a file named `blah.html`.
+      def handler_is_format?
+        return false if @handler.nil?
+        @format.nil? and MIME::Types.type_for(@handler.to_s).any?
+      end
+
+      def parse
+        @dirname, @basename = File.split(path)
+        parse_basename
+      end
+
+      # Given a filename, this will work out the extensions, formats, and node_name.
+      def parse_basename
+        base = basename
+        filename, extname = split_filename(base)
+
+        # This is a root path, so we have to treat it a little differently
+        # so that the node mapper and node names work properly.
+        if filename == ROOT_PATH and extname.nil?
+          @node_name = ROOT_NODE_NAME
+        elsif extname
+          extname = extname.to_sym
+
+          # We have an extension! Let's figure out if its a handler or not.
+          if @handler_extensions.include? extname
+            # Yup, its a handler. Set those variables accordingly.
+            @handler = extname
+            base = filename
+          end
+
+          # Now let's get the format (e.g. :html, :xml, :json) for the path and
+          # the key, which is just the basename without the format extension.
+          @node_name, format = split_filename(base)
+          @format = format
+        else
+          @node_name = filename
+        end
+      end
+
+      # If given a path `/a/b/c`, thsi would return `["a", "b", "c"].
+      def node_name_ancestors
+        strip_leading_prefix(File.dirname(path)).split(@path_seperator)
+      end
+
+      # Make it easier to split the last extension off a filename.
+      # For example, if you run `split_filename("c.taco.html")`
+      # it would return `["c.taco", "html"]`. If you ran it against
+      # something like `split_filename("c")`, it would return `["c"]`
+      def split_filename(string)
+        base, _, extension = string.rpartition(".")
+        base.empty? ? [extension] : [base, extension]
       end
 
-      def parse_path
-        path, _, file = strip_leading_slash(@path).rpartition(@delimiter)
-        @ext = File.extname(file)
-        @file = File.basename(file, @ext)
-        @node_names = path.split(@delimiter).push(@file)
+      # Strips leading `/` or leading `.` if the path is relative.
+      def strip_leading_prefix(dirname)
+        dirname.to_s.gsub(/^#{@path_seperator}|\./, "")
       end
   end
 end

data/lib/sitepress/resource.rb

@@ -5,21 +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
-
     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
 
-    RENDERABLE_MEDIA_TYPE = "text".freeze
-
-    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
@@ -67,7 +66,7 @@ module Sitepress
     # 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.mime_type.media_type == RENDERABLE_MEDIA_TYPE
+      asset.renderable?
     end
 
     private

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.beta8".freeze
+  VERSION = "2.0.0".freeze
 end

data/sitepress-core.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Sitepress::VERSION
   spec.authors       = ["Brad Gessler"]
   spec.email         = ["bradgessler@gmail.com"]
+  spec.licenses      = ["MIT"]
 
   spec.summary       = %q{An embeddable file-backed content management system.}
   spec.homepage      = "https://github.com/sitepress/sitepress"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta8
+  version: 2.0.0
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-16 00:00:00.000000000 Z
+date: 2021-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,21 +75,27 @@ 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
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -102,11 +108,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 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,57 +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.
-    SWAP_FILE_EXTENSIONS = [
-      "~",
-      ".swp",
-      ".DS_Store" # TODO: Not a swap file, but something that should be ignored.
-    ]
-
-    # 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, name, format|
-        if path.directory?
-          SourceNodeMapper.new(path: path).mount node.add_child(name)
-        else
-          asset = Asset.new(path: path)
-          node.add_child(name).formats.add(format: 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 is_swap_file? path
-          next if is_partial_file? path
-
-          node_name, node_format, template_handler = path.basename.to_s.split(".")
-          y << [ path, node_name, node_format&.to_sym ]
-        end
-      end
-    end
-
-    def is_partial_file?(path)
-      path.basename.to_s.start_with? PARTIAL_PREFIX
-    end
-
-    def is_swap_file?(path)
-      SWAP_FILE_EXTENSIONS.any? { |ext| path.to_s.end_with? ext }
-    end
-  end
-end