bridgetown-core 0.14.1 → 0.15.0

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

@@ -1,187 +1,152 @@
 # frozen_string_literal: true
 
-require "erb"
-
 module Bridgetown
   module Commands
-    class New < Command
-      class << self
-        DOCSURL = "https://bridgetownrb.com/docs"
-
-        def init_with_program(prog)
-          prog.command(:new) do |c|
-            c.syntax "new PATH"
-            c.description "Creates a new Bridgetown site scaffold in PATH"
-
-            c.option "force", "--force", "Force creation even if PATH already exists"
-            c.option "skip-bundle", "--skip-bundle", "Skip 'bundle install'"
-            c.option "skip-yarn", "--skip-yarn", "Skip 'yarn install'"
-
-            c.action do |args, options|
-              Bridgetown::Commands::New.process(args, options)
-            end
-          end
-        end
-
-        def process(args, options = {})
-          raise ArgumentError, "You must specify a path." if args.empty?
-
-          new_site_path = File.expand_path(args.join(" "), Dir.pwd)
-          FileUtils.mkdir_p new_site_path
-          if preserve_source_location?(new_site_path, options)
-            Bridgetown.logger.error "Conflict:", "#{new_site_path} exists and is not empty."
-            Bridgetown.logger.abort_with "", "Ensure #{new_site_path} is empty or else " \
-                      "try again with `--force` to proceed and overwrite any files."
-          end
-
-          Bridgetown.logger.info("Creating:".green, new_site_path)
+    class New < Thor::Group
+      include Thor::Actions
+      extend Summarizable
 
-          create_site new_site_path
-
-          after_install(new_site_path, args.join(" "), options)
-        end
-
-        def scaffold_post_content
-          ERB.new(File.read(File.expand_path(scaffold_path, site_template))).result
-        end
-
-        # Internal: Gets the filename of the sample post to be created
-        #
-        # Returns the filename of the sample post, as a String
-        def initialized_post_name
-          "src/_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-bridgetown.md"
-        end
+      Registrations.register do
+        register(New, "new", "new PATH", New.summary)
+      end
 
-        private
-
-        def gemfile_contents
-          <<~RUBY
-            source "https://rubygems.org"
-            # Hello! This is where you manage which Bridgetown version is used to run.
-            # When you want to use a different version, change it below, save the
-            # file and run `bundle install`. Run Bridgetown with `bundle exec`, like so:
-            #
-            #   bundle exec bridgetown serve
-            #
-            # This will help ensure the proper Bridgetown version is running.
-            #
-            # To install a plugin, simply run bundle add and specify the group
-            # "bridgetown_plugins". For example:
-            #
-            #   bundle add some-new-plugin -g bridgetown_plugins
-            #
-            # Happy Bridgetowning!
-
-            gem "bridgetown", "~> #{Bridgetown::VERSION}"
-
-          RUBY
-        end
+      def self.banner
+        "bridgetown new PATH"
+      end
+      summary "Creates a new Bridgetown site scaffold in PATH"
+
+      class_option :apply,
+                   aliases: "-a",
+                   banner: "PATH|URL",
+                   desc: "Apply an automation after creating the site scaffold"
+      class_option :force,
+                   type: :boolean,
+                   desc: "Force creation even if PATH already exists"
+      class_option :"skip-bundle",
+                   type: :boolean,
+                   desc: "Skip 'bundle install'"
+      class_option :"skip-yarn",
+                   type: :boolean,
+                   desc: "Skip 'yarn install'"
+
+      DOCSURL = "https://bridgetownrb.com/docs"
+
+      def self.exit_on_failure?
+        false
+      end
 
-        def create_site(new_site_path)
-          create_sample_files new_site_path
+      def self.source_root
+        File.expand_path("../../site_template", __dir__)
+      end
 
-          File.open(File.expand_path(initialized_post_name, new_site_path), "w") do |f|
-            f.write(scaffold_post_content)
-          end
+      class << self
+        attr_accessor :created_site_dir
+      end
 
-          File.open(File.expand_path("Gemfile", new_site_path), "w") do |f|
-            f.write(gemfile_contents)
-          end
-        end
+      def new_site
+        raise ArgumentError, "You must specify a path." if args.empty?
 
-        def preserve_source_location?(path, options)
-          !options["force"] && !Dir["#{path}/**/*"].empty?
+        new_site_path = File.expand_path(args.join(" "), Dir.pwd)
+        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 " \
+                    "try again with `--force` to proceed and overwrite any files."
         end
 
-        def create_sample_files(path)
-          FileUtils.cp_r site_template + "/.", path
-          FileUtils.chmod_R "u+w", path
-          FileUtils.rm File.expand_path(scaffold_path, path)
-        end
+        self.destination_root = self.class.created_site_dir = new_site_path
 
-        def site_template
-          File.expand_path("../../site_template", __dir__)
-        end
+        say_status :create, new_site_path
+        create_site new_site_path
+        after_install new_site_path, args.join(" "), options
+      end
 
-        def scaffold_path
-          "src/_posts/0000-00-00-welcome-to-bridgetown.md.erb"
-        end
+      protected
 
-        # 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:disable Metrics/AbcSize, Metrics/MethodLength #
-        def after_install(path, cli_path, options = {})
-          logger = Bridgetown.logger
-          git_init path
-
-          unless options["skip-bundle"]
-            begin
-              require "bundler"
-              bundle_install path
-            rescue LoadError
-              logger.info "Could not load Bundler. Bundle install skipped."
-            end
-          end
+      def preserve_source_location?(path, options)
+        !options["force"] && Dir.exist?(path)
+      end
 
-          yarn_install path unless options["skip-yarn"]
+      def create_site(new_site_path)
+        directory ".", ".", exclude_pattern: %r!\.erb|DS_Store$!
+        FileUtils.chmod_R "u+w", new_site_path
 
-          yarn_start = "yarn start"
+        template(
+          "src/_posts/0000-00-00-welcome-to-bridgetown.md.erb",
+          "src/_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-bridgetown.md"
+        )
+        template("Gemfile.erb", "Gemfile")
+      end
 
-          logger.info "Success!".green, "🎉 Your new Bridgetown site was" \
-                      " generated in #{cli_path.cyan}."
-          if options["skip-yarn"]
-            logger.info "You can now #{"cd".cyan} #{cli_path.cyan} to get started."
-            logger.info "You'll probably also want to #{"yarn install".cyan}" \
-                        " to load in your frontend assets."
-          else
-            logger.info "You can now #{"cd".cyan} and run #{yarn_start.cyan} to get started."
-          end
-          logger.info "Then check out our online documentation for" \
-                      " next steps: #{DOCSURL.cyan}"
-          logger.info "Bundle install skipped." if options["skip-bundle"]
+      # 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
+      def after_install(path, cli_path, options = {})
+        git_init path
+
+        @skipped_bundle = true # is set to false if bundle install worked
+        bundle_install path unless options["skip-bundle"]
+
+        @skipped_yarn = true
+        yarn_install path unless options["skip-yarn"]
+
+        invoke(Apply, [], options) if options[:apply]
+
+        logger = Bridgetown.logger
+        yarn_start = "yarn start"
+        logger.info ""
+        logger.info "Success!".green, "🎉 Your new Bridgetown site was" \
+                    " generated in #{cli_path.cyan}."
+        if options["skip-yarn"]
+          logger.info "You can now #{"cd".cyan} #{cli_path.cyan} to get started."
+          logger.info "You'll probably also want to #{"yarn install".cyan}" \
+                      " to load in your frontend assets."
+        else
+          logger.info "You can now #{"cd".cyan} and run #{yarn_start.cyan} to get started."
         end
-        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength #
+        logger.info "Then check out our online documentation for" \
+                    " next steps: #{DOCSURL.cyan}"
 
-        def bundle_install(path)
-          Bridgetown.logger.info "Running bundle install in #{path.cyan}..."
-          Dir.chdir(path) do
-            exe = Gem.bin_path("bundler", "bundle")
-            process, output = Bridgetown::Utils::Exec.run("ruby", exe, "install")
-
-            output.to_s.each_line do |line|
-              Bridgetown.logger.info("Bundler:".green, line.strip) unless line.to_s.empty?
+        logger.info "Bundle install skipped.".yellow if @skipped_bundle
+        logger.info "Yarn install skipped.".yellow if @skipped_yarn
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def bundle_install(path)
+        unless Bridgetown.environment == "test"
+          require "bundler"
+          Bundler.with_clean_env do
+            inside(path) do
+              run "bundle install", abort_on_failure: true
             end
-
-            raise SystemExit unless process.success?
           end
         end
+        @skipped_bundle = false
+      rescue LoadError
+        say_status :run, "Could not load Bundler. Bundle install skipped.", :red
+      rescue SystemExit
+        say_status :run, "Problem occured while running bundle install.", :red
+      end
 
-        def git_init(path)
-          Dir.chdir(path) do
-            _process, output = Bridgetown::Utils::Exec.run("git", "init")
-            output.to_s.each_line do |line|
-              Bridgetown.logger.info("Git:".green, line.strip) unless line.to_s.empty?
-            end
+      def git_init(path)
+        unless Bridgetown.environment == "test"
+          inside(path) do
+            run "git init", abort_on_failure: true
           end
-        rescue SystemCallError
         end
+      rescue SystemExit
+        say_status :run, "Could not load git. git init skipped.", :red
+      end
 
-        def yarn_install(path)
-          Bridgetown.logger.info "Running yarn install in #{path.cyan}..."
-          Dir.chdir(path) do
-            _process, output = Bridgetown::Utils::Exec.run("yarn", "install")
-            output.to_s.each_line do |line|
-              next if line.to_s.empty? ||
-                line.strip.start_with?("warning ") ||
-                line.include?("No lockfile found")
-
-              Bridgetown.logger.info("Yarn:".green, line.strip)
-            end
+      def yarn_install(path)
+        unless Bridgetown.environment == "test"
+          inside(path) do
+            run "yarn install", abort_on_failure: true
           end
-        rescue SystemCallError
-          Bridgetown.logger.info "Could not load yarn. yarn install skipped."
         end
+        @skipped_yarn = false
+      rescue SystemExit
+        say_status :run, "Could not load yarn. yarn install skipped.", :red
       end
     end
   end

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

@@ -2,166 +2,203 @@
 
 module Bridgetown
   module Commands
-    class Plugins < Command
-      class << self
-        def init_with_program(prog)
-          plugins_cmd = prog.command(:plugins) do |c|
-            c.syntax "plugins <subcommand>"
-            c.description "List installed plugins or access plugin content"
-
-            c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array,
-                     "Custom configuration file"
-
-            c.action do
-              output_supercommand_syntax(c)
-            end
-          end
+    class Plugins < Thor
+      include Thor::Actions
+      include ConfigurationOverridable
 
-          plugins_cmd.command(:list) do |subcmd|
-            subcmd.syntax "list"
-            subcmd.description "List information about installed plugins"
+      Registrations.register do
+        desc "plugins <command>", "List installed plugins or access plugin content"
+        subcommand "plugins", Plugins
+      end
 
-            subcmd.action do |_, options|
-              list(options)
-            end
-          end
+      desc "list", "List information about installed plugins"
+      def list
+        site = Bridgetown::Site.new(configuration_with_overrides(options))
+        site.reset
+        Bridgetown::Hooks.trigger :site, :pre_read, site
 
-          plugins_cmd.command(:cd) do |subcmd|
-            subcmd.syntax "cd <origin/dir>"
-            subcmd.description "Open directory (content, layouts, etc.) within the plugin origin"
+        pm = site.plugin_manager
 
-            subcmd.action do |args, options|
-              if args.empty?
-                puts subcmd.to_s
-              else
-                cd(args, options)
-              end
-            end
-          end
+        plugins_list = pm.class.registered_plugins.reject do |plugin|
+          plugin.to_s.end_with? "site_builder.rb"
         end
 
-        def output_supercommand_syntax(supercmd)
-          puts supercmd.to_s
+        Bridgetown.logger.info("Registered Plugins:", plugins_list.length.to_s.yellow.bold)
+
+        plugins_list.each do |plugin|
+          unless plugin.to_s.end_with? "site_builder.rb"
+            Bridgetown.logger.info("", plugin.to_s.sub(site.in_root_dir("/"), ""))
+          end
         end
 
-        def list(options)
-          site = Bridgetown::Site.new(configuration_from_options(options))
-          site.reset
-          Bridgetown::Hooks.trigger :site, :pre_read, site
+        Bridgetown.logger.info("Source Manifests:", "---") unless pm.class.source_manifests.empty?
 
-          pm = site.plugin_manager
+        pm.class.source_manifests.each do |manifest|
+          Bridgetown.logger.info("Origin:", (manifest.origin || "n/a").to_s.green)
+          Bridgetown.logger.info("Components:", (manifest.components || "n/a").to_s.cyan)
+          Bridgetown.logger.info("Content:", (manifest.content || "n/a").to_s.cyan)
+          Bridgetown.logger.info("Layouts:", (manifest.layouts || "n/a").to_s.cyan)
 
-          plugins_list = pm.class.registered_plugins.reject do |plugin|
-            plugin.to_s.end_with? "site_builder.rb"
-          end
+          Bridgetown.logger.info("", "---")
+        end
 
-          Bridgetown.logger.info("Registered Plugins:", plugins_list.length.to_s.yellow.bold)
+        unless Bridgetown.autoload? :Builder
+          builders = Bridgetown::Builder.descendants
+          Bridgetown.logger.info("Builders:", builders.length.to_s.yellow.bold)
 
-          plugins_list.each do |plugin|
-            unless plugin.to_s.end_with? "site_builder.rb"
-              Bridgetown.logger.info("", plugin.to_s.sub(site.in_root_dir("/"), ""))
-            end
+          builders.each do |builder|
+            name = builder.respond_to?(:custom_name) ? builder.custom_name : builder.name
+            name_components = name.split("::")
+            last_name = name_components.pop
+            name_components.push last_name.magenta
+            Bridgetown.logger.info("", name_components.join("::"))
           end
+        end
 
-          Bridgetown.logger.info("Source Manifests:", "---") unless pm.class.source_manifests.empty?
+        Bridgetown.logger.info("Converters:", site.converters.length.to_s.yellow.bold)
 
-          pm.class.source_manifests.each do |manifest|
-            Bridgetown.logger.info("Origin:", (manifest.origin || "n/a").to_s.green)
-            Bridgetown.logger.info("Components:", (manifest.components || "n/a").to_s.cyan)
-            Bridgetown.logger.info("Content:", (manifest.content || "n/a").to_s.cyan)
-            Bridgetown.logger.info("Layouts:", (manifest.layouts || "n/a").to_s.cyan)
+        site.converters.each do |converter|
+          name = plugin_name_for(converter)
+          name_components = name.split("::")
+          last_name = name_components.pop
+          name_components.push last_name.magenta
+          Bridgetown.logger.info("", name_components.join("::"))
+        end
 
-            Bridgetown.logger.info("", "---")
-          end
+        Bridgetown.logger.info("Generators:", site.generators.length.to_s.yellow.bold)
 
-          unless Bridgetown.autoload? :Builder
-            builders = Bridgetown::Builder.descendants
-            Bridgetown.logger.info("Builders:", builders.length.to_s.yellow.bold)
+        site.generators.each do |generator|
+          name = plugin_name_for(generator)
+          name_components = name.split("::")
+          last_name = name_components.pop
+          name_components.push last_name.magenta
+          Bridgetown.logger.info("", name_components.join("::"))
+        end
+      end
+
+      long_desc <<-DOC
+        Open a directory (content, layouts, etc.) within the plugin origin. \n
+        First run bridgetown plugins list to view source manifests currently
+        set up on your site.\n
+        Then look for the origin of the manifest and the folder you'd like to
+        open.\n
+        So for example, with an origin of SamplePlugin and a folder of
+        Layouts, you'd run:\n
+        bridgetown plugins cd SamplePlugin/Layouts
+      DOC
+      desc "cd <origin/dir>", "Open folder (content, layouts, etc.) within the plugin origin"
+
+      # This is super useful if you want to copy files out of plugins to override.
+      #
+      # Example:
+      #   bridgetown plugins cd AwesomePlugin/layouts
+      #   cp -r * $BRIDGETOWN_SITE/src/_layouts
+      #
+      # Now all the plugin's layouts will be in the site repo directly.
+      #
+      def cd(arg)
+        site = Bridgetown::Site.new(configuration_with_overrides(options))
+
+        pm = site.plugin_manager
+
+        directive = arg.split("/")
+        unless directive[1]
+          Bridgetown.logger.warn("Oops!", "Your command needs to be in the <origin/dir> format")
+          return
+        end
+
+        manifest = pm.class.source_manifests.find do |source_manifest|
+          source_manifest.origin.to_s == directive[0]
+        end
 
-            builders.each do |builder|
-              name = builder.respond_to?(:custom_name) ? builder.custom_name : builder.name
-              name_components = name.split("::")
-              last_name = name_components.pop
-              name_components.push last_name.magenta
-              Bridgetown.logger.info("", name_components.join("::"))
+        if manifest&.respond_to?(directive[1].downcase)
+          dir = manifest.send(directive[1].downcase)
+          Bridgetown.logger.info("Opening the #{dir.green} folder for" \
+                                  " #{manifest.origin.to_s.cyan}…")
+          Bridgetown.logger.info("Type #{"exit".yellow} when you're done to" \
+                                  " return to your site root.")
+          puts
+
+          Dir.chdir dir do
+            ENV["BRIDGETOWN_SITE"] = site.root_dir
+            if ENV["SHELL"]
+              system(ENV["SHELL"])
+            else
+              system("/bin/sh")
             end
           end
 
-          Bridgetown.logger.info("Converters:", site.converters.length.to_s.yellow.bold)
+          puts
+          Bridgetown.logger.info("Done!", "You're back in #{Dir.pwd.green}")
+        else
+          Bridgetown.logger.warn("Oops!", "I wasn't able to find the" \
+                                  " #{directive[1]} folder for #{directive[0]}")
+        end
+      end
 
-          site.converters.each do |converter|
-            name = plugin_name_for(converter)
-            name_components = name.split("::")
-            last_name = name_components.pop
-            name_components.push last_name.magenta
-            Bridgetown.logger.info("", name_components.join("::"))
-          end
+      desc "new NAME", "Create a new plugin NAME (please-use-dashes) by" \
+                       " cloning the sample plugin repo"
+      # rubocop:disable Layout/LineLength
+      def new(plugin_name)
+        folder_name = plugin_name.underscore
+        name = folder_name.dasherize
+        module_name = folder_name.camelize
 
-          Bridgetown.logger.info("Generators:", site.generators.length.to_s.yellow.bold)
+        run "git clone https://github.com/bridgetownrb/bridgetown-sample-plugin #{name}"
+        new_gemspec = "#{name}.gemspec"
 
-          site.generators.each do |generator|
-            name = plugin_name_for(generator)
-            name_components = name.split("::")
-            last_name = name_components.pop
-            name_components.push last_name.magenta
-            Bridgetown.logger.info("", name_components.join("::"))
-          end
-        end
+        inside name do # rubocop:todo Metrics/BlockLength
+          run "rm -rf .git"
+          run "git init"
 
-        # This is super useful if you want to copy files out of plugins to override.
-        #
-        # Example:
-        #   bridgetown plugins cd AwesomePlugin/layouts
-        #   cp -r * $BRIDGETOWN_SITE/src/_layouts
-        #
-        # Now all the plugin's layouts will be in the site repo directly.
-        #
-        def cd(args, options)
-          site = Bridgetown::Site.new(configuration_from_options(options))
-
-          pm = site.plugin_manager
-
-          directive = args[0].split("/")
-          unless directive[1]
-            Bridgetown.logger.warn("Oops!", "Your command needs to be in the <origin/dir> format")
-            return
-          end
+          run "mv bridgetown-sample-plugin.gemspec #{new_gemspec}"
+          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
+          gsub_file new_gemspec, "SamplePlugin", module_name
 
-          manifest = pm.class.source_manifests.find do |source_manifest|
-            source_manifest.origin.to_s == directive[0]
-          end
+          gsub_file "package.json", "https://github.com/bridgetownrb/bridgetown-sample-plugin", "https://github.com/username/#{name}"
+          gsub_file "package.json", "bridgetown-sample-plugin", name
 
-          if manifest&.respond_to?(directive[1].downcase)
-            dir = manifest.send(directive[1].downcase)
-            Bridgetown.logger.info("Opening the #{dir.green} folder for" \
-                                   " #{manifest.origin.to_s.cyan}…")
-            Bridgetown.logger.info("Type #{"exit".yellow} when you're done to" \
-                                   " return to your site root.")
-            puts
-
-            Dir.chdir dir do
-              ENV["BRIDGETOWN_SITE"] = site.root_dir
-              if ENV["SHELL"]
-                system(ENV["SHELL"])
-              else
-                system("/bin/sh")
-              end
-            end
+          run "mv lib/sample-plugin.rb lib/#{name}.rb"
+          gsub_file "lib/#{name}.rb", "sample-plugin", name
+          gsub_file "lib/#{name}.rb", "SamplePlugin", module_name
 
-            puts
-            Bridgetown.logger.info("Done!", "You're back in #{Dir.pwd.green}")
-          else
-            Bridgetown.logger.warn("Oops!", "I wasn't able to find the" \
-                                   " #{directive[1]} folder for #{directive[0]}")
-          end
+          run "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
+
+          run "mv components/sample_plugin components/#{folder_name}"
+          run "mv content/sample_plugin content/#{folder_name}"
+          run "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
+          gsub_file "components/#{folder_name}/layout_help.liquid", "sample_plugin", folder_name
+
+          gsub_file "frontend/javascript/index.js", "bridgetown-sample-plugin", name
+          gsub_file "frontend/javascript/index.js", "SamplePlugin", module_name
         end
+        say ""
+        say_status "Done!", "Have fun writing your new #{name} plugin :)"
+        say_status "Remember:", "Don't forget to rename the SamplePlugin" \
+                               " code identifiers and paths to your own" \
+                               " indentifer, as well as update your README " \
+                               " and CHANGELOG files as necessary."
+      end
+      # rubocop:enable Layout/LineLength
 
-        def plugin_name_for(plugin)
-          if plugin.class.respond_to?(:custom_name)
-            plugin.class.custom_name
-          else
-            plugin.class.name
-          end
+      protected
+
+      def plugin_name_for(plugin)
+        if plugin.class.respond_to?(:custom_name)
+          plugin.class.custom_name
+        else
+          plugin.class.name
         end
       end
     end