jekyll-plus 0.1.0 → 0.2.0

data/lib/jekyll/commands/new_site.rb

@@ -0,0 +1,260 @@
+require "erb"
+
+module Jekyll
+  class Commands::NewSite < Command
+    class << self
+      def init_with_program(prog)
+        prog.command(:"new-site") do |c|
+          c.syntax      "new-site PATH"
+          c.description "Creates a custom Jekyll site scaffold in PATH"
+
+          c.option "classic", "--classic", "Classic Jekyll scaffolding"
+          c.option "theme", "--theme GEM-NAME", "Scaffold with a custom gem-based theme"
+          c.option "force", "--force", "Force creation even if PATH already exists"
+          c.option "verbose", "--verbose", "Output messages while creating"
+
+          c.action do |args, options|
+            raise ArgumentError, "You must specify a path." if args.empty?
+            process(args, options)
+          end
+        end
+      end
+
+      def process(args, options = {})
+        site_path = File.expand_path(args.join(" "), Dir.pwd)
+        FileUtils.mkdir_p site_path
+        if existing_source_location?(site_path, options)
+          Jekyll.logger.abort_with "Conflict:", "#{site_path} exists and is not empty."
+        end
+
+        initialize_git site_path if git_installed?
+        create_variables_from(args, options)
+
+        create_site site_path, options
+      end
+
+      #
+      # private methods
+      #
+
+      private
+
+      # join the arguments given, with a whitespace; replace backslashes, if any
+      # with a forward slash; split the string into an array again and select the
+      # last entry.
+      # Further split the entry along a single whitespace, and map to a new array
+      # after capitalizing the split-entries. Join them again with a whitespace
+      # to form the final title string.
+      def extract_title_from(args)
+        a = args.join(" ").tr("\\", "/").split("/").last
+        a.split.map(&:capitalize).join(" ")
+      end
+
+      def create_variables_from(args, options)
+        @verbose = options["verbose"]
+
+        @theme = options["theme"] ? options["theme"] : "minima"
+        @name  = user_name
+        @email = user_email
+
+        # extract capitalized blog title from the argument(s) when a 'path'
+        # to the new site has been provided.
+        #   e.g.  jekyll new work/blogs/exploring ruby would install a blog
+        #   titled 'Exploring Ruby' at path ~/work/blogs/exploring ruby
+        @title   = extract_title_from(args)
+      end
+
+      def create_site(path, options)
+        add_foundation_files path
+        create_scaffold_at path
+
+        if options["classic"]
+          bundle_unless_theme_installed path
+          extract_templates_and_config path
+        elsif options["theme"]
+          bundle_unless_theme_installed path
+          extract_theme_config path
+        end
+
+        success_message path, options
+      end
+
+      def add_foundation_files(path)
+        print_header "Creating:", "Foundation files"
+        process_template_for "Gemfile", site_template, path
+        process_template_for "_config.yml", site_template, path
+        verbose_print ""
+      end
+
+      def create_scaffold_at(path)
+        print_header "Creating:", "Scaffold files"
+        FileUtils.mkdir_p(File.expand_path("_posts", path))
+
+        pages = %w(index.html about.md)
+        pages << ".gitignore"
+        pages.each do |page|
+          write_file(page, erb_render("#{page}.erb", site_template), path)
+        end
+        write_file(welcome_post, erb_render(scaffold_path, site_template), path)
+        verbose_print ""
+      end
+
+      def extract_templates_and_config(path)
+        print_header(
+          "Extracting:",
+          "Templates and _config.yml from #{@theme.cyan} if available..",
+          "="
+        )
+        package = %w(_layouts _includes _sass _data assets _config.yml)
+        package << extraction_opts
+
+        Dir.chdir(path) do
+          bundle_extract package
+        end
+      end
+
+      def extract_theme_config(path)
+        print_header(
+          "Extracting:",
+          "_config.yml from theme-gem if available..",
+          "="
+        )
+        package = %w(_config.yml)
+        package << extraction_opts
+
+        Dir.chdir(path) do
+          bundle_extract package
+        end
+      end
+
+      def bundle_extract(package)
+        system("bundle", "exec", "jekyll+ extract #{package.join(" ")}")
+      end
+
+      def extraction_opts
+        @verbose ? "--force --lax --verbose" : "--force --lax --quiet"
+      end
+
+      def success_message(path, options)
+        print_info ""
+        if options["classic"]
+          print_info "A classic-style jekyll site installed in #{path.cyan}."
+
+        elsif options["theme"]
+          print_info "New #{@theme.cyan} themed jekyll site installed in #{path.cyan}."
+
+        else
+          print_info "New jekyll site #{@title.cyan} installed in #{path.cyan}."
+        end
+      end
+
+      def bundle_unless_theme_installed(path)
+        print_info "Checking:", "Local theme installation..."
+        Gem::Specification.find_by_name(@theme)
+        theme_installed_msg
+        print_info ""
+      rescue Gem::LoadError
+        Jekyll.logger.error "Jekyll+:", "Theme #{@theme.inspect} could not be found."
+        bundle_install path
+        print_info ""
+      end
+
+      def bundle_install(path)
+        print_info "Jekyll+:", "Running bundle install in #{path.cyan}..."
+        Dir.chdir(path) do
+          process, output = Utils::Exec.run("bundle", "install")
+          report = output.to_s.each_line.map(&:strip)
+          print_info "Bundler:", report.first
+          report[1..-1].each { |line| print_info "", line }
+          raise SystemExit unless process.success?
+        end
+      end
+
+      def theme_installed_msg
+        print_info "", "#{@theme.inspect} local installation found." \
+                       " Bundle install skipped".green
+      end
+
+      #
+
+      def process_template_for(file, source, destination)
+        verbose_print "", File.join(destination, file)
+        File.open(File.join(destination, file), "w") do |f|
+          f.write(
+            erb_render("#{file}.erb", source)
+          )
+        end
+      end
+
+      def write_file(filename, contents, path)
+        full_path = File.expand_path(filename, path)
+        verbose_print "", full_path
+        File.write(full_path, contents)
+      end
+
+      def erb_render(filename, source)
+        ERB.new(
+          File.read(File.expand_path(filename, source)), 0, "<>"
+        ).result(binding)
+      end
+
+      def welcome_post
+        "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.md"
+      end
+
+      def site_template
+        File.expand_path("../site_template", File.dirname(__FILE__))
+      end
+
+      def scaffold_path
+        "_posts/0000-00-00-welcome-to-jekyll.md.erb"
+      end
+
+      #
+
+      def existing_source_location?(path, options)
+        !options["force"] && !Dir["#{path}/**/*"].empty?
+      end
+
+      #
+
+      def git_installed?
+        process, _output = Utils::Exec.run("git", "--version")
+        process.success?
+      end
+
+      def initialize_git(path)
+        verbose_print "Initialising:", File.join(path, ".git")
+        Dir.chdir(path) { `git init` }
+      end
+
+      def user_name
+        name ||= `git config user.name`.chomp
+        name.empty? ? "Github User" : name
+      end
+
+      def user_email
+        email ||= `git config user.email`.chomp
+        email.empty? ? "your-email@domain.com" : email
+      end
+
+      #
+
+      def print_info(topic, message = "")
+        Jekyll.logger.info topic, message
+      end
+
+      # only with --verbose switch
+      def verbose_print(topic, message = "")
+        if @verbose
+          Jekyll.logger.info topic, message
+        end
+      end
+
+      def print_header(topic, message, style = "-")
+        print_info topic, message
+        verbose_print "", style * message.length
+      end
+    end
+  end
+end

data/lib/jekyll/{templates/classic_template → site_template}/Gemfile.erb

@@ -11,10 +11,11 @@ ruby "<%= RUBY_VERSION %>"
 # Happy Jekylling!
 gem "jekyll", "~> <%= Jekyll::VERSION %>"
 
-# This is the default theme for new Jekyll sites. You may uncomment the line
-# below and change to any other theme-gem. Don't forget to run `bundle install`
-# again after you change the setting.
-# gem "minima"
+# The theme-gem for your site.
+gem <%= @theme.inspect %><% if @theme == "minima" %>, "~> 2.0"
+<% elsif @theme == "test-theme" %>, path: File.expand_path("../../../test/fixtures/test-theme", File.dirname(__FILE__))
+<% end %>
+
 
 # If you want to use GitHub Pages, remove the "gem "jekyll"" above and
 # uncomment the line below. To upgrade, run `bundle update github-pages`.
@@ -22,5 +23,8 @@ gem "jekyll", "~> <%= Jekyll::VERSION %>"
 
 # If you have any plugins, put them here!
 group :jekyll_plugins do
-  gem "jekyll-feed", "~> 0.6"
+<% if @theme == "minima" %>
+  gem "jekyll-feed", "~> 0.8"
+<% end %>
+  gem "jekyll-plus" # Required to use the jekyll+ executable to build / serve your site
 end

data/lib/jekyll/{templates/site_template → site_template}/_config.yml.erb

@@ -14,11 +14,11 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: <%= @blog_title %>
-author: <%= @user_name %>
-email: <%= @user_email %>
+title: <%= @title %>
+name: <%= @name %>
+email: <%= @email %>
 # the ">" below means to ignore newlines until "baseurl:"
-description: >
+description: > #
   Write an awesome description for your new site here. You can edit this
   line in _config.yml. It will appear in your document head meta (for
   Google search results) and in your feed.xml site description.
@@ -29,9 +29,19 @@ github_username:  jekyll
 
 # Build settings
 markdown: kramdown
-theme: minima
+theme: <%= @theme %>
+<% if @theme == "minima" %>
 gems:
   - jekyll-feed
+<% end %>
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
 exclude:
   - Gemfile
   - Gemfile.lock
+  - node_modules
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/

data/lib/jekyll/{templates/site_template → site_template}/_posts/0000-00-00-welcome-to-jekyll.md.erb

@@ -1,5 +1,7 @@
 ---
+<% if @theme == "minima" %>
 layout: post
+<% end %>
 title:  "Welcome to Jekyll!"
 date:   <%= Time.now.strftime('%Y-%m-%d %H:%M:%S %z') %>
 categories: jekyll update

data/lib/jekyll/{templates/site_template/about.md → site_template/about.md.erb}

@@ -1,11 +1,14 @@
 ---
+<% if @theme == "minima" %>
 layout: page
+<% end %>
 title: About
 permalink: /about/
 ---
 
 This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](http://jekyllrb.com/)
 
+<% if @theme == "minima" %>
 You can find the source code for the Jekyll new theme at:
 {% include icon-github.html username="jekyll" %} /
 [minima](https://github.com/jekyll/minima)
@@ -13,3 +16,4 @@ You can find the source code for the Jekyll new theme at:
 You can find the source code for Jekyll at
 {% include icon-github.html username="jekyll" %} /
 [jekyll](https://github.com/jekyll/jekyll)
+<% end %>

data/lib/jekyll/{templates/site_template/index.md → site_template/index.html.erb}

@@ -2,5 +2,6 @@
 # You don't need to edit this file, it's empty on purpose.
 # Edit theme's home layout instead if you wanna make some changes
 # See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+
 layout: home
 ---

data/lib/patches/idempotent_jekyll_config.rb

@@ -0,0 +1,41 @@
+module Jekyll
+  class Command
+    def self.configuration_from_options(options)
+      return options if options.is_a?(Jekyll::Configuration)
+      Jekyll.configuration(options)
+    end
+  end
+
+  module Commands
+    class Serve < Command
+      class << self
+        def init_with_program(prog)
+          prog.command(:serve) do |cmd|
+            cmd.description "Serve your site locally"
+            cmd.syntax "serve [options]"
+            cmd.alias :server
+            cmd.alias :s
+
+            add_build_options(cmd)
+            COMMAND_OPTIONS.each do |key, val|
+              cmd.option key, *val
+            end
+
+            cmd.action do |_, opts|
+              opts["serving"] = true
+              opts["watch"  ] = true unless opts.key?("watch")
+
+              config = configuration_from_options(opts)
+              if Jekyll.env == "development"
+                config["url"] = default_url(config)
+              end
+
+              Build.process(config)
+              Serve.process(config)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/patches/jekyll_watcher.rb

@@ -0,0 +1,59 @@
+require "listen"
+
+module Jekyll
+  module Watcher
+    extend self
+
+    # Returns nothing.
+    def watch(options, site = nil)
+      ENV["LISTEN_GEM_DEBUGGING"] ||= "1" if options["verbose"]
+
+      site ||= Jekyll::Site.new(options)
+      listener = build_listener(site, options)
+      listener.start
+
+      Jekyll.logger.info "Auto-regeneration:", "#{"enabled".green} for #{options["source"]}"
+
+      unless options["serving"]
+        trap("INT") do
+          listener.stop
+          puts "     Halting auto-regeneration."
+          exit 0
+        end
+
+        sleep_forever
+      end
+    rescue ThreadError
+      # You pressed Ctrl-C, oh my!
+    end
+
+    def listen_handler(site)
+      proc do |modified, added, removed|
+        t = Time.now
+        c = modified + added + removed
+        n = c.length
+        Jekyll.logger.info("Regenerating:",
+          "#{n} file(s) changed at #{t.strftime("%Y-%m-%d %H:%M:%S")} ")
+        relative_paths = c.map { |p| site.in_source_dir(p) }
+        relative_paths.each { |file| Jekyll.logger.info "", file.cyan }
+        process site, t
+      end
+    end
+
+    private
+
+    def process(site, time)
+      site.process
+      Jekyll.logger.info "", "...done in #{Time.now - time} seconds.".green
+      print_clear_line
+    rescue => e
+      Jekyll.logger.warn "Error:", e.message
+      Jekyll.logger.warn "Error:", "Run jekyll build --trace for more information."
+      print_clear_line
+    end
+
+    def print_clear_line
+      Jekyll.logger.info ""
+    end
+  end
+end