middleman-blog 3.3.0 → 3.4.1

data/lib/middleman-blog/extension_3_1.rb

@@ -24,6 +24,7 @@ module Middleman
     option :per_page, 10, 'Articles per page when paginating'
     option :page_link, "page/:num", 'HTTP path for paging'
     option :publish_future_dated, false, 'Whether to pubish articles dated in the future'
+    option :custom_collections, {}, 'Hash of custom frontmatter properties to collect articles on and their options'
 
     attr_accessor :data, :uid
 
@@ -58,6 +59,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
     end
 
@@ -120,6 +125,58 @@ module Middleman
           false
         )
       end
+
+      if options.custom_collections
+        require 'middleman-blog/custom_pages'
+        register_custom_pages
+      end
+    end
+
+    # Register any custom page collections that may be set in the config
+    #
+    # A custom resource list manipulator will be generated for each key in the
+    # custom collections hash.
+    #
+    # The following will collect posts on the "category" frontmatter property:
+    #   ```
+    #   activate :blog do |blog|
+    #     blog.custom_collections = {
+    #       link: "/categories/:category.html",
+    #       template: "/category.html"
+    #     }
+    #   end
+    #   ```
+    #
+    # Category pages in the example above will use the category.html as a template file
+    # and it will be ignored when building.
+    def register_custom_pages
+      options.custom_collections.each do |property, options|
+        @app.ignore options[:template]
+        @app.sitemap.register_resource_list_manipulator(
+          :"blog_#{uid}_#{property}",
+          ::Middleman::Blog::CustomPages.new(property, @app, self),
+          false
+        )
+
+        generate_custom_helper(property)
+      end
+    end
+
+    # Generate helpers to access the path to a custom collection.
+    #
+    # For example, when using a custom property called "category" to collect articles on
+    # the method **category_path** will be generated.
+    #
+    # @param [Symbol] custom_property Custom property which is being used to collect articles on
+    def generate_custom_helper(custom_property)
+      m = Module.new
+      m.module_eval(%Q{
+        def #{custom_property}_path(value, key = nil)
+          sitemap.find_resource_by_path(::Middleman::Blog::CustomPages.link(blog_controller(key).options, :#{custom_property}, value)).try(:url)
+        end
+      })
+
+      app.class.send(:include, m)
     end
 
     # Helpers for use within templates and layouts.
@@ -129,7 +186,20 @@ module Middleman
       end
 
       def blog_controller(key=nil)
-        key ||= (current_resource && current_resource.metadata[:page]["blog"]) || blog_instances.keys.first
+        if !key && current_resource
+          key = current_resource.metadata[:page]["blog"]
+
+          if !key && current_resource.respond_to?(:blog_controller) && current_resource.blog_controller
+            return current_resource.blog_controller
+          end
+        end
+
+        # In multiblog situations, force people to specify the blog
+        if !key && blog_instances.size > 1
+          raise "You must either specify the blog name in calling this method or in your page frontmatter (using the 'blog' key)"
+        end
+
+        key ||= blog_instances.keys.first
         blog_instances[key.to_sym]
       end
 

data/lib/middleman-blog/paginator.rb

@@ -49,11 +49,11 @@ module Middleman
 
         resources.each do |res|
           next if res.ignored?
-          
+
           md = res.metadata
 
           # Skip other blogs' resources
-          res_controller = md[:locals]["blog_controller"] || res.blog_controller
+          res_controller = md[:locals]["blog_controller"] || (res.respond_to?(:blog_controller) && res.blog_controller)
           next if @blog_controller && res_controller && (res_controller != @blog_controller)
           override_controller = md[:page]["blog"]
           next if @blog_controller && override_controller && override_controller != @blog_controller.uid

data/lib/middleman-blog/template/source/feed.xml.builder

@@ -6,7 +6,7 @@ xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
   xml.id URI.join(site_url, blog.options.prefix.to_s)
   xml.link "href" => URI.join(site_url, blog.options.prefix.to_s)
   xml.link "href" => URI.join(site_url, current_page.path), "rel" => "self"
-  xml.updated blog.articles.first.date.to_time.iso8601
+  xml.updated(blog.articles.first.date.to_time.iso8601) unless blog.articles.empty?
   xml.author { xml.name "Blog Author" }
 
   blog.articles[0..5].each do |article|

data/lib/middleman-blog/template/source/layout.erb

@@ -3,6 +3,7 @@
   <head>
     <meta charset="utf-8" />
     <meta http-equiv='X-UA-Compatible' content='IE=edge;chrome=1' />
+    <title>Blog Title<%= ' - ' + current_article.title unless current_article.nil? %></title>
   </head>
   <body>
     

data/lib/middleman-blog/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Blog
-    VERSION = "3.3.0"
+    VERSION = "3.4.1"
   end
 end

data/middleman-blog.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\0")
   s.test_files = `git ls-files -z -- {fixtures,features}/*`.split("\0")
   s.require_paths = ["lib"]
-  s.add_dependency("middleman-core", ["~> 3.0"])
-  s.add_dependency("middleman-more", ["~> 3.0"])
+  s.add_dependency("middleman-core", ["~> 3.2"])
   s.add_dependency("tzinfo", ["~> 0.3.0"])
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.1
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-08 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -17,28 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: middleman-more
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +64,9 @@ files:
 - features/calendar-and-tag.feature
 - features/calendar.feature
 - features/calendar_multiblog.feature
+- features/custom_collections.feature
+- features/custom_collections_multiblog.feature
+- features/custom_permalinks_feature.feature
 - features/directory_indexes.feature
 - features/filename_date.feature
 - features/future_date.feature
@@ -129,6 +118,30 @@ files:
 - fixtures/calendar-multiblog-app/source/calendar2.html.erb
 - fixtures/calendar-multiblog-app/source/index.html.erb
 - fixtures/calendar-multiblog-app/source/layout.erb
+- fixtures/custom-collections-app/config-blog-prefix.rb
+- fixtures/custom-collections-app/config-directory-indexes.rb
+- fixtures/custom-collections-app/config.rb
+- fixtures/custom-collections-app/source/blog/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-app/source/blog/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-app/source/category.html.erb
+- fixtures/custom-collections-app/source/index.html.erb
+- fixtures/custom-collections-app/source/layout.erb
+- fixtures/custom-collections-multiblog-app/config.rb
+- fixtures/custom-collections-multiblog-app/source/blog1/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog1/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog2/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog2/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/category1.html.erb
+- fixtures/custom-collections-multiblog-app/source/category2.html.erb
+- fixtures/custom-collections-multiblog-app/source/index.html.erb
+- fixtures/custom-collections-multiblog-app/source/layout.erb
+- fixtures/custom-permalinks-app/config-directory-indexes.rb
+- fixtures/custom-permalinks-app/config.rb
+- fixtures/custom-permalinks-app/source/blog/2011-01-01-new-article.html.markdown
+- fixtures/custom-permalinks-app/source/blog/2011-01-02-another-article.html.markdown
+- fixtures/custom-permalinks-app/source/blog/2011-01-03-third-article.html.markdown
+- fixtures/custom-permalinks-app/source/index.html.erb
+- fixtures/custom-permalinks-app/source/layout.erb
 - fixtures/default-template-app/Gemfile
 - fixtures/default-template-app/config.rb
 - fixtures/default-template-app/source/2013-04-01-new-article.html.markdown
@@ -252,8 +265,12 @@ files:
 - fixtures/tags-multiblog-app/config.rb
 - fixtures/tags-multiblog-app/source/blog1/2011-01-01-new-article.html.markdown
 - fixtures/tags-multiblog-app/source/blog1/2011-01-02-another-article.html.markdown
+- fixtures/tags-multiblog-app/source/blog1/frontmatter_blog_tags.html.erb
+- fixtures/tags-multiblog-app/source/blog1/named_blog_tags.html.erb
 - fixtures/tags-multiblog-app/source/blog2/2011-01-01-new-article.html.markdown
 - fixtures/tags-multiblog-app/source/blog2/2011-01-02-another-article.html.markdown
+- fixtures/tags-multiblog-app/source/blog2/frontmatter_blog_tags.html.erb
+- fixtures/tags-multiblog-app/source/blog2/named_blog_tags.html.erb
 - fixtures/tags-multiblog-app/source/index.html.erb
 - fixtures/tags-multiblog-app/source/layout.erb
 - fixtures/tags-multiblog-app/source/tag1.html.erb
@@ -266,6 +283,7 @@ files:
 - lib/middleman-blog/calendar_pages.rb
 - lib/middleman-blog/commands/article.rb
 - lib/middleman-blog/commands/article.tt
+- lib/middleman-blog/custom_pages.rb
 - lib/middleman-blog/extension_3_0.rb
 - lib/middleman-blog/extension_3_1.rb
 - lib/middleman-blog/paginator.rb
@@ -314,6 +332,9 @@ test_files:
 - features/calendar-and-tag.feature
 - features/calendar.feature
 - features/calendar_multiblog.feature
+- features/custom_collections.feature
+- features/custom_collections_multiblog.feature
+- features/custom_permalinks_feature.feature
 - features/directory_indexes.feature
 - features/filename_date.feature
 - features/future_date.feature
@@ -365,6 +386,30 @@ test_files:
 - fixtures/calendar-multiblog-app/source/calendar2.html.erb
 - fixtures/calendar-multiblog-app/source/index.html.erb
 - fixtures/calendar-multiblog-app/source/layout.erb
+- fixtures/custom-collections-app/config-blog-prefix.rb
+- fixtures/custom-collections-app/config-directory-indexes.rb
+- fixtures/custom-collections-app/config.rb
+- fixtures/custom-collections-app/source/blog/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-app/source/blog/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-app/source/category.html.erb
+- fixtures/custom-collections-app/source/index.html.erb
+- fixtures/custom-collections-app/source/layout.erb
+- fixtures/custom-collections-multiblog-app/config.rb
+- fixtures/custom-collections-multiblog-app/source/blog1/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog1/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog2/2011-01-01-new-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/blog2/2011-01-02-another-article.html.markdown
+- fixtures/custom-collections-multiblog-app/source/category1.html.erb
+- fixtures/custom-collections-multiblog-app/source/category2.html.erb
+- fixtures/custom-collections-multiblog-app/source/index.html.erb
+- fixtures/custom-collections-multiblog-app/source/layout.erb
+- fixtures/custom-permalinks-app/config-directory-indexes.rb
+- fixtures/custom-permalinks-app/config.rb
+- fixtures/custom-permalinks-app/source/blog/2011-01-01-new-article.html.markdown
+- fixtures/custom-permalinks-app/source/blog/2011-01-02-another-article.html.markdown
+- fixtures/custom-permalinks-app/source/blog/2011-01-03-third-article.html.markdown
+- fixtures/custom-permalinks-app/source/index.html.erb
+- fixtures/custom-permalinks-app/source/layout.erb
 - fixtures/default-template-app/Gemfile
 - fixtures/default-template-app/config.rb
 - fixtures/default-template-app/source/2013-04-01-new-article.html.markdown
@@ -488,8 +533,12 @@ test_files:
 - fixtures/tags-multiblog-app/config.rb
 - fixtures/tags-multiblog-app/source/blog1/2011-01-01-new-article.html.markdown
 - fixtures/tags-multiblog-app/source/blog1/2011-01-02-another-article.html.markdown
+- fixtures/tags-multiblog-app/source/blog1/frontmatter_blog_tags.html.erb
+- fixtures/tags-multiblog-app/source/blog1/named_blog_tags.html.erb
 - fixtures/tags-multiblog-app/source/blog2/2011-01-01-new-article.html.markdown
 - fixtures/tags-multiblog-app/source/blog2/2011-01-02-another-article.html.markdown
+- fixtures/tags-multiblog-app/source/blog2/frontmatter_blog_tags.html.erb
+- fixtures/tags-multiblog-app/source/blog2/named_blog_tags.html.erb
 - fixtures/tags-multiblog-app/source/index.html.erb
 - fixtures/tags-multiblog-app/source/layout.erb
 - fixtures/tags-multiblog-app/source/tag1.html.erb