middleman-blog 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08ba0a40e858e3199220173897c437db62c6513e
-  data.tar.gz: 9d38d7176eb91b89ad0c8f125a2271553d3dbacc
+  metadata.gz: 9607656cf709f1ad3a4cc7ec060e3c3cd5e73ae3
+  data.tar.gz: 169bd0122267d51e7768885fdfa3a782d6a7f9af
 SHA512:
-  metadata.gz: 888e2bf9c611950366eeb2c65d2cee9f08914d0e0ceec9acdb65f42a940f581b23aedcf38cacf5108005f19009263f607b39a0ae6308c899d391be8aa6d5da50
-  data.tar.gz: 18a3c29946fc65bf638b736a8fde6873ebc67eb9e9c99491e2dbd11598d37e0705795ec0e16a21d2bd50b99ff70d5acf3a273e4fa1807d36ac33a01fe640888d
+  metadata.gz: 0bacecc695f007c53ba6df3b8dd259768b151b2b783f16a19762dad8fe5a90014c62c453e3c26c31614ebac8c58feb79cdaf85eeecc2eed8daeff8ec48ebe5cb
+  data.tar.gz: fbc3ce009ad08ccce6c644b4741dde9e36cdb1d4a00ca10514d4bd9afd1fa0218af78ad70f788a3d6d7eb783e2136c6f37d6ff08e5150a509a09b9719ec5351a

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-master
+3.5.1
+===
+
+* Remove a broken bracket in the blog template. #181
+* Fix transliteration of strings into URL slugs to still transliterate when it can but not smash multibyte chars. #183
+* Only match source URI templates if the date components match what a date would look like, and avoid throwing when companion files do not have an article. #184
+* Re-support spaces in blog article source paths. #185
+
+3.5.0
 ===
 
 * Add support for internationalization and locale-specific articles. #156

data/README.md

@@ -21,7 +21,7 @@ activate :blog
 
 ## Learn More
 
-See [the blog extension guide](http://middlemanapp.com/blogging/) for detailed information on configuring and using the blog extension.
+See [the blog extension guide](http://middlemanapp.com/basics/blogging/) for detailed information on configuring and using the blog extension.
 
 Additionally, up-to-date generated code documentation is available on [RubyDoc].
 

data/Rakefile

@@ -17,7 +17,15 @@ end
 
 require 'rake/clean'
 
-task :test => ["cucumber"]
+desc "Run tests, both RSpec and Cucumber"
+task :test => [:spec, :cucumber]
+
+require 'rspec/core/rake_task'
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
 
 begin
   require 'cane/rake_task'

data/lib/middleman-blog/blog_data.rb

@@ -78,7 +78,7 @@ module Middleman
         used_resources = []
 
         resources.each do |resource|
-          if (params = @source_template.extract(resource.path))
+          if (params = extract_params(@source_template, resource.path))
             article = convert_to_article(resource)
             next unless publishable?(article)
 
@@ -92,26 +92,25 @@ module Middleman
 
             @_articles << article
 
-          elsif (params = @subdir_template.extract(resource.path))
+          elsif (params = extract_params(@subdir_template, 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
 
             article_path = @source_template.expand(params).to_s
 
-            article = @app.sitemap.find_resource_by_path(article_path)
-            raise "Article for #{resource.path} not found" if article.nil?
+            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)
 
-            # The article may not yet have been processed, so convert it here.
-            article = convert_to_article(article)
-            next unless publishable?(article)
-
-            # The subdir path is the article path with the index file name
-            # or file extension stripped off.
-            path = params.fetch('path')
-            new_destination_path = template_path @subdir_permalink_template, article, path: path
+              # The subdir path is the article path with the index file name
+              # or file extension stripped off.
+              path = params.fetch('path')
+              new_destination_path = template_path @subdir_permalink_template, article, path: path
 
-            resource.destination_path = Middleman::Util.normalize_path(new_destination_path)
+              resource.destination_path = Middleman::Util.normalize_path(new_destination_path)
+            end
           end
 
           used_resources << resource

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

@@ -4,7 +4,7 @@
     <meta charset="utf-8" />
     <meta http-equiv='X-UA-Compatible' content='IE=edge;chrome=1' />
     <title>Blog Title<%= ' - ' + current_article.title unless current_article.nil? %></title>
-    <%= feed_tag :atom, "#{blog.options.prefix.to_s}/feed.xml"), title: "Atom Feed" %>
+    <%= feed_tag :atom, "#{blog.options.prefix.to_s}/feed.xml", title: "Atom Feed" %>
   </head>
   <body>
     

data/lib/middleman-blog/uri_templates.rb

@@ -1,4 +1,7 @@
 require 'addressable/template'
+require 'middleman-core/util'
+require 'active_support/inflector'
+require 'active_support/inflector/transliterate'
 
 module Middleman
   module Blog
@@ -32,14 +35,36 @@ module Middleman
         ::Middleman::Util.normalize_path Addressable::URI.unencode(template.expand(data)).to_s
       end
 
-      # Parameterize a string only if it does not contain UTF-8 characters
+      # Use a template to extract parameters from a path, and validate some special (date)
+      # keys. Returns nil if the special keys don't match.
+      #
+      # @param [Addressable::Template] template
+      # @param [String] path
+      def extract_params(template, path)
+        params = template.extract(path, BlogTemplateProcessor)
+      end
+
+      # Parameterize a string preserving any multibyte characters
       def safe_parameterize(str)
-        if str.chars.all? { |c| c.bytes.count == 1 }
-          str.parameterize
-        else
-          # At least change spaces to dashes
-          str.gsub(/\s+/, '-')
+        sep = '-'
+
+        # Reimplementation of http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize that preserves un-transliterate-able multibyte chars.
+        parameterized_string = ActiveSupport::Inflector.transliterate(str).downcase
+        parameterized_string.gsub!(/[^a-z0-9\-_\?]+/, sep)
+
+        parameterized_string.chars.to_a.each_with_index do |char, i|
+          if char == '?' && str[i].bytes.count != 1
+            parameterized_string[i] = str[i]
+          end
         end
+
+        re_sep = Regexp.escape(sep)
+        # No more than one of the separator in a row.
+        parameterized_string.gsub!(/#{re_sep}{2,}/, sep)
+        # Remove leading/trailing separator.
+        parameterized_string.gsub!(/^#{re_sep}|#{re_sep}$/, '')
+
+        parameterized_string
       end
 
       # Convert a date into a hash of components to strings
@@ -54,5 +79,20 @@ module Middleman
         }
       end
     end
+
+    # A special template processor that validates date fields
+    # and has an extra-permissive default regex.
+    #
+    # See https://github.com/sporkmonger/addressable/blob/master/lib/addressable/template.rb#L279
+    class BlogTemplateProcessor
+      def self.match(name)
+        case name
+        when 'year' then '\d{4}'
+        when 'month' then '\d{2}'
+        when 'day' then '\d{2}'
+        else '.*?'
+        end
+      end
+    end
   end
 end

data/lib/middleman-blog/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Blog
-    VERSION = "3.5.0"
+    VERSION = "3.5.1"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.root(File.expand_path(File.dirname(__FILE__) + '/..'))
+
+require 'coveralls'
+Coveralls.wear!

data/spec/uri_templates_spec.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+
+require 'middleman-blog/uri_templates'
+
+describe 'Middleman::Blog::UriTemplates' do
+  include Middleman::Blog::UriTemplates
+
+  describe 'safe_parameterize' do
+    it 'can parameterize normal strings' do
+      safe_parameterize('Some FUN stuff!').should == 'some-fun-stuff'
+    end
+
+    it "doesn't mangle unicode strings" do
+      safe_parameterize('☆☆☆').should == '☆☆☆'
+      safe_parameterize('明日がある').should == '明日がある'
+    end
+
+    it "still transliterates when it's safe" do
+      safe_parameterize('Schlagwörter').should == 'schlagworter'
+    end
+
+    it "can handle mixed strings" do
+      safe_parameterize('What ☆☆☆!').should == 'what-☆☆☆'
+    end
+  end
+
+  describe 'extract_params' do
+    it 'matches correctly' do
+      template = uri_template('{year}/{month}/{day}/{title}/{+path}')
+      params = extract_params(template, '2013/12/13/foo-bar/foo/bar.html')
+
+      params['year'].should == '2013'
+      params['month'].should == '12'
+      params['day'].should == '13'
+      params['title'].should == 'foo-bar'
+      params['path'].should == 'foo/bar.html'
+    end
+
+    it 'returns nil if there is no match' do
+      template = uri_template('{year}/{month}/{day}/{title}/{+path}')
+      extract_params(template, 'foo/bar.html').should == nil
+    end
+
+    it 'returns nil if there is no match in the date bits' do
+      template = uri_template('{year}/{month}/{day}/{title}/{+path}')
+      params = extract_params(template, '2a13/1a2/1s3/foo-bar/foo/bar.html')
+    end
+
+    it 'matches even when the path contains spaces' do
+      template = uri_template('{year}/{month}/{day}/{title}/{+path}')
+      params = extract_params(template, '2013/12/13/foo - bar/foo/bar.html')
+
+      params['year'].should == '2013'
+      params['month'].should == '12'
+      params['day'].should == '13'
+      params['title'].should == 'foo - bar'
+      params['path'].should == 'foo/bar.html'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-29 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -341,6 +341,8 @@ files:
 - lib/middleman-blog/version.rb
 - lib/middleman_extension.rb
 - middleman-blog.gemspec
+- spec/spec_helper.rb
+- spec/uri_templates_spec.rb
 homepage: https://github.com/middleman/middleman-blog
 licenses:
 - MIT