sitepress-rails 3.2.1 → 4.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4c6f67b8fd7c3173f8f6144d327e76047ec2bb556a52691e2f7001d41c4aafa
-  data.tar.gz: ca98a7dd5f7ea3e0328d6c4da8223f090e86157c876292eb553a5828909b85a6
+  metadata.gz: c12aa71c76b0e53a1ddf4ca1b6be9e0e097218bc76f801038b35d390bf509d3c
+  data.tar.gz: '02858bb77cd06f142c9a19cc9c8a072d11491b97175757ad0f8daf8859c230a8'
 SHA512:
-  metadata.gz: fa22362aede0571c4dcf36ce1a4c499ff199deb64e3103cd3aca297ef80e14fcb83bc4d1d875daef045ddaebef0b4b966136c08f350e46bbcfed74944039297b
-  data.tar.gz: fbddd930589050bafa8f3cc45d2a8348c90d03fe0b23b489e649abd0894b0e6492086c63c31469553d2419c7a2c8ef772f6baa26dc189e85d60952dae34b6d9f
+  metadata.gz: a31246d3285899bea7595cde279624bc2e3894a211a274c491e834054a9d00ffbd53389a5fcd6e8c7d9c7539405df785289a4438cd7c5ca09a879c005f763185
+  data.tar.gz: a11e604a709e8dbea31410df7f6be34690bd61dc05aa22cee2c6d8dcc57008a75d1c0a02ce2f07a0483dc5b8b2ed3177f54cf27c90aca4f20cc19861488fb24b

data/lib/sitepress/compiler.rb

@@ -2,67 +2,117 @@ require "pathname"
 require "fileutils"
 
 module Sitepress
-  # Compile all resources from a Sitepress site into static pages.
-  class Compiler
-    include FileUtils
-
-    attr_reader :site, :root_path
-
-    # If a resource can't render, it will raise an exception and stop the compiler. Sometimes
-    # its useful to turn off errors so you can get through a full compilation and see how many
-    # errors you encounter along the way. To do that, you'd set `raise_exception_on_error` to
-    # `false` and the compile will get through all the resources.
-    attr_accessor :raise_exception_on_error
-
-    def initialize(site:, root_path:, stdout: $stdout, raise_exception_on_error: true)
-      @site = site
-      @stdout = stdout
-      @root_path = Pathname.new(root_path)
-      @raise_exception_on_error = raise_exception_on_error
+  module Compiler
+    class Abstract
+      include Enumerable
+
+      attr_reader :site, :failed, :succeeded
+
+      # If a resource can't render, it will raise an exception and stop the compiler. Sometimes
+      # its useful to turn off errors so you can get through a full compilation and see how many
+      # errors you encounter along the way. To do that, you'd set `fail_on_error` to
+      # `false` and the compile will get through all the resources.
+      attr_accessor :fail_on_error
+
+      def initialize(site:, stdout: $stdout, fail_on_error: false)
+        @site = site
+        @stdout = stdout
+        @fail_on_error = fail_on_error
+        @failed = []
+        @succeeded = []
+      end
+
+      # Iterates through all pages and writes them to disk
+      def compile
+        before_compile
+        each do |resource, *args, **kwargs|
+          if resource.renderable?
+            render_resource(resource, *args, **kwargs)
+          else
+            copy_resource(resource, *args, **kwargs)
+          end
+          @succeeded << resource
+        rescue
+          status "Error building #{resource.inspect}"
+          @failed << resource
+          raise if fail_on_error
+        end
+        after_compile
+      end
+
+      def each(&block)
+        site.resources.each(&block)
+      end
+
+      protected
+        def copy_resource(resource, *args, **kwargs)
+          raise NotImplementedError
+        end
+
+        def render_resource(resource, *args, **kwargs)
+          raise NotImplementedError
+        end
+
+        def before_compile
+          status "Building #{site.root_path.expand_path}"
+        end
+
+        def after_compile
+          status "Built #{site.root_path.expand_path}"
+        end
+
+        def render(resource)
+          Renderers::Server.new(resource).render
+        end
+
+        def status(message)
+          @stdout.puts message
+        end
     end
 
-    # Iterates through all pages and writes them to disk
-    def compile
-      status "Building #{site.root_path.expand_path} to #{root_path.expand_path}"
-      resources.each do |resource, path|
-        if resource.renderable?
+    # Compile all resources from a Sitepress site into static pages.
+    class Files < Abstract
+      include FileUtils
+
+      attr_reader :root_path
+
+      def initialize(*args, root_path:, **kwargs, &block)
+        super(*args, **kwargs, &block)
+        @root_path = Pathname.new(root_path)
+      end
+
+      protected
+        def render_resource(resource, path)
           status "Rendering #{path}"
           File.open(path.expand_path, "w"){ |f| f.write render resource }
-        else
+        end
+
+        def copy_resource(resource, path)
           status "Copying #{path}"
           cp resource.asset.path, path.expand_path
         end
-      rescue
-        status "Error building #{resource.inspect}"
-        raise if raise_exception_on_error
-      end
-      status "Successful build to #{root_path.expand_path}"
-    end
 
-    private
-      def resources
-        Enumerator.new do |y|
+        def before_compile
           mkdir_p root_path
+          status "Building #{site.root_path.expand_path} to #{root_path.expand_path}"
+        end
 
+        def after_compile
+          status "Build at #{root_path.expand_path}"
+        end
+
+        def each
           site.resources.each do |resource|
             path = build_path resource
             mkdir_p path.dirname
-            y << [resource, path]
+            yield resource, path
           end
         end
-      end
-
-      def build_path(resource)
-        path_builder = resource.node.root? ? BuildPaths::RootPath : BuildPaths::DirectoryIndexPath
-        root_path.join path_builder.new(resource).path
-      end
 
-      def render(resource)
-        Renderers::Server.new(resource).render
-      end
-
-      def status(message)
-        @stdout.puts message
-      end
+        def build_path(resource)
+          path_builder = resource.node.root? ? BuildPaths::RootPath : BuildPaths::DirectoryIndexPath
+          root_path.join path_builder.new(resource).path
+        end
+    end
   end
 end

data/lib/sitepress/rendition.rb

@@ -3,9 +3,9 @@ module Sitepress
   # lets us keep the functions in the controller more functional, which makes them
   # easier to override by the end users.
   class Rendition
-    attr_accessor :resource, :output, :controller_layout
+    attr_accessor :resource, :output, :layout
 
-    def initialize(resource)
+    def initialize(resource, layout: nil)
       @resource = resource
     end
 
@@ -22,7 +22,7 @@ module Sitepress
     end
 
     def layout
-      resource.data.fetch("layout", controller_layout)
+      resource.data.fetch("layout", @layout)
     end
   end
 end

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

@@ -17,7 +17,7 @@ module Sitepress
     included do
       rescue_from Sitepress::ResourceNotFound, with: :resource_not_found
       helper Sitepress::Engine.helpers
-      helper_method :current_page, :site
+      helper_method :current_page, :site, :page_rendition
       before_action :append_relative_partial_path, only: :show
       around_action :ensure_site_reload, only: :show
     end
@@ -41,16 +41,25 @@ module Sitepress
       end
     end
 
+    # Renders the markup within a resource that can be rendered.
+    def page_rendition(resource, layout: nil)
+      Rendition.new(resource).tap do |rendition|
+        rendition.layout = layout
+        pre_render rendition
+      end
+    end
+
     # If a resource has a handler (e.g. erb, haml, etc.) we use the Rails renderer to
     # process templates, layouts, partials, etc. To keep the whole rendering process
     # contained in a way that the end user can override, we coupled the resource, source
     # and output within a `Rendition` object so that it may be processed via hooks.
     def render_resource_with_handler(resource)
-      rendition = Rendition.new(resource)
-      rendition.controller_layout = controller_layout
+      rendition = page_rendition(resource, layout: controller_layout)
 
-      pre_render rendition
+      # Fire a callback in the controller in case anybody needs it.
       process_rendition rendition
+
+      # Now we finally render the output of the processed rendition to the client.
       post_render rendition
     end
 
@@ -162,13 +171,13 @@ module Sitepress
     # and the current page's node formats. If nothing intersects, HTML is returned
     # as a default.
     def current_resource_rails_formats
-      extensions = current_resource.node.formats.extensions
-      supported_extensions = extensions & Mime::EXTENSION_LOOKUP.keys
+      node_formats = current_resource.node.formats
+      supported_formats = node_formats & Mime::EXTENSION_LOOKUP.keys
 
-      if supported_extensions.empty?
+      if supported_formats.empty?
         DEFAULT_PAGE_RAILS_FORMATS
       else
-        supported_extensions.map?(&:to_sym)
+        supported_formats.map?(&:to_sym)
       end
     end