middleman-blog 3.0.0 → 3.1.0

data/lib/middleman-blog/calendar_pages.rb

@@ -4,6 +4,31 @@ module Middleman
     # A sitemap plugin that adds month/day/year pages to the sitemap
     # based on the dates of blog articles.
     class CalendarPages
+      class << self
+        # Get a path to the given calendar page, based on the :year_link, :month_link or :day_link setting.
+        # @param [Middleman::Application] app
+        # @param [Number] year
+        # @param [Number] month
+        # @param [Number] day
+        # @return [String]
+        def link(app, year, month=nil, day=nil)
+          path = if day
+                   app.blog.options.day_link.
+                     sub(':year', year.to_s).
+                     sub(':month', month.to_s.rjust(2,'0')).
+                     sub(':day', day.to_s.rjust(2,'0'))
+                 elsif month
+                   app.blog.options.month_link.
+                     sub(':year', year.to_s).
+                     sub(':month', month.to_s.rjust(2,'0'))
+                 else
+                   app.blog.options.year_link.
+                     sub(':year', year.to_s)
+                 end
+          ::Middleman::Util.normalize_path(path)
+        end
+      end
+
       def initialize(app)
         @app = app
       end
@@ -17,7 +42,7 @@ module Middleman
           if @app.blog.options.year_template
             @app.ignore @app.blog.options.year_template
 
-            path = Middleman::Util.normalize_path(@app.blog_year_path(year))
+            path = CalendarPages.link(@app, year)
           
             p = ::Middleman::Sitemap::Resource.new(
               @app.sitemap,
@@ -25,6 +50,14 @@ module Middleman
             )
             p.proxy_to(@app.blog.options.year_template)
 
+            # Add metadata in local variables so it's accessible to
+            # later extensions
+            p.add_metadata :locals => {
+              'page_type' => 'year',
+              'year' => year,
+              'articles' => year_articles
+            }
+            # Add metadata in instance variables for backwards compatibility
             p.add_metadata do
               @year = year
               @articles = year_articles
@@ -37,7 +70,7 @@ module Middleman
             if @app.blog.options.month_template
               @app.ignore @app.blog.options.month_template
 
-              path = Middleman::Util.normalize_path(@app.blog_month_path(year, month))
+              path = CalendarPages.link(@app, year, month)
           
               p = ::Middleman::Sitemap::Resource.new(
                 @app.sitemap,
@@ -45,6 +78,12 @@ module Middleman
               )
               p.proxy_to(@app.blog.options.month_template)
 
+              p.add_metadata :locals => {
+                'page_type' => 'month',
+                'year' => year,
+                'month' => month,
+                'articles' => month_articles
+              }
               p.add_metadata do
                 @year = year
                 @month = month
@@ -58,13 +97,21 @@ module Middleman
               if @app.blog.options.day_template
                 @app.ignore @app.blog.options.day_template
 
-                path = Middleman::Util.normalize_path(@app.blog_day_path(year, month, day))
+                path = CalendarPages.link(@app, year, month, day)
+
                 p = ::Middleman::Sitemap::Resource.new(
                   @app.sitemap,
                   path
                 )
                 p.proxy_to(@app.blog.options.day_template)
 
+                p.add_metadata :locals => {
+                  'page_type' => 'day',
+                  'year' => year,
+                  'month' => month,
+                  'day' => day,
+                  'articles' => day_articles
+                }
                 p.add_metadata do
                   @year = year
                   @month = month

data/lib/middleman-blog/extension.rb

@@ -9,6 +9,7 @@ module Middleman
         :layout,
         :summary_separator,
         :summary_length,
+        :summary_generator,
         :year_link,
         :month_link,
         :day_link,
@@ -17,7 +18,10 @@ module Middleman
         :year_template,
         :month_template,
         :day_template,
-        :tag_template
+        :tag_template,
+        :paginate,
+        :per_page,
+        :page_link
       ]
       
       KEYS.each do |name|
@@ -51,6 +55,9 @@ module Middleman
         options.month_link        ||= "/:year/:month.html"
         options.day_link          ||= "/:year/:month/:day.html"
         options.default_extension ||= ".markdown"
+        options.paginate          ||= false
+        options.per_page          ||= 10
+        options.page_link         ||= "page/:num"
 
         # optional: :tag_template
         # optional: :year_template
@@ -106,6 +113,15 @@ module Middleman
               false
             )
           end
+
+          if options.paginate
+            require 'middleman-blog/paginator'
+            sitemap.register_resource_list_manipulator(
+              :blog_paginate,
+              Paginator.new(self),
+              false
+            )
+          end
         end
       end
       alias :included :registered
@@ -136,14 +152,14 @@ module Middleman
       # @param [String] tag
       # @return [String]
       def tag_path(tag)
-        blog.options.taglink.sub(':tag', tag.parameterize)
+        sitemap.find_resource_by_path(TagPages.link(self, tag)).try(:url)
       end
 
       # Get a path to the given year-based calendar page, based on the :year_link setting.
       # @param [Number] year
       # @return [String]
       def blog_year_path(year)
-        blog.options.year_link.sub(':year', year.to_s)
+        sitemap.find_resource_by_path(CalendarPages.link(self, year)).try(:url)
       end
 
       # Get a path to the given month-based calendar page, based on the :month_link setting.
@@ -151,8 +167,7 @@ module Middleman
       # @param [Number] month
       # @return [String]
       def blog_month_path(year, month)
-        blog.options.month_link.sub(':year', year.to_s).
-          sub(':month', month.to_s.rjust(2,'0'))
+        sitemap.find_resource_by_path(CalendarPages.link(self, year, month)).try(:url)
       end
 
       # Get a path to the given day-based calendar page, based on the :day_link setting.
@@ -161,9 +176,23 @@ module Middleman
       # @param [Number] day
       # @return [String]
       def blog_day_path(year, month, day)
-        blog.options.day_link.sub(':year', year.to_s).
-          sub(':month', month.to_s.rjust(2,'0')).
-          sub(':day', day.to_s.rjust(2,'0'))
+        sitemap.find_resource_by_path(CalendarPages.link(self, year, month, day)).try(:url)
+      end
+
+
+      # Pagination Helpers
+      # These are used by the template if pagination is off, to allow a single template to work
+      # in both modes. They get overridden by the local variables if the paginator is active.
+
+      # Returns true if pagination is turned on for this template; false otherwise.
+      # @return [Boolean]
+      def paginate; false; end
+
+      # Returns the list of articles to display on this page.
+      # @return [Array<Middleman::Sitemap::Resource>]
+      def page_articles
+        limit = (current_resource.metadata[:page]["per_page"] || 0) - 1
+        blog.articles[0..limit]
       end
     end
   end

data/lib/middleman-blog/paginator.rb

@@ -0,0 +1,127 @@
+module Middleman
+  module Blog
+
+    # A sitemap plugin that splits indexes (including tag
+    # and calendar indexes) over multiple pages
+    class Paginator
+      def initialize(app)
+        @app = app
+      end
+
+      # Substitute the page number into the resource URL.
+      # @return [String]
+      def page_sub(res, num, page_link)
+        if num == 1
+          # First page has an unmodified URL.
+          res.path
+        else
+          page_url = page_link.sub(":num", num.to_s)
+          index_re = %r{(^|/)#{Regexp.escape(@app.index_file)}$}
+          if res.path =~ index_re
+            res.path.sub(index_re, "\\1#{page_url}/#{@app.index_file}")
+          else
+            res.path.sub(%r{(^|/)([^/]*)\.([^/]*)$}, "\\1\\2/#{page_url}.\\3")
+          end
+        end
+      end
+
+      # Update the main sitemap resource list
+      # @return [void]
+      def manipulate_resource_list(resources)
+        new_resources = []
+
+        resources.each do |res|
+          next if res.ignored?
+
+          md = res.metadata
+          if md[:page]["pageable"]
+            # "articles" local variable is populated by Calendar and Tag page generators
+            # If it's not set then use the complete list of articles
+            # TODO: Some way to allow the frontmatter to specify the article filter?
+            articles = md[:locals]["articles"] || @app.blog.articles
+
+            # Allow blog.per_page and blog.page_link to be overridden in the frontmatter
+            per_page  = md[:page]["per_page"] || @app.blog.options.per_page
+            page_link = md[:page]["page_link"] || @app.blog.options.page_link
+
+            num_pages = (articles.length / per_page.to_f).ceil
+
+            # Add the pagination metadata to the base page (page 1)
+            res.add_metadata :locals => {
+              # Set a flag to allow templates to be used with and without pagination
+              'paginate' => true,
+
+              # Include the numbers, useful for displaying "Page X of Y"
+              'page_number' => 1,
+              'num_pages' => num_pages,
+              'per_page' => per_page,
+
+              # The range of article numbers on this page
+              # (1-based, for showing "Items X to Y of Z")
+              'page_start' => 1,
+              'page_end' => [per_page, articles.length].min,
+
+              # These contain the next and previous page.
+              # They are set to nil if there are no more pages.
+              # The nils are overwritten when the later pages are generated, below.
+              'next_page' => nil,
+              'prev_page' => nil,
+
+              # The list of articles for this page.
+              'page_articles' => articles[0..per_page-1],
+
+              # Include the articles so that non-proxied pages can use "articles" instead
+              # of "blog.articles" for consistency with the calendar and tag templates.
+              'articles' => articles
+            }
+
+            prev_page_res = res
+
+            # Create additional resources for the 2nd and subsequent pages.
+            (2..num_pages).each do |num|
+              p = ::Middleman::Sitemap::Resource.new(
+                @app.sitemap,
+                page_sub(res, num, page_link),
+                res.source_file
+              )
+
+              # Copy the metadata from the base page.
+              p.add_metadata md
+
+              # Copy the proxy state from the base page.
+              p.proxy_to(res.proxied_to) if res.proxy?
+
+              page_start = (num-1)*per_page
+              page_end   = (num*per_page)-1
+
+              # Add pagination metadata, meanings as above.
+              p.add_metadata :locals => {
+                'paginate' => true,
+                'page_number' => num,
+                'num_pages' => num_pages,
+                'per_page' => per_page,
+                'page_start' => page_start+1,
+                'page_end' => [page_end+1, articles.length].min,
+                'next_page' => nil,
+                'prev_page' => prev_page_res,
+                'page_articles' => articles[page_start..page_end],
+                'articles' => articles
+              }
+
+              # Add a reference in the previous page to this page
+              prev_page_res.add_metadata :locals => {
+                'next_page' => p
+              }
+
+              prev_page_res = p
+
+              new_resources << p
+            end
+          end
+        end
+
+        resources + new_resources
+      end
+    end
+  end
+end

data/lib/middleman-blog/tag_pages.rb

@@ -4,6 +4,17 @@ module Middleman
     # A sitemap plugin that adds tag pages to the sitemap
     # based on the tags of blog articles.
     class TagPages
+      class << self
+        # Get a path to the given tag, based on the :taglink setting.
+        # @param [Middleman::Application] app
+        # @param [String] tag
+        # @return [String]
+        def link(app, tag)
+          ::Middleman::Util.normalize_path(
+            app.blog.options.taglink.sub(':tag', tag.parameterize))
+        end
+      end
+
       def initialize(app)
         @app = app
       end
@@ -12,7 +23,7 @@ module Middleman
       # @return [void]
       def manipulate_resource_list(resources)
         resources + @app.blog.tags.map do |tag, articles|
-          path = Middleman::Util.normalize_path(@app.tag_path(tag))
+          path = TagPages.link(@app, tag)
           
           p = ::Middleman::Sitemap::Resource.new(
             @app.sitemap,
@@ -20,6 +31,14 @@ module Middleman
           )
           p.proxy_to(@app.blog.options.tag_template)
 
+          # Add metadata in local variables so it's accessible to
+          # later extensions
+          p.add_metadata :locals => {
+            'page_type' => 'tag',
+            'tagname' => tag,
+            'articles' => articles
+          }
+          # Add metadata in instance variables for backwards compatibility
           p.add_metadata do
             @tag = tag
             @articles = articles

data/lib/middleman-blog/template/config.tt

@@ -2,7 +2,10 @@
 # Blog settings
 ###
 
+# Time.zone = "UTC"
+
 activate :blog do |blog|
+  # blog.prefix = "blog"
   # blog.permalink = ":year/:month/:day/:title.html"
   # blog.sources = ":year-:month-:day-:title.html"
   # blog.taglink = "tags/:tag.html"
@@ -16,6 +19,10 @@ activate :blog do |blog|
 
   blog.tag_template = "tag.html"
   blog.calendar_template = "calendar.html"
+
+  # blog.paginate = true
+  # blog.per_page = 10
+  # blog.page_link = "page/:num"
 end
 
 page "/feed.xml", :layout => false
@@ -25,7 +32,7 @@ page "/feed.xml", :layout => false
 ###
 
 # Susy grids in Compass
-# First: gem install compass-susy-plugin
+# First: gem install susy
 # require 'susy'
 
 # Change Compass configuration

data/lib/middleman-blog/template/source/calendar.html.erb

@@ -1,15 +1,33 @@
+---
+pageable: true
+---
 <h1>Archive for
-  <% if @day %>
-    <%= Date.new(@year, @month, @day).strftime('%b %e %Y') %>
-  <% elsif @month %>
-    <%= Date.new(@year, @month, 1).strftime('%b %Y') %>
-  <% else %>
-    <%= @year %>
+  <% case page_type
+     when 'day' %>
+    <%= Date.new(year, month, day).strftime('%b %e %Y') %>
+  <% when 'month' %>
+    <%= Date.new(year, month, 1).strftime('%b %Y') %>
+  <% when 'year' %>
+    <%= year %>
   <% end %>
 </h1>
 
+<% if paginate %>
+  <p>Page <%= page_number %> of <%= num_pages %></p>
+
+  <% if prev_page %>
+    <p><%= link_to 'Previous page', prev_page %></p>
+  <% end %>
+<% end %>
+
 <ul>
-  <% @articles.each_with_index do |article, i| %>
-  <li><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e') %></span></li>
-   <% end %>
+  <% page_articles.each_with_index do |article, i| %>
+    <li><%= link_to article.title, article %> <span><%= article.date.strftime('%b %e') %></span></li>
+  <% end %>
 </ul>
+
+<% if paginate %>
+  <% if next_page %>
+    <p><%= link_to 'Next page', next_page %></p>
+  <% end %>
+<% end %>

data/lib/middleman-blog/template/source/index.html.erb

@@ -1,8 +1,22 @@
-<ul>
-  <% blog.articles[0...10].each do |article| %>
-  <li>
-    <h2><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e') %></span></h2>
-    <p><%= article.summary %></p>
-  </li>
+---
+pageable: true
+per_page: 10
+---
+<% if paginate %>
+  <p>Page <%= page_number %> of <%= num_pages %></p>
+
+  <% if prev_page %>
+    <p><%= link_to 'Previous page', prev_page %></p>
   <% end %>
-</ul>
+<% end %>
+
+<% page_articles.each_with_index do |article, i| %>
+  <h2><%= link_to article.title, article %> <span><%= article.date.strftime('%b %e') %></span></h2>
+  <p><%= article.summary %></p>
+<% end %>
+
+<% if paginate %>
+  <% if next_page %>
+    <p><%= link_to 'Next page', next_page %></p>
+  <% end %>
+<% end %>