bridgetown-core 0.18.6 → 0.20.0

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/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/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,66 @@
+# 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
+        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
+        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/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/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/concerns/data_accessible.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Bridgetown
+  # TODO: to be retired once the Resource engine is made official
   module DataAccessible
     # Returns the contents as a String.
     def to_s

data/lib/bridgetown-core/concerns/site/configurable.rb

@@ -30,11 +30,15 @@ class Bridgetown::Site
       configure_include_paths
       configure_file_read_opts
 
-      self.permalink_style = config["permalink"].to_sym
+      self.permalink_style = (config["permalink"] || "pretty").to_sym
 
       @config
     end
 
+    def uses_resource?
+      config[:content_engine] == "resource"
+    end
+
     def defaults_reader
       @defaults_reader ||= Bridgetown::DefaultsReader.new(self)
     end
@@ -78,7 +82,7 @@ class Bridgetown::Site
     # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_root_dir(*paths)
       paths.reduce(root_dir) do |base, path|
-        Bridgetown.sanitized_path(base, path)
+        Bridgetown.sanitized_path(base, path.to_s)
       end
     end
 
@@ -91,7 +95,7 @@ class Bridgetown::Site
     # @return [Array<String>] Return an array of updated paths if multiple paths given.
     def in_source_dir(*paths)
       paths.reduce(source) do |base, path|
-        Bridgetown.sanitized_path(base, path)
+        Bridgetown.sanitized_path(base, path.to_s)
       end
     end
 

data/lib/bridgetown-core/concerns/site/content.rb

@@ -32,6 +32,18 @@ class Bridgetown::Site
       end
     end
 
+    def resources_grouped_by_taxonomy(taxonomy)
+      @post_attr_hash[taxonomy.label] ||= begin
+        taxonomy.terms.transform_values { |terms| terms.map(&:resource).sort.reverse }
+      end
+    end
+
+    def taxonomies
+      taxonomy_types.transform_values do |taxonomy|
+        resources_grouped_by_taxonomy(taxonomy)
+      end
+    end
+
     # Returns a hash of "tags" using {#post_attr_hash} where each tag is a key
     #  and each value is a post which contains the key.
     # @example
@@ -41,7 +53,7 @@ class Bridgetown::Site
     # @return [Hash{String, Array<Post>}] Returns a hash of all tags and their corresponding posts
     # @see post_attr_hash
     def tags
-      post_attr_hash("tags")
+      uses_resource? ? taxonomies.tag : post_attr_hash("tags")
     end
 
     # Returns a hash of "categories" using {#post_attr_hash} where each tag is
@@ -54,7 +66,7 @@ class Bridgetown::Site
     #   their corresponding posts
     # @see post_attr_hash
     def categories
-      post_attr_hash("categories")
+      uses_resource? ? taxonomies.category : post_attr_hash("categories")
     end
 
     # Returns the value of `data["site_metadata"]` or creates a new instance of
@@ -121,19 +133,25 @@ class Bridgetown::Site
     # An array of collection names.
     # @return [Array<String>] an array of collection names from the configuration,
     #   or an empty array if the `config["collections"]` key is not set.
-    # @raise ArgumentError Raise an error if `config["collections"]` is not
-    #   an Array or a Hash
     def collection_names
-      case config["collections"]
-      when Hash
-        config["collections"].keys
-      when Array
-        config["collections"]
-      when nil
-        []
-      else
-        raise ArgumentError, "Your `collections` key must be a hash or an array."
-      end
+      Array(config.collections&.keys)
+    end
+
+    # @return [Array<Bridgetown::Resource::TaxonomyType>]
+    def taxonomy_types
+      @taxonomy_types ||= config.taxonomies.map do |label, key_or_metadata|
+        key = key_or_metadata
+        tax_metadata = if key_or_metadata.is_a? Hash
+                         key = key_or_metadata["key"]
+                         key_or_metadata.reject { |k| k == "key" }
+                       else
+                         HashWithDotAccess::Hash.new
+                       end
+
+        [label, Bridgetown::Resource::TaxonomyType.new(
+          site: self, label: label, key: key, metadata: tax_metadata
+        ),]
+      end.to_h.with_dot_access
     end
 
     # Get all documents.
@@ -155,11 +173,29 @@ class Bridgetown::Site
       documents.select(&:write?)
     end
 
-    # Get all posts.
+    # Get all documents.
+    # @return [Array<Document>] an array of documents from the
+    # configuration
+    def resources
+      collections.each_with_object(Set.new) do |(_, collection), set|
+        set.merge(collection.resources)
+      end.to_a
+    end
+
+    def resources_to_write
+      resources.select(&:write?)
+    end
+
+    # Get all posts. Deprecated, to be removed in v1.0.
     #
     # @return [Collection] Returns {#collections}`["posts"]`, creating it if need be
     # @see Collection
     def posts
+      unless @wrote_deprecation_msg
+        Bridgetown::Deprecator.deprecation_message "Call site.collections.posts " \
+                                                   "instead of site.posts (Ruby code)"
+      end
+      @wrote_deprecation_msg ||= true
       collections["posts"] ||= Bridgetown::Collection.new(self, "posts")
     end
 
@@ -177,7 +213,13 @@ class Bridgetown::Site
     #
     # @return [Array]
     def contents
+      return resources if uses_resource?
+
       pages + documents
     end
+
+    def add_generated_page(generated_page)
+      generated_pages << generated_page
+    end
   end
 end

data/lib/bridgetown-core/concerns/site/processable.rb

@@ -11,6 +11,7 @@ class Bridgetown::Site
     # @see #cleanup
     # @see #write
     def process
+      Bridgetown::Current.site = self
       reset
       read
       generate  # Extensible

data/lib/bridgetown-core/concerns/site/renderable.rb

@@ -29,6 +29,26 @@ class Bridgetown::Site
       end
     end
 
+    def matched_converters_for_convertible(convertible)
+      @layout_converters ||= {}
+
+      if convertible.is_a?(Bridgetown::Layout) && @layout_converters[convertible]
+        return @layout_converters[convertible]
+      end
+
+      matches = converters.select do |converter|
+        if converter.method(:matches).arity == 1
+          converter.matches(convertible.extname)
+        else
+          converter.matches(convertible.extname, convertible)
+        end
+      end
+
+      @layout_converters[convertible] = matches if convertible.is_a?(Bridgetown::Layout)
+
+      matches
+    end
+
     # Renders all documents
     # @return [void]
     def render_docs
@@ -38,6 +58,12 @@ class Bridgetown::Site
             render_regenerated document
           end
         end
+
+        collection.resources.each do |resource|
+          render_with_locale(resource) do
+            resource.transform!
+          end
+        end
       end
     end