bridgetown-core 0.21.0.beta2 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5271d5bbaf78f54da137c78c0885ca8ca7b66787ea432c362bd1c51416a39c2
-  data.tar.gz: 440500addaa640424b810080179b9e20b22bf9f2936605c77635563c0f102cd1
+  metadata.gz: e3ba931e1d2393d0b13861c33e41c465a4e422baac0f9a68e39699b8159a2c5c
+  data.tar.gz: ff03f8af4f51257689ec84b0b661b0ba22ceb16a9110c5715aab56645020219c
 SHA512:
-  metadata.gz: 375d68544812f8238a226aa6a9986baa74bf08a19d674f1290729ffe556c9a9af29887ef215acd219e6a7e2c0f29fa90c4832afe72c8c37425e3746fa6367531
-  data.tar.gz: 1bc5fcb4c65abf6c394332d891883547106ddb2d233519766578bc33fe1778bd1e97ee830c9dc33f556a7e2486d36f17e6534482b3b51f1af0ca8d463ba6c105
+  metadata.gz: 82407b17c101d072436853bb2892108b544d91d2667dbdef36696d674ce3af18a123920f0e33dd3acce352bf7ad48c9df162c03aba977d7dad2a23ad1dfbc20e
+  data.tar.gz: 6c6c47fbf536cf3e3104040ce480be88183b60df5220845fe8a163af32de700b9f358c9d2bf58d19985da42d66e4005765c3d47a5e3c29def6039f77a640447b

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"
@@ -44,7 +45,6 @@ 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"
@@ -62,21 +62,8 @@ 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"
@@ -128,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"
@@ -145,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
@@ -268,9 +257,21 @@ end
 
 module Bridgetown
   module Model; end
-  module Resource; end
+  module Resource
+    def self.register_extension(mod)
+      if mod.const_defined?(:LiquidResource)
+        Bridgetown::Drops::ResourceDrop.include mod.const_get(:LiquidResource)
+      end
+      if mod.const_defined?(:RubyResource)
+        Bridgetown::Resource::Base.include mod.const_get(:RubyResource)
+      end
+    end
+  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

@@ -242,7 +242,7 @@ module Bridgetown
       site.config.collections[label] || HashWithDotAccess::Hash.new
     end
 
-    def merge_data_resources
+    def merge_data_resources # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
       data_contents = {}
 
       sanitize_filename = ->(name) do
@@ -256,11 +256,16 @@ module Bridgetown
         segments.each_with_index do |segment, index|
           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.rows || data_resource.data
-                                   else
-                                     {}
-                                   end
+          if !hsh.is_a?(Hash)
+            Bridgetown.logger.error(
+              "Error:",
+              "#{nested.join("/")} is not a Hash structure, #{segment} cannot be read"
+            )
+          elsif index == segments.length - 1
+            hsh[sanitized_segment] = data_resource.data.rows || data_resource.data
+          elsif !hsh.key?(sanitized_segment)
+            hsh[sanitized_segment] = {}
+          end
           nested << sanitized_segment
         end
       end
@@ -287,7 +292,7 @@ module Bridgetown
         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?
+      resources << resource if site.config.unpublished || resource.published?
     end
 
     private
@@ -298,7 +303,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?
+      docs << doc if site.config.unpublished || doc.published?
     end
 
     def sort_docs!

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

@@ -36,9 +36,9 @@ module Bridgetown
         klass.class_option :limit_posts,
                            type: :numeric,
                            desc: "Limits the number of posts to parse and publish"
-        klass.class_option :baseurl,
+        klass.class_option :base_path,
                            aliases: "-b",
-                           desc: "Serve the website from the given base URL"
+                           desc: "Serve the website from the given base path"
         klass.class_option :force_polling,
                            type: :boolean,
                            desc: "Force watch to use polling"

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/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

@@ -119,7 +119,7 @@ module Bridgetown
 
       def start_up_webrick(opts, destination)
         @server = WEBrick::HTTPServer.new(webrick_opts(opts)).tap { |o| o.unmount("") }
-        @server.mount(opts["baseurl"].to_s, Servlet, destination, file_handler_opts)
+        @server.mount(opts["base_path"].to_s, Servlet, destination, file_handler_opts)
 
         Bridgetown.logger.info "Server address:", server_address(@server, opts)
         launch_browser @server, opts if opts["open_url"]

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    class Webpack < Thor::Group
+      include Thor::Actions
+      extend Summarizable
+
+      Registrations.register do
+        register(Webpack, "webpack", "webpack ACTION", Webpack.summary)
+      end
+
+      def self.banner
+        "bridgetown webpack ACTION"
+      end
+      summary "Perform actions on the bridgetown webpack configuration"
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def webpack
+        @logger = Bridgetown.logger
+        return show_actions if args.empty?
+
+        action = args.first
+        if supported_actions.include?(action)
+          perform action
+        else
+          @logger.error "Error:".red, "🚨 Please enter a valid action."
+          say "\n"
+          show_actions
+        end
+      end
+
+      def self.source_root
+        File.expand_path("./webpack", __dir__)
+      end
+
+      def self.destination_root
+        config.root_dir
+      end
+
+      protected
+
+      def config
+        @config ||= Bridgetown.configuration({ root_dir: Dir.pwd })
+      end
+
+      def package_json
+        @package_json ||= begin
+          package_json_file = File.read(Bridgetown.sanitized_path(config.root_dir, "package.json"))
+          JSON.parse(package_json_file)
+        end
+      end
+
+      def perform(action)
+        automation = find_in_source_paths("#{action}.rb")
+        inside(New.created_site_dir || Dir.pwd) do
+          apply automation, verbose: false
+        end
+      end
+
+      def show_actions
+        say "Available actions:\n".bold
+
+        longest_action = supported_actions.keys.max_by(&:size).size
+        supported_actions.each do |action, description|
+          say action.ljust(longest_action).to_s.bold.blue + "\t" + "# #{description}"
+        end
+      end
+
+      def supported_actions
+        {
+          setup: "Sets up a webpack integration with Bridgetown in your project",
+          update: "Updates the Bridgetown webpack defaults to the latest available version",
+          "enable-postcss": "Configures PostCSS in your project",
+        }.with_indifferent_access
+      end
+    end
+  end
+end

data/lib/bridgetown-core/commands/webpack/enable-postcss.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+default_postcss_config = File.expand_path("../../../site_template/postcss.config.js.erb", __dir__)
+
+template default_postcss_config, "postcss.config.js"
+template "webpack.defaults.js.erb", "config/webpack.defaults.js", force: true
+
+unless Bridgetown.environment.test?
+  packages = %w(postcss@8.3.0 postcss-loader@4.3.0 postcss-flexbugs-fixes postcss-preset-env)
+  run "yarn add -D #{packages.join(" ")}"
+  run "yarn remove sass sass-loader"
+end