middleman-blog 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a954456dd37131a13ebabbdb3cb2cd2876f31c83
-  data.tar.gz: 9fe2db291d746b24bef90d3acfd16e966f1381c0
+  metadata.gz: 6437136847c6ca3dfc732f0585d154969a140967
+  data.tar.gz: 7d6a917c2f463b52a95a6b1e5c5fc73ff4e0b120
 SHA512:
-  metadata.gz: 97feb50f6597a1123b1e9f06d5a95d7a1479997b921da68ff15d84ba484607bb664de385f7fef4f6547dd972871bc3ff62521f346dcc2d00e4e48f88b7e4248a
-  data.tar.gz: 6be516bced8dba93bd1320f5b00e69d31466fd41286cb71422e3afc1a03fbda4814ff23f512e610bb27698f056ea3d0ec77ad70c7c39f9299a711f8eb6d73ffc
+  metadata.gz: 6b27cbe706b043afb84067b974bdf574bf70e006abb0c111b006c12e9a489f114255456a2152a13d68ae816b3abd9eb02c77c4efc16b5833fcc902ca45106180
+  data.tar.gz: 2b26df677ed97f8806102ae623b7d193820e44175b64d7a1d5bbda4b9c48897ddbf39f6f823ba66f1a6020659304010d788978dd7f668a0ece97a6e77faaecba

data/features/summary.feature

@@ -2,9 +2,9 @@ Feature: Article summary generation
   Scenario: Article has no summary separator
     Given the Server is running at "summary-app"
     When I go to "/index.html"
-    Then I should see "Summary from article with separator."
+    Then I should see "<p>Summary from article with separator.</p>"
     Then I should not see "Extended part from article with separator."
-    Then I should see "Summary from article with no separator."
+    Then I should see "<p>Summary from article with no separator.</p>"
     Then I should not see "Extended part from article with no separator."
 
   Scenario: Article has custom summary separator
@@ -17,7 +17,11 @@ Feature: Article summary generation
       """
     Given the Server is running at "summary-app"
     When I go to "/index.html"
-    Then I should see "Summary from article with custom separator."
+    Then I should see:
+      """
+      <p>Summary from article with custom separator.
+      </p>
+      """
     Then I should not see "Extended part from article with custom separator."
     Then I should see "Extended part from article with separator."
 
@@ -32,7 +36,7 @@ Feature: Article summary generation
     Given the Server is running at "summary-app"
     When I go to "/index.html"
     Then I should see "This is my summary, and I like it"
-    Then I should see "Summary from article"
+    Then I should not see "Summary from article"
     Then I should not see "Summary from article with no separator"
     Then I should not see "Extended part from article"
 
@@ -54,3 +58,25 @@ Feature: Article summary generation
     When I go to "/index.html"
     Then I should see "Extended part from article with no separator."
     Then I should not see "Extended part from article with separator."
+
+  Scenario: Summary limited by length only
+    Given a fixture app "summary-app"
+    And a file named "config.rb" with:
+      """
+      activate :blog
+      """
+    And a file named "source/index.html.erb" with:
+      """
+      <% @i = 0 %>
+      <% blog.articles.each do |article| %>
+        <article>
+          <%= article.summary(7, (@i += 1).to_s) %>
+        </article>
+      <% end %>
+      """
+    Given the Server is running at "summary-app"
+    When I go to "/index.html"
+    Then I should see "Summary1"
+    Then I should see "Summary2"
+    Then I should see "Summary3"
+    Then I should see "Summary4"

data/fixtures/paginate-app/source/_pager.erb

@@ -0,0 +1,15 @@
+Paginate: <%= paginate %>
+Article Count: <%= page_articles.size %>
+<% if paginate %>
+Page Num: <%= page_number %>
+Num Pages: <%= num_pages %>
+Per Page: <%= per_page %>
+Page Start: <%= page_start %>
+Page End: <%= page_end %>
+Next Page: '<%= next_page.url if next_page %>'
+Prev Page: '<%= prev_page.url if prev_page %>'
+<% end %>
+
+<% page_articles.each do |article| %>
+  <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+<% end %>

data/fixtures/paginate-app/source/partial-paging.html.erb

@@ -0,0 +1,5 @@
+---
+pageable: true
+---
+
+<%= partial 'pager' %>

data/lib/middleman-blog.rb

@@ -3,5 +3,6 @@ require "middleman-blog/version"
 
 ::Middleman::Extensions.register(:blog) do
   require "middleman-blog/extension"
+  require "middleman-blog/commands/article"
   ::Middleman::BlogExtension
 end

data/lib/middleman-blog/blog_article.rb

@@ -73,26 +73,24 @@ module Middleman
         render layout: false
       end
 
-      # The summary for this article, in HTML. The summary is either
-      # everything before the summary separator (set via the blog option
-      # +summary_separator+ and defaulting to "READMORE") or the first
-      # +summary_length+ characters of the post.
+      # 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.
+      # 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.
       #
       # @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=blog_options.summary_length, ellipsis='...')
+      def summary(length=nil, ellipsis='...')
         rendered = render layout: false, keep_separator: true
 
-        if blog_options.summary_separator && rendered.match(blog_options.summary_separator)
-          rendered.split(blog_options.summary_separator).first
-        elsif blog_options.summary_generator
+        if blog_options.summary_generator
           blog_options.summary_generator.call(self, rendered, length, ellipsis)
         else
           default_summary_generator(rendered, length, ellipsis)
@@ -107,11 +105,15 @@ module Middleman
       # @param [Integer] length The length in characters to truncate to.
       #   -1 or +nil+ will return the whole article.
       def default_summary_generator(rendered, length, ellipsis)
-        if blog_options.summary_separator && rendered =~ blog_options.summary_separator
-          rendered.split(blog_options.summary_separator).first
-        elsif length && length >= 0
+        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)
+          require 'middleman-blog/truncate_html'
+          TruncateHTML.truncate_at_separator(rendered, blog_options.summary_separator)
+        elsif blog_options.summary_length && blog_options.summary_length > 0
           require 'middleman-blog/truncate_html'
-          TruncateHTML.truncate_html(rendered, length, ellipsis)
+          TruncateHTML.truncate_at_length(rendered, blog_options.summary_length, ellipsis)
         else
           rendered
         end

data/lib/middleman-blog/blog_data.rb

@@ -8,6 +8,8 @@ module Middleman
     class BlogData
       include UriTemplates
 
+      DEFAULT_FILTER = proc {|a| a}
+
       # A URITemplate for the source file path relative to :source_dir
       # @return [URITemplate]
       attr_reader :source_template
@@ -27,6 +29,11 @@ module Middleman
         # A list of resources corresponding to blog articles
         @_articles = []
 
+        @_parsed_url_cache = {
+          source: {},
+          subdir: {}
+        }
+
         @source_template = uri_template options.sources
         @permalink_template = uri_template options.permalink
         @subdir_template = uri_template options.sources.sub(/\.[^.]+$/, "/{+path}")
@@ -36,7 +43,7 @@ module Middleman
       # A list of all blog articles, sorted by descending date
       # @return [Array<Middleman::Sitemap::Resource>]
       def articles
-        @_articles.sort_by(&:date).reverse
+        @_articles.select(&(options.filter || DEFAULT_FILTER)).sort_by(&:date).reverse
       end
 
       # A list of all blog articles with the given language,
@@ -70,6 +77,14 @@ module Middleman
         tags
       end
 
+      def extract_source_params(path)
+        @_parsed_url_cache[:source][path] ||= extract_params(@source_template, path)
+      end
+
+      def extract_subdir_params(path)
+        @_parsed_url_cache[:subdir][path] ||= extract_params(@subdir_template, path)
+      end
+
       # Updates' blog articles destination paths to be the
       # permalink.
       # @return [void]
@@ -84,7 +99,7 @@ module Middleman
             next
           end
 
-          if (params = extract_params(@source_template, resource.path))
+          if (params = extract_source_params(resource.path))
             article = convert_to_article(resource)
             next unless publishable?(article)
 
@@ -98,7 +113,7 @@ module Middleman
 
             @_articles << article
 
-          elsif (params = extract_params(@subdir_template, resource.path))
+          elsif (params = extract_subdir_params(resource.path))
             # It's not an article, but it's thhe companion files for an article
             # (in a subdirectory named after the article)
             # figure out the matching article for this subdirectory file
@@ -167,7 +182,7 @@ module Middleman
         resource.blog_controller = controller
 
         if !options.preserve_locale && (locale = resource.locale || resource.lang)
-          resource.add_metadata options: { lang: locale, lang: locale }, locals: { lang: locale, locale: locale }
+          resource.add_metadata options: { lang: locale, locale: locale }, locals: { lang: locale, locale: locale }
         end
 
         resource

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

@@ -0,0 +1,78 @@
+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.
+    class Article < ::Thor::Group
+      include Thor::Actions
+      include Blog::UriTemplates
+
+      check_unknown_options!
+
+      # Template files are relative to this file
+      # @return [String]
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      argument :title, type: :string
+
+      class_option "date",
+        aliases: "-d",
+        desc: "The date to create the post with (defaults to now)"
+      class_option "lang",
+        desc: "Deprecated, use locale"
+      class_option "locale",
+        aliases: "-l",
+        desc: "The locale to create the post with (defaults to I18n.default_locale if avaliable)"
+      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)"
+      def article
+        config = ::Middleman::Cli.config
+
+        @title = title
+        @slug = safe_parameterize(title)
+        @date = options[:date] ? ::Time.zone.parse(options[:date]) : Time.zone.now
+        @lang = options[:lang] || options[:locale] || (::I18n.default_locale if defined? ::I18n )
+
+        app = ::Middleman::Application.new do
+          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][options[:blog]]
+        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]
+          throw msg
+        end
+
+        path_template = blog_inst.data.source_template
+        params = date_to_params(@date).merge(lang: @lang.to_s, locale: @locale.to_s, title: @slug)
+        article_path = apply_uri_template path_template, params
+
+        template blog_inst.options.new_article_template, File.join(app.source_dir, article_path + blog_inst.options.default_extension)
+      end
+
+      protected
+
+      def blog_instance(key)
+        return nil unless app.extensions[:blog]
+        return app.extensions[:blog][key]
+      end
+
+      # Add to CLI
+      Base.register(self, 'article', 'article TITLE [options]', 'Create a new blog article')
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+---
+title: <%= @title %>
+date: <%= @date.strftime('%F %R %Z') %>
+tags:
+---
+

data/lib/middleman-blog/extension.rb

@@ -34,6 +34,7 @@ module Middleman
     option :generate_tag_pages, true, 'Whether to generate tag pages.'
     option :paginate, false, 'Whether to paginate lists of articles'
     option :per_page, 10, 'Number of articles per page when paginating'
+    option :filter, nil, 'A proc that can be used to select articles that should be published based on user-defined criteria'
     option :page_link, 'page/{num}', 'Path to append for additional pages when paginating'
     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)'

data/lib/middleman-blog/truncate_html.rb

@@ -7,7 +7,18 @@ end
 # Taken and modified from http://madebydna.com/all/code/2010/06/04/ruby-helper-to-cleanly-truncate-html.html
 # MIT license
 module TruncateHTML
-  def self.truncate_html(text, max_length, ellipsis = "...")
+  def self.truncate_at_separator(text, separator)
+    text = text.encode('UTF-8') if text.respond_to?(:encode)
+    doc = Nokogiri::HTML::DocumentFragment.parse text
+    length = doc.inner_text =~ Regexp.new(separator)
+    if length
+      doc.truncate(length - 1, '').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)
     doc = Nokogiri::HTML::DocumentFragment.parse text

data/lib/middleman-blog/uri_templates.rb

@@ -41,7 +41,7 @@ module Middleman
       # @param [Addressable::Template] template
       # @param [String] path
       def extract_params(template, path)
-        params = template.extract(path, BlogTemplateProcessor)
+        template.extract(path, BlogTemplateProcessor)
       end
 
       # Parameterize a string preserving any multibyte characters

data/lib/middleman-blog/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Blog
-    VERSION = "4.0.0"
+    VERSION = "4.0.1"
   end
 end

data/middleman-blog.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency("middleman-core", [">= 4.0.0"])
   s.add_dependency("tzinfo", [">= 0.3.0"])
-  s.add_dependency("addressable", ["~> 2.4.0"])
+  s.add_dependency("addressable", ["~> 2.3"])
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-16 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '2.3'
 description: Blog engine for Middleman
 email:
 - me@tdreyno.com
@@ -244,6 +244,7 @@ files:
 - fixtures/paginate-app/config-directory-indexes.rb
 - fixtures/paginate-app/config-paginate-off.rb
 - fixtures/paginate-app/config.rb
+- fixtures/paginate-app/source/_pager.erb
 - fixtures/paginate-app/source/blog/2011-01-01-test-article.html.markdown
 - fixtures/paginate-app/source/blog/2011-01-02-test-article.html.markdown
 - fixtures/paginate-app/source/blog/2011-01-03-test-article.html.markdown
@@ -255,6 +256,7 @@ files:
 - fixtures/paginate-app/source/category.html.erb
 - fixtures/paginate-app/source/index.html.erb
 - fixtures/paginate-app/source/layout.erb
+- fixtures/paginate-app/source/partial-paging.html.erb
 - fixtures/paginate-app/source/tag.html.erb
 - fixtures/paginate-multiblog-app/config.rb
 - fixtures/paginate-multiblog-app/source/blog1/2011-01-01-test-article.html.markdown
@@ -333,6 +335,8 @@ files:
 - lib/middleman-blog/blog_article.rb
 - lib/middleman-blog/blog_data.rb
 - lib/middleman-blog/calendar_pages.rb
+- lib/middleman-blog/commands/article.rb
+- lib/middleman-blog/commands/article.tt
 - lib/middleman-blog/custom_pages.rb
 - lib/middleman-blog/extension.rb
 - lib/middleman-blog/helpers.rb
@@ -543,6 +547,7 @@ test_files:
 - fixtures/paginate-app/config-directory-indexes.rb
 - fixtures/paginate-app/config-paginate-off.rb
 - fixtures/paginate-app/config.rb
+- fixtures/paginate-app/source/_pager.erb
 - fixtures/paginate-app/source/blog/2011-01-01-test-article.html.markdown
 - fixtures/paginate-app/source/blog/2011-01-02-test-article.html.markdown
 - fixtures/paginate-app/source/blog/2011-01-03-test-article.html.markdown
@@ -554,6 +559,7 @@ test_files:
 - fixtures/paginate-app/source/category.html.erb
 - fixtures/paginate-app/source/index.html.erb
 - fixtures/paginate-app/source/layout.erb
+- fixtures/paginate-app/source/partial-paging.html.erb
 - fixtures/paginate-app/source/tag.html.erb
 - fixtures/paginate-multiblog-app/config.rb
 - fixtures/paginate-multiblog-app/source/blog1/2011-01-01-test-article.html.markdown