RubyGems - middleman-blog - Versions diffs - 3.0.0 → 3.1.0 - Mend

middleman-blog 3.0.0 → 3.1.0

Files changed (93) hide show

data/fixtures/paginate-app/config-directory-indexes.rb ADDED Viewed

@@ -0,0 +1,11 @@
+activate :blog do |blog|
+  blog.sources           = "blog/:year-:month-:day-:title.html"
+  blog.permalink         = "blog/:year-:month-:day-:title.html"
+  blog.calendar_template = 'calendar.html'
+  blog.tag_template      = 'tag.html'
+  blog.paginate          = true
+  blog.per_page          = 5
+end
+require "middleman-more"
+activate :directory_indexes

data/fixtures/paginate-app/config-paginate-off.rb ADDED Viewed

@@ -0,0 +1,8 @@
+activate :blog do |blog|
+  blog.sources           = "blog/:year-:month-:day-:title.html"
+  blog.permalink         = "blog/:year-:month-:day-:title.html"
+  blog.calendar_template = 'calendar.html'
+  blog.tag_template      = 'tag.html'
+  #blog.paginate          = true
+  blog.per_page          = 5
+end

data/fixtures/paginate-app/config.rb ADDED Viewed

@@ -0,0 +1,8 @@
+activate :blog do |blog|
+  blog.sources           = "blog/:year-:month-:day-:title.html"
+  blog.permalink         = "blog/:year-:month-:day-:title.html"
+  blog.calendar_template = 'calendar.html'
+  blog.tag_template      = 'tag.html'
+  blog.paginate          = true
+  blog.per_page          = 5
+end

data/fixtures/paginate-app/source/blog/2011-01-01-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-01-01
+tags: foo
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-01-02-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-01-02
+tags: foo
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-01-03-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-01-03
+tags: bar
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-01-04-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-01-04
+tags: bar
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-01-05-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-01-05
+tags: bar
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-02-01-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-02-01
+tags: bar
+---
+Test Article Content

data/fixtures/paginate-app/source/blog/2011-02-02-test-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Test Article"
+date: 2011-02-02
+tags: bar
+---
+Test Article Content

data/fixtures/paginate-app/source/calendar.html.erb ADDED Viewed

@@ -0,0 +1,28 @@
+---
+pageable: true
+---
+Year: '<%= year %>'
+Month: '<%= month if defined?(month) %>'
+Day: '<%= day if defined?(day) %>'
+Paginate: <%= paginate %>
+Article Count: <%= page_articles.size %>
+<% if paginate %>
+Page Num: <%= page_number %>
+Num Pages: <%= num_pages %>
+Per Page: <%= per_page %>
+Page Start: <%= page_start %>
+Page End: <%= page_end %>
+Next Page: '<%= next_page.url if next_page %>'
+Prev Page: '<%= prev_page.url if prev_page %>'
+<% end %>
+<% page_articles.each_with_index do |article, i| %>
+  <article class="<%= (i == 0) ? 'first' : '' %>">
+    <h1><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e %Y') %></span></h1>
+    <%= article.summary %>
+    <div class="more"><a href="<%= article.url %>">read on &raquo;</a></div>
+  </article>
+<% end %>

data/fixtures/paginate-app/source/index.html.erb ADDED Viewed

@@ -0,0 +1,19 @@
+---
+pageable: true
+---
+Paginate: <%= paginate %>
+Article Count: <%= page_articles.size %>
+<% if paginate %>
+Page Num: <%= page_number %>
+Num Pages: <%= num_pages %>
+Per Page: <%= per_page %>
+Page Start: <%= page_start %>
+Page End: <%= page_end %>
+Next Page: '<%= next_page.url if next_page %>'
+Prev Page: '<%= prev_page.url if prev_page %>'
+<% end %>
+<% page_articles.each do |article| %>
+  <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+<% end %>

data/fixtures/paginate-app/source/layout.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+  <head>
+  </head>
+  <body>
+    <% if is_blog_article? %>
+      <%= yield %>
+      Url: <%= current_article.url %>
+      Previous: <%= current_article.previous_article.try(:url) %>
+      Next: <%= current_article.next_article.try(:url) %>
+    <% else %>
+      <%= yield %>
+    <% end %>
+  </body>
+</html>

data/fixtures/paginate-app/source/tag.html.erb ADDED Viewed

@@ -0,0 +1,23 @@
+---
+pageable: true
+per_page: 2
+---
+Tag: <%= tagname %>
+Paginate: <%= paginate %>
+Article Count: <%= page_articles.size %>
+<% if paginate %>
+Page Num: <%= page_number %>
+Num Pages: <%= num_pages %>
+Per Page: <%= per_page %>
+Page Start: <%= page_start %>
+Page End: <%= page_end %>
+Next Page: '<%= next_page.url if next_page %>'
+Prev Page: '<%= prev_page.url if prev_page %>'
+<% end %>
+<% if page_articles %>
+  <% page_articles.each do |article| %>
+    <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+  <% end %>
+<% end %>

data/fixtures/published-app/config.rb ADDED Viewed

@@ -0,0 +1,3 @@
+activate :blog do |blog|
+  blog.sources = "blog/:year-:month-:day-:title.html"
+end

data/fixtures/published-app/source/_article_template.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= current_article.url %>

data/fixtures/published-app/source/blog/2011-01-01-new-article.html.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+---
+title: "Newer Article"
+date: 2011-01-01
+---
+Newer Article Content

data/fixtures/published-app/source/blog/2012-06-19-draft-article.html.markdown ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: "Draft Article"
+date: 2012-06-19
+published: false
+---
+This is a draft

data/fixtures/published-app/source/blog/2012-06-19-draft-article/example.txt ADDED Viewed

	@@ -0,0 +1 @@
1	+ Example Text

data/fixtures/published-app/source/index.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<% blog.articles[0...5].each_with_index do |article, i| %>
+  <article class="<%= (i == 0) ? 'first' : '' %>">
+    <h1><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e %Y') %></span></h1>
+    <%= article.summary %>
+    <div class="more"><a href="<%= article.url %>">read on &raquo;</a></div>
+  </article>
+<% end %>

data/fixtures/published-app/source/layout.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<!doctype html>
+<html>
+  <head>
+  </head>
+  <body>
+    <% if is_blog_article? %>
+      <%= yield %>
+      <%= current_article.url %>
+    <% else %>
+      <%= yield %>
+    <% end %>
+  </body>
+</html>

data/fixtures/tags-app/config-directory-indexes.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require "middleman-blog"
+activate :blog do |blog|
+  blog.sources      = "blog/:year-:month-:day-:title.html"
+  blog.permalink    = "blog/:year-:month-:day-:title.html"
+  blog.tag_template = "/tag.html"
+end
+require "middleman-more"
+activate :directory_indexes

data/fixtures/tags-app/source/index.html.erb CHANGED Viewed

@@ -1,3 +1,5 @@
  <% blog.articles[0...12].each do |article| %>
       <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
     <% end %>
+Tag Path: '<%= tag_path("foo") %>'

data/fixtures/tags-app/source/tag.html.erb CHANGED Viewed

@@ -1,7 +1,7 @@
-Tag: <%= @tag %>
+Tag: <%= tagname %>
-<% if @articles %>
-  <% @articles[0...12].each do |article| %>
+<% if articles %>
+  <% articles[0...12].each do |article| %>
     <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
   <% end %>
 <% end %>

data/lib/middleman-blog/blog_article.rb CHANGED Viewed

@@ -1,17 +1,22 @@
-require 'date'
+require 'active_support/core_ext/time/calculations'
+# Default to UTC
+Time.zone = "UTC" if Time.zone.nil?
 module Middleman
   module Blog
     # A module that adds blog-article methods to Resources.
     module BlogArticle
-      # The "slug" of the article that shows up in its URL.
-      # @return [String]
-      attr_accessor :slug
       # Render this resource
       # @return [String]
       def render(opts={}, locs={}, &block)
-        opts[:layout] = app.blog.options.layout if opts[:layout].nil?
+        if opts[:layout].nil?
+          if metadata[:options] && !metadata[:options][:layout].nil?
+            opts[:layout] = metadata[:options][:layout]
+          end
+          opts[:layout] = app.blog.options.layout if opts[:layout].nil?
+          opts[:layout] = opts[:layout].to_s if opts[:layout].is_a? Symbol
+        end
         content = super(opts, locs, &block)
@@ -30,6 +35,12 @@ module Middleman
         data["title"]
       end
+      # Whether or not this article has been published
+      # @return [Boolean]
+      def published?
+        data["published"] != false and date <= Time.current
+      end
       # The body of this article, in HTML. This is for
       # things like RSS feeds or lists of articles - individual
       # articles will automatically be rendered from their
@@ -46,12 +57,26 @@ module Middleman
       # @return [String]
       def summary
         @_summary ||= begin
-          all_content = render(:layout => false, :keep_separator => true)
-          if all_content =~ app.blog.options.summary_separator
-            all_content.split(app.blog.options.summary_separator).first
-          else
-            all_content.match(/(.{1,#{app.blog.options.summary_length}}.*?)(\n|\Z)/m).to_s
-          end
+          source = app.template_data_for_file(source_file).dup
+          summary_source = if app.blog.options.summary_generator
+                             app.blog.options.summary_generator.call(self, source)
+                           else
+                             default_summary_generator(source)
+                           end
+          md   = metadata.dup
+          locs = md[:locals]
+          opts = md[:options].merge({:template_body => summary_source})
+          app.render_individual_file(source_file, locs, opts)
+        end
+      end
+      def default_summary_generator(source)
+        if source =~ app.blog.options.summary_separator
+          source.split(app.blog.options.summary_separator).first
+        else
+          source.match(/(.{1,#{app.blog.options.summary_length}}.*?)(\n|\Z)/m).to_s
         end
       end
@@ -67,22 +92,31 @@ module Middleman
         end
       end
+      # Retrieve a section of the source path
+      # @param [String] The part of the path, e.g. "year", "month", "day", "title"
+      # @return [String]
+      def path_part(part)
+        @_path_parts ||= app.blog.path_matcher.match(path).captures
+        @_path_parts[app.blog.matcher_indexes[part]]
+      end
       # Attempt to figure out the date of the post. The date should be
       # present in the source path, but users may also provide a date
       # in the frontmatter in order to provide a time of day for sorting
       # reasons.
       #
-      # @return [DateTime]
+      # @return [TimeWithZone]
       def date
         return @_date if @_date
         frontmatter_date = data["date"]
         # First get the date from frontmatter
-        if frontmatter_date.is_a?(String)
-          @_date = DateTime.parse(frontmatter_date)
+        if frontmatter_date.is_a? Time
+          @_date = frontmatter_date.in_time_zone
         else
-          @_date = frontmatter_date
+          @_date = Time.zone.parse(frontmatter_date.to_s)
         end
         # Next figure out the date from the filename
@@ -90,13 +124,11 @@ module Middleman
             app.blog.options.sources.include?(":month") &&
             app.blog.options.sources.include?(":day")
-          date_parts = @app.blog.path_matcher.match(path).captures
-          filename_date = Date.new(date_parts[0].to_i, date_parts[1].to_i, date_parts[2].to_i)
+          filename_date = Time.zone.local(path_part("year").to_i, path_part("month").to_i, path_part("day").to_i)
           if @_date
-            raise "The date in #{path}'s filename doesn't match the date in its frontmatter" unless @_date.to_date == filename_date
+            raise "The date in #{path}'s filename doesn't match the date in its frontmatter" unless @_date.to_date == filename_date.to_date
           else
-            @_date = filename_date.to_datetime
+            @_date = filename_date.to_time.in_time_zone
           end
         end
@@ -105,6 +137,12 @@ module Middleman
         @_date
       end
+      # The "slug" of the article that shows up in its URL.
+      # @return [String]
+      def slug
+        @_slug ||= path_part("title")
+      end
       # The previous (chronologically earlier) article before this one
       # or nil if this is the first article.
       # @return [Middleman::Sitemap::Resource]

data/lib/middleman-blog/blog_data.rb CHANGED Viewed

@@ -8,6 +8,10 @@ module Middleman
       # @return [Regex]
       attr_reader :path_matcher
+      # A hash of indexes into the path_matcher captures
+      # @return [Hash]
+      attr_reader :matcher_indexes
       # The configured options for this blog
       # @return [Thor::CoreExt::HashWithIndifferentAccess]
       attr_reader :options
@@ -25,17 +29,27 @@ module Middleman
             sub(":year",  "(\\d{4})").
             sub(":month", "(\\d{2})").
             sub(":day",   "(\\d{2})").
-            sub(":title", "(.*)")
+            sub(":title", "([^/]+)")
+        subdir_matcher = matcher.sub(/\\\.[^.]+$/, "(/.*)$")
         @path_matcher = /^#{matcher}/
+        @subdir_matcher = /^#{subdir_matcher}/
+        # Build a hash of part name to capture index, e.g. {"year" => 0}
+        @matcher_indexes = {}
+        options.sources.scan(/:year|:month|:day|:title/).
+          each_with_index do |key, i|
+            @matcher_indexes[key[1..-1]] = i
+          end
+        # The path always appears at the end.
+        @matcher_indexes["path"] = @matcher_indexes.size
       end
-      # A list of all blog articles, sorted by date
+      # A list of all blog articles, sorted by descending date
       # @return [Array<Middleman::Sitemap::Resource>]
       def articles
-        @_articles.sort do |a,b|
-          b.date <=> a.date
-        end
+        @_articles.sort_by(&:date).reverse
       end
       # The BlogArticle for the given path, or nil if one doesn't exist.
@@ -61,6 +75,10 @@ module Middleman
           end
         end
+        tags.each do |tag, articles|
+          tags[tag] = articles.sort_by(&:date).reverse
+        end
         tags
       end
@@ -69,12 +87,15 @@ module Middleman
       # @return [void]
       def manipulate_resource_list(resources)
         @_articles = []
+        used_resources = []
         resources.each do |resource|
           if resource.path =~ path_matcher
             resource.extend BlogArticle
-            resource.slug = $4
+            # Skip articles that are not published (in non-development environments)
+            next unless @app.environment == :development || resource.published?
             # compute output path:
             #   substitute date parts to path pattern
             resource.destination_path = options.permalink.
@@ -86,8 +107,39 @@ module Middleman
             resource.destination_path = Middleman::Util.normalize_path(resource.destination_path)
             @_articles << resource
+          elsif resource.path =~ @subdir_matcher
+            match = $~.captures
+            article_path = options.sources.
+              sub(':year', match[@matcher_indexes["year"]]).
+              sub(':month', match[@matcher_indexes["month"]]).
+              sub(':day', match[@matcher_indexes["day"]]).
+              sub(':title', match[@matcher_indexes["title"]])
+            article = @app.sitemap.find_resource_by_path(article_path)
+            raise "Article for #{resource.path} not found" if article.nil?
+            article.extend BlogArticle
+            # Skip files that belong to articles that are not published (in non-development environments)
+            next unless @app.environment == :development || article.published?
+            # The subdir path is the article path with the index file name
+            # or file extension stripped off.
+            resource.destination_path = options.permalink.
+              sub(':year', article.date.year.to_s).
+              sub(':month', article.date.month.to_s.rjust(2,'0')).
+              sub(':day', article.date.day.to_s.rjust(2,'0')).
+              sub(':title', article.slug).
+              sub(/(\/#{@app.index_file}$)|(\.[^.]+$)|(\/$)/, match[@matcher_indexes["path"]])
+            resource.destination_path = Middleman::Util.normalize_path(resource.destination_path)
           end
+          used_resources << resource
         end
+        used_resources
       end
     end
   end