jekyll-archives 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e5597290843350c0f349a0625e966c5b253d914
-  data.tar.gz: 3b2f8221b82d532d32f2dc038554176d65a380a5
+  metadata.gz: 2b678cbc857435a0606f6903249ffafa2d0bc4c6
+  data.tar.gz: c31fe905416a36b9809252359eae9c6374552f6d
 SHA512:
-  metadata.gz: 17b68ddb19f27ce71fa0bc4fd41cd5da92cbc51f11e74bfdb77b30b63629cd307f0312c4f6740aea94da38d1893e4a7122d4e4966dc1ce99235922baedb62b0f
-  data.tar.gz: e9c28eb8ac183bee610d471e1b304ba6d2aec20c90654b1df7be20b3fff9948cda26941b87f70ca6f4e2eace331b189ab49306a2aaf620b317dcf87588b2cc1a
+  metadata.gz: b9e5dff177b866ea05d3195a35b46410882167453683e3275de7b368bec26e6bfec8e11528b088448c02a5e18d0587baadfeac95bf817546154afe0bd924b6ad
+  data.tar.gz: 9fc71856cd97ceb5186d05f661bd8bfe9ff4802499aec4ae6b7665cfd9ddbf766b6bf594c48d9a07d2747c3c8f3fd72f65cb38b758fc1e654367bcdcdb82b5f8

data/lib/jekyll-archives.rb

@@ -1,83 +1,162 @@
+require 'jekyll'
+
 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/'
+  module Archives
+    # Internal requires
+    autoload :Archive, 'jekyll-archives/archive'
+    autoload :VERSION, 'jekyll-archives/version'
+
+    class Archives < Jekyll::Generator
+      safe true
+
+      DEFAULTS = {
+        'layout' => 'archive',
+        'enabled' => [],
+        'permalinks' => {
+          'year' => '/:year/',
+          'month' => '/:year/:month/',
+          'day' => '/:year/:month/:day/',
+          'tag' => '/tag/:name/',
+          'category' => '/category/:name/'
+        }
       }
-    }
 
-    def initialize(config = nil)
-      @config = Utils.deep_merge_hashes(DEFAULTS, config['jekyll-archives'])
-    end
+      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 = []
+      def generate(site)
+        @site = site
+        @posts = site.posts
+        @archives = []
 
-      @site.config['jekyll-archives'] = @config
+        @site.config['jekyll-archives'] = @config
 
-      read_archives
-      @site.pages += @archives
-    end
+        read
+        render
+        write
 
-    # Read archive data from posts
-    def read_archives
-      tags.each do |tag|
-        @archives << Archive.new(@site, tag[1], "tag", tag[0])
+        @site.keep_files ||= []
+        @archives.each do |archive|
+          @site.keep_files << archive.relative_path
+        end
+        @site.config["archives"] = @archives
       end
-      categories.each do |category|
-        @archives << Archive.new(@site, category[1], "category", category[0])
+
+      # Read archive data from posts
+      def read
+        read_tags
+        read_categories
+        read_dates
       end
-      years.each do |year|
-        @archives << Archive.new(@site, year[1], "year", year[0])
+
+      def read_tags
+        if enabled? "tags"
+          tags.each do |title, posts|
+            @archives << Archive.new(@site, title, "tag", posts)
+          end
+        end
       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 read_categories
+        if enabled? "categories"
+          categories.each do |title, posts|
+            @archives << Archive.new(@site, title, "category", posts)
+          end
+        end
+      end
 
-    def tags
-      post_attr_hash('tags')
-    end
+      def read_dates
+        years.each do |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) if enabled? "month"
+            days(posts).each do |day, posts|
+              @archives << Archive.new(@site, { :year => year, :month => month, :day => day }, "day", posts) if enabled? "day"
+            end
+          end
+        end
+      end
 
-    def categories
-      post_attr_hash('categories')
-    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
 
-    # 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
+      # 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
 end

data/lib/jekyll-archives/archive.rb

@@ -1,111 +1,161 @@
 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
+  module Archives
+    class Archive
+      include Convertible
 
-    # The template of the permalink.
-    #
-    # Returns the template String.
-    def template
-      site.config['jekyll-archives']['permalinks'][type]
-    end
+      attr_accessor :posts, :type, :name, :slug
+      attr_accessor :data, :content, :output
+      attr_accessor :path, :ext
+      attr_accessor :site
 
-    # 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
+      # Attributes for Liquid templates
+      ATTRIBUTES_FOR_LIQUID = %w[
+        posts
+        type
+        title
+        name
+        path
+        url
+      ]
 
-    # 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
+      # Initialize a new Archive page
+      #
+      # site  - The Site object.
+      # 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, title, type, posts)
+        @site   = site
+        @posts  = posts
+        @type   = type
+        @title  = title
+        @config = site.config['jekyll-archives']
 
-    # 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
+        # Generate slug if tag or category (taken from jekyll/jekyll/features/support/env.rb)
+        if title.is_a? String
+          @slug = Utils.slugify(title)
+        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)]
-      }]
+        # Use ".html" for file extension and url for path
+        @ext  = File.extname(relative_path)
+        @path = relative_path
+        @name = File.basename(relative_path, @ext)
 
-      Utils.deep_merge_hashes(data, further_data)
-    end
+        @data = {
+          "layout" => layout
+        }
+        @content = ""
+      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
+      # The template of the permalink.
+      #
+      # Returns the template String.
+      def template
+        @config['permalinks'][type]
+      end
 
-    # Returns the object as a debug String.
-    def inspect
-      "#<Jekyll:Archive @type=#{@type.to_s} @name=#{@name}>"
-    end
+      # The layout to use for rendering
+      #
+      # Returns the layout as a String
+      def layout
+        if @config['layouts'] && @config['layouts'][type]
+          @config['layouts'][type]
+        else
+          @config['layout']
+        end
+      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 @title.is_a? Hash
+          @title.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
+
+      # 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)
+        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 = 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} @title=#{@title} @data=#{@data.inspect}>"
+      end
 
-    # Returns the Boolean of whether this Page is HTML or not.
-    def html?
-      true
+      # Returns the Boolean of whether this Page is HTML or not.
+      def html?
+        true
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-archives
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alfred Xing
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,15 +24,71 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Automatically generate post archives by dates, tags, and categories.
-email: support@github.com
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-archives.rb
 - lib/jekyll-archives/archive.rb
-homepage: https://github.com/alfredxing/jekyll-archives
+homepage: https://github.com/jekyll/jekyll-archives
 licenses:
 - MIT
 metadata: {}
@@ -52,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Post archives for Jekyll.