sitepress-server 2.0.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c176021cf59c6299c842e43bbac69042450f429bfd5d11bf1f9df9c3a6f32818
-  data.tar.gz: f67f47d0b6c2dfe4d67d73de13428051191fc1e3b93b749ef26441edfd615022
+  metadata.gz: b7cac4ef1fbb512ba1885c8a465d38b977ce6fa0cbf1e9fecf4f92922b64a3b2
+  data.tar.gz: 5af9fce05af1b7adb1b913746603024c95dd2e25fcaa4a91e09501317c1e2ad7
 SHA512:
-  metadata.gz: e9d87521be924b21d5f36964a375ff4887780f2aabe00f727958770fd3553a3d1e30a645d4178377a61d3a95b577779cea0f4ed4bd516b1081091c234050831b
-  data.tar.gz: ed5a741569cd7efaba7b8ad266094663c3fccccad94dc10aba1d7a38692cbc07b59a61a4f35908954181f2c91c92fecad7be08a296435eeae3eeae7437678ce8
+  metadata.gz: f17f6a7115af95036560f8c7e249f6b4d940d14b3b2aacb9832ffe6bd47b21a34c331481bcffc4686738abd9e47d1e6edeefc8dd5f5e5bc66cb16434ee4d2ee2
+  data.tar.gz: 74a9be4bbaaf26b5871ed19e954577aa794062d35ca03dbbc1000e94e74b0301ca85a59c4757b4fc39ce6bb0b448de7d47c08b0c3608cbe6ae5fd8df6e224f93

data/lib/sitepress/server.rb

@@ -9,18 +9,41 @@ Bundler.require(*Rails.groups)
 # Configure the rails application.
 module Sitepress
   class Server < Rails::Application
-    # Paths unique to Sitepress
-    config.root = File.join(File.dirname(__FILE__), "../../rails")
+    # Control whether or not to display friendly error reporting messages
+    # in Sitepress. The development server turns this on an handles exception,
+    # while the compile and other environments would likely have this disabled.
+    config.enable_site_error_reporting = false
+
+    # When in a development environment, we'll want to reload the site between
+    # requests so we can see the latest changes; otherwise, load the site once
+    # and we're done.
+    config.enable_site_reloading = false
+
+    # Default to a development environment type of configuration, which would reload the site.
+    # This gets reset later depending on a preference in the `before_initialize` callback.
+    config.eager_load = true
+    config.cache_classes = true
 
-    # Boilerplate required to get Rails to boot.
-    config.eager_load = false # necessary to silence warning
-    config.cache_classes = false # reload everything since this is dev env.
+    config.before_initialize do
+      # Eager load classes, content, etc. to boost performance when site reloading is disabled.
+      config.eager_load = !config.enable_site_reloading
+
+      # Cache classes for speed in production environments when site reloading is disabled.
+      config.cache_classes = !config.enable_site_reloading
+    end
+
+    # Path that points the the Sitepress UI rails app; which displays routes, error messages.
+    # etc. to the user if `enable_site_error_reporting` is enabled.
+    config.root = File.join(File.dirname(__FILE__), "../../rails")
 
-    config.secret_key_base = SecureRandom.uuid    # Rails won't start without this
+    # Rails won't start without this.
+    config.secret_key_base = SecureRandom.uuid
 
-    # Setup routes
-    routes.append { root to: "site#show" }
-    routes.append { get "*resource_path", controller: "site", action: "show", as: :page, format: false }
+    # Setup routes. The `constraints` key is set to `nil` so the `SiteController` can
+    # treat a page not being found as an exception, which it then handles. If the constraint
+    # was set to the default, Sitepress would hand off routing back to rails if something isn't
+    # found and fail silently.
+    routes.append { sitepress_pages root: true, controller: "site", constraints: nil }
 
     # A logger without a formatter will crash when Sprockets is enabled.
     logger           = ActiveSupport::Logger.new(STDOUT)
@@ -48,4 +71,4 @@ module Sitepress
 end
 
 # Load the SassC template handler if SassC is installed as part of this stand-alone server.
-require_relative "sass_template_handlers" if defined? SassC::Engine
+require_relative "sass_template_handlers" if defined? SassC::Engine

data/rails/app/controllers/site_controller.rb

@@ -1,22 +1,13 @@
 class SiteController < ApplicationController
-  DEFAULT_SITE_LAYOUT = "layouts/layout".freeze
-
-  # Control whether or not to display friendly error reporting messages
-  # in Sitepress. The development server turns this on an handles exception,
-  # while the compile and other environments would likely have this disabled.
-  class_attribute :enable_sitepress_error_reporting, default: false
+  include Sitepress::SitePages
 
-  # When in a development environment, we'll want to reload the site between
-  # requests so we can see the latest changes; otherwise, load the site once
-  # and we're done.
-  class_attribute :enable_site_reloading, default: false
+  DEFAULT_SITE_LAYOUT = "layouts/layout".freeze
 
   # This `rescue_from` order is important; it must come before the
   # `include Sitepress::SitePages` statement; otherwise exceptions
   # won't be properly handled.
   rescue_from Exception, with: :sitepress_error
-
-  include Sitepress::SitePages
+  rescue_from Sitepress::ResourceNotFoundError, with: :page_not_found
 
   layout :site_layout
 
@@ -28,23 +19,26 @@ class SiteController < ApplicationController
   def sitepress_error(exception)
     raise exception unless has_error_reporting_enabled?
 
-    @title = "Sitepress error in #{current_page.asset.path}".html_safe
+    @title = "Error in resource #{current_page.asset.path}".html_safe
     @exception = exception
     render "error", layout: "sitepress", status: :internal_server_error
   end
 
   def page_not_found(exception)
     raise exception unless has_error_reporting_enabled?
+    not_found
+  end
 
-    @title = "Sitepress page #{params[:resource_path].inspect} not found"
-    render "page_not_found", layout: "sitepress", status: :not_found
+  def not_found
+    @title = "Could not find resource at #{request.path}"
+    render "not_found", layout: "sitepress", status: :not_found
   end
 
   def has_error_reporting_enabled?
-    self.class.enable_sitepress_error_reporting
+    Sitepress::Server.config.enable_site_error_reporting
   end
 
   def reload_site?
-    self.class.enable_site_reloading
+    Sitepress::Server.config.enable_site_reloading
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitepress-server
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.1.2
 platform: ruby
 authors:
 - Brad Gessler
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-02 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-test
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.1.2
 description:
 email:
 - bradgessler@gmail.com
@@ -54,7 +54,7 @@ files:
 - rails/app/helpers/application_helper.rb
 - rails/app/views/layouts/sitepress.html.erb
 - rails/app/views/site/error.html.erb
-- rails/app/views/site/page_not_found.html.erb
+- rails/app/views/site/not_found.html.erb
 - rails/public/_sitepress/images/logo.svg
 - rails/public/_sitepress/stylesheets/site.css
 - sitepress-server.gemspec
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Sitepress rack app for stand-alone of embedded usage.