bridgetown-core 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7878e020dc228c491934a986395227f17fa2ca93398ae0f3961a77c4df6e1761
-  data.tar.gz: 73dd2ad473c8525974708393f97f0ce464241fedcc78951186b726ea3435c444
+  metadata.gz: c36f73b0c33a2bf052be5e78359a241dce3034f144f9ff12bdd37515ba008f5a
+  data.tar.gz: fb6296ecf818c0fe40244359672babde4f4353549b4972ca5c112ff8ed8579bf
 SHA512:
-  metadata.gz: 38624e9ea2b7e604b773f2224eec18fdce5e44fc9c9e388c7cefa1ebee6fcee62aa96406ff783a7458a5b3d7a24f45c486a2cc2e925867609a26cb8e30336bb1
-  data.tar.gz: eb46348e312153b95b46b1b5e7fbfca154c4d39c87af62e9b77ccdfacdd43cca640b8adf216c223aeb9f47f92977df48d3550dab1a7a173dac256c92cf89f77f
+  metadata.gz: 52c7d713936d04fbcd76e0605d0eaf022800c3ca0ce3e5424630ff12486fa0cfdf786c693099211e2e2a5b2fe483a8eb1ab80a96eef92552397eaef348579ee8
+  data.tar.gz: 76d621f1fc7779830b15768ae21c37e95c5baf0a0949deb59d5d6677a35d68519d12a1bb05299c292420ca1062d73267acb944e77d88ae45b1a57499361c90b2

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

data/lib/bridgetown-core.rb

@@ -29,6 +29,7 @@ require "csv"
 require "json"
 
 # 3rd party
+require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
 require "hash_with_dot_access"
 require "pathutil"
@@ -114,24 +115,23 @@ module Bridgetown
   require_all "bridgetown-core/tags"
 
   class << self
-    # Public: Tells you which Bridgetown environment you are building in so
-    # you can skip tasks if you need to.
-
+    # Tells you which Bridgetown environment you are building in so
+    #   you can skip tasks if you need to.
     def environment
       ENV["BRIDGETOWN_ENV"] || "development"
     end
     alias_method :env, :environment
 
-    # Public: Generate a Bridgetown configuration Hash by merging the default
-    # options with anything in bridgetown.config.yml, and adding the given
-    # options on top.
+    # Generate a Bridgetown configuration hash by merging the default
+    #   options with anything in bridgetown.config.yml, and adding the given
+    #   options on top.
     #
-    # override - A Hash of config directives that override any options in both
-    #            the defaults and the config file.
-    #            See Bridgetown::Configuration::DEFAULTS for a
-    #            list of option names and their defaults.
+    # @param override [Hash] - A an optional hash of config directives that override
+    #   any options in both the defaults and the config file. See
+    #   {Bridgetown::Configuration::DEFAULTS} for a list of option names and their
+    #   defaults.
     #
-    # Returns the final configuration Hash.
+    # @return [Hash] The final configuration hash.
     def configuration(override = {})
       config = Configuration.new
       override = Configuration[override].stringify_keys
@@ -146,15 +146,29 @@ module Bridgetown
     end
 
     # Conveinence method to register a new Thor command
+    #
+    # @see Bridgetown::Commands::Registrations.register
     def register_command(&block)
       Bridgetown::Commands::Registrations.register(&block)
     end
 
-    # Public: Set the TZ environment variable to use the timezone specified
+    # Determines the correct Bundler environment block method to use and passes
+    # the block on to it.
+    #
+    # @return [void]
+    def with_unbundled_env(&block)
+      if Bundler.bundler_major_version >= 2
+        Bundler.method(:with_unbundled_env).call(&block)
+      else
+        Bundler.method(:with_clean_env).call(&block)
+      end
+    end
+
+    # Set the TZ environment variable to use the timezone specified
     #
-    # timezone - the IANA Time Zone
+    # @param timezone [String] the IANA Time Zone
     #
-    # Returns nothing
+    # @return [void]
     # rubocop:disable Naming/AccessorMethodName
     def set_timezone(timezone)
       ENV["TZ"] = if Utils::Platforms.really_windows?
@@ -165,38 +179,39 @@ module Bridgetown
     end
     # rubocop:enable Naming/AccessorMethodName
 
-    # Public: Fetch the logger instance for this Bridgetown process.
+    # Fetch the logger instance for this Bridgetown process.
     #
-    # Returns the LogAdapter instance.
+    # @return [LogAdapter]
     def logger
       @logger ||= LogAdapter.new(LogWriter.new, (ENV["BRIDGETOWN_LOG_LEVEL"] || :info).to_sym)
     end
 
-    # Public: Set the log writer.
-    #         New log writer must respond to the same methods
-    #         as Ruby's interal Logger.
+    # Set the log writer. New log writer must respond to the same methods as Ruby's
+    #   internal Logger.
     #
-    # writer - the new Logger-compatible log transport
+    # @param writer [Object] the new Logger-compatible log transport
     #
-    # Returns the new logger.
+    # @return [LogAdapter]
     def logger=(writer)
       @logger = LogAdapter.new(writer, (ENV["BRIDGETOWN_LOG_LEVEL"] || :info).to_sym)
     end
 
-    # Public: An array of sites
+    # An array of sites. Currently only ever a single entry.
     #
-    # Returns the Bridgetown sites created.
+    # @return [Array<Bridgetown::Site>] the Bridgetown sites created.
     def sites
       @sites ||= []
     end
 
-    # Public: Ensures the questionable path is prefixed with the base directory
-    #         and prepends the questionable path with the base directory if false.
+    # Ensures the questionable path is prefixed with the base directory
+    #   and prepends the questionable path with the base directory if false.
     #
-    # base_directory - the directory with which to prefix the questionable path
-    # questionable_path - the path we're unsure about, and want prefixed
+    # @param base_directory [String] the directory with which to prefix the
+    #   questionable path
+    # @param questionable_path [String] the path we're unsure about, and want
+    #   prefixed
     #
-    # Returns the sanitized path.
+    # @return [String] the sanitized path
     def sanitized_path(base_directory, questionable_path)
       return base_directory if base_directory.eql?(questionable_path)
 

data/lib/bridgetown-core/collection.rb

@@ -2,7 +2,10 @@
 
 module Bridgetown
   class Collection
-    attr_reader :site, :label, :metadata
+    # @return [Bridgetown::Site]
+    attr_reader :site
+
+    attr_reader :label, :metadata
     attr_writer :docs
 
     # Create a new Collection.
@@ -65,6 +68,7 @@ module Bridgetown
           read_static_file(file_path, full_path)
         end
       end
+      site.static_files.concat(files)
       sort_docs!
     end
 

data/lib/bridgetown-core/commands/apply.rb

@@ -44,7 +44,7 @@ module Bridgetown
 
       def apply_after_new_command
         # Coming from the new command, so set up proper bundler env
-        Bundler.with_clean_env do
+        Bridgetown.with_unbundled_env do
           self.destination_root = New.created_site_dir
           inside(New.created_site_dir) do
             apply_from_url options[:apply]
@@ -62,7 +62,7 @@ module Bridgetown
                                " current folder."
         end
 
-        Bundler.with_clean_env do
+        Bridgetown.with_unbundled_env do
           apply_from_url automation_command
         end
       rescue ArgumentError => e

data/lib/bridgetown-core/commands/new.rb

@@ -115,7 +115,7 @@ module Bridgetown
       def bundle_install(path)
         unless Bridgetown.environment == "test"
           require "bundler"
-          Bundler.with_clean_env do
+          Bridgetown.with_unbundled_env do
             inside(path) do
               run "bundle install", abort_on_failure: true
             end

data/lib/bridgetown-core/concerns/layout_placeable.rb

@@ -11,7 +11,7 @@ module Bridgetown
     end
 
     def no_layout?
-      data["layout"] == "none"
+      data["layout"] == "none" || data["layout"] == false
     end
   end
 end

data/lib/bridgetown-core/concerns/liquid_renderable.rb

@@ -8,10 +8,20 @@ module Bridgetown
     # contain any Liquid Tags or Variables, true otherwise.
     def render_with_liquid?
       return false if data["render_with_liquid"] == false
+      return false unless liquid_engine_configured?
 
       !(yaml_file? || !Utils.has_liquid_construct?(content))
     end
 
+    def liquid_engine_configured?
+      data["template_engine"] == "liquid" ||
+        (
+          data["template_engine"].nil? && (
+            site.config[:template_engine].nil? || site.config[:template_engine] == "liquid"
+          )
+        )
+    end
+
     # Override in individual classes
     def yaml_file?
       false

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

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Configurable
+class Bridgetown::Site
+  module Configurable
     # Set the site's configuration. This handles side-effects caused by
-    # changing values in the configuration.
+    #   changing values in the configuration.
     #
-    # @param config [Bridgetown::Configuration]
-    #   An instance of {Bridgetown::Configuration},
+    # @param config [Configuration]
+    #   An instance of {Configuration},
     #   containing the new configuration.
     #
-    # @return [Bridgetown::Configuration]
-    #   A new instance of {Bridgetown::Configuration}
-    #
-    # @see Bridgetown::Configuration
+    # @return [Configuration]
+    #   The processed instance of {Configuration}
     def config=(config)
       @config = config.clone
 
@@ -38,21 +36,21 @@ module Bridgetown
     end
 
     def defaults_reader
-      @defaults_reader ||= DefaultsReader.new(self)
+      @defaults_reader ||= Bridgetown::DefaultsReader.new(self)
     end
 
     # Returns the current instance of {FrontmatterDefaults} or
-    # creates a new instance {FrontmatterDefaults} if it doesn't already exist.
+    #   creates a new instance {FrontmatterDefaults} if it doesn't already exist.
     #
     # @return [FrontmatterDefaults]
     #   Returns an instance of {FrontmatterDefaults}
     def frontmatter_defaults
-      @frontmatter_defaults ||= FrontmatterDefaults.new(self)
+      @frontmatter_defaults ||= Bridgetown::FrontmatterDefaults.new(self)
     end
 
     # Whether to perform a full rebuild without incremental regeneration.
-    # If either +override+["incremental"] or +config+["incremental"] are true,
-    # fully rebuild the site. If not, incrementally build the site.
+    #   If either `override["incremental"]` or `config["incremental"]` are true,
+    #   fully rebuild the site. If not, incrementally build the site.
     #
     # @param [Hash] override
     #   An override hash to override the current config value
@@ -63,11 +61,11 @@ module Bridgetown
     end
 
     # Returns the current instance of {Publisher} or creates a new instance of
-    # {Publisher} if one doesn't exist.
+    #   {Publisher} if one doesn't exist.
     #
     # @return [Publisher] Returns an instance of {Publisher}
     def publisher
-      @publisher ||= Publisher.new(self)
+      @publisher ||= Bridgetown::Publisher.new(self)
     end
 
     # Prefix a path or paths with the {#root_dir} directory.
@@ -126,16 +124,16 @@ module Bridgetown
     end
 
     # The full path to the directory that houses all the registered collections
-    # for the current site.
+    #  for the current site.
     #
-    # If +@collections_path+ is specified use its value.
+    #  If `@collections_path` is specified use its value.
     #
-    # If +@collections+ is not specified and +config+["collections_dir"] is
-    # specified, prepend it with {#source} and assign it to
-    # {#collections_path}.
+    #  If `@collections` is not specified and `config["collections_dir"]` is
+    #  specified, prepend it with {#source} and assign it to
+    #  {#collections_path}.
     #
-    # If +@collections+ is not specified and +config+["collections_dir"] is not
-    # specified, assign {#source} to +@collections_path+
+    #  If `@collections` is not specified and `config["collections_dir"]` is not
+    #  specified, assign {#source} to `@collections_path`
     #
     # @return [String] Returns the full path to the collections directory
     # @see #config

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

@@ -1,27 +1,24 @@
 # frozen_string_literal: true
 
-module Bridgetown
-  module Site::Content
+class Bridgetown::Site
+  # Content is king!
+  module Content
     # Construct a Hash of Posts indexed by the specified Post attribute.
     #
-    # @param post_attr [String] The String name of the Post attribute.
-    #
-    # @example
-    #   Returns a hash like so: { attr => posts } where
+    # Returns a hash like so: `{ attr => posts }` where:
     #
-    #   attr  - One of the values for the requested attribute.
+    # * `attr` - One of the values for the requested attribute.
+    # * `posts` - The array of Posts with the given attr value.
     #
-    #   posts - The Array of Posts with the given attr value.
+    # @param post_attr [String] The String name of the Post attribute.
     #
     # @example
-    #
     #   post_attr_hash('categories')
     #   # => { 'tech' => [<Post A>, <Post B>],
     #   #      'ruby' => [<Post B>] }
     #
     # @return [Hash{String, Symbol => Array<Post>}]
     #   Returns a hash of !{attr => posts}
-    #
     def post_attr_hash(post_attr)
       # Build a hash map based on the specified post attribute ( post attr =>
       # array of posts ) then sort each array in reverse order.
@@ -36,7 +33,7 @@ module Bridgetown
     end
 
     # Returns a hash of "tags" using {#post_attr_hash} where each tag is a key
-    # and each value is a post which contains the key.
+    #  and each value is a post which contains the key.
     # @example
     #   tags
     #   # => { 'tech': [<Post A>, <Post B>],
@@ -48,7 +45,7 @@ module Bridgetown
     end
 
     # Returns a hash of "categories" using {#post_attr_hash} where each tag is
-    # a key and each value is a post which contains the key.
+    #  a key and each value is a post which contains the key.
     # @example
     #   categories
     #   # => { 'tech': [<Post A>, <Post B>],
@@ -60,8 +57,8 @@ module Bridgetown
       post_attr_hash("categories")
     end
 
-    # Returns the value of +data+["site_metadata"] or creates a new instance of
-    # +HashWithDotAccess::Hash+
+    # Returns the value of `data["site_metadata"]` or creates a new instance of
+    #   `HashWithDotAccess::Hash`
     # @return [Hash] Returns a hash of site metadata
     def metadata
       data["site_metadata"] ||= HashWithDotAccess::Hash.new
@@ -98,22 +95,21 @@ module Bridgetown
     #
     # @see #post_attr_hash
     def site_payload
-      Drops::UnifiedPayloadDrop.new self
+      Bridgetown::Drops::UnifiedPayloadDrop.new self
     end
     alias_method :to_liquid, :site_payload
 
-    # The list of {#collections} and their corresponding {Bridgetown::Collection} instances.
+    # The list of collections labels and their corresponding {Collection} instances.
     #
-    # If +config+['collections'] is set, a new instance of {Bridgetown::Collection} is created
-    # for each entry in the collections configuration.
+    #  If `config['collections']` is set, a new instance of {Collection} is created
+    #  for each entry in the collections configuration.
     #
-    # If +config+["collections"] is not specified, a blank hash is returned.
+    #  If `config["collections"]` is not specified, a blank hash is returned.
     #
-    # @return [Hash{String, Symbol => Bridgetown::Collection}] A Hash
+    # @return [Hash{String, Symbol => Collection}] A Hash
     #   containing a collection name-to-instance pairs.
     #
     # @return [Hash] Returns a blank hash if no items found
-    # @see Collection
     def collections
       @collections ||= collection_names.each_with_object(
         HashWithDotAccess::Hash.new
@@ -123,9 +119,9 @@ module Bridgetown
     end
 
     # An array of collection names.
-    # @return [Array<Collection>] an array of collection names from the configuration,
-    #   or an empty array if the +config+["collections"] key is not set.
-    # @raise ArgumentError Raise an error if +config+["collections"] is not
+    # @return [Array<String>] an array of collection names from the configuration,
+    #   or an empty array if the `config["collections"]` key is not set.
+    # @raise ArgumentError Raise an error if `config["collections"]` is not
     #   an Array or a Hash
     def collection_names
       case config["collections"]
@@ -141,17 +137,18 @@ module Bridgetown
     end
 
     # Get all documents.
-    # @return [Array<String>] an array of documents from the configuration
+    # @return [Array<Document>] an array of documents from the
+    # configuration
     def documents
       collections.each_with_object(Set.new) do |(_, collection), set|
-        set.merge(collection.docs).merge(collection.files)
+        set.merge(collection.docs)
       end.to_a
     end
 
     # Get the documents to be written
     #
-    # @return [Array<String, File>] an Array of Documents which should be written and
-    #   that +respond_to :write?+
+    # @return [Array<Document>] an array of documents which should be
+    #   written and that `respond_to :write?`
     # @see #documents
     # @see Collection
     def docs_to_write
@@ -160,11 +157,27 @@ module Bridgetown
 
     # Get all posts.
     #
-    # @return [Collection] A #Collection of posts. Returns +#collections+["posts"]
-    # @return [Collection] Return a new #Collection if +#collections+["posts"] is nil
+    # @return [Collection] Returns {#collections}`["posts"]`, creating it if need be
     # @see Collection
     def posts
-      collections["posts"] ||= Collection.new(self, "posts")
+      collections["posts"] ||= Bridgetown::Collection.new(self, "posts")
+    end
+
+    # Get the static files to be written
+    #
+    # @return [Array<StaticFile>] an array of files which should be
+    #   written and that `respond_to :write?`
+    # @see #static_files
+    # @see StaticFile
+    def static_files_to_write
+      static_files.select(&:write?)
+    end
+
+    # Get all pages and documents (posts and collection items) in a single array.
+    #
+    # @return [Array]
+    def contents
+      pages + documents
     end
   end
 end