sitepress-rails 1.0.0 → 2.0.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b8d7a0d3d0bf5537540444e469a6a2d1240d27a198d5d7de3b12eee16987974
-  data.tar.gz: 5994a7fe8f40b317b990b488a5b434c1b84366b85baf7daa29de02485d628e3e
+  metadata.gz: 135962bb8c744104c2119d592dc46d33d3bf86d1f0138f9cc8484416770f776d
+  data.tar.gz: f9ec3cea5fb45637deef576515ecf039f943087d29c7d6255e2bf98070f7ede5
 SHA512:
-  metadata.gz: 43b0db4a564944e11f22c4092ebef89a48bef5ed196927b32309f56b848446fd4a230f04b7473026d4b68164f5cb122957671acc7acfc86532e3f7e273510e90
-  data.tar.gz: cfdac0511e6288950e9ab0218e0095012436bf511af57f5f7ee00cec22af5269dfc8588153ed6829038a6c08eebce89de5bd0750d47eba14e16bcd034457b3a2
+  metadata.gz: 8daefdf6dde16ba78128f812aa1d8fa2e0fc5cf0feeb639844207236d9226231925b7915908d1f31895eb306eabeae54c2c37a5e3e2026cd078b4745754128f7
+  data.tar.gz: af534c613a3d31f8dd7e61a7dd131bf01b71cd5915fe9b2ae2876b184ef9f68c715075d40d450fc7e07728c5779150bbbedf5224f07403859ca9fa8a48fb70e5

data/.gitignore

@@ -0,0 +1,7 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/

data/README.md

@@ -25,7 +25,7 @@ mount Sitepress::Engine => "/"
 Create the `app/content/pages` in your rails project:
 
 ```bash
-$ mkdir app/content/pages
+$ mkdir -p app/content/pages
 ```
 
 Then add pages to the `app/content/pages` directory:

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/sitepress-rails/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

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,22 +1,54 @@
+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 root of the engine to the gems rails directory.
+    config.root = File.expand_path("../../rails", __dir__)
+
+    # 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.
+    ]
+
+    # 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

data/lib/sitepress/renderers/controller.rb

@@ -0,0 +1,51 @@
+module Sitepress
+  module Renderers
+    class Controller
+      attr_reader :controller, :page
+
+      def initialize(page, controller = SiteController)
+        @controller = controller
+        @page = page
+      end
+
+      def render
+        renderer.render inline: page.body,
+          type: page.asset.template_extensions.last,
+          layout: resolve_layout,
+          content_type: page.mime_type.to_s
+      end
+
+      private
+        def layout
+          controller._layout
+        end
+
+        def has_layout_conditions?
+          controller._layout_conditions?
+        end
+
+        def layout_conditions
+          controller._layout_conditions
+        end
+
+        def renderer
+          controller.renderer.new("PATH_INFO" => page.request_path)
+        end
+
+        def resolve_layout
+          return page.data.fetch("layout") if page.data.key? "layout"
+          return layout unless has_layout_conditions?
+
+          clause, formats = layout_conditions.first
+          format = page.format.to_s
+
+          case clause
+          when :only
+            layout if formats.include? format
+          when :except
+            layout if formats.exclude? format
+          end
+        end
+    end
+  end
+end

data/lib/sitepress/renderers/server.rb

@@ -0,0 +1,25 @@
+module Sitepress
+  module Renderers
+    class Server
+      attr_reader :rails_app, :page
+
+      def initialize(page, rails_app = Rails.application)
+        @rails_app = rails_app
+        @page = page
+      end
+
+      def render
+        code, headers, response = rails_app.routes.call env
+        response.body
+      end
+
+      def env
+        {
+          "PATH_INFO"=> page.request_path,
+          "REQUEST_METHOD"=>"GET",
+          "rack.input" => "GET"
+        }
+      end
+    end
+  end
+end

data/{app → rails/app}/controllers/concerns/sitepress/site_pages.rb

@@ -7,12 +7,16 @@ module Sitepress
     # 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
@@ -21,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
@@ -40,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.
@@ -53,9 +76,23 @@ 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
+
+    # 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
@@ -74,8 +111,12 @@ module Sitepress
 
       if layout.instance_of? String # Rails 4 and 5 return a string from above.
         layout
-      else # Rails 3 and older return an object that gives us a file name
+      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