middleman-blog 4.0.2 → 4.0.3

data/lib/middleman-blog/tag_pages.rb

@@ -1,15 +1,12 @@
 require 'middleman-blog/uri_templates'
 
 module Middleman
-
   module Blog
-
     ##
     # A sitemap resource manipulator that adds a tag page to the sitemap for
     # each tag in the associated blog
     ##
     class TagPages
-
       include UriTemplates
 
       ##
@@ -18,7 +15,7 @@ module Middleman
       # @param  app             [Object] Middleman app
       # @param  blog_controller [Object] Blog controller
       ##
-      def initialize( app, blog_controller )
+      def initialize(app, blog_controller)
         @sitemap            = app.sitemap
         @blog_controller    = blog_controller
         @tag_link_template  = uri_template blog_controller.options.taglink
@@ -33,8 +30,8 @@ module Middleman
       # @param  tag [String] Tag name
       # @return     [String] Safe Tag URL
       ##
-      def link( tag )
-        apply_uri_template @tag_link_template, tag: safe_parameterize( tag )
+      def link(tag)
+        apply_uri_template @tag_link_template, tag: safe_parameterize(tag)
       end
 
       ##
@@ -43,14 +40,12 @@ module Middleman
       # @param  resources [Object] Tag name
       # @return           [void]
       ##
-      def manipulate_resource_list( resources )
-
+      def manipulate_resource_list(resources)
         return resources unless @generate_tag_pages
 
-        resources + @blog_data.tags.map do | tag, articles |
-          tag_page_resource( tag, articles )
+        resources + @blog_data.tags.map do |tag, articles|
+          tag_page_resource(tag, articles)
         end
-
       end
 
       private
@@ -64,27 +59,20 @@ module Middleman
       #
       # @todo Can we inject the correct locale into the metadata here
       ##
-      def tag_page_resource( tag, articles )
-
-        Sitemap::ProxyResource.new( @sitemap, link( tag ), @tag_template ).tap do | p |
-
+      def tag_page_resource(tag, articles)
+        Sitemap::ProxyResource.new(@sitemap, link(tag), @tag_template).tap do |p|
           # Detect "formatted" tag in first article - trying to guess the correct format to show
           # tagname = articles.first.tags.detect { |article_tag| safe_parameterize(article_tag) == tag }
 
           # Add metadata in local variables so it's accessible to later extensions
           p.add_metadata locals: {
-            'page_type'       => 'tag',
-            'tagname'         => tag,
-            'articles'        => articles,
+            'page_type' => 'tag',
+            'tagname' => tag,
+            'articles' => articles,
             'blog_controller' => @blog_controller
           }
-
         end
-
       end
-
     end
-
   end
-
 end

data/lib/middleman-blog/truncate_html.rb

@@ -1,5 +1,5 @@
 begin
-  require "nokogiri"
+  require 'nokogiri'
 rescue LoadError
   raise "Nokogiri is required for blog post summaries. Add 'nokogiri' to your Gemfile."
 end
@@ -13,7 +13,7 @@ module TruncateHTML
     doc.inner_html
   end
 
-  def self.truncate_at_length(text, max_length, ellipsis = "...")
+  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
@@ -31,12 +31,14 @@ module NokogiriTruncator
   module NodeWithChildren
     def truncate(max_length, ellipsis)
       return self if inner_text.length <= max_length
-      truncated_node = self.dup
+
+      truncated_node = dup
       truncated_node.children.remove
 
-      self.children.each do |node|
+      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
@@ -54,15 +56,14 @@ module NokogiriTruncator
   end
 
   module CommentNode
-    def truncate(*args)
+    def truncate(*_args)
       # Don't truncate comments, since they aren't visible
       self
     end
   end
-
 end
 
 Nokogiri::HTML::DocumentFragment.send(:include, NokogiriTruncator::NodeWithChildren)
 Nokogiri::XML::Element.send(:include, NokogiriTruncator::NodeWithChildren)
 Nokogiri::XML::Text.send(:include, NokogiriTruncator::TextNode)
-Nokogiri::XML::Comment.send(:include, NokogiriTruncator::CommentNode)
+Nokogiri::XML::Comment.send(:include, NokogiriTruncator::CommentNode)

data/lib/middleman-blog/uri_templates.rb

@@ -4,12 +4,9 @@ require 'active_support/inflector'
 require 'active_support/inflector/transliterate'
 
 module Middleman
-
   module Blog
-
     # Handy methods for dealing with URI templates. Mix into whatever class.
     module UriTemplates
-
       module_function
 
       ##
@@ -22,9 +19,7 @@ module Middleman
       ##
       def uri_template(tmpl_src)
         # Support the RFC6470 templates directly if people use them
-        if tmpl_src.include?(':')
-          tmpl_src = tmpl_src.gsub(/:([A-Za-z0-9]+)/, '{\1}')
-        end
+        tmpl_src = tmpl_src.gsub(/:([A-Za-z0-9]+)/, '{\1}') if tmpl_src.include?(':')
 
         Addressable::Template.new ::Middleman::Util.normalize_path(tmpl_src)
       end
@@ -52,15 +47,37 @@ module Middleman
         template.extract(path, BlogTemplateProcessor)
       end
 
-      ##
       # Parametrize a string preserving any multi-byte characters
       # Reimplementation of this, preserves un-transliterate-able multibyte chars.
       #
       # @see http://api.rubyonrails.org/classes/ActiveSupport/Inflector.html#method-i-parameterize
-      ##
-      def safe_parameterize(str)
-        parameterized_string = ::ActiveSupport::Inflector.transliterate(str.to_s)
-        parameterized_string.parameterize
+      def safe_parameterize(str, sep = '-')
+        # Remove ending ?
+        str = str.to_s.gsub(/\?$/, '')
+
+        # 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.to_s).downcase
+        parameterized_string.gsub!(/[^a-z0-9\-_\?]+/, sep)
+
+        # Check for multibytes and sub back in
+        parameterized_string.chars.to_a.each_with_index do |char, i|
+          next unless char == '?' && str[i].bytes.count != 1
+
+          parameterized_string[i] = str[i]
+        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.tr!('_', '-')
+        parameterized_string.delete!('?')
+
+        # Replace all ?
+        parameterized_string
       end
 
       ##
@@ -71,7 +88,7 @@ module Middleman
       # @return [Hash] parameters
       ##
       def date_to_params(date)
-        return {
+        {
           year: date.year.to_s,
           month: date.month.to_s.rjust(2, '0'),
           day: date.day.to_s.rjust(2, '0')
@@ -81,13 +98,12 @@ module Middleman
       ##
       #
       ##
-      def extract_directory_path( article_path )
+      def extract_directory_path(article_path)
         uri = Addressable::URI.parse article_path
 
         # Remove file extension from the article path
-        directory_path = uri.path.gsub( uri.extname, '' )
+        uri.path.gsub(uri.extname, '')
       end
-
     end
 
     ##
@@ -106,7 +122,5 @@ module Middleman
         end
       end
     end
-
   end
-
 end

data/lib/middleman-blog/version.rb

@@ -1,7 +1,5 @@
 module Middleman
-
   module Blog
-    VERSION = '4.0.2'
+    VERSION = '4.0.3'.freeze
   end
-
 end

data/lib/middleman_extension.rb

@@ -1 +1 @@
-require "middleman-blog"
+require 'middleman-blog'

data/middleman-blog.gemspec

@@ -1,25 +1,25 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
-require 'middleman-blog/version'
+$:.push File.expand_path( "../lib", __FILE__ )
+require "middleman-blog/version"
 
-Gem::Specification.new do |s|
+Gem::Specification.new do | s |
 
-  s.name                  = 'middleman-blog'
+  s.name                  = "middleman-blog"
   s.version               = Middleman::Blog::VERSION
   s.platform              = Gem::Platform::RUBY
-  s.authors               = ['Thomas Reynolds', 'Ben Hollis', 'Ian Warner']
-  s.email                 = ['me@tdreyno.com', 'ben@benhollis.net', 'ian.warner@drykiss.com']
-  s.homepage              = 'https://github.com/middleman/middleman-blog'
+  s.authors               = [ "Thomas Reynolds", "Ben Hollis", "Ian Warner" ]
+  s.email                 = [ "me@tdreyno.com", "ben@benhollis.net", "ian.warner@drykiss.com" ]
+  s.homepage              = "https://github.com/middleman/middleman-blog"
   s.summary               = %q{ Blog engine for Middleman }
   s.description           = %q{ Blog engine for Middleman }
-  s.license               = 'MIT'
-  s.files                 = `git ls-files -z`.split("\0")
-  s.test_files            = `git ls-files -z -- {fixtures,features}/*`.split("\0")
-  s.require_paths         = ['lib']
-  s.required_ruby_version = '>= 2.0.0'
+  s.license               = "MIT"
+  s.files                 = `git ls-files -z`.split( "\0" )
+  s.test_files            = `git ls-files -z -- {fixtures,features}/*`.split( "\0" )
+  s.require_paths         = [ "lib" ]
+  s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency('middleman-core', ['~> 4.0'])
-  s.add_dependency('tzinfo',         ['>= 0.3.0'])
-  s.add_dependency('addressable',    ['~> 2.3'])
+  s.add_dependency( "middleman-core", [ ">= 4.0.0" ] )
+  s.add_dependency( "tzinfo",         [ ">= 0.3.0" ] )
+  s.add_dependency( "addressable",    [ "~> 2.3"   ] )
 
 end

data/spec/spec_helper.rb

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

data/spec/uri_templates_spec.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 require 'middleman-blog/uri_templates'
 
 describe 'Middleman::Blog::UriTemplates' do
@@ -7,24 +5,24 @@ describe 'Middleman::Blog::UriTemplates' do
 
   describe 'safe_parameterize' do
     it 'can parameterize normal strings' do
-      expect(safe_parameterize('Some FUN stuff!')) == 'some-fun-stuff'
+      expect(safe_parameterize('Some FUN stuff!')).to eq 'some-fun-stuff'
     end
 
     it "doesn't mangle unicode strings" do
-      expect(safe_parameterize('☆☆☆')) == '☆☆☆'
-      expect(safe_parameterize('明日がある')) == '明日がある'
+      expect(safe_parameterize('☆☆☆')).to eq '☆☆☆'
+      expect(safe_parameterize('明日がある')).to eq '明日がある'
     end
 
     it "still transliterates when it's safe" do
-      expect(safe_parameterize('Schlagwörter')) == 'schlagworter'
+      expect(safe_parameterize('Schlagwörter')).to eq 'schlagworter'
     end
 
-    it "can handle mixed strings" do
-      expect(safe_parameterize('What ☆☆☆!')) == 'what-☆☆☆'
+    it 'can handle mixed strings' do
+      expect(safe_parameterize('What ☆☆☆!')).to eq 'what-☆☆☆'
     end
 
-    it "can handle numbers" do
-      expect(safe_parameterize(1)) == '1'
+    it 'can handle numbers' do
+      expect(safe_parameterize(1)).to eq '1'
     end
   end
 
@@ -33,47 +31,42 @@ describe 'Middleman::Blog::UriTemplates' do
       template = uri_template('{year}/{month}/{day}/{title}/{+path}')
       params = extract_params(template, '2013/12/13/foo-bar/foo/bar.html')
 
-      expect(params['year'])  == '2013'
-      expect(params['month']) == '12'
-      expect(params['day'])   == '13'
-      expect(params['title']) == 'foo-bar'
-      expect(params['path'])  == 'foo/bar.html'
+      expect(params['year']).to eq '2013'
+      expect(params['month']).to eq '12'
+      expect(params['day']).to eq '13'
+      expect(params['title']).to eq 'foo-bar'
+      expect(params['path']).to eq 'foo/bar.html'
     end
 
     it 'returns nil if there is no match' do
       template = uri_template('{year}/{month}/{day}/{title}/{+path}')
-      expect(extract_params(template, 'foo/bar.html')) == nil
+      expect(extract_params(template, 'foo/bar.html')).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')
+      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')
 
-      expect(params['year'])  == '2013'
-      expect(params['month']) == '12'
-      expect(params['day'])   == '13'
-      expect(params['title']) == 'foo - bar'
-      expect(params['path'])  == 'foo/bar.html'
+      expect(params['year']).to eq '2013'
+      expect(params['month']).to eq '12'
+      expect(params['day']).to eq '13'
+      expect(params['title']).to eq 'foo - bar'
+      expect(params['path']).to eq 'foo/bar.html'
     end
   end
 
   describe 'extract_directory_path' do
-
     it 'can extract a directory path' do
-
-      template     = uri_template( '{year}/{month}/{day}/{title}/{+path}' )
-      params       = extract_params( template, '2013/12/13/foo-bar/foo/bar.html' )
+      template     = uri_template('{year}/{month}/{day}/{title}/{+path}')
+      params       = extract_params(template, '2013/12/13/foo-bar/foo/bar.html')
       article_path = apply_uri_template template, params
 
-      expect( extract_directory_path( article_path ) ) == '2013-12-13-foo-bar-foo-bar'
-
+      expect(extract_directory_path(article_path)).to eq '2013/12/13/foo-bar/foo/bar'
     end
-
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Thomas Reynolds
@@ -10,22 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-22 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: tzinfo
   requirement: !ruby/object:Gem::Requirement
@@ -65,11 +65,13 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile-4.x
 - ISSUE_TEMPLATE.md
 - LICENSE.md
 - README.md
@@ -371,15 +373,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Blog engine for Middleman