jekyll-plus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d61d7047840f274b66bfbae1c9e987cb304ba6fb
+  data.tar.gz: c9bf197e497d800e3515a9d591e898cae0bf7b0f
+SHA512:
+  metadata.gz: ee0170d39c872f61bcd51b7bc4b3b835d595aec9fa90b2fcc54bd02f7f57421a4f851b1725cdc9021b8bf80d037289879c1cef406c80454511b158579cdc497c
+  data.tar.gz: 15a4d19d35f2c921c33953ce77aee115515d76d6a44c2bf805de38fadc41f541705b393594a6bd56840c880a4afbabe275fe0c763c2c5025faf92c9e38e3d6b1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ashwin Maroli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Jekyll-Plus
+
+[![Gem Version](https://img.shields.io/gem/v/jekyll-plus.svg)](https://rubygems.org/gems/jekyll-plus)
+[![Build Status](https://img.shields.io/travis/ashmaroli/jekyll-plus/master.svg?label=Build%20Status)][travis]
+
+[travis]: https://travis-ci.org/ashmaroli/jekyll-plus
+
+A ruby gem that modifies `jekyll new` command to add new switches: `--plus`, `--classic`, `--verbose`.
+
+## Installation
+
+Simply run:
+
+    $ gem install jekyll-plus
+
+Currently, to use this gem as intended, Jekyll's native `~/commands/new.rb` file requires to be slightly modified as shown below:
+```diff
+# lib/jekyll/commands/new.rb
+
+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.option "plus", "--plus", "Plus features"
++   c.option "classic", "--classic", "Classic Jekyll scaffolding"
++   c.option "verbose", "--verbose", "Output messages while creating"
+
+    c.action do |args, options|
++     if options["plus"] || options["classic"] || options["verbose"]
++       External.require_with_graceful_fail "jekyll-plus"
++     end
+      Jekyll::Commands::New.process(args, options)
+    end
+  end
+end
+```
+## Usage
+
+This gem provides three new switches to be used along with the `jekyll new` command.
+
+### `--plus`
+
+This switch creates a new Jekyll site using ERB templates for `_config.yml` and `Gemfile` and additionally initializes the directory as a git repository.  
+The config file in such sites will be **pre-populated** with information from the argument(s) passed to `jekyll new` and from the user's `.gitconfig` file. If the git-user-details have not been configured, placeholder text will be used instead.
+
+**Note:** `site.title` will be set with `capitalized` version of the project's directory-name.  
+This switch has no effect when used alongside the `--blank` switch.
+
+### `--classic`
+
+This switch creates a classic-style (pre-Jekyll-3.2) Jekyll site by including the `_layouts`, `_includes`, `_sass` at the root. The directory structure has been altered to be in sync with Jekyll v3.3 and hence you'll have a `Gemfile`, `css/main.scss` is now `assets/main.scss`, etc.
+
+A *Classic Site* will:
+  - have `Gemfile` and `_config.yml` with the line containing `minima` commented out.
+  - have `_layouts`, `_includes`, `_sass` and `assets` at root.
+  - the contents of these directories, in sync (to be manually updated with patch releases) with the latest `master` branch from Minima Repo.
+  - ***not*** have `site.email` and `site.author` pre-filled with info from user's `.gitconfig` or `site.title` pre-configured from the argument(s) passed.
+  - ***not*** run `bundle install` automatically.
+
+**Note:** `--classic` dominates `--plus` and will create a *Classic Site* when the two switches are used together.
+
+### `--verbose`
+
+This switch prints out messages as the new Jekyll site is being created. Can be used with `--blank`, `--plus` and `--classic`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ashmaroli/jekyll-plus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/jekyll-plus.rb

@@ -0,0 +1,2 @@
+require "jekyll-plus/version"
+require_relative "jekyll/commands/new"

data/lib/jekyll-plus/version.rb

@@ -0,0 +1,3 @@
+module JekyllPlus
+  VERSION = "0.1.0".freeze
+end

data/lib/jekyll/commands/new.rb

@@ -0,0 +1,190 @@
+require "erb"
+
+module Jekyll
+  class Commands::New < Command
+    class << self
+      def init_with_program(prog)
+      end
+
+      def process(args, options = {})
+        @verbose = options["verbose"]
+
+        raise ArgumentError, "You must specify a path." if args.empty?
+
+        # 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
+        blog_title = extract_title args
+        blog_path = File.expand_path(args.join(" "), Dir.pwd)
+        FileUtils.mkdir_p blog_path
+
+        if preserve_source_location?(blog_path, options)
+          Jekyll.logger.abort_with "Conflict:",
+                    "#{blog_path} exists and is not empty."
+        end
+
+        create_site blog_title, blog_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(args)
+        a = args.join(" ").tr("\\", "/").split("/").last
+        a.split.map(&:capitalize).join(" ")
+      end
+
+      def initialized_post_name
+        "_posts/#{Time.now.strftime("%Y-%m-%d")}-welcome-to-jekyll.md"
+      end
+
+      def initialize_git(path)
+        Jekyll.logger.info "Initialising:", File.join(path, ".git") if @verbose
+        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 preserve_source_location?(path, options)
+        !options["force"] && !Dir["#{path}/**/*"].empty?
+      end
+
+      def create_site(title, path, options)
+        if options["blank"] && options["verbose"]
+          create_blank_site path
+        else
+          create_sample_files path
+          add_supporting_files title, path, options
+        end
+        after_install title, path, options
+      end
+
+      def create_blank_site(path)
+        Dir.chdir(path) do
+          FileUtils.mkdir(%w(_layouts _posts _drafts))
+          FileUtils.touch("index.html")
+        end
+      end
+
+      def create_sample_files(path)
+        Jekyll.logger.info "" if @verbose
+        initialize_git path
+        FileUtils.mkdir_p(File.expand_path("_posts", path))
+        source = site_template
+
+        static_files = %w(index.md about.md .gitignore)
+        static_files.each do |file|
+          write_file(file, template(file, source), path)
+        end
+        write_file(initialized_post_name, template(scaffold_path, source), path)
+      end
+
+      # adds Gemfile and _config.yml
+      # additionally creates (updated) SCAFFOLD DIRECTORIES of a Jekyll Theme at
+      # blog_path when the `--classic` switch is used.
+      def add_supporting_files(title, path, options)
+        if options["classic"]
+          source = classic_template
+          Jekyll.logger.info "Creating:", "Classic directories and files" if @verbose
+          FileUtils.cp_r "#{classic_directories}/.", path
+        else
+          source = site_template
+        end
+        create_config_file title, path, source
+        write_file("Gemfile", template("Gemfile.erb", source), path)
+        Jekyll.logger.info "" if @verbose
+      end
+
+      # create _config.yml pre-populated with blog-title, and author's name & email
+      # using information from the user's .gitconfig
+      def create_config_file(title, path, source)
+        @blog_title = title
+        @user_name = user_name
+        @user_email = user_email
+        config_template = File.expand_path("_config.yml.erb", source)
+        config_copy = ERB.new(File.read(config_template)).result(binding)
+
+        Jekyll.logger.info "Creating:", File.join(path, "_config.yml") if @verbose
+        File.open(File.expand_path("_config.yml", path), "w") do |f|
+          f.write(config_copy)
+        end
+      end
+
+      def write_file(filename, contents, path)
+        full_path = File.expand_path(filename, path)
+        Jekyll.logger.info "Creating:", full_path if @verbose
+        File.write(full_path, contents)
+      end
+
+      def template(filename, source)
+        erb ||= ThemeBuilder::ERBRenderer.new(self)
+        erb.render(File.read(File.expand_path(filename, source)))
+      end
+
+      def site_template
+        File.expand_path("../templates/site_template", File.dirname(__FILE__))
+      end
+
+      def classic_template
+        File.expand_path("../templates/classic_template", File.dirname(__FILE__))
+      end
+
+      def classic_directories
+        File.join(classic_template, "theme_folders")
+      end
+
+      def scaffold_path
+        "_posts/0000-00-00-welcome-to-jekyll.md.erb"
+      end
+
+      # After a new blog has been installed, print a success notification and then
+      # automatically execute bundle install from within the new blog dir unless
+      # the user opts to generate a classic Jekyll blog or a blank blog or skip
+      # 'bundle install' using the `--skip-bundle` switch
+      def after_install(title, path, options)
+        if options["classic"]
+          Jekyll.logger.info "New classic jekyll site installed in #{path.cyan}."
+        elsif options["blank"]
+          Jekyll.logger.info "New blank jekyll site installed in #{path.cyan}."
+        else
+          Jekyll.logger.info "New jekyll site #{title.cyan} installed in #{path.cyan}."
+        end
+
+        Jekyll.logger.info "Bundle install skipped." if options["skip-bundle"]
+        unless options["classic"] || options["blank"] || options["skip-bundle"]
+          bundle_install path
+        end
+      end
+
+      def bundle_install(path)
+        Jekyll::External.require_with_graceful_fail "bundler"
+        Jekyll.logger.info "Running bundle install in #{path.cyan}..."
+        Dir.chdir(path) do
+          if ENV["CI"]
+            system("bundle", "install", "--quiet")
+          else
+            system("bundle", "install")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/templates/classic_template/Gemfile.erb

@@ -0,0 +1,26 @@
+source "https://rubygems.org"
+ruby "<%= RUBY_VERSION %>"
+
+# 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 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"
+
+# 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.6"
+end

data/lib/jekyll/templates/classic_template/_config.yml.erb

@@ -0,0 +1,37 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole blog, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+title: your awesome title
+email: your-email@domain.com
+# the ">" below means to ignore newlines until "baseurl:"
+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.
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: jekyllrb
+github_username:  jekyll
+
+# Build settings
+markdown: kramdown
+# uncomment (and edit) the line below when using a theme
+# theme: minima
+gems:
+  - jekyll-feed
+exclude:
+  - Gemfile
+  - Gemfile.lock

data/lib/jekyll/templates/classic_template/theme_folders/_includes/disqus_comments.html

@@ -0,0 +1,20 @@
+{% if page.comments != false and jekyll.environment == "production" %}
+
+  <div id="disqus_thread"></div>
+  <script>
+    var disqus_config = function () {
+      this.page.url = '{{ page.url | absolute_url }}';
+      this.page.identifier = '{{ page.url | absolute_url }}';
+    };
+
+    (function() {
+      var d = document, s = d.createElement('script');
+
+      s.src = 'https://{{ site.disqus.shortname }}.disqus.com/embed.js';
+
+      s.setAttribute('data-timestamp', +new Date());
+      (d.head || d.body).appendChild(s);
+    })();
+  </script>
+  <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a></noscript>
+{% endif %}

data/lib/jekyll/templates/classic_template/theme_folders/_includes/footer.html

@@ -0,0 +1,46 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+    <h2 class="footer-heading">{{ site.title | escape }}</h2>
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col footer-col-1">
+        <ul class="contact-list">
+          <li>
+            {% if site.author %}
+              {{ site.author | escape }}
+            {% else %}
+              {{ site.title | escape }}
+            {% endif %}
+            </li>
+            {% if site.email %}
+            <li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+            {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-2">
+        <ul class="social-media-list">
+          {% if site.github_username %}
+          <li>
+            {% include icon-github.html username=site.github_username %}
+          </li>
+          {% endif %}
+
+          {% if site.twitter_username %}
+          <li>
+            {% include icon-twitter.html username=site.twitter_username %}
+          </li>
+          {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-3">
+        <p>{{ site.description | escape }}</p>
+      </div>
+    </div>
+
+  </div>
+
+</footer>

data/lib/jekyll/templates/classic_template/theme_folders/_includes/google-analytics.html

@@ -0,0 +1,11 @@
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '{{ site.google_analytics }}', 'auto');
+  ga('send', 'pageview');
+
+</script>
+