nesta 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e80fef7e8fe518a674eb7527d91410d162fca8288985971e641a3329ae192eef
-  data.tar.gz: bc6f671dc4f0ae10b403fa53b489f06c74ae8e9c6560ae49e08dc2518185dc22
+  metadata.gz: e14e3ed99700277225c068df787864f52f19385f08469d91bf1a8f4073e24568
+  data.tar.gz: 84e9c0fb31ba8b380b0ce86f9edc6f660fd8a8f9474ad28400e7c921fd745c01
 SHA512:
-  metadata.gz: 857872073a0ea318df15323bd0f9a64de0104106b45c0c749a2261e266866abc0dd38f475fa98de07fb9cb09ee41411b837ec91a1e7d581bb1924f697557184d
-  data.tar.gz: 828a24e35350cfae15ff093f42a67a6ee33faf48435b0e0d9ff831e3e5a1592b2e22db2910442eb39adc7642f5b3f451224dcf8f49fcc11d7a062e7a48f4b47c
+  metadata.gz: e39c4ada00a1ac3b4be18b6887240a670d4f1c050023771dc71fa6703bbb315bac54f959053788dc7018761a5bfc3e1fe387486e856629a785ae3098c8203704
+  data.tar.gz: 4da9e195b6679df8c9f2c9ec3a07b780409b2a68f6cffe66feab9276a0ee90b987b7221a13d5f363c0b700c3d5b8d956e9b6a5753a0aa81058e1e10458ced75f

data/.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "head"]
+        ruby: ["2.7", "3.0", "3.1", "3.2", "head"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

data/.gitignore

@@ -6,6 +6,7 @@
 /.rbenv-version
 /.ruby-version
 /.rvmrc
+/checksums
 /config/config.yml
 /config/deploy.rb
 /db/*.db

data/CHANGES

@@ -1,3 +1,76 @@
+= 0.14.0 / (23 March 2023)
+
+ * Nesta can now be used as a Static Site Generator (SSG) with its new
+   `nesta build` command! Server Side Rendering (SSR) is still supported,
+   as is development with a local web server.
+
+   Back in the days when Heroku allowed us to deploy Nesta on their
+   platform for free, there really didn't seem to be any point in
+   converting a site to a bunch of static HTML and CSS files. If you
+   enabled the appropriate HTTP cache-control headers, Heroku would
+   automatically cache an entire site in memory, so there was no real
+   performance benefit. That's why Nesta never had SSG support, even
+   though everybody seemed to think it was cool.
+
+   But Heroku is not free any more. And there's a wide choice of hosting
+   platforms for static site generators. So why not?
+
+   See the docs for full details, but in short:
+
+   - If you run `bundle exec nesta build`, Nesta will generate a static
+     copy of your site in a ./dist directory.
+
+   - You might want to add ./dist to your .gitignore file.
+
+   - There are a couple of new config settings in config.yml.
+
+   - You can configure hosting platforms like Netlify, AWS Amplify,
+     Vercel (and others) to redeploy your site by running the build
+     command when you push changes to your git repository.
+
+   This was fun to implement. (Graham Ashton)
+
+ * Sass and SCSS files are now rendered with Dart Sass (the main implementation
+   of Sass). We had been using the (now deprecated) libsass library.
+
+   Sass has changed a bit since libsass was current, so you may need to make
+   some small changes to your stylesheets. Documentation that should help with
+   those changes can be found here:
+
+   https://sass-lang.com/documentation/breaking-changes
+
+ * Replace Nesta's custom template-locating code with Sinatra's #find_template
+   method. (Graham Ashton, suggested by Lilith River)
+
+ * Update multiple dependencies to fix security vulnerabilities; see commit
+   history for details. (Graham Ashton)
+
+ * Built-in support for configuring Nesta via environment variables has been
+   dropped. (Graham Ashton)
+
+   Should you still want to configure Nesta via the environment you can
+   use Erb in `config.yml`, like this:
+
+       some_value: <%= ENV.fetch('NESTA_VARIABLE') %>
+
+ * During a tidy up of the config file code, the `yaml_conf` attribute on
+   the Nesta::Config class has been renamed to `config`. This is unlikely
+   to affect you, but if it does just change the name. (Graham Ashton)
+
+ * The `yaml_path` attribute on the Nesta::Config class has been moved
+   to `Nesta::ConfigFile.path`. Again, I can't imagine why anybody would
+   have written code that used it, but it's a breaking change so I'm
+   mentioning it. (Graham Ashton)
+
+ * Support for loading plugins from a local directory (which was deprecated
+   in version 0.9.10) has been removed. (Graham Ashton)
+
+ * The local_stylesheet? helper method (deprecated in 0.9.1) has been
+   removed. (Graham Ashton)
+
+ * The breadcrumb_label helper method (deprecated in 0.9.3) has been removed.
+   (Graham Ashton)
+
 = 0.13.0 / (28 September 2022)
 
  * Update dependencies in order to support Ruby 3.0 and above.

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    nesta (0.13.0)
+    nesta (0.14.0)
       RedCloth (~> 4.2)
       haml (>= 3.1, < 6.0)
       haml-contrib (>= 1.0)
-      rack (~> 2.0)
+      rack (~> 2)
+      rake
       rdiscount (~> 2.1)
-      sassc (>= 2.2)
+      sass-embedded (~> 1.58)
       sinatra (~> 2.0)
       tilt (~> 2.0)
 
@@ -28,6 +29,7 @@ GEM
       rack-test (>= 0.5.4)
       xpath (>= 2.0, < 4.0)
     ffi (1.15.5)
+    google-protobuf (3.22.2)
     haml (5.2.2)
       temple (>= 0.8.0)
       tilt
@@ -39,9 +41,9 @@ GEM
       rb-inotify (>= 0.9)
       rb-kqueue (>= 0.2)
     mini_mime (1.1.2)
-    mini_portile2 (2.8.0)
-    minitest (5.16.3)
-    minitest-reporters (1.5.0)
+    mini_portile2 (2.8.1)
+    minitest (5.18.0)
+    minitest-reporters (1.6.0)
       ansi
       builder
       minitest (>= 5.0)
@@ -53,35 +55,36 @@ GEM
       unicorn (>= 4.5)
     mustermann (2.0.2)
       ruby2_keywords (~> 0.0.1)
-    nokogiri (1.13.8)
+    nokogiri (1.14.2)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    public_suffix (5.0.0)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-protection (2.2.2)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-protection (2.2.4)
       rack
     rack-test (2.0.2)
       rack (>= 1.3)
-    raindrops (0.20.0)
+    raindrops (0.20.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rb-kqueue (0.2.8)
       ffi (>= 0.5.0)
-    rdiscount (2.2.0.2)
-    ruby-progressbar (1.11.0)
+    rdiscount (2.2.7)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
-    sassc (2.4.0)
-      ffi (~> 1.9)
-    sinatra (2.2.2)
+    sass-embedded (1.58.3)
+      google-protobuf (~> 3.21)
+      rake (>= 10.0.0)
+    sinatra (2.2.4)
       mustermann (~> 2.0)
       rack (~> 2.2)
-      rack-protection (= 2.2.2)
+      rack-protection (= 2.2.4)
       tilt (~> 2.0)
-    temple (0.8.2)
-    tilt (2.0.11)
+    temple (0.10.0)
+    tilt (2.1.0)
     unicorn (6.1.0)
       kgio (~> 2.6)
       raindrops (~> 0.7)
@@ -98,7 +101,6 @@ DEPENDENCIES
   minitest-reporters
   mr-sparkle
   nesta!
-  rake
 
 BUNDLED WITH
-   2.3.14
+   2.4.6

data/README.md

@@ -44,8 +44,8 @@ full instructions).
 ## Support
 
 There's plenty of information on <http://nestacms.com>. If you need some
-help with anything feel free to file an issue, or contact me (@grahamashton)
-on Twitter.
+help with anything feel free to file an issue, or contact me on Mastodon
+(@gma@hachyderm.io) or Twitter (@grahamashton).
 
 If you like Nesta you can keep up with developments by following [@nestacms][]
 on Twitter, and on [the blog][].
@@ -53,6 +53,8 @@ on Twitter, and on [the blog][].
 [@nestacms]: http://twitter.com/nestacms
 [the blog]: http://nestacms.com/blog
 
+![Tests](https://github.com/gma/nesta/actions/workflows/tests.yml/badge.svg)
+
 ## Contributing
 
 If you want to add a new feature, I recommend that you file an issue to discuss

data/bin/nesta

@@ -24,6 +24,7 @@ COMMANDS
     theme:install <url>   Install a theme from a git repository.
     theme:enable <name>   Make the theme active, updating config.yml.
     theme:create <name>   Makes a template for a new theme in ./themes.
+    build [path]          Build static copy of site (path defaults to ./dist)
 
 OPTIONS FOR new
     --git                 Create a new git repository for the project.
@@ -41,6 +42,7 @@ EOF
     def self.parse_command_line
       opts = GetoptLong.new(
         ['--bash-completion', GetoptLong::NO_ARGUMENT],
+        ['--domain', GetoptLong::REQUIRED_ARGUMENT],
         ['--git', GetoptLong::NO_ARGUMENT],
         ['--help', '-h', GetoptLong::NO_ARGUMENT],
         ['--version', '-v', GetoptLong::NO_ARGUMENT],
@@ -118,7 +120,7 @@ _nesta() {
     cur="${COMP_WORDS[COMP_CWORD]}"
     prev="${COMP_WORDS[COMP_CWORD-1]}"
 
-    opts="new 'demo:content' edit 'plugin:create' 'theme:install' 'theme:enable' 'theme:create'"
+    opts="new 'demo:content' edit 'plugin:create' 'theme:install' 'theme:enable' 'theme:create' build"
 
     case "${cur}" in
         theme:*)
@@ -172,6 +174,7 @@ _1st_arguments=(
   'theme\:install:Install a theme from a git repository'
   'theme\:enable:Make the theme active, updating config.yml'
   'theme\:create:Makes a template for a new theme in ./themes'
+  'build\:Build static copy of site'
 )
 
 local expl

data/lib/nesta/app.rb

@@ -1,6 +1,5 @@
 require 'sinatra/base'
 require 'haml'
-require 'sassc'
 
 require File.expand_path('../nesta', File.dirname(__FILE__))
 require File.expand_path('env', File.dirname(__FILE__))
@@ -18,6 +17,7 @@ module Nesta
     set :root, Nesta::Env.root
     set :views, File.expand_path('../../views', File.dirname(__FILE__))
     set :haml, { format: :html5 }
+    set :public_folder, 'public'
 
     helpers Overrides::Renderers
     helpers Navigation::Renderers
@@ -90,5 +90,4 @@ module Nesta
   end
 end
 
-Nesta::Plugin.load_local_plugins
 Nesta::Plugin.initialize_plugins

data/lib/nesta/commands/build.rb

@@ -0,0 +1,38 @@
+require 'rake'
+
+require_relative '../static/assets'
+require_relative '../static/site'
+
+module Nesta
+  module Commands
+    class Build
+      DEFAULT_DESTINATION = "dist"
+
+      attr_accessor :domain
+
+      def initialize(build_dir = nil, options = {})
+        @build_dir = build_dir || DEFAULT_DESTINATION
+        if @build_dir == Nesta::App.settings.public_folder
+          raise RuntimeError.new("#{@build_dir} is already used, for assets")
+        end
+        @domain = options['domain'] || configured_domain_name
+      end
+
+      def configured_domain_name
+        Nesta::Config.build.fetch('domain', 'localhost')
+      end
+
+      def execute(process)
+        logger = Proc.new { |message| puts message }
+        site = Nesta::Static::Site.new(@build_dir, @domain, logger)
+        site.render_pages
+        site.render_not_found
+        site.render_atom_feed
+        site.render_sitemap
+        site.render_templated_assets
+        Nesta::Static::Assets.new(@build_dir, logger).copy_attachments
+        Nesta::Static::Assets.new(@build_dir, logger).copy_public_folder
+      end
+    end
+  end
+end

data/lib/nesta/commands/new.rb

@@ -25,7 +25,8 @@ module Nesta
       def create_repository(process)
         FileUtils.cd(@path) do
           File.open('.gitignore', 'w') do |file|
-            file.puts %w[._* .*.swp .bundle .DS_Store .sass-cache].join("\n")
+            lines = %w[._* .*.swp .bundle .DS_Store .sass-cache dist]
+            file.puts lines.join("\n")
           end
           process.run('git', 'init')
           process.run('git', 'add', '.')

data/lib/nesta/commands.rb

@@ -7,6 +7,7 @@ require File.expand_path('path', File.dirname(__FILE__))
 require File.expand_path('system_command', File.dirname(__FILE__))
 require File.expand_path('version', File.dirname(__FILE__))
 
+require File.expand_path('commands/build', File.dirname(__FILE__))
 require File.expand_path('commands/demo', File.dirname(__FILE__))
 require File.expand_path('commands/edit', File.dirname(__FILE__))
 require File.expand_path('commands/new', File.dirname(__FILE__))

data/lib/nesta/config.rb

@@ -1,115 +1,89 @@
+require 'singleton'
 require 'yaml'
 
+require_relative './config_file'
+
 module Nesta
   class Config
+    include Singleton
+
     class NotDefined < KeyError; end
 
-    @settings = %w[
-      cache
+    SETTINGS = %w[
+      author
+      build
       content
       disqus_short_name
+      domain
       google_analytics_code
       read_more
       subtitle
       theme
       title
     ]
-    @author_settings = %w[name uri email]
-    @yaml = nil
-    
+
     class << self
-      attr_accessor :settings, :author_settings, :yaml_conf
+      extend Forwardable
+      def_delegators *[:instance, :fetch].concat(SETTINGS.map(&:to_sym))
     end
 
-    def self.fetch(key, *default)
-      from_environment(key.to_s)
+    attr_accessor :config
+
+    def fetch(setting, *default)
+      setting = setting.to_s
+      self.config ||= read_config_file(setting)
+      env_config = config.fetch(Nesta::App.environment.to_s, {})
+      env_config.fetch(
+        setting,
+        config.fetch(setting) { raise NotDefined.new(setting) }
+      )
     rescue NotDefined
-      begin
-        from_yaml(key.to_s)
-      rescue NotDefined
-        default.empty? && raise || (return default.first)
-      end
+      default.empty? && raise || (return default.first)
     end
 
-    def self.method_missing(method, *args)
-      if settings.include?(method.to_s)
-        fetch(method, nil)
+    def method_missing(method, *args)
+      if SETTINGS.include?(method.to_s)
+        fetch(method.to_s, nil)
       else
         super
       end
     end
-    
-    def self.author
-      environment_config = {}
-      %w[name uri email].each do |setting|
-        variable = "NESTA_AUTHOR__#{setting.upcase}"
-        ENV[variable] && environment_config[setting] = ENV[variable]
-      end
-      environment_config.empty? ? from_yaml('author') : environment_config
-    rescue NotDefined
-      nil
-    end
 
-    def self.cache
-      Nesta.deprecated('Nesta::Config.cache',
-                       'see http://nestacms.com/docs/deployment/page-caching')
-    end
-    
-    def self.content_path(basename = nil)
-      get_path(content, basename)
-    end
-    
-    def self.page_path(basename = nil)
-      get_path(File.join(content_path, "pages"), basename)
+    def respond_to_missing?(method, include_private = false)
+      SETTINGS.include?(method.to_s) || super
     end
-    
-    def self.attachment_path(basename = nil)
-      get_path(File.join(content_path, "attachments"), basename)
-    end
-    
-    def self.yaml_path
-      File.expand_path('config/config.yml', Nesta::App.root)
+
+    def build
+      fetch('build', {})
     end
 
-    def self.read_more
+    def read_more
       fetch('read_more', 'Continue reading')
     end
 
-    def self.from_environment(setting)
-      value = ENV.fetch("NESTA_#{setting.upcase}")
-    rescue KeyError
+    private
+
+    def read_config_file(setting)
+      YAML::load(ERB.new(IO.read(Nesta::ConfigFile.path)).result)
+    rescue Errno::ENOENT
       raise NotDefined.new(setting)
-    else
-      overrides = { "true" => true, "false" => false }
-      overrides.has_key?(value) ? overrides[value] : value
-    end
-    private_class_method :from_environment
-    
-    def self.yaml_exists?
-      File.exist?(yaml_path)
     end
-    private_class_method :yaml_exists?
 
-    def self.from_hash(hash, setting)
-      hash.fetch(setting) { raise NotDefined.new(setting) }
-    end
-    private_class_method :from_hash
-
-    def self.from_yaml(setting)
-      raise NotDefined.new(setting) unless yaml_exists?
-      self.yaml_conf ||= YAML::load(ERB.new(IO.read(yaml_path)).result)
-      env_config = self.yaml_conf.fetch(Nesta::App.environment.to_s, {})
-      begin
-        from_hash(env_config, setting)
-      rescue NotDefined
-        from_hash(self.yaml_conf, setting)
-      end
-    end
-    private_class_method :from_yaml
-    
     def self.get_path(dirname, basename)
       basename.nil? ? dirname : File.join(dirname, basename)
     end
     private_class_method :get_path
+
+    def self.content_path(basename = nil)
+      get_path(content, basename)
+    end
+
+    def self.page_path(basename = nil)
+      get_path(File.join(content_path, "pages"), basename)
+    end
+
+    def self.attachment_path(basename = nil)
+      get_path(File.join(content_path, "attachments"), basename)
+    end
   end
 end

data/lib/nesta/config_file.rb

@@ -1,11 +1,15 @@
 module Nesta
   class ConfigFile
+    def self.path
+      File.expand_path('config/config.yml', Nesta::App.root)
+    end
+
     def set_value(key, value)
       pattern = /^\s*#?\s*#{key}:.*/
       replacement = "#{key}: #{value}"
 
       configured = false
-      File.open(Nesta::Config.yaml_path, 'r+') do |file|
+      File.open(self.class.path, 'r+') do |file|
         output = ''
         file.each_line do |line|
           if configured

data/lib/nesta/helpers.rb

@@ -60,11 +60,6 @@ module Nesta
         date.strftime("%d %B %Y")
       end
 
-      def local_stylesheet?
-        Nesta.deprecated('local_stylesheet?', 'use local_stylesheet_link_tag')
-        File.exist?(File.expand_path('views/local.sass', Nesta::App.root))
-      end
-
       def local_stylesheet_link_tag(name)
         pattern = File.expand_path("views/#{name}.s{a,c}ss", Nesta::App.root)
         if Dir.glob(pattern).size > 0

data/lib/nesta/models.rb

@@ -380,45 +380,44 @@ module Nesta
       end
     end
 
-    private
-      def self.append_menu_item(menu, file, depth)
-        path = file.readline
-      rescue EOFError
-      else
-        page = Page.load(path.strip)
-        current_depth = path.scan(INDENT).size
-        if page
-          if current_depth > depth
-            sub_menu_for_depth(menu, depth) << [page]
-          else
-            sub_menu_for_depth(menu, current_depth) << page
-          end
+    private_class_method def self.append_menu_item(menu, file, depth)
+      path = file.readline
+    rescue EOFError
+    else
+      page = Page.load(path.strip)
+      current_depth = path.scan(INDENT).size
+      if page
+        if current_depth > depth
+          sub_menu_for_depth(menu, depth) << [page]
+        else
+          sub_menu_for_depth(menu, current_depth) << page
         end
-        append_menu_item(menu, file, current_depth)
       end
+      append_menu_item(menu, file, current_depth)
+    end
 
-      def self.sub_menu_for_depth(menu, depth)
-        sub_menu = menu
-        depth.times { sub_menu = sub_menu[-1] }
-        sub_menu
-      end
+    private_class_method def self.sub_menu_for_depth(menu, depth)
+      sub_menu = menu
+      depth.times { sub_menu = sub_menu[-1] }
+      sub_menu
+    end
 
-      def self.find_menu_item_by_path(menu, path)
-        item = menu.detect do |item|
-          item.respond_to?(:path) && (item.path == path)
-        end
-        if item
-          subsequent = menu[menu.index(item) + 1]
-          item = [item]
-          item << subsequent if subsequent.respond_to?(:each)
-        else
-          sub_menus = menu.select { |menu_item| menu_item.respond_to?(:each) }
-          sub_menus.each do |sub_menu|
-            item = find_menu_item_by_path(sub_menu, path)
-            break if item
-          end
+    private_class_method def self.find_menu_item_by_path(menu, path)
+      item = menu.detect do |item|
+        item.respond_to?(:path) && (item.path == path)
+      end
+      if item
+        subsequent = menu[menu.index(item) + 1]
+        item = [item]
+        item << subsequent if subsequent.respond_to?(:each)
+      else
+        sub_menus = menu.select { |menu_item| menu_item.respond_to?(:each) }
+        sub_menus.each do |sub_menu|
+          item = find_menu_item_by_path(sub_menu, path)
+          break if item
         end
-        item
       end
+      item
+    end
   end
 end

data/lib/nesta/navigation.rb

@@ -64,11 +64,6 @@ module Nesta
         raise
       end
 
-      def breadcrumb_label(page)
-        Nesta.deprecated('breadcrumb_label', 'use link_text')
-        link_text(page)
-      end
-
       def current_item?(item)
         request.path_info == item.abspath
       end