jekyll-watch 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e8b19bc631168b0a288f5ed832a574a322e6b46
-  data.tar.gz: 33a7e14411be8f7ef8b3cfe89f3dd57677a83d44
+  metadata.gz: 5af48120c14729914c6d38399ba3555784b2f750
+  data.tar.gz: 90e8fa82eba51acc47c7407d1398fd12ff118506
 SHA512:
-  metadata.gz: 65669640a282e62c78c50929a6b531273d530613b13cc510c3c1f39febbccc18c3b34509f704d043675ede918e67e8ee73c432bf6cb86a888edd67ef42630d74
-  data.tar.gz: f6bd2e09034cc85e7bd69e0e744485d220c6e9c8d95b9eda38cd64b15c647d405af999bc5b2b378ab8f1f260f08067c2323593c777fa979f9104d74e6e0bca0a
+  metadata.gz: 4245c05ecf747b93fbc9fc86203d062f6f585a77d549807c29c2601fad7cc676a57507db5a7b90492be7ab4f88dab74d80f5b5f190cad36ec884e5f404ab25e2
+  data.tar.gz: 4a1196d1a352272c409fd213abec35b61391946c6085bafaffe1a1f85a9c0e38735776602e580d3694dcefa318d24d75e7c28cbe364283f3dcdeccc1e3579656

data/.gitignore

@@ -20,3 +20,7 @@ tmp
 *.o
 *.a
 mkmf.log
+vendor
+
+.sass-cache
+_site

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0
+- 2.1
+install:
+- travis_retry script/unbundle
+- travis_retry script/bootstrap
+script: script/cibuild
+notifications:
+  irc:
+    on_success: change
+    on_failure: change
+    channels:
+    - irc.freenode.org#jekyll
+    template:
+    - '%{repository}#%{build_number} %{message} %{build_url}'
+  email:
+    on_success: never
+    on_failure: change

data/History.markdown

@@ -0,0 +1,15 @@
+## 1.1.0 / 2014-08-10
+
+### Minor Enhancements
+
+  * Refactor the whole watching thing and compartmentalize it. (#5)
+  * Don't listen to things in the `exclude` configuration option. (#5)
+
+### Development Fixes
+
+  * Add github stuff and the beginnings of the test suite (#6)
+  * Flesh out the test suite (#7)
+
+## 1.0.0 / 2014-06-27
+
+  * Birthday!

data/README.md

@@ -2,6 +2,8 @@
 
 Rebuild your Jekyll site when a file changes with the `--watch` switch.
 
+[![Build Status](https://travis-ci.org/jekyll/jekyll-watch.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-watch)
+
 ## Installation
 
 **`jekyll-watch` comes pre-installed with Jekyll 2.1 or greater.**

data/jekyll-watch.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-watch"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.0"
   spec.authors       = ["Parker Moore"]
   spec.email         = ["parkrmoore@gmail.com"]
   spec.summary       = %q{Rebuild your Jekyll site when a file changes with the `--watch` switch.}
@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "jekyll", "~> 2.0"
 end

data/lib/jekyll-watch.rb

@@ -1 +1,2 @@
-require "jekyll/commands/watch"
+require_relative "jekyll/watcher"
+require_relative "jekyll/commands/watch"

data/lib/jekyll/commands/watch.rb

@@ -1,61 +1,28 @@
 module Jekyll
   module Commands
-    class Watch < Command
-      class << self
+    module Watch
+      extend self
 
-        def init_with_program(prog)
-          # noop
-        end
-
-        # Build your jekyll site
-        # Continuously watch if `watch` is set to true in the config.
-        def process(options)
-          Jekyll.logger.log_level = :error if options['quiet']
-          watch(site, options) if options['watch']
-        end
-
-        # Watch for file changes and rebuild the site.
-        #
-        # site - A Jekyll::Site instance
-        # options - A Hash of options passed to the command
-        #
-        # Returns nothing.
-        def watch(site, options)
-          require 'listen'
-
-          listener = Listen.to(
-            options['source'],
-            :ignore => ignore_paths(options),
-            :force_polling => options['force_polling']
-          ) do |modified, added, removed|
-            t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
-            n = modified.length + added.length + removed.length
-            print Jekyll.logger.formatted_topic("Regenerating:") + "#{n} files at #{t} "
-            begin
-              process_site(site)
-              puts  "...done."
-            rescue => e
-              puts "...error:"
-              Jekyll.logger.warn "Error:", e.message
-              Jekyll.logger.warn "Error:", "Run jekyll build --trace for more information."
-            end
-          end
-          listener.start
-
-          Jekyll.logger.info "Auto-regeneration:", "enabled for '#{options['source']}'"
-
-          unless options['serving']
-            trap("INT") do
-              listener.stop
-              puts "     Halting auto-regeneration."
-              exit 0
-            end
+      def init_with_program(prog)
+      end
 
-            loop { sleep 1000 }
-          end
-        end
+      # Build your jekyll site
+      # Continuously watch if `watch` is set to true in the config.
+      def process(options)
+        Jekyll.logger.log_level = :error if options['quiet']
+        watch(site, options) if options['watch']
+      end
 
+      # Watch for file changes and rebuild the site.
+      #
+      # site - A Jekyll::Site instance
+      # options - A Hash of options passed to the command
+      #
+      # Returns nothing.
+      def watch(site, options)
+        Jekyll::Watcher.watch(options)
       end
+
     end
   end
 end

data/lib/jekyll/watcher.rb

@@ -0,0 +1,83 @@
+module Jekyll
+  module Watcher
+    extend self
+
+    def watch(options)
+      listener = build_listener(options)
+      listener.start
+
+      Jekyll.logger.info "Auto-regeneration:", "enabled for '#{options['source']}'"
+
+      unless options['serving']
+        trap("INT") do
+          listener.stop
+          puts "     Halting auto-regeneration."
+          exit 0
+        end
+
+        loop { sleep 1000 }
+      end
+    rescue ThreadError => e
+      # You pressed Ctrl-C, oh my!
+    end
+
+    def build_listener(options)
+      require 'listen'
+      Listen.to(
+        options['source'],
+        :ignore => listen_ignore_paths(options),
+        :force_polling => options['force_polling'],
+        &(listen_handler(options))
+      )
+    end
+
+    def listen_handler(options)
+      proc { |modified, added, removed|
+        t = Time.now.strftime("%Y-%m-%d %H:%M:%S")
+        c = modified + added + removed
+        n = c.length
+        print Jekyll.logger.message("Regenerating:", "#{n} files at #{t} ")
+        begin
+          Jekyll::Command.process_site(Jekyll::Site.new(options))
+          puts  "...done."
+        rescue => e
+          puts "...error:"
+          Jekyll.logger.warn "Error:", e.message
+          Jekyll.logger.warn "Error:", "Run jekyll build --trace for more information."
+        end
+      }
+    end
+
+    # Paths to ignore for the watch option
+    #
+    # options - A Hash of options passed to the command
+    #
+    # Returns a list of relative paths from source that should be ignored
+    def listen_ignore_paths(options)
+      source       = options['source']
+      destination  = options['destination']
+      config_files = Jekyll.sanitized_path(source, "_config.yml")
+      paths = (
+        Array(config_files) \
+        + Array(destination) \
+        + Array(options['exclude']).map { |e| Jekyll.sanitized_path(source, e) }
+      )
+      ignored = []
+
+      source_abs = Pathname.new(source).expand_path
+      paths.each do |p|
+        path_abs = Pathname.new(p).expand_path
+        begin
+          rel_path = path_abs.relative_path_from(source_abs).to_s
+          ignored << Regexp.new(Regexp.escape(rel_path)) unless rel_path.start_with?('../')
+        rescue ArgumentError
+          # Could not find a relative path
+        end
+      end
+
+      Jekyll.logger.debug "Watcher:", "Ignoring #{ignored.map(&:inspect).join(', ')}"
+      ignored
+    end
+
+  end
+end

data/script/bootstrap

@@ -0,0 +1,8 @@
+#! /bin/bash
+
+if [[ "$TRAVIS" == "true" ]]; then
+  echo "We're on Travis! Installing to vendor."
+  time bundle install --path vendor
+else
+  bundle install --system
+fi

data/script/cibuild

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+time script/test

data/script/test

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec --color --require spec_helper "$@"

data/script/test-watcher

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+local-jekyll serve --watch \
+  --source spec/test-site \
+  --destination spec/test-site/_site

data/script/unbundle

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+RELEASES_URL="https://github.com/jekyll/jekyll/releases"
+JEKYLL_VERSION="2.2.0"
+JEKYLL_BUNDLE="jekyll-${JEKYLL_VERSION}.tar.gz"
+
+wget "${RELEASES_URL}/download/v${JEKYLL_VERSION}/${JEKYLL_BUNDLE}"
+tar -xzvf ${JEKYLL_BUNDLE}

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require 'jekyll'
+require File.expand_path('../../lib/jekyll-watch.rb', __FILE__)
+TEST_DIR = File.expand_path('..', __FILE__)
+
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+
+
+  def source_dir(*files)
+    File.join(TEST_DIR, 'test-site', *files)
+  end
+
+  def dest_dir(*files)
+    source_dir('_site', *files)
+  end
+end

data/spec/test-site/.gitignore

@@ -0,0 +1 @@
+_site

data/spec/test-site/_config.dev.toml

@@ -0,0 +1 @@
+hello = "there"

data/spec/test-site/_config.yml

@@ -0,0 +1,15 @@
+# Site settings
+title: jekyll-watch test site
+email: your-email@domain.com
+description: > # this means to ignore newlines until "baseurl:"
+  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: "http://yourdomain.com" # the base hostname & protocol for your site
+twitter_username: jekyllrb
+github_username:  jekyll
+exclude: [".gitignore"]
+
+# Build settings
+markdown: kramdown

data/spec/test-site/_includes/footer.html

@@ -0,0 +1,55 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+    <h2 class="footer-heading">{{ site.title }}</h2>
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col  footer-col-1">
+        <ul class="contact-list">
+          <li>{{ site.title }}</li>
+          <li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+        </ul>
+      </div>
+
+      <div class="footer-col  footer-col-2">
+        <ul class="social-media-list">
+          {% if site.github_username %}
+          <li>
+            <a href="https://github.com/{{ site.github_username }}">
+              <span class="icon  icon--github">
+                <svg viewBox="0 0 16 16">
+                  <path fill="#828282" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761 c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32 c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472 c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037 C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65 c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261 c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082 c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129 c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/>
+                </svg>
+              </span>
+
+              <span class="username">{{ site.github_username }}</span>
+            </a>
+          </li>
+          {% endif %}
+
+          {% if site.twitter_username %}
+          <li>
+            <a href="https://twitter.com/{{ site.twitter_username }}">
+              <span class="icon  icon--twitter">
+                <svg viewBox="0 0 16 16">
+                  <path fill="#828282" d="M15.969,3.058c-0.586,0.26-1.217,0.436-1.878,0.515c0.675-0.405,1.194-1.045,1.438-1.809
+                  c-0.632,0.375-1.332,0.647-2.076,0.793c-0.596-0.636-1.446-1.033-2.387-1.033c-1.806,0-3.27,1.464-3.27,3.27 c0,0.256,0.029,0.506,0.085,0.745C5.163,5.404,2.753,4.102,1.14,2.124C0.859,2.607,0.698,3.168,0.698,3.767 c0,1.134,0.577,2.135,1.455,2.722C1.616,6.472,1.112,6.325,0.671,6.08c0,0.014,0,0.027,0,0.041c0,1.584,1.127,2.906,2.623,3.206 C3.02,9.402,2.731,9.442,2.433,9.442c-0.211,0-0.416-0.021-0.615-0.059c0.416,1.299,1.624,2.245,3.055,2.271 c-1.119,0.877-2.529,1.4-4.061,1.4c-0.264,0-0.524-0.015-0.78-0.046c1.447,0.928,3.166,1.469,5.013,1.469 c6.015,0,9.304-4.983,9.304-9.304c0-0.142-0.003-0.283-0.009-0.423C14.976,4.29,15.531,3.714,15.969,3.058z"/>
+                </svg>
+              </span>
+
+              <span class="username">{{ site.twitter_username }}</span>
+            </a>
+          </li>
+          {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col  footer-col-3">
+        <p class="text">{{ site.description }}</p>
+      </div>
+    </div>
+
+  </div>
+
+</footer>

data/spec/test-site/_includes/head.html

@@ -0,0 +1,11 @@
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+    <title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
+    <meta name="description" content="{{ site.description }}">
+
+    <link rel="stylesheet" href="{{ "/css/main.css" | prepend: site.baseurl }}">
+    <link rel="canonical" href="{{ page.url | replace:'index.html','' | prepend: site.baseurl | prepend: site.url }}">
+</head>