middleman-blog 4.0.3 → 4.2.0

data/fixtures/alias-prefix-app/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+activate :blog do |blog|
+  blog.prefix = 'blog'
+  blog.sources = ':year-:month-:day-:title.html'
+  blog.permalink = ':year/:month/:day/:title.html'
+  blog.aliases = [
+    ':year-:month-:day-:title.html',
+    'archive/:year/:title'
+  ]
+end

data/fixtures/alias-prefix-app/source/blog/2024-01-15-prefix-test.html.markdown

@@ -0,0 +1,7 @@
+---
+title: "Prefix Test Article"
+date: 2024-01-15
+layout: false
+---
+
+This article tests prefix functionality with aliases.

data/fixtures/alias-prefix-app/source/index.html

@@ -0,0 +1 @@
+<h1>Blog with Prefix</h1>

data/fixtures/article-dirs-app/config-directory-indexes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.permalink = '{year}/{month}/{day}/{title}'
   blog.sources = 'blog/:year-:month-:day-:title.html'

data/fixtures/article-dirs-app/config-permalink-with-dot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.permalink = '{year}.{month}.{day}/{title}'
   blog.sources = 'blog/:year-:month-:day-:title.html'

data/fixtures/article-dirs-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
 end

data/fixtures/blog-sources-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
 end

data/fixtures/blog-sources-no-date-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:title.html'
 end

data/fixtures/blog-sources-no-day-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':year-:month-:title.html'
 end

data/fixtures/blog-sources-no-title-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':year-:month-:day.html'
 end

data/fixtures/blog-sources-subdirs-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:title.html'
   blog.permalink = 'blog/{title}.html'

data/fixtures/calendar-and-tag-app/config-directory-indexes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/calendar-and-tag-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/calendar-app/config-directory-indexes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/calendar-app/config-only-year.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/calendar-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/calendar-multiblog-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/custom-article-template-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.new_article_template = 'my_custom_article.tt'
 end

data/fixtures/custom-collections-app/config-blog-prefix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 activate :blog do |blog|
   blog.prefix       = 'blog/'

data/fixtures/custom-collections-app/config-directory-indexes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 activate :blog do |blog|
   blog.sources      = 'blog/:year-:month-:day-:title.html'

data/fixtures/custom-collections-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 activate :blog do |blog|
   blog.sources      = 'blog/:year-:month-:day-:title.html'

data/fixtures/custom-collections-multiblog-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.name         = 'blog_name_1'
   blog.prefix       = 'blog1'

data/fixtures/custom-collections-sources-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources      = ':category/:year-:month-:day-:title.html'
   blog.permalink    = 'blog/:year-:month-:day-:title.html'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 activate :blog do |blog|
   blog.sources      = 'blog/:year-:month-:day-:title.html'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 activate :blog do |blog|
   blog.sources      = 'blog/:year-:month-:day-:title.html'

data/fixtures/filename-date-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog

data/fixtures/future-date-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Time.zone = 'Pacific Time (US & Canada)'
 
 activate :blog do |blog|

data/fixtures/indexes-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':year/:month/:day/:title.html'
 end

data/fixtures/lang-path-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :i18n
 
 activate :blog do |blog|

data/fixtures/language-app/config.rb

@@ -1,2 +1,4 @@
-activate :i18n
+# frozen_string_literal: true
+
+activate :i18n
 activate :blog

data/fixtures/layouts-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':year/:month/:day/:title.html'
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
   blog.permalink         = 'blog/:year-:month-:day-:title.html'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
   blog.permalink         = 'blog/:year-:month-:day-:title.html'

data/fixtures/paginate-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
   blog.permalink         = 'blog/:year-:month-:day-:title.html'

data/fixtures/paginate-multiblog-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.name              = 'blog_name_1'
   blog.prefix            = 'blog1'

data/fixtures/permalink-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':category/:year-:month-:day-:title.html'
   blog.permalink = ':category/:custom-:year-:month-:day-:title.html'

data/fixtures/preview-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = ':year/:month/:day/:title.html'
 end

data/fixtures/published-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.sources = 'blog/:year-:month-:day-:title.html'
 end

data/fixtures/summary-app/config.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 activate :blog

data/fixtures/summary-app/source/layout.erb

@@ -0,0 +1,6 @@
+<!doctype html>
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 
 activate :blog do |blog|

data/fixtures/tags-app/config-filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 
 activate :blog do |blog|

data/fixtures/tags-app/config-no-tags.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 
 activate :blog do |blog|

data/fixtures/tags-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'
 
 activate :blog do |blog|

data/fixtures/tags-app/source/blog/2011-01-01-new-article.html.markdown

@@ -1,7 +1,7 @@
 --- 
 title: "Newer Article"
 date: 2011-01-01
-tags: foo, bar
+tags: foo, bar, 日本語
 ---
 
 Newer Article Content

data/fixtures/tags-app/source/blog/2011-01-02-another-article.html.markdown

@@ -4,6 +4,7 @@ date: 2011-01-02
 tags:
   - foo
   - 120
+  - 日本語
 ---
 
 Another Article Content

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
   blog.name         = 'blog_name_1'
   blog.prefix       = 'blog1'

data/fixtures/time-zone-app/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 set :time_zone, 'Tokyo'
 
 activate :blog do |blog|

data/lib/middleman-blog/alias_pages.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'middleman-core'
+require 'middleman-core/sitemap/resource'
+require 'middleman-blog/uri_templates'
+
+module Middleman
+  module Blog
+    ##
+    # A sitemap resource manipulator that adds alias/redirect pages to the sitemap
+    # for each blog article based on the configured alias patterns
+    ##
+    class AliasPages
+      include UriTemplates
+
+      ##
+      # Initialise Alias pages
+      #
+      # @param  app             [Object] Middleman app
+      # @param  blog_controller [Object] Blog controller
+      ##
+      def initialize(app, blog_controller)
+        @sitemap         = app.sitemap
+        @blog_controller = blog_controller
+        @blog_data       = blog_controller.data
+        @alias_patterns  = blog_controller.options.aliases || []
+        @alias_templates = @alias_patterns.map { |pattern| uri_template(pattern) }
+      end
+
+      ##
+      # Update the main sitemap resource list
+      #
+      # @param  resources [Array] Existing resources
+      # @return           [Array] Resources with alias pages added
+      ##
+      def manipulate_resource_list(resources)
+        return resources if @alias_patterns.empty?
+
+        alias_resources = []
+
+        @blog_data.articles.each do |article|
+          @alias_templates.each do |template|
+            alias_path = generate_alias_path(template, article)
+            next if alias_path == article.destination_path # Don't create alias to itself
+
+            alias_resources << alias_page_resource(alias_path, article)
+          end
+        end
+
+        resources + alias_resources
+      end
+
+      private
+
+      ##
+      # Generate an alias path for an article using the given template
+      #
+      # @param  template [Addressable::Template] URI template for the alias
+      # @param  article  [BlogArticle] The blog article
+      # @return [String] The generated alias path
+      ##
+      def generate_alias_path(template, article)
+        # Get the same parameters used for the main permalink
+        params = permalink_options(article)
+        apply_uri_template(template, params)
+      end
+
+      ##
+      # Generate permalink options for an article (same as BlogData uses)
+      #
+      # @param  article [BlogArticle] The blog article
+      # @return [Hash] Parameters for URL generation
+      ##
+      def permalink_options(article)
+        # Get variables from all alias templates
+        all_variables = @alias_templates.flat_map(&:variables).uniq
+        
+        # Allow any frontmatter data to be substituted into the alias URL
+        page_data = article.metadata[:page] || {}
+        params = page_data.slice(*all_variables.map(&:to_sym))
+
+        params.each do |k, v|
+          params[k] = safe_parameterize(v)
+        end
+
+        params
+          .merge(date_to_params(article.date))
+          .merge(lang: article.lang.to_s, locale: article.locale.to_s, title: article.slug)
+      end
+
+      ##
+      # Create an alias page resource that redirects to the main article
+      #
+      # @param  alias_path [String] The path for the alias
+      # @param  article    [BlogArticle] The target article
+      # @return [Sitemap::Resource] A redirect resource
+      ##
+      def alias_page_resource(alias_path, article)
+        target_url = article.destination_path
+        # Ensure target URL starts with '/' for absolute URLs
+        target_url = "/#{target_url}" unless target_url.start_with?('/')
+        AliasResource.new(@sitemap, alias_path, target_url, article)
+      end
+    end
+
+    ##
+    # A resource that generates redirect HTML for alias pages
+    ##
+    class AliasResource < ::Middleman::Sitemap::Resource
+      def initialize(store, path, target_url, alias_resource)
+        @target_url = target_url
+        @alias_resource = alias_resource
+        super(store, path)
+      end
+
+      def source_file
+        @alias_resource.source_file
+      end
+
+      def template?
+        false
+      end
+
+      def render(*args, &block)
+        %[
+          <html>
+            <head>
+              <link rel="canonical" href="#{@target_url}" />
+              <meta name="robots" content="noindex,follow" />
+              <meta http-equiv="cache-control" content="no-cache" />
+              <script>
+                // Attempt to keep search and hash
+                window.location.replace("#{@target_url}"+window.location.search+window.location.hash);
+              </script>
+              <meta http-equiv=refresh content="0; url=#{@target_url}" />
+            </head>
+            <body>
+              <a href="#{@target_url}">You are being redirected.</a>
+            </body>
+          </html>
+        ]
+      end
+
+      def binary?
+        false
+      end
+
+      def raw_data
+        @alias_resource.raw_data
+      end
+
+      def ignored?
+        false
+      end
+
+      def metadata
+        @alias_resource.metadata
+      end
+    end
+  end
+end

data/lib/middleman-blog/blog_article.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/time_with_zone'
 require 'active_support/core_ext/time/acts_like'
 require 'active_support/core_ext/time/calculations'
@@ -14,9 +16,6 @@ module Middleman
     module BlogArticle
       extend Gem::Deprecate
 
-      ##
-      #
-      ##
       def self.extended(base)
         base.class.send(:attr_accessor, :blog_controller)
       end
@@ -58,7 +57,14 @@ module Middleman
 
         content = super(opts, locs, &block)
 
-        content.sub!(blog_options.summary_separator, '') unless opts[:keep_separator]
+        # Handle summary separator: if not keeping separator and separator exists,
+        # return only content after separator
+        if blog_options.summary_separator && !opts[:keep_separator]
+          if content.match?(blog_options.summary_separator)
+            require 'middleman-blog/truncate_html'
+            content = TruncateHTML.content_after_separator(content, blog_options.summary_separator)
+          end
+        end
 
         content
       end
@@ -204,10 +210,10 @@ module Middleman
 
         # First get the date from frontmatter
         @_date = if frontmatter_date.is_a? Time
-                   frontmatter_date.in_time_zone
-                 else
-                   Time.zone.parse(frontmatter_date.to_s)
-                 end
+          frontmatter_date.in_time_zone
+        else
+          Time.zone.parse(frontmatter_date.to_s)
+        end
 
         # Next figure out the date from the filename
         source_vars = blog_data.source_template.variables
@@ -239,13 +245,13 @@ module Middleman
       ##
       def slug
         if data['slug']
-          Blog::UriTemplates.safe_parameterize(data['slug'])
+          Blog::UriTemplates.safe_parameterize(data['slug'], preserve_underscores: blog_options.preserve_underscores_in_slugs)
 
         elsif blog_data.source_template.variables.include?('title')
-          Blog::UriTemplates.safe_parameterize(path_part('title'))
+          Blog::UriTemplates.safe_parameterize(path_part('title'), preserve_underscores: blog_options.preserve_underscores_in_slugs)
 
         elsif title
-          Blog::UriTemplates.safe_parameterize(title)
+          Blog::UriTemplates.safe_parameterize(title, preserve_underscores: blog_options.preserve_underscores_in_slugs)
 
         else
           raise "Can't generate a slug for #{path} because it has no :title in its path pattern or title/slug in its frontmatter."

data/lib/middleman-blog/blog_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -49,7 +51,7 @@ module Middleman
       # @return [Array<Middleman::Sitemap::Resource>]
       ##
       def articles
-        @_articles.select(&(options.filter || proc { |a| a })).sort_by(&:date).reverse
+        @_articles.select(&options.filter || proc { |a| a }).sort_by(&:date).reverse
       end
 
       ##
@@ -207,7 +209,7 @@ module Middleman
         params = resource.metadata[:page].slice(*@permalink_template.variables.map(&:to_sym))
 
         params.each do |k, v|
-          params[k] = safe_parameterize(v)
+          params[k] = safe_parameterize(v, preserve_underscores: @options.preserve_underscores_in_slugs)
         end
 
         params
@@ -216,9 +218,6 @@ module Middleman
           .merge(extra)
       end
 
-      ##
-      #
-      ##
       def convert_to_article(resource)
         return resource if resource.is_a?(BlogArticle)
 
@@ -232,9 +231,6 @@ module Middleman
         resource
       end
 
-      ##
-      #
-      ##
       def template_path(template, article, extras = {})
         apply_uri_template template, permalink_options(article, extras)
       end

data/lib/middleman-blog/calendar_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -31,12 +33,12 @@ module Middleman
       # @return [String]
       def link(year, month = nil, day = nil)
         template = if day
-                     @day_link_template
-                   elsif month
-                     @month_link_template
-                   else
-                     @year_link_template
-                   end
+          @day_link_template
+        elsif month
+          @month_link_template
+        else
+          @year_link_template
+        end
 
         apply_uri_template template, date_to_params(Date.new(year, month || 1, day || 1))
       end