bridgetown-core 0.14.1 → 0.15.0

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

@@ -2,40 +2,41 @@
 
 module Bridgetown
   module Commands
-    class Clean < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:clean) do |c|
-            c.syntax "clean [subcommand]"
-            c.description "Clean the site " \
-                  "(removes site output and metadata file) without building."
+    class Clean < Thor::Group
+      extend BuildOptions
+      extend Summarizable
+      include ConfigurationOverridable
 
-            add_build_options(c)
+      Registrations.register do
+        register(Clean, "clean", "clean", Clean.summary)
+      end
 
-            c.action do |_, options|
-              Bridgetown::Commands::Clean.process(options)
-            end
-          end
-        end
+      def self.banner
+        "bridgetown clean [options]"
+      end
+      summary "Clean the site (removes site output and metadata file) without building"
 
-        def process(options)
-          options = configuration_from_options(options)
-          destination = options["destination"]
-          metadata_file = File.join(options["source"], ".bridgetown-metadata")
-          cache_dir = File.join(options["source"], options["cache_dir"])
+      def clean
+        config = configuration_with_overrides(options)
+        destination = config["destination"]
+        metadata_file = File.join(config["root_dir"], ".bridgetown-metadata")
+        cache_dir = File.join(config["root_dir"], config["cache_dir"])
+        webpack_dir = File.join(config["root_dir"], ".bridgetown-webpack")
 
-          remove(destination, checker_func: :directory?)
-          remove(metadata_file, checker_func: :file?)
-          remove(cache_dir, checker_func: :directory?)
-        end
+        remove(destination, checker_func: :directory?)
+        remove(metadata_file, checker_func: :file?)
+        remove(cache_dir, checker_func: :directory?)
+        remove(webpack_dir, checker_func: :directory?)
+      end
+
+      protected
 
-        def remove(filename, checker_func: :file?)
-          if File.public_send(checker_func, filename)
-            Bridgetown.logger.info "Cleaner:", "Removing #{filename}..."
-            FileUtils.rm_rf(filename)
-          else
-            Bridgetown.logger.info "Cleaner:", "Nothing to do for #{filename}."
-          end
+      def remove(filename, checker_func: :file?)
+        if File.public_send(checker_func, filename)
+          Bridgetown.logger.info "Cleaner:", "Removing #{filename}..."
+          FileUtils.rm_rf(filename)
+        else
+          Bridgetown.logger.info "Cleaner:", "Nothing to do for #{filename}."
         end
       end
     end

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

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Mostly not used here, but may come in handy in new automations
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/string/strip"
+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
+
+      def javascript_import(data = nil, filename: "index.js")
+        data ||= yield if block_given?
+        data += "\n" unless data.chars.last == "\n"
+
+        say_status :javascript_import, filename
+
+        js_index = File.join("frontend", "javascript", filename)
+        if File.exist?(js_index)
+          index_file = File.read(js_index)
+
+          last_import = ""
+          index_file.each_line do |line|
+            line.start_with?("import ") ? last_import = line : break
+          end
+
+          if last_import == ""
+            # add to top of file
+            prepend_file js_index, data, verbose: false
+          else
+            # inject after the last import line
+            inject_into_file js_index, data, after: last_import, verbose: false, force: false
+          end
+        else
+          create_file(js_index, data, verbose: false)
+        end
+      end
+
+      def add_bridgetown_plugin(gemname, version: nil)
+        version = " -v \"#{version}\"" if version
+        run "bundle add #{gemname}#{version} -g bridgetown_plugins"
+      rescue SystemExit
+        say_status :run, "Gem not added due to bundler error", :red
+      end
+
+      def add_yarn_for_gem(gemname)
+        say_status :add_yarn, gemname
+
+        Bundler.reset!
+        available_gems = Bundler.setup Bridgetown::PluginManager::PLUGINS_GROUP
+        Bridgetown::PluginManager.install_yarn_dependencies(
+          available_gems.requested_specs, gemname
+        )
+      rescue SystemExit
+        say_status :add_yarn, "Package not added due to yarn error", :red
+      end
+
+      def apply_from_url(url)
+        apply transform_automation_url(url.dup)
+      end
+
+      private
+
+      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?
+      # 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/concerns/build_options.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    module BuildOptions
+      def self.extended(klass)
+        klass.class_option :trace,
+                           type: :boolean,
+                           aliases: "-t",
+                           desc: "Show the full backtrace when an error occurs during watch mode"
+
+        klass.class_option :config,
+                           type: :array,
+                           banner: "FILE1 FILE2",
+                           desc: "Custom configuration file(s)"
+        klass.class_option :source,
+                           aliases: "-s",
+                           desc: "Source directory (defaults to src)"
+        klass.class_option :destination,
+                           aliases: "-d",
+                           desc: "Destination directory (defaults to output)"
+        klass.class_option :root_dir,
+                           aliases: "-r",
+                           desc: "The top-level root folder" \
+                                 " where config files are located"
+        klass.class_option :plugins_dir,
+                           aliases: "-p",
+                           type: :array,
+                           banner: "DIR1 DIR2",
+                           desc: "Plugins directory (defaults to plugins)"
+        klass.class_option :layouts_dir,
+                           desc: "Layouts directory (defaults to src/_layouts)"
+        klass.class_option :future,
+                           type: :boolean,
+                           desc: "Publishes posts with a future date"
+        klass.class_option :limit_posts,
+                           type: :numeric,
+                           desc: "Limits the number of posts to parse and publish"
+        klass.class_option :baseurl,
+                           aliases: "-b",
+                           desc: "Serve the website from the given base URL"
+        klass.class_option :force_polling,
+                           type: :boolean,
+                           desc: "Force watch to use polling"
+        klass.class_option :lsi,
+                           type: :boolean,
+                           desc: "Use LSI for improved related posts"
+        klass.class_option :unpublished,
+                           type: :boolean,
+                           aliases: "-U",
+                           desc: "Render posts that were marked as unpublished"
+        klass.class_option :disable_disk_cache,
+                           type: :boolean,
+                           desc: "Disable caching to disk"
+        klass.class_option :profile,
+                           type: :boolean,
+                           desc: "Generate a Liquid rendering profile"
+        klass.class_option :quiet,
+                           aliases: "-q",
+                           type: :boolean,
+                           desc: "Silence output."
+        klass.class_option :verbose,
+                           aliases: "-V",
+                           type: :boolean,
+                           desc: "Print verbose output."
+        klass.class_option :incremental,
+                           aliases: "-I",
+                           type: :boolean,
+                           desc: "Enable incremental rebuild."
+        klass.class_option :strict_front_matter,
+                           type: :boolean,
+                           desc: "Fail if errors are present in front matter"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    module ConfigurationOverridable
+      # Create a full Bridgetown configuration with the options passed in as overrides
+      #
+      # options - the configuration overrides
+      #
+      # Returns a full Bridgetown configuration
+      def configuration_with_overrides(options)
+        return options if options.is_a?(Bridgetown::Configuration)
+
+        Bridgetown.configuration(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    module Summarizable
+      def summary(description = nil)
+        return @desc.split("\n").last.strip unless description
+
+        desc "Description:\n  #{description}"
+      end
+    end
+  end
+end

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

@@ -1,56 +1,74 @@
 # frozen_string_literal: true
 
-require "irb"
-
 module Bridgetown
   module Commands
-    class Console < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:console) do |c|
-            c.syntax "console"
-            c.description "Invoke an IRB console with the site loaded"
-            c.alias :c
-
-            add_build_options(c)
-
-            c.action do |_, options|
-              Bridgetown::Commands::Console.process(options)
-            end
-          end
-        end
+    class Console < Thor::Group
+      extend Summarizable
+      include ConfigurationOverridable
+
+      Registrations.register do
+        register(Console, "console", "console", Console.summary)
+      end
+
+      def self.banner
+        "bridgetown console [options]"
+      end
+      summary "Invoke an IRB console with the site loaded"
+
+      class_option :config,
+                   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…"
+        Bridgetown.logger.info "Environment:", Bridgetown.environment.cyan
+        site = Bridgetown::Site.new(configuration_with_overrides(options))
 
-        # TODO: is there a way to add a unit test for this command?
-        # rubocop:disable Style/GlobalVars, Metrics/AbcSize, Metrics/MethodLength
-        def process(options)
-          Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
-                                      " (codename \"#{Bridgetown::CODE_NAME.yellow}\")" \
-                                      " console…"
-          Bridgetown.logger.info "Environment:", Bridgetown.environment.cyan
-          site = Bridgetown::Site.new(configuration_from_options(options))
+        unless options[:blank]
           site.reset
+          Bridgetown.logger.info "Reading files..."
           site.read
+          Bridgetown.logger.info "", "done!"
+          Bridgetown.logger.info "Running generators..."
           site.generate
+          Bridgetown.logger.info "", "done!"
+        end
 
-          $BRIDGETOWN_SITE = site
-          IRB.setup(nil)
-          workspace = IRB::WorkSpace.new
-          irb = IRB::Irb.new(workspace)
-          IRB.conf[:MAIN_CONTEXT] = irb.context
-          eval("site = $BRIDGETOWN_SITE", workspace.binding, __FILE__, __LINE__)
-          Bridgetown.logger.info "Console:", "Now loaded as " + "site".cyan + " variable."
+        $BRIDGETOWN_SITE = site
+        IRB.setup(nil)
+        workspace = IRB::WorkSpace.new
+        irb = IRB::Irb.new(workspace)
+        IRB.conf[:MAIN_CONTEXT] = irb.context
+        eval("site = $BRIDGETOWN_SITE", workspace.binding, __FILE__, __LINE__)
+        Bridgetown.logger.info "Console:", "Now loaded as " + "site".cyan + " variable."
 
-          trap("SIGINT") do
-            irb.signal_handle
-          end
+        trap("SIGINT") do
+          irb.signal_handle
+        end
 
-          begin
-            catch(:IRB_EXIT) do
-              irb.eval_input
+        begin
+          catch(:IRB_EXIT) do
+            unless options[:"bypass-ap"]
+              AwesomePrint.defaults = {
+                indent: 2,
+              }
+              AwesomePrint.irb!
             end
+            irb.eval_input
           end
         end
-        # rubocop:enable Style/GlobalVars, Metrics/AbcSize, Metrics/MethodLength
       end
     end
   end

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

@@ -2,160 +2,160 @@
 
 module Bridgetown
   module Commands
-    class Doctor < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:doctor) do |c|
-            c.syntax "doctor"
-            c.description "Search site and print specific deprecation warnings"
-
-            add_build_options(c)
-
-            c.action do |_, options|
-              Bridgetown::Commands::Doctor.process(options)
-            end
-          end
-        end
+    class Doctor < Thor::Group
+      extend BuildOptions
+      extend Summarizable
+      include ConfigurationOverridable
 
-        def process(options)
-          site = Bridgetown::Site.new(configuration_from_options(options))
-          site.reset
-          site.read
-          site.generate
+      Registrations.register do
+        register(Doctor, "doctor", "doctor", Doctor.summary)
+      end
 
-          if healthy?(site)
-            Bridgetown.logger.info "Your test results", "are in. Everything looks fine."
-          else
-            abort
-          end
+      def self.banner
+        "bridgetown doctor [options]"
+      end
+      summary "Search site and print specific deprecation warnings"
+
+      def doctor
+        site = Bridgetown::Site.new(configuration_with_overrides(options))
+        site.reset
+        site.read
+        site.generate
+
+        if healthy?(site)
+          Bridgetown.logger.info "Your test results", "are in. Everything looks fine."
+        else
+          abort
         end
+      end
 
-        def healthy?(site)
-          [
-            fsnotify_buggy?(site),
-            !conflicting_urls(site),
-            !urls_only_differ_by_case(site),
-            proper_site_url?(site),
-            properly_gathered_posts?(site),
-          ].all?
-        end
+      protected
+
+      def healthy?(site)
+        [
+          fsnotify_buggy?(site),
+          !conflicting_urls(site),
+          !urls_only_differ_by_case(site),
+          proper_site_url?(site),
+          properly_gathered_posts?(site),
+        ].all?
+      end
 
-        def properly_gathered_posts?(site)
-          return true if site.config["collections_dir"].empty?
+      def properly_gathered_posts?(site)
+        return true if site.config["collections_dir"].empty?
 
-          posts_at_root = site.in_source_dir("_posts")
-          return true unless File.directory?(posts_at_root)
+        posts_at_root = site.in_source_dir("_posts")
+        return true unless File.directory?(posts_at_root)
 
-          Bridgetown.logger.warn "Warning:",
-                                 "Detected '_posts' directory outside custom `collections_dir`!"
-          Bridgetown.logger.warn "",
-                                 "Please move '#{posts_at_root}' into the custom directory at " \
-                "'#{site.in_source_dir(site.config["collections_dir"])}'"
-          false
-        end
+        Bridgetown.logger.warn "Warning:",
+                               "Detected '_posts' directory outside custom `collections_dir`!"
+        Bridgetown.logger.warn "",
+                               "Please move '#{posts_at_root}' into the custom directory at " \
+              "'#{site.in_source_dir(site.config["collections_dir"])}'"
+        false
+      end
 
-        def conflicting_urls(site)
-          conflicting_urls = false
-          urls = {}
-          urls = collect_urls(urls, site.pages, site.dest)
-          urls = collect_urls(urls, site.posts.docs, site.dest)
-          urls.each do |url, paths|
-            next unless paths.size > 1
-
-            conflicting_urls = true
-            Bridgetown.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
-              " for the following pages: #{paths.join(", ")}"
-          end
-          conflicting_urls
+      def conflicting_urls(site)
+        conflicting_urls = false
+        urls = {}
+        urls = collect_urls(urls, site.pages, site.dest)
+        urls = collect_urls(urls, site.posts.docs, site.dest)
+        urls.each do |url, paths|
+          next unless paths.size > 1
+
+          conflicting_urls = true
+          Bridgetown.logger.warn "Conflict:", "The URL '#{url}' is the destination" \
+            " for the following pages: #{paths.join(", ")}"
         end
+        conflicting_urls
+      end
 
-        def fsnotify_buggy?(_site)
-          return true unless Utils::Platforms.osx?
-
-          if Dir.pwd != `pwd`.strip
-            Bridgetown.logger.error "  " + <<-STR.strip.gsub(%r!\n\s+!, "\n  ")
-              We have detected that there might be trouble using fsevent on your
-              operating system, you can read https://github.com/thibaudgg/rb-fsevent/wiki/no-fsevents-fired-(OSX-bug)
-              for possible work arounds or you can work around it immediately
-              with `--force-polling`.
-            STR
+      def fsnotify_buggy?(_site)
+        return true unless Utils::Platforms.osx?
 
-            false
-          end
+        if Dir.pwd != `pwd`.strip
+          Bridgetown.logger.error "  " + <<-STR.strip.gsub(%r!\n\s+!, "\n  ")
+            We have detected that there might be trouble using fsevent on your
+            operating system, you can read https://github.com/thibaudgg/rb-fsevent/wiki/no-fsevents-fired-(OSX-bug)
+            for possible work arounds or you can work around it immediately
+            with `--force-polling`.
+          STR
 
-          true
+          false
         end
 
-        def urls_only_differ_by_case(site)
-          urls_only_differ_by_case = false
-          urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
-          urls.each_value do |real_urls|
-            next unless real_urls.uniq.size > 1
+        true
+      end
 
-            urls_only_differ_by_case = true
-            Bridgetown.logger.warn "Warning:", "The following URLs only differ" \
-              " by case. On a case-insensitive file system one of the URLs" \
-              " will be overwritten by the other: #{real_urls.join(", ")}"
-          end
-          urls_only_differ_by_case
-        end
+      def urls_only_differ_by_case(site)
+        urls_only_differ_by_case = false
+        urls = case_insensitive_urls(site.pages + site.docs_to_write, site.dest)
+        urls.each_value do |real_urls|
+          next unless real_urls.uniq.size > 1
 
-        def proper_site_url?(site)
-          url = site.config["url"]
-          [
-            url_exists?(url),
-            url_valid?(url),
-            url_absolute(url),
-          ].all?
+          urls_only_differ_by_case = true
+          Bridgetown.logger.warn "Warning:", "The following URLs only differ" \
+            " by case. On a case-insensitive file system one of the URLs" \
+            " will be overwritten by the other: #{real_urls.join(", ")}"
         end
+        urls_only_differ_by_case
+      end
 
-        private
+      def proper_site_url?(site)
+        url = site.config["url"]
+        [
+          url_exists?(url),
+          url_valid?(url),
+          url_absolute(url),
+        ].all?
+      end
 
-        def collect_urls(urls, things, destination)
-          things.each do |thing|
-            dest = thing.destination(destination)
-            if urls[dest]
-              urls[dest] << thing.path
-            else
-              urls[dest] = [thing.path]
-            end
+      private
+
+      def collect_urls(urls, things, destination)
+        things.each do |thing|
+          dest = thing.destination(destination)
+          if urls[dest]
+            urls[dest] << thing.path
+          else
+            urls[dest] = [thing.path]
           end
-          urls
         end
+        urls
+      end
 
-        def case_insensitive_urls(things, destination)
-          things.each_with_object({}) do |thing, memo|
-            dest = thing.destination(destination)
-            (memo[dest.downcase] ||= []) << dest
-          end
+      def case_insensitive_urls(things, destination)
+        things.each_with_object({}) do |thing, memo|
+          dest = thing.destination(destination)
+          (memo[dest.downcase] ||= []) << dest
         end
+      end
 
-        def url_exists?(url)
-          return true unless url.nil? || url.empty?
+      def url_exists?(url)
+        return true unless url.nil? || url.empty?
 
-          Bridgetown.logger.warn "Warning:", "You didn't set an URL in the config file, "\
-              "you may encounter problems with some plugins."
-          false
-        end
+        Bridgetown.logger.warn "Warning:", "You didn't set an URL in the config file, "\
+            "you may encounter problems with some plugins."
+        false
+      end
 
-        def url_valid?(url)
-          Addressable::URI.parse(url)
-          true
-        # Addressable::URI#parse only raises a TypeError
-        # https://git.io/vFfbx
-        rescue TypeError
-          Bridgetown.logger.warn "Warning:", "The site URL does not seem to be valid, "\
-              "check the value of `url` in your config file."
-          false
-        end
+      def url_valid?(url)
+        Addressable::URI.parse(url)
+        true
+      # Addressable::URI#parse only raises a TypeError
+      # https://git.io/vFfbx
+      rescue TypeError
+        Bridgetown.logger.warn "Warning:", "The site URL does not seem to be valid, "\
+            "check the value of `url` in your config file."
+        false
+      end
 
-        def url_absolute(url)
-          return true if url.is_a?(String) && Addressable::URI.parse(url).absolute?
+      def url_absolute(url)
+        return true if url.is_a?(String) && Addressable::URI.parse(url).absolute?
 
-          Bridgetown.logger.warn "Warning:", "Your site URL does not seem to be absolute, "\
-              "check the value of `url` in your config file."
-          false
-        end
+        Bridgetown.logger.warn "Warning:", "Your site URL does not seem to be absolute, "\
+            "check the value of `url` in your config file."
+        false
       end
     end
   end