bridgetown-core 2.0.5 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04724f0d282ebd3b98d82230277b3f525b6b514036529bd0a86a5d617582a55d
-  data.tar.gz: 6d75adb7396c2d635f2032b8c3af85d7b12ebda90f72fa8e1a7c794d6113ddb5
+  metadata.gz: 696307e4270883706cdcff2ad44ea6d83120449aab4a5e74a67101fc3769fc3b
+  data.tar.gz: 5596f15af73805b95d1f2c8df40e4da2256733363697b235828fe6f59a5469fe
 SHA512:
-  metadata.gz: 7567e6a5d81cfae3e6ea665cdf2cb99376e1c2a6433be20d37924e9a04e3162361670c4b54234fb5ef186140a5c6c6b36ac484e3bbae9d6e0ea80a0faabbbff8
-  data.tar.gz: 875cff3b9e332cdb783d0190207aeda11b08a8fc0ce981e44a843f5299a9dc12caed0faa13cc65f5f3db71a6e4279e7c68fd177f3fa1f2cc66a9126d7f175ee5
+  metadata.gz: a72aa20636088803d8960f3880b48465702fa8961923b51ec6edc7b5245d8d6f9645c83c18b02993f396076c35cd7c461dfb5b97f04bcfc4f78d4f8984bd5eed
+  data.tar.gz: 9f4bdb2e72807ddc0a6caf528a26931ea6ce02e4384c6c31f889ab12f6bd0887d0da6181d7d1ee4c54d06b62f9f646958cf1d0ad09f50c66e346b45b1e0b1ca8

data/.rubocop.yml

@@ -12,8 +12,6 @@ AllCops:
     - tmp/**/*
     - test/source/**/*
     - test/resources/src/**/*.rb
-    - lib/bridgetown-core/commands/base.rb
-    - lib/bridgetown-core/commands/plugins.rb
     - lib/bridgetown-core/configurations/ruby2js/**/*
     - lib/bridgetown-core/rack/roda.rb
     - lib/site_template/TEMPLATES/**/*
@@ -23,6 +21,10 @@ AllCops:
     - lib/site_template/plugins/site_builder.rb
     - lib/site_template/server/roda_app.rb
 
+Bridgetown/NoPutsAllowed:
+  Exclude:
+    - lib/bridgetown-core/commands/**/*
+
 Lint/ConstantDefinitionInBlock:
   Exclude:
     - test/test_liquid_extensions.rb

data/bin/bridgetown

@@ -9,12 +9,12 @@ require "bridgetown"
 
 # Support NO_COLOR: https://no-color.org
 # TODO: need to change behavior of Colorator gem
-ENV["THOR_SHELL"] = "Basic" if ENV["NO_COLOR"]
+#ENV["THOR_SHELL"] = "Basic" if ENV["NO_COLOR"]
 
-output_version = if ARGV[0] == "-v" || ARGV[0] == "--version"
-                   puts "bridgetown #{Bridgetown::VERSION} \"#{Bridgetown::CODE_NAME}\""
-                   true
-                 end
+if ARGV[0] == "-v" || ARGV[0] == "--version"
+  puts "bridgetown #{Bridgetown::VERSION} \"#{Bridgetown::CODE_NAME}\""
+  exit(true)
+end
 
 if env_index = ARGV.index { |arg| arg == "-e" } # rubocop:disable Lint/AssignmentInCondition
   env = ARGV[env_index + 1]
@@ -25,9 +25,21 @@ end
 
 Bridgetown.begin!
 
-require "bridgetown-core/commands/base"
+require "bridgetown-core/commands/application"
+
+custom_commands_file = File.expand_path("config/custom_commands.rb", Dir.pwd)
+require custom_commands_file if File.exist?(custom_commands_file)
+
 begin
-  Bridgetown::Commands::Base.start unless output_version
+  Bridgetown::Commands::Application.parse(ARGV).call
+rescue Samovar::MissingValueError => e
+  puts "#{"Command error:".bold.red} #{e.message.to_s.yellow}\n\n"
+  e.command.print_usage
+  exit(false)
+rescue Samovar::InvalidInputError => e
+  puts "#{"Unknown token:".bold.red} #{e.token.yellow}\n\n"
+  e.command.print_usage
+  exit(false)
 rescue StandardError => e
   Bridgetown::Errors.print_build_error(e)
   exit(false)

data/bridgetown-core.gemspec

@@ -29,17 +29,18 @@ Gem::Specification.new do |spec|
 
   spec.rdoc_options = ["--charset=UTF-8"]
 
-  spec.required_ruby_version     = ">= 3.1.0"
+  spec.required_ruby_version     = ">= 3.2.0"
 
-  spec.add_dependency("activesupport",             [">= 6.0", "< 8.0"])
   spec.add_dependency("addressable",               "~> 2.4")
   spec.add_dependency("amazing_print",             "~> 1.2")
+  spec.add_dependency("base64",                    ">= 0.3")
+  spec.add_dependency("bigdecimal",                ">= 3.2")
   spec.add_dependency("bridgetown-foundation",     Bridgetown::VERSION)
   spec.add_dependency("csv",                       "~> 3.2")
-  spec.add_dependency("dry-inflector",             ">= 1.0")
   spec.add_dependency("erubi",                     "~> 1.9")
   spec.add_dependency("faraday",                   "~> 2.0")
   spec.add_dependency("faraday-follow_redirects",  "~> 0.3")
+  spec.add_dependency("freyia",                    ">= 0.5")
   spec.add_dependency("i18n",                      "~> 1.0")
   spec.add_dependency("irb",                       ">= 1.14")
   spec.add_dependency("kramdown",                  "~> 2.1")
@@ -51,10 +52,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency("rake",                      ">= 13.0")
   spec.add_dependency("roda",                      "~> 3.46")
   spec.add_dependency("rouge",                     [">= 3.0", "< 5.0"])
-  spec.add_dependency("serbea",                    "~> 2.1")
+  spec.add_dependency("samovar",                   ">= 2.4")
+  spec.add_dependency("securerandom",              "~> 0.4")
+  spec.add_dependency("serbea",                    ">= 2.4.1")
   spec.add_dependency("signalize",                 "~> 1.3")
   spec.add_dependency("streamlined",               ">= 0.6.0")
-  spec.add_dependency("thor",                      "~> 1.1")
   spec.add_dependency("tilt",                      "~> 2.0")
-  spec.add_dependency("zeitwerk",                  "~> 2.5")
+  spec.add_dependency("zeitwerk",                  ">= 2.7.3")
 end

data/lib/bridgetown-core/collection.rb

@@ -292,11 +292,12 @@ module Bridgetown
     # @param full_path [String]
     # @param manifest [Bridgetown::Configuration::SourceManifest]
     # @return [void]
-    def read_resource(full_path, manifest: nil)
+    def read_resource(full_path, manifest: nil, bare_text: false)
       model_relative_path = relative_model_path_for(full_path, manifest:)
       model = Bridgetown::Model::Base.find(
         model_id_from_relative_path(model_relative_path, manifest:),
-        site:
+        site:,
+        bare_text:
       )
 
       if model_is_multi_locale?(model, model_relative_path)
@@ -396,7 +397,7 @@ module Bridgetown
 
     def relative_model_path_for(full_path, manifest: nil)
       Pathname(full_path).relative_path_from(
-        manifest ? Pathname(manifest.content) : Pathname(site.source)
+        manifest ? manifest.contents[label.to_sym] : site.source
       ).to_s
     end
 

data/lib/bridgetown-core/command.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "samovar"
+require "freyia"
+
+# Monkey-patch to use cyan instead of blue formatting
+Samovar::Output::UsageFormatter.class_eval do
+  # Initialize a new usage formatter.
+  #
+  # @parameter rows [Rows] The rows to format.
+  # @parameter output [IO] The output stream to print to.
+  def initialize(output)
+    @output = output
+    @width = 80
+    @first = true
+
+    @terminal = Console::Terminal.for(@output)
+    @terminal[:header] = @terminal.style(:cyan, nil, :bright)
+    #@terminal[:description] = @terminal.style(:cyan)
+    @terminal[:options] = @terminal.style(:cyan)
+    @terminal[:error] = @terminal.style(:red)
+  end
+
+  map(Samovar::Output::Row) do |row, rows|
+    row[1] = row[1].reset_ansi if row[1]
+    @terminal.puts "#{rows.indentation}#{row.align(rows.columns)}", style: :options
+  end
+end
+
+# Monkey-patch to support `--key=value`
+Samovar::Options.class_eval do
+  def parse(input, parent = nil, default = nil) # rubocop:disable Metrics
+    values = (default || @defaults).dup
+
+    while option = @keyed[input.first] || @keyed[input.first&.split("=")&.first] # rubocop:disable Lint/AssignmentInCondition
+      result = option.parse(input)
+      values[option.key] = result unless result.nil?
+    end
+
+    # Validate required options
+    @ordered.each do |option|
+      if option.required && !values.key?(option.key)
+        raise Samovar::MissingValueError.new(parent, option.key)
+      end
+    end
+
+    values
+  end
+end
+
+Samovar::ValueFlag.class_eval do
+  # Parse this flag from the input.
+  #
+  # @parameter input [Array(String)] The command-line arguments.
+  # @returns [String | Symbol | Nil] The parsed value.
+  def parse(input)
+    if prefix?(input.first)
+      # Whether we are expecting to parse a value from input:
+      if @value
+        # Get the actual value from input:
+        _, value = input.shift(2)
+        value
+      else
+        # Otherwise, we are just a boolean flag:
+        input.shift
+        key
+      end
+    elsif prefix?(input.first.split("=").first)
+      input.shift(1)[0].split("=").last
+
+    end
+  end
+end
+
+module Bridgetown
+  class Command < Samovar::Command
+    def self.summary = description
+
+    # Compatibility syntax to execute commands.
+    # It's recommended you use Samovar's more idiomatic `CmdClass[*args].call` syntax instead
+    def self.start(args = []) = self[*args].call
+
+    # Samovar shows all command options by default when printing out a command name string.
+    # We want to hide that part of the output, as options are already listed out separately
+    def self.command_line(name)
+      table = self.table.merged
+
+      usage_string = table.each.collect do |row|
+        next "" if row.is_a?(Samovar::Options)
+
+        row.to_s
+      end.reject(&:empty?).join(" ")
+
+      "#{name} #{usage_string}"
+    end
+  end
+end

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

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    # Register a new command for the Bridgetown CLI
+    #
+    # @param name [Symbol]
+    # @param klass [Bridgetown::Command]
+    def self.register_command(name, klass)
+      Registrations.register(klass, name)
+    end
+  end
+end
+
+require_all "bridgetown-core/commands/concerns"
+require_all "bridgetown-core/commands"
+
+module Bridgetown
+  module Commands
+    class Application < Bridgetown::Command
+      self.description =
+        "next-generation, progressive site generator & fullstack framework, powered by Ruby"
+
+      def self.registrations = @registrations ||= {}
+
+      def self.register(klass, name, *)
+        registrations[name.to_s] = klass
+      end
+
+      nested(:command, registrations)
+
+      def self.desc(name, description)
+        @next_cmd_name = name.split.first
+        @next_cmd_description = description
+      end
+
+      def self.subcommand(name, klass)
+        return unless @next_cmd_name == name
+
+        table[:command].commands[name] = klass
+        klass.description = @next_cmd_description
+
+        @next_cmd_name = nil
+        @next_cmd_description = nil
+      end
+
+      def parse(input)
+        Registrations.load_registrations self.class
+        self.class.table.merged.parse(input, self)
+
+        return self if input.empty?
+
+        new_input = locate_command(input)
+        unless new_input
+          locate_rake_task(input)
+          return self
+        end
+
+        parse(new_input)
+      end
+
+      def call
+        if @command
+          @command.()
+        else
+          print_usage
+        end
+      end
+
+      def print_usage # rubocop:disable Metrics
+        puts "Bridgetown v#{Bridgetown::VERSION.magenta} \"#{Bridgetown::CODE_NAME.yellow}\" " \
+             "is a #{self.class.description}"
+        puts ""
+        puts "Usage:".bold.green + " #{"bridgetown".bold.cyan} #{"<command> [options]".cyan}\n\n"
+        puts "Commands:".bold.green
+
+        commands = self.class.table[:command].commands.to_h do |name, command|
+          inputs = command.table.each.find do |item|
+            item.is_a?(Samovar::Many) || item.is_a?(Samovar::One) || item.is_a?(Samovar::Nested)
+          end
+          name = name.bold.cyan
+          name = "#{name} #{"<#{inputs.key.upcase}>".cyan}" if inputs
+          [name, command]
+        end
+
+        name_max_length = commands.keys.map { Foundation::Packages::Ansi.strip(_1).length }.max
+        commands.find do |name, command|
+          spaces = " " * (name_max_length - Foundation::Packages::Ansi.strip(name).length)
+          puts "  #{"bridgetown".cyan} #{name}  #{spaces}#{command.description}"
+        end
+
+        puts ""
+
+        require "rake"
+        Rake::TaskManager.record_task_metadata = true
+        Rake.with_application do |rake|
+          rake.instance_variable_set(:@name, "  bridgetown")
+          rake.standard_exception_handling do
+            rakefile, _location = rake.find_rakefile_location
+            return unless rakefile # rubocop:disable Lint/NonLocalExitFromIterator
+
+            load_rake_tasks(rake)
+            puts "Available Rake Tasks:".bold.green
+            display_rake_tasks(rake, name_max_length)
+          end
+        end
+      end
+
+      # @param input [String]
+      def locate_command(input)
+        token = input.first
+
+        case token
+        when "--help", "-help", "-h"
+          input[0] = "help"
+          input
+        when "c"
+          input[0] = "console"
+          input
+        when "s"
+          input[0] = "start"
+          input
+        else
+          self.class.table[:command].commands.find do |name, _command|
+            next unless name.start_with?(token)
+
+            input[0] = name
+            input
+          end
+        end
+      end
+
+      # @param input [String]
+      def locate_rake_task(input) # rubocop:todo Metrics
+        require "rake"
+        Rake::TaskManager.record_task_metadata = true
+        cmd = input.first
+
+        Rake.with_application do |rake|
+          rake.standard_exception_handling do
+            rakefile, _location = rake.find_rakefile_location
+            unless rakefile
+              puts "No Rakefile found (searching: #{rake.class::DEFAULT_RAKEFILES.join(", ")})\n\n"
+              new.invoke("help")
+              return # rubocop:disable Lint/NonLocalExitFromIterator
+            end
+            rake.init("bridgetown")
+            load_rake_tasks(rake)
+          end
+
+          # either return a command proc or nothing, #call will handle either case
+          if Rake::Task.task_defined?(cmd.split("[")[0])
+            @command = -> { rake.top_level }
+          else
+            puts "#{"Unknown token:".bold.red} #{cmd.split("[")[0].yellow}\n\n"
+          end
+        rescue RuntimeError => e
+          # re-raise error unless it's an error through Minitest
+          raise e unless e.message.include?("ruby -Ilib:test")
+
+          Bridgetown.logger.error "test aborted!"
+          Bridgetown.logger.error e.message
+          exit(false)
+        end
+      end
+
+      # @param rake [Rake::Application]
+      def display_rake_tasks(rake, previous_max_length)
+        # based in part on `Rake::Application#display_tasks_and_comments`
+        displayable_tasks = rake.tasks.to_h do |t|
+          [t.name_with_args, t.comment]
+        end
+
+        name_max_length = [previous_max_length, displayable_tasks.keys.map(&:length).max].max
+        displayable_tasks.find do |name, comment|
+          next if name == "default"
+
+          spaces = " " * (name_max_length - name.length)
+          puts "  #{"bridgetown".cyan} #{name.bold.cyan}  #{spaces}#{comment}"
+        end
+      end
+
+      # @param rake [Rake::Application]
+      def load_rake_tasks(rake)
+        rake.load_rakefile
+        tasks = rake.instance_variable_get(:@tasks)
+        rake.instance_variable_set(:@tasks, tasks.reject do |_k, v|
+          v.locations.first&.include?("/lib/rails/tasks/") ||
+            v.locations.first&.include?("/lib/rake/dsl_definition")
+        end)
+      end
+    end
+
+    class Dream < Bridgetown::Command
+      self.description = "There's a place where that idea still exists as a reality"
+
+      def call
+        puts ""
+        puts "🎶 The Dream of the 90s is Alive in Portland... ✨"
+        puts "          https://youtu.be/U4hShMEk1Ew"
+        puts "          https://youtu.be/0_HGqPGp9iY"
+        puts ""
+      end
+    end
+
+    register_command :dream, Dream
+  end
+end

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

@@ -2,34 +2,19 @@
 
 module Bridgetown
   module Commands
-    class Apply < Thor::Group
-      include Thor::Actions
-      include Actions
-      extend Summarizable
+    class Apply < Bridgetown::Command
+      include Automations
 
-      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"
+      self.description = "Applies an automation to the current site"
 
-      def self.source_root
-        Dir.pwd
-      end
+      one :path_or_url, "Either a path or a URL to an automation file or Git repo"
 
-      def self.exit_on_failure?
-        true
-      end
-
-      def apply_automation
-        @source_paths = [Dir.pwd]
+      def call(new_site_dir: nil)
+        self.source_paths = [Dir.pwd]
         @logger = Bridgetown.logger
 
-        if options[:apply]
-          apply_after_new_command
+        if new_site_dir
+          apply_after_new_command new_site_dir
         else
           apply_in_pwd
         end
@@ -43,21 +28,22 @@ module Bridgetown
 
       protected
 
-      def apply_after_new_command
+      def apply_after_new_command(created_site_dir)
         # Coming from the new command, so set up proper bundler env
         Bridgetown.with_unbundled_env do
-          self.destination_root = New.created_site_dir
-          inside(New.created_site_dir) do
-            apply_from_url options[:apply]
+          self.destination_root = created_site_dir
+          inside(created_site_dir) do
+            apply_from_url path_or_url
           end
         end
       end
 
       def apply_in_pwd
         # Running standalone
-        automation_command = args.empty? ? "bridgetown.automation.rb" : args[0]
+        self.destination_root = Dir.pwd
+        automation_command = path_or_url.nil? ? "bridgetown.automation.rb" : path_or_url
 
-        if args.empty? && !File.exist?("bridgetown.automation.rb")
+        if path_or_url.nil? && !File.exist?("bridgetown.automation.rb")
           raise ArgumentError, "You must specify a path or a URL, " \
                                "or add bridgetown.automation.rb to the " \
                                "current folder."
@@ -70,5 +56,7 @@ module Bridgetown
         @logger.warn "Oops!", e.message
       end
     end
+
+    register_command :apply, Apply
   end
 end

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

@@ -2,24 +2,15 @@
 
 module Bridgetown
   module Commands
-    class Build < Thor::Group
-      extend BuildOptions
-      extend Summarizable
+    class Build < Bridgetown::Command
       include ConfigurationOverridable
 
-      Registrations.register do
-        register(Build, "build", "build", Build.summary)
-      end
+      self.description = "Build your site and save to destination folder"
 
-      def self.banner
-        "bridgetown build [options]"
+      options do
+        BuildOptions.include_options(self)
+        option "-w/--watch", "Watch for changes and rebuild"
       end
-      summary "Build your site and save to destination folder"
-
-      class_option :watch,
-                   type: :boolean,
-                   aliases: "-w",
-                   desc: "Watch for changes and rebuild"
 
       def self.print_startup_message
         Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta} " \
@@ -28,7 +19,7 @@ module Bridgetown
 
       # Build your bridgetown site
       # Continuously watch if `watch` is set to true in the config.
-      def build
+      def call # rubocop:disable Metrics
         Bridgetown.logger.adjust_verbosity(**options)
 
         # @type [Bridgetown::Configuration]
@@ -90,7 +81,7 @@ module Bridgetown
       # Watch for file changes and rebuild the site
       #
       # @param options [Bridgetown::Configuration] options loaded from config and/or CLI
-      def watch_site(config_options)
+      def watch_site(config_options) # rubocop:disable Metrics
         if config_options["url"]&.include?("://localhost")
           require "socket"
           external_ip = Socket.ip_address_list.find do |ai|
@@ -137,5 +128,7 @@ module Bridgetown
         end
       end
     end
+
+    register_command :build, Build
   end
 end

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

@@ -2,21 +2,16 @@
 
 module Bridgetown
   module Commands
-    class Clean < Thor::Group
-      extend BuildOptions
-      extend Summarizable
+    class Clean < Bridgetown::Command
       include ConfigurationOverridable
 
-      Registrations.register do
-        register(Clean, "clean", "clean", Clean.summary)
-      end
+      self.description = "Clean the site (removes site output and metadata file) without building"
 
-      def self.banner
-        "bridgetown clean [options]"
+      options do
+        BuildOptions.include_options(self)
       end
-      summary "Clean the site (removes site output and metadata file) without building"
 
-      def clean
+      def call
         config = configuration_with_overrides(options, Bridgetown::Current.preloaded_configuration)
         destination = config["destination"]
         metadata_file = File.join(config["root_dir"], ".bridgetown-metadata")
@@ -40,5 +35,7 @@ module Bridgetown
         end
       end
     end
+
+    register_command :clean, Clean
   end
 end