jekyll-incremental 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9793102931494fe36f0f4a5a56e27eeca940a0962f3d34fc5b56309aa7db1280
-  data.tar.gz: d8e6fbc542095b421193def52cef069864e680cf4449575d51ef9424d2dbfcda
+  metadata.gz: 6bbe1dbe0d68eb5a232cf4bde2b13eee14b83308ca80a474949d1c6e6c83263b
+  data.tar.gz: 0f320fd38c6cd525ee1b7e307c9873911bd559712dcfe4db24fe309c4034b883
 SHA512:
-  metadata.gz: 0f7760d024bd9e7f706264e0b0d1ed5a90294ef59a3df9a30e6009a2d251194c79af3b6baa97b243df59832b59120def5b3a08ab17460ab3bbb4450a2c8a87d5
-  data.tar.gz: d658c37e31764d4d16a4515cda1fe2956081f147c58077b69675ace196d3ddf48f107dd06ae98e1e9ef7ba09bfa11d77aebeb0022df4b16e74631c7968a72dbb
+  metadata.gz: f7bb4b2c682ed2b3d8fc6c5db1a122403072c755aa1b70656f459538a7cf4c28c853340d26d62dd01541fa785b6bdc7cdf73fa73e04e31bc6fa09feb7718e916
+  data.tar.gz: 21b8db849c736443e6f452fdec9ed8393dc0c01491e82937eb17ecc427add449aeffe4b49483360a0b501b5d0eb0cf9fa7bb1ae55a7296eb26f631b78ddcb8ee

data/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 Anomaly Software Pty Ltd
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -7,3 +7,20 @@
 # Jekyll Incremental
 
 Jekyll Incremental is a more simple, and to the point version of incremental generation for Jekyll.  It also tries to solve the shortfalls of Jekyll's own incremental regeneration by treating all things equal, dynamic, doc, post, or collection.  As long as we can get the path, we will track it and make sure it gets generated.  It has an almost backwards compatible API (as far as adding dependencies, and dependent's) and merges several other API's in favor of a single, simple interface to track everything.
+
+## Installation
+
+```ruby
+gem "jekyll-reload", {
+  group: "jekyll-plugins"
+}
+```
+
+## Usage
+
+By default we replace Jekyll's internal regenerator with our own, so you would use ours the same way you would use theirs.  This allows us to stay out of your way and for you not to have to adjust any workflows.
+
+```ruby
+bundle exec jekyll b \
+  --incremental
+```

data/Rakefile

@@ -2,31 +2,38 @@
 # Copyright: 2012 - 2017 - MIT License
 # Encoding: utf-8
 
+# --
+# 🔖
+# RSpec, MiniTest, Whatever.
 # --
 task :spec do
-  exec "script/test"
+  sh "script/test"
 end
-
+# --
+# 🔖
+# RSpec, MiniTest, Whatever.
 # --
 task :test do
-  exec "script/test"
+  sh "script/test"
 end
-
+# --
+# 🔖
+# @see .rubocop.yml
+# Rubocop.
 # --
 task :rubocop do
-  exec "script/lint"
+  sh "script/lint"
 end
-
+# --
+# 🔖
+# @see .rubocop.yml
+# Rubocop.
 # --
 task :lint do
-  exec "script/lint"
+  sh "script/lint"
 end
 
 # --
-# If you wish to have extra rake tasks
-#   You can load them from within the script
-#   directory by creating task.rake.
-# --
-Dir.glob("script/rake/*.rake").each do |v|
+Dir.glob("script/rake.d/*.rake").each do |v|
   load v
 end

data/lib/jekyll-incremental.rb

@@ -6,6 +6,12 @@
 require "jekyll/cache"
 
 module Jekyll
+  # --
+  # @note we replace theirs in-place.
+  # @example bundle exec jekyll b --incremental
+  # A replacement of Jekyll's Regenerator.  That does a
+  #   few things a bit differently, most things.
+  # --
   module Incremental
     FORCE_KEYS = %w(regenerate force force_regenerate regen).freeze
     CACHE_KEY  = "jekyll:regenerator:metadata"
@@ -32,10 +38,18 @@ module Jekyll
     #   whether the file has been modified.
     # --
     def regenerate?(doc)
-      return false unless doc.write?
-      return true if doc.respond_to?(:asset_file?) && doc.asset_file?
-      return true if forced_by_data?(doc)
-      modified?(doc)
+      out = false unless doc.write?
+      out = true if doc.respond_to?(:asset_file?) && doc.asset_file?
+      out = true if forced_by_data?(doc)
+      out = modified?(doc)
+
+      # --
+      # Make sure they know.
+      # --
+      Jekyll.logger.debug "Incremental" do
+        "#{out} for #{doc.path}"
+      end
+      out
     end
 
     # --
@@ -57,14 +71,18 @@ module Jekyll
     # rubocop:disable Metrics/PerceivedComplexity
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/LineLength
+    # rubocop:disable Metrics/AbcSize
     # --
     def modified?(doc)
       return true if metadata[doc.path]&.[](:forced)
+      return true unless File.exist?(site.in_dest_dir(doc.path))
       modified, hash = file_mtime_of(doc.path), metadata[doc.path]
       return modified > hash[:last_modified] if hash && !hash[:dynamic] && hash[:seen_before]
       return hash[:seen_before] = true if hash && !hash[:seen_before]
       return dependencies_modified?(hash) if hash
       add(doc.path).update(seen_before: true)
+
+      true
     end
 
     # --
@@ -96,7 +114,7 @@ module Jekyll
       return metadata[path] if metadata.key?(path)
       metadata[path] = {
         seen_before: false,
-        dynamic: !File.exist?(path),
+        dynamic: !File.exist?(site.in_source_dir(path)),
         last_modified: file_mtime_of(path),
         dependencies: Set.new,
         forced: forced,
@@ -167,6 +185,11 @@ end
 
 # --
 module Jekyll
+  # --
+  # Patches Jekyll's own regenerator, and replaces it with
+  #   our regenerator, which should in theory be more efficient
+  #   than Jekyll's since it does less work.
+  # --
   class Regenerator
     prepend Jekyll::Incremental
   end

data/lib/jekyll/incremental/version.rb

@@ -4,6 +4,6 @@
 
 module Jekyll
   module Incremental
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-incremental
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Jordon Bedwell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll