bridgetown-core 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c58653595832ef2fb9e6bbea3f147a0b3be9edae554d169e974570b84565a507
-  data.tar.gz: 7af409e9a01570321171cf1afc562c00cacdcc6e0dce98f2b8eac4988a60e8d6
+  metadata.gz: b4c0ce7bce739e63c69f338a2b614156fcf1b287f4d0742ae159055bbc64c8a6
+  data.tar.gz: 3ecd352f397904b828a924fcc4e58813b8d9c0c37313bd17a7fab4a08600ba64
 SHA512:
-  metadata.gz: b21d9c304dd99dd306b70e97e172d1ec172f0d1fa48034610cc3d9e6bc9c40b98e7fe10479226103cb2ff501c22c7c2841f20630235262cc7214661be62bcf3e
-  data.tar.gz: cab7afb0f441e412850ce648d6e7ca9a3996f106b0800c31ef24a0cf63af9db770498f307da275860c0572d6d6f2a5f1e56570d10349bb11cd4f17f96b3266ee
+  metadata.gz: 2d17ec6dea80449358e73cc7c7c0d8ac1b3be7dd9d5a55d4d05771fbe59d7d7f27504c08143cb56b8d97e9c0329245c9f68476bfed2708d8915201c16f6ce1bc
+  data.tar.gz: 5ceb50825db51531cad5f9ae141d53a30791ef35ffeb44169911e764ce4ec6bcb082ce54f8a456da275853128dc8cd3768985fd1854001bab9cd0edc0ba057bc

data/bridgetown-core.gemspec

@@ -47,7 +47,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency("liquid-component",      ">= 0.1")
   s.add_runtime_dependency("listen",                "~> 3.0")
   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.1")
   s.add_runtime_dependency("tilt",                  "~> 2.0")

data/lib/bridgetown-core.rb

@@ -28,6 +28,7 @@ require "logger"
 require "set"
 require "csv"
 require "json"
+require "yaml"
 
 # 3rd party
 require "active_support"
@@ -38,12 +39,12 @@ require "active_support/core_ext/object/deep_dup"
 require "active_support/core_ext/object/inclusion"
 require "active_support/core_ext/string/inflections"
 require "active_support/core_ext/string/inquiry"
+require "active_support/core_ext/string/output_safety"
 require "active_support/core_ext/string/starts_ends_with"
 require "active_support/current_attributes"
 require "active_support/descendants_tracker"
 require "hash_with_dot_access"
 require "addressable/uri"
-require "safe_yaml/load"
 require "liquid"
 require "liquid-component"
 require "kramdown"
@@ -61,25 +62,13 @@ module HashWithDotAccess
   end
 end
 
-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"]
-
-if RUBY_VERSION.start_with?("3.0")
-  # workaround for Ruby 3 preview 2, maybe can remove later
-  # rubocop:disable Style/GlobalVars
-  old_verbose = $VERBOSE
-  $VERBOSE = nil
-  SafeYAML::SafeToRubyVisitor.const_set(:INITIALIZE_ARITY, 2)
-  $verbose = old_verbose
-  # rubocop:enable Style/GlobalVars
-end
 
 module Bridgetown
   autoload :Cleaner,             "bridgetown-core/cleaner"
   autoload :Collection,          "bridgetown-core/collection"
+  autoload :Component,           "bridgetown-core/component"
   autoload :Configuration,       "bridgetown-core/configuration"
   autoload :DataAccessible,      "bridgetown-core/concerns/data_accessible"
   autoload :Deprecator,          "bridgetown-core/deprecator"
@@ -88,9 +77,8 @@ module Bridgetown
   # TODO: we have too many errors! This is silly
   autoload :Errors,              "bridgetown-core/errors"
   autoload :Excerpt,             "bridgetown-core/excerpt"
-  # TODO: this is a poorly named, unclear class. Relocate to Utils:
-  autoload :External,            "bridgetown-core/external"
   autoload :FrontmatterDefaults, "bridgetown-core/frontmatter_defaults"
+  autoload :FrontMatterImporter, "bridgetown-core/concerns/front_matter_importer"
   autoload :Hooks,               "bridgetown-core/hooks"
   autoload :Layout,              "bridgetown-core/layout"
   autoload :LayoutPlaceable,     "bridgetown-core/concerns/layout_placeable"
@@ -102,16 +90,12 @@ module Bridgetown
   autoload :LayoutReader,        "bridgetown-core/readers/layout_reader"
   # TODO: remove this when legacy content engine is gone:
   autoload :PostReader,          "bridgetown-core/readers/post_reader"
-  # TODO: we can merge this back into Reader class:
+  # TODO: remove this when legacy content engine is gone:
   autoload :PageReader,          "bridgetown-core/readers/page_reader"
   autoload :PluginContentReader, "bridgetown-core/readers/plugin_content_reader"
-  # TODO: also merge this:
-  autoload :StaticFileReader,    "bridgetown-core/readers/static_file_reader"
   autoload :LogAdapter,          "bridgetown-core/log_adapter"
   autoload :Page,                "bridgetown-core/page"
   autoload :GeneratedPage,       "bridgetown-core/page"
-  # TODO: figure out how to get rid of this seemingly banal class:
-  autoload :PathManager,         "bridgetown-core/path_manager"
   autoload :PluginManager,       "bridgetown-core/plugin_manager"
   autoload :Publishable,         "bridgetown-core/concerns/publishable"
   autoload :Publisher,           "bridgetown-core/publisher"
@@ -131,6 +115,7 @@ module Bridgetown
   autoload :Validatable,         "bridgetown-core/concerns/validatable"
   autoload :VERSION,             "bridgetown-core/version"
   autoload :Watcher,             "bridgetown-core/watcher"
+  autoload :YAMLParser,          "bridgetown-core/yaml_parser"
 
   # extensions
   require "bridgetown-core/commands/registrations"
@@ -148,6 +133,7 @@ module Bridgetown
   require_all "bridgetown-core/drops"
   require_all "bridgetown-core/generators"
   require_all "bridgetown-core/tags"
+  require_all "bridgetown-core/core_ext"
 
   class << self
     # Tells you which Bridgetown environment you are building in so
@@ -265,7 +251,7 @@ module Bridgetown
     end
 
     # Conditional optimizations
-    Bridgetown::External.require_if_present("liquid/c")
+    Bridgetown::Utils::RequireGems.require_if_present("liquid/c")
   end
 end
 
@@ -274,6 +260,9 @@ module Bridgetown
   module Resource; end
 end
 
+# This method is available in Ruby 3, monkey patching for older versions
+Psych.extend Bridgetown::CoreExt::Psych::SafeLoadFile unless Psych.respond_to?(:safe_load_file)
+
 loader = Zeitwerk::Loader.new
 loader.push_dir File.join(__dir__, "bridgetown-core/model"), namespace: Bridgetown::Model
 loader.push_dir File.join(__dir__, "bridgetown-core/resource"), namespace: Bridgetown::Resource

data/lib/bridgetown-core/cleaner.rb

@@ -101,7 +101,7 @@ module Bridgetown
     #
     # Returns a Set with the directory paths
     def keep_dirs
-      site.keep_files.flat_map { |file| parent_dirs(site.in_dest_dir(file)) }.to_set
+      site.config.keep_files.flat_map { |file| parent_dirs(site.in_dest_dir(file)) }.to_set
     end
 
     # Private: Creates a regular expression from the config's keep_files array
@@ -112,7 +112,7 @@ module Bridgetown
     #
     # Returns the regular expression
     def keep_file_regex
-      %r!\A#{Regexp.quote(site.dest)}\/(#{Regexp.union(site.keep_files).source})!
+      %r!\A#{Regexp.quote(site.dest)}\/(#{Regexp.union(site.config.keep_files).source})!
     end
   end
 end

data/lib/bridgetown-core/collection.rb

@@ -78,7 +78,8 @@ module Bridgetown
         if site.uses_resource?
           next if File.basename(file_path).starts_with?("_")
 
-          if label == "data" || Utils.has_yaml_header?(full_path)
+          if label == "data" || Utils.has_yaml_header?(full_path) ||
+              Utils.has_rbfm_header?(full_path)
             read_resource(full_path)
           else
             read_static_file(file_path, full_path)
@@ -256,7 +257,7 @@ module Bridgetown
           sanitized_segment = sanitize_filename.(File.basename(segment, ".*"))
           hsh = nested.empty? ? data_contents : data_contents.dig(*nested)
           hsh[sanitized_segment] = if index == segments.length - 1
-                                     data_resource.data.array || data_resource.data
+                                     data_resource.data.rows || data_resource.data
                                    else
                                      {}
                                    end
@@ -279,6 +280,16 @@ module Bridgetown
       data_contents
     end
 
+    # Read in resource from repo path
+    # @param full_path [String]
+    def read_resource(full_path)
+      id = "repo://#{label}.collection/" + Addressable::URI.escape(
+        Pathname(full_path).relative_path_from(Pathname(site.source)).to_s
+      )
+      resource = Bridgetown::Model::Base.find(id).to_resource.read!
+      resources << resource if site.config.unpublished || resource.published?
+    end
+
     private
 
     def container
@@ -287,15 +298,7 @@ module Bridgetown
 
     def read_document(full_path)
       doc = Document.new(full_path, site: site, collection: self).tap(&:read)
-      docs << doc if site.unpublished || doc.published?
-    end
-
-    def read_resource(full_path)
-      id = "file://#{label}.collection/" + Addressable::URI.escape(
-        Pathname(full_path).relative_path_from(Pathname(site.source)).to_s
-      )
-      resource = Bridgetown::Model::Base.find(id).to_resource.read!
-      resources << resource if site.unpublished || resource.published?
+      docs << doc if site.config.unpublished || doc.published?
     end
 
     def sort_docs!

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
 

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
@@ -85,10 +86,10 @@ module Bridgetown
         )
         template("Gemfile.erb", "Gemfile")
         template("package.json.erb", "package.json")
-        template("webpack.config.js.erb", "webpack.config.js")
         template("frontend/javascript/index.js.erb", "frontend/javascript/index.js")
 
         options["use-postcss"] ? configure_postcss : configure_sass
+        invoke(Webpack, ["setup"], {})
       end
 
       def configure_sass
@@ -139,7 +140,7 @@ module Bridgetown
       # rubocop:enable Metrics/PerceivedComplexity
 
       def bundle_install(path)
-        unless Bridgetown.environment == "test"
+        unless Bridgetown.environment.test?
           require "bundler"
           Bridgetown.with_unbundled_env do
             inside(path) do
@@ -155,10 +156,9 @@ module Bridgetown
       end
 
       def git_init(path)
-        unless Bridgetown.environment == "test"
+        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
@@ -166,7 +166,7 @@ module Bridgetown
       end
 
       def yarn_install(path)
-        unless Bridgetown.environment == "test"
+        unless Bridgetown.environment.test?
           inside(path) do
             run "yarn install", abort_on_failure: true
           end

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.