RubyGems - middleman-blog - Versions diffs - 3.3.0 → 3.4.1 - Mend

middleman-blog 3.3.0 → 3.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

data/fixtures/custom-collections-multiblog-app/source/index.html.erb ADDED Viewed

@@ -0,0 +1,8 @@
+ <% blog(:blog_name_1).articles[0...12].each do |article| %>
+      <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+    <% end %>
+ <% blog(:blog_name_2).articles[0...12].each do |article| %>
+      <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+    <% end %>
+Category Path1: '<%= category_path("ruby-on-rails", :blog_name_1) %>'
+Category Path2: '<%= category_path("javascript", :blog_name_2) %>'

data/fixtures/custom-collections-multiblog-app/source/layout.erb ADDED Viewed

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

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

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

data/fixtures/custom-permalinks-app/config.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require "middleman-blog"
+activate :blog do |blog|
+  blog.sources      = "blog/:year-:month-:day-:title.html"
+  blog.permalink    = "blog/:category/:title.html"
+end

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

@@ -0,0 +1,7 @@
+---
+title: "Newer Article"
+date: 2011-01-01
+category: ruby-on-rails
+---
+Newer Article Content

data/fixtures/custom-permalinks-app/source/blog/2011-01-02-another-article.html.markdown ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: "Another Article"
+date: 2011-01-02
+category: html5
+---
+Another Article Content

data/fixtures/custom-permalinks-app/source/blog/2011-01-03-third-article.html.markdown ADDED Viewed

@@ -0,0 +1,7 @@
+---
+title: "Parameterize me"
+date: 2011-01-03
+category: Ruby on Rails
+---
+Another Article Content

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

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

data/fixtures/custom-permalinks-app/source/layout.erb ADDED Viewed

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

data/fixtures/indexes-app/config.rb CHANGED Viewed

@@ -2,5 +2,4 @@ activate :blog do |blog|
   blog.sources = ":year/:month/:day/:title.html"
 end
-require "middleman-more"
 activate :directory_indexes

data/fixtures/layouts-app/config.rb CHANGED Viewed

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

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

@@ -1,7 +1,5 @@
-<p>Default blog length: <%= blog.articles.length %></p>
 <p>blog_number_1 length: <%= blog(:blog_number_1).articles.length %></p>
 <p>blog_number_1 title: <%= blog(:blog_number_1).articles[0].data.title %></p>
 <p>blog_number_2 length: <%= blog("blog_number_2").articles.length %></p>
-<p>blog_number_2 title: <%= blog("blog_number_2").articles[0].data.title %></p>
+<p>blog_number_2 title: <%= blog("blog_number_2").articles[0].data.title %></p>

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

@@ -7,5 +7,4 @@ activate :blog do |blog|
   blog.per_page          = 5
 end
-require "middleman-more"
 activate :directory_indexes

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

@@ -5,5 +5,4 @@ activate :blog do |blog|
   blog.tag_template = "/tag.html"
 end
-require "middleman-more"
 activate :directory_indexes

data/fixtures/tags-app/config.rb CHANGED Viewed

@@ -3,4 +3,4 @@ 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
+end

data/fixtures/tags-multiblog-app/config.rb CHANGED Viewed

@@ -12,4 +12,4 @@ activate :blog do |blog|
   blog.sources      = ":year-:month-:day-:title.html"
   blog.permalink    = ":year-:month-:day-:title.html"
   blog.tag_template = "tag2.html"
-end
+end

data/fixtures/tags-multiblog-app/source/blog1/frontmatter_blog_tags.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+---
+blog: blog_name_1
+---
+<% blog().tags.each do |tag, articles| %>
+  <section>
+    <h2><%= tag %> (<%= articles.size %>)</h2>
+  </section>
+<% end %>

data/fixtures/tags-multiblog-app/source/blog1/named_blog_tags.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<% blog("blog_name_1").tags.each do |tag, articles| %>
+  <section>
+    <h2><%= tag %> (<%= articles.size %>)</h2>
+  </section>
+<% end %>

data/fixtures/tags-multiblog-app/source/blog2/frontmatter_blog_tags.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+---
+blog: blog_name_2
+---
+<% blog().tags.each do |tag, articles| %>
+  <section>
+    <h2><%= tag %> (<%= articles.size %>)</h2>
+  </section>
+<% end %>

data/fixtures/tags-multiblog-app/source/blog2/named_blog_tags.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<% blog("blog_name_2").tags.each do |tag, articles| %>
+  <section>
+    <h2><%= tag %> (<%= articles.size %>)</h2>
+  </section>
+<% end %>

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

@@ -129,7 +129,6 @@ module Middleman
       # @return [String]
       def path_part(part)
         @_path_parts ||= blog_data.path_matcher.match(path).captures
         @_path_parts[blog_data.matcher_indexes[part]]
       end
@@ -176,8 +175,10 @@ module Middleman
         @_slug ||= if blog_options.sources.include?(":title")
           path_part("title")
-        else
+        elsif title
           title.parameterize
+        else
+          raise "Can't generate a slug for #{path} because it has no :title in its path pattern or title/slug in its frontmatter."
         end
       end
@@ -194,6 +195,10 @@ module Middleman
       def next_article
         blog_data.articles.reverse.find {|a| a.date > self.date }
       end
+      def inspect
+        "#<Middleman::Blog::BlogArticle: #{data.inspect}>"
+      end
     end
   end
 end

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

@@ -7,7 +7,7 @@ module Middleman
       # A regex for matching blog article source paths
       # @return [Regex]
       attr_reader :path_matcher
       # A hash of indexes into the path_matcher captures
       # @return [Hash]
       attr_reader :matcher_indexes
@@ -18,6 +18,8 @@ module Middleman
       attr_reader :controller
+      DEFAULT_PERMALINK_COMPONENTS = [:year, :month, :day, :title]
       # @private
       def initialize(app, options={}, controller=nil)
         @app = app
@@ -26,7 +28,7 @@ module Middleman
         # A list of resources corresponding to blog articles
         @_articles = []
         matcher = Regexp.escape(options.sources).
             sub(/^\//, "").
             gsub(":year",  "(\\d{4})").
@@ -105,24 +107,17 @@ module Middleman
             # compute output path:
             #   substitute date parts to path pattern
-            resource.destination_path = options.permalink.
-              sub(':year', resource.date.year.to_s).
-              sub(':month', resource.date.month.to_s.rjust(2,'0')).
-              sub(':day', resource.date.day.to_s.rjust(2,'0')).
-              sub(':title', resource.slug)
-            resource.destination_path = Middleman::Util.normalize_path(resource.destination_path)
+            resource.destination_path = Middleman::Util.normalize_path parse_permalink_options(resource)
             @_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_path = options.sources
+            %w(year month day title).each do |token|
+              article_path = article_path.sub(":#{token}", match[@matcher_indexes[token]]) if @matcher_indexes[token]
+            end
             article = @app.sitemap.find_resource_by_path(article_path)
             raise "Article for #{resource.path} not found" if article.nil?
@@ -133,11 +128,7 @@ module Middleman
             # 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).
+            resource.destination_path = parse_permalink_options(article).
               sub(/(\/#{@app.index_file}$)|(\.[^.]+$)|(\/$)/, match[@matcher_indexes["path"]])
             resource.destination_path = Middleman::Util.normalize_path(resource.destination_path)
@@ -145,9 +136,35 @@ module Middleman
           used_resources << resource
         end
         used_resources
       end
+      def parse_permalink_options(resource)
+        permalink = options.permalink.
+          sub(':year', resource.date.year.to_s).
+          sub(':month', resource.date.month.to_s.rjust(2, '0')).
+          sub(':day', resource.date.day.to_s.rjust(2, '0')).
+          sub(':title', resource.slug)
+        custom_permalink_components.each do |component|
+          permalink = permalink.sub(":#{component}", resource.data[component].parameterize)
+        end
+        permalink
+      end
+      def custom_permalink_components
+        permalink_url_components.reject { |component| DEFAULT_PERMALINK_COMPONENTS.include? component.to_sym }
+      end
+      def permalink_url_components
+        options.permalink.scan(/:([A-Za-z0-9]+)/).flatten
+      end
+      def inspect
+        "#<Middleman::Blog::BlogData: #{articles.inspect}>"
+      end
     end
   end
 end

data/lib/middleman-blog/custom_pages.rb ADDED Viewed

@@ -0,0 +1,85 @@
+module Middleman
+  module Blog
+    class CustomPages
+      class << self
+        # Return a path to the given property / value pair
+        #
+        # @param [Hash] blog_options
+        # @param [String|Symbol] property Frontmatter property used to collect on
+        # @param [String| value Frontmatter value for the given article for the given property
+        def link(blog_options, property, value)
+          link_template = blog_options.custom_collections[property][:link]
+          ::Middleman::Util.normalize_path(link_template.sub(":#{property}", value.parameterize))
+        end
+      end
+      attr_reader :property, :app, :blog_controller
+      def initialize(property, app, controller = nil)
+        @property        = property
+        @app             = app
+        @blog_controller = controller
+      end
+      def blog_data
+        if blog_controller
+          blog_controller.data
+        else
+          app.blog
+        end
+      end
+      def blog_options
+        if blog_controller
+          blog_controller.options
+        else
+          app.blog.options
+        end
+      end
+      def articles
+        blog_data.articles
+      end
+      def manipulate_resource_list(resources)
+        new_resources = []
+        articles.group_by { |a| a.data[property] }.each do |property_value, property_articles|
+          path = CustomPages.link(blog_options, property, property_value)
+          new_resources << build_resource(path, property_value, property_articles)
+        end
+        resources + new_resources
+      end
+      def build_resource(path, value, property_articles)
+        p = ::Middleman::Sitemap::Resource.new(app.sitemap, path)
+        p.proxy_to(template_for_page)
+        p.add_metadata :locals => {
+          "page_type"       => property,
+          "#{property}"     => value,
+          "articles"        => property_articles,
+          "blog_controller" => blog_controller
+        }
+        prop_name = property
+        p.add_metadata do
+          instance_variable_set("@#{prop_name}", value)
+          @articles = property_articles
+        end
+        p
+      end
+      def template_for_page
+        blog_options.custom_collections[property][:template]
+      end
+    end
+  end
+end

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

@@ -22,7 +22,8 @@ module Middleman
               :paginate,
               :per_page,
               :page_link,
-              :publish_future_dated
+              :publish_future_dated,
+              :custom_collections
              ]
       KEYS.each do |name|
@@ -61,6 +62,7 @@ module Middleman
         options.per_page             ||= 10
         options.page_link            ||= "page/:num"
         options.publish_future_dated ||= false
+        options.custom_collections   ||= {}
         # optional: :tag_template
         # optional: :year_template
@@ -82,6 +84,10 @@ module Middleman
           options.year_link = File.join(options.prefix, options.year_link)
           options.month_link = File.join(options.prefix, options.month_link)
           options.day_link = File.join(options.prefix, options.day_link)
+          options.custom_collections.each do |key, opts|
+            opts[:link] = File.join(options.prefix, opts[:link])
+          end
         end
         app.after_configuration do
@@ -141,6 +147,27 @@ module Middleman
                                                        false
                                                        )
           end
+          if options.custom_collections
+            require 'middleman-blog/custom_pages'
+            options.custom_collections.each do |property, options|
+              ignore options[:template]
+              sitemap.register_resource_list_manipulator(
+                                                          :"blog_#{property}",
+                                                          CustomPages.new(property, self),
+                                                          false
+                                                          )
+              m = Module.new
+              m.module_eval(%Q{
+                def #{property}_path(value, key = nil)
+                  sitemap.find_resource_by_path(CustomPages.link(self.blog.options, :#{property}, value)).try(:url)
+                end
+              })
+              self.class.send(:include, m)
+            end
+          end
         end
       end
       alias :included :registered