jekyll 4.0.1 → 4.2.1

data/lib/jekyll/commands/new.rb

@@ -1,169 +1,169 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Jekyll
-  module Commands
-    class New < Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:new) do |c|
-            c.syntax "new PATH"
-            c.description "Creates a new Jekyll site scaffold in PATH"
-
-            c.option "force", "--force", "Force creation even if PATH already exists"
-            c.option "blank", "--blank", "Creates scaffolding but with empty files"
-            c.option "skip-bundle", "--skip-bundle", "Skip 'bundle install'"
-
-            c.action do |args, options|
-              Jekyll::Commands::New.process(args, options)
-            end
-          end
-        end
-
-        def process(args, options = {})
-          raise ArgumentError, "You must specify a path." if args.empty?
-
-          new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
-          FileUtils.mkdir_p new_blog_path
-          if preserve_source_location?(new_blog_path, options)
-            Jekyll.logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
-            Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else " \
-                      "try again with `--force` to proceed and overwrite any files."
-          end
-
-          if options["blank"]
-            create_blank_site new_blog_path
-          else
-            create_site new_blog_path
-          end
-
-          after_install(new_blog_path, options)
-        end
-
-        def blank_template
-          File.expand_path("../../blank_template", __dir__)
-        end
-
-        def create_blank_site(path)
-          FileUtils.cp_r blank_template + "/.", path
-          FileUtils.chmod_R "u+w", path
-
-          Dir.chdir(path) do
-            FileUtils.mkdir(%w(_data _drafts _includes _posts))
-          end
-        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
-          "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.markdown"
-        end
-
-        private
-
-        def gemfile_contents
-          <<~RUBY
-            source "https://rubygems.org"
-            # Hello! This is where you manage which Jekyll version is used to run.
-            # When you want to use a different version, change it below, save the
-            # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-            #
-            #     bundle exec jekyll serve
-            #
-            # This will help ensure the proper Jekyll version is running.
-            # Happy Jekylling!
-            gem "jekyll", "~> #{Jekyll::VERSION}"
-            # This is the default theme for new Jekyll sites. You may change this to anything you like.
-            gem "minima", "~> 2.5"
-            # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-            # uncomment the line below. To upgrade, run `bundle update github-pages`.
-            # gem "github-pages", group: :jekyll_plugins
-            # If you have any plugins, put them here!
-            group :jekyll_plugins do
-              gem "jekyll-feed", "~> 0.12"
-            end
-
-            # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
-            # and associated library.
-            install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
-              gem "tzinfo", "~> 1.2"
-              gem "tzinfo-data"
-            end
-
-            # Performance-booster for watching directories on Windows
-            gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
-
-          RUBY
-        end
-
-        def create_site(new_blog_path)
-          create_sample_files new_blog_path
-
-          File.open(File.expand_path(initialized_post_name, new_blog_path), "w") do |f|
-            f.write(scaffold_post_content)
-          end
-
-          File.open(File.expand_path("Gemfile", new_blog_path), "w") do |f|
-            f.write(gemfile_contents)
-          end
-        end
-
-        def preserve_source_location?(path, options)
-          !options["force"] && !Dir["#{path}/**/*"].empty?
-        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
-
-        def site_template
-          File.expand_path("../../site_template", __dir__)
-        end
-
-        def scaffold_path
-          "_posts/0000-00-00-welcome-to-jekyll.markdown.erb"
-        end
-
-        # After a new blog has been created, print a success notification and
-        # then automatically execute bundle install from within the new blog dir
-        # unless the user opts to generate a blank blog or skip 'bundle install'.
-
-        def after_install(path, options = {})
-          unless options["blank"] || options["skip-bundle"]
-            begin
-              require "bundler"
-              bundle_install path
-            rescue LoadError
-              Jekyll.logger.info "Could not load Bundler. Bundle install skipped."
-            end
-          end
-
-          Jekyll.logger.info "New jekyll site installed in #{path.cyan}."
-          Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"]
-        end
-
-        def bundle_install(path)
-          Jekyll.logger.info "Running bundle install in #{path.cyan}..."
-          Dir.chdir(path) do
-            exe = Gem.bin_path("bundler", "bundle")
-            process, output = Jekyll::Utils::Exec.run("ruby", exe, "install")
-
-            output.to_s.each_line do |line|
-              Jekyll.logger.info("Bundler:".green, line.strip) unless line.to_s.empty?
-            end
-
-            raise SystemExit unless process.success?
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "erb"
+
+module Jekyll
+  module Commands
+    class New < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:new) do |c|
+            c.syntax "new PATH"
+            c.description "Creates a new Jekyll site scaffold in PATH"
+
+            c.option "force", "--force", "Force creation even if PATH already exists"
+            c.option "blank", "--blank", "Creates scaffolding but with empty files"
+            c.option "skip-bundle", "--skip-bundle", "Skip 'bundle install'"
+
+            c.action do |args, options|
+              Jekyll::Commands::New.process(args, options)
+            end
+          end
+        end
+
+        def process(args, options = {})
+          raise ArgumentError, "You must specify a path." if args.empty?
+
+          new_blog_path = File.expand_path(args.join(" "), Dir.pwd)
+          FileUtils.mkdir_p new_blog_path
+          if preserve_source_location?(new_blog_path, options)
+            Jekyll.logger.error "Conflict:", "#{new_blog_path} exists and is not empty."
+            Jekyll.logger.abort_with "", "Ensure #{new_blog_path} is empty or else " \
+                      "try again with `--force` to proceed and overwrite any files."
+          end
+
+          if options["blank"]
+            create_blank_site new_blog_path
+          else
+            create_site new_blog_path
+          end
+
+          after_install(new_blog_path, options)
+        end
+
+        def blank_template
+          File.expand_path("../../blank_template", __dir__)
+        end
+
+        def create_blank_site(path)
+          FileUtils.cp_r blank_template + "/.", path
+          FileUtils.chmod_R "u+w", path
+
+          Dir.chdir(path) do
+            FileUtils.mkdir(%w(_data _drafts _includes _posts))
+          end
+        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
+          "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.markdown"
+        end
+
+        private
+
+        def gemfile_contents
+          <<~RUBY
+            source "https://rubygems.org"
+            # Hello! This is where you manage which Jekyll version is used to run.
+            # When you want to use a different version, change it below, save the
+            # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+            #
+            #     bundle exec jekyll serve
+            #
+            # This will help ensure the proper Jekyll version is running.
+            # Happy Jekylling!
+            gem "jekyll", "~> #{Jekyll::VERSION}"
+            # This is the default theme for new Jekyll sites. You may change this to anything you like.
+            gem "minima", "~> 2.5"
+            # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+            # uncomment the line below. To upgrade, run `bundle update github-pages`.
+            # gem "github-pages", group: :jekyll_plugins
+            # If you have any plugins, put them here!
+            group :jekyll_plugins do
+              gem "jekyll-feed", "~> 0.12"
+            end
+
+            # Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+            # and associated library.
+            platforms :mingw, :x64_mingw, :mswin, :jruby do
+              gem "tzinfo", "~> 1.2"
+              gem "tzinfo-data"
+            end
+
+            # Performance-booster for watching directories on Windows
+            gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+          RUBY
+        end
+
+        def create_site(new_blog_path)
+          create_sample_files new_blog_path
+
+          File.open(File.expand_path(initialized_post_name, new_blog_path), "w") do |f|
+            f.write(scaffold_post_content)
+          end
+
+          File.open(File.expand_path("Gemfile", new_blog_path), "w") do |f|
+            f.write(gemfile_contents)
+          end
+        end
+
+        def preserve_source_location?(path, options)
+          !options["force"] && !Dir["#{path}/**/*"].empty?
+        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
+
+        def site_template
+          File.expand_path("../../site_template", __dir__)
+        end
+
+        def scaffold_path
+          "_posts/0000-00-00-welcome-to-jekyll.markdown.erb"
+        end
+
+        # After a new blog has been created, print a success notification and
+        # then automatically execute bundle install from within the new blog dir
+        # unless the user opts to generate a blank blog or skip 'bundle install'.
+
+        def after_install(path, options = {})
+          unless options["blank"] || options["skip-bundle"]
+            begin
+              require "bundler"
+              bundle_install path
+            rescue LoadError
+              Jekyll.logger.info "Could not load Bundler. Bundle install skipped."
+            end
+          end
+
+          Jekyll.logger.info "New jekyll site installed in #{path.cyan}."
+          Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"]
+        end
+
+        def bundle_install(path)
+          Jekyll.logger.info "Running bundle install in #{path.cyan}..."
+          Dir.chdir(path) do
+            exe = Gem.bin_path("bundler", "bundle")
+            process, output = Jekyll::Utils::Exec.run("ruby", exe, "install")
+
+            output.to_s.each_line do |line|
+              Jekyll.logger.info("Bundler:".green, line.strip) unless line.to_s.empty?
+            end
+
+            raise SystemExit unless process.success?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/new_theme.rb

@@ -1,42 +1,40 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Jekyll
-  module Commands
-    class NewTheme < Jekyll::Command
-      class << self
-        def init_with_program(prog)
-          prog.command(:"new-theme") do |c|
-            c.syntax "new-theme NAME"
-            c.description "Creates a new Jekyll theme scaffold"
-            c.option "code_of_conduct", \
-                     "-c", "--code-of-conduct", \
-                     "Include a Code of Conduct. (defaults to false)"
-
-            c.action do |args, opts|
-              Jekyll::Commands::NewTheme.process(args, opts)
-            end
-          end
-        end
-
-        # rubocop:disable Metrics/AbcSize
-        def process(args, opts)
-          if !args || args.empty?
-            raise Jekyll::Errors::InvalidThemeName, "You must specify a theme name."
-          end
-
-          new_theme_name = args.join("_")
-          theme = Jekyll::ThemeBuilder.new(new_theme_name, opts)
-          Jekyll.logger.abort_with "Conflict:", "#{theme.path} already exists." if theme.path.exist?
-
-          theme.create!
-          Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}," \
-                             " is ready for you in #{theme.path.to_s.cyan}!"
-          Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
-        end
-        # rubocop:enable Metrics/AbcSize
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "erb"
+
+module Jekyll
+  module Commands
+    class NewTheme < Jekyll::Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:"new-theme") do |c|
+            c.syntax "new-theme NAME"
+            c.description "Creates a new Jekyll theme scaffold"
+            c.option "code_of_conduct", \
+                     "-c", "--code-of-conduct", \
+                     "Include a Code of Conduct. (defaults to false)"
+
+            c.action do |args, opts|
+              Jekyll::Commands::NewTheme.process(args, opts)
+            end
+          end
+        end
+
+        def process(args, opts)
+          if !args || args.empty?
+            raise Jekyll::Errors::InvalidThemeName, "You must specify a theme name."
+          end
+
+          new_theme_name = args.join("_")
+          theme = Jekyll::ThemeBuilder.new(new_theme_name, opts)
+          Jekyll.logger.abort_with "Conflict:", "#{theme.path} already exists." if theme.path.exist?
+
+          theme.create!
+          Jekyll.logger.info "Your new Jekyll theme, #{theme.name.cyan}," \
+                             " is ready for you in #{theme.path.to_s.cyan}!"
+          Jekyll.logger.info "For help getting started, read #{theme.path}/README.md."
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/serve/live_reload_reactor.rb

@@ -1,122 +1,122 @@
-# frozen_string_literal: true
-
-require "em-websocket"
-
-require_relative "websockets"
-
-module Jekyll
-  module Commands
-    class Serve
-      class LiveReloadReactor
-        attr_reader :started_event
-        attr_reader :stopped_event
-        attr_reader :thread
-
-        def initialize
-          @websockets = []
-          @connections_count = 0
-          @started_event = Utils::ThreadEvent.new
-          @stopped_event = Utils::ThreadEvent.new
-        end
-
-        def stop
-          # There is only one EventMachine instance per Ruby process so stopping
-          # it here will stop the reactor thread we have running.
-          EM.stop if EM.reactor_running?
-          Jekyll.logger.debug "LiveReload Server:", "halted"
-        end
-
-        def running?
-          EM.reactor_running?
-        end
-
-        def handle_websockets_event(websocket)
-          websocket.onopen { |handshake| connect(websocket, handshake) }
-          websocket.onclose { disconnect(websocket) }
-          websocket.onmessage { |msg| print_message(msg) }
-          websocket.onerror { |error| log_error(error) }
-        end
-
-        def start(opts)
-          @thread = Thread.new do
-            # Use epoll if the kernel supports it
-            EM.epoll
-            EM.run do
-              EM.error_handler { |e| log_error(e) }
-
-              EM.start_server(
-                opts["host"],
-                opts["livereload_port"],
-                HttpAwareConnection,
-                opts
-              ) do |ws|
-                handle_websockets_event(ws)
-              end
-
-              # Notify blocked threads that EventMachine has started or shutdown
-              EM.schedule { @started_event.set }
-              EM.add_shutdown_hook { @stopped_event.set }
-
-              Jekyll.logger.info "LiveReload address:",
-                                 "http://#{opts["host"]}:#{opts["livereload_port"]}"
-            end
-          end
-          @thread.abort_on_exception = true
-        end
-
-        # For a description of the protocol see
-        # http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
-        def reload(pages)
-          pages.each do |p|
-            json_message = JSON.dump(
-              :command => "reload",
-              :path    => p.url,
-              :liveCSS => true
-            )
-
-            Jekyll.logger.debug "LiveReload:", "Reloading #{p.url}"
-            Jekyll.logger.debug "", json_message
-            @websockets.each { |ws| ws.send(json_message) }
-          end
-        end
-
-        private
-
-        def connect(websocket, handshake)
-          @connections_count += 1
-          if @connections_count == 1
-            message = "Browser connected"
-            message += " over SSL/TLS" if handshake.secure?
-            Jekyll.logger.info "LiveReload:", message
-          end
-          websocket.send(
-            JSON.dump(
-              :command    => "hello",
-              :protocols  => ["http://livereload.com/protocols/official-7"],
-              :serverName => "jekyll"
-            )
-          )
-
-          @websockets << websocket
-        end
-
-        def disconnect(websocket)
-          @websockets.delete(websocket)
-        end
-
-        def print_message(json_message)
-          msg = JSON.parse(json_message)
-          # Not sure what the 'url' command even does in LiveReload.  The spec is silent
-          # on its purpose.
-          Jekyll.logger.info "LiveReload:", "Browser URL: #{msg["url"]}" if msg["command"] == "url"
-        end
-
-        def log_error(error)
-          Jekyll.logger.error "LiveReload experienced an error. " \
-            "Run with --trace for more information."
-          raise error
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require "em-websocket"
+
+require_relative "websockets"
+
+module Jekyll
+  module Commands
+    class Serve
+      class LiveReloadReactor
+        attr_reader :started_event
+        attr_reader :stopped_event
+        attr_reader :thread
+
+        def initialize
+          @websockets = []
+          @connections_count = 0
+          @started_event = Utils::ThreadEvent.new
+          @stopped_event = Utils::ThreadEvent.new
+        end
+
+        def stop
+          # There is only one EventMachine instance per Ruby process so stopping
+          # it here will stop the reactor thread we have running.
+          EM.stop if EM.reactor_running?
+          Jekyll.logger.debug "LiveReload Server:", "halted"
+        end
+
+        def running?
+          EM.reactor_running?
+        end
+
+        def handle_websockets_event(websocket)
+          websocket.onopen { |handshake| connect(websocket, handshake) }
+          websocket.onclose { disconnect(websocket) }
+          websocket.onmessage { |msg| print_message(msg) }
+          websocket.onerror { |error| log_error(error) }
+        end
+
+        def start(opts)
+          @thread = Thread.new do
+            # Use epoll if the kernel supports it
+            EM.epoll
+            EM.run do
+              EM.error_handler { |e| log_error(e) }
+
+              EM.start_server(
+                opts["host"],
+                opts["livereload_port"],
+                HttpAwareConnection,
+                opts
+              ) do |ws|
+                handle_websockets_event(ws)
+              end
+
+              # Notify blocked threads that EventMachine has started or shutdown
+              EM.schedule { @started_event.set }
+              EM.add_shutdown_hook { @stopped_event.set }
+
+              Jekyll.logger.info "LiveReload address:",
+                                 "http://#{opts["host"]}:#{opts["livereload_port"]}"
+            end
+          end
+          @thread.abort_on_exception = true
+        end
+
+        # For a description of the protocol see
+        # http://feedback.livereload.com/knowledgebase/articles/86174-livereload-protocol
+        def reload(pages)
+          pages.each do |p|
+            json_message = JSON.dump(
+              :command => "reload",
+              :path    => p.url,
+              :liveCSS => true
+            )
+
+            Jekyll.logger.debug "LiveReload:", "Reloading #{p.url}"
+            Jekyll.logger.debug "", json_message
+            @websockets.each { |ws| ws.send(json_message) }
+          end
+        end
+
+        private
+
+        def connect(websocket, handshake)
+          @connections_count += 1
+          if @connections_count == 1
+            message = "Browser connected"
+            message += " over SSL/TLS" if handshake.secure?
+            Jekyll.logger.info "LiveReload:", message
+          end
+          websocket.send(
+            JSON.dump(
+              :command    => "hello",
+              :protocols  => ["http://livereload.com/protocols/official-7"],
+              :serverName => "jekyll"
+            )
+          )
+
+          @websockets << websocket
+        end
+
+        def disconnect(websocket)
+          @websockets.delete(websocket)
+        end
+
+        def print_message(json_message)
+          msg = JSON.parse(json_message)
+          # Not sure what the 'url' command even does in LiveReload.  The spec is silent
+          # on its purpose.
+          Jekyll.logger.info "LiveReload:", "Browser URL: #{msg["url"]}" if msg["command"] == "url"
+        end
+
+        def log_error(error)
+          Jekyll.logger.error "LiveReload experienced an error. " \
+            "Run with --trace for more information."
+          raise error
+        end
+      end
+    end
+  end
+end