Merge branch 'master' into rubocop

Author: DirtyF

History.md renamed to History.markdown

@@ -1,47 +1,61 @@
 ## HEAD
 
 ### Minor Enhancements
+
+  * Make Archive subclass of Page (#67)
   * Don't limit slugs/title to strings (#41)
+  * Enable incremental operation (#58)
+
+### Development Fixes
 
-## 2.1.0 
+  * Update Travis config and Gemfile for Ruby < 2.2.2 support (#68)
+  * Consolidate History file to work with jekyllbot (#80)
+
+## 2.1.0
 
 ### Minor Enhancements
+
   * Update Jekyll dependency to allow Jekyll 3 (#33)
   * Update docs to reflect changes in v2.0.0 (#31)
   * Add compatibility with Jekyll 3 (#48)
   * Update to reflect release of Jekyll 3 (#52)
   * Support revised documents/collections in Jekyll 3 (#53)
 
-## Development Fixes
-  * Test against Jekyll 2, 3, and GitHub Pages (#48)
+### Development Fixes
 
-### Bug Fixes
+  * Test against Jekyll 2, 3, and GitHub Pages (#48)
 
 ## 2.0.0 / 2015-01-06
 
 ### Minor Enhancements
+
   * Move Date object from `page.title` to `page.date` (#26)
   * Add documentation to repository (#25)
 
 ### Bug Fixes
+
   * Change Jekyll dependency to ~> 2.4 (#23)
 
 ## 1.0.0 / 2014-09-26
 
 ### Major Enhancements
+
   * Support type-specific layouts
   * Pass `Date` object to Liquid in case of date-based archives
   * Liquid `{{ site.archives }}` support
   * Generate month and day archives
 
 ### Minor Enhancements
+
   * Add version file and move everything into `Archives` module
   * Use `Jekyll::Utils.slugify` for slugging
   * Require use to specify what types of archives are enabled
 
 ## 0.1.0 / 2014-08-17
+
   * First release
   * Generate year, category, and tag archives
 
 ## 0.0.0 / 2014-08-17
+
   * Birthday!

README.md

@@ -2,7 +2,7 @@
 
 Automatically generate post archives by dates, tags, and categories.
 
-[![Gem Version](https://badge.fury.io/rb/jekyll-archives.png)](http://badge.fury.io/rb/jekyll-archives)
+[![Gem Version](https://badge.fury.io/rb/jekyll-archives.svg)](http://badge.fury.io/rb/jekyll-archives)
 [![Build Status](https://travis-ci.org/jekyll/jekyll-archives.svg?branch=master)](https://travis-ci.org/jekyll/jekyll-archives)
 
 ## Getting started

lib/jekyll-archives.rb

@@ -6,14 +6,6 @@ module Archives
     autoload :Archive, "jekyll-archives/archive"
     autoload :VERSION, "jekyll-archives/version"
 
-    if Jekyll.const_defined? :Hooks
-      Jekyll::Hooks.register :site, :after_reset do |site|
-        # We need to disable incremental regen for Archives to generate with the
-        # correct content
-        site.regenerator.instance_variable_set(:@disabled, true)
-      end
-    end
-
     class Archives < Jekyll::Generator
       safe true
 
@@ -45,13 +37,8 @@ def generate(site)
         @site.config["jekyll-archives"] = @config
 
         read
-        render
-        write
+        @site.pages.concat(@archives)
 
-        @site.keep_files ||= []
-        @archives.each do |archive|
-          @site.keep_files << archive.relative_path
-        end
         @site.config["archives"] = @archives
       end
 
@@ -108,7 +95,8 @@ def render
       # Write archives to their destination
       def write
         @archives.each do |archive|
-          archive.write(@site.dest)
+          archive.write(@site.dest) if archive.regenerate?
+          archive.add_dependencies
         end
       end
 

lib/jekyll-archives/archive.rb

@@ -1,12 +1,8 @@
 module Jekyll
   module Archives
-    class Archive
-      include Convertible
+    class Archive < Jekyll::Page
 
-      attr_accessor :posts, :type, :name, :slug
-      attr_accessor :data, :content, :output
-      attr_accessor :path, :ext
-      attr_accessor :site
+      attr_accessor :posts, :type, :slug
 
       # Attributes for Liquid templates
       ATTRIBUTES_FOR_LIQUID = %w(
@@ -17,6 +13,7 @@ class Archive
         name
         path
         url
+        permalink
       ).freeze
 
       # Initialize a new Archive page
@@ -34,8 +31,8 @@ def initialize(site, title, type, posts)
         @config = site.config["jekyll-archives"]
 
         # Generate slug if tag or category (taken from jekyll/jekyll/features/support/env.rb)
-        if title.to_s.length
-          @slug = Utils.slugify(title.to_s)
+        if title.is_a? String
+          @slug = Utils.slugify(title)
         end
 
         # Use ".html" for file extension and url for path
@@ -90,6 +87,10 @@ def url
         raise ArgumentError, "Template \"#{template}\" provided is invalid."
       end
 
+      def permalink
+        data && data.is_a?(Hash) && data['permalink']
+      end
+
       # Add any necessary layouts to this post
       #
       # layouts      - The Hash of {"name" => "layout"}.
@@ -104,6 +105,17 @@ def render(layouts, site_payload)
         do_layout(payload, layouts)
       end
 
+      # Add dependencies for incremental mode
+      def add_dependencies
+        if defined? site.regenerator
+          archive_path = site.in_dest_dir(relative_path)
+          site.regenerator.add(archive_path)
+          @posts.each do |post|
+            site.regenerator.add_dependency(archive_path, post.path)
+          end
+        end
+      end
+      
       # Convert this Convertible's data to a Hash suitable for use by Liquid.
       #
       # Returns the Hash representation of this Convertible.
@@ -135,17 +147,6 @@ def date
         end
       end
 
-      # Obtain destination path.
-      #
-      # dest - The String path to the destination dir.
-      #
-      # Returns the destination file path String.
-      def destination(dest)
-        path = Jekyll.sanitized_path(dest, URL.unescape_path(url))
-        path = File.join(path, "index.html") if url =~ /\/$/
-        path
-      end
-
       # Obtain the write path relative to the destination directory
       #
       # Returns the destination relative path String.
@@ -155,15 +156,18 @@ def relative_path
         path
       end
 
+      def regenerate?
+        if defined? site.regenerator
+          site.regenerator.regenerate?(self)
+        else
+          true
+        end
+      end
+
       # Returns the object as a debug String.
       def inspect
         "#<Jekyll:Archive @type=#{@type} @title=#{@title} @data=#{@data.inspect}>"
       end
-
-      # Returns the Boolean of whether this Page is HTML or not.
-      def html?
-        true
-      end
     end
   end
 end