sitepress-core 1.0.1 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5edd37e3b6cbe8829fdf7e6d86863f51dab0985bd79ce3c6c6fc892b76cf43b6
-  data.tar.gz: 8238ff5cdb9d205b095f85a7c5b863ceb995378c732be368b44bd936b302bc8b
+  metadata.gz: 6395983eac0134367f92c65aae2d13cc54fb1cd480bc062c00c24fcdd6575590
+  data.tar.gz: fd7db9816c3b8a6f3f6b9c6bf02e5a06e496209a8c006316f2cd85c9456fcdf2
 SHA512:
-  metadata.gz: 53b2d7df10e9078f69a20e1dd13a219a42c4e9746d650902ba505838068769c5499b6dd09dd1a5d79aebd2728d0248c980f6373902bbac50b3975bea522bdbb0
-  data.tar.gz: b67155cd7a4f8435f50a2fea2d944c14293fa90aaddd3ee7e27582b759a5e40e3938f36918d7833fa644ee10e68ea587c5fb7c91c10cbabd8380ea2f6c347a64
+  metadata.gz: 7430bd142a60bbbd3afbff40dce5e23741975241c9db38e97a258a85241aa191f55dbe89eaa6e08d0b5ee0c20c46fa01fda74fe24044f0f65e871944351ad85d
+  data.tar.gz: 286b316eccf042d8b83c1d231741d06d71a538aaf4cf311b322fe09bf6401e05413d74df1c872d0c6b0f2f64fe9a66e4ad37d041c8b66db249e5b80e4deac278

data/lib/sitepress-core.rb

@@ -8,14 +8,15 @@ module Sitepress
   ExistingRequestPathError = Class.new(InvalidRequestPathError)
 
   autoload :Asset,                "sitepress/asset"
-  autoload :DirectoryCollection,  "sitepress/directory_collection"
   autoload :Formats,              "sitepress/formats"
   autoload :Frontmatter,          "sitepress/frontmatter"
+  autoload :Node,                 "sitepress/node"
+  autoload :Path,                 "sitepress/path"
   autoload :Resource,             "sitepress/resource"
   autoload :ResourceCollection,   "sitepress/resource_collection"
   autoload :ResourcesPipeline,    "sitepress/resources_pipeline"
-  autoload :ResourcesNode,        "sitepress/resources_node"
   autoload :Site,                 "sitepress/site"
+  autoload :SourceNodeMapper,     "sitepress/source_node_mapper"
   module Middleware
     autoload :RequestCache,       "sitepress/middleware/request_cache"
   end

data/lib/sitepress/asset.rb

@@ -30,10 +30,10 @@ module Sitepress
       path.basename.to_s.split(".").drop(1)
     end
 
-    # TODO: This is really a "key" or "leafname".
     def basename
       path.basename.to_s.split(".").first
     end
+    alias :node_name :basename
 
     def format_basename
       [basename, format_extension].join(".")
@@ -67,18 +67,6 @@ module Sitepress
       File.exist? path
     end
 
-    # Spits out a reasonable default request path. This may be changed
-    # via Resource#request_path.
-    def to_request_path
-      ext = format_extension
-
-      if ext
-        path.dirname.join(basename).sub_ext(".#{ext}").to_s
-      else
-        path.to_s
-      end
-    end
-
     private
     def frontmatter
       Frontmatter.new File.read @path

data/lib/sitepress/formats.rb

@@ -1,12 +1,13 @@
 module Sitepress
-  # Manages collections of resources that share the same ResourceNode. Given the files `/a.html` and `/a.gif`,
-  # both of these assets would be stored in the `ResourceNode#name = "a"` under `ResourceNode#formats` with
+  # 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
   # the extensions `.gif`, and `.html`.
   class Formats
     include Enumerable
 
     extend Forwardable
     def_delegators :@formats, :size, :clear
+    def_delegators :@node, :default_format
 
     def initialize(node: )
       @node = node
@@ -17,12 +18,12 @@ module Sitepress
       @formats.values.each(&block)
     end
 
-    def remove(ext)
-      @formats.delete(ext)
+    def remove(extension)
+      @formats.delete(symbolize(extension))
     end
 
-    def ext(ext)
-      @formats[ext]
+    def get(extension)
+      @formats[symbolize(extension || default_format)]
     end
 
     def extensions
@@ -33,17 +34,24 @@ module Sitepress
       find { |f| f.mime_type == mime_type }
     end
 
-    def add(asset: , ext: )
-      resource = Resource.new(asset: asset, node: @node, ext: ext)
-      if @formats.has_key? ext
-        raise Sitepress::ExistingRequestPathError, "Resource at #{resource.request_path} already set"
+    def add(asset:, format: nil)
+      format = symbolize(format || default_format)
+
+      resource = Resource.new(asset: asset, node: @node, format: format)
+      if @formats.has_key? format
+        raise Sitepress::ExistingRequestPathError, "Resource at #{resource.request_path} already set with format #{format.inspect}"
       else
-        @formats[ext] = resource
+        @formats[format] = resource
       end
     end
 
     def inspect
       "<#{self.class}: resources=#{map(&:request_path)}>"
     end
+
+    private
+    def symbolize(format)
+      format&.to_sym
+    end
   end
 end

data/lib/sitepress/node.rb

@@ -0,0 +1,111 @@
+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`,
+  # a tree of resource nodes would be built named `foo`, `bar`, `biz`, `buz`. `foo` would be the "root" node and `buz`
+  # a leaf node. The actual `buz.html` asset is then stored on the leaf node as a resource. This tree structure
+  # makes it possible to reason through path relationships from code to build out elements in a website like tree navigation.
+  class Node
+    attr_reader :parent, :name, :default_format, :default_name
+
+    # Default extension
+    DEFAULT_EXTENSION = :html
+
+    DEFAULT_NAME = "index".freeze
+
+    def initialize(parent: nil, name: nil, default_format: DEFAULT_EXTENSION, default_name: DEFAULT_NAME)
+      @parent = parent
+      @name = name.freeze
+      @default_format = default_format
+      @default_name = default_name
+      yield self if block_given?
+    end
+
+    def formats
+      @formats ||= Formats.new(node: self)
+    end
+
+    # Returns the immediate children nodes.
+    def children
+      child_nodes.values
+    end
+
+    # Returns sibling nodes and self.
+    def siblings
+      parent ? parent.children : []
+    end
+
+    # Returns all parents up to the root node.
+    def parents
+      parents = []
+      node = parent
+      while node do
+        parents << node
+        node = node.parent
+      end
+      parents
+    end
+
+    def root?
+      parent.nil?
+    end
+
+    def leaf?
+      child_nodes.empty?
+    end
+
+    def flatten(resources: [])
+      formats.each{ |resource| resources << resource }
+      children.each do |child|
+        child.flatten.each{ |resource| resources << resource }
+      end
+      resources
+    end
+
+    def remove
+      formats.clear
+      parent.remove_child(name) if leaf?
+    end
+
+    def get(path)
+      path = Path.new(path)
+      node = dig(*path.node_names)
+      node.formats.get(path.format) if node
+    end
+
+    def add_child(name)
+      return self if name == default_name
+      child_nodes[name].tap do |node|
+        yield node if block_given?
+      end
+    end
+
+    def inspect
+      "<#{self.class}: name=#{name.inspect} formats=#{formats.map(&:request_path)} children=#{children.map(&:name).inspect}>"
+    end
+
+    def dig(*args)
+      head, *tail = args
+      if (head.nil? or head.empty? or head == default_name) and tail.empty?
+        self
+      elsif child_nodes.has_key?(head)
+        child_nodes[head].dig(*tail)
+      else
+        nil
+      end
+    end
+
+    protected
+    def remove_child(name)
+      child_nodes.delete(name)
+    end
+
+    private
+    def build_child(name)
+      Node.new(parent: self, name: name, default_format: default_format, default_name: default_name)
+    end
+
+    def child_nodes
+      @child_nodes ||= Hash.new { |hash, key| hash[key] = build_child(key) }
+    end
+  end
+end

data/lib/sitepress/path.rb

@@ -0,0 +1,31 @@
+module Sitepress
+  class Path
+    DELIMITER = "/".freeze
+
+    attr_reader :node_names, :ext
+
+    def initialize(path, delimiter: DELIMITER)
+      @path = path
+      @delimiter = delimiter
+      parse_path
+    end
+
+    def format
+      format = @ext.partition(".").last
+      return nil if format.nil? or format.empty?
+      format.to_sym
+    end
+
+    private
+      def strip_leading_slash(path)
+        path.to_s.gsub(/^\//, "")
+      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)
+      end
+  end
+end

data/lib/sitepress/resource.rb

@@ -9,23 +9,21 @@ module Sitepress
     def_delegators :asset, :mime_type
 
     attr_writer :body, :data
-    attr_reader :node, :asset, :ext
+    attr_reader :node, :asset, :format
 
     # Default scope for querying parent/child/sibling resources.
     DEFAULT_FILTER_SCOPE = :same
 
-    def initialize(asset: , node: , ext: "")
+    RENDERABLE_MEDIA_TYPE = "text".freeze
+
+    def initialize(asset:, node:, format: nil)
       @asset = asset
       @node = node
-      @ext = ext # TODO: Meh, feels dirty but I suppose the thingy has to drop it in.
+      @format = format
     end
 
     def request_path
-      return unless node
-      # TODO: This `compact` makes me nervous. How can we handle this better?
-      lineage = node.parents.reverse.map(&:name).compact
-      file_name = [node.name, @ext].join
-      File.join("/", *lineage, file_name)
+      File.join("/", *lineage, request_filename)
     end
 
     def data
@@ -37,7 +35,7 @@ module Sitepress
     end
 
     def inspect
-      "<#{self.class}:#{object_id} request_path=#{request_path.inspect} asset_path=#{@asset.path.to_s.inspect}>"
+      "<#{self.class}:#{object_id} request_path=#{request_path.inspect} asset_path=#{asset.path.to_s.inspect}>"
     end
 
     def parent(**args)
@@ -60,6 +58,18 @@ module Sitepress
       resource.request_path == request_path
     end
 
+    # Used internally to construct paths from the current node up to the root node.
+    def lineage
+      @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.mime_type.media_type == RENDERABLE_MEDIA_TYPE
+    end
+
     private
     # Filters parent/child/sibling resources by a type. The default behavior is to only return
     # resources of the same type. For example given the pages `/a.html`, `/a.gif`, `/a/b.html`,
@@ -79,14 +89,29 @@ module Sitepress
       when :all
         nodes.map{ |node| node.formats }
       when :same
-        nodes.map{ |n| n.formats.ext(ext) }.flatten
-      when String
-        nodes.map{ |n| n.formats.ext(type) }.flatten
+        nodes.map{ |n| n.formats.get(format) }.flatten
+      when String, Symbol, NilClass
+        nodes.map{ |n| n.formats.get(type) }.flatten
       when MIME::Type
         nodes.map{ |n| n.formats.mime_type(type) }.flatten
       else
         raise ArgumentError, "Invalid type argument #{type}. Must be either :same, :all, an extension string, or a Mime::Type"
       end
     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
+        ""
+      elsif node.root? and format
+        "#{node.default_name}.#{format}"
+      elsif node.root?
+        node.default_name
+      elsif format.nil? or node.default_format == format
+        node.name
+      else
+        "#{node.name}.#{format}"
+      end
+    end
   end
 end

data/lib/sitepress/resources_pipeline.rb

@@ -4,7 +4,7 @@ module Sitepress
   # Processes a collection of resources
   class ResourcesPipeline < Array
     def process(resources)
-      each{ |processor| processor.process_resources resources }
+      each { |processor| processor.process_resources resources }
     end
   end
 end

data/lib/sitepress/site.rb

@@ -33,8 +33,8 @@ module Sitepress
     # A tree representation of the resourecs wthin the site. The root is a node that's
     # processed by the `resources_pipeline`.
     def root
-      ResourcesNode.new.tap do |node|
-        DirectoryCollection.new(assets: pages_assets, path: pages_path).mount(node)
+      Node.new.tap do |node|
+        source_node_mapper.mount node
         resources_pipeline.process node
       end
     end
@@ -42,12 +42,12 @@ module Sitepress
     # Returns a list of all the resources within #root.
     def resources
       with_resources_cache do
-        ResourceCollection.new(node: root, root_path: root_path)
+        ResourceCollection.new(node: root, root_path: pages_path)
       end
     end
 
     def clear_resources_cache
-      @_resources = nil
+      @resources = nil
     end
 
     # Root path to website project. Contains helpers, pages, and more.
@@ -64,6 +64,10 @@ module Sitepress
       root_path.join("helpers")
     end
 
+    def assets_path
+      root_path.join("assets")
+    end
+
     # Quick and dirty way to manipulate resources in the site without
     # creating classes that implement the #process_resources method.
     #
@@ -98,7 +102,7 @@ module Sitepress
     end
 
     # An array of procs that manipulate the tree and resources from the
-    # ResourceNode returned by #root.
+    # Node returned by #root.
     def resources_pipeline
       @resources_pipeline ||= ResourcesPipeline.new
     end
@@ -106,26 +110,11 @@ module Sitepress
     private
     def with_resources_cache
       clear_resources_cache unless cache_resources
-      @_resources ||= yield
+      @resources ||= yield
     end
 
-    # TODO: Move this into the DirectoryHandler class so that its not
-    # a concern of site.rb
-    # Exclude swap files created by Textmate and vim from being added
-    # to the sitemap.
-    SWAP_FILE_EXTENSIONS = [
-      "~",
-      ".swp"
-    ]
-
-    # Lazy stream of files that will be rendered by resources.
-    def pages_assets(glob = DEFAULT_GLOB)
-      # TODO: Move this into the DirectoryHandler class so that its not
-      # a concern of site.rb
-      paths = Dir.glob(pages_path.join(glob)).reject do |path|
-        File.directory? path or SWAP_FILE_EXTENSIONS.any? { |ext| path.end_with? ext }
-      end
-      paths.lazy.map { |path| Asset.new(path: path) }
+    def source_node_mapper
+      @source_node_mapper ||= SourceNodeMapper.new(path: pages_path)
     end
   end
 end

data/lib/sitepress/source_node_mapper.rb

@@ -0,0 +1,57 @@
+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

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "1.0.1".freeze
+  VERSION = "2.0.0.beta1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-core
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0.beta1
 platform: ruby
 authors:
 - Brad Gessler
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.99'
-description: 
+description:
 email:
 - bradgessler@gmail.com
 executables: []
@@ -75,23 +75,24 @@ extra_rdoc_files: []
 files:
 - lib/sitepress-core.rb
 - lib/sitepress/asset.rb
-- lib/sitepress/directory_collection.rb
 - lib/sitepress/extensions/layouts.rb
 - lib/sitepress/extensions/proc_manipulator.rb
 - lib/sitepress/formats.rb
 - lib/sitepress/frontmatter.rb
 - lib/sitepress/middleware/request_cache.rb
+- lib/sitepress/node.rb
+- lib/sitepress/path.rb
 - lib/sitepress/resource.rb
 - lib/sitepress/resource_collection.rb
-- lib/sitepress/resources_node.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: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,12 +103,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: An embeddable file-backed content management system.
 test_files: []

data/lib/sitepress/directory_collection.rb

@@ -1,24 +0,0 @@
-module Sitepress
-  # Maps a directory of assets into a set of routes that correspond with
-  # the `path` root.
-  class DirectoryCollection
-    attr_reader :assets, :path
-
-    def initialize(path: , assets:)
-      @path = path
-      @assets = assets
-    end
-
-    def mount(node)
-      assets.each { |a| node.add path: asset_path_to_request_path(a), asset: a }
-    end
-
-    private
-    # Given a @file_path of `/hi`, this method changes `/hi/there/friend.html.erb`
-    # to an absolute `/there/friend` format by removing the file extensions
-    def asset_path_to_request_path(asset)
-      # Relative path of resource to the file_path of this project.
-      asset.path.dirname.join(asset.format_basename).relative_path_from(path).to_s
-    end
-  end
-end

data/lib/sitepress/resources_node.rb

@@ -1,134 +0,0 @@
-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`,
-  # a tree of resource nodes would be built named `foo`, `bar`, `biz`, `buz`. `foo` would be the "root" node and `buz`
-  # a leaf node. The actual `buz.html` asset is then stored on the leaf node as a resource. This tree structure
-  # makes it possible to reason through path relationships from code to build out elements in a website like tree navigation.
-  class ResourcesNode
-    attr_reader :parent, :name
-
-    DELIMITER = "/".freeze
-
-    def initialize(parent: nil, delimiter: ResourcesNode::DELIMITER, name: nil)
-      @parent = parent
-      @name = name.freeze
-      @delimiter = delimiter.freeze
-    end
-
-    def formats
-      @formats ||= Formats.new(node: self)
-    end
-
-    # Returns the immediate children nodes.
-    def children
-      child_nodes.values
-    end
-
-    # Returns sibling nodes.
-    def siblings
-      parent ? parent.children.reject{ |c| c == self } : []
-    end
-
-    # Returns all parents up to the root node.
-    def parents
-      parents = []
-      node = parent
-      while node do
-        parents << node
-        node = node.parent
-      end
-      parents
-    end
-
-    def root?
-      parent.nil?
-    end
-
-    def leaf?
-      child_nodes.empty?
-    end
-
-    def flatten(resources: [])
-      formats.each{ |resource| resources << resource }
-      children.each do |child|
-        child.flatten.each{ |resource| resources << resource }
-      end
-      resources
-    end
-
-    def remove
-      if leaf?
-        # TODO: Check the parents to see if they also need to be removed if
-        # this call orphans the tree up to a resource.
-        parent.remove_child(name)
-      else
-        formats.clear
-      end
-    end
-
-    def add(path: , asset: )
-      head, *path = tokenize(path)
-      if path.empty?
-        # When there's no more paths, we're left with the format (e.g. ".html")
-        formats.add(asset: asset, ext: head)
-      else
-        child_nodes[head].add(path: path, asset: asset)
-      end
-    end
-    alias :[]= :add
-
-    def get(path)
-      *path, ext = tokenize(path)
-      node = dig(*path)
-      node.formats.ext(ext) if node
-    end
-
-    def get_node(path)
-      *path, _ = tokenize(path)
-      dig(*path)
-    end
-    alias :[] :get_node
-
-    def inspect
-      "<#{self.class}: formats=#{formats.map(&:request_path)} children=#{children.map(&:name).inspect}>"
-    end
-
-    # TODO: I don't really like how the path is broken up with the "ext" at the end.
-    # It feels inconsistent. Either make an object/struct that encaspulates this or
-    # just pass `index.html` through to the end.
-    def dig(*args)
-      head, *tail = args
-      if head.nil? and tail.empty?
-        self
-      elsif child_nodes.has_key?(head)
-        child_nodes[head].dig(*tail)
-      else
-        nil
-      end
-    end
-
-    protected
-    def remove_child(path)
-      *_, segment, _ = tokenize(path)
-      child_nodes.delete(segment)
-    end
-
-    private
-    def add_child_node(name)
-      ResourcesNode.new(parent: self, delimiter: @delimiter, name: name)
-    end
-
-    def child_nodes
-      @child_nodes ||= Hash.new { |hash, key| hash[key] = add_child_node(key) }
-    end
-
-    # Returns all of the names for the path along with the format, if set.
-    def tokenize(path)
-      return path if path.respond_to? :to_a
-      path, _, file = path.gsub(/^\//, "").rpartition(@delimiter)
-      ext = File.extname(file)
-      file = File.basename(file, ext)
-      path.split(@delimiter).push(file).push(ext)
-    end
-  end
-end