bridgetown-core 0.21.4 → 1.0.0.alpha1

data/lib/bridgetown-core/regenerator.rb

@@ -1,202 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  class Regenerator
-    attr_reader :site, :metadata, :cache
-    attr_accessor :disabled
-    private :disabled, :disabled=
-
-    def initialize(site)
-      @site = site
-
-      # Read metadata from file
-      read_metadata
-
-      # Initialize cache to an empty hash
-      clear_cache
-    end
-
-    # Checks if a renderable object needs to be regenerated
-    #
-    # Returns a boolean.
-    def regenerate?(document) # rubocop:todo Metrics/CyclomaticComplexity
-      return true if disabled
-
-      case document
-      when Page
-        regenerate_page?(document)
-      when Document
-        regenerate_document?(document)
-      when Bridgetown::Resource::Base
-        regenerate_resource?(document)
-      else
-        source_path = document.respond_to?(:path) ? document.path : nil
-        dest_path = document.destination(@site.dest) if document.respond_to?(:destination)
-        source_modified_or_dest_missing?(source_path, dest_path)
-      end
-    end
-
-    # Add a path to the metadata
-    #
-    # Returns true, also on failure.
-    def add(path)
-      return true unless File.exist?(path)
-
-      metadata[path] = {
-        "mtime" => File.mtime(path),
-        "deps"  => [],
-      }
-      cache[path] = true
-    end
-
-    # Force a path to regenerate
-    #
-    # Returns true.
-    def force(path)
-      cache[path] = true
-    end
-
-    # Clear the metadata and cache
-    #
-    # Returns nothing
-    def clear
-      @metadata = {}
-      clear_cache
-    end
-
-    # Clear just the cache
-    #
-    # Returns nothing
-    def clear_cache
-      @cache = {}
-    end
-
-    # Checks if the source has been modified or the
-    # destination is missing
-    #
-    # returns a boolean
-    def source_modified_or_dest_missing?(source_path, dest_path)
-      modified?(source_path) || (dest_path && !File.exist?(dest_path))
-    end
-
-    # Checks if a path's (or one of its dependencies)
-    # mtime has changed
-    #
-    # Returns a boolean.
-    def modified?(path)
-      return true if disabled?
-
-      # objects that don't have a path are always regenerated
-      return true if path.nil?
-
-      # Check for path in cache
-      return cache[path] if cache.key? path
-
-      if metadata[path]
-        # If we have seen this file before,
-        # check if it or one of its dependencies has been modified
-        existing_file_modified?(path)
-      else
-        # If we have not seen this file before, add it to the metadata and regenerate it
-        add(path)
-      end
-    end
-
-    # Add a dependency of a path
-    #
-    # Returns nothing.
-    def add_dependency(path, dependency)
-      return if metadata[path].nil? || disabled
-
-      unless metadata[path]["deps"].include? dependency
-        metadata[path]["deps"] << dependency
-        add(dependency) unless metadata.include?(dependency)
-      end
-      regenerate? dependency
-    end
-
-    # Write the metadata to disk
-    #
-    # Returns nothing.
-    def write_metadata
-      unless disabled?
-        Bridgetown.logger.debug "Writing Metadata:", ".bridgetown-metadata"
-        File.binwrite(metadata_file, Marshal.dump(metadata))
-      end
-    end
-
-    # Produce the absolute path of the metadata file
-    #
-    # Returns the String path of the file.
-    def metadata_file
-      @metadata_file ||= site.in_root_dir(".bridgetown-metadata")
-    end
-
-    # Check if metadata has been disabled
-    #
-    # Returns a Boolean (true for disabled, false for enabled).
-    def disabled?
-      self.disabled = !site.incremental? if disabled.nil?
-      disabled
-    end
-
-    private
-
-    # Read metadata from the metadata file, if no file is found,
-    # initialize with an empty hash
-    #
-    # Returns the read metadata.
-    def read_metadata
-      @metadata =
-        if !disabled? && File.file?(metadata_file)
-          content = File.binread(metadata_file)
-
-          begin
-            Marshal.load(content)
-          rescue TypeError
-            YAMLParser.load(content)
-          rescue ArgumentError => e
-            Bridgetown.logger.warn("Failed to load #{metadata_file}: #{e}")
-            {}
-          end
-        else
-          {}
-        end
-    end
-
-    def regenerate_page?(document)
-      document.data["regenerate"] ||
-        source_modified_or_dest_missing?(
-          site.in_source_dir(document.relative_path), document.destination(@site.dest)
-        )
-    end
-
-    def regenerate_document?(document)
-      !document.write? || document.data["regenerate"] ||
-        source_modified_or_dest_missing?(
-          document.path, document.destination(@site.dest)
-        )
-    end
-
-    # TODO: need to manage dependencies, but for now always regenerate
-    def regenerate_resource?(_resource)
-      true
-    end
-
-    def existing_file_modified?(path)
-      # If one of this file dependencies have been modified,
-      # set the regeneration bit for both the dependency and the file to true
-      metadata[path]["deps"].each do |dependency|
-        return cache[dependency] = cache[path] = true if modified?(dependency)
-      end
-
-      if File.exist?(path) && metadata[path]["mtime"].eql?(File.mtime(path))
-        # If this file has not been modified, set the regeneration bit to false
-        cache[path] = false
-      else
-        # If it has been modified, set it to true
-        add(path)
-      end
-    end
-  end
-end

data/lib/bridgetown-core/related_posts.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  # TODO: to be retired once the Resource engine is made official
-  class RelatedPosts
-    class << self
-      attr_accessor :lsi
-    end
-
-    attr_reader :post, :site
-
-    def initialize(post)
-      @post = post
-      @site = post.site
-      if site.config.lsi
-        Bridgetown::Utils::RequireGems.require_with_graceful_fail("classifier-reborn")
-      end
-    end
-
-    def build
-      return [] unless site.collections.posts.docs.size > 1
-
-      if site.config.lsi
-        build_index
-        lsi_related_posts
-      else
-        most_recent_posts
-      end
-    end
-
-    def build_index
-      self.class.lsi ||= begin
-        lsi = ClassifierReborn::LSI.new(auto_rebuild: false)
-        Bridgetown.logger.info("Populating LSI...")
-
-        site.collections.posts.docs.each do |x|
-          lsi.add_item(x)
-        end
-
-        Bridgetown.logger.info("Rebuilding index...")
-        lsi.build_index
-        Bridgetown.logger.info("")
-        lsi
-      end
-    end
-
-    def lsi_related_posts
-      self.class.lsi.find_related(post, 11) - [post]
-    end
-
-    def most_recent_posts
-      @most_recent_posts ||= (site.collections.posts.docs.last(11).reverse - [post]).first(10)
-    end
-  end
-end

data/lib/site_template/start.js

@@ -1,17 +0,0 @@
-const concurrently = require('concurrently');
-
-// By default, configure Bridgetown to use port 4001 so Browsersync can use 4000
-// See also Browsersync settings in sync.js
-const port = 4001
-
-/////////////////
-// Concurrently
-/////////////////
-concurrently([
-  { command: "yarn webpack-dev", name: "Webpack", prefixColor: "yellow" },
-  { command: "sleep 4; yarn serve --port " + port, name: "Bridgetown", prefixColor: "green" },
-  { command: "sleep 8; yarn sync", name: "Live", prefixColor: "blue" }
-], {
-  restartTries: 3,
-  killOthers: ['failure', 'success'],
-}).then(() => { console.log("Done.");console.log('\033[0G'); }, () => {});

data/lib/site_template/sync.js

@@ -1,35 +0,0 @@
-const browserSync = require("browser-sync").create();
-
-// You can change these configuration values:
-const proxy = "http://localhost:4001"
-const port = 4000
-const uiPort = 4002
-
-////////////////
-// Browsersync
-////////////////
-browserSync.init({
-  open: false,
-  notify: false,
-  proxy: proxy,
-  port: port,
-  files: "output/index.html",
-  ghostMode: {
-    clicks: false,
-    forms: false,
-    scroll: false,
-  },
-  reloadDelay: 0,
-  injectChanges: false,
-  ui: {
-    port: uiPort
-  },
-  snippetOptions: {
-    rule: {
-      match: /<\/head>/i,
-      fn: function (snippet, match) {
-        return snippet + match;
-      },
-    },
-  },
-});