Merge pull request #10 from jekyll/enabled-archives

Add `enabled` key to config

Author: alfredxing

README.md

@@ -19,9 +19,24 @@ gems:
 
 ```yml
 jekyll-archives:
-  layout: archive                  # The layout to use for archive pages.
-  permalinks:
-    year:     '/archive/:name'     # The permalink to use for year-based archives.
-    tag:      '/tag/:name'         # The permalink to use for tag archives.
-    category: '/category/:name'    # The permalink to use for category archives.
+  layout: archive                  # The default layout to use for archive pages.
+  enabled:                         # Specifies which archives are enabled.
+    - year
+    - month
+    - tags
+  layouts:                         # (Optional) Specifies type-specific layouts.
+    year:     year-archive
+    month:    month-archive
+  permalinks:                      # (Optional) The permalinks to use for each archive.
+    year:     '/:year/'
+    month:    '/:year/:month/'
+    day:      '/:year/:month/:day'
+    tag:      '/tag/:name/'
+    category: '/category/:name/'
 ```
+
+### The `enabled` setting
+Archives are enabled based on the following configuration rules:
+- All archives are disabled by default.
+- All archives can be enabled by setting `enabled: true` or `enabled: all`.
+- Individual archives can be enabled by setting `enabled` to an array (see above example).

lib/jekyll-archives.rb

@@ -9,6 +9,7 @@ class Archives < Jekyll::Generator
 
     DEFAULTS = {
       'layout' => 'archive',
+      'enabled' => [],
       'permalinks' => {
         'year' => '/:year/',
         'month' => '/:year/:month/',
@@ -46,23 +47,46 @@ def generate(site)
 
     # Read archive data from posts
     def read
-      tags.each do |name, posts|
-        @archives << Archive.new(@site, name, "tag", posts)
+      read_tags
+      read_categories
+      read_dates
+    end
+
+    def read_tags
+      if enabled? "tags"
+        tags.each do |name, posts|
+          @archives << Archive.new(@site, name, "tag", posts)
+        end
       end
-      categories.each do |name, posts|
-        @archives << Archive.new(@site, name, "category", posts)
+    end
+
+    def read_categories
+      if enabled? "categories"
+        categories.each do |name, posts|
+          @archives << Archive.new(@site, name, "category", posts)
+        end
       end
+    end
+
+    def read_dates
       years.each do |year, posts|
-        @archives << Archive.new(@site, { :year => year }, "year", posts)
+        @archives << Archive.new(@site, { :year => year }, "year", posts) if enabled? "year"
         months(posts).each do |month, posts|
-          @archives << Archive.new(@site, { :year => year, :month => month }, "month", posts)
+          @archives << Archive.new(@site, { :year => year, :month => month }, "month", posts) if enabled? "month"
           days(posts).each do |day, posts|
-            @archives << Archive.new(@site, { :year => year, :month => month, :day => day }, "day", posts)
+            @archives << Archive.new(@site, { :year => year, :month => month, :day => day }, "day", posts) if enabled? "day"
           end
         end
       end
     end
 
+    # Checks if archive type is enabled in config
+    def enabled?(archive)
+      @config["enabled"] == true || @config["enabled"] == "all" || if @config["enabled"].is_a? Array
+        @config["enabled"].include? archive
+      end
+    end
+
     # Renders the archives into the layouts
     def render
       payload = @site.site_payload

test/test_jekyll_archives.rb

@@ -3,7 +3,11 @@
 class TestJekyllArchives < Minitest::Test
   context "the jekyll-archives plugin" do
     setup do
-      @site = fixture_site
+      @site = fixture_site({
+        "jekyll-archives" => {
+          "enabled" => true
+        }
+      })
       @site.read
       @archives = Jekyll::Archives.new(@site.config)
     end
@@ -48,7 +52,8 @@ class TestJekyllArchives < Minitest::Test
     setup do
       @site = fixture_site({
         "jekyll-archives" => {
-          "layout" => "archive-too"
+          "layout" => "archive-too",
+          "enabled" => true
         }
       })
       @site.read
@@ -65,6 +70,7 @@ class TestJekyllArchives < Minitest::Test
     setup do
       @site = fixture_site({
         "jekyll-archives" => {
+          "enabled" => true,
           "permalinks" => {
             "year" => "/year/:year/",
             "tag" => "/tag-:name.html",
@@ -86,12 +92,51 @@ class TestJekyllArchives < Minitest::Test
 
   context "the archives" do
     setup do
-      @site = fixture_site
+      @site = fixture_site({
+        "jekyll-archives" => {
+          "enabled" => true
+        }
+      })
       @site.process
     end
 
     should "populate the {{ site.archives }} tag in Liquid" do
       assert_equal 12, read_file("/length.html").to_i
     end
   end
+
+  context "the jekyll-archives plugin with default config" do
+    setup do
+      @site = fixture_site
+      @site.process
+    end
+
+    should "not generate any archives" do
+      assert_equal 0, read_file("/length.html").to_i
+    end
+  end
+
+  context "the jekyll-archives plugin with enabled array" do
+    setup do
+      @site = fixture_site({
+        "jekyll-archives" => {
+          "enabled" => ["tags"]
+        }
+      })
+      @site.process
+    end
+
+    should "generate the enabled archives" do
+      assert archive_exists? @site, "/tag/test-tag/"
+      assert archive_exists? @site, "/tag/tagged/"
+      assert archive_exists? @site, "/tag/new/"
+    end
+
+    should "not generate the disabled archives" do
+      assert !archive_exists?(@site, "/2014/")
+      assert !archive_exists?(@site, "/2014/08/")
+      assert !archive_exists?(@site, "/2013/08/16/")
+      assert !archive_exists?(@site, "/category/plugins/")
+    end
+  end
 end