bridgetown-core 0.15.0.beta1 → 0.16.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba553587c222b3cedc1844d3bf40845a83dd24d70e3c85d49965ad010687e1b5
-  data.tar.gz: 223fea6ecf255ebaab06e34d3f8fa8e47ab64d0dd63d2dffc5cd25361a232ded
+  metadata.gz: 25a57f1cf4e0a06e347edf5c97c78a168bc56f5efab6fdcf7f55a78ac491a3de
+  data.tar.gz: 96f00f4e411b8f46467d3f8ff6ecb153c07a34f5496f4109361afdfe8d7493c0
 SHA512:
-  metadata.gz: dbb889837e2ef982295b2880d76bf6f928ba808b048792250c201bf101eff0151406bad78ed1ea2229d1f1bd572c7b031889386c7dc765506f5f631c30825aff
-  data.tar.gz: c6c582d64cab40f9ad203752cc8168b91e446a6535716ea7d318359990ab74f256c57b2a910bed1fbfce316a590e389901a1335770d9171c6ae3852509625ef5
+  metadata.gz: 378534362fb45c10c4aef9600771e10d13d07f827309ee2dd2395ff5c60a9b36c1e1b309e48274de3ef09ac9d16178ad563d49da437535961ba27844c86020d0
+  data.tar.gz: dda52cf9adc2768b57dc93677babdd63b5d1e500a8fbfe7c69f0dcb719701f3b986ae740d3fca703932f346b172b23e0c8561549a7f1dddad7b3b97b3605e535

data/Rakefile

@@ -12,3 +12,17 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = "test/**/test_*.rb"
   test.verbose = true
 end
+
+require 'yard'
+YARD::Rake::YardocTask.new(:yard) do |t|
+ t.files   = ['lib/**/*.rb']
+ t.options = ['--no-output']
+ t.stats_options = ['--list-undoc']
+end
+
+namespace :yard do
+  task :serve do
+    port = ENV['YARD_PORT'] || "8808"
+    sh("yard server --reload -p #{port}")
+  end
+end

data/bridgetown-core.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency("activesupport",         "~> 6.0")
   s.add_runtime_dependency("addressable",           "~> 2.4")
+  s.add_runtime_dependency("awesome_print",         "~> 1.8")
   s.add_runtime_dependency("colorator",             "~> 1.0")
   s.add_runtime_dependency("faraday",               "~> 1.0")
   s.add_runtime_dependency("faraday_middleware",    "~> 1.0")
@@ -48,4 +49,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("safe_yaml",             "~> 1.0")
   s.add_runtime_dependency("terminal-table",        "~> 1.8")
   s.add_runtime_dependency("thor",                  "~> 1.0")
+  s.add_runtime_dependency("tilt",                  "~> 2.0")
 end

data/lib/bridgetown-core.rb

@@ -54,7 +54,7 @@ module Bridgetown
   autoload :Cleaner,             "bridgetown-core/cleaner"
   autoload :Collection,          "bridgetown-core/collection"
   autoload :Configuration,       "bridgetown-core/configuration"
-  autoload :Convertible,         "bridgetown-core/concerns/convertible"
+  autoload :DataAccessible,      "bridgetown-core/concerns/data_accessible"
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :Document,            "bridgetown-core/document"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
@@ -64,6 +64,7 @@ module Bridgetown
   autoload :FrontmatterDefaults, "bridgetown-core/frontmatter_defaults"
   autoload :Hooks,               "bridgetown-core/hooks"
   autoload :Layout,              "bridgetown-core/layout"
+  autoload :LayoutPlaceable,     "bridgetown-core/concerns/layout_placeable"
   autoload :Cache,               "bridgetown-core/cache"
   autoload :CollectionReader,    "bridgetown-core/readers/collection_reader"
   autoload :DataReader,          "bridgetown-core/readers/data_reader"
@@ -77,17 +78,21 @@ module Bridgetown
   autoload :PageWithoutAFile,    "bridgetown-core/page_without_a_file"
   autoload :PathManager,         "bridgetown-core/path_manager"
   autoload :PluginManager,       "bridgetown-core/plugin_manager"
+  autoload :Publishable,         "bridgetown-core/concerns/publishable"
   autoload :Publisher,           "bridgetown-core/publisher"
   autoload :Reader,              "bridgetown-core/reader"
   autoload :Regenerator,         "bridgetown-core/regenerator"
   autoload :RelatedPosts,        "bridgetown-core/related_posts"
   autoload :Renderer,            "bridgetown-core/renderer"
+  autoload :LiquidRenderable,    "bridgetown-core/concerns/liquid_renderable"
   autoload :LiquidRenderer,      "bridgetown-core/liquid_renderer"
+  autoload :RubyTemplateView,    "bridgetown-core/ruby_template_view"
   autoload :LogWriter,           "bridgetown-core/log_writer"
   autoload :Site,                "bridgetown-core/site"
   autoload :StaticFile,          "bridgetown-core/static_file"
   autoload :URL,                 "bridgetown-core/url"
   autoload :Utils,               "bridgetown-core/utils"
+  autoload :Validatable,         "bridgetown-core/concerns/validatable"
   autoload :VERSION,             "bridgetown-core/version"
   autoload :Watcher,             "bridgetown-core/watcher"
 

data/lib/bridgetown-core/commands/concerns/actions.rb

@@ -8,9 +8,24 @@ require "active_support/core_ext/string/indent"
 module Bridgetown
   module Commands
     module Actions
+      GITHUB_REGEX = %r!https://github\.com!.freeze
+      GITHUB_TREE_REGEX = %r!#{GITHUB_REGEX}/.*/.*/tree/.*/?!.freeze
+      GITHUB_BLOB_REGEX = %r!#{GITHUB_REGEX}/.*/.*/blob/!.freeze
+
       def create_builder(filename, data = nil)
         say_status :create_builder, filename
         data ||= yield if block_given?
+
+        site_builder = File.join("plugins", "site_builder.rb")
+        unless File.exist?(site_builder)
+          create_file("plugins/site_builder.rb", verbose: true) do
+            <<~RUBY
+              class SiteBuilder < Bridgetown::Builder
+              end
+            RUBY
+          end
+        end
+
         create_file("plugins/builders/#{filename}", data, verbose: false)
       end
 
@@ -66,30 +81,48 @@ module Bridgetown
 
       private
 
-      def transform_automation_url(arg)
-        remote_file = if arg.end_with?(".rb")
-                        arg.split("/").yield_self do |segments|
-                          arg.sub!(%r!/#{segments.last}$!, "")
-                          segments.last
-                        end
-                      else
-                        "bridgetown.automation.rb"
-                      end
-
-        if arg.start_with?("https://gist.github.com")
-          return arg.sub(
-            "https://gist.github.com", "https://gist.githubusercontent.com"
-          ) + "/raw/#{remote_file}"
-        elsif arg.start_with?("https://github.com")
-          return arg.sub(
-            "https://github.com", "https://raw.githubusercontent.com"
-          ) + "/master/#{remote_file}"
+      def determine_remote_filename(arg)
+        if arg.end_with?(".rb")
+          arg.split("/").yield_self do |segments|
+            arg.sub!(%r!/#{segments.last}$!, "")
+            segments.last
+          end
+        else
+          "bridgetown.automation.rb"
         end
+      end
 
-        # TODO: option to download and confirm remote automation?
-
-        arg
+      # TODO: option to download and confirm remote automation?
+      # rubocop:disable Metrics/MethodLength
+      def transform_automation_url(arg)
+        return arg unless arg.start_with?("http")
+
+        remote_file = determine_remote_filename(arg)
+        github_match = GITHUB_REGEX.match(arg)
+
+        arg = if arg.start_with?("https://gist.github.com")
+                arg.sub(
+                  "https://gist.github.com", "https://gist.githubusercontent.com"
+                ) + "/raw"
+              elsif github_match
+                new_url = arg.sub(GITHUB_REGEX, "https://raw.githubusercontent.com")
+                github_tree_match = GITHUB_TREE_REGEX.match(arg)
+                github_blob_match = GITHUB_BLOB_REGEX.match(arg)
+
+                if github_tree_match
+                  new_url.sub("/tree/", "/")
+                elsif github_blob_match
+                  new_url.sub("/blob/", "/")
+                else
+                  "#{new_url}/master"
+                end
+              else
+                arg
+              end
+
+        "#{arg}/#{remote_file}"
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "irb"
-
 module Bridgetown
   module Commands
     class Console < Thor::Group
@@ -21,11 +19,17 @@ module Bridgetown
                    type: :array,
                    banner: "FILE1 FILE2",
                    desc: "Custom configuration file(s)"
+      class_option :"bypass-ap",
+                   type: :boolean,
+                   desc: "Don't load AwesomePrint when IRB opens"
       class_option :blank,
                    type: :boolean,
                    desc: "Skip reading content and running generators before opening console"
 
       def console
+        require "irb"
+        require "awesome_print" unless options[:"bypass-ap"]
+
         Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
                                     " (codename \"#{Bridgetown::CODE_NAME.yellow}\")" \
                                     " console…"
@@ -56,6 +60,12 @@ module Bridgetown
 
         begin
           catch(:IRB_EXIT) do
+            unless options[:"bypass-ap"]
+              AwesomePrint.defaults = {
+                indent: 2,
+              }
+              AwesomePrint.irb!
+            end
             irb.eval_input
           end
         end

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

@@ -29,6 +29,11 @@ module Bridgetown
       class_option :skip_initial_build,
                    type: :boolean,
                    desc: "Skips the initial site build which occurs before the server is started."
+      class_option :watch,
+                   type: :boolean,
+                   aliases: "-w",
+                   default: true,
+                   desc: "Watch for changes and rebuild"
 
       def self.banner
         "bridgetown serve [options]"

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module DataAccessible
+    # Returns the contents as a String.
+    def to_s
+      output || content || ""
+    end
+
+    # Accessor for data properties by Liquid.
+    #
+    # property - The String name of the property to retrieve.
+    #
+    # Returns the String value or nil if the property isn't included.
+    def [](property)
+      data[property]
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module LayoutPlaceable
+    # Determine whether the file should be placed into layouts.
+    #
+    # Returns false if the document is an asset file or if the front matter
+    #   specifies `layout: none`
+    def place_in_layout?
+      !(yaml_file? || no_layout?)
+    end
+
+    def no_layout?
+      data["layout"] == "none"
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module LiquidRenderable
+    # Determine whether the file should be rendered with Liquid.
+    #
+    # Returns false if the document is a yaml file or if the document doesn't
+    # contain any Liquid Tags or Variables, true otherwise.
+    def render_with_liquid?
+      return false if data["render_with_liquid"] == false
+
+      !(yaml_file? || !Utils.has_liquid_construct?(content))
+    end
+
+    # Override in individual classes
+    def yaml_file?
+      false
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Publishable
+    # Whether the file is published or not, as indicated in YAML front-matter
+    def published?
+      !(data.key?("published") && data["published"] == false)
+    end
+  end
+end

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

@@ -2,12 +2,17 @@
 
 module Bridgetown
   module Site::Configurable
-    # Public: Set the site's configuration. This handles side-effects caused by
+    # Set the site's configuration. This handles side-effects caused by
     # changing values in the configuration.
     #
-    # config - a Bridgetown::Configuration, containing the new configuration.
+    # @param config [Bridgetown::Configuration]
+    #   An instance of {Bridgetown::Configuration},
+    #   containing the new configuration.
     #
-    # Returns the new configuration.
+    # @return [Bridgetown::Configuration]
+    #   A new instance of {Bridgetown::Configuration}
+    #
+    # @see Bridgetown::Configuration
     def config=(config)
       @config = config.clone
 
@@ -32,81 +37,107 @@ module Bridgetown
       @config
     end
 
-    # Returns the FrontmatterDefaults or creates a new FrontmatterDefaults
-    # if it doesn't already exist.
+    # Returns the current instance of {FrontmatterDefaults} or
+    # creates a new instance {FrontmatterDefaults} if it doesn't already exist.
     #
-    # Returns The FrontmatterDefaults
+    # @return [FrontmatterDefaults]
+    #   Returns an instance of {FrontmatterDefaults}
     def frontmatter_defaults
       @frontmatter_defaults ||= FrontmatterDefaults.new(self)
     end
 
-    # Whether to perform a full rebuild without incremental regeneration
+    # 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.
     #
-    # Returns a Boolean: true for a full rebuild, false for normal build
+    # @param [Hash] override
+    #   An override hash to override the current config value
+    # @option override [Boolean] "incremental" Whether to incrementally build
+    # @return [Boolean] true for full rebuild, false for normal build
     def incremental?(override = {})
       override["incremental"] || config["incremental"]
     end
 
-    # Returns the publisher or creates a new publisher if it doesn't
-    # already exist.
+    # Returns the current instance of {Publisher} or creates a new instance of
+    # {Publisher} if one doesn't exist.
     #
-    # Returns The Publisher
+    # @return [Publisher] Returns an instance of {Publisher}
     def publisher
       @publisher ||= Publisher.new(self)
     end
 
-    # Public: Prefix a given path with the root directory.
+    # Prefix a path or paths with the {#root_dir} directory.
     #
-    # paths - (optional) path elements to a file or directory within the
-    #         root directory
+    # @see Bridgetown.sanitized_path
+    # @param paths [Array<String>]
+    #   An array of paths to prefix with the root_dir directory using the
+    #   {Bridgetown.sanitized_path} method.
     #
-    # Returns a path which is prefixed with the root_dir directory.
+    # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_root_dir(*paths)
       paths.reduce(root_dir) do |base, path|
         Bridgetown.sanitized_path(base, path)
       end
     end
 
-    # Public: Prefix a given path with the source directory.
-    #
-    # paths - (optional) path elements to a file or directory within the
-    #         source directory
+    # Prefix a path or paths with the {#source} directory.
     #
-    # Returns a path which is prefixed with the source directory.
+    # @see Bridgetown.sanitized_path
+    # @param paths [Array<String>]
+    #   An array of paths to prefix with the source directory using the
+    #   {Bridgetown.sanitized_path} method.
+    # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_source_dir(*paths)
       paths.reduce(source) do |base, path|
         Bridgetown.sanitized_path(base, path)
       end
     end
 
-    # Public: Prefix a given path with the destination directory.
+    # Prefix a path or paths with the {#dest} directory.
     #
-    # paths - (optional) path elements to a file or directory within the
-    #         destination directory
+    # @see Bridgetown.sanitized_path
+    # @param paths [Array<String>]
+    #   An array of paths to prefix with the destination directory using the
+    #   {Bridgetown.sanitized_path} method.
     #
-    # Returns a path which is prefixed with the destination directory.
+    # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_dest_dir(*paths)
       paths.reduce(dest) do |base, path|
         Bridgetown.sanitized_path(base, path)
       end
     end
 
-    # Public: Prefix a given path with the cache directory.
+    # Prefix a path or paths with the {#cache_dir} directory.
     #
-    # paths - (optional) path elements to a file or directory within the
-    #         cache directory
+    # @see Bridgetown.sanitized_path
+    # @param paths [Array<String>]
+    #   An array of paths to prefix with the {#cache_dir} directory using the
+    #   {Bridgetown.sanitized_path} method.
     #
-    # Returns a path which is prefixed with the cache directory.
+    # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_cache_dir(*paths)
       paths.reduce(cache_dir) do |base, path|
         Bridgetown.sanitized_path(base, path)
       end
     end
 
-    # Public: The full path to the directory that houses all the collections registered
-    # with the current site.
+    # The full path to the directory that houses all the registered collections
+    # for the current site.
+    #
+    # 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 not
+    # specified, assign {#source} to +@collections_path+
     #
-    # Returns the source directory or the absolute path to the custom collections_dir
+    # @return [String] Returns the full path to the collections directory
+    # @see #config
+    # @see #source
+    # @see #collections_path
+    # @see #in_source_dir
     def collections_path
       dir_str = config["collections_dir"]
       @collections_path ||= dir_str.empty? ? source : in_source_dir(dir_str)