bunto-archives 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6050195a3fe52e29423dcdd36058cddfcc0d9ea
+  data.tar.gz: 7c52c9fbcea17983036817714d7825d681b7dece
+SHA512:
+  metadata.gz: 5ce6f5f453f44ad450d2841b17dad353a7addae01c58cbacd98c9d80b341ad2fdce61bfcc4b9883eea54ef6d476b00a72762e6676b99596bb31cb09806393b6b
+  data.tar.gz: 1dc223990d4b05217504224502c3355d83b0642eb9f0cf9fcca1c851ad81a5d916cb951751adb07a89e16385ac1ada0c1cf270cf4569970c7d4e582ba7c443d5

data/lib/bunto-archives.rb

@@ -0,0 +1,152 @@
+require 'bunto'
+
+module Bunto
+  module Archives
+    # Internal requires
+    autoload :Archive, 'bunto-archives/archive'
+    autoload :VERSION, 'bunto-archives/version'
+
+    if (Bunto.const_defined? :Hooks)
+      Bunto::Hooks.register :site, :after_reset do |site|
+        # We need to disable incremental regen for Archives to generate with the
+        # correct content
+        site.regenerator.instance_variable_set(:@disabled, true)
+      end
+    end
+
+    class Archives < Bunto::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)
+        if config['bunto-archives'].nil?
+          @config = DEFAULTS
+        else
+          @config = Utils.deep_merge_hashes(DEFAULTS, config['bunto-archives'])
+        end
+      end
+
+      def generate(site)
+        @site = site
+        @posts = site.posts
+        @archives = []
+
+        @site.config['bunto-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
+        read_tags
+        read_categories
+        read_dates
+      end
+
+      def read_tags
+        if enabled? "tags"
+          tags.each do |title, posts|
+            @archives << Archive.new(@site, title, "tag", posts)
+          end
+        end
+      end
+
+      def read_categories
+        if enabled? "categories"
+          categories.each do |title, posts|
+            @archives << Archive.new(@site, title, "category", posts)
+          end
+        end
+      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
+
+      # 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
+        @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
+
+      def tags
+        @site.post_attr_hash('tags')
+      end
+
+      def categories
+        @site.post_attr_hash('categories')
+      end
+
+      # Custom `post_attr_hash` method for years
+      def years
+        hash = Hash.new { |h, key| h[key] = [] }
+
+        # In Bunto 3, Collection#each should be called on the #docs array directly.
+        if Bunto::VERSION >= '3.0.0' 
+          @posts.docs.each { |p| hash[p.date.strftime("%Y")] << p }
+        else
+          @posts.each { |p| hash[p.date.strftime("%Y")] << p }
+        end
+        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/bunto-archives/archive.rb

@@ -0,0 +1,169 @@
+module Bunto
+  module Archives
+    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
+        title
+        date
+        name
+        path
+        url
+      ]
+
+      # 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['bunto-archives']
+
+        # Generate slug if tag or category (taken from bunto/bunto/features/support/env.rb)
+        if title.to_s.length
+          @slug = Utils.slugify(title.to_s)
+        end
+
+        # Use ".html" for file extension and url for path
+        @ext  = File.extname(relative_path)
+        @path = relative_path
+        @name = File.basename(relative_path, @ext)
+
+        @data = {
+          "layout" => layout
+        }
+        @content = ""
+      end
+
+      # The template of the permalink.
+      #
+      # Returns the template String.
+      def template
+        @config['permalinks'][type]
+      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 a String (for tag and category archives) and nil for
+      # date-based archives.
+      def title
+        if @title.is_a? String
+          @title
+        end
+      end
+
+      # Produce a date object if a date-based archive
+      #
+      # Returns a Date.
+      def date
+        if @title.is_a? Hash
+          args = @title.values.map { |s| s.to_i }
+          Date.new(*args)
+        end
+      end
+
+      # Obtain destination path.
+      #
+      # dest - The String path to the destination dir.
+      #
+      # Returns the destination file path String.
+      def destination(dest)
+        path = Bunto.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
+        "#<Bunto: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
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bunto-archives
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alfred Xing
+- Suriyaa Kudo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2016-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: bunto
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rake
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rdoc
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: shoulda
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: minitest
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically generate post archives by dates, tags, and categories.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bunto-archives.rb
+- lib/bunto-archives/archive.rb
+homepage: https://github.com/bunto/bunto-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.4.8
+signing_key:
+specification_version: 4
+summary: Post archives for Bunto.
+test_files: []