middleman-blog 4.0.3 → 4.2.0

data/lib/middleman-blog/commands/article.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-core/cli'
 require 'date'
 require 'middleman-blog/uri_templates'
@@ -65,7 +67,6 @@ module Middleman
         @content = options[:content] || ''
         @date    = options[:date] ? ::Time.zone.parse(options[:date]) : Time.zone.now
         @locale  = options[:locale] || (::I18n.default_locale if defined? ::I18n)
-        @slug    = safe_parameterize(title)
         @tags    = options[:tags]&.split(/\s*,\s*/) || []
         @title   = title
 
@@ -77,17 +78,20 @@ module Middleman
         end
 
         blog_inst = if options[:blog]
-                      app.extensions[:blog].find { |_key, instance| instance.options[:name] == options[:blog] }[ 1 ]
-                    else
-                      app.extensions[:blog].values.first
-                    end
+          app.extensions[:blog].find { |_key, instance| instance.options[:name] == options[:blog] }[ 1 ]
+        else
+          app.extensions[:blog].values.first
+        end
 
         unless blog_inst
           msg = 'Could not find an active blog instance'
-          msg << " named #{options[:blog]}" if options[:blog]
+          msg = "#{msg} named #{options[:blog]}" if options[:blog]
           throw msg
         end
 
+        # Generate slug after we have access to blog options
+        @slug = safe_parameterize(title, preserve_underscores: blog_inst.options.preserve_underscores_in_slugs)
+
         path_template         = blog_inst.data.source_template
         params                = date_to_params(@date).merge(locale: @locale.to_s, title: @slug)
         article_path          = apply_uri_template path_template, params

data/lib/middleman-blog/commands/article.tt

@@ -1,7 +1,7 @@
 ---
 
-title: <%= @title %>
-date: <%= @date.strftime('%F %R %Z') %>
+title: "<%= %Q[#{@title}] %>"
+date: <%= @date.strftime('%F %R %z') %>
 tags: <%= @tags.join(",") %>
 
 ---

data/lib/middleman-blog/custom_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -21,7 +23,7 @@ module Middleman
       #
       # @param [String] value
       def link(value)
-        apply_uri_template @link_template, property => safe_parameterize(value)
+        apply_uri_template @link_template, property => safe_parameterize(value, preserve_underscores: @blog_controller.options.preserve_underscores_in_slugs)
       end
 
       def manipulate_resource_list(resources)

data/lib/middleman-blog/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/core_ext/time/zones'
 require 'middleman-blog/blog_data'
 require 'middleman-blog/blog_article'
@@ -39,8 +41,10 @@ module Middleman
     option :publish_future_dated, false, 'Whether articles with a date in the future should be considered published'
     option :custom_collections, {}, 'Hash of custom frontmatter properties to collect articles on and their options (link, template)'
     option :preserve_locale, false, 'Use the global Middleman I18n.locale instead of the lang in the article\'s frontmatter'
+    option :preserve_underscores_in_slugs, false, 'Whether to preserve underscores in article slugs instead of converting them to dashes'
     option :new_article_template, File.expand_path('commands/article.tt', __dir__), 'Path (relative to project root) to an ERb template that will be used to generate new articles from the "middleman article" command.'
     option :default_extension, '.markdown', 'Default template extension for articles (used by "middleman article")'
+    option :aliases, [], 'Array of URL patterns that should redirect to the main permalink (e.g., [":year-:month-:day-:title.html"])'
 
     # @return [BlogData] blog data for this blog, which has all information about the blog articles
     attr_reader :data
@@ -60,6 +64,9 @@ module Middleman
     # @return [Hash<CustomPages>] custom pages handlers for this blog, indexed by property name
     attr_reader :custom_pages
 
+    # @return [AliasPages] alias page handler for this blog
+    attr_reader :alias_pages
+
     # Helpers for use within templates and layouts.
     self.defined_helpers = [Middleman::Blog::Helpers]
 
@@ -79,18 +86,23 @@ module Middleman
       end
 
       # If "prefix" option is specified, all other paths are relative to it.
-      if options.prefix
-        options.prefix = "/#{options.prefix}" unless options.prefix.start_with? '/'
-        options.permalink = File.join(options.prefix, options.permalink)
-        options.sources = File.join(options.prefix, options.sources)
-        options.taglink = File.join(options.prefix, options.taglink)
-        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
+      return unless options.prefix
+
+      options.prefix = "/#{options.prefix}" unless options.prefix.start_with? '/'
+      options.permalink = File.join(options.prefix, options.permalink)
+      options.sources = File.join(options.prefix, options.sources)
+      options.taglink = File.join(options.prefix, options.taglink)
+      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_value do |opts|
+        opts[:link] = File.join(options.prefix, opts[:link])
+      end
+
+      # Apply prefix to alias patterns if specified
+      unless options.aliases.nil? || options.aliases.empty?
+        options.aliases = options.aliases.map { |alias_pattern| File.join(options.prefix, alias_pattern) }
       end
     end
 
@@ -113,6 +125,8 @@ module Middleman
       @app.ignore(options.day_template) if options.day_template
       @app.ignore options.tag_template if options.tag_template
 
+      ActiveSupport.to_time_preserves_timezone = :zone
+
       # Make sure ActiveSupport's TimeZone stuff has something to work with,
       # allowing people to set their desired time zone via Time.zone or
       # set :time_zone
@@ -153,6 +167,12 @@ module Middleman
         @app.sitemap.register_resource_list_manipulator(:"blog_#{name}_paginate", @paginator)
       end
 
+      unless options.aliases.nil? || options.aliases.empty?
+        require 'middleman-blog/alias_pages'
+        @alias_pages = Blog::AliasPages.new(@app, self)
+        @app.sitemap.register_resource_list_manipulator(:"blog_#{name}_aliases", @alias_pages)
+      end
+
       logger.info "== Blog Sources: #{options.sources} (:prefix + :sources)"
     end
 

data/lib/middleman-blog/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Middleman
   module Blog
     # Blog-related helpers that are available to the Middleman application in +config.rb+ and in templates.
@@ -59,7 +61,7 @@ module Middleman
       # Determine whether the currently rendering template is a {BlogArticle}.
       # This can be useful in layouts and helpers.
       # @return [Boolean]
-      def is_blog_article? # rubocop:disable Naming/PredicateName
+      def is_blog_article?
         !current_article.nil?
       end
 
@@ -67,7 +69,7 @@ module Middleman
       # @return [BlogArticle]
       def current_article
         article = current_resource
-        article if article&.is_a?(BlogArticle)
+        article if article.is_a?(BlogArticle)
       end
 
       # Get a path to the given tag page, based on the +taglink+ blog setting.

data/lib/middleman-blog/paginator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -149,7 +151,7 @@ module Middleman
         else
           page_url = apply_uri_template page_link, num: page_num
           index_re = %r{(^|/)#{Regexp.escape(@app.config[:index_file])}$}
-          if res.path =~ index_re
+          if res.path&.match?(index_re)
             res.path.sub(index_re, "\\1#{page_url}/#{@app.config[:index_file]}")
           else
             res.path.sub(%r{(^|/)([^/]*)\.([^/]*)$}, "\\1\\2/#{page_url}.\\3")

data/lib/middleman-blog/tag_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -31,7 +33,7 @@ module Middleman
       # @return     [String] Safe Tag URL
       ##
       def link(tag)
-        apply_uri_template @tag_link_template, tag: safe_parameterize(tag)
+        apply_uri_template @tag_link_template, tag: safe_parameterize(tag, preserve_underscores: @blog_controller.options.preserve_underscores_in_slugs)
       end
 
       ##

data/lib/middleman-blog/truncate_html.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'nokogiri'
 rescue LoadError
@@ -13,6 +15,20 @@ module TruncateHTML
     doc.inner_html
   end
 
+  def self.content_after_separator(text, separator)
+    text = text.encode('UTF-8') if text.respond_to?(:encode)
+    parts = text.split(separator, 2)
+    
+    if parts.length >= 2
+      # Take the last part (which should be after the separator)
+      content_after = parts.last
+      doc = Nokogiri::HTML::DocumentFragment.parse content_after
+      doc.inner_html
+    else
+      text
+    end
+  end
+
   def self.truncate_at_length(text, max_length, ellipsis = '...')
     ellipsis_length = ellipsis.length
     text = text.encode('UTF-8') if text.respond_to?(:encode)
@@ -48,7 +64,7 @@ module NokogiriTruncator
   module TextNode
     def truncate(max_length, ellipsis)
       # Don't break in the middle of a word
-      trimmed_content = content.match(/(.{1,#{max_length}}[\w]*)/m).to_s
+      trimmed_content = content.match(/(.{1,#{max_length}}\w*)/m).to_s
       trimmed_content << ellipsis if trimmed_content.length < content.length
 
       Nokogiri::XML::Text.new(trimmed_content, parent)
@@ -63,7 +79,7 @@ module NokogiriTruncator
   end
 end
 
-Nokogiri::HTML::DocumentFragment.send(:include, NokogiriTruncator::NodeWithChildren)
-Nokogiri::XML::Element.send(:include, NokogiriTruncator::NodeWithChildren)
-Nokogiri::XML::Text.send(:include, NokogiriTruncator::TextNode)
-Nokogiri::XML::Comment.send(:include, NokogiriTruncator::CommentNode)
+Nokogiri::HTML::DocumentFragment.include NokogiriTruncator::NodeWithChildren
+Nokogiri::XML::Element.include NokogiriTruncator::NodeWithChildren
+Nokogiri::XML::Text.include NokogiriTruncator::TextNode
+Nokogiri::XML::Comment.include NokogiriTruncator::CommentNode

data/lib/middleman-blog/uri_templates.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'addressable/template'
+require 'active_support/all'
 require 'middleman-core/util'
 require 'active_support/inflector'
 require 'active_support/inflector/transliterate'
@@ -51,13 +54,13 @@ module Middleman
       # Reimplementation of this, preserves un-transliterate-able multibyte chars.
       #
       # @see http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize
-      def safe_parameterize(str, sep = '-')
+      def safe_parameterize(str, separator: '-', preserve_underscores: false)
         # Remove ending ?
         str = str.to_s.gsub(/\?$/, '')
 
         # Reimplementation of http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize that preserves un-transliterate-able multibyte chars.
         parameterized_string = ::ActiveSupport::Inflector.transliterate(str.to_s).downcase
-        parameterized_string.gsub!(/[^a-z0-9\-_\?]+/, sep)
+        parameterized_string.gsub!(/[^a-z0-9\-_?]+/, separator)
 
         # Check for multibytes and sub back in
         parameterized_string.chars.to_a.each_with_index do |char, i|
@@ -66,17 +69,20 @@ module Middleman
           parameterized_string[i] = str[i]
         end
 
-        re_sep = ::Regexp.escape(sep)
+        re_sep = ::Regexp.escape(separator)
 
         # No more than one of the separator in a row.
-        parameterized_string.gsub!(/#{re_sep}{2,}/, sep)
+        parameterized_string.gsub!(/#{re_sep}{2,}/, separator)
 
         # Remove leading/trailing separator.
         parameterized_string.gsub!(/^#{re_sep}|#{re_sep}$/, '')
-        parameterized_string.tr!('_', '-')
+
+        # Replace all _ with - (unless preserve_underscores is true)
+        parameterized_string.tr!('_', '-') unless preserve_underscores
+
+        # Delete all ?
         parameterized_string.delete!('?')
 
-        # Replace all ?
         parameterized_string
       end
 

data/lib/middleman-blog/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Middleman
   module Blog
-    VERSION = '4.0.3'.freeze
+    VERSION = '4.2.0'
   end
 end

data/lib/middleman-blog.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-core'
 require 'middleman-blog/version'
 

data/lib/middleman_extension.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'middleman-blog'

data/middleman-blog.gemspec

@@ -1,25 +1,18 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path( "../lib", __FILE__ )
-require "middleman-blog/version"
+require "./lib/middleman-blog/version"
 
 Gem::Specification.new do | s |
-
-  s.name                  = "middleman-blog"
-  s.version               = Middleman::Blog::VERSION
-  s.platform              = Gem::Platform::RUBY
-  s.authors               = [ "Thomas Reynolds", "Ben Hollis", "Ian Warner" ]
-  s.email                 = [ "me@tdreyno.com", "ben@benhollis.net", "ian.warner@drykiss.com" ]
-  s.homepage              = "https://github.com/middleman/middleman-blog"
-  s.summary               = %q{ Blog engine for Middleman }
-  s.description           = %q{ Blog engine for Middleman }
-  s.license               = "MIT"
-  s.files                 = `git ls-files -z`.split( "\0" )
-  s.test_files            = `git ls-files -z -- {fixtures,features}/*`.split( "\0" )
-  s.require_paths         = [ "lib" ]
-  s.required_ruby_version = '>= 2.3.0'
-
-  s.add_dependency( "middleman-core", [ ">= 4.0.0" ] )
-  s.add_dependency( "tzinfo",         [ ">= 0.3.0" ] )
-  s.add_dependency( "addressable",    [ "~> 2.3"   ] )
-
+  s.name          = "middleman-blog"
+  s.version       = Middleman::Blog::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = [ "Thomas Reynolds", "Ben Hollis", "Ian Warner" ]
+  s.email         = [ "me@tdreyno.com", "ben@benhollis.net", "ian.warner@drykiss.com" ]
+  s.homepage      = "https://github.com/middleman/middleman-blog"
+  s.summary       = %q{ Blog engine for Middleman }
+  s.description   = %q{ Blog engine for Middleman }
+  s.license       = "MIT"
+  s.files         = `git ls-files -z`.split( "\0" )
+  s.test_files    = `git ls-files -z -- {fixtures,features}/*`.split( "\0" )
+  s.add_dependency("middleman-core", ">= 4.0.0")
+  s.add_dependency("tzinfo", ">= 0.3.0")
+  s.add_dependency("addressable", "~> 2.3")
 end

data/spec/alias_spec.rb

@@ -0,0 +1,116 @@
+require 'middleman-blog/alias_pages'
+require 'middleman-blog/uri_templates'
+
+describe 'Middleman::Blog::AliasPages' do
+  include Middleman::Blog::UriTemplates
+
+  let(:mock_app) { double('app') }
+  let(:mock_sitemap) { double('sitemap') }
+  let(:mock_blog_controller) { double('blog_controller') }
+  let(:mock_blog_data) { double('blog_data') }
+  let(:mock_article) { double('article') }
+  let(:mock_options) { double('options') }
+
+  before do
+    allow(mock_app).to receive(:sitemap).and_return(mock_sitemap)
+    allow(mock_blog_controller).to receive(:data).and_return(mock_blog_data)
+    allow(mock_blog_controller).to receive(:options).and_return(mock_options)
+    allow(mock_article).to receive(:destination_path).and_return('2024/03/14/pi-day.html')
+    allow(mock_article).to receive(:date).and_return(Date.new(2024, 3, 14))
+    allow(mock_article).to receive(:slug).and_return('pi-day')
+    allow(mock_article).to receive(:lang).and_return(:en)
+    allow(mock_article).to receive(:locale).and_return(:en)
+    allow(mock_article).to receive(:metadata).and_return({ page: {} })
+  end
+
+  describe 'alias URL generation' do
+    let(:alias_patterns) { [':year-:month-:day-:title.html', ':year/:month-:day-:title'] }
+
+    before do
+      allow(mock_options).to receive(:aliases).and_return(alias_patterns)
+      allow(mock_blog_data).to receive(:articles).and_return([mock_article])
+    end
+
+    context 'when testing alias path generation' do
+      let(:alias_pages) { Middleman::Blog::AliasPages.new(mock_app, mock_blog_controller) }
+
+      it 'generates correct alias paths from patterns' do
+        template1 = uri_template(':year-:month-:day-:title.html')
+        template2 = uri_template(':year/:month-:day-:title')
+        
+        # Test path generation directly
+        alias_path1 = alias_pages.send(:generate_alias_path, template1, mock_article)
+        alias_path2 = alias_pages.send(:generate_alias_path, template2, mock_article)
+        
+        expect(alias_path1).to eq('2024-03-14-pi-day.html')
+        expect(alias_path2).to eq('2024/03-14-pi-day')
+      end
+
+      it 'filters out aliases that match main permalink' do
+        # Test with an alias pattern that would match the main permalink
+        template = uri_template(':year/:month/:day/:title.html')
+        
+        alias_path = alias_pages.send(:generate_alias_path, template, mock_article)
+        expect(alias_path).to eq('2024/03/14/pi-day.html')
+        
+        # This would be filtered out in manipulate_resource_list because it matches destination_path
+        expect(alias_path).to eq(mock_article.destination_path)
+      end
+    end
+
+    context 'when testing permalink options generation' do
+      let(:alias_pages) { Middleman::Blog::AliasPages.new(mock_app, mock_blog_controller) }
+
+      it 'generates correct permalink options from article data' do
+        params = alias_pages.send(:permalink_options, mock_article)
+        
+        expect(params[:year]).to eq('2024')
+        expect(params[:month]).to eq('03')
+        expect(params[:day]).to eq('14')
+        expect(params[:title]).to eq('pi-day')
+        expect(params[:lang]).to eq('en')
+        expect(params[:locale]).to eq('en')
+      end
+    end
+  end
+
+  describe 'empty aliases configuration' do
+    before do
+      allow(mock_options).to receive(:aliases).and_return([])
+      allow(mock_blog_data).to receive(:articles).and_return([mock_article])
+    end
+
+    it 'returns original resources when aliases array is empty' do
+      alias_pages = Middleman::Blog::AliasPages.new(mock_app, mock_blog_controller)
+      resources = ['existing_resource']
+      result = alias_pages.manipulate_resource_list(resources)
+      
+      # Should return the same resources since no aliases are configured
+      expect(result).to eq(resources)
+    end
+  end
+
+  describe 'alias pattern handling' do
+    before do
+      allow(mock_blog_data).to receive(:articles).and_return([mock_article])
+    end
+
+    it 'handles multiple alias patterns' do
+      patterns = [':year-:month-:day-:title.html', ':year/:month-:day-:title', 'archive/:title']
+      allow(mock_options).to receive(:aliases).and_return(patterns)
+      
+      alias_pages = Middleman::Blog::AliasPages.new(mock_app, mock_blog_controller)
+      
+      # Test that all patterns are converted to templates
+      expect(alias_pages.instance_variable_get(:@alias_templates).length).to eq(3)
+    end
+
+    it 'handles nil alias patterns gracefully' do
+      allow(mock_options).to receive(:aliases).and_return(nil)
+      
+      expect {
+        Middleman::Blog::AliasPages.new(mock_app, mock_blog_controller)
+      }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'simplecov'
-SimpleCov.root(File.expand_path(File.dirname(__FILE__) + '/..'))
+SimpleCov.root(File.expand_path("#{File.dirname(__FILE__)}/.."))

data/spec/uri_templates_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 describe 'Middleman::Blog::UriTemplates' do
@@ -24,6 +26,18 @@ describe 'Middleman::Blog::UriTemplates' do
     it 'can handle numbers' do
       expect(safe_parameterize(1)).to eq '1'
     end
+
+    it 'converts underscores to dashes by default' do
+      expect(safe_parameterize('name_of_article')).to eq 'name-of-article'
+    end
+
+    it 'can preserve underscores when requested' do
+      expect(safe_parameterize('name_of_article', preserve_underscores: true)).to eq 'name_of_article'
+    end
+
+    it 'still works with mixed content when preserving underscores' do
+      expect(safe_parameterize('Some MIXED_content', preserve_underscores: true)).to eq 'some-mixed_content'
+    end
   end
 
   describe 'extract_params' do