jekyll-archives 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e5597290843350c0f349a0625e966c5b253d914
+  data.tar.gz: 3b2f8221b82d532d32f2dc038554176d65a380a5
+SHA512:
+  metadata.gz: 17b68ddb19f27ce71fa0bc4fd41cd5da92cbc51f11e74bfdb77b30b63629cd307f0312c4f6740aea94da38d1893e4a7122d4e4966dc1ce99235922baedb62b0f
+  data.tar.gz: e9c28eb8ac183bee610d471e1b304ba6d2aec20c90654b1df7be20b3fff9948cda26941b87f70ca6f4e2eace331b189ab49306a2aaf620b317dcf87588b2cc1a

data/lib/jekyll-archives.rb

@@ -0,0 +1,83 @@
+module Jekyll
+  # Internal requires
+  autoload :Archive, 'jekyll-archives/archive'
+
+  class JekyllArchives < Jekyll::Generator
+    safe true
+
+    DEFAULTS = {
+      'layout' => 'archive',
+      'permalinks' => {
+        'year' => '/archive/:name/',
+        'tag' => '/tag/:name/',
+        'category' => '/category/:name/'
+      }
+    }
+
+    def initialize(config = nil)
+      @config = Utils.deep_merge_hashes(DEFAULTS, config['jekyll-archives'])
+    end
+
+    def generate(site)
+      @site = site
+      @posts = site.posts
+      @archives = []
+
+      @site.config['jekyll-archives'] = @config
+
+      read_archives
+      @site.pages += @archives
+    end
+
+    # Read archive data from posts
+    def read_archives
+      tags.each do |tag|
+        @archives << Archive.new(@site, tag[1], "tag", tag[0])
+      end
+      categories.each do |category|
+        @archives << Archive.new(@site, category[1], "category", category[0])
+      end
+      years.each do |year|
+        @archives << Archive.new(@site, year[1], "year", year[0])
+      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.
+    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.year.to_s] << p }
+      hash.values.each { |posts| posts.sort!.reverse! }
+      hash
+    end
+  end
+end

data/lib/jekyll-archives/archive.rb

@@ -0,0 +1,111 @@
+module Jekyll
+  class Archive
+    include Convertible
+
+    attr_accessor :posts, :type, :name
+    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.
+    # posts - The array of posts that belong in this archive.
+    # type  - The type of archive. Can be one of "year", "category", or "tag"
+    # name  - The name of the archive (e.g. "2014" or "my-category" or "my-tag").
+    def initialize(site, posts, type, name)
+      @site  = site
+      @posts = posts
+      @type  = type
+      @name  = name
+
+      # 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
+      { :name => @name, :type => @type.to_s }
+    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)
+      path = Jekyll.sanitized_path(dest, URL.unescape_path(url))
+      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}>"
+    end
+
+    # Returns the Boolean of whether this Page is HTML or not.
+    def html?
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-archives
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alfred Xing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Automatically generate post archives by dates, tags, and categories.
+email: support@github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jekyll-archives.rb
+- lib/jekyll-archives/archive.rb
+homepage: https://github.com/alfredxing/jekyll-archives
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Post archives for Jekyll.
+test_files: []