bridgetown-core 0.18.4 → 0.19.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12935850728bd01e8b6aff21631a0ca38e62c1c3be5dfc94c7918ba49ff3a9b7
-  data.tar.gz: c85c38dc8c902d8fe774b98263d71c0845f301ed2793a61d71c700d77434173e
+  metadata.gz: 82771f9cc6fa2993f61010025de7fab09c2be37d9dfb3f365d728a6dd3ed5b3a
+  data.tar.gz: ab1cfb7e45eac85bb80852b33ab4ca1f5cc69b52f6a1bde70ea1c70c39859005
 SHA512:
-  metadata.gz: 10082e9084ea89ed6e2cae0da189ba8a2e81dfe22501c32622db5ba0c83a447351789c9f73e28fc53210500dc56f73689f7021d25239df663010e14b2041589b
-  data.tar.gz: b934861ac81add8ac716ada0156af33b9cdd93228cab17cad968d8a0a3cbdf1749d72467b4ef51d2da7db100aaa5916a7d2d4b0bd4643c735185ceae66087357
+  metadata.gz: 67ea143f786bf6825f6db8ffa4ba1ce336e5d20e6746bbb24a754df40e0ba5084c3a5a04b0965f7ee080de67f2312b79d0251f34d76174fd55ca3ba379667928
+  data.tar.gz: 2ad31567525e3b3633c4620088df104d2fe5ae65010ffadab04baa33982c960640430f16f13eeab6718c27ec2e66574e5aeeb30be90086ab2707a9f465e9d9c5

data/bin/bridgetown

@@ -5,6 +5,12 @@ STDOUT.sync = true
 
 $LOAD_PATH.unshift File.expand_path("../../bridgetown/lib", __dir__)
 
+# Used by commands/automations
+require "active_support"
+require "active_support/core_ext/array/extract_options"
+require "active_support/core_ext/string/strip"
+require "active_support/core_ext/string/indent"
+
 require "bridgetown"
 
 Bridgetown::PluginManager.require_from_bundler

data/bridgetown-core.gemspec

@@ -42,14 +42,14 @@ Gem::Specification.new do |s|
   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",                "~> 5.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("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")
+  s.add_runtime_dependency("thor",                  "~> 1.1")
   s.add_runtime_dependency("tilt",                  "~> 2.0")
+  s.add_runtime_dependency("webrick",               "~> 1.7")
 end

data/lib/bridgetown-core.rb

@@ -29,14 +29,18 @@ require "csv"
 require "json"
 
 # 3rd party
+require "active_support"
+require "active_support/core_ext/hash/keys"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/string/inflections"
+require "active_support/core_ext/string/inquiry"
+require "active_support/core_ext/string/starts_ends_with"
+require "active_support/descendants_tracker"
 require "hash_with_dot_access"
 require "pathutil"
 require "addressable/uri"
 require "safe_yaml/load"
 require "liquid"
-require "liquid-render-tag"
 require "liquid-component"
 require "kramdown"
 require "colorator"
@@ -44,12 +48,30 @@ require "i18n"
 require "faraday"
 require "thor"
 
+module HashWithDotAccess
+  class Hash # :nodoc:
+    def to_liquid
+      to_h.to_liquid
+    end
+  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
   # internal requires
   autoload :Cleaner,             "bridgetown-core/cleaner"
@@ -118,7 +140,7 @@ module Bridgetown
     # Tells you which Bridgetown environment you are building in so
     #   you can skip tasks if you need to.
     def environment
-      ENV["BRIDGETOWN_ENV"] || "development"
+      (ENV["BRIDGETOWN_ENV"] || "development").inquiry
     end
     alias_method :env, :environment
 

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

@@ -26,6 +26,7 @@ module Bridgetown
 
       def apply_automation
         @source_paths = [Dir.pwd]
+        @logger = Bridgetown.logger
 
         if options[:apply]
           apply_after_new_command
@@ -33,9 +34,9 @@ module Bridgetown
           apply_in_pwd
         end
       rescue SystemExit => e
-        Bridgetown.logger.error "Problem occurred while running automation:"
+        @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'")
+          @logger.info backtrace_line if backtrace_line.include?(":in `apply'")
         end
         raise e
       end
@@ -66,7 +67,7 @@ module Bridgetown
           apply_from_url automation_command
         end
       rescue ArgumentError => e
-        Bridgetown.logger.warn "Oops!", e.message
+        @logger.warn "Oops!", e.message
       end
     end
   end

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

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-# Mostly not used here, but may come in handy in new automations
-require "active_support/core_ext/array/extract_options"
-require "active_support/core_ext/string/strip"
-require "active_support/core_ext/string/indent"
-
 module Bridgetown
   module Commands
     module Actions

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Commands
+    class Configure < Thor::Group
+      include Thor::Actions
+      extend Summarizable
+
+      Registrations.register do
+        register(Configure, "configure", "configure CONFIGURATION", Configure.summary)
+      end
+
+      def self.banner
+        "bridgetown configure CONFIGURATION(S)"
+      end
+      summary "Set up bundled Bridgetown configurations"
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def perform_configurations
+        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}"
+        end
+      end
+
+      def self.source_root
+        File.expand_path("../configurations", __dir__)
+      end
+
+      protected
+
+      def configure(configuration)
+        configuration_file = find_in_source_paths("#{configuration}.rb")
+
+        inside(New.created_site_dir || Dir.pwd) do
+          Apply.new.invoke(:apply_automation, [configuration_file])
+        end
+      end
+
+      def list_configurations
+        say "Please specify a valid packaged configuration from the below list:\n\n"
+        configurations.each do |configuration|
+          configuration = set_color configuration, :blue, :bold
+          say configuration
+        end
+      end
+
+      def configurations
+        inside self.class.source_root do
+          return Dir.glob("*.rb").map { |file| file.sub(".rb", "") }
+        end
+      end
+    end
+  end
+end

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

@@ -19,6 +19,10 @@ module Bridgetown
                    aliases: "-a",
                    banner: "PATH|URL",
                    desc: "Apply an automation after creating the site scaffold"
+      class_option :configure,
+                   aliases: "-c",
+                   banner: "CONFIGURATION(S)",
+                   desc: "Comma separated list of bundled configurations to perform"
       class_option :force,
                    type: :boolean,
                    desc: "Force creation even if PATH already exists"
@@ -28,6 +32,9 @@ module Bridgetown
       class_option :"skip-yarn",
                    type: :boolean,
                    desc: "Skip 'yarn install'"
+      class_option :"use-postcss",
+                   type: :boolean,
+                   desc: "Create an empty PostCSS configuration instead of using Sass"
 
       DOCSURL = "https://bridgetownrb.com/docs"
 
@@ -47,6 +54,8 @@ module Bridgetown
         raise ArgumentError, "You must specify a path." if args.empty?
 
         new_site_path = File.expand_path(args.join(" "), Dir.pwd)
+        @site_name = new_site_path.split(File::SEPARATOR).last
+
         if preserve_source_location?(new_site_path, options)
           say_status :conflict, "#{new_site_path} exists and is not empty.", :red
           Bridgetown.logger.abort_with "Ensure #{new_site_path} is empty or else " \
@@ -67,7 +76,7 @@ module Bridgetown
       end
 
       def create_site(new_site_path)
-        directory ".", ".", exclude_pattern: %r!\.erb|DS_Store$!
+        directory ".", ".", exclude_pattern: %r!\.erb|DS_Store$|\.(s[ac]|c)ss$!
         FileUtils.chmod_R "u+w", new_site_path
 
         template(
@@ -75,12 +84,27 @@ module Bridgetown
           "src/_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-bridgetown.md"
         )
         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
+      end
+
+      def configure_sass
+        copy_file("frontend/styles/index.scss")
+      end
+
+      def configure_postcss
+        template("postcss.config.js.erb", "postcss.config.js")
+        copy_file("frontend/styles/index.css")
       end
 
       # After a new site has been created, print a success notification and
       # then automatically execute bundle install from within the new site dir
       # unless the user opts to skip 'bundle install'.
       # rubocop:todo Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
       def after_install(path, cli_path, options = {})
         git_init path
 
@@ -91,6 +115,7 @@ module Bridgetown
         yarn_install path unless options["skip-yarn"]
 
         invoke(Apply, [], options) if options[:apply]
+        invoke(Configure, options[:configure].split(","), {}) if options[:configure]
 
         logger = Bridgetown.logger
         yarn_start = "yarn start"
@@ -111,6 +136,7 @@ module Bridgetown
         logger.info "Yarn install skipped.".yellow if @skipped_yarn
       end
       # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
 
       def bundle_install(path)
         unless Bridgetown.environment == "test"
@@ -132,6 +158,7 @@ module Bridgetown
         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"
           end
         end
       rescue SystemExit

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

@@ -150,6 +150,7 @@ module Bridgetown
         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"
 
           run "mv bridgetown-sample-plugin.gemspec #{new_gemspec}"
           gsub_file new_gemspec, "https://github.com/bridgetownrb/bridgetown-sample-plugin", "https://github.com/username/#{name}"

data/lib/bridgetown-core/configurations/bt-postcss.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+TEMPLATE_PATH = File.expand_path("./bt-postcss", __dir__)
+
+begin
+  find_in_source_paths("postcss.config.js")
+rescue Thor::Error
+  error_message = "#{"postcss.config.js".bold} not found. Please configure postcss in your project."
+
+  @logger.error "\nError:".red, "🚨 #{error_message}"
+  @logger.info "\nFor new projects, you can use #{"bridgetown new my_project --use-postcss".bold.blue}\n"
+
+  return
+end
+
+plugins = %w(postcss-easy-import postcss-mixins postcss-color-function cssnano)
+
+say "Adding the following PostCSS plugins: #{plugins.join(' | ')}", :green
+run "yarn add -D #{plugins.join(' ')}"
+
+remove_file "postcss.config.js"
+copy_file "#{TEMPLATE_PATH}/postcss.config.js", "postcss.config.js"
+
+# rubocop:enable all

data/lib/bridgetown-core/configurations/bt-postcss/postcss.config.js

@@ -0,0 +1,21 @@
+module.exports = {
+  plugins: {
+    'postcss-easy-import': {},
+    'postcss-mixins': {},
+    'postcss-color-function': {},
+    'postcss-flexbugs-fixes': {},
+    'postcss-preset-env': {
+      autoprefixer: {
+        flexbox: 'no-2009'
+      },
+      stage: 2,
+      features: {
+        'nesting-rules': true,
+        'custom-media-queries': true
+      },
+    },
+    'cssnano' : {
+      preset: 'default'
+    }
+  }
+}

data/lib/bridgetown-core/configurations/minitesting.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+
+say_status :minitesting, "Adding test gems, package.json scripts, and examples"
+
+append_to_file "Gemfile" do
+  <<~GEMS
+    \n
+    group :test, optional: true do
+      gem "nokogiri"
+      gem "minitest"
+      gem "minitest-profile"
+      gem "minitest-reporters"
+      gem "shoulda"
+      gem "rails-dom-testing"
+    end
+  GEMS
+end
+
+new_scripts = '    "test": "BRIDGETOWN_ENV=test yarn build",'
+new_scripts += "\n" + '    "deploy:test": "bundle install --with test && yarn deploy"'
+package_json = "package.json"
+script_regex = %r{"scripts": \{(\s+".*,?)*}
+inject_into_file(package_json, ",\n" + new_scripts, after: script_regex)
+
+create_file "test/helper.rb" do
+  <<~RUBY
+    require "nokogiri"
+    require "minitest/autorun"
+    require "minitest/reporters"
+    require "minitest/profile"
+    require "shoulda"
+    require "rails-dom-testing"
+    # Report with color.
+    Minitest::Reporters.use! [
+      Minitest::Reporters::DefaultReporter.new(
+        color: true
+      ),
+    ]
+    Minitest::Test.class_eval do
+      include Rails::Dom::Testing::Assertions
+      def site
+        @site ||= Bridgetown.sites.first
+      end
+      def nokogiri(input)
+        input.respond_to?(:output) ? Nokogiri::HTML(input.output) : Nokogiri::HTML(input)
+      end
+      def document_root(root)
+        @document_root = root.is_a?(Nokogiri::XML::Document) ? root : nokogiri(root)
+      end
+      def document_root_element
+        if @document_root.nil?
+          raise "Call `document_root' with a Nokogiri document before testing your assertions"
+        end
+        @document_root
+      end
+    end
+  RUBY
+end
+
+create_file "test/test_homepage.rb" do
+  <<~RUBY
+    require_relative "./helper"
+    class TestHomepage < Minitest::Test
+      context "homepage" do
+        setup do
+          page = site.pages.find { |doc| doc.url == "/" }
+          document_root page
+        end
+        should "exist" do
+          assert_select "body"
+        end
+      end
+    end
+  RUBY
+end
+
+create_file "plugins/test_output.rb" do
+  <<~RUBY
+    unless Bridgetown.environment == "development"
+      Bridgetown::Hooks.register :site, :post_write do
+        # Load test suite to run on exit
+        require "nokogiri"
+        Dir["test/**/*.rb"].each { |file| require_relative("../\#{file}") }
+      rescue LoadError
+        Bridgetown.logger.warn "Testing:", "To run tests, you must first run \`bundle install --with test\`"
+      end
+    end
+  RUBY
+end
+
+say_status :minitesting, "All set! To get started, look at test/test_homepage.rb and then run \`yarn test\`"
+
+# rubocop:enable all