Merge pull request #9 from jekyll/date-object

Pass Date object to Liquid instead of a Hash

Author: alfredxing

lib/jekyll-archives.rb

@@ -54,16 +54,16 @@ def read
 
     def read_tags
       if enabled? "tags"
-        tags.each do |name, posts|
-          @archives << Archive.new(@site, name, "tag", posts)
+        tags.each do |title, posts|
+          @archives << Archive.new(@site, title, "tag", posts)
         end
       end
     end
 
     def read_categories
       if enabled? "categories"
-        categories.each do |name, posts|
-          @archives << Archive.new(@site, name, "category", posts)
+        categories.each do |title, posts|
+          @archives << Archive.new(@site, title, "category", posts)
         end
       end
     end

lib/jekyll-archives/archive.rb

@@ -11,32 +11,34 @@ class Archive
     ATTRIBUTES_FOR_LIQUID = %w[
       posts
       type
+      title
       name
+      path
+      url
     ]
 
     # Initialize a new Archive page
     #
     # site  - The Site object.
-    # name  - The name of the tag/category or a Hash of the year/month/day in case of date.
+    # title - The name of the tag/category or a Hash of the year/month/day in case of date.
     #           e.g. { :year => 2014, :month => 08 } or "my-category" or "my-tag".
     # type  - The type of archive. Can be one of "year", "month", "day", "category", or "tag"
     # posts - The array of posts that belong in this archive.
-    def initialize(site, name, type, posts)
+    def initialize(site, title, type, posts)
       @site  = site
       @posts = posts
       @type  = type
-      @name  = name
+      @title = title
 
       # Generate slug if tag or category (taken from jekyll/jekyll/features/support/env.rb)
-      if name.is_a? String
-        @slug = name.split(" ").map { |w|
-          w.downcase.gsub(/[^\w]/, '')
-        }.join("-")
+      if title.is_a? String
+        @slug = Utils.slugify(title)
       end
 
       # Use ".html" for file extension and url for path
-      @ext  = ".html"
-      @path = url
+      @ext  = File.extname(relative_path)
+      @path = relative_path
+      @name = File.basename(relative_path, @ext)
 
       @data = {
         "layout" => site.config['jekyll-archives']['layout']
@@ -54,8 +56,8 @@ def template
     # Returns a hash of URL placeholder names (as symbols) mapping to the
     # desired placeholder replacements. For details see "url.rb".
     def url_placeholders
-      if @name.is_a? Hash
-        @name.merge({ :type => @type })
+      if @title.is_a? Hash
+        @title.merge({ :type => @type })
       else
         { :name => @slug, :type => @type }
       end
@@ -99,13 +101,25 @@ def to_liquid(attrs = nil)
       Utils.deep_merge_hashes(data, further_data)
     end
 
+    # Produce a title object suitable for Liquid based on type of archive.
+    #
+    # Returns the title as a Date (for date-based archives) or a
+    # String (for tag and category archives)
+    def title
+      if @title.is_a? Hash
+        args = @title.values.map { |s| s.to_i }
+        Date.new(*args)
+      else
+        @title
+      end
+    end
+
     # Obtain destination path.
     #
     # dest - The String path to the destination dir.
     #
     # Returns the destination file path String.
     def destination(dest)
-      @dest ||= dest
       path = Jekyll.sanitized_path(dest, URL.unescape_path(url))
       path = File.join(path, "index.html") if url =~ /\/$/
       path
@@ -115,13 +129,14 @@ def destination(dest)
     #
     # Returns the destination relative path String.
     def relative_path
-      path = Pathname.new(destination(@dest)).relative_path_from Pathname.new(@dest)
+      path = URL.unescape_path(url).gsub(/^\//, '')
+      path = File.join(path, "index.html") if url =~ /\/$/
       path
     end
 
     # Returns the object as a debug String.
     def inspect
-      "#<Jekyll:Archive @type=#{@type.to_s} @name=#{@name}>"
+      "#<Jekyll:Archive @type=#{@type.to_s} @title=#{@title}>"
     end
 
     # Returns the Boolean of whether this Page is HTML or not.

test/test_jekyll_archives.rb

@@ -14,37 +14,37 @@ class TestJekyllArchives < Minitest::Test
 
     should "generate archive pages by year" do
       @archives.generate(@site)
-      assert archive_exists? @site, "/2014/"
-      assert archive_exists? @site, "/2013/"
+      assert archive_exists? @site, "2014/index.html"
+      assert archive_exists? @site, "2013/index.html"
     end
 
     should "generate archive pages by month" do
       @archives.generate(@site)
-      assert archive_exists? @site, "/2014/08/"
-      assert archive_exists? @site, "/2014/03/"
+      assert archive_exists? @site, "2014/08/index.html"
+      assert archive_exists? @site, "2014/03/index.html"
     end
 
     should "generate archive pages by day" do
       @archives.generate(@site)
-      assert archive_exists? @site, "/2014/08/17/"
-      assert archive_exists? @site, "/2013/08/16/"
+      assert archive_exists? @site, "2014/08/17/index.html"
+      assert archive_exists? @site, "2013/08/16/index.html"
     end
 
     should "generate archive pages by tag" do
       @archives.generate(@site)
-      assert archive_exists? @site, "/tag/test-tag/"
-      assert archive_exists? @site, "/tag/tagged/"
-      assert archive_exists? @site, "/tag/new/"
+      assert archive_exists? @site, "tag/test-tag/index.html"
+      assert archive_exists? @site, "tag/tagged/index.html"
+      assert archive_exists? @site, "tag/new/index.html"
     end
 
     should "generate archive pages by category" do
       @archives.generate(@site)
-      assert archive_exists? @site, "/category/plugins/"
+      assert archive_exists? @site, "category/plugins/index.html"
     end
 
     should "generate archive pages with a layout" do
       @site.process
-      assert_equal "Test", read_file("/tag/test-tag/index.html")
+      assert_equal "Test", read_file("tag/test-tag/index.html")
     end
   end
 
@@ -62,7 +62,7 @@ class TestJekyllArchives < Minitest::Test
 
     should "use custom layout" do
       @site.process
-      assert_equal "Test too", read_file("/tag/test-tag/index.html")
+      assert_equal "Test too", read_file("tag/test-tag/index.html")
     end
   end
 
@@ -82,11 +82,11 @@ class TestJekyllArchives < Minitest::Test
     end
 
     should "use the right permalink" do
-      assert archive_exists? @site, "/year/2014/"
-      assert archive_exists? @site, "/year/2013/"
-      assert archive_exists? @site, "/tag-test-tag.html"
-      assert archive_exists? @site, "/tag-new.html"
-      assert archive_exists? @site, "/category-plugins.html"
+      assert archive_exists? @site, "year/2014/index.html"
+      assert archive_exists? @site, "year/2013/index.html"
+      assert archive_exists? @site, "tag-test-tag.html"
+      assert archive_exists? @site, "tag-new.html"
+      assert archive_exists? @site, "category-plugins.html"
     end
   end
 
@@ -101,7 +101,7 @@ class TestJekyllArchives < Minitest::Test
     end
 
     should "populate the {{ site.archives }} tag in Liquid" do
-      assert_equal 12, read_file("/length.html").to_i
+      assert_equal 12, read_file("length.html").to_i
     end
   end
 
@@ -112,7 +112,7 @@ class TestJekyllArchives < Minitest::Test
     end
 
     should "not generate any archives" do
-      assert_equal 0, read_file("/length.html").to_i
+      assert_equal 0, read_file("length.html").to_i
     end
   end
 
@@ -127,16 +127,16 @@ class TestJekyllArchives < Minitest::Test
     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/"
+      assert archive_exists? @site, "tag/test-tag/index.html"
+      assert archive_exists? @site, "tag/tagged/index.html"
+      assert archive_exists? @site, "tag/new/index.html"
     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/")
+      assert !archive_exists?(@site, "2014/index.html")
+      assert !archive_exists?(@site, "2014/08/index.html")
+      assert !archive_exists?(@site, "2013/08/16/index.html")
+      assert !archive_exists?(@site, "category/plugins/index.html")
     end
   end
 end