sitepress-rails 0.1.27 → 2.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 027cfbb8b2287f8ed5c2da1368cfc75821b3d9c2
-  data.tar.gz: c0ee867a1293ff9ffed5aaa150df8d491bbc4f4c
+SHA256:
+  metadata.gz: ef7991baba77ba1d9f5686ec4f8570e60b9ecfbd4d56c9daf0af7a4eef835cfa
+  data.tar.gz: 20c870b3d71fb594dbc8c904a74a084d8b67c90b4f5c2f7f7b02c71be69b1ce1
 SHA512:
-  metadata.gz: b5f4109ea391c4f76fc5b71b892a973964e56f9bf9e25f4738c69fb8bdb99fd027e5576df7051be35e77fad1a43c5de815eebfcb2c6864306b4fab9c900072ec
-  data.tar.gz: e990a3321275c5d4e2edf96bdac2f2f92049f5449cb2e397b0b5c623851d89669fcefb736c8ce53d41c5d37c2709a7cf7f4064fa6125327f1bde4babea767b8e
+  metadata.gz: d4b6f85510e7fe4078679203d2f86ac04ac22428463714ce236f06220513443fa64998598c35ac5fdbd6494ff7547743dd4b0539d48d04824e8c775a638d07dc
+  data.tar.gz: 16174ec324144ffa5b3b3ea8bc67a93c724713af7a4269a48859653d2cab09db366dd597d0fce3c5fd4418b1948687a79d61e89077b0d04475f1d25d2c0a42d9

data/README.md

@@ -22,10 +22,16 @@ Then mount the engine into your `config/routes.rb` file:
 mount Sitepress::Engine => "/"
 ```
 
-Then add pages to the `app/views/pages` directory:
+Create the `app/content/pages` in your rails project:
 
 ```bash
-$ echo "<h1>Hello</h1><p>It is <%= Time.now %> o'clock</p>" > app/views/pages/hello.html.erb
+$ mkdir -p app/content/pages
+```
+
+Then add pages to the `app/content/pages` directory:
+
+```bash
+$ echo "<h1>Hello</h1><p>It is <%= Time.now %> o'clock</p>" > app/content/pages/hello.html.erb
 ```
 
 Point your browser to `http://127.0.0.1:3000/hello` and if all went well you should see the page you just created.

data/app/controllers/concerns/sitepress/site_pages.rb

@@ -3,12 +3,20 @@ module Sitepress
   # Sitepress::SiteController, but may be included into other controllers for static
   # page behavior.
   module SitePages
+    # Rails 5 requires a format to be given to the private layout method
+    # to return the path to the layout.
+    DEFAULT_PAGE_RAILS_FORMATS = [:html].freeze
+
+    # Default root path of resources.
+    ROOT_RESOURCE_PATH = "".freeze
+
     extend ActiveSupport::Concern
 
     included do
       rescue_from Sitepress::PageNotFoundError, with: :page_not_found
       helper Sitepress::Engine.helpers
       helper_method :current_page, :site
+      before_action :append_relative_partial_path, only: :show
     end
 
     def show
@@ -17,14 +25,15 @@ module Sitepress
 
     protected
     def render_page(page)
-      render inline: page.body,
-        type: page.asset.template_extensions.last,
-        layout: page.data.fetch("layout", controller_layout),
-        content_type: page.mime_type.to_s
+      if page.renderable?
+        render_text_resource page
+      else
+        send_binary_resource page
+      end
     end
 
     def current_page
-      @_current_page ||= find_resource
+      @current_page ||= find_resource
     end
 
     def site
@@ -36,6 +45,24 @@ module Sitepress
     end
 
     private
+    def append_relative_partial_path
+      append_view_path current_page.asset.path.dirname
+    end
+
+    def render_text_resource(resource)
+      with_sitepress_render_cache do
+        render inline: resource.body,
+          type: resource.asset.template_extensions.last,
+          layout: resource.data.fetch("layout", controller_layout),
+          content_type: resource.mime_type.to_s
+      end
+    end
+
+    def send_binary_resource(resource)
+      send_file resource.asset.path,
+        disposition: :inline,
+        type: resource.mime_type.to_s
+    end
 
     # Sitepress::PageNotFoundError is handled in the default Sitepress::SiteController
     # with an execption that Rails can use to display a 404 error.
@@ -49,18 +76,62 @@ module Sitepress
       end
     end
 
-    # Default finder of the resource for the current controller context.###
+    # Default finder of the resource for the current controller context. If the :resource_path
+    # isn't present, then its probably the root path so grab that.
     def find_resource
-      get params[:resource_path]
+      get params.fetch(:resource_path, ROOT_RESOURCE_PATH)
     end
 
-    # Returns the current layout for the inline Sitepress renderer.
+    # When development environments disable the cache, we still want to turn it
+    # on during rendering so that view doesn't rebuild the site on each call.
+    def with_sitepress_render_cache(&block)
+      cache_resources = site.cache_resources
+      begin
+        site.cache_resources = true
+        yield
+      ensure
+        site.cache_resources = cache_resources
+        site.clear_resources_cache unless site.cache_resources
+      end
+    end
+
+    # Returns the current layout for the inline Sitepress renderer. This is
+    # exposed via some really convoluted private methods inside of the various
+    # versions of Rails, so I try my best to hack out the path to the layout below.
     def controller_layout
-      layout = self.send(:_layout)
-      if layout.instance_of? String
+      private_layout_method = self.method(:_layout)
+      layout =
+        if Rails.version >= "6"
+          private_layout_method.call lookup_context, current_page_rails_formats
+        elsif Rails.version >= "5"
+          private_layout_method.call current_page_rails_formats
+        else
+          private_layout_method.call
+        end
+
+      if layout.instance_of? String # Rails 4 and 5 return a string from above.
         layout
-      else
+      elsif layout # Rails 3 and older return an object that gives us a file name
         File.basename(layout.identifier).split('.').first
+      else
+        # If none of the conditions are met, then no layout was
+        # specified, so nil is returned.
+        nil
+      end
+    end
+
+    # Rails 5 requires an extension, like `:html`, to resolve a template. This
+    # method returns the intersection of the formats Rails supports from Mime::Types
+    # and the current page's node formats. If nothing intersects, HTML is returned
+    # as a default.
+    def current_page_rails_formats
+      extensions = current_page.node.formats.extensions
+      supported_extensions = extensions & Mime::EXTENSION_LOOKUP.keys
+
+      if supported_extensions.empty?
+        DEFAULT_PAGE_RAILS_FORMATS
+      else
+        supported_extensions.map?(&:to_sym)
       end
     end
   end

data/app/controllers/sitepress/site_controller.rb

@@ -1,5 +1,5 @@
 module Sitepress
-  class SiteController < ::ApplicationController
+  class SiteController < ActionController::Base
     # Extracted into a module because other controllers may need
     # to be capable of serving Sitepress pages.
     include Sitepress::SitePages

data/config/routes.rb

@@ -2,6 +2,11 @@ Sitepress.configuration.parent_engine.routes.draw do
   if Sitepress.configuration.routes
     constraints Sitepress::RouteConstraint.new do
       get "*resource_path", controller: "sitepress/site", action: "show", as: :page, format: false
+      if has_named_route? :root
+        Rails.logger.warn 'Sitepress tried to configure `root to: "sitepress/site#show"`, but a root route was already defined.'
+      else
+        root to: "sitepress/site#show"
+      end
     end
   end
 end

data/lib/sitepress/build_paths/directory_index_path.rb

@@ -0,0 +1,12 @@
+module Sitepress
+  module BuildPaths
+    # In many cases, you'll want to serve up `pages/blah.html.haml` as `/blah` on
+    # hosts like S3. To achieve this effect, we have to compile `pages/blah.html.haml`
+    # to a folder with the filename `index.html`, so the final path would be `/blah/index.html`
+    class DirectoryIndexPath < IndexPath
+      def path_with_default_format
+        File.join(node.name, "#{node.default_name}.#{format}")
+      end
+    end
+  end
+end

data/lib/sitepress/build_paths/index_path.rb

@@ -0,0 +1,20 @@
+module Sitepress
+  module BuildPaths
+    # Compiles pages directly from `/pages/blah.html.haml` to `/blah.html`. Handles root `index`
+    # pages too, mainly grabbing the root, which doesn't have a name in the node, to the default_name
+    # of the node, which is usually `index`.
+    class IndexPath < RootPath
+      def path_without_format
+        node.name
+      end
+
+      def path_with_format
+        "#{node.name}.#{format}"
+      end
+
+      def path_with_default_format
+        path_with_format
+      end
+    end
+  end
+end

data/lib/sitepress/build_paths/root_path.rb

@@ -0,0 +1,40 @@
+module Sitepress
+  module BuildPaths
+    # Compiles pages directly from `/pages/blah.html.haml` to `/blah.html`. Handles root `index`
+    # pages too, mainly grabbing the root, which doesn't have a name in the node, to the default_name
+    # of the node, which is usually `index`.
+    class RootPath
+      attr_reader :resource
+
+      extend Forwardable
+      def_delegators :resource, :node, :format
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def path
+        if format.nil?
+          path_without_format
+        elsif format == node.default_format
+          path_with_default_format
+        elsif format
+          path_with_format
+        end
+      end
+
+      protected
+      def path_without_format
+        node.default_name
+      end
+
+      def path_with_format
+        "#{node.default_name}.#{format}"
+      end
+
+      def path_with_default_format
+        path_with_format
+      end
+    end
+  end
+end

data/lib/sitepress/compiler.rb

@@ -0,0 +1,68 @@
+require "pathname"
+require "fileutils"
+
+module Sitepress
+  # Compile all resources from a Sitepress site into static pages.
+  class Compiler
+    include FileUtils
+
+    class ResourceCompiler
+      attr_reader :resource
+
+      def initialize(resource)
+        @resource = resource
+      end
+
+      def compilation_path
+        File.join(*resource.lineage, compilation_filename)
+      end
+
+      # Compiled assets have a slightly different filename for assets, especially the root node.
+      def compilation_filename(path_builder: BuildPaths::DirectoryIndexPath, root_path_builder: BuildPaths::RootPath)
+        path_builder = resource.node.root? ? root_path_builder : path_builder
+        path_builder.new(resource).path
+      end
+
+      def render(page)
+        Renderers::Server.new(resource).render
+      end
+    end
+
+    attr_reader :site
+
+    def initialize(site:, stdout: $stdout)
+      @site = site
+      @stdout = stdout
+    end
+
+    # Iterates through all pages and writes them to disk
+    def compile(target_path:)
+      target_path = Pathname.new(target_path)
+      mkdir_p target_path
+      cache_resources = @site.cache_resources
+      @stdout.puts "Compiling #{@site.root_path.expand_path}"
+
+      begin
+        @site.cache_resources = true
+        @site.resources.each do |resource|
+          compiler = ResourceCompiler.new(resource)
+          path = target_path.join(compiler.compilation_path)
+          mkdir_p path.dirname
+          if resource.renderable?
+            @stdout.puts "  Rendering #{path}"
+            File.open(path.expand_path, "w"){ |f| f.write compiler.render(resource) }
+          else
+            @stdout.puts "  Copying #{path}"
+            FileUtils.cp resource.asset.path, path.expand_path
+          end
+        rescue => e
+          @stdout.puts "Error compiling #{resource.inspect}"
+          raise
+        end
+        @stdout.puts "Successful compilation to #{target_path.expand_path}"
+      ensure
+        @site.cache_resources = cache_resources
+      end
+    end
+  end
+end

data/lib/sitepress/engine.rb

@@ -1,28 +1,51 @@
+require "rails/engine"
+
 module Sitepress
   class Engine < ::Rails::Engine
-    config.before_configuration do |app|
-      Sitepress.configure do |config|
-        app.paths["app/helpers"].push config.site.root_path.join("helpers")
-        app.paths["app/assets"].push config.site.root_path.join("assets")
-        app.paths["app/views"].push config.site.root_path
-      end
+    # Set the path for the site configuration file.
+    paths.add "config/site.rb", with: [
+      File.expand_path("./config/site.rb"), # When Sitepress is launched via `sitepress server`.
+      "config/site.rb"                      # When Sitepress is launched embedded in Rails project.
+    ]
 
-      # Setup concerns paths for Rails 4 (doesn't automatically populate)
-      concerns_path = "app/controllers/concerns"
-      unless app.paths.keys.include?(concerns_path)
-        app.paths.add(concerns_path)
-      end
+    # Load the `config/site.rb` file so users can configure Sitepress.
+    initializer :load_sitepress_file, before: :set_sitepress_paths do
+      site_file = paths["config/site.rb"].existent.first
+      load site_file if site_file
+    end
+
+    # Load paths from `Sitepress#site` into rails so it can render views, helpers, etc. properly.
+    initializer :set_sitepress_paths, before: :set_autoload_paths do |app|
+      app.paths["app/helpers"].push site.helpers_path.expand_path
+      app.paths["app/views"].push site.root_path.expand_path
+      app.paths["app/views"].push site.pages_path.expand_path
     end
 
-    initializer "sitepress.configure" do |app|
-      Sitepress.configure do |config|
-        config.parent_engine = app
-        config.cache_resources = app.config.cache_classes
+    # Configure sprockets paths for the site.
+    initializer :set_asset_paths, before: :append_assets_path do |app|
+      manifest_file = sitepress_configuration.manifest_file_path.expand_path
+
+      if manifest_file.exist?
+        app.paths["app/assets"].push site.assets_path.expand_path
+        app.config.assets.precompile << manifest_file.to_s
+      else
+        Rails.logger.warn "WARNING: Sitepress could not enable Sprockets because it could not find a manifest file at #{manifest_file.to_s.inspect}."
       end
     end
 
-    initializer "sitepress.middleware" do |app|
-      app.middleware.use Sitepress::Middleware::RequestCache, site: Sitepress.site
+    # Configure Sitepress with Rails settings.
+    initializer :configure_sitepress do |app|
+      sitepress_configuration.parent_engine = app
+      sitepress_configuration.cache_resources = app.config.cache_classes
+    end
+
+    private
+    def sitepress_configuration
+      Sitepress.configuration
+    end
+
+    def site
+      sitepress_configuration.site
     end
   end
 end

data/lib/sitepress/rails.rb

@@ -1,19 +1,21 @@
 require "sitepress-core"
 
 module Sitepress
-  # Contains singletons for rails and some configuration data.
-  Configuration = Struct.new(:site, :routes, :parent_engine)
-
-  # Rescued by ActionController to display page not found error.
-  PageNotFoundError = Class.new(StandardError)
-
+  autoload :Compiler,                 "sitepress/compiler"
   autoload :RailsConfiguration,       "sitepress/rails_configuration"
   autoload :RouteConstraint,          "sitepress/route_constraint"
-  module Extensions
-    autoload :RailsRequestPaths,      "sitepress/extensions/rails_request_paths"
-    autoload :PartialsRemover,        "sitepress/extensions/partials_remover"
-    autoload :IndexRequestPath,       "sitepress/extensions/index_request_path"
+  module Renderers
+    autoload :Controller,             "sitepress/renderers/controller"
+    autoload :Server,                 "sitepress/renderers/server"
   end
+  module BuildPaths
+    autoload :RootPath,               "sitepress/build_paths/root_path"
+    autoload :IndexPath,              "sitepress/build_paths/index_path"
+    autoload :DirectoryIndexPath,     "sitepress/build_paths/directory_index_path"
+  end
+
+  # Rescued by ActionController to display page not found error.
+  PageNotFoundError = Class.new(StandardError)
 
   # Make site available via Sitepress.site from Rails app.
   def self.site

data/lib/sitepress/rails_configuration.rb

@@ -6,13 +6,13 @@ module Sitepress
     # Store in ./app/content by default.
     DEFAULT_SITE_ROOT = "app/content".freeze
 
-    attr_accessor :site, :parent_engine, :routes, :cache_resources
+    attr_accessor :routes
+    attr_writer :site, :parent_engine
 
     # Delegates configuration points into the Sitepress site.
     extend Forwardable
     def_delegators :site, :cache_resources, :cache_resources=, :cache_resources?
 
-    # Set defaults.
     def initialize
       self.routes = true
     end
@@ -22,10 +22,12 @@ module Sitepress
     end
 
     def site
-      @site ||= Site.new(root_path: default_root).tap do |site|
-        site.resources_pipeline << Extensions::PartialsRemover.new
-        site.resources_pipeline << Extensions::RailsRequestPaths.new
-      end
+      @site ||= Site.new(root_path: default_root)
+    end
+
+    # Location of Sprockets manifest file
+    def manifest_file_path
+      site.assets_path.join("config/manifest.js")
     end
 
     private