Merge pull request #1 from jekyll/archives

Migrate from alfredxing/jekyll-archives

Author: alfredxing

.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+test/destination
+.bundle

Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alfred Xing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,27 @@
-# jekyll-archives
+# Jekyll Archives
 
-Archive pages for your Jekyll tags and categories.
+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)
+
+## Usage
+
+1. Add `gem 'jekyll-archives'` to your site's Gemfile
+2. Add the following to your site's `_config.yml`:
+
+```yml
+gems:
+  - jekyll-archives
+```
+
+## Configuration
+`jekyll-archives` is configurable from your site's `_config.yml` file:
+
+```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.
+```

Rakefile

@@ -0,0 +1,23 @@
+# From jekyll/jekyll-mentions
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => 'test'

jekyll-archives.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name        = "jekyll-archives"
+  s.summary     = "Post archives for Jekyll."
+  s.description = "Automatically generate post archives by dates, tags, and categories."
+  s.version     = "0.1.0"
+  s.authors     = ["Alfred Xing"]
+
+  s.homepage    = "https://github.com/jekyll/jekyll-archives"
+  s.licenses    = ["MIT"]
+  s.files       = ["lib/jekyll-archives.rb", "lib/jekyll-archives/archive.rb"]
+
+  s.add_dependency "jekyll", '~> 2.0'
+
+  s.add_development_dependency  'rake'
+  s.add_development_dependency  'rdoc'
+  s.add_development_dependency  'shoulda'
+  s.add_development_dependency  'minitest'
+end

lib/jekyll-archives.rb

@@ -0,0 +1,135 @@
+require 'jekyll'
+
+module Jekyll
+  # Internal requires
+  autoload :Archive, 'jekyll-archives/archive'
+
+  class Archives < Jekyll::Generator
+    safe true
+
+    DEFAULTS = {
+      'layout' => 'archive',
+      'permalinks' => {
+        'year' => '/:year/',
+        'month' => '/:year/:month/',
+        'day' => '/:year/:month/:day/',
+        'tag' => '/tag/:name/',
+        'category' => '/category/:name/'
+      }
+    }
+
+    def initialize(config = nil)
+      if config['jekyll-archives'].nil?
+        @config = DEFAULTS
+      else
+        @config = Utils.deep_merge_hashes(DEFAULTS, config['jekyll-archives'])
+      end
+    end
+
+    def generate(site)
+      @site = site
+      @posts = site.posts
+      @archives = []
+
+      @site.config['jekyll-archives'] = @config
+
+      read
+      render
+      write
+
+      @site.keep_files ||= []
+      @archives.each do |archive|
+        @site.keep_files << archive.relative_path
+      end
+      @site.config["archives"] = @archives
+    end
+
+    # Read archive data from posts
+    def read
+      tags.each do |name, posts|
+        @archives << Archive.new(@site, name, "tag", posts)
+      end
+      categories.each do |name, posts|
+        @archives << Archive.new(@site, name, "category", posts)
+      end
+      years.each do |year, posts|
+        @archives << Archive.new(@site, { :year => year }, "year", posts)
+        months(posts).each do |month, posts|
+          @archives << Archive.new(@site, { :year => year, :month => month }, "month", posts)
+          days(posts).each do |day, posts|
+            @archives << Archive.new(@site, { :year => year, :month => month, :day => day }, "day", posts)
+          end
+        end
+      end
+    end
+
+    # Renders the archives into the layouts
+    def render
+      payload = @site.site_payload
+      @archives.each do |archive|
+        archive.render(@site.layouts, payload)
+      end
+    end
+
+    # Write archives to their destination
+    def write
+      @archives.each do |archive|
+        archive.write(@site.dest)
+      end
+    end
+
+    # Construct a Hash of Posts indexed by the specified Post attribute.
+    #
+    # post_attr - The String name of the Post attribute.
+    #
+    # Examples
+    #
+    #   post_attr_hash('categories')
+    #   # => { 'tech' => [<Post A>, <Post B>],
+    #   #      'ruby' => [<Post B>] }
+    #
+    # Returns the Hash: { attr => posts } where
+    #   attr  - One of the values for the requested attribute.
+    #   posts - The Array of Posts with the given attr value.
+    #
+    # Taken from jekyll/jekyll (Copyright (c) 2014 Tom Preston-Werner under the MIT).
+    def post_attr_hash(post_attr)
+      # Build a hash map based on the specified post attribute ( post attr =>
+      # array of posts ) then sort each array in reverse order.
+      hash = Hash.new { |h, key| h[key] = [] }
+      @posts.each { |p| p.send(post_attr.to_sym).each { |t| hash[t] << p } }
+      hash.values.each { |posts| posts.sort!.reverse! }
+      hash
+    end
+
+    def tags
+      post_attr_hash('tags')
+    end
+
+    def categories
+      post_attr_hash('categories')
+    end
+
+    # Custom `post_attr_hash` method for years
+    def years
+      hash = Hash.new { |h, key| h[key] = [] }
+      @posts.each { |p| hash[p.date.strftime("%Y")] << p }
+      hash.values.each { |posts| posts.sort!.reverse! }
+      hash
+    end
+
+    def months(year_posts)
+      hash = Hash.new { |h, key| h[key] = [] }
+      year_posts.each { |p| hash[p.date.strftime("%m")] << p }
+      hash.values.each { |posts| posts.sort!.reverse! }
+      hash
+    end
+
+    def days(month_posts)
+      hash = Hash.new { |h, key| h[key] = [] }
+      month_posts.each { |p| hash[p.date.strftime("%d")] << p }
+      hash.values.each { |posts| posts.sort!.reverse! }
+      hash
+    end
+  end
+end

lib/jekyll-archives/archive.rb

@@ -0,0 +1,132 @@
+module Jekyll
+  class Archive
+    include Convertible
+
+    attr_accessor :posts, :type, :name, :slug
+    attr_accessor :data, :content, :output
+    attr_accessor :path, :ext
+    attr_accessor :site
+
+    # Attributes for Liquid templates
+    ATTRIBUTES_FOR_LIQUID = %w[
+      posts
+      type
+      name
+    ]
+
+    # 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.
+    #           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)
+      @site  = site
+      @posts = posts
+      @type  = type
+      @name  = name
+
+      # 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("-")
+      end
+
+      # Use ".html" for file extension and url for path
+      @ext  = ".html"
+      @path = url
+
+      @data = {
+        "layout" => site.config['jekyll-archives']['layout']
+      }
+      @content = ""
+    end
+
+    # The template of the permalink.
+    #
+    # Returns the template String.
+    def template
+      site.config['jekyll-archives']['permalinks'][type]
+    end
+
+    # 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 })
+      else
+        { :name => @slug, :type => @type }
+      end
+    end
+
+    # The generated relative url of this page. e.g. /about.html.
+    #
+    # Returns the String url.
+    def url
+      @url ||= URL.new({
+        :template => template,
+        :placeholders => url_placeholders,
+        :permalink => nil
+      }).to_s
+    rescue ArgumentError
+      raise ArgumentError.new "Template \"#{template}\" provided is invalid."
+    end
+
+    # Add any necessary layouts to this post
+    #
+    # layouts      - The Hash of {"name" => "layout"}.
+    # site_payload - The site payload Hash.
+    #
+    # Returns nothing.
+    def render(layouts, site_payload)
+      payload = Utils.deep_merge_hashes({
+        "page" => to_liquid
+      }, site_payload)
+
+      do_layout(payload, layouts)
+    end
+
+    # Convert this Convertible's data to a Hash suitable for use by Liquid.
+    #
+    # Returns the Hash representation of this Convertible.
+    def to_liquid(attrs = nil)
+      further_data = Hash[(attrs || self.class::ATTRIBUTES_FOR_LIQUID).map { |attribute|
+        [attribute, send(attribute)]
+      }]
+
+      Utils.deep_merge_hashes(data, further_data)
+    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
+    end
+
+    # Obtain the write path relative to the destination directory
+    #
+    # Returns the destination relative path String.
+    def relative_path
+      path = Pathname.new(destination(@dest)).relative_path_from Pathname.new(@dest)
+      path
+    end
+
+    # Returns the object as a debug String.
+    def inspect
+      "#<Jekyll:Archive @type=#{@type.to_s} @name=#{@name}>"
+    end
+
+    # Returns the Boolean of whether this Page is HTML or not.
+    def html?
+      true
+    end
+  end
+end

script/cibuild

@@ -0,0 +1,3 @@
+#! /bin/sh
+
+bundle exec rake test