middleman-blog 4.0.2 → 4.0.3

data/fixtures/paginate-app/config.rb

@@ -1,18 +1,16 @@
-activate :blog do | blog |
+activate :blog do |blog|
+  blog.sources = 'blog/:year-:month-:day-:title.html'
+  blog.permalink         = 'blog/:year-:month-:day-:title.html'
+  blog.calendar_template = 'calendar.html'
+  blog.tag_template      = 'tag.html'
+  blog.paginate          = true
+  blog.per_page          = 5
 
-    blog.sources           = "blog/:year-:month-:day-:title.html"
-    blog.permalink         = "blog/:year-:month-:day-:title.html"
-    blog.calendar_template = 'calendar.html'
-    blog.tag_template      = 'tag.html'
-    blog.paginate          = true
-    blog.per_page          = 5
+  blog.custom_collections = {
 
-    blog.custom_collections = {
-
-        :category => {
-            :link     => '/categories/:category.html',
-            :template => '/category.html'
-        }
+    category: {
+      link: '/categories/:category.html',
+      template: '/category.html'
     }
-
+  }
 end

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

@@ -1,8 +1,8 @@
 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.name              = 'blog_name_1'
+  blog.prefix            = 'blog1'
+  blog.sources           = ':year-:month-:day-:title.html'
+  blog.permalink         = ':year-:month-:day-:title.html'
   blog.calendar_template = 'calendar1.html'
   blog.tag_template      = 'tag1.html'
   blog.paginate          = true
@@ -10,10 +10,10 @@ activate :blog do |blog|
 end
 
 activate :blog do |blog2|
-  blog2.name              = "blog_name_2"
-  blog2.prefix            = "blog2"
-  blog2.sources           = ":year-:month-:day-:title.html"
-  blog2.permalink         = ":year-:month-:day-:title.html"
+  blog2.name              = 'blog_name_2'
+  blog2.prefix            = 'blog2'
+  blog2.sources           = ':year-:month-:day-:title.html'
+  blog2.permalink         = ':year-:month-:day-:title.html'
   blog2.calendar_template = 'calendar2.html'
   blog2.tag_template      = 'tag2.html'
   blog2.paginate          = true
@@ -21,11 +21,11 @@ activate :blog do |blog2|
 end
 
 activate :blog do |blog3|
-  blog3.name              = "blog_name_3"
-  blog3.prefix            = "blog3"
-  blog3.sources           = ":year-:month-:day-:title.html"
-  blog3.permalink         = ":year-:month-:day-:title.html"
+  blog3.name              = 'blog_name_3'
+  blog3.prefix            = 'blog3'
+  blog3.sources           = ':year-:month-:day-:title.html'
+  blog3.permalink         = ':year-:month-:day-:title.html'
   blog3.calendar_template = 'calendar3.html'
   blog3.tag_template      = 'tag3.html'
   blog3.paginate          = false
-end
+end

data/fixtures/permalink-app/config.rb

@@ -1,7 +1,4 @@
-
-activate :blog do | blog |
-
-    blog.sources   = ":category/:year-:month-:day-:title.html"
-    blog.permalink = ":category/:custom-:year-:month-:day-:title.html"
-
+activate :blog do |blog|
+  blog.sources = ':category/:year-:month-:day-:title.html'
+  blog.permalink = ':category/:custom-:year-:month-:day-:title.html'
 end

data/fixtures/preview-app/config.rb

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

data/fixtures/published-app/config.rb

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

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

@@ -1,9 +1,9 @@
-require "middleman-blog"
+require 'middleman-blog'
 
-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"
+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
 
 activate :directory_indexes

data/fixtures/tags-app/config.rb

@@ -1,7 +1,7 @@
-require "middleman-blog"
+require 'middleman-blog'
 
-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"
+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

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

@@ -1,15 +1,15 @@
 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/lib/middleman-blog.rb

@@ -1,11 +1,9 @@
-require "middleman-core"
-require "middleman-blog/version"
+require 'middleman-core'
+require 'middleman-blog/version'
 
-::Middleman::Extensions.register( :blog ) do
-
-    require "middleman-blog/extension"
-    require "middleman-blog/commands/article"
-
-    ::Middleman::BlogExtension
+::Middleman::Extensions.register(:blog) do
+  require 'middleman-blog/extension'
+  require 'middleman-blog/commands/article'
 
+  ::Middleman::BlogExtension
 end

data/lib/middleman-blog/blog_article.rb

@@ -1,12 +1,9 @@
-# -*- coding: utf-8 -*-
 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,7 +12,6 @@ module Middleman
     # @see http://rdoc.info/github/middleman/middleman/Middleman/Sitemap/Resource Middleman::Sitemap::Resource
     ##
     module BlogArticle
-
       extend Gem::Deprecate
 
       ##
@@ -49,9 +45,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 +58,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 +69,7 @@ module Middleman
       # @return [String]
       ##
       def title
-        data['title']
+        data['title'].to_s
       end
 
       ##
@@ -120,7 +113,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 +121,6 @@ module Middleman
         else
           default_summary_generator(rendered, length, ellipsis)
         end
-
       end
 
       ##
@@ -142,7 +134,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 +142,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 +157,6 @@ module Middleman
       # @return [Array<String>] (never +nil+)
       ##
       def tags
-
         article_tags = data['tags']
 
         if article_tags.is_a? String
@@ -175,7 +164,6 @@ module Middleman
         else
           Array(article_tags).map(&:to_s)
         end
-
       end
 
       ##
@@ -188,21 +176,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,17 +198,16 @@ 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
-        else
-          @_date = Time.zone.parse(frontmatter_date.to_s)
-        end
+        @_date = if frontmatter_date.is_a? Time
+                   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
@@ -244,7 +228,6 @@ module Middleman
         raise "Blog post #{path} needs a date in its filename or frontmatter" unless @_date
 
         @_date
-
       end
 
       ##
@@ -279,7 +262,7 @@ module Middleman
       # @return [BlogArticle]
       ##
       def previous_article
-        article_previous()
+        article_previous
       end
       deprecate :previous_article, :article_previous, 2017, 5
 
@@ -292,7 +275,7 @@ module Middleman
       # @return [Middleman::Sitemap::Resource]
       ##
       def next_article
-        article_next()
+        article_next
       end
       deprecate :next_article, :article_next, 2017, 5
 
@@ -303,7 +286,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 +296,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 +306,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 +316,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 +340,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,13 @@
 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 +39,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 +49,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 +61,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 +75,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 +87,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 +138,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 +152,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 +202,25 @@ 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
@@ -241,10 +235,9 @@ module Middleman
       ##
       #
       ##
-      def template_path(template, article, extras={})
+      def template_path(template, article, extras = {})
         apply_uri_template template, permalink_options(article, extras)
       end
-
     end
   end
 end