sitepress-core 2.0.0.beta4 → 2.0.0.beta9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa11bbd1b48f37ec8ac67ca5c7e097988dd3c3c5b15d4e8c286bc182bfccd005
-  data.tar.gz: e57cbd1a867e08e028c07d54a07a3b4212871202fe22f95680d70c7f62dab602
+  metadata.gz: 9a7a004d33fe5e05c2e1831ebcd902dc9c6bbcbf4650437b6e36984a1eb0e263
+  data.tar.gz: 9bd65a5f76ee6b166337887619e825c48c4580cb082448c63c8d78d1c549759b
 SHA512:
-  metadata.gz: 48b3f8cca37f6c6b5d6ebf97d5d90edac5cb318c8f0f2481ef5b36157f80cca9b566a4066d746e7061fe4158c8134914102339d40deae3eaf6292718745c7b26
-  data.tar.gz: 47b7cc455168355572800e2a95f7654838c7d86f17a3873317008d502f5c1e16afa19d896a80a84fb298db5e51c7ad760b17b713afcbde294e882001ad56564b
+  metadata.gz: 213d67af29c1e88c03f3ad72cb81001a2a938f418ca41717288f757581a409ec6daba877bdca903bb0a650c140d71e7252c113d2b4e0d9334b2e2726122ddb54
+  data.tar.gz: 68e40ac58a005c54262b050a3bc430eb3d2b81124705ce8aca39a87a3f0d07dd0fe9ab43283ead764c8afa9a00bf611fe6a903c2beb24d91b7eced7226b3ca7a

data/lib/sitepress-core.rb

@@ -17,7 +17,4 @@ module Sitepress
   autoload :ResourcesPipeline,    "sitepress/resources_pipeline"
   autoload :Site,                 "sitepress/site"
   autoload :SourceNodeMapper,     "sitepress/source_node_mapper"
-  module Middleware
-    autoload :RequestCache,       "sitepress/middleware/request_cache"
-  end
 end

data/lib/sitepress/asset.rb

@@ -17,41 +17,13 @@ module Sitepress
 
     extend Forwardable
     def_delegators :frontmatter, :data, :body
+    def_delegators :path, :handler, :node_name, :format, :exists?
 
     def initialize(path: , mime_type: nil)
       # 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
     end
 
     # Treat resources with the same request path as equal.
@@ -63,19 +35,22 @@ 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
-    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
+      def frontmatter
+        Frontmatter.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/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

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/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

@@ -6,7 +6,7 @@ module Sitepress
   # and may be altered by the resource proxy.
   class Resource
     extend Forwardable
-    def_delegators :asset, :mime_type
+    def_delegators :asset, :mime_type, :handler
 
     attr_writer :body, :data
     attr_reader :node, :asset, :format
@@ -14,8 +14,6 @@ module Sitepress
     # Default scope for querying parent/child/sibling resources.
     DEFAULT_FILTER_SCOPE = :same
 
-    RENDERABLE_MEDIA_TYPE = "text".freeze
-
     def initialize(asset:, node:, format: nil)
       @asset = asset
       @node = node
@@ -67,7 +65,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

@@ -14,26 +14,18 @@ module Sitepress
     attr_reader :root_path
     attr_writer :resources_pipeline
 
-    # Cache resources for production runs of Sitepress. Development
-    # modes don't cache to optimize for files reloading.
-    attr_accessor :cache_resources
-    alias :cache_resources? :cache_resources
-
     # TODO: Get rid of these so that folks have ot call site.resources.get ...
     extend Forwardable
     def_delegators :resources, :get, :glob
 
     def initialize(root_path: DEFAULT_ROOT_PATH)
       self.root_path = root_path
-      # When Site#resources is called, the results should be cached in production
-      # environments for performance reasons, but not in development environments.
-      self.cache_resources = false
     end
 
     # A tree representation of the resourecs wthin the site. The root is a node that's
     # processed by the `resources_pipeline`.
     def root
-      Node.new.tap do |node|
+      @root ||= Node.new.tap do |node|
         source_node_mapper.mount node
         resources_pipeline.process node
       end
@@ -41,13 +33,12 @@ module Sitepress
 
     # Returns a list of all the resources within #root.
     def resources
-      with_resources_cache do
-        ResourceCollection.new(node: root, root_path: pages_path)
-      end
+      @resources ||= ResourceCollection.new(node: root, root_path: pages_path)
     end
 
-    def clear_resources_cache
-      @resources = nil
+    def reload!
+      @resources = @root = nil
+      self
     end
 
     # Root path to website project. Contains helpers, pages, and more.
@@ -108,10 +99,6 @@ module Sitepress
     end
 
     private
-    def with_resources_cache
-      clear_resources_cache unless cache_resources
-      @resources ||= yield
-    end
 
     def source_node_mapper
       @source_node_mapper ||= SourceNodeMapper.new(path: pages_path)

data/lib/sitepress/source_node_mapper.rb

@@ -4,10 +4,11 @@ module Sitepress
   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.
+    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.
@@ -22,12 +23,13 @@ module Sitepress
 
     # Mounts the source files from the path to the given node.
     def mount(node)
-      paths.each do |path, name, format|
+      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(name).formats.add(format: format, asset: asset)
+          node.add_child(asset.node_name).formats.add(format: asset.format, asset: asset)
         end
       end
     end
@@ -37,21 +39,22 @@ module Sitepress
     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 ]
+          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 is_swap_file?(path)
-      SWAP_FILE_EXTENSIONS.any? { |ext| path.to_s.end_with? ext }
+    def matches_ignore_file_pattern?(path)
+      IGNORE_FILE_PATTERNS.any? { |pattern| path.fnmatch? pattern }
     end
   end
 end

data/lib/sitepress/version.rb

@@ -1,3 +1,3 @@
 module Sitepress
-  VERSION = "2.0.0.beta4".freeze
+  VERSION = "2.0.0.beta9".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.beta4
+  version: 2.0.0.beta9
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,6 @@ files:
 - 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
@@ -90,7 +89,8 @@ files:
 - lib/sitepress/version.rb
 - sitepress-core.gemspec
 homepage: https://github.com/sitepress/sitepress
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -107,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: An embeddable file-backed content management system.

data/lib/sitepress/middleware/request_cache.rb

@@ -1,26 +0,0 @@
-module Sitepress
-  module Middleware
-    # Reloads the Sitepress cache between requests if cache resources is enabled.
-    # This ensures that the Sitepress resources are loaded only once per request
-    # for development environments so that the site isn're reloaded per call. Used
-    # from the Rails app and from the stand-alone Sitepress server.
-    class RequestCache
-      def initialize(app, site:)
-        @app, @site = app, site
-      end
-
-      # Cache resources for the duration of the request, even if
-      # caching is disabled.
-      def call(env)
-        cache_resources = @site.cache_resources
-        begin
-          @site.cache_resources = true
-          @app.call env
-        ensure
-          @site.cache_resources = cache_resources
-          @site.clear_resources_cache unless @site.cache_resources
-        end
-      end
-    end
-  end
-end