middleman-blog 4.0.2 → 4.1.0

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 activate :blog do |blog|
-  blog.name         = "blog_name_1"
-  blog.prefix       = "blog1"
-  blog.sources      = ":year-:month-:day-:title.html"
-  blog.permalink    = ":year-:month-:day-:title.html"
-  blog.tag_template = "tag1.html"
+  blog.name         = 'blog_name_1'
+  blog.prefix       = 'blog1'
+  blog.sources      = ':year-:month-:day-:title.html'
+  blog.permalink    = ':year-:month-:day-:title.html'
+  blog.tag_template = 'tag1.html'
 end
 
 activate :blog do |blog|
-  blog.name         = "blog_name_2"
-  blog.prefix       = "blog2"
-  blog.sources      = ":year-:month-:day-:title.html"
-  blog.permalink    = ":year-:month-:day-:title.html"
-  blog.tag_template = "tag2.html"
+  blog.name         = 'blog_name_2'
+  blog.prefix       = 'blog2'
+  blog.sources      = ':year-:month-:day-:title.html'
+  blog.permalink    = ':year-:month-:day-:title.html'
+  blog.tag_template = 'tag2.html'
 end

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/blog_article.rb

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
+# 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'
 
 module Middleman
-
   module Blog
-
     ##
     # A module that adds blog-article-specific methods to Resources. A
     # {BlogArticle} can be retrieved via {Blog::Helpers#current_article} or
@@ -15,12 +14,8 @@ module Middleman
     # @see http://rdoc.info/github/middleman/middleman/Middleman/Sitemap/Resource Middleman::Sitemap::Resource
     ##
     module BlogArticle
-
       extend Gem::Deprecate
 
-      ##
-      #
-      ##
       def self.extended(base)
         base.class.send(:attr_accessor, :blog_controller)
       end
@@ -49,9 +44,8 @@ module Middleman
       #
       # @return [String]
       ##
-      def render(opts={}, locs={}, &block)
-
-        unless opts.has_key?( :layout )
+      def render(opts = {}, locs = {}, &block)
+        unless opts.key?(:layout)
 
           opts[:layout] = metadata[:options][:layout]
           opts[:layout] = blog_options.layout if opts[:layout].nil? || opts[:layout] == :_auto_layout
@@ -63,9 +57,7 @@ module Middleman
 
         content = super(opts, locs, &block)
 
-        unless opts[:keep_separator]
-          content.sub!(blog_options.summary_separator, '')
-        end
+        content.sub!(blog_options.summary_separator, '') unless opts[:keep_separator]
 
         content
       end
@@ -76,7 +68,7 @@ module Middleman
       # @return [String]
       ##
       def title
-        data['title']
+        data['title'].to_s
       end
 
       ##
@@ -120,7 +112,7 @@ module Middleman
       # @param [String] ellipsis The ellipsis string to use when content is trimmed.
       # @return [String]
       ##
-      def summary(length=nil, ellipsis='...')
+      def summary(length = nil, ellipsis = '...')
         rendered = render layout: false, keep_separator: true
 
         if blog_options.summary_generator
@@ -128,7 +120,6 @@ module Middleman
         else
           default_summary_generator(rendered, length, ellipsis)
         end
-
       end
 
       ##
@@ -142,7 +133,6 @@ module Middleman
       # @param [String] ellipsis The ellipsis string to use when content is trimmed.
       ##
       def default_summary_generator(rendered, length, ellipsis)
-
         if blog_options.summary_separator && rendered.match(blog_options.summary_separator)
           require 'middleman-blog/truncate_html'
           TruncateHTML.truncate_at_separator(rendered, blog_options.summary_separator)
@@ -151,14 +141,13 @@ module Middleman
           require 'middleman-blog/truncate_html'
           TruncateHTML.truncate_at_length(rendered, length, ellipsis)
 
-        elsif blog_options.summary_length && blog_options.summary_length > 0
+        elsif blog_options.summary_length&.positive?
           require 'middleman-blog/truncate_html'
           TruncateHTML.truncate_at_length(rendered, blog_options.summary_length, ellipsis)
 
         else
           rendered
         end
-
       end
 
       ##
@@ -167,7 +156,6 @@ module Middleman
       # @return [Array<String>] (never +nil+)
       ##
       def tags
-
         article_tags = data['tags']
 
         if article_tags.is_a? String
@@ -175,7 +163,6 @@ module Middleman
         else
           Array(article_tags).map(&:to_s)
         end
-
       end
 
       ##
@@ -188,21 +175,18 @@ module Middleman
       # @return [Symbol] Language code (for example, +:en+ or +:de+)
       ##
       def locale
-
         frontmatter_locale = data['locale'] || data['lang']
         filename_locale    = path_part('locale') || path_part('lang')
 
-        if frontmatter_locale && filename_locale && frontmatter_locale != filename_locale
-          raise "The locale in #{path}'s filename (#{filename_locale.inspect}) doesn't match the lang in its frontmatter (#{frontmatter_locale.inspect})"
-        end
+        raise "The locale in #{path}'s filename (#{filename_locale.inspect}) doesn't match the lang in its frontmatter (#{frontmatter_locale.inspect})" if frontmatter_locale && filename_locale && frontmatter_locale != filename_locale
 
         default_locale = I18n.default_locale if defined? ::I18n
 
         found_locale = frontmatter_locale || filename_locale || default_locale
-        found_locale && found_locale.to_sym
+        found_locale&.to_sym
       end
 
-      alias_method :lang, :locale
+      alias lang locale
 
       ##
       # Attempt to figure out the date of the post. The date should be
@@ -213,16 +197,15 @@ module Middleman
       # @return [TimeWithZone]
       ##
       def date
-
         return @_date if @_date
 
         frontmatter_date = data['date']
 
         # First get the date from frontmatter
-        if frontmatter_date.is_a? Time
-          @_date = frontmatter_date.in_time_zone
+        @_date = if frontmatter_date.is_a? Time
+          frontmatter_date.in_time_zone
         else
-          @_date = Time.zone.parse(frontmatter_date.to_s)
+          Time.zone.parse(frontmatter_date.to_s)
         end
 
         # Next figure out the date from the filename
@@ -244,7 +227,6 @@ module Middleman
         raise "Blog post #{path} needs a date in its filename or frontmatter" unless @_date
 
         @_date
-
       end
 
       ##
@@ -279,7 +261,7 @@ module Middleman
       # @return [BlogArticle]
       ##
       def previous_article
-        article_previous()
+        article_previous
       end
       deprecate :previous_article, :article_previous, 2017, 5
 
@@ -292,7 +274,7 @@ module Middleman
       # @return [Middleman::Sitemap::Resource]
       ##
       def next_article
-        article_next()
+        article_next
       end
       deprecate :next_article, :article_next, 2017, 5
 
@@ -303,7 +285,7 @@ module Middleman
       # @return [BlogArticle]
       ##
       def article_previous
-        blog_data.articles.find { |a| a.date < self.date }
+        blog_data.articles.find { |a| a.date < date }
       end
 
       ##
@@ -313,7 +295,7 @@ module Middleman
       # @return [Middleman::Sitemap::Resource]
       ##
       def article_next
-        blog_data.articles.reverse.find { |a| a.date > self.date }
+        blog_data.articles.reverse.find { |a| a.date > date }
       end
 
       ##
@@ -323,7 +305,7 @@ module Middleman
       # @return [BlogArticle]
       ##
       def article_locale_previous
-        blog_data.local_articles.find { |a| a.date < self.date }
+        blog_data.local_articles.find { |a| a.date < date }
       end
 
       ##
@@ -333,7 +315,7 @@ module Middleman
       # @return [Middleman::Sitemap::Resource]
       ##
       def article_locale_next
-        blog_data.local_articles.reverse.find { |a| a.date > self.date }
+        blog_data.local_articles.reverse.find { |a| a.date > date }
       end
 
       ##
@@ -357,9 +339,6 @@ module Middleman
         @_path_parts ||= Blog::UriTemplates.extract_params(blog_data.source_template, path)
         @_path_parts[part.to_s]
       end
-
     end
-
   end
-
 end

data/lib/middleman-blog/blog_data.rb

@@ -1,16 +1,15 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
-
   module Blog
-
     ##
     # A store of all the blog articles in the site, with accessors
     # for the articles by various dimensions. Accessed via "blog" in
     # templates.
     ##
     class BlogData
-
       include UriTemplates
       extend Gem::Deprecate
 
@@ -42,8 +41,8 @@ module Middleman
 
         @source_template           = uri_template options.sources
         @permalink_template        = uri_template options.permalink
-        @subdir_template           = uri_template options.sources.sub(/(\.[^.{}\/]+)?$/, "/{+path}" )
-        @subdir_permalink_template = uri_template options.permalink.sub(/(\.[^.{}\/]+)?$/, "/{+path}" )
+        @subdir_template           = uri_template options.sources.sub(/(\.[^.{}\/]+)?$/, '/{+path}')
+        @subdir_permalink_template = uri_template options.permalink.sub(/(\.[^.{}\/]+)?$/, '/{+path}')
       end
 
       ##
@@ -52,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
 
       ##
@@ -64,8 +63,8 @@ module Middleman
       # @param  [Symbol] locale Language to match (optional, defaults to I18n.locale).
       # @return [Array<Middleman::Sitemap::Resource>]
       ##
-      def local_articles( locale = ::I18n.locale )
-          articles_by_locale( locale )
+      def local_articles(locale = ::I18n.locale)
+        articles_by_locale(locale)
       end
       deprecate :local_articles, :articles_by_locale, 2017, 5
 
@@ -78,9 +77,9 @@ module Middleman
       #
       # @todo should use the @_articles if represented in this method.
       ##
-      def articles_by_locale( locale = ::I18n.locale )
-        locale = locale.to_sym if locale.kind_of? String
-        articles.select { | article | article.locale == locale }
+      def articles_by_locale(locale = ::I18n.locale)
+        locale = locale.to_sym if locale.is_a? String
+        articles.select { |article| article.locale == locale }
       end
 
       ##
@@ -90,19 +89,16 @@ module Middleman
       # @return [Hash<String, Array<Middleman::Sitemap::Resource>>]
       ##
       def tags
-
         tags = {}
 
         # Reference the filtered articles
         articles.each do |article|
-
           # Reference the tags assigned to an article
           article.tags.each do |tag|
             # tag = safe_parameterize(tag)
             tags[tag] ||= []
             tags[tag] << article
           end
-
         end
 
         # Return tags
@@ -144,7 +140,7 @@ module Middleman
             next unless publishable?(article)
 
             # Add extra parameters from the URL to the page metadata
-            extra_data = params.except *%w(year month day title lang locale)
+            extra_data = params.except 'year', 'month', 'day', 'title', 'lang', 'locale'
             article.add_metadata page: extra_data unless extra_data.empty?
 
             # compute output path: substitute date parts to path pattern
@@ -158,13 +154,13 @@ module Middleman
             # figure out the matching article for this subdirectory file
             article_path = @source_template.expand(params).to_s
 
-            if article = @app.sitemap.find_resource_by_path(article_path)
+            if (article = @app.sitemap.find_resource_by_path(article_path))
               # The article may not yet have been processed, so convert it here.
               article = convert_to_article(article)
               next unless publishable?(article)
 
               # Add extra parameters from the URL to the page metadata
-              extra_data = params.except *%w(year month day title lang locale)
+              extra_data = params.except 'year', 'month', 'day', 'title', 'lang', 'locale'
               article.add_metadata page: extra_data unless extra_data.empty?
 
               # The subdir path is the article path with the index file name
@@ -208,25 +204,22 @@ module Middleman
       # @param [Hash] extra More options to be merged in on top.
       # @return [Hash] options
       ##
-      def permalink_options(resource, extra={})
+      def permalink_options(resource, extra = {})
         # Allow any frontmatter data to be substituted into the permalink URL
-        params = resource.metadata[:page].slice *@permalink_template.variables.map(&:to_sym)
+        params = resource.metadata[:page].slice(*@permalink_template.variables.map(&:to_sym))
 
         params.each do |k, v|
           params[k] = safe_parameterize(v)
         end
 
-        params.
-          merge(date_to_params(resource.date)).
-          merge(lang: resource.lang.to_s, locale: resource.locale.to_s, title: resource.slug).
-          merge(extra)
+        params
+          .merge(date_to_params(resource.date))
+          .merge(lang: resource.lang.to_s, locale: resource.locale.to_s, title: resource.slug)
+          .merge(extra)
       end
 
-      ##
-      #
-      ##
-      def convert_to_article( resource )
-        return resource if resource.is_a?( BlogArticle )
+      def convert_to_article(resource)
+        return resource if resource.is_a?(BlogArticle)
 
         resource.extend BlogArticle
         resource.blog_controller = controller
@@ -238,13 +231,9 @@ module Middleman
         resource
       end
 
-      ##
-      #
-      ##
-      def template_path(template, article, extras={})
+      def template_path(template, article, extras = {})
         apply_uri_template template, permalink_options(article, extras)
       end
-
     end
   end
 end

data/lib/middleman-blog/calendar_pages.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'middleman-blog/uri_templates'
 
 module Middleman
@@ -29,14 +31,14 @@ module Middleman
       # @param [Number] month
       # @param [Number] day
       # @return [String]
-      def link(year, month=nil, day=nil)
+      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
@@ -47,20 +49,14 @@ module Middleman
         new_resources = []
 
         # Set up date pages if the appropriate templates have been specified
-        @blog_data.articles.group_by {|a| a.date.year }.each do |year, year_articles|
-          if @generate_year_pages && @year_template
-            new_resources << year_page_resource(year, year_articles)
-          end
+        @blog_data.articles.group_by { |a| a.date.year }.each do |year, year_articles|
+          new_resources << year_page_resource(year, year_articles) if @generate_year_pages && @year_template
 
-          year_articles.group_by {|a| a.date.month }.each do |month, month_articles|
-            if @generate_month_pages && @month_template
-              new_resources << month_page_resource(year, month, month_articles)
-            end
+          year_articles.group_by { |a| a.date.month }.each do |month, month_articles|
+            new_resources << month_page_resource(year, month, month_articles) if @generate_month_pages && @month_template
 
-            month_articles.group_by {|a| a.date.day }.each do |day, day_articles|
-              if @generate_day_pages && @day_template
-                new_resources << day_page_resource(year, month, day, day_articles)
-              end
+            month_articles.group_by { |a| a.date.day }.each do |day, day_articles|
+              new_resources << day_page_resource(year, month, day, day_articles) if @generate_day_pages && @day_template
             end
           end
         end
@@ -109,4 +105,4 @@ module Middleman
       end
     end
   end
-end
+end

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 require 'middleman-core/cli'
 require 'date'
 require 'middleman-blog/uri_templates'
 
 module Middleman
-
   module Cli
-
     ##
     # This class provides an "article" command for the middleman CLI.
     #
@@ -18,7 +18,6 @@ module Middleman
     # @todo Tags should be removed from the template if they are not required
     ##
     class Article < ::Thor::Group
-
       include Thor::Actions
       include Blog::UriTemplates
 
@@ -27,110 +26,104 @@ module Middleman
       # Template files are relative to this file
       # @return [String]
       def self.source_root
-        File.dirname( __FILE__ )
+        File.dirname(__FILE__)
       end
 
       argument :title, type: :string
 
-      class_option "blog",
-        aliases: "-b",
-        desc:    "The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)"
+      class_option 'blog',
+                   aliases: '-b',
+                   desc: 'The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)'
 
-      class_option "content",
-        aliases: "-c",
-        desc: "Content of the post"
+      class_option 'content',
+                   aliases: '-c',
+                   desc: 'Content of the post'
 
-      class_option "date",
-        aliases: "-d",
-        desc:    "The date to create the post with (defaults to now)"
+      class_option 'date',
+                   aliases: '-d',
+                   desc: 'The date to create the post with (defaults to now)'
 
-      class_option "locale",
-        aliases: "-l",
-        desc:    "The locale to create the post with (defaults to I18n.default_locale if available)"
+      class_option 'locale',
+                   aliases: '-l',
+                   desc: 'The locale to create the post with (defaults to I18n.default_locale if available)'
 
-      class_option "edit",
-        aliases: "-e",
-        desc:    "Edit the newly created blog post",
-        default: false,
-        type:    :boolean
+      class_option 'edit',
+                   aliases: '-e',
+                   desc: 'Edit the newly created blog post',
+                   default: false,
+                   type: :boolean
 
-      class_option "subdirectory",
-        aliases: "-s",
-        desc:    "Generate an article subdirectory (for directory indexes, defaults to false)",
-        default: false,
-        type:    :boolean
+      class_option 'subdirectory',
+                   aliases: '-s',
+                   desc: 'Generate an article subdirectory (for directory indexes, defaults to false)',
+                   default: false,
+                   type: :boolean
 
-      class_option "tags",
-        aliases: "-t",
-        desc: "A list of comma-separated tags for the post"
+      class_option 'tags',
+                   aliases: '-t',
+                   desc: 'A list of comma-separated tags for the post'
 
       def article
-
-        @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] && options[:tags].split(/\s*,\s*/) || []
+        @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
 
         app = ::Middleman::Application.new do
-          config[ :mode ]              = :config
-          config[ :disable_sitemap ]   = true
-          config[ :watcher_disable ]   = true
-          config[ :exit_before_ready ] = true
+          config[:mode]              = :config
+          config[:disable_sitemap]   = true
+          config[:watcher_disable]   = true
+          config[:exit_before_ready] = true
         end
 
-        blog_inst = if options[ :blog ]
-          app.extensions[ :blog ].find { | key, instance | instance.options[ :name ] == options[ :blog ] }[ 1 ]
+        blog_inst = if options[:blog]
+          app.extensions[:blog].find { |_key, instance| instance.options[:name] == options[:blog] }[ 1 ]
         else
-          app.extensions[ :blog ].values.first
+          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 = 'Could not find an active blog instance'
+          msg = "#{msg} named #{options[:blog]}" if options[:blog]
           throw msg
         end
 
         path_template         = blog_inst.data.source_template
-        params                = date_to_params( @date ).merge( locale: @locale.to_s, title: @slug )
+        params                = date_to_params(@date).merge(locale: @locale.to_s, title: @slug)
         article_path          = apply_uri_template path_template, params
-        absolute_article_path = File.join( app.source_dir, article_path + blog_inst.options.default_extension )
+        absolute_article_path = File.join(app.source_dir, article_path + blog_inst.options.default_extension)
 
         template blog_inst.options.new_article_template, absolute_article_path
 
         # Edit option process
-        if options[ :edit ]
+        if options[:edit]
 
-          editor = ENV.fetch( 'MM_EDITOR', ENV.fetch( 'EDITOR', nil ) )
+          editor = ENV.fetch('MM_EDITOR', ENV.fetch('EDITOR', nil))
 
           if editor
-            system( "#{ editor } #{ absolute_article_path }" )
+            system("#{editor} #{absolute_article_path}")
           else
-            throw "Could not find a suitable editor. Try setting the environment variable MM_EDITOR."
+            throw 'Could not find a suitable editor. Try setting the environment variable MM_EDITOR.'
           end
 
         end
 
         # Subdirectory option process
-        if options[ :subdirectory ]
-          empty_directory extract_directory_path( File.join( app.source_dir, article_path ) )
-        end
-
+        empty_directory extract_directory_path(File.join(app.source_dir, article_path)) if options[:subdirectory]
       end
 
       protected
 
-      def blog_instance( key )
-        return nil unless app.extensions[ :blog ]
-        return app.extensions[ :blog ][ key ]
+      def blog_instance(key)
+        return nil unless app.extensions[:blog]
+
+        app.extensions[:blog][key]
       end
 
       # Add to CLI
-      Base.register( self, 'article', 'article TITLE [options]', 'Create a new blog article' )
-
+      Base.register(self, 'article', 'article TITLE [options]', 'Create a new blog article')
     end
-
   end
-
 end

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(",") %>
 
 ---