middleman-blog 4.0.1 → 4.0.2

data/fixtures/permalink-app/source/news/2011-01-01-new-article.html.markdown

@@ -0,0 +1,9 @@
+---
+
+title  : "Newer Article"
+date   : 2011-01-01
+custom : "A custom string"
+
+---
+
+Newer Article Content

data/fixtures/summary-app/source/2013-05-08-article-with-custom-separator.html.markdown

@@ -3,5 +3,5 @@ title: "Article with custom summary separator"
 ---
 
 Summary from article with custom separator.
-/SPLIT_SUMMARY_BEFORE_THIS/
+SPLIT_SUMMARY_BEFORE_THIS
 Extended part from article with custom separator.

data/fixtures/summary-app/source/2016-05-21-article-with-comment-separator.html.markdown

@@ -0,0 +1,7 @@
+---
+title: "Article with HTML comment summary separator"
+---
+
+Summary from article with HTML comment separator.
+<!--more-->
+Extended part from article with HTML comment separator.

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

@@ -1,5 +1,6 @@
 require "middleman-blog"
-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.tag_template = "/tag.html"

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

@@ -0,0 +1,8 @@
+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'
+  blog.filter       = proc { |article| !article.title.start_with?('Another') }
+end

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

@@ -1,6 +1,8 @@
+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"
+  blog.sources            = 'blog/:year-:month-:day-:title.html'
+  blog.permalink          = 'blog/:year-:month-:day-:title.html'
+  blog.tag_template       = '/tag.html'
   blog.generate_tag_pages = false
 end

data/fixtures/tags-app/config.rb

@@ -1,5 +1,6 @@
 require "middleman-blog"
-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.tag_template = "/tag.html"

data/fixtures/tags-app/source/blog/2011-01-03-no-taga.html.markdown

@@ -0,0 +1,6 @@
+---
+title: "Article"
+date: 2011-01-03
+---
+
+No tags here

data/lib/middleman-blog.rb

@@ -1,8 +1,11 @@
 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

@@ -4,89 +4,122 @@ 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
+
+    ##
+    # A module that adds blog-article-specific methods to Resources. A
+    # {BlogArticle} can be retrieved via {Blog::Helpers#current_article} or
     # methods on {BlogData} (like {BlogData#articles}).
+    #
     # @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
 
+      ##
       # A reference to the {BlogData} for this article's blog.
+      #
       # @return [BlogData]
+      ##
       def blog_data
         blog_controller.data
       end
 
+      ##
       # The options for this article's blog.
+      #
       # @return [ConfigurationManager]
+      ###
       def blog_options
         blog_controller.options
       end
 
+      ##
       # Render this resource to a string with the appropriate layout.
       # Called automatically by Middleman.
+      #
       # @return [String]
+      ##
       def render(opts={}, locs={}, &block)
-        unless opts.has_key?(:layout)
+
+        unless opts.has_key?( :layout )
+
           opts[:layout] = metadata[:options][:layout]
-          opts[:layout] = blog_options.layout if opts[:layout].nil?
+          opts[:layout] = blog_options.layout if opts[:layout].nil? || opts[:layout] == :_auto_layout
+
           # Convert to a string unless it's a boolean
           opts[:layout] = opts[:layout].to_s if opts[:layout].is_a? Symbol
+
         end
 
         content = super(opts, locs, &block)
 
         unless opts[:keep_separator]
-          content.sub!(blog_options.summary_separator, "")
+          content.sub!(blog_options.summary_separator, '')
         end
 
         content
       end
 
+      ##
       # The title of the article, set from frontmatter.
+      #
       # @return [String]
+      ##
       def title
-        data["title"]
+        data['title']
       end
 
+      ##
       # Whether or not this article has been published.
-      #
       # An article is considered published in the following scenarios:
       #
       # 1. Frontmatter does not set +published+ to false and either
       # 2. The blog option +publish_future_dated+ is true or
       # 3. The article's date is after the current time
+      #
       # @return [Boolean]
+      ##
       def published?
-        data["published"] != false && (blog_options.publish_future_dated || date <= Time.current)
+        data['published'] != false && (blog_options.publish_future_dated || date <= Time.current)
       end
 
-      # The body of this article, in HTML (no layout). This is for
-      # things like RSS feeds or lists of articles - individual
-      # articles will automatically be rendered from their
-      # template.
+      ##
+      # The body of this article, in HTML (no layout). This is for things like
+      # RSS feeds or lists of articles - individual articles will automatically
+      # be rendered from their template.
+      #
       # @return [String]
+      ##
       def body
         render layout: false
       end
 
+      ##
       # The summary for this article, in HTML.
       #
-      # The blog option +summary_generator+ can be set to a +Proc+ in order to provide
-      # custom summary generation. The +Proc+ is provided
-      # the rendered content of the article (without layout), the
-      # desired length to trim the summary to, and the ellipsis string to use.
-      # Otherwise the {#default_summary_generator} will be used, which returns either
+      # The blog option +summary_generator+ can be set to a +Proc+ in order to
+      # provide custom summary generation. The +Proc+ is provided the rendered
+      # content of the article (without layout), the desired length to trim the
+      # summary to, and the ellipsis string to use. Otherwise the
+      # {#default_summary_generator} will be used, which returns either
       # everything before the summary separator (set via the blog option
-      # +summary_separator+ and defaulting to "READMORE") if it is found,
-      # or the first +summary_length+ characters of the post.
+      # +summary_separator+ and defaulting to "READMORE") if it is found, or the
+      # first +summary_length+ characters of the post.
       #
       # @param [Number] length How many characters to trim the summary to.
       # @param [String] ellipsis The ellipsis string to use when content is trimmed.
       # @return [String]
+      ##
       def summary(length=nil, ellipsis='...')
         rendered = render layout: false, keep_separator: true
 
@@ -95,8 +128,10 @@ module Middleman
         else
           default_summary_generator(rendered, length, ellipsis)
         end
+
       end
 
+      ##
       # The default summary generator first tries to find the +summary_separator+ and
       # take the text before it. If that doesn't work, it will truncate text without splitting
       # the middle of an HTML tag, using a Nokogiri-based {TruncateHTML} utility.
@@ -104,33 +139,46 @@ module Middleman
       # @param [String] rendered The rendered blog article
       # @param [Integer] length The length in characters to truncate to.
       #   -1 or +nil+ will return the whole article.
+      # @param [String] ellipsis The ellipsis string to use when content is trimmed.
+      ##
       def default_summary_generator(rendered, length, ellipsis)
-        if length && length >= 0
-          require 'middleman-blog/truncate_html'
-          TruncateHTML.truncate_at_length(rendered, length, ellipsis)
-        elsif blog_options.summary_separator && rendered.match(blog_options.summary_separator)
+
+        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)
+
+        elsif length && length >= 0
+          require 'middleman-blog/truncate_html'
+          TruncateHTML.truncate_at_length(rendered, length, ellipsis)
+
         elsif blog_options.summary_length && blog_options.summary_length > 0
           require 'middleman-blog/truncate_html'
           TruncateHTML.truncate_at_length(rendered, blog_options.summary_length, ellipsis)
+
         else
           rendered
         end
+
       end
 
+      ##
       # A list of tags for this article, set from frontmatter.
+      #
       # @return [Array<String>] (never +nil+)
+      ##
       def tags
-        article_tags = data["tags"]
+
+        article_tags = data['tags']
 
         if article_tags.is_a? String
           article_tags.split(',').map(&:strip)
         else
           Array(article_tags).map(&:to_s)
         end
+
       end
 
+      ##
       # The language of the article. The language can be present in the
       # frontmatter or in the source path. If both are present, they
       # must match. If neither specifies a lang, I18n's default_locale will
@@ -138,9 +186,11 @@ module Middleman
       # activated at all, +nil+ will be returned.
       #
       # @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')
+        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})"
@@ -154,13 +204,16 @@ module Middleman
 
       alias_method :lang, :locale
 
+      ##
       # Attempt to figure out the date of the post. The date should be
       # present in the source path, but users may also provide a date
       # in the frontmatter in order to provide a time of day for sorting
       # reasons.
       #
       # @return [TimeWithZone]
+      ##
       def date
+
         return @_date if @_date
 
         frontmatter_date = data['date']
@@ -174,6 +227,7 @@ module Middleman
 
         # Next figure out the date from the filename
         source_vars = blog_data.source_template.variables
+
         if source_vars.include?('year') &&
            source_vars.include?('month') &&
            source_vars.include?('day')
@@ -184,59 +238,128 @@ module Middleman
           else
             @_date = filename_date.to_time.in_time_zone
           end
+
         end
 
         raise "Blog post #{path} needs a date in its filename or frontmatter" unless @_date
 
         @_date
+
       end
 
+      ##
       # The "slug" of the article that shows up in its URL. The article slug
-      # is a parameterized version of the {#title} (lowercase, spaces replaced
+      # is a parametrized version of the {#title} (lowercase, spaces replaced
       # with dashes, etc) and can be used in the blog +permalink+ as +:title+.
       #
       # @return [String]
+      ##
       def slug
         if data['slug']
-          data['slug']
+          Blog::UriTemplates.safe_parameterize(data['slug'])
+
         elsif blog_data.source_template.variables.include?('title')
-          path_part('title')
+          Blog::UriTemplates.safe_parameterize(path_part('title'))
+
         elsif title
           Blog::UriTemplates.safe_parameterize(title)
+
         else
           raise "Can't generate a slug for #{path} because it has no :title in its path pattern or title/slug in its frontmatter."
+
         end
       end
 
-      # The previous (chronologically earlier) article before this one
-      # or +nil+ if this is the first article.
+      ##
+      # The previous (chronologically earlier) article before this one or
+      # +nil+ if this is the first article.
+      #
+      # @deprecated Use {#article_previous} instead.
+      #
       # @return [BlogArticle]
+      ##
       def previous_article
-        blog_data.articles.find {|a| a.date < self.date }
+        article_previous()
       end
+      deprecate :previous_article, :article_previous, 2017, 5
 
-      # The next (chronologically later) article after this one
-      # or +nil+ if this is the most recent article.
+      ##
+      # The next (chronologically later) article after this one or +nil+ if
+      # this is the most recent article.
+      #
+      # @deprecated Use {#article_next} instead.
+      #
       # @return [Middleman::Sitemap::Resource]
+      ##
       def next_article
-        blog_data.articles.reverse.find {|a| a.date > self.date }
+        article_next()
+      end
+      deprecate :next_article, :article_next, 2017, 5
+
+      ##
+      # The previous (chronologically earlier) article before this one or
+      # +nil+ if this is the first article.
+      #
+      # @return [BlogArticle]
+      ##
+      def article_previous
+        blog_data.articles.find { |a| a.date < self.date }
+      end
+
+      ##
+      # The next (chronologically later) article after this one or +nil+ if
+      # this is the most recent article.
+      #
+      # @return [Middleman::Sitemap::Resource]
+      ##
+      def article_next
+        blog_data.articles.reverse.find { |a| a.date > self.date }
+      end
+
+      ##
+      # The previous (chronologically earlier) article before this one in the
+      # current locale, or +nil+ if this is the first article.
+      #
+      # @return [BlogArticle]
+      ##
+      def article_locale_previous
+        blog_data.local_articles.find { |a| a.date < self.date }
+      end
+
+      ##
+      # The next (chronologically later) article after this one in the current
+      # locale or +nil+ if this is the most recent article.
+      #
+      # @return [Middleman::Sitemap::Resource]
+      ##
+      def article_locale_next
+        blog_data.local_articles.reverse.find { |a| a.date > self.date }
       end
 
+      ##
       # This is here to prevent out-of-memory on exceptions.
+      #
       # @private
+      ##
       def inspect
         "#<Middleman::Blog::BlogArticle: #{data.inspect}>"
       end
 
       private
 
+      ##
       # Retrieve a section of the source path template.
+      #
       # @param [String] part The part of the path, e.g. "lang", "year", "month", "day", "title"
       # @return [String]
+      ##
       def path_part(part)
         @_path_parts ||= Blog::UriTemplates.extract_params(blog_data.source_template, path)
         @_path_parts[part.to_s]
       end
+
     end
+
   end
+
 end