bridgetown-core 0.12.0 → 0.15.0.beta1

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Site::Writable
+    # Remove orphaned files and empty directories in destination.
+    #
+    # Returns nothing.
+    def cleanup
+      @cleaner.cleanup!
+    end
+
+    # Write static files, pages, and posts.
+    #
+    # Returns nothing.
+    def write
+      each_site_file do |item|
+        item.write(dest) if regenerator.regenerate?(item)
+      end
+      regenerator.write_metadata
+      Bridgetown::Hooks.trigger :site, :post_write, self
+    end
+
+    def each_site_file
+      %w(pages static_files docs_to_write).each do |type|
+        send(type).each do |item|
+          yield item
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-core/configuration.rb

@@ -1,66 +1,70 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  class Configuration < Hash
+  # TODO: refactor this whole object! Already had to fix obscure
+  # bugs just making minor changes, and all the indirection is
+  # quite hard to decipher. -JW
+  class Configuration < ActiveSupport::HashWithIndifferentAccess
     # Default options. Overridden by values in bridgetown.config.yml.
     # Strings rather than symbols are used for compatibility with YAML.
     DEFAULTS = {
       # Where things are
-      "root_dir"            => Dir.pwd,
-      "plugins_dir"         => "plugins",
-      "source"              => File.join(Dir.pwd, "src"),
-      "destination"         => File.join(Dir.pwd, "output"),
-      "collections_dir"     => "",
-      "cache_dir"           => ".bridgetown-cache",
-      "layouts_dir"         => "_layouts",
-      "data_dir"            => "_data",
-      "components_dir"      => "_components",
-      "includes_dir"        => "_includes",
-      "collections"         => {},
+      "root_dir"             => Dir.pwd,
+      "plugins_dir"          => "plugins",
+      "source"               => File.join(Dir.pwd, "src"),
+      "destination"          => File.join(Dir.pwd, "output"),
+      "collections_dir"      => "",
+      "cache_dir"            => ".bridgetown-cache",
+      "layouts_dir"          => "_layouts",
+      "data_dir"             => "_data",
+      "components_dir"       => "_components",
+      "includes_dir"         => "_includes",
+      "collections"          => {},
 
       # Handling Reading
-      "include"             => [".htaccess", "_redirects", ".well-known"],
-      "exclude"             => [],
-      "keep_files"          => [".git", ".svn", "_bridgetown"],
-      "encoding"            => "utf-8",
-      "markdown_ext"        => "markdown,mkdown,mkdn,mkd,md",
-      "strict_front_matter" => false,
-      "slugify_categories"  => true,
+      "include"              => [".htaccess", "_redirects", ".well-known"],
+      "exclude"              => [],
+      "keep_files"           => [".git", ".svn", "_bridgetown"],
+      "encoding"             => "utf-8",
+      "markdown_ext"         => "markdown,mkdown,mkdn,mkd,md",
+      "strict_front_matter"  => false,
+      "slugify_categories"   => true,
 
       # Filtering Content
-      "limit_posts"         => 0,
-      "future"              => false,
-      "unpublished"         => false,
+      "limit_posts"          => 0,
+      "future"               => false,
+      "unpublished"          => false,
+      "ruby_in_front_matter" => true, # requires BRIDGETOWN_RUBY_IN_FRONT_MATTER == "true"
 
       # Conversion
-      "markdown"            => "kramdown",
-      "highlighter"         => "rouge",
-      "lsi"                 => false,
-      "excerpt_separator"   => "\n\n",
-      "incremental"         => false,
+      "markdown"             => "kramdown",
+      "highlighter"          => "rouge",
+      "lsi"                  => false,
+      "excerpt_separator"    => "\n\n",
+      "incremental"          => false,
 
       # Serving
-      "detach"              => false, # default to not detaching the server
-      "port"                => "4000",
-      "host"                => "127.0.0.1",
-      "baseurl"             => nil, # this mounts at /, i.e. no subdirectory
-      "show_dir_listing"    => false,
+      "detach"               => false, # default to not detaching the server
+      "port"                 => "4000",
+      "host"                 => "127.0.0.1",
+      "baseurl"              => nil, # this mounts at /, i.e. no subdirectory
+      "show_dir_listing"     => false,
 
       # Output Configuration
-      "permalink"           => "date",
-      "timezone"            => nil, # use the local timezone
+      "permalink"            => "date",
+      "timezone"             => nil, # use the local timezone
 
-      "quiet"               => false,
-      "verbose"             => false,
-      "defaults"            => [],
+      "quiet"                => false,
+      "verbose"              => false,
+      "defaults"             => [],
 
-      "liquid"              => {
+      "liquid"               => {
         "error_mode"       => "warn",
         "strict_filters"   => false,
         "strict_variables" => false,
       },
 
-      "kramdown"            => {
+      "kramdown"             => {
         "auto_ids"      => true,
         "toc_levels"    => (1..6).to_a,
         "entity_output" => "as_char",
@@ -87,18 +91,14 @@ module Bridgetown
       #
       # Returns a Configuration filled with defaults.
       def from(user_config)
-        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config].stringify_keys)
-          .add_default_collections.add_default_excludes
+        Utils.deep_merge_hashes(DEFAULTS, Configuration[user_config])
+          .merge_environment_specific_options!
+          .add_default_collections
+          .add_default_excludes
+          .check_include_exclude
       end
     end
 
-    # Public: Turn all keys into string
-    #
-    # Return a copy of the hash where all its keys are strings
-    def stringify_keys
-      each_with_object({}) { |(k, v), hsh| hsh[k.to_s] = v }
-    end
-
     def get_config_value_with_override(config_key, override)
       override[config_key] || self[config_key] || DEFAULTS[config_key]
     end
@@ -178,31 +178,6 @@ module Bridgetown
       Array(config_files)
     end
 
-    # Public: Read configuration and return merged Hash
-    #
-    # file - the path to the YAML file to be read in
-    #
-    # Returns this configuration, overridden by the values in the file
-    def read_config_file(file)
-      file = File.expand_path(file)
-      next_config = safe_load_file(file)
-
-      unless next_config.is_a?(Hash)
-        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
-      end
-
-      Bridgetown.logger.info "Configuration file:", file
-      next_config
-    rescue SystemCallError
-      if @default_config_file ||= nil
-        Bridgetown.logger.warn "Configuration file:", "none"
-        {}
-      else
-        Bridgetown.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
-        raise LoadError, "The Configuration file '#{file}' could not be found."
-      end
-    end
-
     # Public: Read in a list of configuration files and merge with this hash
     #
     # files - the list of configuration file paths
@@ -210,14 +185,14 @@ module Bridgetown
     # Returns the full configuration, with the defaults overridden by the values in the
     # configuration files
     def read_config_files(files)
-      configuration = clone
+      config = self
 
       begin
         files.each do |config_file|
           next if config_file.nil? || config_file.empty?
 
           new_config = read_config_file(config_file)
-          configuration = Utils.deep_merge_hashes(configuration, new_config)
+          config = Utils.deep_merge_hashes(self, new_config)
         end
       rescue ArgumentError => e
         Bridgetown.logger.warn "WARNING:", "Error reading configuration. Using defaults" \
@@ -225,52 +200,64 @@ module Bridgetown
         warn e
       end
 
-      configuration.validate.add_default_collections
+      config
     end
 
-    # Public: Split a CSV string into an array containing its values
+    # Public: Read configuration and return merged Hash
     #
-    # csv - the string of comma-separated values
+    # file - the path to the YAML file to be read in
     #
-    # Returns an array of the values contained in the CSV
-    def csv_to_array(csv)
-      csv.split(",").map(&:strip)
-    end
+    # Returns this configuration, overridden by the values in the file
+    def read_config_file(file)
+      file = File.expand_path(file)
+      next_config = safe_load_file(file)
 
-    # Public: Ensure the proper options are set in the configuration
-    #
-    # Returns the configuration Hash
-    def validate
-      config = clone
+      unless next_config.is_a?(Hash)
+        raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
+      end
 
-      check_include_exclude(config)
+      Bridgetown.logger.info "Configuration file:", file
+      next_config
+    rescue SystemCallError
+      if @default_config_file ||= nil
+        Bridgetown.logger.warn "Configuration file:", "none"
+        {}
+      else
+        Bridgetown.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
+        raise LoadError, "The Configuration file '#{file}' could not be found."
+      end
+    end
 
-      config
+    # Merge in environment-specific options, if present
+    def merge_environment_specific_options!
+      self[Bridgetown.environment]&.each_key do |k|
+        self[k] = self[Bridgetown.environment][k]
+      end
+      delete(Bridgetown.environment)
+      self
     end
 
     def add_default_collections
-      config = clone
-
       # It defaults to `{}`, so this is only if someone sets it to null manually.
-      return config if config["collections"].nil?
+      return self if self["collections"].nil?
 
       # Ensure we have a hash.
-      if config["collections"].is_a?(Array)
-        config["collections"] = config["collections"].each_with_object({}) do |collection, hash|
+      if self["collections"].is_a?(Array)
+        self["collections"] = self["collections"].each_with_object({}) do |collection, hash|
           hash[collection] = {}
         end
       end
 
-      config["collections"] = Utils.deep_merge_hashes(
-        { "posts" => {} }, config["collections"]
+      self["collections"] = Utils.deep_merge_hashes(
+        { "posts" => {} }, self["collections"]
       ).tap do |collections|
         collections["posts"]["output"] = true
-        if config["permalink"]
-          collections["posts"]["permalink"] ||= style_to_permalink(config["permalink"])
+        if self["permalink"]
+          collections["posts"]["permalink"] ||= style_to_permalink(self["permalink"])
         end
       end
 
-      config
+      self
     end
 
     DEFAULT_EXCLUDES = %w(
@@ -281,14 +268,16 @@ module Bridgetown
     ).freeze
 
     def add_default_excludes
-      config = clone
-      return config if config["exclude"].nil?
+      return self if self["exclude"].nil?
 
-      config["exclude"].concat(DEFAULT_EXCLUDES).uniq!
-      config
+      self["exclude"].concat(DEFAULT_EXCLUDES).uniq!
+      self
     end
 
-    private
+    def should_execute_inline_ruby?
+      ENV["BRIDGETOWN_RUBY_IN_FRONT_MATTER"] == "true" &&
+        self["ruby_in_front_matter"]
+    end
 
     # rubocop:disable Metrics/CyclomaticComplexity #
     def style_to_permalink(permalink_style)
@@ -311,14 +300,15 @@ module Bridgetown
     end
     # rubocop:enable Metrics/CyclomaticComplexity #
 
-    def check_include_exclude(config)
+    def check_include_exclude
       %w(include exclude).each do |option|
-        next unless config.key?(option)
-        next if config[option].is_a?(Array)
+        next unless key?(option)
+        next if self[option].is_a?(Array)
 
         raise Bridgetown::Errors::InvalidConfigurationError,
-              "'#{option}' should be set as an array, but was: #{config[option].inspect}."
+              "'#{option}' should be set as an array, but was: #{self[option].inspect}."
       end
+      self
     end
   end
 end

data/lib/bridgetown-core/converters/markdown/kramdown_parser.rb

@@ -11,8 +11,6 @@ module Kramdown
       attr_reader :options, :parser
 
       # The implementation is basically the core logic in +Kramdown::Document#initialize+
-      #
-      # rubocop:disable Naming/MemoizedInstanceVariableName
       def setup(options)
         @cache ||= {}
 
@@ -36,7 +34,6 @@ module Kramdown
           end
         end
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       private
 

data/lib/bridgetown-core/document.rb

@@ -59,7 +59,7 @@ module Bridgetown
     # Returns a Hash containing the data. An empty hash is returned if
     #   no data was read.
     def data
-      @data ||= {}
+      @data ||= ActiveSupport::HashWithIndifferentAccess.new
     end
 
     # Merge some data in with this document's data.

data/lib/bridgetown-core/drops/bridgetown_drop.rb

@@ -13,13 +13,18 @@ module Bridgetown
         Bridgetown::VERSION
       end
 
+      def code_name
+        Bridgetown::CODE_NAME
+      end
+
       def environment
-        Bridgetown.env
+        Bridgetown.environment
       end
 
       def to_h
         @to_h ||= {
           "version"     => version,
+          "code_name"   => code_name,
           "environment" => environment,
         }
       end

data/lib/bridgetown-core/drops/site_drop.rb

@@ -7,7 +7,7 @@ module Bridgetown
 
       mutable false
 
-      def_delegator  :@obj, :site_data, :data
+      def_delegator  :@obj, :data
       def_delegators :@obj, :time, :pages, :static_files, :tags, :categories
 
       private def_delegator :@obj, :config, :fallback_data
@@ -50,7 +50,6 @@ module Bridgetown
         @documents ||= @obj.documents
       end
 
-      # TODO: provide a way to set BRIDGETOWN_ENV-specific metadata
       def metadata
         @site_metadata ||= @obj.data["site_metadata"]
       end

data/lib/bridgetown-core/external.rb

@@ -10,13 +10,11 @@ module Bridgetown
       #
       def require_if_present(names)
         Array(names).each do |name|
-          begin
-            require name
-          rescue LoadError
-            Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
-            yield(name, version_constraint(name)) if block_given?
-            false
-          end
+          require name
+        rescue LoadError
+          Bridgetown.logger.debug "Couldn't load #{name}. Skipping."
+          yield(name, version_constraint(name)) if block_given?
+          false
         end
       end
 
@@ -38,23 +36,21 @@ module Bridgetown
       #
       def require_with_graceful_fail(names)
         Array(names).each do |name|
-          begin
-            Bridgetown.logger.debug "Requiring:", name.to_s
-            require name
-          rescue LoadError => e
-            Bridgetown.logger.error "Dependency Error:", <<~MSG
-              Yikes! It looks like you don't have #{name} or one of its dependencies installed.
-              In order to use Bridgetown as currently configured, you'll need to install this gem.
+          Bridgetown.logger.debug "Requiring:", name.to_s
+          require name
+        rescue LoadError => e
+          Bridgetown.logger.error "Dependency Error:", <<~MSG
+            Yikes! It looks like you don't have #{name} or one of its dependencies installed.
+            In order to use Bridgetown as currently configured, you'll need to install this gem.
 
-              If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
-              gem in your Gemfile as well.
+            If you've run Bridgetown with `bundle exec`, ensure that you have included the #{name}
+            gem in your Gemfile as well.
 
-              The full error message from Ruby is: '#{e.message}'
+            The full error message from Ruby is: '#{e.message}'
 
-              If you run into trouble, you can find helpful resources at https://bridgetownrb.com/help/!
-            MSG
-            raise Bridgetown::Errors::MissingDependencyException, name
-          end
+            If you run into trouble, you can find helpful resources at https://www.bridgetownrb.com/docs/community/
+          MSG
+          raise Bridgetown::Errors::MissingDependencyException, name
         end
       end
     end