bridgetown-core 0.19.2 → 0.21.0.beta3

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

@@ -25,6 +25,15 @@ module Bridgetown
         end
       end
 
+      desc "dream", "There's a place where that idea still exists as a reality"
+      def dream
+        puts ""
+        puts "🎶 The Dream of the 90s is Alive in Portland... ✨"
+        puts "          https://youtu.be/U4hShMEk1Ew"
+        puts "          https://youtu.be/0_HGqPGp9iY"
+        puts ""
+      end
+
       desc "help <command>", "Show detailed command usage information and exit"
       def help(subcommand = nil)
         if subcommand && respond_to?(subcommand)

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

@@ -79,17 +79,6 @@ module Bridgetown
       #
       # 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
 

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    module GitHelpers
+      def initialize_new_repo
+        run "git init", abort_on_failure: true
+        `git symbolic-ref HEAD refs/heads/main` if user_default_branch.empty?
+      end
+
+      def destroy_existing_repo
+        run "rm -rf .git"
+      end
+
+      def user_default_branch
+        @user_default_branch ||= `git config init.defaultbranch`.strip
+      end
+    end
+  end
+end

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

@@ -4,6 +4,7 @@ module Bridgetown
   module Commands
     class Configure < Thor::Group
       include Thor::Actions
+      include Actions
       extend Summarizable
 
       Registrations.register do
@@ -20,13 +21,13 @@ module Bridgetown
       end
 
       def perform_configurations
-        logger = Bridgetown.logger
+        @logger = Bridgetown.logger
         list_configurations if args.empty?
 
         args.each do |configuration|
           configure configuration
         rescue Thor::Error
-          logger.error "Error:".red, "🚨 Configuration doesn't exist: #{configuration}"
+          @logger.error "Error:".red, "🚨 Configuration doesn't exist: #{configuration}"
         end
       end
 
@@ -40,7 +41,7 @@ module Bridgetown
         configuration_file = find_in_source_paths("#{configuration}.rb")
 
         inside(New.created_site_dir || Dir.pwd) do
-          Apply.new.invoke(:apply_automation, [configuration_file])
+          apply configuration_file, verbose: false
         end
       end
 
@@ -50,6 +51,10 @@ module Bridgetown
           configuration = set_color configuration, :blue, :bold
           say configuration
         end
+        say "\n"
+
+        docs_url = "https://www.bridgetownrb.com/docs/bundled-configurations".yellow.bold
+        say "For more info, check out the docs at: #{docs_url}"
       end
 
       def configurations

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

@@ -28,6 +28,7 @@ module Bridgetown
 
       def console
         require "irb"
+        require "irb/ext/save-history"
         require "amazing_print" unless options[:"bypass-ap"]
 
         Bridgetown.logger.info "Starting:", "Bridgetown v#{Bridgetown::VERSION.magenta}" \
@@ -50,6 +51,7 @@ module Bridgetown
         IRB.setup(nil)
         workspace = IRB::WorkSpace.new
         irb = IRB::Irb.new(workspace)
+        IRB.conf[:IRB_RC]&.call(irb.context)
         IRB.conf[:MAIN_CONTEXT] = irb.context
         eval("site = $BRIDGETOWN_SITE", workspace.binding, __FILE__, __LINE__)
         Bridgetown.logger.info "Console:", "Now loaded as " + "site".cyan + " variable."
@@ -68,6 +70,8 @@ module Bridgetown
             end
             irb.eval_input
           end
+        ensure
+          IRB.conf[:AT_EXIT].each(&:call)
         end
       end
     end

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

@@ -33,7 +33,6 @@ module Bridgetown
 
       def healthy?(site)
         [
-          fsnotify_buggy?(site),
           !conflicting_urls(site),
           !urls_only_differ_by_case(site),
           proper_site_url?(site),
@@ -59,7 +58,7 @@ module Bridgetown
         conflicting_urls = false
         urls = {}
         urls = collect_urls(urls, site.pages, site.dest)
-        urls = collect_urls(urls, site.posts.docs, site.dest)
+        urls = collect_urls(urls, site.collections.posts.docs, site.dest)
         urls.each do |url, paths|
           next unless paths.size > 1
 
@@ -70,23 +69,6 @@ module Bridgetown
         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
-
-          false
-        end
-
-        true
-      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)

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

@@ -4,6 +4,7 @@ module Bridgetown
   module Commands
     class New < Thor::Group
       include Thor::Actions
+      include GitHelpers
       extend Summarizable
 
       Registrations.register do
@@ -157,8 +158,7 @@ module Bridgetown
       def git_init(path)
         unless Bridgetown.environment == "test"
           inside(path) do
-            run "git init", abort_on_failure: true
-            run "if [[ -n $(git status | grep 'On branch master') ]]; then git checkout -b main; fi"
+            initialize_new_repo
           end
         end
       rescue SystemExit

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

@@ -5,6 +5,7 @@ module Bridgetown
     class Plugins < Thor
       include Thor::Actions
       include ConfigurationOverridable
+      include GitHelpers
 
       Registrations.register do
         desc "plugins <command>", "List installed plugins or access plugin content"
@@ -144,15 +145,15 @@ module Bridgetown
         name = folder_name.dasherize
         module_name = folder_name.camelize
 
-        run "git clone https://github.com/bridgetownrb/bridgetown-sample-plugin #{name}"
+        # TODO: upon 0.21 release, remove the explicit branch name!
+        run "git clone -b switch-to-minitest https://github.com/bridgetownrb/bridgetown-sample-plugin #{name}"
         new_gemspec = "#{name}.gemspec"
 
         inside name do # rubocop:todo Metrics/BlockLength
-          run "rm -rf .git"
-          run "git init"
-          run "if [[ -n $(git status | grep 'On branch master') ]]; then git checkout -b main; fi"
+          destroy_existing_repo
+          initialize_new_repo
 
-          run "mv bridgetown-sample-plugin.gemspec #{new_gemspec}"
+          FileUtils.mv "bridgetown-sample-plugin.gemspec", new_gemspec.to_s
           gsub_file new_gemspec, "https://github.com/bridgetownrb/bridgetown-sample-plugin", "https://github.com/username/#{name}"
           gsub_file new_gemspec, "bridgetown-sample-plugin", name
           gsub_file new_gemspec, "sample-plugin", name
@@ -161,21 +162,21 @@ module Bridgetown
           gsub_file "package.json", "https://github.com/bridgetownrb/bridgetown-sample-plugin", "https://github.com/username/#{name}"
           gsub_file "package.json", "bridgetown-sample-plugin", name
 
-          run "mv lib/sample-plugin.rb lib/#{name}.rb"
+          FileUtils.mv "lib/sample-plugin.rb", "lib/#{name}.rb"
           gsub_file "lib/#{name}.rb", "sample-plugin", name
           gsub_file "lib/#{name}.rb", "SamplePlugin", module_name
 
-          run "mv lib/sample-plugin lib/#{name}"
+          FileUtils.mv "lib/sample-plugin", "lib/#{name}"
           gsub_file "lib/#{name}/builder.rb", "SamplePlugin", module_name
           gsub_file "lib/#{name}/version.rb", "SamplePlugin", module_name
 
-          run "mv spec/sample-plugin_spec.rb spec/#{name}_spec.rb"
-          gsub_file "spec/#{name}_spec.rb", "SamplePlugin", module_name
-          gsub_file "spec/spec_helper.rb", "sample-plugin", name
+          FileUtils.mv "test/test_sample_plugin.rb", "test/test_#{folder_name}.rb"
+          gsub_file "test/test_#{folder_name}.rb", "SamplePlugin", module_name
+          gsub_file "test/helper.rb", "sample-plugin", name
 
-          run "mv components/sample_plugin components/#{folder_name}"
-          run "mv content/sample_plugin content/#{folder_name}"
-          run "mv layouts/sample_plugin layouts/#{folder_name}"
+          FileUtils.mv "components/sample_plugin", "components/#{folder_name}"
+          FileUtils.mv "content/sample_plugin", "content/#{folder_name}"
+          FileUtils.mv "layouts/sample_plugin", "layouts/#{folder_name}"
 
           gsub_file "layouts/#{folder_name}/layout.html", "sample_plugin", folder_name
           gsub_file "content/#{folder_name}/example_page.md", "sample_plugin", folder_name

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

@@ -13,10 +13,6 @@ module Bridgetown
 
       class_option :host, aliases: "-H", desc: "Host to bind to"
       class_option :port, aliases: "-P", desc: "Port to listen on"
-      class_option :open_url,
-                   aliases: "-o",
-                   type: :boolean,
-                   desc: "Launch your site in a browser"
       class_option :detach,
                    aliases: "-B",
                    type: :boolean,
@@ -169,16 +165,6 @@ module Bridgetown
         )
       end
 
-      def launch_browser(server, opts)
-        address = server_address(server, opts)
-        return system "start", address if Utils::Platforms.windows?
-        return system "xdg-open", address if Utils::Platforms.linux?
-        return system "open", address if Utils::Platforms.osx?
-
-        Bridgetown.logger.error "Refusing to launch browser; " \
-          "Platform launcher unknown."
-      end
-
       # Keep in our area with a thread or detach the server as requested
       # by the user.  This method determines what we do based on what you
       # ask us to do.

data/lib/bridgetown-core/component.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  class Component
+    extend Forwardable
+
+    def_delegators :@view_context, :helpers, :liquid_render, :partial
+
+    # @return [Bridgetown::Site]
+    attr_reader :site # will be nil unless you explicitly set a `@site` ivar
+
+    # @return [Bridgetown::RubyTemplateView, Bridgetown::Component]
+    attr_reader :view_context
+
+    class << self
+      attr_accessor :source_location
+
+      def inherited(child)
+        # Code cribbed from ViewComponent by GitHub:
+        # Derive the source location of the component Ruby file from the call stack
+        child.source_location = caller_locations(1, 10).reject do |l|
+          l.label == "inherited"
+        end[0].absolute_path
+
+        super
+      end
+
+      # Return the appropriate template renderer for a given extension.
+      # TODO: make this extensible
+      #
+      # @param ext [String] erb, slim, etc.
+      def renderer_for_ext(ext, &block)
+        case ext
+        when "erb"
+          include ERBCapture
+          Tilt::ErubiTemplate.new(component_template_path,
+                                  outvar: "@_erbout",
+                                  bufval: "Bridgetown::OutputBuffer.new",
+                                  engine_class: Bridgetown::ERBEngine,
+                                  &block)
+        when "serb" # requires serbea
+          include Serbea::Helpers
+          Tilt::SerbeaTemplate.new(component_template_path, &block)
+        when "slim" # requires bridgetown-slim
+          Slim::Template.new(component_template_path, &block)
+        when "haml" # requires bridgetown-haml
+          Tilt::HamlTemplate.new(component_template_path, &block)
+        else
+          raise NameError
+        end
+      rescue NameError, LoadError
+        raise "No component rendering engine could be found for .#{ext} templates"
+      end
+
+      # Find the first matching template path based on source location and extension.
+      #
+      # @return [String]
+      def component_template_path
+        stripped_path = File.join(
+          File.dirname(source_location),
+          File.basename(source_location, ".*")
+        )
+        supported_template_extensions.each do |ext|
+          test_path = "#{stripped_path}.#{ext}"
+          return test_path if File.exist?(test_path)
+
+          test_path = "#{stripped_path}.html.#{ext}"
+          return test_path if File.exist?(test_path)
+        end
+
+        raise "No matching templates could be found in #{File.dirname(source_location)}"
+      end
+
+      # Read the template file.
+      #
+      # @return [String]
+      def component_template_content
+        File.read(component_template_path)
+      end
+
+      # A list of extensions supported by the renderer
+      # TODO: make this extensible
+      #
+      # @return [Array<String>]
+      def supported_template_extensions
+        %w(erb serb slim haml)
+      end
+    end
+
+    # If a content block was originally passed into via `render`, capture its output.
+    #
+    # @return [String] or nil
+    def content
+      @_content ||= begin
+        view_context.capture(self, &@_content_block) if @_content_block
+      end
+    end
+
+    # Provide a render helper for evaluation within the component context.
+    #
+    # @param item [Object] a component supporting `render_in` or a partial name
+    # @param options [Hash] passed to the `partial` helper if needed
+    # @return [String]
+    def render(item, options = {}, &block)
+      if item.respond_to?(:render_in)
+        result = ""
+        capture do # this ensures no leaky interactions between BT<=>VC blocks
+          result = item.render_in(self, &block)
+        end
+        result&.html_safe
+      else
+        partial(item, options, &block)&.html_safe
+      end
+    end
+
+    # This is where the magic happens. Render the component within a view context.
+    #
+    # @param view_context [Bridgetown::RubyTemplateView]
+    def render_in(view_context, &block)
+      @view_context = view_context
+      @_content_block = block
+
+      if render?
+        before_render
+        template
+      else
+        ""
+      end
+    rescue StandardError => e
+      Bridgetown.logger.error "Component error:",
+                              "#{self.class} encountered an error while "\
+                              "rendering `#{self.class.component_template_path}'"
+      raise e
+    end
+
+    # Subclasses can override this method to return a string from their own
+    # template handling.
+    def template
+      call || _renderer.render(self)
+    end
+
+    # Typically not used but here as a compatibility nod toward ViewComponent.
+    def call
+      nil
+    end
+
+    # Subclasses can override this method to perform tasks before a render.
+    def before_render; end
+
+    # Subclasses can override this method to determine if the component should
+    # be rendered based on initialized data or other logic.
+    def render?
+      true
+    end
+
+    def _renderer
+      # TODO: figure out a way to compile templates for increased performance
+      @_renderer ||= begin
+        ext = File.extname(self.class.component_template_path).delete_prefix(".")
+        self.class.renderer_for_ext(ext) { self.class.component_template_content }
+      end
+    end
+
+    # rubocop:disable Style/MissingRespondToMissing
+    ruby2_keywords def method_missing(method, *args, &block)
+      if helpers.respond_to?(method.to_sym)
+        helpers.send method.to_sym, *args, &block
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_private = false)
+      helpers.respond_to?(method.to_sym, include_private) || super
+    end
+    # rubocop:enable Style/MissingRespondToMissing
+  end
+end