bridgetown-core 0.12.0 → 0.15.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f4610f5a38cc797e719301a59ce3c40ceef246702f3f20f6608a01cb05b23f
-  data.tar.gz: 749f92dfd628f60c5cce698b009aa6aed110fc48daa921b523b50f2617d7987e
+  metadata.gz: ba553587c222b3cedc1844d3bf40845a83dd24d70e3c85d49965ad010687e1b5
+  data.tar.gz: 223fea6ecf255ebaab06e34d3f8fa8e47ab64d0dd63d2dffc5cd25361a232ded
 SHA512:
-  metadata.gz: b1707b9be0641a5814fb6817633c5013e38aeb7293fb353e4cb6f9cde1cab7d09c3f91f3237fbcf435659f2cc61c8345d4c43162252b04308847c56233704df7
-  data.tar.gz: 3e859ebb2c76bacacbb87c53f803277042560d6e9579911912504b5dd470f22a8be314ad440134fd97c8558d8757b0d7ba6988466804031934d7aedfc6ea6afc
+  metadata.gz: dbb889837e2ef982295b2880d76bf6f928ba808b048792250c201bf101eff0151406bad78ed1ea2229d1f1bd572c7b031889386c7dc765506f5f631c30825aff
+  data.tar.gz: c6c582d64cab40f9ad203752cc8168b91e446a6535716ea7d318359990ab74f256c57b2a910bed1fbfce316a590e389901a1335770d9171c6ae3852509625ef5

data/Rakefile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 $LOAD_PATH.unshift File.expand_path("lib", __dir__)
 require "bridgetown-core/version"
 
-task :spec => :test
+task spec: :test
 require "rake/testtask"
 Rake::TestTask.new(:test) do |test|
   test.libs << "lib" << "test"

data/bin/bridgetown

@@ -6,56 +6,17 @@ STDOUT.sync = true
 $LOAD_PATH.unshift File.expand_path("../../bridgetown/lib", __dir__)
 
 require "bridgetown"
-require "mercenary"
 
 Bridgetown::PluginManager.require_from_bundler
 
-Bridgetown::Deprecator.process(ARGV)
+# Support NO_COLOR: https://no-color.org
+# TODO: need to change behavior of Colorator gem
+ENV["THOR_SHELL"] = "Basic" if ENV["NO_COLOR"]
 
-Mercenary.program(:bridgetown) do |p|
-  p.version Bridgetown::VERSION
-  p.description "Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era"
-  p.syntax "bridgetown <subcommand> [options]"
+output_version = if ARGV[0] == "-v"
+                   puts "bridgetown #{Bridgetown::VERSION} \"#{Bridgetown::CODE_NAME}\""
+                   true
+                 end
 
-  # TODO: it seems wonky to include build options in this top-level
-  # exe. Should probably remove most things here and relocated to
-  # individual comments. …in fact there are duplicate option listings
-  # if you do bridgetown build --help — ouch!
-  p.option "source", "-s", "--source [DIR]", "Source directory (defaults to src)"
-  p.option "destination", "-d", "--destination [DIR]",
-    "Destination directory (defaults to output)"
-  p.option "plugins_dir", "-p", "--plugins PLUGINS_DIR1[,PLUGINS_DIR2[,...]]", Array,
-    "Plugins directory (defaults to plugins)"
-  p.option "layouts_dir", "--layouts DIR", String,
-    "Layouts directory (defaults to src/_layouts)"
-  p.option "profile", "--profile", "Generate a Liquid rendering profile"
-
-#  TODO: this is not the way to bring in extra command gems! 
-#  Bridgetown::External.require_if_present(Bridgetown::External.blessed_gems) do |g, ver_constraint|
-#    cmd = g.split("-").last
-#    p.command(cmd.to_sym) do |c|
-#      c.syntax cmd
-#      c.action do
-#        Bridgetown.logger.abort_with "You must install the '#{g}' gem" \
-#          " version #{ver_constraint} to use the 'bridgetown #{cmd}' command."
-#      end
-#    end
-#  end
-
-  Bridgetown::Command.subclasses.each { |c| c.init_with_program(p) }
-
-  p.action do |args, _|
-    if args.empty?
-      Bridgetown.logger.error "A subcommand is required."
-      puts p
-      abort
-    else
-      subcommand = args.first
-      unless p.has_command? subcommand
-        Bridgetown.logger.abort_with "fatal: 'bridgetown #{args.first}' could not" \
-          " be found. You may need to install the bridgetown-#{args.first} gem" \
-          " or a related gem to be able to use this subcommand."
-      end
-    end
-  end
-end
+require "bridgetown-core/commands/base"
+Bridgetown::Commands::Base.start unless output_version

data/bridgetown-core.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |s|
   s.license       = "MIT"
   s.author        = "Bridgetown Team"
   s.email         = "maintainers@bridgetownrb.com"
-  s.homepage      = "https://bridgetownrb.com"
+  s.homepage      = "https://www.bridgetownrb.com"
   s.summary       = "A Webpack-aware, Ruby-based static site generator for the modern Jamstack era"
   s.description   = "Bridgetown is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era"
 
   s.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(benchmark|features|script|test)/})
+    f.match(%r!^(benchmark|features|script|test)/!)
   end
   s.executables   = ["bridgetown"]
   s.bindir        = "bin"
@@ -26,21 +26,26 @@ Gem::Specification.new do |s|
     "homepage_uri"    => s.homepage,
   }
 
-  s.rdoc_options     = ["--charset=UTF-8"]
+  s.rdoc_options = ["--charset=UTF-8"]
 
-  s.required_ruby_version     = ">= 2.4.0"
+  s.required_ruby_version     = ">= 2.5.0"
   s.required_rubygems_version = ">= 2.7.0"
 
+  s.add_runtime_dependency("activesupport",         "~> 6.0")
   s.add_runtime_dependency("addressable",           "~> 2.4")
   s.add_runtime_dependency("colorator",             "~> 1.0")
+  s.add_runtime_dependency("faraday",               "~> 1.0")
+  s.add_runtime_dependency("faraday_middleware",    "~> 1.0")
   s.add_runtime_dependency("i18n",                  "~> 1.0")
   s.add_runtime_dependency("kramdown",              "~> 2.1")
   s.add_runtime_dependency("kramdown-parser-gfm",   "~> 1.0")
   s.add_runtime_dependency("liquid",                "~> 4.0")
+  s.add_runtime_dependency("liquid-component",      ">= 0.1")
+  s.add_runtime_dependency("liquid-render-tag",     "~> 0.2")
   s.add_runtime_dependency("listen",                "~> 3.0")
-  s.add_runtime_dependency("mercenary",             "~> 0.4.0")
   s.add_runtime_dependency("pathutil",              "~> 0.9")
   s.add_runtime_dependency("rouge",                 "~> 3.0")
   s.add_runtime_dependency("safe_yaml",             "~> 1.0")
   s.add_runtime_dependency("terminal-table",        "~> 1.8")
+  s.add_runtime_dependency("thor",                  "~> 1.0")
 end

data/lib/bridgetown-core.rb

@@ -29,22 +29,32 @@ require "csv"
 require "json"
 
 # 3rd party
+require "active_support/core_ext/hash/indifferent_access"
+require "active_support/core_ext/string/inflections"
 require "pathutil"
 require "addressable/uri"
 require "safe_yaml/load"
 require "liquid"
+require "liquid-render-tag"
+require "liquid-component"
 require "kramdown"
 require "colorator"
 require "i18n"
+require "faraday"
+require "thor"
 
 SafeYAML::OPTIONS[:suppress_warnings] = true
 
+# Create our little String subclass for Ruby Front Matter
+class Rb < String; end
+SafeYAML::OPTIONS[:whitelisted_tags] = ["!ruby/string:Rb"]
+
 module Bridgetown
   # internal requires
   autoload :Cleaner,             "bridgetown-core/cleaner"
   autoload :Collection,          "bridgetown-core/collection"
   autoload :Configuration,       "bridgetown-core/configuration"
-  autoload :Convertible,         "bridgetown-core/convertible"
+  autoload :Convertible,         "bridgetown-core/concerns/convertible"
   autoload :Deprecator,          "bridgetown-core/deprecator"
   autoload :Document,            "bridgetown-core/document"
   autoload :EntryFilter,         "bridgetown-core/entry_filter"
@@ -60,6 +70,7 @@ module Bridgetown
   autoload :LayoutReader,        "bridgetown-core/readers/layout_reader"
   autoload :PostReader,          "bridgetown-core/readers/post_reader"
   autoload :PageReader,          "bridgetown-core/readers/page_reader"
+  autoload :PluginContentReader, "bridgetown-core/readers/plugin_content_reader"
   autoload :StaticFileReader,    "bridgetown-core/readers/static_file_reader"
   autoload :LogAdapter,          "bridgetown-core/log_adapter"
   autoload :Page,                "bridgetown-core/page"
@@ -81,16 +92,15 @@ module Bridgetown
   autoload :Watcher,             "bridgetown-core/watcher"
 
   # extensions
+  require "bridgetown-core/commands/registrations"
   require "bridgetown-core/plugin"
   require "bridgetown-core/converter"
   require "bridgetown-core/generator"
-  require "bridgetown-core/command"
   require "bridgetown-core/liquid_extensions"
   require "bridgetown-core/filters"
 
   require "bridgetown-core/drops/drop"
   require "bridgetown-core/drops/document_drop"
-  require_all "bridgetown-core/commands"
   require_all "bridgetown-core/converters"
   require_all "bridgetown-core/converters/markdown"
   require_all "bridgetown-core/drops"
@@ -101,9 +111,10 @@ module Bridgetown
     # Public: Tells you which Bridgetown environment you are building in so
     # you can skip tasks if you need to.
 
-    def env
+    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
@@ -128,6 +139,11 @@ module Bridgetown
       end
     end
 
+    # Conveinence method to register a new Thor command
+    def register_command(&block)
+      Bridgetown::Commands::Registrations.register(&block)
+    end
+
     # Public: Set the TZ environment variable to use the timezone specified
     #
     # timezone - the IANA Time Zone

data/lib/bridgetown-core/cleaner.rb

@@ -24,6 +24,7 @@ module Bridgetown
     def obsolete_files
       out = (existing_files - new_files - new_dirs + replaced_files).to_a
       Bridgetown::Hooks.trigger :clean, :on_obsolete, out
+      @new_files = @new_dirs = nil
       out
     end
 

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

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    class Apply < Thor::Group
+      include Thor::Actions
+      include Actions
+      extend Summarizable
+
+      Registrations.register do
+        register(Apply, "apply", "apply", Apply.summary)
+      end
+
+      def self.banner
+        "bridgetown apply PATH or URL"
+      end
+      summary "Applies an automation to the current site"
+
+      def self.source_root
+        Dir.pwd
+      end
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def apply_automation
+        @source_paths = [Dir.pwd]
+
+        if options[:apply]
+          apply_after_new_command
+        else
+          apply_in_pwd
+        end
+      rescue SystemExit => e
+        Bridgetown.logger.error "Problem occurred while running automation:"
+        e.backtrace[0..3].each do |backtrace_line|
+          Bridgetown.logger.info backtrace_line if backtrace_line.include?(":in `apply'")
+        end
+        raise e
+      end
+
+      protected
+
+      def apply_after_new_command
+        # Coming from the new command, so set up proper bundler env
+        Bundler.with_clean_env do
+          self.destination_root = New.created_site_dir
+          inside(New.created_site_dir) do
+            apply_from_url options[:apply]
+          end
+        end
+      end
+
+      def apply_in_pwd
+        # Running standalone
+        automation_command = args.empty? ? "bridgetown.automation.rb" : args[0]
+
+        if args.empty? && !File.exist?("bridgetown.automation.rb")
+          raise ArgumentError, "You must specify a path or a URL," \
+                               " or add bridgetown.automation.rb to the" \
+                               " current folder."
+        end
+
+        Bundler.with_clean_env do
+          apply_from_url automation_command
+        end
+      rescue ArgumentError => e
+        Bridgetown.logger.warn "Oops!", e.message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_all "bridgetown-core/commands/concerns"
+require_all "bridgetown-core/commands"
+
+module Bridgetown
+  module Commands
+    class Base < Thor
+      def self.exit_on_failure?
+        true
+      end
+
+      Registrations.registrations.each do |block|
+        instance_exec(&block)
+      end
+
+      class << self
+        # Override single character commands if necessary
+        def find_command_possibilities(subcommand)
+          if subcommand == "c"
+            ["console"]
+          else
+            super
+          end
+        end
+      end
+
+      desc "help <command>", "Show detailed command usage information and exit"
+      def help(subcommand = nil)
+        if subcommand && respond_to?(subcommand)
+          klass = Kernel.const_get("Bridgetown::Commands::#{subcommand.capitalize}")
+          klass.start(["-h"])
+        else
+          puts "Bridgetown v#{Bridgetown::VERSION.magenta} \"#{Bridgetown::CODE_NAME.yellow}\"" \
+               " is a Webpack-aware, Ruby-powered static site generator for the modern Jamstack era"
+          puts ""
+          puts "Usage:"
+          puts "  bridgetown <command> [options]"
+          puts ""
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -2,106 +2,111 @@
 
 module Bridgetown
   module Commands
-    class Build < Command
-      class << self
-        # Create the Mercenary command for the Bridgetown CLI for this Command
-        def init_with_program(prog)
-          prog.command(:build) do |c|
-            c.syntax      "build [options]"
-            c.description "Build your site"
-            c.alias :b
+    class Build < Thor::Group
+      extend BuildOptions
+      extend Summarizable
+      include ConfigurationOverridable
 
-            add_build_options(c)
+      Registrations.register do
+        register(Build, "build", "build", Build.summary)
+      end
 
-            c.action do |_, options|
-              options["serving"] = false
-              process_with_graceful_fail(c, options, self)
-            end
-          end
-        end
+      def self.banner
+        "bridgetown build [options]"
+      end
+      summary "Build your site and save to destination folder"
 
-        # Build your bridgetown site
-        # Continuously watch if `watch` is set to true in the config.
-        def process(options)
-          # Adjust verbosity quickly
-          Bridgetown.logger.adjust_verbosity(options)
+      class_option :watch,
+                   type: :boolean,
+                   aliases: "-w",
+                   desc: "Watch for changes and rebuild"
 
-          Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
-                                      " (codename \"#{Bridgetown::CODE_NAME.yellow}\")"
+      # Build your bridgetown site
+      # Continuously watch if `watch` is set to true in the config.
+      def build
+        Bridgetown.logger.adjust_verbosity(options)
 
-          options = configuration_from_options(options)
-          @site = Bridgetown::Site.new(options)
+        Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
+                               " (codename \"#{Bridgetown::CODE_NAME.yellow}\")"
 
-          if options.fetch("skip_initial_build", false)
-            Bridgetown.logger.warn "Build Warning:", "Skipping the initial build." \
-                               " This may result in an out-of-date site."
-          else
-            build(options)
-          end
+        config_options = Serve.loaded_config || configuration_with_overrides(options)
+        config_options["serving"] = false unless config_options["serving"]
+        @site = Bridgetown::Site.new(config_options)
 
-          if options.fetch("detach", false)
-            Bridgetown.logger.info "Auto-regeneration:",
-                                   "disabled when running server detached."
-          elsif options.fetch("watch", false)
-            watch(options)
-          else
-            Bridgetown.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
-          end
+        if config_options.fetch("skip_initial_build", false)
+          Bridgetown.logger.warn "Build Warning:", "Skipping the initial build." \
+                                 " This may result in an out-of-date site."
+        else
+          build_site(config_options)
         end
 
-        # Build your Bridgetown site.
-        #
-        # options - A Hash of options passed to the command or loaded from config
-        #
-        # Returns nothing.
-        def build(options)
-          t = Time.now
-          display_folder_paths(options)
-          if options["unpublished"]
-            Bridgetown.logger.info "Unpublished mode:",
-                                   "enabled. Processing documents marked unpublished"
-          end
-          incremental = options["incremental"]
-          Bridgetown.logger.info "Incremental build:",
-                                 (incremental ? "enabled" : "disabled. Enable with --incremental")
-          Bridgetown.logger.info "Generating…"
-          process_site(@site)
-          Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
-                                 " #{(Time.now - t).ceil(2)} seconds."
+        if config_options.fetch("detach", false)
+          Bridgetown.logger.info "Auto-regeneration:",
+                                 "disabled when running server detached."
+        elsif config_options.fetch("watch", false)
+          watch_site(config_options)
+        else
+          Bridgetown.logger.info "Auto-regeneration:", "disabled. Use --watch to enable."
         end
+      end
 
-        # Private: Watch for file changes and rebuild the site.
-        #
-        # options - A Hash of options passed to the command or loaded from config
-        #
-        # Returns nothing.
-        def watch(options)
-          # Warn Windows users that they might need to upgrade.
-          if Utils::Platforms.bash_on_windows?
-            Bridgetown.logger.warn "",
-                                   "Auto-regeneration may not work on some Windows versions."
-            Bridgetown.logger.warn "",
-                                   "Please see: https://github.com/Microsoft/BashOnWindows/issues/216"
-            Bridgetown.logger.warn "",
-                                   "If it does not work, please upgrade Bash on Windows or "\
-                                   "run Bridgetown with --no-watch."
-          end
+      protected
 
-          #          External.require_with_graceful_fail "bridgetown-watch"
-          Bridgetown::Watcher.watch(@site, options)
+      # Build your Bridgetown site.
+      #
+      # options - A Hash of options passed to the command or loaded from config
+      #
+      # Returns nothing.
+      def build_site(config_options)
+        t = Time.now
+        display_folder_paths(config_options)
+        if config_options["unpublished"]
+          Bridgetown.logger.info "Unpublished mode:",
+                                 "enabled. Processing documents marked unpublished"
         end
+        incremental = config_options["incremental"]
+        Bridgetown.logger.info "Incremental build:",
+                               (incremental ? "enabled" : "disabled. Enable with --incremental")
+        Bridgetown.logger.info "Generating…"
+        @site.process
+        Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
+                                " #{(Time.now - t).ceil(2)} seconds."
+      end
+
+      # Watch for file changes and rebuild the site.
+      #
+      # options - A Hash of options passed to the command or loaded from config
+      #
+      # Returns nothing.
+      def watch_site(config_options)
+        # Warn Windows users that they might need to upgrade.
+        if Utils::Platforms.bash_on_windows?
+          Bridgetown.logger.warn "",
+                                 "Auto-regeneration may not work on some Windows versions."
+          Bridgetown.logger.warn "",
+                                 "Please see: https://github.com/Microsoft/BashOnWindows/issues/216"
+          Bridgetown.logger.warn "",
+                                 "If it does not work, please upgrade Bash on Windows or "\
+                                 "run Bridgetown with --no-watch."
+        end
+
+        Bridgetown::Watcher.watch(@site, config_options)
+      end
 
-        # Private: display the source and destination folder paths
-        #
-        # options - A Hash of options passed to the command
-        #
-        # Returns nothing.
-        def display_folder_paths(options)
-          source = File.expand_path(options["source"])
-          destination = File.expand_path(options["destination"])
-          plugins_dir = File.expand_path(options["plugins_dir"])
-          Bridgetown.logger.info "Source:", source
-          Bridgetown.logger.info "Destination:", destination
+      # Display the source and destination folder paths
+      #
+      # options - A Hash of options passed to the command
+      #
+      # Returns nothing.
+      def display_folder_paths(config_options)
+        source = File.expand_path(config_options["source"])
+        destination = File.expand_path(config_options["destination"])
+        Bridgetown.logger.info "Environment:", Bridgetown.environment.cyan
+        Bridgetown.logger.info "Source:", source
+        Bridgetown.logger.info "Destination:", destination
+        # TODO: work with arrays
+        if config_options["plugins_dir"].is_a?(String)
+          plugins_dir = File.expand_path(config_options["plugins_dir"])
           Bridgetown.logger.info "Custom Plugins:", plugins_dir if Dir.exist?(plugins_dir)
         end
       end