middleman-blog 3.1.1 → 3.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 307641a41396030f5930374adc6ccd8016e4fcd3
+  data.tar.gz: 4fceaaa05d6742597a5f281192da389ab70da601
+SHA512:
+  metadata.gz: a06536de8efae6ee8df31ec992d7f8c19b3f82506eff011050eb5ec39dd4fc0f7989bdcad6985787de2381f593ded44f5e9e564f8a38c5a0b4eddb66a0213149
+  data.tar.gz: bb6d528615b52afcd59c976f8d1f93fe7fadc521d989894f270db7cb45524af94686e535732d22cea399a0b7485dc9ce79f5b9ccf380c1dcc28336513dd3def8

data/.travis.yml

@@ -2,6 +2,7 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
 

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+3.2.0
+====
+
+* The `summary` method on articles is now HTML-aware, and can be provided with
+  a different summary length or ellipsis string: `summary(1000, '…')`. 
+  Nokogiri is required to use the summary.
+* The `summary_generator` option now recieves the rendered article (without
+  layout) instead of the template source.
+* Set `summary_length` to false to always use the full article as a summary.
+* Future-dated articles can still be generated if `publish_future_dated` is true.
+* The `summary_separator` option no longer needs to have a capturing group, or
+  even be a regexp.
+
 3.1.1
 ====
 * Correctly handle time zone, allow setting time zone with `set :time_zone`. #76

data/Gemfile

@@ -1,6 +1,6 @@
-source :rubygems
+source 'http://rubygems.org'
 
-git "git://github.com/middleman/middleman.git" do
+git "git://github.com/middleman/middleman.git", :branch => "master" do
   # gem "middleman"
   gem "middleman-core"
   gem "middleman-more"
@@ -9,20 +9,17 @@ end
 # Specify your gem's dependencies in middleman-blog.gemspec
 gemspec
 
-group :development do
-  gem "rake",     "~> 0.9.2"
-  gem "rdoc",     "~> 3.9"
-  gem "yard",     "~> 0.8.0"
-end
+gem "rake",     "~> 0.9.2"
+gem "rdoc",     "~> 3.9"
+gem "yard",     "~> 0.8.0"
+
+gem "cucumber", "~> 1.2.0"
+gem "fivemat"
+gem "aruba",    "~> 0.4.11"
+gem "rspec",    "~> 2.7"
+gem "timecop",  "~> 0.4.0"
+gem "nokogiri"
 
-group :test do
-  gem "cucumber", "~> 1.2.0"
-  gem "fivemat"
-  gem "aruba",    "~> 0.4.11"
-  gem "rspec",    "~> 2.7"
-  gem "timecop",  "~> 0.4.0"
-  
-  platforms :ruby do
-    gem "redcarpet", "~> 2.1.1"
-  end
+platforms :ruby do
+  gem "redcarpet", "~> 2.1.1"
 end

data/README.md

@@ -20,7 +20,7 @@ activate :blog
 
 # Learn More
 
-See [the blog extension guide](http://beta.middlemanapp.com/extensions/blog/) for detailed information on configuring and using the blog extension.
+See [the blog extension guide](http://middlemanapp.com/blogging/) for detailed information on configuring and using the blog extension.
 
 Up-to-date generated code documentation is available on RubyDoc: 
 http://rubydoc.info/github/middleman/middleman-blog
@@ -41,7 +41,7 @@ The best way to get quick responses to your issues and swift fixes to your bugs
 
 # Build & Dependency Status
 
-[![Build Status](http://travis-ci.org/middleman/middleman-blog.png)](http://travis-ci.org/middleman/middleman-blog)
+[![Build Status](https://travis-ci.org/middleman/middleman-blog.png)](https://travis-ci.org/middleman/middleman-blog)
 
 # How to Run Cucumber Tests
 
@@ -52,7 +52,7 @@ The best way to get quick responses to your issues and swift fixes to your bugs
 
 # Donate
 
-[![Click here to lend your support to Middleman](https://www.pledgie.com/campaigns/15807.png)](http://www.pledgie.com/campaigns/15807)
+Please, [help support the Middleman team with a donation](https://spb.io/s/4dXbHBorC3).
 
 # License
 

data/features/future_date.feature

@@ -34,3 +34,23 @@ Feature: Future-dated blog articles
     Then I should see "This is a future-dated article"
     When I go to "/2012/06/19/future-article/example.txt"
     Then I should see "Example Text"
+
+  Scenario: Future-dated articles show up when publish_future_dated is true
+    Given a fixture app "future-date-app"
+    And a file named "config.rb" with:
+      """
+      set :environment, :production
+      Time.zone = "Pacific Time (US & Canada)"
+      activate :blog do |blog|
+        blog.sources = "blog/:year-:month-:day-:title.html"
+        blog.publish_future_dated = true
+      end
+      """
+    Given the date is 2012-06-18
+    And the Server is running at "future-date-app"
+    When I go to "/2011/01/01/new-article.html"
+    Then I should see "Newer Article Content"
+    When I go to "/2012/06/19/future-article.html"
+    Then I should see "This is a future-dated article"
+    When I go to "/2012/06/19/future-article/example.txt"
+    Then I should see "Example Text"

data/lib/middleman-blog/blog_article.rb

@@ -19,8 +19,8 @@ module Middleman
         content = super(opts, locs, &block)
 
         unless opts[:keep_separator]
-          if content =~ app.blog.options.summary_separator
-            content.sub!($1, "")
+          if content.match(app.blog.options.summary_separator)
+            content.sub!(app.blog.options.summary_separator, "")
           end
         end
 
@@ -34,9 +34,16 @@ module Middleman
       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. published_future_dated is true or
+      # 3. article date is after the current time
       # @return [Boolean]
       def published?
-        data["published"] != false and date <= Time.current
+        (data["published"] != false) and
+          (app.blog.options.publish_future_dated || date <= Time.current)
       end
 
       # The body of this article, in HTML. This is for
@@ -52,29 +59,36 @@ module Middleman
       # everything before the summary separator (set via :summary_separator
       # and defaulting to "READMORE") or the first :summary_length
       # characters of the post.
+      #
+      # :summary_generator can be set to a Proc in order to provide
+      # custom summary generation. The Proc is provided a parameter
+      # which is the rendered content of the article (without layout), the
+      # desired length to trim the summary to, and the ellipsis string to use.
+      #
+      # @param [Number] length How many characters to trim the summary to.
+      # @param [Number] length The ellipsis string to use when content is trimmed.
       # @return [String]
-      def summary
-        @_summary ||= begin
-          source = app.template_data_for_file(source_file).dup
-
-          summary_source = if app.blog.options.summary_generator
-                             app.blog.options.summary_generator.call(self, source)
-                           else
-                             default_summary_generator(source)
-                           end
-
-          md   = metadata.dup
-          locs = md[:locals]
-          opts = md[:options].merge({:template_body => summary_source})
-          app.render_individual_file(source_file, locs, opts)
+      def summary(length=app.blog.options.summary_length, ellipsis='...')
+        rendered = render(:layout => false, :keep_separator => true)
+
+        if app.blog.options.summary_separator && rendered.match(app.blog.options.summary_separator)
+          rendered.split(app.blog.options.summary_separator).first
+        elsif app.blog.options.summary_generator
+          app.blog.options.summary_generator.call(self, rendered, length, ellipsis)
+        else
+          default_summary_generator(rendered, length, ellipsis)
         end
       end
 
-      def default_summary_generator(source)
-        if source =~ app.blog.options.summary_separator
-          source.split(app.blog.options.summary_separator).first
+      def default_summary_generator(rendered, length, ellipsis)
+        require 'middleman-blog/truncate_html'
+
+        if rendered =~ app.blog.options.summary_separator
+          rendered.split(app.blog.options.summary_separator).first
+        elsif length
+          TruncateHTML.truncate_html(rendered, length, ellipsis)
         else
-          source.match(/(.{1,#{app.blog.options.summary_length}}.*?)(\n|\Z)/m).to_s
+          rendered
         end
       end
 

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

@@ -33,7 +33,7 @@ module Middleman
         if shared_instance.respond_to? :blog
           @title = title
           @slug = title.parameterize
-          @date = options[:date] ? DateTime.parse(options[:date]) : DateTime.now
+          @date = options[:date] ? Time.zone.parse(options[:date]) : Time.zone.now
 
           article_path = shared_instance.blog.options.sources.
             sub(':year', @date.year.to_s).

data/lib/middleman-blog/extension.rb

@@ -21,7 +21,8 @@ module Middleman
               :tag_template,
               :paginate,
               :per_page,
-              :page_link
+              :page_link,
+              :publish_future_dated
              ]
       
       KEYS.each do |name|
@@ -48,19 +49,20 @@ module Middleman
         options = Options.new(options_hash)
         yield options if block_given?
         
-        options.permalink         ||= "/:year/:month/:day/:title.html"
-        options.sources           ||= ":year-:month-:day-:title.html"
-        options.taglink           ||= "tags/:tag.html"
-        options.layout            ||= "layout"
-        options.summary_separator ||= /(READMORE)/
-        options.summary_length    ||= 250
-        options.year_link         ||= "/:year.html"
-        options.month_link        ||= "/:year/:month.html"
-        options.day_link          ||= "/:year/:month/:day.html"
-        options.default_extension ||= ".markdown"
-        options.paginate          ||= false
-        options.per_page          ||= 10
-        options.page_link         ||= "page/:num"
+        options.permalink            ||= "/:year/:month/:day/:title.html"
+        options.sources              ||= ":year-:month-:day-:title.html"
+        options.taglink              ||= "tags/:tag.html"
+        options.layout               ||= "layout"
+        options.summary_separator    ||= /(READMORE)/
+        options.summary_length       ||= 250
+        options.year_link            ||= "/:year.html"
+        options.month_link           ||= "/:year/:month.html"
+        options.day_link             ||= "/:year/:month/:day.html"
+        options.default_extension    ||= ".markdown"
+        options.paginate             ||= false
+        options.per_page             ||= 10
+        options.page_link            ||= "page/:num"
+        options.publish_future_dated ||= false
 
         # optional: :tag_template
         # optional: :year_template

data/lib/middleman-blog/template/source/feed.xml.builder

@@ -16,7 +16,7 @@ xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
       xml.published article.date.to_time.iso8601
       xml.updated article.date.to_time.iso8601
       xml.author { xml.name "Article Author" }
-      xml.summary article.summary, "type" => "html"
+      # xml.summary article.summary, "type" => "html"
       xml.content article.body, "type" => "html"
     end
   end

data/lib/middleman-blog/template/source/index.html.erb

@@ -12,7 +12,9 @@ per_page: 10
 
 <% page_articles.each_with_index do |article, i| %>
   <h2><%= link_to article.title, article %> <span><%= article.date.strftime('%b %e') %></span></h2>
-  <p><%= article.summary %></p>
+  <!-- use article.summary(250) if you have Nokogiri available to show just
+       the first 250 characters -->
+  <%= article.body %>
 <% end %>
 
 <% if paginate %>

data/lib/middleman-blog/template/source/layout.erb

@@ -14,21 +14,21 @@
       <h2>Recent Articles</h2>
       <ol>
         <% blog.articles[0...10].each do |article| %>
-          <li><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e') %></span></li>
+          <li><%= link_to article.title, article %> <span><%= article.date.strftime('%b %e') %></span></li>
         <% end %>
       </ol>
 
       <h2>Tags</h2>
       <ol>
         <% blog.tags.each do |tag, articles| %>
-          <li><a href="<%= tag_path tag %>"><%= tag %> (<%= articles.size %>)</a></li>
+          <li><%= link_to tag, tag_path(tag) %> (<%= articles.size %>)</a></li>
         <% end %>
       </ol>
 
       <h2>By Year</h2>
       <ol>
         <% blog.articles.group_by {|a| a.date.year }.each do |year, articles| %>
-          <li><a href="<%= blog_year_path year %>"><%= year %> (<%= articles.size %>)</a></li>
+          <li><%= link_to year, blog_year_path(year) %> (<%= articles.size %>)</a></li>
         <% end %>
       </ol>
     </aside>

data/lib/middleman-blog/truncate_html.rb

@@ -0,0 +1,53 @@
+begin
+  require "nokogiri"
+rescue LoadError
+  raise "Nokogiri is required for blog post summaries. Add 'nokogiri' to your Gemfile."
+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 = "...")
+    ellipsis_length = ellipsis.length     
+    doc = Nokogiri::HTML::DocumentFragment.parse text
+    content_length = doc.inner_text.length
+    actual_length = max_length - ellipsis_length
+    if content_length > actual_length 
+      doc.truncate(actual_length, ellipsis).inner_html
+    else
+      text
+    end
+  end
+end
+
+module NokogiriTruncator
+  module NodeWithChildren
+    def truncate(max_length, ellipsis)
+      return self if inner_text.length <= max_length
+      truncated_node = self.dup
+      truncated_node.children.remove
+
+      self.children.each do |node|
+        remaining_length = max_length - truncated_node.inner_text.length
+        break if remaining_length <= 0
+        truncated_node.add_child node.truncate(remaining_length, ellipsis)
+      end
+      truncated_node
+    end
+  end
+
+  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 << ellipsis if trimmed_content.length < content.length
+
+      Nokogiri::XML::Text.new(trimmed_content, parent)
+    end
+  end
+
+end
+
+Nokogiri::HTML::DocumentFragment.send(:include, NokogiriTruncator::NodeWithChildren)
+Nokogiri::XML::Element.send(:include, NokogiriTruncator::NodeWithChildren)
+Nokogiri::XML::Text.send(:include, NokogiriTruncator::TextNode)

data/lib/middleman-blog/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Blog
-    VERSION = "3.1.1"
+    VERSION = "3.2.0"
   end
 end

data/middleman-blog.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -z -- {fixtures,features}/*`.split("\0")
   s.require_paths = ["lib"]
   
-  s.add_dependency("middleman-core", ["~> 3.0.1"])
+  s.add_dependency("middleman-core", ["~> 3.0"])
   s.add_dependency("maruku", ["~> 0.6.0"])
   s.add_dependency("tzinfo", ["~> 0.3.0"])
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog
 version: !ruby/object:Gem::Version
-  version: 3.1.1
-  prerelease: 
+  version: 3.2.0
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -10,28 +9,25 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-21 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: maruku
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -202,38 +195,32 @@ files:
 - lib/middleman-blog/template/source/index.html.erb
 - lib/middleman-blog/template/source/layout.erb
 - lib/middleman-blog/template/source/tag.html.erb
+- lib/middleman-blog/truncate_html.rb
 - lib/middleman-blog/version.rb
 - lib/middleman_extension.rb
 - middleman-blog.gemspec
 homepage: https://github.com/middleman/middleman-blog
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3637459157260692446
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3637459157260692446
 requirements: []
 rubyforge_project: middleman-blog
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A blog foundation using Middleman
 test_files:
 - features/article_cli.feature